LSattr_html :: select_list / select_object : add parameter to handle onlyAccessible...
[ldapsaisie.git] / public_html / includes / class / class.LSattr_html_select_object.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  * Type d'attribut HTML select_object
25  *
26  * @author Benjamin Renard <brenard@easter-eggs.com>
27  */
28 class LSattr_html_select_object extends LSattr_html{
29
30   var $unrecognizedValues=false;
31
32   /**
33    * Ajoute l'attribut au formualaire passer en paramètre
34    *
35    * @param[in] &$form LSform Le formulaire
36    * @param[in] $idForm L'identifiant du formulaire
37    * @param[in] $data Valeur du champs du formulaire
38    *
39    * @retval LSformElement L'element du formulaire ajouté
40    */
41   function addToForm (&$form,$idForm,$data=NULL) {
42     $this -> config['attrObject'] = $this;
43     $element=$form -> addElement('select_object', $this -> name, $this -> config['label'],$this -> config,$this);
44     if(!$element) {
45       LSerror :: addErrorCode('LSform_06',$this -> name);
46       return;
47     }
48     if ($data) {
49       if (!is_array($data)) {
50         $data=array($data);
51       }
52       $values=$this -> getFormValues($data);
53       if ($values) {
54         $element -> setValue($values);
55       }
56     }
57     $element -> setSelectableObject($this -> config['html_options']['selectable_object']['object_type']);
58     return $element;
59   }
60
61   /**
62    * Effectue les tâches nécéssaires au moment du rafraichissement du formulaire
63    * 
64    * Récupère un array du type array('DNs' => 'displayName') à partir d'une
65    * liste de DNs.
66    * 
67    * @param[in] $data mixed La valeur de l'attribut (liste de DNs)
68    * 
69    * @retval mixed La valeur formatée de l'attribut (array('DNs' => 'displayName'))
70    **/
71   function refreshForm($data,$fromDNs=false) {
72     return $this -> getFormValues($data,$fromDNs);
73   }
74
75   /**
76    * Retourne un tableau des valeurs de l'attribut à partir des valeurs du formulaire
77    *
78    * @param[in] mixed Tableau des valeurs du formulaire
79    * 
80    * @author Benjamin Renard <brenard@easter-eggs.com>
81    *
82    * @retval array  Tableau des valeurs de l'attribut
83    */ 
84   function getValuesFromFormValues($values=NULL) {
85     $retValues = array();
86     if (isset($this -> config['html_options']['selectable_object'])) {
87       $conf=$this -> config['html_options']['selectable_object'];
88       if (!isset($conf['object_type'])) {
89         LSerror :: addErrorCode('LSattr_html_select_object_01',$this -> name);
90         return;
91       }
92       
93       if (!LSsession :: loadLSobject($conf['object_type'])) {
94         return;
95       }
96       
97       if (is_array($values)) {
98         $obj=new $conf['object_type']();
99         foreach($values as $dn => $name) {
100           if ($obj -> loadData($dn)) {
101             if(($conf['value_attribute']=='dn')||($conf['value_attribute']=='%{dn}')) {
102               $val = $dn;
103             }
104             elseif (!isset($obj->attrs[$conf['value_attribute']])) {
105               LSerror :: addErrorCode('LSattr_html_select_object_02',$this -> name);
106               return;
107             }
108             else {
109               $val = $obj -> getValue($conf['value_attribute']);
110               $val = $val[0];
111             }
112             if (empty($val)) {
113               continue;
114             }
115             $retValues[]=$val;
116           }
117         }
118         return $retValues;
119       }
120     }
121     return;
122   }
123
124   /**
125    * Retourne un tableau des objects selectionnés
126    *
127    * @param[in] mixed $values Tableau des valeurs de l'attribut
128    * @param[in] boolean $fromDNs True si les valeurs passées en paramètre sont des DNs
129    * 
130    * @author Benjamin Renard <brenard@easter-eggs.com>
131    *
132    * @retval array Tableau associatif des objects selectionés avec en clé
133    *               le DN et en valeur ce qui sera affiché.
134    */ 
135   function getFormValues($values=NULL,$fromDNs=false) {
136     $retInfos = array();
137     $DNs=array();
138     if (isset($this -> config['html_options']['selectable_object'])) {
139       $conf=$this -> config['html_options']['selectable_object'];
140       if (!isset($conf['object_type'])) {
141         LSerror :: addErrorCode('LSattr_html_select_object_01',$this -> name);
142         return;
143       }
144       
145       if (!LSsession :: loadLSobject($conf['object_type'])) {
146         return;
147       }
148       
149       if (is_array($values)) {
150         $obj = new $conf['object_type']();
151         if(($conf['value_attribute']=='dn')||($conf['value_attribute']=='%{dn}')||$fromDNs) {
152           $DNs=$values;
153           foreach($DNs as $dn) {
154             if($obj -> loadData($dn)) {
155               $retInfos[$dn] = $obj -> getDisplayName($conf['display_name_format']);
156             }
157           }
158         }
159         else {
160           if (!isset($conf['value_attribute']) || (!is_array(LSconfig::get('LSobjects.'.$conf['object_type'].'.attrs.'.$conf['value_attribute'])))) {
161             LSerror :: addErrorCode('LSattr_html_select_object_02',$this -> name);
162             return;
163           }
164           $unrecognizedValues=array();
165           foreach($values as $val) {
166             if (!empty($val)) {
167               $filter=Net_LDAP2_Filter::create($conf['value_attribute'],'equals',$val);
168               $sparams=array();
169               $sparams['onlyAccessible'] = (isset($conf['onlyAccessible'])?$conf['onlyAccessible']:False);
170               $listobj = $obj -> listObjectsName($filter,NULL,$sparams,$conf['display_name_format']);
171               if (count($listobj)==1) {
172                 foreach($listobj as $dn => $name) {
173                   $DNs[]=$dn;
174                   $retInfos[$dn] = $name;
175                 }
176               }
177               else {
178                 $unrecognizedValues[]=$val;
179                 if(count($listobj)>1) {
180                   LSerror :: addErrorCode('LSattr_html_select_object_03',array('val' => $val, 'attribute' => $this -> name));
181                 }
182               }
183             }
184           }
185           $this -> unrecognizedValues=$unrecognizedValues;
186         }
187       }
188       else {
189         return false;
190       }
191       $_SESSION['LSselect'][$conf['object_type']]=$DNs;
192       return $retInfos;
193     }
194     return false;
195   }
196
197
198   /**
199    * Retourne un tableau des valeurs de l'attribut à partir de la variable session
200    *
201    * @author Benjamin Renard <brenard@easter-eggs.com>
202    *
203    * @retval array Tableau associatif des objects selectionnés avec en clé
204    *               le DN et en valeur ce qui sera affiché.
205    */
206   function getValuesFromSession() {
207     if(is_array($_SESSION['LSselect'][$this -> config['html_options']['selectable_object']['object_type']])) {
208       return $this -> getFormValues($_SESSION['LSselect'][$this -> config['html_options']['selectable_object']['object_type']],true);
209     }
210     return false;
211   }
212
213   /**
214    * Return the values to be displayed in the LSform
215    *
216    * @param[in] $data The values of attribute
217    *
218    * @retval array The values to be displayed in the LSform
219    **/
220   function getFormVal($data) {
221     return $data;
222   }
223
224 }
225
226 /*
227  * Error Codes
228  */
229 LSerror :: defineError('LSattr_html_select_object_01',
230 _("LSattr_html_select_object : LSobject type is undefined (attribute : %{attr}).")
231 );
232 LSerror :: defineError('LSattr_html_select_object_02',
233 _("LSattr_html_select_object : the value of the parameter value_attribute in the configuration of the attribute %{attrs} is incorrect. This attribute does not exists.")
234 );
235 LSerror :: defineError('LSattr_html_select_object_03',
236 _("LSattr_html_select_object : more than one object returned corresponding to value %{val} of attribute %{attr}.")
237 );
238
239 ?>