class workbench_access_handler_filter_access in Workbench Access 7

@file Views integration for Workbench.

Provides a filter to display nodes by assigned section.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_filter
    class \views_handler_filter_in_operator
    class \views_handler_filter_many_to_one
    class \workbench_access_handler_filter_access

Expanded class hierarchy of workbench_access_handler_filter_access

1 string reference to 'workbench_access_handler_filter_access'

workbench_access_views_data in ./workbench_access.views.inc: Implements hook_views_data().

File

includes/workbench_access_handler_filter_access.inc, line 10: Views integration for Workbench.

View source

class workbench_access_handler_filter_access extends views_handler_filter_many_to_one {
  function init(&$view, &$options) {
    parent::init($view, $options);
    $this->value = array(
      $options['access_id'],
    );
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['access_id'] = array(
      'default' => NULL,
    );
    $options['size'] = array(
      'default' => 5,
    );
    return $options;
  }
  function operator_options($which = 'title') {
    return array(
      'or' => t('Is one of'),
    );
  }
  function get_value_options() {
    return workbench_access_active_options();
  }
  function value_form(&$form, &$form_state) {
    $options = $this
      ->get_value_options();
    $form['access_id'] = array(
      '#type' => 'select',
      '#title' => t('Sections'),
      '#multiple' => TRUE,
      '#options' => $options,
      '#default_value' => $this->options['access_id'],
      '#size' => $this->options['size'],
    );
    $form['size'] = array(
      '#type' => 'select',
      '#title' => t('Size'),
      '#options' => drupal_map_assoc(array(
        1,
        5,
        10,
        20,
        50,
      )),
      '#default_value' => $this->options['size'],
    );
  }
  function value_submit($form, &$form_state) {
    $this->value = $form_state['values']['access_id'];
  }
  function exposed_form(&$form, &$form_state) {

    // Prevent parent form errors by using a value.
    $form['value'] = array(
      '#type' => 'value',
      '#value' => '',
    );
    parent::exposed_form($form, $form_state);

    // Build our form element.
    $options = workbench_access_active_options();
    $form['access_id'] = array(
      '#type' => 'select',
      '#multiple' => TRUE,
      '#options' => $options,
      '#default_value' => $this->options['access_id'],
      '#size' => $this->options['size'],
    );
    unset($form['size']);
  }
  function exposed_submit(&$form, &$form_state) {
    if (empty($form_state['values']['access_id'])) {
      $form_state['values']['access_id'] = -5;
    }
  }
  function query() {
    global $user;
    static $node_types;

    // If workbench_access is not configured, do nothing.
    $active = workbench_access_get_active_tree();
    $access_table = $active['access_scheme']['field_table'];
    $tree = $active['tree'];
    if (empty($tree)) {
      return;
    }

    // Check the user's access.
    $account = $user;

    // Not a clone, but that's ok, since we need this data on $user.
    // Load workbench_access user data onto the account object.
    if (!isset($account->workbench_access)) {
      workbench_access_user_load_data($account);
    }

    // Get node types that do not use workbench_access for access control.
    $node_types = array();
    foreach (node_type_get_names() as $type => $name) {
      if (!variable_get('workbench_access_node_type_' . $type, TRUE)) {
        $node_types[$type] = $type;
      }
    }

    // Here we start altering the query. All of our alters should be their own
    // where group.
    // If the user has no workbench_access rights, and all node types use
    // workbench_access, force the query to return nothing.
    if (empty($account->workbench_access) && empty($node_types)) {
      $table = $this->view->base_table;
      $group = $this->query
        ->set_where_group('OR');
      $this->query
        ->add_where($group, "{$table}.nid", -1, '=');
      return;
    }

    // If there is no selection, use the user's own access tree.
    if (empty($this->value[0]) || $this->value[0] == -5) {
      workbench_access_build_tree($tree, array_keys($account->workbench_access));
      $group = $this->query
        ->set_where_group('OR');
      $node_type_filter = TRUE;
    }
    else {
      workbench_access_build_tree($tree, array_keys($this->value[0]));
      $group = $this->query
        ->set_where_group('AND');
      $node_type_filter = FALSE;
    }

    // Build the workbench_access where clause.
    if (!empty($tree)) {

      // Since we allow multi-select, this has to be a subquery.
      $ids = array_keys($tree);
      $table = $active['access_scheme']['field_table'];
      $subquery = db_select($table, $table);
      $subquery
        ->addField($table, 'nid');
      $subquery
        ->distinct();
      $subquery
        ->condition($table . '.' . $active['access_scheme']['query_field'], $ids, 'IN');
      $subquery
        ->condition($table . '.access_scheme', $active['access_scheme']['access_scheme']);
      $where_table = !empty($this->relationship) ? $this->relationship : $this->query->base_table;
      $this->query
        ->add_where($group, "{$where_table}.nid", $subquery, 'IN');
    }

    // If not all node types use workbench access for permissions, add them here.
    if (!empty($node_types)) {
      $table = $this->query->base_table;

      // Ensure that we have a proper table when using a relationship from a non-node base table.
      // @TODO: There may be cleaner ways to do this lookup.
      if (isset($this->view->relationship['vid'])) {
        $table = $this->view->relationship['vid']->alias;
      }
      elseif (isset($this->view->relationship['nid'])) {
        $table = $this->view->relationship['nid']->alias;
      }

      // If no filter is active, then we allow node types not under access control.
      if ($node_type_filter) {
        $this->query
          ->add_where($group, "{$table}.type", $node_types, 'IN');
      }
      else {
        $this->query
          ->add_where($group, "{$table}.type", $node_types, 'NOT IN');
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_handler::$handler_type	public	property	The type of the handler, for example filter/footer/field.
views_handler::$query	public	property	Where the $query object will reside:.	1
views_handler::$real_field	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship	public	property	The relationship used for this field.
views_handler::$table_alias	public	property	The alias of the table of this handler which is used in the query.
views_handler::$view	public	property	The top object of a view. Overrides views_object::$view
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::case_transform	public	function	Transform a string by a certain method.
views_handler::exposed_validate	public	function	Validate the exposed handler form.	4
views_handler::expose_submit	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options	public	function	Provide defaults for the handler.
views_handler::extra_options_form	public	function	Provide a form for setting options.	1
views_handler::extra_options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate	public	function	Validate the options form.
views_handler::get_field	public	function	Shortcut to get a handler's raw field value.
views_handler::get_join	public	function	Get the join object that should be used for this handler.
views_handler::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::groupby_form_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
views_handler::has_extra_options	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_exposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin	public	function	Determine if the argument needs a style plugin.	1
views_handler::placeholder	public	function	Provides a unique placeholders for handlers.
views_handler::post_execute	public	function	Run after the view is executed, before the result is cached.	1
views_handler::pre_query	public	function	Run before the view is built.	1
views_handler::sanitize_value	public	function	Sanitize the value for output.
views_handler::set_relationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::ui_name	public	function	Return a string representing this handler's name in the UI.	9
views_handler::use_group_by	public	function	Provides the handler some groupby.	2
views_handler_filter::$always_multiple	public	property	Disable the possibility to force a single value.	6
views_handler_filter::$always_required	public	property	Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info	public	property	Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator	public	property	Disable the possibility to use operators.	2
views_handler_filter::$operator	public	property	Contains the operator which is used on the query.
views_handler_filter::$value	public	property	Contains the actual value of the field.
views_handler_filter::build_group_form	public	function	Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options	public	function	Provide default options for exposed filters.
views_handler_filter::build_group_submit	public	function	Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate	public	function	Validate the build group options form.	1
views_handler_filter::can_build_group	public	function	Determine if a filter can be converted into a group.
views_handler_filter::can_expose	public	function	Determine if a filter can be exposed. Overrides views_handler::can_expose	5
views_handler_filter::can_group	public	function	Can this filter be used in OR groups?	1
views_handler_filter::convert_exposed_input	public	function	Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_info	public	function	Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate	public	function	Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_validate	public	function	Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form	public	function	Build a form with a group of operator \| values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input	public	function	Options available for a grouped filter which uses checkboxes.
views_handler_filter::is_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input	public	function	Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form	public	function	Options form subform for setting the operator.	6
views_handler_filter::operator_submit	public	function	Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate	public	function	Validate the operator form.
views_handler_filter::options_form	public	function	Provide the basic form which calls through to subforms. Overrides views_handler::options_form	4
views_handler_filter::options_submit	public	function	Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate	public	function	Simple validate handler. Overrides views_handler::options_validate	1
views_handler_filter::prepare_filter_select_options	public	function	Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button	public	function	Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form	public	function	Shortcut to display the exposed options form.
views_handler_filter::show_expose_button	public	function	Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form	public	function	Shortcut to display the operator form.
views_handler_filter::show_value_form	public	function	Shortcut to display the value form.
views_handler_filter::store_exposed_input	public	function	Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input	public	function	If set to remember exposed input in the session, store it there.
views_handler_filter::value_validate	public	function	Validate the options form.	3
views_handler_filter_in_operator::$value_options	public	property	Stores all operations which are available on the form.
views_handler_filter_in_operator::accept_exposed_input	public	function	Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter::accept_exposed_input	2
views_handler_filter_in_operator::admin_summary	public	function	Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary	2
views_handler_filter_in_operator::construct	public	function	Views handlers use a special construct function. Overrides views_object::construct
views_handler_filter_in_operator::expose_form	public	function	Options form subform for exposed filter options. Overrides views_handler_filter::expose_form	1
views_handler_filter_in_operator::expose_options	public	function	Provide default options for exposed filters. Overrides views_handler_filter::expose_options
views_handler_filter_in_operator::operator_values	public	function
views_handler_filter_in_operator::op_empty	public	function
views_handler_filter_in_operator::op_simple	public	function
views_handler_filter_in_operator::reduce_value_options	public	function	When using exposed filters, we may be required to reduce the set.
views_handler_filter_in_operator::validate	public	function	Validates the handler against the complete View. Overrides views_handler::validate
views_handler_filter_many_to_one::$helper	public	property	Stores the Helper object which handles the many_to_one complexity.
views_handler_filter_many_to_one::$value_form_type	public	property	Overrides views_handler_filter_in_operator::$value_form_type
views_handler_filter_many_to_one::ensure_my_table	public	function	Override ensure_my_table so we can control how this joins in. The operator actually has influence over joining. Overrides views_handler::ensure_my_table
views_handler_filter_many_to_one::operators	public	function	This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. Overrides views_handler_filter_in_operator::operators	1
views_handler_filter_many_to_one::op_helper	public	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::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
workbench_access_handler_filter_access::exposed_form		function	Render our chunk of the exposed filter form when selecting. Overrides views_handler_filter::exposed_form
workbench_access_handler_filter_access::exposed_submit		function	Submit the exposed handler form. Overrides views_handler::exposed_submit
workbench_access_handler_filter_access::get_value_options		function	Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides views_handler_filter_in_operator::get_value_options
workbench_access_handler_filter_access::init		function	Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter_many_to_one::init
workbench_access_handler_filter_access::operator_options		function	Build strings from the operators() for 'select' options. Overrides views_handler_filter_in_operator::operator_options
workbench_access_handler_filter_access::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_many_to_one::option_definition
workbench_access_handler_filter_access::query		function	Add this filter to the query. Overrides views_handler_filter_in_operator::query
workbench_access_handler_filter_access::value_form		function	Options form subform for setting options. Overrides views_handler_filter_many_to_one::value_form
workbench_access_handler_filter_access::value_submit		function	Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter_in_operator::value_submit

You are here

class workbench_access_handler_filter_access in Workbench Access 7

Hierarchy

File

Members

API Navigation