class spaces_og_plugin_argument_validate_useringroups in Spaces 7.3

Validate whether an argument is a valid user that is a member of one of the current user's groups. This check works through the implementation of db_rewrite_sql() in spaces_og.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_validate
      • class \spaces_og_plugin_argument_validate_useringroups

1 string reference to 'spaces_og_plugin_argument_validate_useringroups'

spaces_og_views_plugins in spaces_og/views/spaces_og.views.inc

Implements hook_views_plugins().

File

spaces_og/views/spaces_og_plugin_argument_validate_useringroups.inc, line 8

class spaces_og_plugin_argument_validate_useringroups extends views_plugin_argument_validate {
  function validate_form(&$form, &$form_state) {

    // We are unable to rely on options having already been set, so let's make
    // sure defaults are here:
    if (!isset($this->argument->options['validate_user_argument_type'])) {
      $this->argument->options['validate_user_argument_type'] = 'uid';
    }
    $form['validate_user_argument_type'] = array(
      '#type' => 'radios',
      '#title' => t('Type of user argument to allow'),
      '#options' => array(
        'uid' => t('Only allow numeric UIDs'),
        'name' => t('Only allow string usernames'),
        'either' => t('Allow both numeric UIDs and string usernames'),
      ),
      '#default_value' => $this->argument->options['validate_user_argument_type'],
      '#process' => array(
        'expand_radios',
        'ctools_dependent_process',
      ),
      '#dependency' => array(
        'edit-options-validate-type' => array(
          $this->id,
        ),
      ),
      '#prefix' => '<div id="edit-options-validate-user-argument-type-wrapper">',
      '#suffix' => '</div>',
    );
  }
  function validate_argument($argument) {
    $type = $this->argument->options['validate_user_argument_type'];

    // is_numeric() can return false positives, so we ensure it's an integer.
    // However, is_integer() will always fail, since $argument is a string.
    if (is_numeric($argument) && $argument == (int) $argument) {
      if ($type == 'uid' || $type == 'either') {
        $where = 'u.uid = %d';
      }
    }
    else {
      if ($type == 'name' || $type == 'either') {
        $where = "u.name = '%s'";
      }
    }
    if (!empty($where)) {
      $query = db_rewrite_sql("SELECT u.uid FROM {users} u WHERE {$where}", 'u', 'uid', array(
        $argument,
      ));

      // TODO Please convert this statement to the D7 database API syntax.
      $validated = db_query($query, $argument)
        ->fetchField();
      return $validated;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
spaces_og_plugin_argument_validate_useringroups::validate_argument		function	Overrides views_plugin_argument_validate::validate_argument
spaces_og_plugin_argument_validate_useringroups::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::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
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