class views_plugin_argument_default_bboxquery in Views GeoJSON 7

The BBOX query string argument default handler.

@TODO: Write an options_validate() method.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \views_plugin_argument_default_bboxquery

1 string reference to 'views_plugin_argument_default_bboxquery'

views_geojson_views_plugins in views/views_geojson.views.inc

Implements hook_views_plugins().

File

views/views_plugin_argument_default_bboxquery.inc, line 13

Contains the BBOX query string argument default plugin.

class views_plugin_argument_default_bboxquery extends views_plugin_argument_default {

  /**
   * Return the default argument.
   */
  public function get_argument() {
    $query = drupal_get_query_parameters();
    if (isset($query[$this->options['arg_id']])) {

      // Just set the argument here. We'll validate and sanitize the input in
      // views_geojson_bbox_argument::query().
      return $query[$this->options['arg_id']];
    }
    if ($this->argument->options['empty_result']) {

      // Return no values if arg not present and empty result option is set.
      $this->view->built = TRUE;
      $this->view->executed = TRUE;
      return FALSE;
    }

    // Return all values if arg not present.
    return TRUE;
  }

  /**
   *
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['argument'] = array(
      'default' => '',
    );
    $options['arg_id'] = array(
      'default' => 'bbox',
    );
    return $options;
  }

  /**
   *
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['info'] = array(
      '#markup' => '<p class="description">Attempt to pull bounding box info
      directly from the query string, bypassing Drupal\'s normal argument
      handling. If the argument does not exist, all values will be shown.</p>',
    );
    $form['arg_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Query argument ID'),
      '#size' => 60,
      '#maxlength' => 64,
      '#default_value' => $this->options['arg_id'] ? $this->options['arg_id'] : t('bbox'),
      '#description' => t('The ID of the query argument.<br />For OpenLayers use <em>bbox</em>, (as in "<em>?bbox=left,bottom,right,top</em>".)'),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
views_plugin_argument_default_bboxquery::get_argument	public	function	Return the default argument. Overrides views_plugin_argument_default::get_argument
views_plugin_argument_default_bboxquery::options_form	public	function	Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
views_plugin_argument_default_bboxquery::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_default::option_definition