class image_plugin_argument_validate_image_size in Image 7

Validation handler for image size.

Validates an image size argument and allows to restrict which image sizes are valid.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_validate
      • class \image_plugin_argument_validate_image_size

1 string reference to 'image_plugin_argument_validate_image_size'

image_views_plugins in views/image.views.inc

Implementation of hook_views_plugins().

File

views/image_plugin_argument_validate_image_size.inc, line 14

Views validation plugin for image size argument.

class image_plugin_argument_validate_image_size extends views_plugin_argument_validate {
  var $image_sizes = array();
  function init(&$view, &$argument, $id = NULL) {
    parent::init($view, $argument, $id);
    $this->image_sizes = image_get_sizes();
  }
  function validate_form(&$form, &$form_state) {
    $image_size_options = array();
    foreach ($this->image_sizes as $key => $size) {
      $image_size_options[$key] = $size['label'];
    }
    $form['image_size'] = array(
      '#type' => 'select',
      '#title' => t('Image sizes'),
      '#options' => $image_size_options,
      '#default_value' => $this
        ->get_argument(),
      '#multiple' => TRUE,
      '#required' => TRUE,
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'edit-options-validate-type' => array(
          $this->id,
        ),
      ),
      '#description' => t("Which image sizes are allowed to be passed through this argument. Both 'original' and '_original' are valid."),
    );
  }
  function get_argument() {
    return isset($this->argument->options['image_size']) ? $this->argument->options['image_size'] : array_keys($this->image_sizes);
  }
  function validate_argument($argument) {

    // Allow 'original' as well as '_original'. It's really up to the handler to
    // deal with this and change it before it gets here, but seeing as we
    // promise to do this in the UI we should back it up here.
    if ($argument == 'original') {
      $argument = '_original';
    }
    return $this->argument->options['image_size'][$argument];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
image_plugin_argument_validate_image_size::$image_sizes		property
image_plugin_argument_validate_image_size::get_argument		function
image_plugin_argument_validate_image_size::init		function	Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin_argument_validate::init
image_plugin_argument_validate_image_size::validate_argument		function	Overrides views_plugin_argument_validate::validate_argument
image_plugin_argument_validate_image_size::validate_form		function
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::options_form	public	function	Provide the default form for setting options. Overrides views_plugin::options_form	4
views_plugin_argument_validate::options_submit	public	function	Provide the default form form for submitting options Overrides views_plugin::options_submit	3
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::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_object::option_definition	4
views_plugin_argument_validate::process_summary_arguments	public	function	Process the summary arguments for displaying.	2