trunk/obj/rapport_instruction.class.php

<?php
//$Id: rapport_instruction.class.php 6046 2016-02-26 15:27:06Z fmichon $ 
//gen openMairie le 07/01/2013 15:28

require_once ("../gen/obj/rapport_instruction.class.php");

class rapport_instruction extends rapport_instruction_gen {

    var $metadata = array(
        "om_fichier_rapport_instruction" => array(
            "dossier" => "getDossier",
            "dossier_version" => "getDossierVersion",
            "numDemandeAutor" => "getNumDemandeAutor",
            "anneemoisDemandeAutor" => "getAnneemoisDemandeAutor",
            "typeInstruction" => "getTypeInstruction",
            "statutAutorisation" => "getStatutAutorisation",
            "typeAutorisation" => "getTypeAutorisation",
            "dateEvenementDocument" => "getDateEvenementDocument",
            "groupeInstruction" => 'getGroupeInstruction',
            "title" => 'getTitle',
        ),
    );

    var $abstract_type = array(
        "om_fichier_rapport_instruction" => "file",
    );

    /** @var boolean Les nouvelles actions sont activées sur cet objet */
    var $activate_class_action;

    /**
     * Instance de la classe dossier
     *
     * @var mixed
     */
    var $inst_dossier = null;

    function rapport_instruction($id,&$db,$debug) {
        //On active les nouvelles actions
        $this->activate_class_action = true;
        $this->constructeur($id,$db,$debug);
    }// fin constructeur

    /**
     * Définition des actions disponibles sur la classe.
     *
     * @return void
     */
    function init_class_actions() {

        // On récupère les actions génériques définies dans la méthode 
        // d'initialisation de la classe parente
        parent::init_class_actions();

        // ACTION - 001 - modifier
        // Modification du libellé de l'action "modifier"
        $this->class_actions[1]["portlet"]["libelle"] = _("Modifier");
        $this->class_actions[1]["condition"] = array("show_rapport_instruction_finaliser_portlet_action",
                                                "is_editable");

        // ACTION - 002 - supprimer
        // Modification de la condition d'affichage de l'action "supprimer"
        $this->class_actions[2]["condition"] = array("show_rapport_instruction_finaliser_portlet_action",
                                                "is_deletable");

        // ACTION - 100 - edition
        // Permet d'afficher l'édition du rapport d'instruction
        $this->class_actions[100] = array(
            "identifier" => "edition",
            "portlet" => array(
                "type" => "action-blank",
                "libelle" => _("Edition"),
                "order" => 100,
                "class" => "pdf-16",
            ),
            "view" => "view_edition",
            "permission_suffix" => "consulter",
        );

        // ACTION - 110 - finalise
        // Permet de finaliser le rapport d'instruction
        $this->class_actions[110] = array(
            "identifier" => "finalise",
            "portlet" => array(
                "type" => "action-direct",
                "libelle" => _("Finaliser le document"),
                "order" => 110,
                "class" => "finalise",
            ),
            "view" => "formulaire",
            "method" => "finalize",
            "button" => "finalise",
            "permission_suffix" => "finaliser",
            "condition" => array("show_rapport_instruction_finaliser_portlet_action",
                            "is_finalizable"),
        );

        // ACTION - 120 - definalise
        // Permet de reprendre la rédaction du rapport d'instruction
        $this->class_actions[120] = array(
            "identifier" => "definalise",
            "portlet" => array(
                "type" => "action-direct",
                "libelle" => _("Reprendre la redaction du document"),
                "order" => 120,
                "class" => "definalise",
            ),
            "view" => "formulaire",
            "method" => "unfinalize",
            "button" => "definalise",
            "permission_suffix" => "definaliser",
            "condition" => array("show_unfinalize_portlet_action", 
                            "is_unfinalizable"),
        );
    }

    /**
     * CONDITION - is_editable.
     *
     * Condition pour afficher le bouton de modification.
     *
     * @return boolean
     */
    function is_editable() {
        
        //
        if ($this->f->can_bypass("rapport_instruction", "modifier")){
            return true;
        }
        
        if ($this->is_dossier_instruction_not_closed()&&$this->is_instructeur_from_division()){
            return true;
        }
        //
        return false;
    }

