Checking Permissions

Checking Complex Permission Keys

For permissions with granular control, like "Edit Page Properties," the process involves more detailed checks. To determine specific permissions, such as editing a page name, follow these steps:

1. Retrieve the permission key:

   $key = \Concrete\Core\Permission\Key\Key::getByHandle('edit_page_properties');
   

2. Set the permission object:

   $c = \Page::getCurrentPage();
   $key->setPermissionObject($this->page);
   

3. Since "Edit Page Properties" is an advanced permission key, it's an instance of [Concrete\Core\Permission\Key\EditPagePropertiesKey]. Use its getMyAssignment method to get a [Concrete\Core\Permission\Access\ListItem\EditPagePropertiesListItem] instance:

   $assignment = $key->getMyAssignment();
   

4. This method contains all necessary functions to check specific actions under the Edit Page Properties permission. For instance, to check if a user can edit the page's name:

   if ($assignment->allowEditName()) {
      // User can edit the page's name
   }
   

This approach is generally used for permission keys with advanced capabilities, retrieving a list item object that defines the current user's permissions.

Checking Permissions for Different Users or Groups

To check permissions for users or groups other than the currently logged-in user, follow these steps:

Check Page for Guest Group Viewing

1. Get the permission key for View Page:

   $key = Key::getByHandle('view_page');
   

2. Set the permission object:

   $key->setPermissionObject($page);
   

3. Retrieve the access object for the key/object combination:

   $access = $key->getPermissionAccessObject();
   if (!$access) {
      return false;
   }
   

4. Get the access entity for the Guest Group:

   $guestGroup = \Concrete\Core\User\Group\Group::getByID(GUEST_GROUP_ID);
   $entity = \Concrete\Core\Permission\Access\Entity\GroupEntity::getOrCreate($guestGroup);
   

5. Validate the access object against the Guest Group entity:

   return $access->validateAccessEntities([$entity]);
   

Check File Download Permission for a Specific User

1. Retrieve the permission key for View File:

   $key = Key::getByHandle('view_file');
   

2. Set the permission object:

   $file = \File::getByID(10);
   $key->setPermissionObject($file);
   

3. Retrieve the access object for the key/object combination:

   $access = $key->getPermissionAccessObject();
   if (!$access) {
      return false;
   }
   

4. Get the User object for the specific user:

   $info = \User::getByName('andrew');
   

5. Retrieve all access entities for that user:

   $entities = \Concrete\Core\Permission\Access\Entity\Entity::getForUser($info);
   

6. Pass the entities to the access object to validate:

   return $access->validateAccessEntities($entities);
   

This approach lets you check whether specific users or groups, like the Guest group or a particular user, have the necessary permissions.

Full List of Permission Keys