Groups // 分组

Create a group // 创建一个分组

Creating new Groups is very easy and in this section you will learn how to create one.
创建一个新的分组是非常简单的，在这个章节中你将学习如何创建一个分组。

Param Required Default Type Description
$attributes true null array The group attributes.
分组的属性。

Below we’ll list all the valid keys that you can pass through the $attributes.
下面我们将列出你可以通过 $attributes 传递的所有有效的 keys。

Key Required Type Description
name true string The name of the group.
分组名称。
permissions false array The group permissions, pass a key/value pair.
分组权限，传入一个 键/值 对数组。

Example

  1. try
  2. {
  3.     // Create the group
  4.     $group = Sentry::createGroup(array(
  5.         'name'        => 'Moderator',
  6.         'permissions' => array(
  7.             'admin' => 1,
  8.             'users' => 1,
  9.         ),
  10.     ));
  11. }
  12. catch (Cartalyst\Sentry\Groups\NameRequiredException $e)
  13. {
  14.     echo 'Name field is required';
  15. }
  16. catch (Cartalyst\Sentry\Groups\GroupExistsException $e)
  17. {
  18.     echo 'Group already exists';
  19. }

Exceptions // 异常

Below is a list of exceptions that this method can throw.
下面是该方法可能抛出的异常的列表。

Exception Description
Cartalyst\Sentry\Groups\NameRequiredException If you don’t provide the group name, this exception will be thrown.
如果你没有提供分组的名称，这个异常将被抛出。
Cartalyst\Sentry\Groups\GroupExistsException This exception will be thrown when the group you are trying to create already exists on your database.
当你试图创建数据库中已经存在的分组时，这个异常将被抛出。

Update a group // 更新分组

Example

  1. try
  2. {
  3.     // Find the group using the group id
  4.     // 通过 分组ID 查找分组
  5.     $group = Sentry::findGroupById(1);
  7.     // Update the group details
  8.     // 更新分组详情
  9.     $group->name = 'Users';
  10.     $group->permissions = array(
  11.         'admin' => 1,
  12.         'users' => 1,
  13.     );
  15.     // Update the group
  16.     // 更新分组
  17.     if ($group->save())
  18.     {
  19.         // Group information was updated
  20.         // 分组信息已被更新
  21.     }
  22.     else
  23.     {
  24.         // Group information was not updated
  25.         // 分组信息未被更新
  26.     }
  27. }
  28. catch (Cartalyst\Sentry\Groups\NameRequiredException $e)
  29. {
  30.     echo 'Name field is required';
  31. }
  32. catch (Cartalyst\Sentry\Groups\GroupExistsException $e)
  33. {
  34.     echo 'Group already exists.';
  35. }
  36. catch (Cartalyst\Sentry\Groups\GroupNotFoundException $e)
  37. {
  38.     echo 'Group was not found.';
  39. }

Exceptions

Below is a list of exceptions that this method can throw.
下面是该方法可能抛出的异常的列表。

Exception Description
Cartalyst\Sentry\Groups\NameRequiredException If you don’t provide the group name, this exception will be thrown.
如果你没有提供分组的名称，这个异常将被抛出。
Cartalyst\Sentry\Groups\GroupExistsException This exception will be thrown when the group you are trying to create already exists on your database.
当你试图创建数据库中已经存在的分组时，这个异常将被抛出。
Cartalyst\Sentry\Groups\GroupNotFoundException If the provided group was not found, this exception will be thrown.
如果指定的分组没有找到，这个异常将被抛出。

Delete a Group // 删除一个分组

Example

  1. try
  2. {
  3.     // Find the group using the group id
  4.     // 通过 分组ID 查找分组
  5.     $group = Sentry::findGroupById(1);
  7.     // Delete the group
  8.     // 删除分组
  9.     $group->delete();
  10. }
  11. catch (Cartalyst\Sentry\Groups\GroupNotFoundException $e)
  12. {
  13.     echo 'Group was not found.';
  14. }

Exceptions // 异常

Below is a list of exceptions that this method can throw.
下面是该方法可能抛出的异常的列表。

Exception Description
Cartalyst\Sentry\Groups\GroupNotFoundException If the provided group was not found, this exception will be thrown.
如果指定的分组没有找到，这个异常将被抛出。

Finding Groups // 查找分组

Sentry provides simple methods to find you your groups. Sentry 提供了一个简单的方法来查找你的分组。

Find all the Groups // 查找所有的分组

This will return all the groups.
这将返回所有的分组。

  1. $groups = Sentry::findAllGroups();

Find a group by its ID // 通过“分组ID”查找一个分组

Find a group by it’s ID.
通过“分组ID”查找一个分组。

  1. try
  2. {
  3.     $group = Sentry::findGroupById(1);
  4. }
  5. catch (Cartalyst\Sentry\Groups\GroupNotFoundException $e)
  6. {
  7.     echo 'Group was not found.';
  8. }

Find a Group by it’s Name // 通过“分组名称”查找一个分组

Find a group by it’s name.
通过“分组名称”查找一个分组。

  1. try
  2. {
  3.     $group = Sentry::findGroupByName('admin');
  4. }
  5. catch (Cartalyst\Sentry\Groups\GroupNotFoundException $e)
  6. {
  7.     echo 'Group was not found.';
  8. }

Exceptions // 异常

Below is a list of exceptions that the methods can throw.
下面是该方法可能抛出的异常的列表。

Exception Description
Cartalyst\Sentry\Groups\GroupNotFoundException If the provided group was not found, this exception will be thrown.
如果指定的分组没有找到，这个异常将被抛出。

Helpers // 辅助

getPermissions() // 返回一个分组的权限

Returns the permissions of a group.
返回一个分组的权限。

  1. try
  2. {
  3.     // Find the group using the group id
  4.     $group = Sentry::findGroupById(1);
  6.     // Get the group permissions
  7.     $groupPermissions = $group->getPermissions();
  8. }
  9. catch (Cartalyst\Sentry\Groups\GroupNotFoundException $e)
  10. {
  11.     echo 'Group does not exist.';
  12. }