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. @trigger_error('Using Groups is deprecated since version 2.2 and will be removed in 3.0.', E_USER_DEPRECATED);
  16. /**
  17.  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  18.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  19.  * @author Christophe Coevoet <stof@notk.org>
  20.  *
  21.  * @deprecated
  22.  */
  23. interface GroupableInterface
  24. {
  25.     /**
  26.      * Gets the groups granted to the user.
  27.      *
  28.      * @return \Traversable
  29.      */
  30.     public function getGroups();
  32.     /**
  33.      * Gets the name of the groups which includes the user.
  34.      *
  35.      * @return array
  36.      */
  37.     public function getGroupNames();
  39.     /**
  40.      * Indicates whether the user belongs to the specified group or not.
  41.      *
  42.      * @param string $name Name of the group
  43.      *
  44.      * @return bool
  45.      */
  46.     public function hasGroup($name);
  48.     /**
  49.      * Add a group to the user groups.
  50.      *
  51.      * @return static
  52.      */
  53.     public function addGroup(GroupInterface $group);
  55.     /**
  56.      * Remove a group from the user groups.
  57.      *
  58.      * @return static
  59.      */
  60.     public function removeGroup(GroupInterface $group);
  61. }