    /**
     * CONDITION - is_deletable.
     *
     * Condition pour afficher le bouton de suppression.
     *
     * @return boolean
     */
    function is_deletable() {

        if ($this->f->can_bypass("rapport_instruction", "supprimer")){
            return true;
        }
        
        if ($this->is_dossier_instruction_not_closed()&&$this->is_instructeur_from_division()){
            return true;
        }
        
        return false;
    }

    /**
     * CONDITION - is_finalizable.
     *
     * Condition pour afficher le bouton de finalisation.
     *
     * @return boolean
     */
    function is_finalizable() {

        if($this->f->can_bypass("rapport_instruction", "finaliser")){
            return true;
        }
        
        if ($this->is_instructeur_from_division() && $this->is_dossier_instruction_not_closed()){
            return true;
        }
        
        return false;
    }

    /**
     * CONDITION - is_unfinalizable.
     *
     * Condition pour afficher le bouton de définalisation.
     *
     * @return boolean
     */
    function is_unfinalizable() {

        if($this->f->can_bypass("rapport_instruction", "definaliser")){
            return true;
        }
        
        if ($this->is_instructeur_from_division() && $this->is_dossier_instruction_not_closed()){
            return true;
        }
        
        return false;
    }

    /**
     * Permet de récupérer l'édition de la consultation.
     *
     * @param string $output type de sortie
     *
     * @return string si le type de sortie est string, le contenu du pdf est retourné.
     */
    function generate_edition($output) {

        // Variable de retour
        $return = "";

        //
        $_GET["output"] = $output;
        $f = $this->f;
        // Redirection vers le script d'édition pdf avec les bons paramètres
        include "../pdf/pdfetat.php";

        // retour selon le paramètre
        if($output == "string") {
            $return = $pdf_output;
        }

        //
        return $return;
    }

    /**
     * VIEW - view_edition.
     *
     * Permet de visualiser le pdf en le générant ou en le récupérant depuis
     * le système de fichier.
     *
     * @return void
     */
    function view_edition() {

        //
        if($this->getVal("om_final_rapport_instruction") == 't'
            && $this->getVal("om_final_rapport_instruction") != null) {

            //
            $lien = '../spg/file.php?obj='.$this->table.'&'.
                    'champ=om_fichier_rapport_instruction&id='.$this->getVal($this->clePrimaire);
            //
            header("Location: ".$lien);
        } else {

            // Identifiant du rapport d'instruction
            $idx = $this->getVal($this->clePrimaire);

            // Récupère la colelctivité du dossier d'instruction
            $dossier_instruction_om_collectivite = $this->get_dossier_instruction_om_collectivite();

            //
            $collectivite = $this->f->getCollectivite($dossier_instruction_om_collectivite);

            // Génération du PDF
            $result = $this->compute_pdf_output('etat', $this->table, $collectivite, $idx);
            // Affichage du PDF
            $this->expose_pdf_output(
                $result['pdf_output'], 
                $result['filename']
            );
        }
    }

    /**
     * Récupère la collectivité du dossier d'instruction.
     *
     * @return integer
     */
    function get_dossier_instruction_om_collectivite() {

        //
        require_once "../obj/dossier_instruction.class.php";
        $dossier_instruction = new dossier_instruction($this->getVal('dossier_instruction'), $this->f->db, false);

        //
        return $dossier_instruction->getVal('om_collectivite');
    }
    
    // Modification du style de certains champs
    function setType(&$form,$maj) {
        parent::setType($form,$maj);

        $form->setType('dossier_instruction', 'hidden');
        
        if( $maj < 2 ){           
            // Select pour le proposition de décision
            $form->setType('proposition_decision', 'select');
        }

        // Modification 
        $form->setType('dossier_libelle', 'hiddenstatic');
        
        //Cache les champs pour la finalisation
        $form->setType('om_fichier_rapport_instruction', 'hidden');
        $form->setType('om_final_rapport_instruction', 'hidden');

        //
        if($maj == 110 || $maj == 120) {
            //
            foreach ($this->champs as $value) {
                //
                $form->setType($value, 'hidden');
            }
        }
    }
    
