vendor/friendsofsymfony/user-bundle/Model/GroupableInterface.php line 14

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSUserBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\UserBundle\Model;
  14. /**
  15.  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  16.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  17.  * @author Christophe Coevoet <stof@notk.org>
  18.  *
  19.  * @deprecated Using Groups is deprecated since version 2.2 and will be removed in 3.0.
  20.  */
  21. interface GroupableInterface
  22. {
  23.     /**
  24.      * Gets the groups granted to the user.
  25.      *
  26.      * @return \Traversable
  27.      */
  28.     public function getGroups();
  30.     /**
  31.      * Gets the name of the groups which includes the user.
  32.      *
  33.      * @return array
  34.      */
  35.     public function getGroupNames();
  37.     /**
  38.      * Indicates whether the user belongs to the specified group or not.
  39.      *
  40.      * @param string $name Name of the group
  41.      *
  42.      * @return bool
  43.      */
  44.     public function hasGroup($name);
  46.     /**
  47.      * Add a group to the user groups.
  48.      *
  49.      * @return static
  50.      */
  51.     public function addGroup(GroupInterface $group);
  53.     /**
  54.      * Remove a group from the user groups.
  55.      *
  56.      * @return static
  57.      */
  58.     public function removeGroup(GroupInterface $group);
  59. }