ldapsaisie/src/includes/class/class.LSattr_html_select_list.php

459 lines
16 KiB
PHP
Raw Normal View History

2007-03-29 18:10:14 +02:00
<?php
/*******************************************************************************
* Copyright (C) 2007 Easter-eggs
* https://ldapsaisie.org
2007-03-29 18:10:14 +02:00
*
* 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_list
*
* 'html_options' => array (
* 'possible_values' => array (
* '[LSformat de la valeur clé]' => '[LSformat du nom d'affichage]',
* ...
* 'OTHER_OBJECT' => array (
* 'object_type' => '[Type d'LSobject]',
* 'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
* 'value_attribute' => '[Nom de l'attribut clé]',
* 'filter' => '[Filtre de recherche des LSobject]',
* 'scope' => '[Scope de la recherche]',
* 'basedn' => '[Basedn de la recherche]'
* )
* )
* ),
2020-04-29 15:54:21 +02:00
*
2007-03-29 18:10:14 +02:00
* @author Benjamin Renard <brenard@easter-eggs.com>
*/
class LSattr_html_select_list extends LSattr_html{
var $LSformElement_type = 'select';
/**
* Ajoute l'attribut au formualaire passer en paramètre
*
* @param LSform &$form Le formulaire
* @param string $idForm L'identifiant du formulaire
* @param array|string|null $data Valeur du champs du formulaire
*
* @return LSformElement L'element du formulaire ajouté
*/
public function addToForm (&$form,$idForm,$data=NULL) {
$possible_values=$this -> getPossibleValues();
$this -> config['text_possible_values'] = $possible_values;
$element=parent::addToForm($form,$idForm,$data);
if ($element) {
// Mise en place de la regle de verification des donnees
$form -> addRule($this -> name, 'LSformElement_select_validValue', array('msg'=> _('Invalid value'),'params' => array('possible_values' => $possible_values)) );
}
return $element;
2007-03-29 18:10:14 +02:00
}
/**
* Return array of possible values with translated labels (if enabled)
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array Associative array with possible values as key and corresponding
* translated label as value.
*/
protected function getPossibleValues() {
return static :: _getPossibleValues(
$this -> getConfig('html_options'),
$this -> name,
$this->attribute->ldapObject
);
}
2007-03-29 18:10:14 +02:00
/**
* Return array of possible values with translated labels (if enabled)
2007-03-29 18:10:14 +02:00
*
* @param array|false $options Attribute HTML options (optional)
* @param string|false $name Attribute name (optional)
* @param LSldapObject|false &$ldapObject Related LSldapObject (optional)
*
2007-03-29 18:10:14 +02:00
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array Associative array with possible values as key and corresponding
* translated label as value.
2020-04-29 15:54:21 +02:00
*/
public static function _getPossibleValues($options=false, $name=false, &$ldapObject=false) {
// Handle get_possible_values parameter
$retInfos = self :: getCallablePossibleValues($options, $name, $ldapObject);
if (!is_array($retInfos))
$retInfos = array();
// Handle other configured possible values
if (is_array($options) && isset($options['possible_values']) && is_array($options['possible_values'])) {
$translate_labels = LSconfig :: get('translate_labels', true, 'bool', $options);
foreach($options['possible_values'] as $val_key => $val_label) {
if($val_key==='OTHER_OBJECT') {
$objInfos=static :: getLSobjectPossibleValues($val_label,$options,$name);
$retInfos=static :: _array_merge($retInfos,$objInfos);
2007-03-29 18:10:14 +02:00
}
elseif($val_key==='OTHER_ATTRIBUTE') {
$attrInfos=static :: getLSattributePossibleValues($val_label, $options, $name, $ldapObject);
$retInfos=static :: _array_merge($retInfos,$attrInfos);
}
2021-06-10 18:45:00 +02:00
elseif (is_array($val_label)) {
if (!isset($val_label['possible_values']) || !is_array($val_label['possible_values']) || !isset($val_label['label']))
continue;
$subRetInfos=array();
foreach($val_label['possible_values'] as $vk => $vl) {
if ($vk==='OTHER_OBJECT') {
$objInfos=static :: getLSobjectPossibleValues($vl,$options,$name);
$subRetInfos=static :: _array_merge($subRetInfos,$objInfos);
}
else {
$vk = $ldapObject->getFData($vk);
$vl = $ldapObject->getFData(($translate_labels?__($vl):$vl));
$subRetInfos[$vk] = $vl;
}
}
static :: _sort($subRetInfos,$options);
$subRetLabel = $ldapObject->getFData(($translate_labels?__($val_label['label']):$val_label['label']));
$retInfos[] = array (
'label' => $subRetLabel,
'possible_values' => $subRetInfos
);
}
2007-03-29 18:10:14 +02:00
else {
$val_key = $ldapObject->getFData($val_key);
$val_label = $ldapObject->getFData(($translate_labels?__($val_label):$val_label));
$retInfos[$val_key] = $val_label;
2007-03-29 18:10:14 +02:00
}
}
}
static :: _sort($retInfos, $options);
return $retInfos;
}
/**
* Merge arrays preserving keys (string or numeric)
*
* As array_merge PHP function, this function merge arrays but
* this method permit to preverve key even if it's numeric key.
*
* @return array Merged array
**/
protected static function _array_merge() {
$ret=array();
foreach(func_get_args() as $a) {
foreach($a as $k => $v) {
$ret[$k]=$v;
}
}
return $ret;
}
/**
* Apply sort feature on possible values if this feature is enabled
*
* @param array &$retInfos Possible values array reference to sort
* @param array|false $options Attribute HTML options
*
* @return void
**/
public static function _sort(&$retInfos, $options) {
if (!isset($options['sort']) || $options['sort']) {
if (isset($options['sortDirection']) && $options['sortDirection']=='DESC') {
uasort($retInfos,array('LSattr_html_select_list','_sortTwoValuesDesc'));
}
else {
uasort($retInfos,array('LSattr_html_select_list','_sortTwoValuesAsc'));
}
}
}
/**
* Function use with uasort to sort two values in ASC order
*
* @param string $va One value
* @param string $va One value
*
* @return int Value for uasort
**/
protected static function _sortTwoValuesAsc(&$va,&$vb) {
if (is_array($va)) {
// Force sub-options at the end
$nva='ZZZZ'.$va['label'];
}
else {
$nva=$va;
}
if (is_array($vb)) {
// Force sub-options at the end
$nvb='ZZZZ'.$vb['label'];
}
else {
$nvb=$vb;
}
if ($nva == $nvb) return 0;
return strcoll(strtolower($nva), strtolower($nvb));
}
/**
* Function use with uasort to sort two values in DESC order
*
* @param string $va One value
* @param string $va One value
*
* @return int Value for uasort
**/
protected static function _sortTwoValuesDesc(&$va,&$vb) {
return (-1 * static :: _sortTwoValuesAsc($va,$vb));
}
/**
* Retourne un tableau des valeurs possibles d'un type d'objet
*
* @param array $conf OTHER_OBJECT configuration array
* @param array|false $options Attribute HTML options
* @param string $name Attribute name
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array|false Tableau associatif des valeurs possible de la liste avec en clé
* la valeur des balises option et en valeur ce qui sera affiché.
* False en cas d'erreur.
*/
protected static function getLSobjectPossibleValues($conf, $options, $name) {
$retInfos = array();
if ((!isset($conf['object_type'])) || ((!isset($conf['value_attribute'])) && (!isset($conf['values_attribute'])))) {
LSerror :: addErrorCode('LSattr_html_select_list_01',$name);
return false;
}
if (!LSsession :: loadLSclass('LSsearch')) {
return false;
}
$param=array(
'filter' => (isset($conf['filter'])?$conf['filter']:null),
'basedn' => (isset($conf['basedn'])?$conf['basedn']:null),
'scope' => (isset($conf['scope'])?$conf['scope']:null),
'displayFormat' => (isset($conf['display_name_format'])?$conf['display_name_format']:null),
'onlyAccessible' => (isset($conf['onlyAccessible'])?$conf['onlyAccessible']:False),
);
if (isset($conf['value_attribute']) && $conf['value_attribute']!='dn') {
$param['attributes'][] = $conf['value_attribute'];
}
if (isset($conf['values_attribute'])) {
$param['attributes'][] = $conf['values_attribute'];
}
$LSsearch = new LSsearch($conf['object_type'],'LSattr_html_select_list',$param,true);
$LSsearch -> run();
if (isset($conf['value_attribute'])) {
if(($conf['value_attribute']=='dn')||($conf['value_attribute']=='%{dn}')) {
$retInfos = $LSsearch -> listObjectsName();
}
else {
$list = $LSsearch -> getSearchEntries();
foreach($list as $entry) {
$key = $entry -> get($conf['value_attribute']);
if(is_array($key)) {
$key = $key[0];
}
$retInfos[$key]=$entry -> displayName;
}
}
}
if (isset($conf['values_attribute'])) {
$list = $LSsearch -> getSearchEntries();
foreach($list as $entry) {
$keys = $entry -> get($conf['values_attribute']);
foreach (ensureIsArray($keys) as $key) {
$retInfos[$key]=$key;
}
}
}
static :: _sort($retInfos,$options);
2007-03-29 18:10:14 +02:00
return $retInfos;
}
/**
* Retourne un tableau des valeurs possibles d'un autre attribut
*
* @param string|array $attr OTHER_ATTRIBUTE configuration value
* @param array|false $options Attribute HTML options
* @param string $name Attribute name
* @param LSldapObject &$ldapObject The related LSldapObject reference
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array Tableau associatif des valeurs possible de la liste avec en clé
* la valeur des balises option et en valeur ce qui sera affiché.
*/
protected static function getLSattributePossibleValues($attr, $options ,$name ,&$ldapObject) {
$retInfos=array();
if (is_string($attr)) {
if (isset($ldapObject->attrs[$attr]) && $ldapObject->attrs[$attr] instanceof LSattribute) {
$attr_values = ensureIsArray($ldapObject->attrs[$attr]->getValue());
if (isset($options['translate_labels']) && !$options['translate_labels']) {
foreach($attr_values as $attr_value)
$retInfos[$attr_value] = $attr_value;
}
else {
foreach($attr_values as $attr_value)
$retInfos[$attr_value] = __($attr_value);
}
}
else
LSerror :: addErrorCode('LSattr_html_select_list_02',$attr);
}
elseif (is_array($attr)) {
if (isset($attr['attr'])) {
if (isset($ldapObject->attrs[$attr['attr']]) && $ldapObject->attrs[$attr['attr']] instanceof LSattribute) {
if (isset($attr['json_component_key'])) {
if (get_class($ldapObject->attrs[$attr['attr']]->html) == 'LSattr_html_jsonCompositeAttribute') {
$attr_values = ensureIsArray($ldapObject->attrs[$attr['attr']]->getValue());
foreach($attr_values as $attr_value) {
$value_data = @json_decode($attr_value, true);
if (!isset($value_data[$attr['json_component_key']])) {
LSerror :: addErrorCode('LSattr_html_select_list_05', array('attr' => $attr['attr'], 'value' => $attr_value, 'component' => $attr['json_component_key']));
return $retInfos;
}
$key = $value_data[$attr['json_component_key']];
if (isset($attr['json_component_label'])) {
if (!isset($value_data[$attr['json_component_label']])) {
LSerror :: addErrorCode('LSattr_html_select_list_05', array('attr' => $attr['attr'], 'value' => $attr_value, 'component' => $attr['json_component_label']));
return $retInfos;
}
$label = $value_data[$attr['json_component_label']];
}
else
$label = $key;
$retInfos[$key] = $label;
}
}
else
LSerror :: addErrorCode('LSattr_html_select_list_03',$attr['attr']);
}
else
$retInfos = static :: getLSattributePossibleValues($attr['attr'], $options ,$name ,$ldapObject);
}
else
LSerror :: addErrorCode('LSattr_html_select_list_02',$attr['attr']);
}
else {
foreach($attr as $sub_attr => $sub_label) {
$subRetInfos = static :: getLSattributePossibleValues($sub_attr, $options ,$name ,$ldapObject);
static :: _sort($subRetInfos,$options);
$retInfos[] = array (
'label' => $sub_label,
'possible_values' => $subRetInfos
);
}
}
}
static :: _sort($retInfos,$options);
return $retInfos;
}
/**
* Return array of possible values with translated labels (if enabled)
* by using specify callable
*
* @param array $options Attribute HTML options
* @param string $name Attribute name
* @param LSldapObject &$ldapObject Related LSldapObject
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @return array|false Associative array with possible values as key and corresponding
* translated label as value, or false in case of error.
*/
public static function getCallablePossibleValues($options, $name, &$ldapObject) {
// Handle get_possible_values parameter
$get_possible_values = LSconfig :: get('get_possible_values', null, null, $options);
if (!$get_possible_values)
return array();
// Check callable
if (!is_callable($get_possible_values)) {
LSerror :: addErrorCode('LSattr_html_select_list_06', $name);
return false;
}
// Run callable
try {
$retInfos = call_user_func_array(
$get_possible_values,
array($options, $name, $ldapObject)
);
}
catch (Exception $er) {
self :: log_exception($er, get_called_class()." -> _getPossibleValues(): exception occured running ".format_callable($get_possible_values));
$retInfos = null;
}
// Check result
if (!is_array($retInfos)) {
LSerror :: addErrorCode(
'LSattr_html_select_list_07',
array(
'attr' => $name,
'callable' => format_callable($get_possible_values)
)
);
return false;
}
return $retInfos;
}
2007-03-29 18:10:14 +02:00
}
- LdapSaisie : J'ai commencé à écrire la docummentation de LdapSaisie que j'espère pour voir bientôt ajouté au SVN. Cela me fait mettre le doit sur quelques problèmes de nommages, d'organisation que j'ai corrigé sur le fait : - Concepte de level était enfaite celui de subDn : seule le nom subDn doit rester. - Le concept de LSrights dans LSsession et config.inc.php était mal nommé. Il correspond plus à la définition de LSprofile en réalité. Je l'ai renommé ainsi. - Les paramètres authobject et authobject_pwdattr n'étaient pas très représentatif. Je les ai renommé en authObjectType et authObjectTypeAttrPwd. - Templates : -> Correction du template default dans le but de changer la couleur bleu dominante juger trop flashy :). Au passage j'ai dégagé l'image de fond de #main utilisé pour colorer le menu : cette méthode est moche et quitte a à faire du moche je préfère utiliser un vulgaire tableau que des bidouille de ce genre. -> Création d'un logo pour LdapSaisie qui vient remplacer le logo Easter-Eggs utilisé jusqu'alors. -> Ajout d'un favicon. - LSerror : -> J'ai déplacé les definitions de code d'erreur dans le contexte concerné (càd dans les fichiers de définition des classes) (Feature Request #1757) -> J'en ai profité pour renommer les codes d'erreur avec un prefixe pour eviter les doublons -> J'ai donc modifié une grande partie des fichiers pour changer les codes erreurs utilisés -> Ajout d'une méthode getError() utilisé par getErrors() -> Modification de la méthode stop() - LSformElement_password : - Correction d'un bug dans la génération des mots de passe dans un formulaire de création d'objet. - Ajout d'une possiblité de choisir le type de hashage du mot de passe stocké dans l'annuaire (Feature Request #1756) - Traduction des commentaires - LSattribute : Ajout des vérifications dans les méthodes de la classe lors de l'utilisation des objets html et ldap. - LSsession : -> Renforcement des méthodes faisant des inclusions d'autres fichiers php.
2009-01-02 17:00:25 +01:00
/*
* Error Codes
*/
LSerror :: defineError('LSattr_html_select_list_01',
___("LSattr_html_select_list: Configuration data are missing to generate the select list of the attribute %{attr}.")
- LdapSaisie : J'ai commencé à écrire la docummentation de LdapSaisie que j'espère pour voir bientôt ajouté au SVN. Cela me fait mettre le doit sur quelques problèmes de nommages, d'organisation que j'ai corrigé sur le fait : - Concepte de level était enfaite celui de subDn : seule le nom subDn doit rester. - Le concept de LSrights dans LSsession et config.inc.php était mal nommé. Il correspond plus à la définition de LSprofile en réalité. Je l'ai renommé ainsi. - Les paramètres authobject et authobject_pwdattr n'étaient pas très représentatif. Je les ai renommé en authObjectType et authObjectTypeAttrPwd. - Templates : -> Correction du template default dans le but de changer la couleur bleu dominante juger trop flashy :). Au passage j'ai dégagé l'image de fond de #main utilisé pour colorer le menu : cette méthode est moche et quitte a à faire du moche je préfère utiliser un vulgaire tableau que des bidouille de ce genre. -> Création d'un logo pour LdapSaisie qui vient remplacer le logo Easter-Eggs utilisé jusqu'alors. -> Ajout d'un favicon. - LSerror : -> J'ai déplacé les definitions de code d'erreur dans le contexte concerné (càd dans les fichiers de définition des classes) (Feature Request #1757) -> J'en ai profité pour renommer les codes d'erreur avec un prefixe pour eviter les doublons -> J'ai donc modifié une grande partie des fichiers pour changer les codes erreurs utilisés -> Ajout d'une méthode getError() utilisé par getErrors() -> Modification de la méthode stop() - LSformElement_password : - Correction d'un bug dans la génération des mots de passe dans un formulaire de création d'objet. - Ajout d'une possiblité de choisir le type de hashage du mot de passe stocké dans l'annuaire (Feature Request #1756) - Traduction des commentaires - LSattribute : Ajout des vérifications dans les méthodes de la classe lors de l'utilisation des objets html et ldap. - LSsession : -> Renforcement des méthodes faisant des inclusions d'autres fichiers php.
2009-01-02 17:00:25 +01:00
);
LSerror :: defineError('LSattr_html_select_list_02',
___("LSattr_html_select_list: Invalid attribute %{attr} reference as OTHER_ATTRIBUTE possible values.")
);
LSerror :: defineError('LSattr_html_select_list_03',
___("LSattr_html_select_list: Attribute %{attr} referenced as OTHER_ATTRIBUTE possible values is not a jsonCompositeAttribute.")
);
LSerror :: defineError('LSattr_html_select_list_04',
___("LSattr_html_select_list: Fail to decode the following attribute %{attr} value as JSON : %{value}")
);
LSerror :: defineError('LSattr_html_select_list_05',
___("LSattr_html_select_list: No component %{component} found in the following attribute %{attr} JSON value : %{value}")
);
LSerror :: defineError('LSattr_html_select_list_06',
___("LSattr_html_select_list: Invalid get_possible_values parameter found in configuration of attribute %{attr}: must be a callable.")
);
LSerror :: defineError('LSattr_html_select_list_07',
2021-08-25 18:02:37 +02:00
___("LSattr_html_select_list: fail to retrieve possible values of attribute %{attr} using configured function %{callable}.")
);