silverstripe-framework/security/PermissionRole.php
Ingo Schommer bfe44b3909 MINOR Documentation (from r104610)
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@112358 467b73ca-7a2a-4603-9d3b-597d59a354a9
2010-10-15 00:31:41 +00:00

66 lines
1.7 KiB
PHP

<?php
/**
* A PermissionRole represents a collection of permission codes that can be applied to groups.
*
* Because permission codes are very granular, this lets website administrators create more
* business-oriented units of access control - Roles - and assign those to groups.
*
* If the <b>OnlyAdminCanApply</b> property is set to TRUE, the role can only be assigned
* to new groups by a user with ADMIN privileges. This is a simple way to prevent users
* with access to {@link SecurityAdmin} (but no ADMIN privileges) to get themselves ADMIN access
* (which might be implied by certain roles).
*
* @package sapphire
* @subpackage security
*/
class PermissionRole extends DataObject {
static $db = array(
"Title" => "Varchar",
"OnlyAdminCanApply" => "Boolean"
);
static $has_many = array(
"Codes" => "PermissionRoleCode",
);
static $belongs_many_many = array(
"Groups" => "Group",
);
static $default_sort = "\"Title\"";
static $singular_name = 'Role';
static $plural_name = 'Roles';
function getCMSFields() {
$fields = parent::getCMSFields();
$fields->removeFieldFromTab('Root', 'Codes');
$fields->removeFieldFromTab('Root', 'Groups');
$fields->addFieldToTab(
'Root.Main',
$permissionField = new PermissionCheckboxSetField(
'Codes',
singleton('Permission')->i18n_plural_name(),
'PermissionRoleCode',
'RoleID'
)
);
$permissionField->setHiddenPermissions(SecurityAdmin::$hidden_permissions);
return $fields;
}
function onAfterDelete() {
parent::onAfterDelete();
// Delete associated permission codes
$codes = $this->Codes();
foreach ( $codes as $code ) {
$code->delete();
}
}
}