ldapsaisie/trunk/includes/class/class.LSattribute.php

<?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.

******************************************************************************/

$GLOBALS['LSsession'] -> loadLSclass('LSattr_ldap');
$GLOBALS['LSsession'] -> loadLSclass('LSattr_html');

/**
 * Attribut Ldap
 *
 * Cette classe mod<EFBFBD>lise un attribut Ldap
 *
 * @author Benjamin Renard <brenard@easter-eggs.com>
 */
class LSattribute {
  
  var $name;
  var $config;
  var $ldapObject;
  var $ldap;
  var $html;
  var $data;
  var $updateData=false;
  var $is_validate=false;
  var $_finalUpdateData=false;
  var $_myRights=NULL;
  
  /**
   * Constructeur
   *
   * Cette methode construit l'objet et d<EFBFBD>finis la configuration.
   * Elle lance la construction des objets LSattr_html et LSattr_ldap correspondant
   * <EFBFBD> ses types d<EFBFBD>finis d<EFBFBD>finis dans sa configuration
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @param[in] $name string Nom de l'attribut ldap
   * @param[in] $config array Configuration de l'objet
   * @param[in] &$ldapObject LSldapObject L'objet ldap parent
   *
   * @retval boolean Retourne true si la cr<EFBFBD>ation a r<EFBFBD>ussi, false sinon.
   */ 
  function LSattribute ($name,$config,&$ldapObject) {
    $this -> name = $name;
    $this -> config = $config;
    $this -> ldapObject = $ldapObject;
    $html_type = "LSattr_html_".$config['html_type'];
    $ldap_type = "LSattr_ldap_".$config['ldap_type'];
    $GLOBALS['LSsession'] -> loadLSclass($html_type);
    $GLOBALS['LSsession'] -> loadLSclass($ldap_type);
    if((class_exists($html_type))&&(class_exists($ldap_type))) {
      $this -> html = new $html_type($name,$config,$this);
      $this -> ldap = new $ldap_type($name,$config,$this);
    }
    else {
      $GLOBALS['LSerror'] -> addErrorCode(41,array('attr' => $name,'html'=>$config['html_type'],'ldap'=>$config['ldap_type']));
      return;
    }
    return true;
  }
  
  
  /**
   * Retourne la valeur du label de l'attribut
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval string Le label de l'attribut
   *
   * @see LSattr_html::getLabel()
   */ 

  function getLabel() {
    return $this -> html -> getLabel();
  }
  
  /**
   * D<EFBFBD>fini la valeur de l'attribut
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true
   */
  function loadData($attr_data) {
    $this -> data = $attr_data;
    return true;
  }
  
  /**
   * Red<EFBFBD>fini la valeur de l'attribut
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true
   */
  function reloadData($attr_data) {
    $this -> data = $attr_data;
    $this -> updateData=false;
    $this -> is_validate=false;
    return true;
  }
  
  /**
   * Retourne la valeur de l'attribut
   *
   * Retourne la valeur nouvelle si elle existe, sinon la valeur pass<EFBFBD>.
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval mixed La valeur de l'attribut
   */
  function getValue() {
    $updateData=$this -> getUpdateData();
    if (empty($updateData)) {
      return $this -> data;
    }
    else {
      return $updateData;
    }
  }
  
  /**
   * Retourne la valeur d'affichage de l'attribut
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval string La valeur d'affichage de l'attribut
   */
  function getDisplayValue() {
    $data = $this -> ldap -> getDisplayValue($this -> data);
    if ($this -> config['onDisplay']) {
      if (is_array($this -> config['onDisplay'])) {
        $result=$data;
        foreach($this -> config['onDisplay'] as $func) {
          if (function_exists($func)) {
            $result=$func($result);
          }
          else {
            $GLOBALS['LSerror'] -> addErrorCode(42,array('attr' => $this->name,'func' => $func));
            return;
          }
        }
        return $result;
      }
      else {
        if (function_exists($this -> config['onDisplay'])) {
          return $this -> config['onDisplay']($data);
        }
        else {
          $GLOBALS['LSerror'] -> addErrorCode(42,array('attr' => $this->name,'func' => $this -> config['onDisplay']));
          return;
        }
      }
    }
    return $data;
  }
  
