vendor/bundles/FOS/UserBundle/Model/GroupableInterface.php
changeset 3 e54dfe4d0b2b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vendor/bundles/FOS/UserBundle/Model/GroupableInterface.php	Fri Sep 30 11:24:53 2011 +0200
@@ -0,0 +1,56 @@
+<?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 \Doctrine\Common\Collections\Collection
+     */
+    function getGroups();
+
+    /**
+     * Gets the name of the groups which includes the user.
+     *
+     * @return array
+     */
+    function getGroupNames();
+
+    /**
+     * Indicates whether the user belongs to the specified group or not.
+     *
+     * @param string $name Name of the group
+     * @return Boolean
+     */
+    function hasGroup($name);
+
+    /**
+     * Add a group to the user groups.
+     *
+     * @param GroupInterface $group
+     */
+    function addGroup(GroupInterface $group);
+
+    /**
+     * Remove a group from the user groups.
+     *
+     * @param GroupInterface $group
+     */
+    function removeGroup(GroupInterface $group);
+}