Provides management of all Permission pages independent of users, for access control.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Permissions class also inherits all the methods and properties of: PagesType and Wire.

Common / Manipulation / For hooks

Common

Name Return Summary  
$permissions->find($selector) PageArray Return the permissions(s) matching the the given selector query.
$permissions->get($selector) Permission or NullPage Return permission by given name, numeric ID or a selector string.
$permissions->getIterator() ArrayObject Returns all installed Permission pages and enables foreach() iteration of $permissions
$permissions->has(string $name) bool Does the system have a permission with the given name?

Manipulation

Name Return Summary  
$permissions->add(string $name) Permission, Page or NullPage Add a new Permission with the given name and return it
$permissions->delete($page) bool Permanently delete a Permission
$permissions->save($page) bool Save a Permission

For hooks

This methods are only useful for hooking and should not be called directly.

Name Return Summary  
$permissions->added(Page $page) (nothing) Hook called just after a Permission is added
$permissions->deleteReady(Page $page) (nothing) Hook called before a Permission is deleted
$permissions->deleted(Page $page) (nothing) Hook called when a permission is deleted
$permissions->saveReady(Page $page) array Hook called just before a Permission is saved
$permissions->saved(Page $page) (nothing) Hook called when a permission is saved

Additional methods and properties

In addition to the methods and properties above, Permissions also inherits the methods and properties of these classes: