public_html/includes/class/class.LSformElement_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 LSsession :: loadLSclass('LSformElement');
  24
  25 /**
  26  * Element select d'un formulaire pour LdapSaisie
  27  *
  28  * Cette classe définis les éléments select des formulaires.
  29  * Elle étant la classe basic LSformElement.
  30  *
  31  * Options HTML :
  32  * // *************************************
  33  * 'html_options' => array (
  34  *   selectable_object => array (
  35  *     'object_type' => '[Type d'LSobject selectionnable]',
  36  *     'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
  37  *     'value_attribute' => '[LSformat de la valeur clé référant à un LSobject donnée]'
  38  *   )
  39  * ),
  40  * // *************************************
  41  *
  42  * @author Benjamin Renard <brenard@easter-eggs.com>
  43  */
  44
  45 class LSformElement_select_object extends LSformElement {
  46
  47   var $fieldTemplate = 'LSformElement_select_object_field.tpl';
  48   var $template = 'LSformElement_select_object.tpl';
  49
  50  /**
  51   * Retourn les infos d'affichage de l'Ã©lÃ©ment
  52   *
  53   * Cette mÃ©thode retourne les informations d'affichage de l'Ã©lement
  54   *
  55   * @retval array
  56   */
  57   function getDisplay($refresh=NULL){
  58     LSsession :: addCssFile('LSformElement_select_object.css');
  59     if ($refresh) {
  60       $this -> values = $this -> getValuesFromSession();
  61     }
  62     $return = $this -> getLabelInfos();
  63
  64     if (!$this -> isFreeze()) {
  65       LSsession :: addJSconfigParam(
  66         $this -> name,
  67         array(
  68           'object_type' => $this -> selectableObject,
  69           'addBtn' => _('Modify'),
  70           'deleteBtns' => _('Delete'),
  71           'multiple' => (($this -> params['multiple'])?1:0),
  72           'noValueLabel' => _('No set value'),
  73           'noResultLabel' => _('No result')
  74         )
  75       );
  76
  77       LSsession :: addHelpInfos (
  78         'LSformElement_select_object',
  79         array(
  80           'searchAdd' => _("Fast Add"),
  81           'add' => _("Display advanced search and selection panel."),
  82           'delete' => _("Delete")
  83         )
  84       );
  85
  86       LSsession :: addJSscript('LSformElement_select_object_field.js');
  87       LSsession :: addJSscript('LSformElement_select_object.js');
  88       if (LSsession :: loadLSclass('LSselect')) {
  89         LSselect :: loadDependenciesDisplay();
  90       }
  91     }
  92     $return['html'] = $this -> fetchTemplate(NULL,array('selectableObject' => $this -> selectableObject));
  93     return $return;
  94   }
  95
  96   /*
  97    * Retourne les valeurs de l'objet à partir de la variable Session
  98    */
  99   function getValuesFromSession() {
 100     return $this -> attr_html -> getValuesFromSession();
 101   }
 102
 103   /**
 104    * DÃ©fini le type d'objet sÃ©lectionnable
 105    *
 106    * @param[in] $object string Le type d'object
 107    *
 108    * @retval void
 109    **/
 110   function setSelectableObject($object) {
 111     $this -> selectableObject = $object;
 112   }
 113
 114   /**
 115    * Exporte les valeurs de l'élément
 116    *
 117    * @retval Array Les valeurs de l'élement
 118    */
 119   function exportValues(){
 120     $values = $this -> attr_html -> getValuesFromFormValues($this -> values);
 121     return $values;
 122   }
 123
 124   /**
 125    * Définis la valeur de l'élément à partir des données
 126    * envoyées en POST du formulaire
 127    *
 128    * Cette méthode définis la valeur de l'élément à partir des données
 129    * envoyées en POST du formulaire.
 130    *
 131    * @author Benjamin Renard <brenard@easter-eggs.com>
 132    *
 133    * @param[in] [<b>required</b>] string or array La futur valeur de l'élément
 134    *
 135    * @retval boolean Retourne True
 136    */
 137   function setValueFromPostData($data) {
 138     LSformElement::setValueFromPostData($data);
 139     $this -> values = $this -> attr_html -> refreshForm($this -> values,true);
 140     return true;
 141   }
 142
 143   /**
 144    * Recherche les objets sélectionnables à partir du pattern fournis
 145    *
 146    * @param[in] $pattern Pattern de recherche
 147    *
 148    * @retval array(dn -> displayName) Les objets trouvés
 149    */
 150   function searchAdd ($pattern) {
 151     if (is_array($this -> params['html_options']['selectable_object'])) {
 152       if (LSsession :: loadLSobject($this -> params['html_options']['selectable_object']['object_type'])) {
 153         $obj = new $this -> params['html_options']['selectable_object']['object_type']();
 154         $ret = $obj -> getSelectArray($pattern,NULL,$this -> params['html_options']['selectable_object']['display_name_format']);
 155         if (is_array($ret)) {
 156           return $ret;
 157         }
 158       }
 159     }
 160     return array();
 161   }
 162
 163   public static function ajax_refresh(&$data) {
 164     if ((isset($_REQUEST['attribute'])) && (isset($_REQUEST['objecttype'])) && (isset($_REQUEST['objectdn'])) && (isset($_REQUEST['idform'])) ) {
 165       if (LSsession ::loadLSobject($_REQUEST['objecttype'])) {
 166         $object = new $_REQUEST['objecttype']();
 167         $form = $object -> getForm($_REQUEST['idform']);
 168         $field=$form -> getElement($_REQUEST['attribute']);
 169         $val = $field -> getValuesFromSession();
 170         if ( $val ) {
 171           $data = array(
 172             'objects'    => $val
 173           );
 174         }
 175       }
 176     }
 177   }
 178
 179   public static function ajax_searchAdd(&$data) {
 180     if ((isset($_REQUEST['attribute'])) && (isset($_REQUEST['objecttype'])) && (isset($_REQUEST['pattern'])) && (isset($_REQUEST['idform'])) ) {
 181       if (LSsession ::loadLSobject($_REQUEST['objecttype'])) {
 182         $object = new $_REQUEST['objecttype']();
 183         $form = $object -> getForm($_REQUEST['idform']);
 184         $field=$form -> getElement($_REQUEST['attribute']);
 185         $data['objects'] = $field -> searchAdd($_REQUEST['pattern']);
 186       }
 187     }
 188   }
 189 }
 190
 191 ?>