You are here

class GroupRoleController in Group 7

Controller for group role entities.

Hierarchy

Expanded class hierarchy of GroupRoleController

1 string reference to 'GroupRoleController'
group_entity_info in ./group.entity.inc
Implements hook_entity_info().

File

classes/group_role.controller.inc, line 10
Defines the Entity API CRUD class for group roles.

View source
class GroupRoleController extends EntityAPIControllerExportable {

  /**
   * Delete a group role.
   *
   * @see EntityAPIController::delete()
   */
  public function delete($ids, DatabaseTransaction $transaction = NULL) {
    if (!empty($ids)) {
      foreach (group_roles($ids) as $group_role) {

        // Invalidate the parent group type's GroupRole cache.
        $group_role
          ->invalidateTypeCache();

        // Flag parent type as ENTITY_CUSTOM.
        $group_role
          ->flagTypeCustom();

        // Add Internationalization module support.
        if (module_exists('i18n_string')) {
          i18n_string_object_remove('group_role', $group_role);
        }
      }
    }
    parent::delete($ids, $transaction);
  }

  /**
   * Save a group role.
   *
   * @see EntityAPIController::save()
   */
  public function save($group_role, DatabaseTransaction $transaction = NULL) {
    $is_new = !empty($group_role->is_new);
    $is_special = in_array($group_role->name, array(
      'anonymous',
      'outsider',
      'member',
    ));

    // Invalidate the parent type's GroupRole cache whenever we save a new
    // group role or alter a special group role (anonymous, outsider or
    // member). The latter case is required because special group roles are
    // never actually saved to the db and thus need to be rebuilt after every
    // change to avoid serving outdated special roles from the cache.
    if ($is_new || $is_special) {
      $group_role
        ->invalidateTypeCache();
    }

    // If we save a special group role (anonymous, outsider or member), we
    // don't actually save the role but attach its permissions back onto the
    // group type.
    if ($is_special) {
      $key = $group_role->name . '_permissions';
      $group_type = group_type_load($group_role->type);
      $group_type->{$key} = $group_role->permissions;
      $group_type
        ->save();
      return;
    }

    // If we save a group role we call GroupRole::flagTypeCustom() which in turn
    // will check whether or not there is a parent group type that needs to be
    // flagged as ENTITY_CUSTOM.
    $group_role
      ->flagTypeCustom();

    // Add Internationalization module support.
    if (module_exists('i18n_string')) {
      i18n_string_object_update('group_role', $group_role);
    }
    return parent::save($group_role, $transaction);
  }

  /**
   * Create a group role.
   *
   * We first set up the values that are specific to the group role schema
   * but then also run the EntityAPIControllerExportable counterpart.
   *
   * @param array $values
   *   An array of values to set, keyed by property name.
   *
   * @return GroupRole
   *   A new GroupRole instance.
   */
  public function create(array $values = array()) {

    // Provide defaults that are needed in group_role_form().
    $values += array(
      'type' => '',
      'name' => '',
      'label' => '',
      'global' => 1,
      'permissions' => array(),
    );
    return parent::create($values);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::cleanIds protected function Ensures integer entity IDs are valid.
DrupalDefaultEntityController::filterId protected function Callback for array_filter that removes non-integer IDs.
EntityAPIController::$bundleKey protected property
EntityAPIController::$cacheComplete protected property
EntityAPIController::$defaultRevisionKey protected property
EntityAPIController::buildContent public function Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::buildContent
EntityAPIController::deleteRevision public function Implements EntityAPIControllerRevisionableInterface::deleteRevision(). Overrides EntityAPIControllerRevisionableInterface::deleteRevision
EntityAPIController::import public function Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::import
EntityAPIController::query public function Builds and executes the query for loading.
EntityAPIController::renderEntityProperty protected function Renders a single entity property.
EntityAPIController::saveRevision protected function Saves an entity revision.
EntityAPIControllerExportable::$entityCacheByName protected property
EntityAPIControllerExportable::$nameKey protected property
EntityAPIControllerExportable::applyConditions protected function
EntityAPIControllerExportable::attachLoad protected function Overridden. Overrides DrupalDefaultEntityController::attachLoad
EntityAPIControllerExportable::buildQuery protected function Support loading by name key. Overrides EntityAPIController::buildQuery
EntityAPIControllerExportable::cacheGet protected function Overridden. Overrides DrupalDefaultEntityController::cacheGet
EntityAPIControllerExportable::cacheGetByName protected function Like cacheGet() but keyed by name.
EntityAPIControllerExportable::cacheSet protected function Overridden. Overrides DrupalDefaultEntityController::cacheSet
EntityAPIControllerExportable::export public function Overridden. Overrides EntityAPIController::export
EntityAPIControllerExportable::invoke public function Overridden to care about reverted bundle entities and to skip Rules. Overrides EntityAPIController::invoke
EntityAPIControllerExportable::load public function Overridden to support passing numeric ids as well as names as $ids. Overrides EntityAPIController::load
EntityAPIControllerExportable::resetCache public function Overrides DrupalDefaultEntityController::resetCache(). Overrides EntityAPIController::resetCache
EntityAPIControllerExportable::view public function Implements EntityAPIControllerInterface. Overrides EntityAPIController::view
EntityAPIControllerExportable::__construct public function Overridden. Overrides EntityAPIController::__construct
GroupRoleController::create public function Create a group role. Overrides EntityAPIController::create
GroupRoleController::delete public function Delete a group role. Overrides EntityAPIControllerExportable::delete
GroupRoleController::save public function Save a group role. Overrides EntityAPIControllerExportable::save