LSgroup/class : Added -> memberAttrValue parameter
[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   var $memberAttrValue = 'dn';
33
34   /* ========== Members ========== */
35   /**
36    * Retourne la valeur clef d'un membre
37    * 
38    * @param[in] $object Un object utilisateur
39    * 
40    * @retval Mixed La valeur clef d'un membre
41    **/
42   function getMemberKeyValue($object) {
43     return $this -> getObjectKeyValueInRelation($object,$this -> memberAttr,$this -> userObjectType);
44   }
45   
46   /**
47    * Retourne la liste des groupes pour utilisateur
48    * 
49    * Retourne un tableau de LSgroup correspondant aux groupes
50    * auxquels appartient un utilisateur
51    * 
52    * @param[in] $userObject Un object user (type : $this -> userObjectType)
53    * 
54    * @retval Array of LSgroup Les groupes de l'utilisateur
55    **/
56   function listUserGroups($userObject) {
57     return $this -> listObjectsInRelation($userObject,$this -> memberAttr,$this -> userObjectType,$this -> memberAttrValue);
58   }
59
60   /**
61    * Ajoute un utilisateur au groupe
62    * 
63    * @param[in] $object Un object user ($this -> userObjectType) : l'utilisateur à ajouter
64    * 
65    * @retval boolean true si l'utilisateur à été ajouté, False sinon
66    **/  
67   function addOneMember($object) {
68     return $this -> addOneObjectInRelation($object,$this -> memberAttr, $this -> userObjectType,$this -> memberAttrValue,'canEditGroupRelation');
69   }
70   
71   /**
72    * Supprime un utilisateur du groupe
73    * 
74    * @param[in] $object Un object (type : $this -> userObjectType) : l'utilisateur à supprimer
75    * 
76    * @retval boolean true si l'utilisateur à été supprimé, False sinon
77    **/  
78   function deleteOneMember($object) {
79     return $this -> deleteOneObjectInRelation($object,$this -> memberAttr,$this -> userObjectType,$this -> memberAttrValue,'canEditGroupRelation');
80   }
81   
82  /**
83   * Renome un utilisateur du groupe
84   * 
85   * @param[in] $object Un object (type : $this -> userObjectType) : l'utilisateur à renomer
86   * @param[in] $oldDn string L'ancien DN de l'utilisateur
87   * 
88   * @retval boolean True en cas de succès, False sinon
89   */
90   function renameOneMember($object,$oldDn) {
91     return $this -> renameOneObjectInRelation($object,$oldDn,$this -> memberAttr,$this -> userObjectType,$this -> memberAttrValue);
92   }
93   
94   /**
95    * Met à jour les groupes d'un utilisateur
96    * 
97    * @param[in] $object Mixed Un object (type : $this -> userObjectType) : l'utilisateur
98    * @param[in] $listDns Array(string) Un tableau des DNs des groupes de l'utilisateur
99    * 
100    * @retval boolean true si tout c'est bien passé, False sinon
101    **/  
102   function updateUserGroups($object,$listDns) {
103     return $this -> updateObjectsInRelation($object,$listDns,$this -> memberAttr,$this -> userObjectType,$this -> memberAttrValue,'canEditGroupRelation');
104   }
105
106   /**
107    * Test si l'utilisateur peut d'editer la relation avec ce groupe
108    * 
109    * @retval boolean true si tout l'utilisateur peut éditer la relation, False sinon
110    **/  
111   function canEditGroupRelation($dn=NULL) {
112     if (!$dn) {
113       $dn=$this -> dn;
114     }
115     return LSsession :: canEdit($this -> type_name,$this -> dn,$this -> memberAttr);
116   }
117 }
118
119 ?>