class PermissionEvent in Organic groups 8

Event that is fired when OG permissions are compiled.

This event allows implementing modules to provide their own OG permissions or alter existing permissions that are provided by other modules.

The entity types and bundles of both the group and the related group content are available and can be used to determine the applicable permissions.

Hierarchy

class \Drupal\og\Event\PermissionEvent extends \Symfony\Component\EventDispatcher\Event implements PermissionEventInterface

Expanded class hierarchy of PermissionEvent

3 files declare their use of PermissionEvent

PermissionEventTest.php in tests/src/Unit/PermissionEventTest.php
PermissionEventTest.php in tests/src/Kernel/PermissionEventTest.php
PermissionManager.php in src/PermissionManager.php

File

src/Event/PermissionEvent.php, line 20

Namespace

Drupal\og\Event

View source

class PermissionEvent extends Event implements PermissionEventInterface {

  /**
   * The list of permissions.
   *
   * @var array
   *   Associative array of permission arrays, keyed by permission name.
   */
  protected $permissions = [];

  /**
   * The entity type ID of the group type to which the permissions apply.
   *
   * @var string
   */
  protected $groupEntityTypeId;

  /**
   * The bundle ID of the group type to which the permissions apply.
   *
   * @var string
   */
  protected $groupBundleId;

  /**
   * The bundle IDs of the group content types to which the permissions apply.
   *
   * @var array
   *   An array of group content bundle IDs, keyed by group content entity type
   *   ID.
   */
  protected $groupContentBundleIds;

  /**
   * Constructs a PermissionEvent object.
   *
   * @param string $group_entity_type_id
   *   The entity type ID of the group type for which the permissions are
   *   collected.
   * @param string $group_bundle_id
   *   The bundle ID of the group type for which the permissions are collected.
   * @param array $group_content_bundle_ids
   *   An array of group content bundle IDs, keyed by group content entity type
   *   ID.
   */
  public function __construct($group_entity_type_id, $group_bundle_id, array $group_content_bundle_ids) {
    $this->groupEntityTypeId = $group_entity_type_id;
    $this->groupBundleId = $group_bundle_id;
    $this->groupContentBundleIds = $group_content_bundle_ids;
  }

