Files
Chamilo/vendor/friendsofsymfony/user-bundle/Model/GroupableInterface.php
2025-08-14 22:41:49 +02:00

62 lines
1.3 KiB
PHP

<?php
/*
* This file is part of the FOSUserBundle package.
*
* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace FOS\UserBundle\Model;
/**
* @author Thibault Duplessis <thibault.duplessis@gmail.com>
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Christophe Coevoet <stof@notk.org>
*/
interface GroupableInterface
{
/**
* Gets the groups granted to the user.
*
* @return \Traversable
*/
public function getGroups();
/**
* Gets the name of the groups which includes the user.
*
* @return array
*/
public function getGroupNames();
/**
* Indicates whether the user belongs to the specified group or not.
*
* @param string $name Name of the group
*
* @return bool
*/
public function hasGroup($name);
/**
* Add a group to the user groups.
*
* @param GroupInterface $group
*
* @return static
*/
public function addGroup(GroupInterface $group);
/**
* Remove a group from the user groups.
*
* @param GroupInterface $group
*
* @return static
*/
public function removeGroup(GroupInterface $group);
}