540b681733c6fd70912b9dba0a06c3c4873f02a1
[ldapsaisie.git] / trunk / includes / class / class.LSattribute.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  * Attribut Ldap
25  *
26  * Cette classe modélise un attribut Ldap
27  *
28  * @author Benjamin Renard <brenard@easter-eggs.com>
29  */
30 class LSattribute {
31   
32   var $name;
33   var $config;
34   var $ldapObject;
35   var $ldap;
36   var $html;
37   var $data;
38   var $updateData=false;
39   var $is_validate=false;
40         var $_finalUpdateData=false;
41   
42   /**
43    * Constructeur
44    *
45    * Cette methode construit l'objet et définis la configuration.
46    * Elle lance la construction des objets LSattr_html et LSattr_ldap correspondant
47    * à ses types définis définis dans sa configuration
48    *
49    * @author Benjamin Renard <brenard@easter-eggs.com>
50    *
51    * @param[in] $name string Nom de l'attribut ldap
52    * @param[in] $config array Configuration de l'objet
53    * @param[in] &$ldapObject LSldapObject L'objet ldap parent
54    *
55    * @retval boolean Retourne true si la création a réussi, false sinon.
56    */   
57   function LSattribute ($name,$config,&$ldapObject) {
58     $this -> name = $name;
59     $this -> config = $config;
60                 $this -> ldapObject = $ldapObject;
61     
62     $html_type = "LSattr_html_".$config['html_type'];
63     $ldap_type = "LSattr_ldap_".$config['ldap_type'];
64     if((class_exists($html_type))&&(class_exists($ldap_type))) {
65       $this -> html = new $html_type($name,$config,$this);
66       $this -> ldap = new $ldap_type($name,$config,$this);
67     }
68     else {
69       $GLOBALS['LSerror'] -> addErrorCode(41,array('attr' => $name,'html'=>$config['html_type'],'ldap'=>$config['ldap_type']));
70       return;
71     }
72     return true;
73   }
74   
75   
76   /**
77    * Retourne la valeur du label de l'attribut
78    *
79    * @author Benjamin Renard <brenard@easter-eggs.com>
80    *
81    * @retval string Le label de l'attribut
82    *
83    * @see LSattr_html::getLabel()
84    */   
85
86   function getLabel() {
87     return $this -> html -> getLabel();
88   }
89   
90   /**
91    * Défini la valeur de l'attribut
92    *
93    * @author Benjamin Renard <brenard@easter-eggs.com>
94    *
95    * @retval boolean true
96    */
97   function loadData($attr_data) {
98     $this -> data = $attr_data;
99     return true;
100   }
101   
102   /**
103    * Redéfini la valeur de l'attribut
104    *
105    * @author Benjamin Renard <brenard@easter-eggs.com>
106    *
107    * @retval boolean true
108    */
109   function reloadData($attr_data) {
110     $this -> data = $attr_data;
111     $this -> updateData=false;
112     $this -> is_validate=false;
113     return true;
114   }
115   
116   /**
117    * Retourne la valeur de l'attribut
118          *
119          * Retourne la valeur nouvelle si elle existe, sinon la valeur passé.
120    *
121    * @author Benjamin Renard <brenard@easter-eggs.com>
122    *
123    * @retval mixed La valeur de l'attribut
124    */
125   function getValue() {
126                 $updateData=$this -> getUpdateData();
127                 if (empty($updateData)) {
128             return $this -> data;
129                 }
130                 else {
131                         return $updateData;
132                 }
133   }
134   
135   /**
136    * Retourne la valeur d'affichage de l'attribut
137    *
138    * @author Benjamin Renard <brenard@easter-eggs.com>
139    *
140    * @retval string La valeur d'affichage de l'attribut
141    */
142   function getDisplayValue() {
143     $data = $this -> ldap -> getDisplayValue($this -> data);
144     if ($this -> config['onDisplay']) {
145       if (is_array($this -> config['onDisplay'])) {
146         $result=$data;
147         foreach($this -> config['onDisplay'] as $func) {
148           if (function_exists($func)) {
149             $result=$func($result);
150           }
151           else {
152             $GLOBALS['LSerror'] -> addErrorCode(42,array('attr' => $this->name,'func' => $func));
153             return;
154           }
155         }
156         return $result;
157       }
158       else {
159         if (function_exists($this -> config['onDisplay'])) {
160           return $this -> config['onDisplay']($data);
161         }
162         else {
163           $GLOBALS['LSerror'] -> addErrorCode(42,array('attr' => $this->name,'func' => $this -> config['onDisplay']));
164           return;
165         }
166       }
167     }
168     return $data;
169   }
170   
171   /**
172    * Ajoute l'attribut au formualaire
173    *
174    * Cette méthode ajoute l'attribut au formulaire $form si l'identifiant de celui-ci
175    * ($idForm) est connu dans la configuration de l'objet.
176    *
177    * @author Benjamin Renard <brenard@easter-eggs.com>
178    *
179    * @param[in] object $form Le formulaire dans lequel doit être ajouté l'attribut
180    * @param[in] string $idForm L'identifiant du formulaire
181    * @param[in] objet  &$obj Objet utilisable pour la génération de la valeur de l'attribut
182    *
183    * @retval boolean true si l'ajout a fonctionner ou qu'il n'est pas nécessaire, false sinon
184    */
185   function addToForm(&$form,$idForm,&$obj=NULL) {
186     if(isset($this -> config['form'][$idForm])) {
187       if($this -> data !='') {
188         $data=$this -> getFormVal();
189       }
190       else if (isset($this -> config['default_value'])) {
191         $data=$obj -> getFData($this -> config['default_value']);
192       }
193       
194       $element = $this -> html -> addToForm($form,$idForm,$data);
195                         if(!$element) {
196                                 $GLOBALS['LSerror'] -> addErrorCode(206,$this -> name);
197                         }
198
199       if($this -> config['required']==1) {
200         $form -> setRequired($this -> name);
201       }
202
203       if($this -> config['form'][$idForm]==0) {
204         $element -> freeze();
205       }
206       
207       if(isset($this -> config['check_data'])) {
208         if(is_array($this -> config['check_data'])) {
209           foreach ($this -> config['check_data'] as $rule => $rule_infos) {
210             if((!$form -> isRuleRegistered($rule))&&($rule!='')) {
211               $GLOBALS['LSerror'] -> addErrorCode(43,array('attr' => $this->name,'rule' => $rule));
212               return;
213             }
214             if(!isset($rule_infos['msg']))
215               $rule_infos['msg']=getFData(_('La valeur du champs %{label} est invalide.'),$this -> config['label']);
216             if(!isset($rule_infos['param']))
217               $rule_infos['param']=NULL;
218             $form -> addRule($this -> name,$rule,array('msg' => $rule_infos['msg'], 'param' => $rule_infos['param']));
219           }
220         }
221         else {
222           $GLOBALS['LSerror'] -> addErrorCode(44,$this->name);
223         }
224       }
225     }
226     return true;
227   }
228   
229   /**
230    * Rafraichis la valeur de l'attribut dans un formualaire
231    *
232    * @author Benjamin Renard <brenard@easter-eggs.com>
233    *
234    * @param[in] object &$form LSform Le formulaire dans lequel doit être ajouté l'attribut
235    * @param[in] string $idForm L'identifiant du formulaire
236    *
237    * @retval boolean true si la valeur a été rafraichie ou que ce n'est pas nécessaire, false sinon
238    */
239   function refreshForm(&$form,$idForm) {
240     if(isset($this -> config['form'][$idForm])) {
241       //~ echo 'Attr : '.$this -> name.'| Val : '.$this -> data."<br />\n";
242       $form_element = &$form -> getElement($this -> name);
243       if(!empty($this -> data)) {
244         return $form_element -> setValue($this -> getFormVal());
245       }
246       else if (isset($this -> config['default_value'])) {
247         return $form_element -> setValue($this -> config['default_value']);
248       }
249     }
250     return true;
251   }
252   
253   /**
254    * Retourne la valeur a afficher dans le formulaire
255    *
256    * @author Benjamin Renard <brenard@easter-eggs.com>
257    *
258    * @retval string La valeur a afficher dans le formulaire.
259    */
260   function getFormVal() {
261     return $this -> getDisplayValue();
262   }
263   
264   /**
265    * Définis les données de mises à jour si un changement a eut lieu
266    *
267    * @author Benjamin Renard <brenard@easter-eggs.com>
268    *
269    * @param[in] string $data Les données de mise à jour.
270    *
271    * @retval void
272    */
273   function setUpdateData($data) {
274     if($this -> getFormVal() != $data)
275       $this -> updateData=$data;
276   }
277   
278   /**
279    * Vérifie si l'attribut a été validé
280    *
281    * @author Benjamin Renard <brenard@easter-eggs.com>
282    *
283    * @retval boolean true si l'attribut a été validé, false sinon
284    */
285   function isValidate() {
286     return $this -> is_validate;
287   }
288   
289   /**
290    * Valide le champs
291    *
292    * @author Benjamin Renard <brenard@easter-eggs.com>
293    *
294    * @retval void
295    */
296   function validate() {
297     $this -> is_validate=true;
298   }
299   
300   /**
301    * Vérifie si l'attribut a été mise à jour
302    *
303    * @author Benjamin Renard <brenard@easter-eggs.com>
304    *
305    * @retval boolean true si l'attribut a été mis à jour, false sinon
306    */
307   function isUpdate() {
308     return ($this -> updateData)?true:false;
309   }
310   
311   /**
312    * Vérifie si l'attribut est obligatoire
313    *
314    * @author Benjamin Renard <brenard@easter-eggs.com>
315    *
316    * @retval boolean true si l'attribut est obligatoire, false sinon
317    */
318   function isRequired() {
319     return $this -> config['required'];
320   }
321   
322   /**
323    * Vérifie si la valeur de l'attribut peut être générée
324    *
325    * @author Benjamin Renard <brenard@easter-eggs.com>
326    *
327    * @retval boolean true si la valeur de l'attribut peut être générée, false sinon
328    */
329   function canBeGenerated() {
330     return (function_exists($this -> config['generate_function']));
331   }
332
333         /**
334          * Génere la valeur de l'attribut à partir de la fonction de génération
335          *
336          * @author Benjamin Renard <brenard@easter-eggs.com>
337          *
338          * @retval boolean true si la valeur à put être générée, false sinon
339          */
340         function generateValue() {
341                 if ( ! $this -> canBeGenerated() ) {
342                         return;
343                 }
344                 $value=call_user_func($this -> config['generate_function'],$this -> ldapObject);
345                 if (!empty($value)) {
346                         //$this -> setValue($value); // pas nécéssaire ??
347                         $this -> updateData=$value;
348                         return true;
349                 }
350                 return;
351         }
352   
353   /**
354    * Retourne la valeur de l'attribut pour son enregistrement dans l'annuaire
355          * si l'attribut à été modifié.
356    *
357    * @author Benjamin Renard <brenard@easter-eggs.com>
358    *
359    * @retval mixed La valeur de l'attribut pour son enregistrement dans l'annuaire
360    */
361   function getUpdateData() {
362                 if (!$this -> isUpdate()) {
363                         return;
364                 }
365                 if ( $this -> _finalUpdateData ) {
366                         return  $this -> _finalUpdateData;
367                 }
368     $data=$this -> updateData;
369     if ($this -> config['onSave']) {
370       if (is_array($this -> config['onSave'])) {
371         $result=$data;
372         foreach($this -> config['onSave'] as $func) {
373           if (function_exists($func)) {
374             $result=$func($result);
375           }
376           else {
377             $GLOBALS['LSerror'] -> addErrorCode(45,array('attr' => $this->name,'func' => $func));
378             return;
379           }
380         }
381       }
382       else {
383         if (function_exists($this -> config['onSave'])) {
384           $result = $this -> config['onSave']($data);
385         }
386         else {
387           $GLOBALS['LSerror'] -> addErrorCode(45,array('attr' => $this->name,'func' => $this -> config['onSave']));
388           return;
389         }
390       }
391     }
392     else {
393       $result = $this -> ldap -> getUpdateData($data);
394     }
395                 $this -> _finalUpdateData = $result;
396     return $result;
397   }
398  
399   /**
400    * Retourne la configuration de validation de l'attribut
401    *
402    * @author Benjamin Renard <brenard@easter-eggs.com>
403    *
404    * @retval mixed La configuration de validation de l'attribut
405    */
406   function getValidateConfig() {
407     return $this -> config['validation'];
408   }
409
410   /**
411    * Retourne les attributs dépendants de celui-ci
412    *
413    * @author Benjamin Renard <brenard@easter-eggs.com>
414    *
415    * @retval array les noms des attributs dépendants
416    */
417   function getDependsAttrs() {
418     return $this -> config['dependAttrs'];
419   } 
420 }
421
422 ?>