    // Pré-remplir les champs
    function setValsousformulaire(&$form, $maj,$validation,$idxformulaire,$retourformulaire,$typeformulaire,&$db,$DEBUG=null) {
        
        parent::setValsousformulaire($form, $maj,$validation,$idxformulaire,$retourformulaire,$typeformulaire,$db,$DEBUG);
        
        if($maj == 0) {
            
            // Analyse réglementaire
            // Choisi par l'administrateur
            $temp_analyse_reglementaire = explode("\r",$this->f->getParameter('rapport_instruction_analyse_reglementaire'));
            $analyse_reglementaire = "";
            foreach ($temp_analyse_reglementaire as $value) {
                $analyse_reglementaire .= "<p>".$value."</p>";
            }
               
            $form->setVal("analyse_reglementaire_om_html",$analyse_reglementaire);
            
            // Description du projet
            // Libellé des travaux du dossier en cours
            // Création de la requête
            $sql = "SELECT dossier_libelle, 
                        CONCAT(donnees_techniques.am_projet_desc,' ',donnees_techniques.co_projet_desc) as libelle
                    FROM 
                        ".DB_PREFIXE."dossier
                    LEFT JOIN ".DB_PREFIXE."donnees_techniques ON
                                donnees_techniques.dossier_instruction = dossier.dossier
                    WHERE 
                        dossier.dossier = '".$idxformulaire."'";
                        
            // Exécution de la requête
            $res = $db->query($sql);
            $this->f->addToLog("setVal(): db->query(\"".$sql."\");", VERBOSE_MODE);
            if ( database::isError($res)){
                die();
            }
            
            // Si le champ travaux est rempli
            while ($row=&$res->fetchrow(DB_FETCHMODE_ASSOC)){
                
                if ( $row['libelle'] != "" ){
                    
                    $description_projet = $row['libelle'];
                    
                    $form->setVal("description_projet_om_html",$description_projet);
                }

                // Ajout automatique du numéro de dossier d'instruction
                $form->setVal("dossier_libelle", $row['dossier_libelle']);
            }
            
            // Ajout automatique du numéro de dossier d'instruction
            $form->setVal("dossier_instruction",$idxformulaire);
        }
    }
    
    /*
     * Select pour le proposition_decision
     */
    function setSelect(&$form, $maj,&$db,$debug) {
        
        // Lors d'un ajout ou d'une modification
        if( $maj < 2 ){
            
            // proposition_decision
            $contenu=array();

            $k = 0;
            $contenu[0][$k]="";
            $contenu[1][$k++]=_('choisir')." "._('proposition_decision');
            
            // Si le paramètre existe et a été remplie
            if ( !is_null($this->f->getParameter('rapport_instruction_proposition_decision'))){
                             
                $donnees = $this->f->getParameter('rapport_instruction_proposition_decision');
                $donnees = explode('<br />', nl2br(htmlentities($donnees)));
                
                // Pour chaque ligne du paramètre, faire une ligne dans le select
                foreach ($donnees as $value) {
                
                    $contenu[0][$k]=$value;
                    $contenu[1][$k++]=$value;
                }
            }
            $form->setSelect("proposition_decision",$contenu);
            
        }

    }


