Permissions

The system supports the concept of permissions, a common part of a role-based access control system. In the Gatekeeper system the permissions have these properties:

• id
• name
• description
• created date
• updated date

Creating a permission

When creating a permission, you need to specify a name and description value. The name must be unique:

<?php
$perm = array(
    'name' => 'perm1',
    'description' => 'Permission #1'
);
if (Gatekeeper::createPermission($perm) === true) {
    echo 'Permission created successfully!';
}
?>

You can also set an expiration date on your permissions using the expire property:

<?php
$perm = [
    'name' => 'perm1',
    'description' => 'Permission #1',
    'expire' => strtotime('+1 day')
];
?>

These values are stored as Unix timestamps on the permission records themselves. This will cause the permission to exire, not the permission to no longer be allowed for a user (that's in the user-to-permission relationship). You can also check to see if a permission is expired with the isExpired method:

<?php
$permission = Gatekeeper::findPermissionById(1);
if ($permission->isExpired() === true) {
    echo 'Oh noes, the permission expired!';
}
?>

You can also update the expiration time directly when you have a permission object in hand:

<?php
$permission = Gatekeeper::findPermissionById(1);
$permission->expire = strtotime('+1 month');
$permission->save();
?>

Adding Child Permissions

Much like groups, permissions also support the concept of children. Adding a permission as a child to a parent is easy and can be done in one of two ways:

<?php
$permission = Gatekeeper::findPermissionById(1);

// You can either add via ID
$permission->addChild(1);
// or with another model instance
$permission2 = Gatekeeper::findPermissionById(2);
$permission->addChild($permission);
?>

Removing Child Permissions

You can also remove child permissions in a similar way:

<?php
$permission1 = Gatekeeper::findPermissionById(1);

// You can either remove via ID
$permission1->removeChild(2);
// Or by model instance
$permission2 = Gatekeeper::findPermissionById(1);
$permission1->removeChild($permission2);
?>

Finding child permissions

If you want to find the permissions that are children of the current instance, you can use the children property:

<?php
$permission1 = Gatekeeper::findPermissionById(1);

$childPermissions = $permission1->children;
?>

This will return an array of permission objects representing the children.