views/plugins/views_plugin_argument_validate.inc

   1 <?php
   2 // $Id: views_plugin_argument_validate.inc,v 1.1 2008/09/03 19:21:30 merlinofchaos Exp $
   3 /**
   4  * @file
   5  * Contains the base argument validator plugin.
   6  */
   7
   8 /**
   9  * Base argument validator plugin to provide basic functionality.
  10  *
  11  * @ingroup views_argument_validate_plugins
  12  */
  13 class views_plugin_argument_validate extends views_plugin {
  14   var $option_name = 'validate_argument';
  15
  16   /**
  17    * Initialize this plugin with the view and the argument
  18    * it is linked to.
  19    */
  20   function init(&$view, &$argument, $id = NULL) {
  21     $this->view = &$view;
  22     $this->argument = &$argument;
  23     $this->id = $id;
  24   }
  25
  26   /**
  27    * Determine if the administrator has the privileges to use this
  28    * plugin
  29    */
  30   function access() { return TRUE; }
  31
  32   function argument_form(&$form, &$form_state) {
  33   }
  34
  35   /**
  36    * If we don't have access to the form but are showing it anyway, ensure that
  37    * the form is safe and cannot be changed from user input.
  38    */
  39   function check_access(&$form) {
  40     if (!$this->access()) {
  41       $form[$this->option_name]['#disabled'] = TRUE;
  42       $form[$this->option_name]['#value'] = $form[$this->option_name]['#default_value'];
  43       $form[$this->option_name]['#description'] .= ' <strong>' . t('Note: you do not have permission to modify this. If you change the validator, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
  44     }
  45   }
  46
  47   /**
  48    * Return the validate argument.
  49    */
  50   function get_argument() {
  51     return isset($this->argument->options[$this->option_name]) ? $this->argument->options[$this->option_name] : '';
  52   }
  53
  54   function validate_form(&$form, &$form_state) { }
  55
  56   function validate_argument($arg) { return TRUE; }
  57 }
  58