PHP Interface FOS\UserBundle\Model\GroupManagerInterface

All changes to groups should happen through this interface.
Author: Christophe Coevoet ([email protected])
Datei anzeigen Open project: KnpLabs/KnpUserBundle Interface Usage Examples

Public Methods

Method Description
createGroup ( string $name ) : FOS\UserBundle\Model\GroupInterface Returns an empty group instance
deleteGroup ( FOS\UserBundle\Model\GroupInterface $group ) : void Deletes a group
findGroupBy ( array $criteria ) : FOS\UserBundle\Model\GroupInterface Finds one group by the given criteria
findGroupByName ( string $name ) : FOS\UserBundle\Model\GroupInterface Finds a group by name
findGroups ( ) : Traversable Returns a collection with all user instances
getClass ( ) : string Returns the group's fully qualified class name
updateGroup ( FOS\UserBundle\Model\GroupInterface $group ) : void Updates a group

Method Details

createGroup() public method

Returns an empty group instance
public createGroup ( string $name ) : FOS\UserBundle\Model\GroupInterface
$name string
return FOS\UserBundle\Model\GroupInterface

deleteGroup() public method

Deletes a group
public deleteGroup ( FOS\UserBundle\Model\GroupInterface $group ) : void
$group FOS\UserBundle\Model\GroupInterface
return void

findGroupBy() public method

Finds one group by the given criteria
public findGroupBy ( array $criteria ) : FOS\UserBundle\Model\GroupInterface
$criteria array
return FOS\UserBundle\Model\GroupInterface

findGroupByName() public method

Finds a group by name
public findGroupByName ( string $name ) : FOS\UserBundle\Model\GroupInterface
$name string
return FOS\UserBundle\Model\GroupInterface

findGroups() public method

Returns a collection with all user instances
public findGroups ( ) : Traversable
return Traversable

getClass() public method

Returns the group's fully qualified class name
public getClass ( ) : string
return string

updateGroup() public method

Updates a group
public updateGroup ( FOS\UserBundle\Model\GroupInterface $group ) : void
$group FOS\UserBundle\Model\GroupInterface
return void