<?php
/*******************************************************************************
* Copyright (C) 2007 Easter-eggs
* http://ldapsaisie.labs.libre-entreprise.org
*
* Author: See AUTHORS file in top-level directory.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
******************************************************************************/
/**
* Type d'attribut HTML select_object
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*/
class LSattr_html_select_object extends LSattr_html{
var $unrecognizedValues=false;
/**
* Ajoute l'attribut au formualaire passer en paramètre
*
* @param[in] &$form LSform Le formulaire
* @param[in] $idForm L'identifiant du formulaire
* @param[in] $data Valeur du champs du formulaire
*
* @retval LSformElement L'element du formulaire ajouté
*/
public function addToForm (&$form,$idForm,$data=NULL) {
$this -> config['attrObject'] = $this;
$element=$form -> addElement('select_object', $this -> name, $this -> getLabel(), $this -> config, $this);
if(!$element) {
LSerror :: addErrorCode('LSform_06',$this -> name);
return;
}
if ($data) {
if (!is_array($data)) {
$data=array($data);
}
$values=$this -> getFormValues($data);
if ($values) {
$element -> setValue($values);
}
}
$element -> setSelectableObject($this -> getConfig('html_options.selectable_object.object_type'));
return $element;
}
/**
* Effectue les tâches nécéssaires au moment du rafraichissement du formulaire
*
* Récupère un array du type array('DNs' => 'displayName') à partir d'une
* liste de DNs.
*
* @param[in] $data mixed La valeur de l'attribut (liste de DNs)
*
* @retval mixed La valeur formatée de l'attribut (array('DNs' => 'displayName'))
**/
public function refreshForm($data,$fromDNs=false) {
return $this -> getFormValues($data,$fromDNs);
}
/**
* Retourne un tableau des valeurs de l'attribut à partir des valeurs du formulaire
*
* @param[in] mixed Tableau des valeurs du formulaire
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @retval array Tableau des valeurs de l'attribut
*/
public function getValuesFromFormValues($values=NULL) {
$conf = $this -> getConfig('html_options.selectable_object');
if (is_array($conf) && is_array($values)) {
$retValues = array();
if (!isset($conf['object_type'])) {
LSerror :: addErrorCode('LSattr_html_select_object_01',$this -> name);
return;
}
if (!isset($conf['value_attribute'])) {
LSerror :: addErrorCode('LSattr_html_select_object_02',$this -> name);
return;
}
if (!LSsession :: loadLSobject($conf['object_type'])) {
return;
}
$obj=new $conf['object_type']();
foreach($values as $dn => $name) {
if ($obj -> loadData($dn)) {
$val = '';
if(($conf['value_attribute']=='dn')||($conf['value_attribute']=='%{dn}')) {
$val = $dn;
}
else {
if (!isset($obj->attrs[$conf['value_attribute']])) {
LSerror :: addErrorCode('LSattr_html_select_object_02',$this -> name);
return;
}
$val = $obj -> getValue($conf['value_attribute']);
$val = $val[0];
}
if (empty($val)) {
continue;
}
$retValues[] = $val;
}
}
return $retValues;
}
return;
}
/**
* Retourne un tableau des objects selectionnés
*
* @param[in] mixed $values Tableau des valeurs de l'attribut
* @param[in] boolean $fromDNs True si les valeurs passées en paramètre sont des DNs
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @retval array Tableau associatif des objects selectionés avec en clé
* le DN et en valeur ce qui sera affiché.
*/
public function getFormValues($values=NULL, $fromDNs=false) {
$conf = $this -> getConfig('html_options.selectable_object');
if (is_array($conf) && is_array($values)) {
if (!isset($conf['object_type'])) {
LSerror :: addErrorCode('LSattr_html_select_object_01',$this -> name);
return;
}
if (!isset($conf['value_attribute'])) {
LSerror :: addErrorCode('LSattr_html_select_object_02',$this -> name);
return;
}
if (!LSsession :: loadLSobject($conf['object_type'])) {
return;
}
$retInfos = array();
$DNs=array();
$obj = new $conf['object_type']();
if(($conf['value_attribute']=='dn')||($conf['value_attribute']=='%{dn}')||$fromDNs) {
$DNs=$values;
foreach($DNs as $dn) {
if($obj -> loadData($dn)) {
$retInfos[$dn] = $obj -> getDisplayName($conf['display_name_format']);
}
}
}
else {
if (!is_array(LSconfig::get('LSobjects.'.$conf['object_type'].'.attrs.'.$conf['value_attribute']))) {
LSerror :: addErrorCode('LSattr_html_select_object_02', $this -> name);
return;
}
$unrecognizedValues=array();
foreach($values as $val) {
if (!empty($val)) {
$filter=Net_LDAP2_Filter::create($conf['value_attribute'],'equals',$val);
if (isset($conf['filter'])) $filter = LSldap::combineFilters('and',array($filter,$conf['filter']));
$sparams=array();
$sparams['onlyAccessible'] = (isset($conf['onlyAccessible'])?$conf['onlyAccessible']:False);
$listobj = $obj -> listObjectsName($filter, NULL, $sparams, (isset($conf['display_name_format'])?$conf['display_name_format']:false));
if (count($listobj)==1) {
foreach($listobj as $dn => $name) {
$DNs[]=$dn;
$retInfos[$dn] = $name;
}
}
else {
$unrecognizedValues[]=$val;
if(count($listobj)>1) {
LSerror :: addErrorCode('LSattr_html_select_object_03',array('val' => $val, 'attribute' => $this -> name));
}
}
}
}
$this -> unrecognizedValues=$unrecognizedValues;
}
$_SESSION['LSselect'][$conf['object_type']] = $DNs;
return $retInfos;
}
return false;
}
/**
* Retourne un tableau des valeurs de l'attribut à partir de la variable session
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @retval array Tableau associatif des objects selectionnés avec en clé
* le DN et en valeur ce qui sera affiché.
*/
public function getValuesFromSession() {
$obj_type = $this -> getConfig('html_options.selectable_object.object_type');
if ( $obj_type && is_array($_SESSION['LSselect'][$obj_type]) ) {
return $this -> getFormValues($_SESSION['LSselect'][$obj_type], true);
}
return false;
}
/**
* Return the values to be displayed in the LSform
*
* @param[in] $data The values of attribute
*
* @retval array The values to be displayed in the LSform
**/
public function getFormVal($data) {
return $data;
}
}
/*
* Error Codes
*/
LSerror :: defineError('LSattr_html_select_object_01',
_("LSattr_html_select_object : LSobject type is undefined (attribute : %{attr}).")
);
LSerror :: defineError('LSattr_html_select_object_02',
_("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.")
);
LSerror :: defineError('LSattr_html_select_object_03',
_("LSattr_html_select_object : more than one object returned corresponding to value %{val} of attribute %{attr}.")
);