You are here

Home » API reference » Access Control Kit 7 » access_grant_entity_controller.inc

class AccessGrantEntityController in Access Control Kit 7

Provides the entity controller for access grants.

Hierarchy

Expanded class hierarchy of AccessGrantEntityController

1 string reference to 'AccessGrantEntityController'
access_entity_info in ./access.module
Implements hook_entity_info().

File

./access_grant_entity_controller.inc, line 11
Contains the access grant entity controller.

View source 
class AccessGrantEntityController extends DrupalDefaultEntityController {

  /**
   * Constructs a new grant object without saving it.
   *
   * @param array $values
   *   (optional) An array of values to set, keyed by property name.
   *
   * @return object
   *   An access grant object.
   */
  public function create(array $values = array()) {
    $grant = new stdClass();
    $grant->gid = NULL;
    $grant->uid = empty($values['uid']) ? NULL : $values['uid'];
    $grant->rid = empty($values['rid']) ? NULL : $values['rid'];
    $grant->scheme = empty($values['scheme']) ? '' : $values['scheme'];
    return $grant;
  }

  /**
   * Overrides DrupalDefaultEntityController::attachLoad().
   */
  protected function attachLoad(&$grants, $revision_id = FALSE) {
    parent::attachLoad($grants, $revision_id);
    foreach ($grants as $grant) {

      // Make the realm field's values available as $grant->realms, an array
      // where the keys are the values of the grant's access realm field, and
      // the values are the realm labels.
      $grant->realms = array();
      $scheme = access_scheme_machine_name_load($grant->scheme);
      $field_name = $scheme->realm_field['field_name'];
      $assigned = isset($grant->{$field_name}) ? $grant->{$field_name} : array(
        LANGUAGE_NONE => array(),
      );
      if (!empty($assigned[LANGUAGE_NONE])) {
        foreach ($assigned[LANGUAGE_NONE] as $data) {
          $key = $data['value'];

          // Make sure that the assigned value exists in the realm list.
          if (isset($scheme->realms[$key])) {
            $grant->realms[$key] = field_filter_xss($scheme->realms[$key]);
          }
        }
      }
    }
  }

  /**
   * Saves an access grant to the database.
   *
   * @param object $grant
   *   An access grant object with the following properties:
   *   - gid: (optional) The unique ID for the grant being saved. If $grant->gid
   *     is empty or omitted, a new grant will be inserted.
   *   - uid: The ID of the user being granted access.
   *   - rid: The ID of the role being granted to the user.
   *   - scheme: The machine name of the scheme to which the grant belongs.
   *   - original: (optional) The original grant object before any changes were
   *     applied. When omitted, the unchanged grant object is loaded from the
   *     database and stored in this property.
   *   Since an access grant is an entity, any fields contained in the grant
   *   object are saved alongside the grant object.
   *
   * @return int
   *   Status constant indicating whether the grant was inserted (SAVED_NEW) or
   *   updated (SAVED_UPDATED). When inserting a new grant, $grant->gid will
   *   contain the ID of the newly created grant.
   */
  public function save($grant) {
    $transaction = db_transaction();
    try {

      // Load the stored entity, if any.
      if (!empty($grant->gid) && !isset($grant->original)) {
        $grant->original = entity_load_unchanged('access_grant', $grant->gid);
      }
      field_attach_presave('access_grant', $grant);
      module_invoke_all('access_grant_presave', $grant);
      module_invoke_all('entity_presave', $grant, 'access_grant');
      if (empty($grant->gid)) {
        $op = 'insert';
        $status = drupal_write_record('access_grant', $grant);
        field_attach_insert('access_grant', $grant);
        $this
          ->resetCache();
      }
      else {
        $op = 'update';
        $status = drupal_write_record('access_grant', $grant, 'gid');
        field_attach_update('access_grant', $grant);
        $this
          ->resetCache(array(
          $grant->gid,
        ));
      }
      module_invoke_all('access_grant_' . $op, $grant);
      module_invoke_all('entity_' . $op, $grant, 'access_grant');
      unset($grant->original);
      return $status;
    } catch (Exception $e) {
      $transaction
        ->rollback();
      watchdog_exception('access', $e);
      throw $e;
    }
  }

  /**
   * Deletes an access grant from the database.
   *
   * @param int $gid
   *   The grant ID.
   *
   * @return int
   *   Status constant indicating deletion.
   */
  public function delete($gid) {
    $transaction = db_transaction();
    try {
      $grant = entity_load_unchanged('access_grant', $gid);
      if ($grant) {
        module_invoke_all('access_grant_delete', $grant);
        module_invoke_all('entity_delete', $grant, 'access_grant');
        field_attach_delete('access_grant', $grant);
        db_delete('access_grant')
          ->condition('gid', $gid)
          ->execute();
      }
      return SAVED_DELETED;
    } catch (Exception $e) {
      $transaction
        ->rollback();
      watchdog_exception('access', $e);
      throw $e;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AccessGrantEntityController::attachLoad protected function Overrides DrupalDefaultEntityController::attachLoad(). Overrides DrupalDefaultEntityController::attachLoad
AccessGrantEntityController::create public function Constructs a new grant object without saving it.
AccessGrantEntityController::delete public function Deletes an access grant from the database.
AccessGrantEntityController::save public function Saves an access grant to the database.
DrupalDefaultEntityController::$cache protected property Whether this entity type should use the static cache.
DrupalDefaultEntityController::$entityCache protected property Static cache of entities, keyed by entity ID.
DrupalDefaultEntityController::$entityInfo protected property Array of information about the entity.
DrupalDefaultEntityController::$entityType protected property Entity type for this controller instance.
DrupalDefaultEntityController::$hookLoadArguments protected property Additional arguments to pass to hook_TYPE_load().
DrupalDefaultEntityController::$idKey protected property Name of the entity's ID field in the entity database table.
DrupalDefaultEntityController::$revisionKey protected property Name of entity's revision database table field, if it supports revisions.
DrupalDefaultEntityController::$revisionTable protected property The table that stores revisions, if the entity supports revisions.
DrupalDefaultEntityController::buildQuery protected function Builds the query to load the entity. 4
DrupalDefaultEntityController::cacheGet protected function Gets entities from the static cache. 1
DrupalDefaultEntityController::cacheSet protected function Stores entities in the static entity cache.
DrupalDefaultEntityController::cleanIds protected function Ensures integer entity IDs are valid.
DrupalDefaultEntityController::filterId protected function Callback for array_filter that removes non-integer IDs.
DrupalDefaultEntityController::load public function Implements DrupalEntityControllerInterface::load(). Overrides DrupalEntityControllerInterface::load
DrupalDefaultEntityController::resetCache public function Implements DrupalEntityControllerInterface::resetCache(). Overrides DrupalEntityControllerInterface::resetCache
DrupalDefaultEntityController::__construct public function Constructor: sets basic variables.