class uc_addresses_handler_filter_access in Ubercart Addresses 6.2

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

• class \uc_addresses_handler_filter_access extends \views_handler_filter_boolean_operator

1 string reference to 'uc_addresses_handler_filter_access'

uc_addresses_views_data in views/uc_addresses.views.inc

Implementation of hook_views_data().

File

views/uc_addresses_handler_filter_access.inc, line 22

Contains uc_addresses_handler_filter_access class.

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

Name	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.
uc_addresses_handler_filter_access::query	public	function	Implements views_handler_filter#query().