Internal helper function; Create a role with specified permissions.
array $permissions: Array of permission names to assign to role.
string $rid: (optional) The role ID (machine name). Defaults to a random name.
string $name: (optional) The label for the role. Defaults to a random string.
integer $weight: (optional) The weight for the role. Defaults NULL so that entity_create() sets the weight to maximum + 1.
string Role ID of newly created role, or FALSE if role creation failed.
protected function drupalCreateRole(array $permissions, $rid = NULL, $name = NULL, $weight = NULL) {
// Generate a random, lowercase machine name if none was passed.
if (!isset($rid)) {
$rid = strtolower($this
->randomName(8));
}
// Generate a random label.
if (!isset($name)) {
// In the role UI role names are trimmed and random string can start or
// end with a space.
$name = trim($this
->randomString(8));
}
// Check the all the permissions strings are valid.
if (!$this
->checkPermissions($permissions)) {
return FALSE;
}
// Create new role.
$role = entity_create('user_role', array(
'id' => $rid,
'label' => $name,
));
if (!is_null($weight)) {
$role
->set('weight', $weight);
}
$result = $role
->save();
$this
->assertIdentical($result, SAVED_NEW, t('Created role ID @rid with name @name.', array(
'@name' => var_export($role
->label(), TRUE),
'@rid' => var_export($role
->id(), TRUE),
)), t('Role'));
if ($result === SAVED_NEW) {
// Grant the specified permissions to the role, if any.
if (!empty($permissions)) {
user_role_grant_permissions($role
->id(), $permissions);
$assigned_permissions = db_query('SELECT permission FROM {role_permission} WHERE rid = :rid', array(
':rid' => $role
->id(),
))
->fetchCol();
$missing_permissions = array_diff($permissions, $assigned_permissions);
if (!$missing_permissions) {
$this
->pass(t('Created permissions: @perms', array(
'@perms' => implode(', ', $permissions),
)), t('Role'));
}
else {
$this
->fail(t('Failed to create permissions: @perms', array(
'@perms' => implode(', ', $missing_permissions),
)), t('Role'));
}
}
return $role
->id();
}
else {
return FALSE;
}
}