Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\user\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityBase;
Chris@0: use Drupal\Core\Entity\EntityStorageInterface;
Chris@0: use Drupal\user\RoleInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines the user role entity class.
Chris@0:  *
Chris@0:  * @ConfigEntityType(
Chris@0:  *   id = "user_role",
Chris@0:  *   label = @Translation("Role"),
Chris@17:  *   label_collection = @Translation("Roles"),
Chris@17:  *   label_singular = @Translation("role"),
Chris@17:  *   label_plural = @Translation("roles"),
Chris@17:  *   label_count = @PluralTranslation(
Chris@17:  *     singular = "@count role",
Chris@17:  *     plural = "@count roles",
Chris@17:  *   ),
Chris@0:  *   handlers = {
Chris@0:  *     "storage" = "Drupal\user\RoleStorage",
Chris@0:  *     "access" = "Drupal\user\RoleAccessControlHandler",
Chris@0:  *     "list_builder" = "Drupal\user\RoleListBuilder",
Chris@0:  *     "form" = {
Chris@0:  *       "default" = "Drupal\user\RoleForm",
Chris@0:  *       "delete" = "Drupal\Core\Entity\EntityDeleteForm"
Chris@0:  *     }
Chris@0:  *   },
Chris@0:  *   admin_permission = "administer permissions",
Chris@0:  *   config_prefix = "role",
Chris@0:  *   static_cache = TRUE,
Chris@0:  *   entity_keys = {
Chris@0:  *     "id" = "id",
Chris@0:  *     "weight" = "weight",
Chris@0:  *     "label" = "label"
Chris@0:  *   },
Chris@0:  *   links = {
Chris@0:  *     "delete-form" = "/admin/people/roles/manage/{user_role}/delete",
Chris@0:  *     "edit-form" = "/admin/people/roles/manage/{user_role}",
Chris@0:  *     "edit-permissions-form" = "/admin/people/permissions/{user_role}",
Chris@0:  *     "collection" = "/admin/people/roles",
Chris@0:  *   },
Chris@0:  *   config_export = {
Chris@0:  *     "id",
Chris@0:  *     "label",
Chris@0:  *     "weight",
Chris@0:  *     "is_admin",
Chris@0:  *     "permissions",
Chris@0:  *   }
Chris@0:  * )
Chris@0:  */
Chris@0: class Role extends ConfigEntityBase implements RoleInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The machine name of this role.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * The human-readable label of this role.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $label;
Chris@0: 
Chris@0:   /**
Chris@0:    * The weight of this role in administrative listings.
Chris@0:    *
Chris@0:    * @var int
Chris@0:    */
Chris@0:   protected $weight;
Chris@0: 
Chris@0:   /**
Chris@0:    * The permissions belonging to this role.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $permissions = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * An indicator whether the role has all permissions.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $is_admin;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getPermissions() {
Chris@0:     if ($this->isAdmin()) {
Chris@0:       return [];
Chris@0:     }
Chris@0:     return $this->permissions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getWeight() {
Chris@0:     return $this->get('weight');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setWeight($weight) {
Chris@0:     $this->set('weight', $weight);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function hasPermission($permission) {
Chris@0:     if ($this->isAdmin()) {
Chris@0:       return TRUE;
Chris@0:     }
Chris@0:     return in_array($permission, $this->permissions);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function grantPermission($permission) {
Chris@0:     if ($this->isAdmin()) {
Chris@0:       return $this;
Chris@0:     }
Chris@0:     if (!$this->hasPermission($permission)) {
Chris@0:       $this->permissions[] = $permission;
Chris@0:     }
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function revokePermission($permission) {
Chris@0:     if ($this->isAdmin()) {
Chris@0:       return $this;
Chris@0:     }
Chris@0:     $this->permissions = array_diff($this->permissions, [$permission]);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function isAdmin() {
Chris@0:     return (bool) $this->is_admin;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setIsAdmin($is_admin) {
Chris@0:     $this->is_admin = $is_admin;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function postLoad(EntityStorageInterface $storage, array &$entities) {
Chris@0:     parent::postLoad($storage, $entities);
Chris@0:     // Sort the queried roles by their weight.
Chris@0:     // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
Chris@0:     uasort($entities, 'static::sort');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function preSave(EntityStorageInterface $storage) {
Chris@0:     parent::preSave($storage);
Chris@0: 
Chris@0:     if (!isset($this->weight) && ($roles = $storage->loadMultiple())) {
Chris@0:       // Set a role weight to make this new role last.
Chris@0:       $max = array_reduce($roles, function ($max, $role) {
Chris@0:         return $max > $role->weight ? $max : $role->weight;
Chris@0:       });
Chris@0:       $this->weight = $max + 1;
Chris@0:     }
Chris@0: 
Chris@0:     if (!$this->isSyncing()) {
Chris@0:       // Permissions are always ordered alphabetically to avoid conflicts in the
Chris@0:       // exported configuration.
Chris@0:       sort($this->permissions);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }