class farm_plan_plugin_argument_validate_farm_plan in farmOS 7

Validate whether an argument is an acceptable farm_plan entity.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_validate
      • class \farm_plan_plugin_argument_validate_farm_plan

1 string reference to 'farm_plan_plugin_argument_validate_farm_plan'

farm_plan_views_plugins in modules/farm/farm_plan/farm_plan.views.inc

Implements hook_views_plugins().

File

modules/farm/farm_plan/views/plugins/farm_plan_plugin_argument_validate_farm_plan.inc, line 11

Contains the 'farm plan' argument validator plugin.

class farm_plan_plugin_argument_validate_farm_plan extends views_plugin_argument_validate {
  function option_definition() {
    $options = parent::option_definition();
    $options['types'] = array(
      'default' => array(),
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    $types = farm_plan_types();
    $options = array();
    foreach ($types as $type => $definition) {
      $options[$type] = check_plain($definition->label);
    }
    $form['types'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Plan types'),
      '#options' => $options,
      '#default_value' => $this->options['types'],
      '#description' => t('If you wish to validate for specific plan types, check them; if none are checked, all plans will pass.'),
    );
  }
  function options_submit(&$form, &$form_state, &$options = array()) {

    // Filter unselected items so we don't unnecessarily store giant arrays.
    $options['types'] = array_filter($options['types']);
  }
  function validate_argument($argument) {

    // If the argument is not a number, fail.
    if (!is_numeric($argument)) {
      return FALSE;
    }

    // Attempt to load the farm plan entity.
    $farm_plan = farm_plan_load($argument);

    // If the plan didn't load, fail.
    if (empty($farm_plan)) {
      return FALSE;
    }

    // Set the validated title.
    $this->argument->validated_title = check_plain(entity_label('farm_plan', $farm_plan));

    // Load the valid plan types from options, and return TRUE if the list is
    // empty, or if the type is in the list.
    $types = array_filter($this->options['types']);
    return empty($types) || !empty($types[$farm_plan->type]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
farm_plan_plugin_argument_validate_farm_plan::options_form		function	Provide the default form for setting options. Overrides views_plugin_argument_validate::options_form
farm_plan_plugin_argument_validate_farm_plan::options_submit		function	Provide the default form form for submitting options Overrides views_plugin_argument_validate::options_submit
farm_plan_plugin_argument_validate_farm_plan::option_definition		function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_validate::option_definition
farm_plan_plugin_argument_validate_farm_plan::validate_argument		function	Overrides views_plugin_argument_validate::validate_argument
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_validate::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_validate::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_validate::convert_options	public	function	Convert options from the older style.	4
views_plugin_argument_validate::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_validate::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_validate::process_summary_arguments	public	function	Process the summary arguments for displaying.	2