76b7d43b1d6dd002ea748079722884165ce349ff
[ldapsaisie.git] / public_html / includes / class / class.LSobjects.LSgroup.php
1 <?php
2 /*******************************************************************************
3  * Copyright (C) 2007 Easter-eggs
4  * http://ldapsaisie.labs.libre-entreprise.org
5  *
6  * Author: See AUTHORS file in top-level directory.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License version 2
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20
21 ******************************************************************************/
22
23 /**
24  * Objet Ldap group
25  *
26  * @author Benjamin Renard <brenard@easter-eggs.com>
27  */
28 class LSgroup extends LSldapObject {
29
30   var $userObjectType = 'LSpeople';
31   var $memberAttr = 'uniqueMember';
32
33   /* ========== Members ========== */
34   /**
35    * Retourne la valeur clef d'un membre
36    * 
37    * @param[in] $object Un object utilisateur
38    * 
39    * @retval Mixed La valeur clef d'un membre
40    **/
41   function getMemberKeyValue($object) {
42     return $this -> getObjectKeyValueInRelation($object,$this -> userObjectType);
43   }
44   
45   /**
46    * Retourne la liste des groupes pour utilisateur
47    * 
48    * Retourne un tableau de LSgroup correspondant aux groupes
49    * auxquels appartient un utilisateur
50    * 
51    * @param[in] $userObject Un object user (type : $this -> userObjectType)
52    * 
53    * @retval Array of LSgroup Les groupes de l'utilisateur
54    **/
55   function listUserGroups($userObject) {
56     return $this -> listObjectsInRelation($userObject,$this -> memberAttr,$this -> userObjectType);
57   }
58
59   /**
60    * Ajoute un utilisateur au groupe
61    * 
62    * @param[in] $object Un object user ($this -> userObjectType) : l'utilisateur à ajouter
63    * 
64    * @retval boolean true si l'utilisateur à été ajouté, False sinon
65    **/  
66   function addOneMember($object) {
67     return $this -> addOneObjectInRelation($object,$this -> memberAttr, $this -> userObjectType,'dn','canEditGroupRelation');
68   }
69   
70   /**
71    * Supprime un utilisateur du groupe
72    * 
73    * @param[in] $object Un object (type : $this -> userObjectType) : l'utilisateur à supprimer
74    * 
75    * @retval boolean true si l'utilisateur à été supprimé, False sinon
76    **/  
77   function deleteOneMember($object) {
78     return $this -> deleteOneObjectInRelation($object,$this -> memberAttr,$this -> userObjectType,'dn','canEditGroupRelation');
79   }
80   
81  /**
82   * Renome un utilisateur du groupe
83   * 
84   * @param[in] $object Un object (type : $this -> userObjectType) : l'utilisateur à renomer
85   * @param[in] $oldDn string L'ancien DN de l'utilisateur
86   * 
87   * @retval boolean True en cas de succès, False sinon
88   */
89   function renameOneMember($object,$oldDn) {
90     return $this -> renameOneObjectInRelation($object,$oldDn,$this -> memberAttr,$this -> userObjectType);
91   }
92   
93   /**
94    * Met à jour les groupes d'un utilisateur
95    * 
96    * @param[in] $object Mixed Un object (type : $this -> userObjectType) : l'utilisateur
97    * @param[in] $listDns Array(string) Un tableau des DNs des groupes de l'utilisateur
98    * 
99    * @retval boolean true si tout c'est bien passé, False sinon
100    **/  
101   function updateUserGroups($object,$listDns) {
102     return $this -> updateObjectsInRelation($object,$listDns,$this -> memberAttr,$this -> userObjectType,'dn','canEditGroupRelation');
103   }
104   
105   /**
106    * Test si l'utilisateur peut d'editer la relation avec ce groupe
107    * 
108    * @retval boolean true si tout l'utilisateur peut éditer la relation, False sinon
109    **/  
110   function canEditGroupRelation($dn=NULL) {
111     if (!$dn) {
112       $dn=$this -> dn;
113     }
114     return LSsession :: canEdit($this -> type_name,$this -> dn,$this -> memberAttr);
115   }
116 }
117
118 ?>