  /**
   * Ajoute l'attribut au formualaire
   *
   * Cette m<EFBFBD>thode ajoute l'attribut au formulaire $form si l'identifiant de celui-ci
   * ($idForm) est connu dans la configuration de l'objet.
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @param[in] object $form Le formulaire dans lequel doit <EFBFBD>tre ajout<EFBFBD> l'attribut
   * @param[in] string $idForm L'identifiant du formulaire
   * @param[in] objet  &$obj Objet utilisable pour la g<EFBFBD>n<EFBFBD>ration de la valeur de l'attribut
   * @param[in] array  $value valeur de l'<EFBFBD>lement
   *
   * @retval boolean true si l'ajout a fonctionner ou qu'il n'est pas n<EFBFBD>cessaire, false sinon
   */
  function addToForm(&$form,$idForm,&$obj=NULL,$value=NULL) {
    if(isset($this -> config['form'][$idForm])) {
      if($this -> myRights() == 'n') {
        return true;
      }
      if ($value) {
        $data = $value;
      }
      else if($this -> data !='') {
        $data=$this -> getFormVal();
      }
      else if (isset($this -> config['default_value'])) {
        $data=$obj -> getFData($this -> config['default_value']);
      }
      
      $element = $this -> html -> addToForm($form,$idForm,$data);
      if(!$element) {
        $GLOBALS['LSerror'] -> addErrorCode(206,$this -> name);
      }

      if($this -> config['required']==1) {
        $form -> setRequired($this -> name);
      }

      if (($this -> config['form'][$idForm]==0) || ($this -> myRights() == 'r')) {
        $element -> freeze();
      }
      else {
        if(isset($this -> config['check_data'])) {
          if(is_array($this -> config['check_data'])) {
            foreach ($this -> config['check_data'] as $rule => $rule_infos) {
              if((!$form -> isRuleRegistered($rule))&&($rule!='')) {
                $GLOBALS['LSerror'] -> addErrorCode(43,array('attr' => $this->name,'rule' => $rule));
                return;
              }
              if(!isset($rule_infos['msg']))
                $rule_infos['msg']=getFData(_('La valeur du champs %{label} est invalide.'),$this -> config['label']);
              if(!isset($rule_infos['param']))
                $rule_infos['param']=NULL;
              $form -> addRule($this -> name,$rule,array('msg' => $rule_infos['msg'], 'param' => $rule_infos['param']));
            }
          }
          else {
            $GLOBALS['LSerror'] -> addErrorCode(44,$this->name);
          }
        }
      } 
    }
    return true;
  }

  /**
   * R<EFBFBD>cup<EFBFBD>ration des droits de l'utilisateur sur l'attribut
   * 
   * @retval string 'r'/'w'/'n' pour 'read'/'write'/'none'
   **/
  function myRights() {
    // cache
    if ($this -> _myRights != NULL) {
      return $this -> _myRights;
    }
    $return='n';
    switch ($this -> ldapObject -> whoami()) {
      case 'admin':
        if($this -> config['rights']['admin']=='w') {
          $return='w';
        }
        else {
          $return='r';
        }
        break;
      case 'self':
        if (($this -> config['rights']['self'] == 'w') || ($this -> config['rights']['self'] == 'r')) {
          $return=$this -> config['rights']['self'];
        }
        break;
      default:    //user
        if (($this -> config['rights']['user'] == 'w') || ($this -> config['rights']['user'] == 'r')) {
            $return=$this -> config['rights']['user'];
        }
        break;
    }
    $this -> _myRights = $return;
    return $return;
  }

  /**
   * Ajoute l'attribut au formualaire de vue
   *
   * Cette m<EFBFBD>thode ajoute l'attribut au formulaire $form de vue si il doit l'<EFBFBD>tre
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @param[in] object $form Le formulaire dans lequel doit <EFBFBD>tre ajout<EFBFBD> l'attribut
   *
   * @retval boolean true si l'ajout a fonctionner ou qu'il n'est pas n<EFBFBD>cessaire, false sinon
   */
  function addToView(&$form) {
    if((isset($this -> config['view'])) && ($this -> myRights() != 'n')) {
      if($this -> data !='') {
        $data=$this -> getFormVal();
      }
      else {
        $data='';
      }
      $element = $this -> html -> addToForm($form,'view',$data);
      if(!$element) {
        $GLOBALS['LSerror'] -> addErrorCode(206,$this -> name);
      }
      $element -> freeze();
      return true;
    }
    return true;
  }
  
  /**
   * Rafraichis la valeur de l'attribut dans un formualaire
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @param[in] object &$form LSform Le formulaire dans lequel doit <EFBFBD>tre ajout<EFBFBD> l'attribut
   * @param[in] string $idForm L'identifiant du formulaire
   *
   * @retval boolean true si la valeur a <EFBFBD>t<EFBFBD> rafraichie ou que ce n'est pas n<EFBFBD>cessaire, false sinon
   */
  function refreshForm(&$form,$idForm) {
    if(isset($this -> config['form'][$idForm]) && ($this -> myRights()=='w')) {
      $form_element = $form -> getElement($this -> name);
      $values = $this -> html -> refreshForm($this -> getFormVal());
      return $form_element -> setValue($values);
    }
    return true;
  }
  
