class ip_geoloc_plugin_argument_default_ip_geoloc in IP Geolocation Views & Maps 7

Default argument plugin to inject attributes from the visitor's location.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \ip_geoloc_plugin_argument_default_ip_geoloc

1 string reference to 'ip_geoloc_plugin_argument_default_ip_geoloc'

ip_geoloc_views_plugins in views/ip_geoloc.views.inc

Implements hook_views_plugins().

File

views/ip_geoloc_plugin_argument_default_ip_geoloc.inc, line 11

views/ip_geoloc_plugin_argument_default_ip_geoloc.inc

class ip_geoloc_plugin_argument_default_ip_geoloc extends views_plugin_argument_default {
  public function option_definition() {
    $options = parent::option_definition();
    $options['type'] = array(
      'default' => 'postal',
    );
    return $options;
  }
  public function options_form(&$form, &$form_state) {
    $form['type'] = array(
      '#type' => 'select',
      '#title' => t('Location attribute to use'),
      '#options' => array(
        'postal_code' => t('Postal code'),
        'city_state' => t('City and State/Province'),
        'country' => t('Country'),
        'lat_long' => t('Latitude, longitude'),
        'formatted_address' => t('Formatted address'),
      ),
      '#default_value' => $this->options['type'],
    );
  }
  public function get_argument() {
    $location = ip_geoloc_get_visitor_location();
    if (!empty($location)) {
      switch ($this->options['type']) {
        case 'postal_code':
          return isset($location['postal_code']) ? $location['postal_code'] : '';
        case 'city_state':
          return isset($location['city']) && isset($location['region']) ? $location['city'] . ', ' . $location['region'] : '';
        case 'country':
          return isset($location['country']) ? $location['country'] : '';
        case 'lat_long':
          return isset($location['latitude']) && isset($location['longitude']) ? $location['latitude'] . ',' . $location['longitude'] : '';
        case 'formatted_address':
          return isset($location['formatted_address']) ? $location['formatted_address'] : '';
      }
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ip_geoloc_plugin_argument_default_ip_geoloc::get_argument	public	function	Return the default argument. Overrides views_plugin_argument_default::get_argument
ip_geoloc_plugin_argument_default_ip_geoloc::options_form	public	function	Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
ip_geoloc_plugin_argument_default_ip_geoloc::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_default::option_definition
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::query	public	function	Add anything to the query that we might need to.	7
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_argument_default::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_default::check_access	public	function	If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
views_plugin_argument_default::convert_options	public	function	Convert options from the older style.	3
views_plugin_argument_default::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_default::options_submit	public	function	Provide the default form form for submitting options. Overrides views_plugin::options_submit	1
views_plugin_argument_default::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate