You are here

Home » API reference » Ubercart Addresses 7 » uc_addresses_handler_filter_access.inc

class uc_addresses_handler_filter_access in Ubercart Addresses 7

Same name and namespace in other branches
  1. 6.2 views/uc_addresses_handler_filter_access.inc \uc_addresses_handler_filter_access

A handler to filter a view by checking address access.

Note that this filter does not work well with pager as it alters the results returned by the query and not the query itself. A possible fix for this would be to load all results, but that could become a serious performance hit because:

  • all addresses must be fully loaded;
  • load hooks are performed on all loaded addresses;
  • access hooks are performed on all loaded addresses.

Because of that, pager is not supported by this filter.

Hierarchy

Expanded class hierarchy of uc_addresses_handler_filter_access

1 string reference to 'uc_addresses_handler_filter_access'
uc_addresses_views_data in views/uc_addresses.views.inc
Implements hook_views_data().

File

views/uc_addresses_handler_filter_access.inc, line 22
Contains uc_addresses_handler_filter_access class.

View source 
class uc_addresses_handler_filter_access extends views_handler_filter_boolean_operator {

  /**
   * The assumed name of the aid field in the Views' results.
   *
   * @var string
   * @access protected
   */
  protected $aid_field_alias = 'unknown';

  /**
   * The assumed name of the uid field in the Views' results.
   *
   * @var string
   * @access protected
   */
  protected $uid_field_alias = 'unknown';

  /**
   * Implements views_handler_filter#query().
   *
   * This method needs to be overriden for two reasons:
   * - To prevent Views from adding an extra WHERE condition
   *   to the query, which is not needed as this filter alters
   *   the results.
   * - To add fields 'aid' and 'uid' to the table, so the filter
   *   is able to check access based on these two fields.
   */
  public function query() {
    $this
      ->ensure_my_table();

    // Add our fields.
    $this->aid_field_alias = $this->query
      ->add_field($this->table_alias, $this->real_field);
    $this->uid_field_alias = $this->query
      ->add_field($this->table_alias, 'uid');

    // Set flag that the access filter is present.
    // This can be handy for other modules to know, for example
    // when they'd like to fix the pager problem.
    $this->view->uc_addresses_filter_access = TRUE;
  }

  /**
   * Loads a single address.
   *
   * @param int $aid
   *   The ID of the address to load.
   * @param int $uid
   *   (optional) The owner of the address.
   *
   * @return UcAddressesAddresss
   *   An address object.
   */
  public function loadAddress($aid, $uid = NULL) {
    if (empty($uid)) {
      $address = UcAddressesAddressBook::loadAddress($aid);
    }
    else {
      $address = UcAddressesAddressBook::get($uid)
        ->getAddressById($aid);
    }
    return $address;
  }

  /**
   * Removes the rows the user should have no access to.
   *
   * @param array $values
   *   The loaded values.
   *
   * @todo This doesn't work with pager.
   */
  public function post_execute(&$values) {
    $aid_field_alias = $this->aid_field_alias;
    $uid_field_alias = $this->uid_field_alias;
    foreach ($values as $index => $row) {
      if (!isset($row->{$aid_field_alias})) {

        // The address ID field is not found in the row.
        // As a result, we can not check address access.
        continue;
      }
      $aid = $row->{$aid_field_alias};
      $uid = NULL;
      if (isset($row->{$uid_field_alias})) {
        $uid = $row->{$uid_field_alias};
      }
      if (!$aid) {

        // The address ID can be missing, for example when used
        // in Views where a relationship with uc_addresses is
        // optional. In this case, just skip the row.
        continue;
      }
      $address = $this
        ->loadAddress($aid, $uid);

      // Reassign user ID, just in case it was empty in the results.
      $uid = $address
        ->getUserId();
      $address_user = user_load($uid);

      // Check for access.
      if ($this->value && !$this
        ->check_access($address_user, $address) || !$this->value && $this
        ->check_access($address_user, $address)) {

        // No access. Remove the row from the results and decrease the calculated
        // number of rows.
        unset($values[$index]);
        if (isset($this->view->total_rows)) {
          $this->view->total_rows--;
        }
      }
    }
  }

  /**
   * Checks address access for the current user.
   *
   * @param object $address_user
   *   The user who owns the address.
   * @param UcAddressesAddress
   *   The address to check access for.
   *
   * @return boolean
   *   TRUE, if the user should have access.
   *   FALSE otherwise.
   */
  public function check_access($address_user, $address) {
    switch ($this->definition['uc_addresses_access_type']) {
      case 'view':
        return UcAddressesPermissions::canViewAddress($address_user, $address);
      case 'edit':
        return UcAddressesPermissions::canEditAddress($address_user, $address);
      case 'delete':
        return UcAddressesPermissions::canDeleteAddress($address_user, $address);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
uc_addresses_handler_filter_access::$aid_field_alias protected property The assumed name of the aid field in the Views' results.
uc_addresses_handler_filter_access::$uid_field_alias protected property The assumed name of the uid field in the Views' results.
uc_addresses_handler_filter_access::check_access public function Checks address access for the current user.
uc_addresses_handler_filter_access::loadAddress public function Loads a single address.
uc_addresses_handler_filter_access::post_execute public function Removes the rows the user should have no access to. Overrides views_handler::post_execute
uc_addresses_handler_filter_access::query public function Implements views_handler_filter#query(). Overrides views_handler_filter_boolean_operator::query
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::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_submit public function Submit the exposed handler form.
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::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::validate public function Validates the handler against the complete View. 1
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::$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::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
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_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
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_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
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::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
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_options public function Provide a list of options for the default operator form. 4
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_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter_boolean_operator::$accept_null public property Whether to accept NULL as a false value or not.
views_handler_filter_boolean_operator::$always_multiple public property Exposed filter options. Overrides views_handler_filter::$always_multiple
views_handler_filter_boolean_operator::$no_operator public property Don't display empty space where the operator would be. Overrides views_handler_filter::$no_operator
views_handler_filter_boolean_operator::admin_summary public function Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary
views_handler_filter_boolean_operator::construct public function Views handlers use a special construct function. Overrides views_object::construct 1
views_handler_filter_boolean_operator::expose_options public function Provide default options for exposed filters. Overrides views_handler_filter::expose_options
views_handler_filter_boolean_operator::get_value_options public function Return the possible options for this filter.
views_handler_filter_boolean_operator::operator_form public function Options form subform for setting the operator. Overrides views_handler_filter::operator_form
views_handler_filter_boolean_operator::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition
views_handler_filter_boolean_operator::value_form public function Options form subform for setting options. Overrides views_handler_filter::value_form
views_handler_filter_boolean_operator::value_validate public function Validate the options form. Overrides views_handler_filter::value_validate
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