Below we’ll list all the valid that you can pass through the $attributes.

    Key Required Type Description
    name true string The name of the group.
    permissions false array The group permissions, pass a key/value pair.

    Example

    Exceptions

    Below is a list of exceptions that this method can throw.

    Example

    1. try
    2. {
    3.     // Find the group using the group id
    5.     // Update the group details
    6.     $group->name = 'Users';
    7.     $group->permissions = array(
    8.         'admin' => 1,
    9.         'users' => 1,
    10.     );
    12.     // Update the group
    13.     if ($group->save())
    14.     {
    15.         // Group information was updated
    16.     }
    17.     else
    18.     {
    19.         // Group information was not updated
    20.     }
    21. }
    22. catch (Cartalyst\Sentry\Groups\NameRequiredException $e)
    23.     echo 'Name field is required';
    24. }
    26. {
    27.     echo 'Group already exists.';
    28. }
    29. catch (Cartalyst\Sentry\Groups\GroupNotFoundException $e)
    30. {
    31.     echo 'Group was not found.';
    32. }

    Exceptions

    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.

    Example

    Exceptions

    Below is a list of exceptions that this method can throw.

    Sentry provides simple methods to find you your groups.

    Find all the Groups

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

    Find a group by its ID

    Find a group by it’s ID.

    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. {
    8. }

    Exceptions

    Exception Description
    Cartalyst\Sentry\Groups\GroupNotFoundException If the provided group was not found, this exception will be thrown.

    getPermissions()

    Returns the permissions of a group.