og-8.x-1.x-dev/src/Permission.php

<?php

declare(strict_types=1);

namespace Drupal\og;

use Drupal\Component\Render\MarkupInterface;

/**
 * Base class for OG permissions.
 */
abstract class Permission implements PermissionInterface {

  /**
   * The name of the permission.
   */
  protected ?string $name = NULL;

  /**
   * The human-readable permission title.
   */
  protected MarkupInterface|string|null $title = NULL;

  /**
   * A short description of the permission.
   */
  protected MarkupInterface|string $description = '';

  /**
   * The default roles to which this permission applies.
   *
   * @var list<string>
   */
  protected array $defaultRoles = [];

  /**
   * Permission provider.
   *
   * Defaults to 'Group' for GroupPermission and
   * 'Group content' for GroupContentOperationPermission.
   */
  protected string $provider = '';

  /**
   * If the permission is security sensitive and should be limited to admins.
   */
  protected bool $restrictAccess = FALSE;

  /**
   * Constructs a Permission object.
   *
   * @param array $values
   *   An associative array of values, keyed by property.
   */
  public function __construct(array $values = []) {
    foreach ($values as $property => $value) {
      $this->set($property, $value);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function get($property) {
    $property = $this->lowerCamelize($property);
    if (!property_exists($this, $property)) {
      throw new \InvalidArgumentException("Invalid property $property.");
    }
    return $this->$property;
  }

  /**
   * {@inheritdoc}
   */
  public function set($property, $value) {
    $property = $this->lowerCamelize($property);
    $this->validate($property, $value);
    $this->$property = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->get('name');
  }

  /**
   * {@inheritdoc}
   */
  public function setName($name) {
    $this->set('name', $name);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->get('title');
  }

  /**
   * {@inheritdoc}
   */
  public function setTitle($title) {
    $this->set('title', $title);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->get('description');
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this->set('description', $description);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultRoles() {
    return $this->get('default roles');
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultRoles(array $default_roles) {
    $this->set('default roles', $default_roles);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRestrictAccess() {
    return $this->get('restrict access');
  }

  /**
   * {@inheritdoc}
   */
  public function setRestrictAccess($access) {
    $this->set('restrict access', $access);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProvider() {
    return $this->get('provider');
  }

  /**
   * {@inheritdoc}
   */
  public function setProvider($provider) {
    $this->set('provider', $provider);
    return $this;
  }

  /**
   * Validates the given property and value.
   *
   * @param string $property
   *   The property to validate.
   * @param mixed $value
   *   The value to validate.
   */
  protected function validate($property, $value) {
    if (!property_exists($this, $property)) {
      throw new \InvalidArgumentException("Invalid property $property.");
    }

    if ($property === 'restrictAccess' && !is_bool($value)) {
      throw new \InvalidArgumentException('The value for the "restrict access" property should be a boolean.');
    }
  }

  /**
   * Converts the given string in a lowerCamelCase version.
   *
   * @param string $string
   *   The string to convert.
   *
   * @return string
   *   The converted string.
   */
  protected static function lowerCamelize($string) {
    return lcfirst(str_replace(' ', '', ucwords($string)));
  }

}