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