    /**
     * Récupération du numéro de dossier d'instruction à ajouter aux métadonnées
     * @return string numéro de dossier d'autorisation
     */
    protected function getDossier() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->dossier;
    }
    /**
     * Récupération la version du dossier d'instruction à ajouter aux métadonnées
     * @return int Version
     */
    protected function getDossierVersion() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->version;
    }
    /**
     * Récupération du numéro de dossier d'autorisation à ajouter aux métadonnées
     * @return string numéro de dossier d'autorisation
     */
    protected function getNumDemandeAutor() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->dossier_autorisation;
    }
    /**
     * Récupération de la date de demande initiale du dossier à ajouter aux métadonnées
     * @return date date de la demande initiale
     */
    protected function getAnneemoisDemandeAutor() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->date_demande_initiale;
    }
    /**
     * Récupération du type de dossier d'instruction à ajouter aux métadonnées
     * @return string type du dossier d'instruction
     */
    protected function getTypeInstruction() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->dossier_instruction_type;
    }
    /**
     * Récupération du statut du dossier d'autorisation à ajouter aux métadonnées
     * @return string avis
     */
    protected function getStatutAutorisation() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->statut;
    }
    /**
     * Récupération du type de dossier d'autorisation à ajouter aux métadonnées
     * @return string type de dossier d'autorisation
     */
    protected function getTypeAutorisation() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->dossier_autorisation_type;
    }
    /**
     * Récupération de la date d'ajout de document à ajouter aux métadonnées
     * @return date de l'évènement
     */
    protected function getDateEvenementDocument() {
        return date("Y-m-d");
    }
    /**
     * Récupération du groupe d'instruction à ajouter aux métadonnées
     * @return string Groupe d'instruction
     */
    protected function getGroupeInstruction() {
        if(empty($this->specificMetadata)) {
            $this->getSpecificMetadata();
        }
        return $this->specificMetadata->groupe_instruction;
    }
    /**
     * Récupération du type du document à ajouter aux métadonnées
     * @return string Type de document
     */
    protected function getTitle() {
        return "Rapport d'instruction";
    }

    /**
     * Cette méthode permet de stocker en attribut toutes les métadonnées
     * nécessaire à l'ajout d'un document.
     */
    public function getSpecificMetadata() {
        //Requête pour récupérer les informations essentiels sur le dossier d'instruction
        $sql = "SELECT dossier.dossier as dossier,
                        dossier_autorisation.dossier_autorisation as dossier_autorisation, 
                        to_char(dossier.date_demande, 'YYYY/MM') as date_demande_initiale,
                        dossier_instruction_type.code as dossier_instruction_type, 
                        etat_dossier_autorisation.libelle as statut,
                        dossier_autorisation_type.code as dossier_autorisation_type,
                        groupe.code as groupe_instruction
                FROM ".DB_PREFIXE."dossier 
                    LEFT JOIN ".DB_PREFIXE."dossier_instruction_type  
                        ON dossier.dossier_instruction_type = dossier_instruction_type.dossier_instruction_type
                    LEFT JOIN ".DB_PREFIXE."dossier_autorisation 
                        ON dossier.dossier_autorisation = dossier_autorisation.dossier_autorisation 
                    LEFT JOIN ".DB_PREFIXE."etat_dossier_autorisation
                        ON  dossier_autorisation.etat_dossier_autorisation = etat_dossier_autorisation.etat_dossier_autorisation
                    LEFT JOIN ".DB_PREFIXE."dossier_autorisation_type_detaille
                        ON dossier_autorisation.dossier_autorisation_type_detaille = dossier_autorisation_type_detaille.dossier_autorisation_type_detaille
                    LEFT JOIN ".DB_PREFIXE."dossier_autorisation_type
                        ON dossier_autorisation_type_detaille.dossier_autorisation_type = dossier_autorisation_type.dossier_autorisation_type
                    LEFT JOIN ".DB_PREFIXE."groupe
                        ON dossier_autorisation_type.groupe = groupe.groupe
                WHERE dossier.dossier = '".$this->getVal("dossier_instruction")."'";
        $res = $this->db->query($sql);
        $this->f->addToLog("getSpecificMetadata() : db->query(".$sql.")", VERBOSE_MODE);
        if ( database::isError($res)){
            die();
        }
        
        //Le résultat est récupéré dans un objet
        $row =& $res->fetchRow(DB_FETCHMODE_OBJECT);

        //Si il y a un résultat
        if ($row !== null) {

            // Instrance de la classe dossier.
            // Il est nécessaire de préciser l'identifiant du dossier d'instruction
            // car le nom du champ n'est pas identique au nom de la table.
            // S'ils avaient été identiques, alors get_inst_common aurait récupérée
            // l'identifiant.
            $inst_dossier = $this->get_inst_dossier($this->getVal('dossier_instruction'));

            // Insère l'attribut version à l'objet
            $row->version = $inst_dossier->get_dossier_instruction_version();

            //Alors on créé l'objet dossier_instruction
            $this->specificMetadata = $row;
        }
    }
    
    /**
     * Surcharge du bouton retour afin de retourner sur le dossier d'instruction selon de cas
     */
    function retoursousformulaire($idxformulaire, $retourformulaire, $val,
                                  $objsf, $premiersf, $tricolsf, $validation,
                                  $idx, $maj, $retour) {
        
        // Ajout et consultation, retour dossier
        if ( ( $maj == 0 && $validation == 0 ) || 
            ( $maj == 3 && $validation == 0 ) ||
            ( $maj == 0 && $validation == 1 ) ){
         
            echo "\n<a class=\"retour\" ";
                echo "href=\"#\" ";
                echo "onclick=\"redirectPortletAction(1,'main');\" ";
                echo ">";
                echo _("Retour");
            echo "</a>\n";
        }
        //Sinon affiche un retour normal
        else {
            
            parent::retoursousformulaire($idxformulaire, $retourformulaire, $val,
                                  $objsf, $premiersf, $tricolsf, $validation,
                                  $idx, $maj, $retour);
        }
    }
    
    /**
     * TREATMENT - finalize.
     * 
     * Permet de finaliser un enregistrement.
     *
     * @param array $val  valeurs soumises par le formulaire
     *
     * @return boolean
     */
    function finalize($val = array()) {
        // Begin
        $this->begin_treatment(__METHOD__);
        
        //
        $ret = $this->manage_finalizing("finalize", $val);

        // Si le traitement ne s'est pas déroulé correctement
        if ($ret !== true) {

            // Return
            return $this->end_treatment(__METHOD__, false);
        }

        // Return
        return $this->end_treatment(__METHOD__, true);
        
    }

    /**
     * TREATMENT - unfinalize.
     * 
     * Permet de definaliser un enregistrement.
     *
     * @param array $val  valeurs soumises par le formulaire
     *
     * @return boolean
     */
    function unfinalize($val = array()) {
        // Begin
        $this->begin_treatment(__METHOD__);

        //
        $ret = $this->manage_finalizing("unfinalize", $val);

        // Si le traitement ne s'est pas déroulé correctement
        if ($ret !== true) {

            // Return
            return $this->end_treatment(__METHOD__, false);
        }

        // Return
        return $this->end_treatment(__METHOD__, true);
    }

    /**
     * Finalisation des documents.
     * 
     * @param string $mode finalize/unfinalize
     * @param array  $val  valeurs soumises par le formulaire
     */
    function manage_finalizing($mode = null, $val = array()) {

        // Si le mode n'existe pas on retourne false
        if ($mode != "finalize" && $mode != "unfinalize") {
            return false;
        }

        // Recuperation de la valeur de la cle primaire de l'objet
        $id = $this->getVal($this->clePrimaire);

        // Si on finalise le document
        if ($mode == "finalize") {

            // Récupère la colelctivité du dossier d'instruction
            $dossier_instruction_om_collectivite = $this->get_dossier_instruction_om_collectivite();
            //
            $collectivite = $this->f->getCollectivite($dossier_instruction_om_collectivite);
            // Génération du PDF
            $result = $this->compute_pdf_output('etat', $this->table, $collectivite, $id);
            $pdf_output = $result['pdf_output'];

            //Métadonnées du document
            $metadata = array(
                'filename' => 'rapport_instruction_'.$id.'.pdf',
                'mimetype' => 'application/pdf',
                'size' => strlen($pdf_output)
            );
            // Récupération des métadonnées calculées après validation
            $spe_metadata = $this->getMetadata("om_fichier_rapport_instruction");

            // Assemble les métadonnées
            $metadata = array_merge($metadata, $spe_metadata);

            // Si le document a déjà été finalisé
            if ($this->getVal("om_fichier_rapport_instruction") != '') {

                // Met à jour le document mais pas son uid
                $uid = $this->f->storage->update(
                    $this->getVal("om_fichier_rapport_instruction"), $pdf_output, $metadata);
            }
            // Sinon, ajoute le document et récupère son uid
            else {

                // Stockage du PDF
                $uid = $this->f->storage->create($pdf_output, $metadata);
            }
        }
        else {
            //Récupération de l'uid du document finalisé
            $uid = $this->getVal("om_fichier_rapport_instruction");

            //On dé-finalise avant de finaliser
            if ($uid == '' || $uid == 'OP_FAILURE'){
                $this->correct = false;
                $this->msg = "";
                $this->addToMessage(_("Finalisation non enregistree"));
                $this->addToLog(
                    _("Finalisation non enregistree")." - ".
                    _("id consultation")." = ".$id." - ".
                    _("uid fichier")." = ".$uid
                );

                // Stop le traitement
                return false;
            }
        }

        //Mise à jour des données
        if ($uid != '' && $uid != 'OP_FAILURE') {

            // Logger
            $this->addToLog(__METHOD__."() - begin", EXTRA_VERBOSE_MODE);

            //
            foreach ($this->champs as $key => $value) {
                //
                $val[$value] = $this->val[$key];
            }

            //
            $this->setvalF($val);
            // Verification de la validite des donnees
            $this->verifier($this->val, $this->db, DEBUG);
            // Si les verifications precedentes sont correctes, on procede a
            // la modification, sinon on ne fait rien et on retourne une erreur
            if ($this->correct) {

                // Execution du trigger 'before' specifique au MODE 'update'
                $this->triggermodifier($id, $this->db, $this->val, DEBUG);

                //
                $valF = '';
                if($mode=="finalize") {
                    $valF["om_final_rapport_instruction"] = true;
                } else {
                    $valF["om_final_rapport_instruction"] = false;
                }
                $valF["om_fichier_rapport_instruction"] = $uid;

                // Execution de la requête de modification des donnees de l'attribut
                // valF de l'objet dans l'attribut table de l'objet
                $res = $this->db->autoExecute(DB_PREFIXE.$this->table, $valF, 
                    DB_AUTOQUERY_UPDATE, $this->getCle($id));
                $this->addToLog(
                    __METHOD__."() : db->autoExecute(\"".DB_PREFIXE.$this->table."\", ".print_r($valF, true).", DB_AUTOQUERY_UPDATE, \"".$this->getCle($id)."\")",
                    VERBOSE_MODE
                );

                // Si une erreur survient
                if (database::isError($res, true)) {

                    // Appel de la methode de recuperation des erreurs
                    $this->erreur_db($res->getDebugInfo(), $res->getMessage(), '');
                    $this->correct = false;
                    return false;
                } else {

                    // Log
                    $this->addToLog(_("Requete executee"), VERBOSE_MODE);
                    // Log
                    $message = _("Enregistrement")."&nbsp;".$id."&nbsp;";
                    $message .= _("de la table")."&nbsp;\"".$this->table."\"&nbsp;";
                    $message .= "[&nbsp;".$this->db->affectedRows()."&nbsp;";
                    $message .= _("enregistrement(s) mis a jour")."&nbsp;]";
                    $this->addToLog($message, VERBOSE_MODE);
                    // Execution du trigger 'after' specifique au MODE 'update'
                    $this->triggermodifierapres($id, $this->db, $this->val, DEBUG);
                    
                    if($mode == "finalize") {
                        $etat = _('finalisation');
                    } else {
                        $etat = _('definalisation');
                    }
                    $this->msg = "";
                    $this->addToMessage(sprintf(_("La %s du document s'est effectuee avec succes."), $etat));
                    return true;
                }
            //
            } else {
                $this->correct = false;
                $this->msg="";
                // Message d'echec (saut d'une ligne supplementaire avant le
                // message pour qu'il soit mis en evidence)
                $this->addToMessage(_("Finalisation non enregistree"));
                $this->addToLog(
                    _("Finalisation non enregistree")." - ".
                    _("id consultation")." = ".$id." - ".
                    _("uid fichier")." = ".$uid
                );
                return false;
            }
        }
        // Si le document n'a pas été stocké
        else{
            $this->correct = false;
            $this->msg="";
            $this->addToMessage(_("Finalisation non enregistree"));
            $this->addToLog(
                _("Finalisation non enregistree")." - ".
                _("id consultation")." = ".$id." - ".
                _("uid fichier")." = ".$uid
            );
            return false;
        }
    }

    /**
     * Cette variable permet de stocker le résultat de la méthode
     * getDivisionFromDossier() afin de ne pas effectuer le recalcul à chacun de
     * ces appels.
     * @var string Code de la division du dossier en cours
     */
    var $_division_from_dossier = NULL;

    /**
     * Cette méthode permet de récupérer le code de division correspondant
     * au dossier sur lequel on se trouve.
     *
     * @return string Code de la division du dossier en cours
     */
    function getDivisionFromDossier() {

        // Cette méthode peut être appelée plusieurs fois lors d'une requête.
        // Pour éviter de refaire le traitement de recherche de la division
        // alors on vérifie si nous ne l'avons pas déjà calculé.
        if ($this->_division_from_dossier != NULL) {
            // Logger
            $this->addToLog("getDivisionFromDossier(): retour de la valeur déjà calculée - '".$this->_division_from_dossier."'", EXTRA_VERBOSE_MODE);
            // On retourne la valeur déjà calculée
            return $this->_division_from_dossier;
        }

        // Par défaut, on définit la valeur du dossier à NULL
        $dossier = NULL;
        // Test sur le mode et le contexte du formulaire
        if ($this->getParameter("maj") == 0
            && ($this->getParameter("retourformulaire") == "dossier"
                || $this->getParameter("retourformulaire") == "dossier_instruction"
                || $this->getParameter("retourformulaire") == "dossier_instruction_mes_encours"
                || $this->getParameter("retourformulaire") == "dossier_instruction_tous_encours"
                || $this->getParameter("retourformulaire") == "dossier_instruction_mes_clotures"
                || $this->getParameter("retourformulaire") == "dossier_instruction_tous_clotures")) {
            // Si on se trouve en mode AJOUT (seul mode où l'enregistrement
            // n'existe pas en base de données) ET que nous nous trouvons
            // dans le contexte d'un dossier d'instruction alors on récupère
            // le numéro de dossier depuis le paramètre 'idxformulaire'
            $dossier = $this->getParameter("idxformulaire");
        } else {
            // Sinon on récupère le numéro de dossier dans le champs dossier de
            // l'enregistrement (en base de données)
            $dossier = $this->getVal("dossier_instruction");
        }

        // On appelle la méthode de la classe utils qui renvoi le code de la
        // division d'un dossier, on la stocke pour ne pas refaire le calcul au
        // prochain appel de cette méthode
        $this->_division_from_dossier = $this->f->getDivisionFromDossier($dossier);
        // Logger
        $this->addToLog("getDivisionFromDossier(): retour de la valeur nouvellement calculée - '".$this->_division_from_dossier."'", EXTRA_VERBOSE_MODE);
        // On retourne la valeur retournée
        return $this->_division_from_dossier;

    }
    
    /**
     * Si le dossier d'instruction auquel est rattachée la consultation est 
     * cloturé, on affiche pas les liens du portlet.
     *
     * @return boolean true si non cloturé false sinon
     */
    function is_dossier_instruction_not_closed() {
        $idxformulaire = $this->getParameter("idxformulaire");
        $retourformulaire = $this->getParameter("retourformulaire");
        //Si le dossier d'instruction auquel est rattachée la consultation est 
        //cloturé, on affiche pas les liens du portlet
        if ( $idxformulaire != '' && 
            (
                $retourformulaire == 'dossier' ||
                $retourformulaire == 'dossier_instruction' ||
                $retourformulaire == 'dossier_instruction_mes_encours' ||
                $retourformulaire == 'dossier_instruction_tous_encours' ||
                $retourformulaire == 'dossier_instruction_mes_clotures' ||
                $retourformulaire == 'dossier_instruction_tous_clotures'
            )){
                
            //On récuppère le statut du dossier d'instruction        
            $statut = $this->f->getStatutDossier($idxformulaire);
            if ( $this->f->isUserInstructeur() && $statut == "cloture" ){
                return false;
            }
        }
        return true;
    }
    
    /**
     * Défini si l'utilisateur est un intructeur qui en correspond à la division
     * du dossier.
     *
     * @return boolean true si correspond false sinon
     */
    function is_instructeur_from_division() {
        
        if ($this->f->isUserInstructeur()
            && isset($this->f->om_utilisateur["division"])
            && $this->f->om_utilisateur["division"] != $this->getDivisionFromDossier()) {
            //
            return false;
        }
        return true;
    }
    
    /**
     * Si le document est finalisé l'action "finaliser" n'est pas affichée
     *
     * @return boolean true sinon lu false sinon
     */
    function show_rapport_instruction_finaliser_portlet_action() {
        if ($this->is_document_finalized("om_final_rapport_instruction")) {
            return false;
        }
        return true;
    }
    
    /**
     * Retourne is_document_finalized("om_final_consultation")
     *
     * @return boolean true si finalisé false sinon
     */
    function show_unfinalize_portlet_action() {
        return $this->is_document_finalized("om_final_rapport_instruction");
    }
    
    /**
     * Permet de savoir si le document passé en paramètre est finalisé
     *
     * @param string $field flag finalisé
     *
     * @return boolean true si finalisé false sinon
     */
    function is_document_finalized($field) {
        if($this->getVal($field) == 't') {
            return true;
        }
        return false;
    }


    /**
     * Récupère l'instance du dossier d'instruction
     *
     * @param mixed Identifiant du dossier d'instruction
     *
     * @return object
     */
    function get_inst_dossier($dossier = null) {
        //
        return $this->get_inst_common("dossier", $dossier);
    }


}// fin classe
?>