  /**
   * {@inheritdoc}
   */
  public function getPermission($name) {
    if (!isset($this->permissions[$name])) {
      throw new \InvalidArgumentException("The '{$name}' permission does not exist.");
    }
    return $this->permissions[$name];
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupContentOperationPermission($entity_type_id, $bundle_id, $operation, $owner = FALSE) {
    foreach ($this
      ->getPermissions() as $permission) {
      if ($permission instanceof GroupContentOperationPermission && $permission
        ->getEntityType() === $entity_type_id && $permission
        ->getBundle() === $bundle_id && $permission
        ->getOperation() === $operation && $permission
        ->getOwner() === $owner) {
        return $permission;
      }
    }
    throw new \InvalidArgumentException('The permission with the given properties does not exist.');
  }

  /**
   * {@inheritdoc}
   */
  public function getPermissions() {
    return $this->permissions;
  }

  /**
   * {@inheritdoc}
   */
  public function setPermission(PermissionInterface $permission) {
    if (empty($permission
      ->getName())) {
      throw new \InvalidArgumentException('Permission name is required.');
    }
    if (empty($permission
      ->getTitle())) {
      throw new \InvalidArgumentException('The permission title is required.');
    }
    if ($permission instanceof GroupContentOperationPermission) {

      // GroupContentOperationPermissions are uniquely identified by entity
      // type, bundle, operation and ownership. Check if these properties are
      // set.
      if (empty($permission
        ->getEntityType())) {
        throw new \InvalidArgumentException('The entity type ID is required.');
      }
      if (empty($permission
        ->getBundle())) {
        throw new \InvalidArgumentException('The bundle ID is required.');
      }
      if (empty($permission
        ->getOperation())) {
        throw new \InvalidArgumentException('The operation is required.');
      }

      // Check if this permission was already registered under another name, and
      // remove it so the new one replaces it.
      try {
        $this
          ->deleteGroupContentOperationPermission($permission
          ->getEntityType(), $permission
          ->getBundle(), $permission
          ->getOperation(), $permission
          ->getOwner());
      } catch (\InvalidArgumentException $e) {

        // The permission wasn't set. There is nothing to delete.
      }
    }
    $this->permissions[$permission
      ->getName()] = $permission;
  }

  /**
   * {@inheritdoc}
   */
  public function setPermissions(array $permissions) {
    foreach ($permissions as $permission) {
      $this
        ->setPermission($permission);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function deletePermission($name) {
    if ($this
      ->hasPermission($name)) {
      unset($this->permissions[$name]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function deleteGroupContentOperationPermission($entity_type_id, $bundle_id, $operation, $owner = 'any') {
    $permission = $this
      ->getGroupContentOperationPermission($entity_type_id, $bundle_id, $operation, $owner);
    $this
      ->deletePermission($permission
      ->getName());
  }

  /**
   * {@inheritdoc}
   */
  public function hasPermission($name) {
    return isset($this->permissions[$name]);
  }

  /**
   * {@inheritdoc}
   */
  public function hasGroupContentOperationPermission($entity_type_id, $bundle_id, $operation, $owner = FALSE) {
    try {
      $this
        ->getGroupContentOperationPermission($entity_type_id, $bundle_id, $operation, $owner);
    } catch (\InvalidArgumentException $e) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupEntityTypeId() {
    return $this->groupEntityTypeId;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupBundleId() {
    return $this->groupBundleId;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupContentBundleIds() {
    return $this->groupContentBundleIds;
  }

  /**
   * {@inheritdoc}
   */
  public function offsetGet($key) {
    return $this
      ->getPermission($key);
  }

  /**
   * {@inheritdoc}
   */
  public function offsetSet($key, $value) {
    if (!$value instanceof PermissionInterface) {
      throw new \InvalidArgumentException('The value must be an object of type PermissionInterface.');
    }
    if ($value
      ->getName() !== $key) {
      throw new \InvalidArgumentException('The key and the permission name must be identical.');
    }
    $this
      ->setpermission($value);
  }

  /**
   * {@inheritdoc}
   */
  public function offsetUnset($key) {
    if ($this
      ->hasPermission($key)) {
      $this
        ->deletePermission($key);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function offsetExists($key) {
    return $this
      ->hasPermission($key);
  }

  /**
   * {@inheritdoc}
   */
  public function getIterator() {
    return new \ArrayIterator($this->permissions);
  }

}

Members

Name	Modifiers	Type	Description
PermissionEvent::$groupBundleId	protected	property	The bundle ID of the group type to which the permissions apply.
PermissionEvent::$groupContentBundleIds	protected	property	The bundle IDs of the group content types to which the permissions apply.
PermissionEvent::$groupEntityTypeId	protected	property	The entity type ID of the group type to which the permissions apply.
PermissionEvent::$permissions	protected	property	The list of permissions.
PermissionEvent::deleteGroupContentOperationPermission	public	function	Deletes a group content operation permission by its identifying properties. Overrides PermissionEventInterface::deleteGroupContentOperationPermission
PermissionEvent::deletePermission	public	function	Deletes the given permission. Overrides PermissionEventInterface::deletePermission
PermissionEvent::getGroupBundleId	public	function	Returns the bundle ID of the group to which the permissions apply. Overrides PermissionEventInterface::getGroupBundleId
PermissionEvent::getGroupContentBundleIds	public	function	Returns the IDs of group content bundles to which the permissions apply. Overrides PermissionEventInterface::getGroupContentBundleIds
PermissionEvent::getGroupContentOperationPermission	public	function	Returns a group content operation permission by its identifying properties. Overrides PermissionEventInterface::getGroupContentOperationPermission
PermissionEvent::getGroupEntityTypeId	public	function	Returns the entity type ID of the group to which the permissions apply. Overrides PermissionEventInterface::getGroupEntityTypeId
PermissionEvent::getIterator	public	function
PermissionEvent::getPermission	public	function	Returns the permission with the given name. Overrides PermissionEventInterface::getPermission
PermissionEvent::getPermissions	public	function	Returns all the permissions. Overrides PermissionEventInterface::getPermissions
PermissionEvent::hasGroupContentOperationPermission	public	function	Returns if a group content operation permission matches given properties. Overrides PermissionEventInterface::hasGroupContentOperationPermission
PermissionEvent::hasPermission	public	function	Returns whether or not the given permission exists. Overrides PermissionEventInterface::hasPermission
PermissionEvent::offsetExists	public	function
PermissionEvent::offsetGet	public	function
PermissionEvent::offsetSet	public	function
PermissionEvent::offsetUnset	public	function
PermissionEvent::setPermission	public	function	Sets the permission with the given data. Overrides PermissionEventInterface::setPermission
PermissionEvent::setPermissions	public	function	Sets multiple permissions. Overrides PermissionEventInterface::setPermissions
PermissionEvent::__construct	public	function	Constructs a PermissionEvent object.
PermissionEventInterface::EVENT_NAME		constant	The event name.

You are here

class PermissionEvent in Organic groups 8

Hierarchy

File

Namespace

Members

API Navigation