  /**
   * Retourne la valeur a afficher dans le formulaire
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval string La valeur a afficher dans le formulaire.
   */
  function getFormVal() {
    $data=$this -> getDisplayValue();
    if(!is_array($data))
      $data=array($data);
    return $data;
  }
  
  /**
   * D<EFBFBD>finis les donn<EFBFBD>es de mises <EFBFBD> jour si un changement a eut lieu
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @param[in] string $data Les donn<EFBFBD>es de mise <EFBFBD> jour.
   *
   * @retval void
   */
  function setUpdateData($data) {
    if($this -> getFormVal() != $data) {
      $this -> updateData=$data;
    }
  }
  
  /**
   * V<EFBFBD>rifie si l'attribut a <EFBFBD>t<EFBFBD> valid<EFBFBD>
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true si l'attribut a <EFBFBD>t<EFBFBD> valid<EFBFBD>, false sinon
   */
  function isValidate() {
    return $this -> is_validate;
  }
  
  /**
   * Valide le champs
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval void
   */
  function validate() {
    $this -> is_validate=true;
  }
  
  /**
   * V<EFBFBD>rifie si l'attribut a <EFBFBD>t<EFBFBD> mise <EFBFBD> jour
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true si l'attribut a <EFBFBD>t<EFBFBD> mis <EFBFBD> jour, false sinon
   */
  function isUpdate() {
    return ($this -> updateData)?true:false;
  }
  
  /**
   * V<EFBFBD>rifie si l'attribut est obligatoire
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true si l'attribut est obligatoire, false sinon
   */
  function isRequired() {
    return $this -> config['required'];
  }
  
  /**
   * V<EFBFBD>rifie si la valeur de l'attribut peut <EFBFBD>tre g<EFBFBD>n<EFBFBD>r<EFBFBD>e
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true si la valeur de l'attribut peut <EFBFBD>tre g<EFBFBD>n<EFBFBD>r<EFBFBD>e, false sinon
   */
  function canBeGenerated() {
    return (function_exists($this -> config['generate_function']));
  }

  /**
   * G<EFBFBD>nere la valeur de l'attribut <EFBFBD> partir de la fonction de g<EFBFBD>n<EFBFBD>ration
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval boolean true si la valeur <EFBFBD> put <EFBFBD>tre g<EFBFBD>n<EFBFBD>r<EFBFBD>e, false sinon
   */
  function generateValue() {
    if ( ! $this -> canBeGenerated() ) {
      return;
    }
    $value=call_user_func($this -> config['generate_function'],$this -> ldapObject);
    if (!empty($value)) {
      //$this -> setValue($value); // pas n<>c<EFBFBD>ssaire ??
      $this -> updateData=array($value);
      return true;
    }
    return;
  }
  
  /**
   * Retourne la valeur de l'attribut pour son enregistrement dans l'annuaire
   * si l'attribut <EFBFBD> <EFBFBD>t<EFBFBD> modifi<EFBFBD>.
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval mixed La valeur de l'attribut pour son enregistrement dans l'annuaire
   */
  function getUpdateData() {
    if (!$this -> isUpdate()) {
      return;
    }
    if ( $this -> _finalUpdateData ) {
      return  $this -> _finalUpdateData;
    }
    $data=$this -> updateData;
    if ($this -> config['onSave']) {
      if (is_array($this -> config['onSave'])) {
        $result=$data;
        foreach($this -> config['onSave'] as $func) {
          if (function_exists($func)) {
            $result=$func($result);
          }
          else {
            $GLOBALS['LSerror'] -> addErrorCode(45,array('attr' => $this->name,'func' => $func));
            return;
          }
        }
      }
      else {
        if (function_exists($this -> config['onSave'])) {
          $result = $this -> config['onSave']($data);
        }
        else {
          $GLOBALS['LSerror'] -> addErrorCode(45,array('attr' => $this->name,'func' => $this -> config['onSave']));
          return;
        }
      }
    }
    else {
      $result = $this -> ldap -> getUpdateData($data);
    }
    $this -> _finalUpdateData = $result;
    return $result;
  }
 
  /**
   * Retourne la configuration de validation de l'attribut
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval mixed La configuration de validation de l'attribut
   */
  function getValidateConfig() {
    return $this -> config['validation'];
  }

  /**
   * Retourne les attributs d<EFBFBD>pendants de celui-ci
   *
   * @author Benjamin Renard <brenard@easter-eggs.com>
   *
   * @retval array les noms des attributs d<EFBFBD>pendants
   */
  function getDependsAttrs() {
    return $this -> config['dependAttrs'];
  }

}

?>