Document_Modele Class Reference

Class for the document template. More...

Collaboration diagram for Document_Modele:

Public Member Functions
	__construct ($p_cn, $p_id=-1)
	Delete ()
	Remove a template.
	form ()
	show the form for loading a template
	load ()
	load the value of a document_modele,the ag_id variable must be set
	move_uploaded_file ($temporary_name, $target_path)
	myList ()
	: show all the stored document_modele. return a string containing all the data separate by TD & TR tag
	Save ()
	: Save a document_modele in the database, if the document_modele doesn't exist yet it will be first created (-> insert into document_modele) in that case the name and the type must be set set before calling Save, the name will be modified with sql_string
	update ($p_array)
	: update a document_modele in the database,

Data Fields
	$cn
	$md_affect
	$md_filename
	$md_id
	$md_lob
	$md_mimetype
	$md_name
	$md_sequence
	$md_type
	$sequence
	$start

Detailed Description

Class for the document template.

Definition at line 26 of file document_modele.class.php.

Constructor & Destructor Documentation

__construct()

Document_Modele::__construct	(		$p_cn,
			$p_id = -1 )

Definition at line 40 of file document_modele.class.php.

    {
        $this->cn=$p_cn;
        $this->md_id=$p_id;
        $this->start=0;
    }

References $p_id, and cn.

Member Function Documentation

Delete()

Document_Modele::Delete

(

)

Remove a template.

Returns

nothing

Definition at line 213 of file document_modele.class.php.

    {
        $this->cn->start();
        // first we unlink the document
        $sql="select md_lob from document_modele where md_id=$1";
        $res=$this->cn->exec_sql($sql,[$this->md_id]);
        $r=Database::fetch_array($res,0);
        // if a lob is found
        if ( !empty ($r['md_lob']) &&$this->cn->exist_blob($r['md_lob']) )
        {
            // we remove it first
            $this->cn->lo_unlink($r['md_lob']);
        }
        // now we can delete the row
        $sql="delete from document_modele where md_id =$1";
        $res=$this->cn->exec_sql($sql,[$this->md_id]);
        $this->cn->commit();
    }

References $r, $res, $sql, cn, and DatabaseCore\fetch_array().

Here is the call graph for this function:

form()

Document_Modele::form

(

)

show the form for loading a template

Parameters

p_action

for the field action = destination url

Returns

string containing the forms

Definition at line 239 of file document_modele.class.php.

    {
        $r='<p class="notice">';
        $r.='Veuillez introduire les mod&egrave;les servant à g&eacute;n&eacute;rer vos documents';
        $r.='</p>';
        $r.='<form enctype="multipart/form-data"  method="post" onsubmit="return check_file_size(this,'.           MAX_FILE_SIZE.')">';
        $r.=\HtmlInput::hidden("MAX_FILE_SIZE", MAX_FILE_SIZE);
        $r.=dossier::hidden();
        // we need to add the sub action as hidden
        $h=new IHidden();
        $h->name="sa";
        $h->value="add_document";
 
        $r.=$h->input();
 
        $r.='<table>';
        $t=new IText();
        $t->name="md_name";
        $r.="<tr><td> Nom </td><td>".$t->input()."</td>";
 
        $r.="</tr>";
        $r.="<tr><td>Catégorie de document </td>";
        $w=new ISelect();
        $w->name="md_type";
 
        $w->value=$this->cn->make_array('select dt_id,dt_value from document_type order by dt_value');
        $r.="<td>".$w->input()."</td></tr>";
 
        $r.='<tr>';
        $r.=td(_('Affectation'));
        $waffect=new ISelect();
        $waffect->name='md_affect';
        $waffect->value=$this->cn->make_array("select dc_code,dc_comment from public.document_component order by dc_code");
 
        $r.=td($waffect->input());
        $r.='</tr>';
 
        $f=new IFile();
        $f->name="doc";
        $f->setAlertOnSize(true);
        $r.="<tr><td>fichier</td><td> ".$f->input()."</td></tr>";
 
        $start=new IText();
        $start->name="start_seq";
        $start->size=9;
        $start->value="0";
 
        $r.="<tr><td> Numerotation commence a</td><td> ".$start->input()."</td>";
        $r.='<td class="notice">Si vous laissez &agrave; 0, la num&eacute;rotation ne changera pas, la prochaine facture sera n+1, n étant le n° que vous avez donn&eacute;</td>';
        $r.="</tr>";
        $r.='</table>';
        $r.='<ul class="aligned-block">';
        $r.='<li>';
        $r.=HtmlInput::submit('add_document','Ajout');
        $r.='</li>';
        $r.='<li>';
        $r.=HtmlInput::button_hide("add_modele");
        $r.='</li>';
        $r.="</form></p>";
        return $r;
    }

References $f, $r, $start, $t, $w, _, cn, and td().

Here is the call graph for this function:

load()

Document_Modele::load

(

)

load the value of a document_modele,the ag_id variable must be set

Definition at line 302 of file document_modele.class.php.

    {
        $array=$this->cn->get_array("SELECT md_id, md_name, md_lob, md_type, md_filename, md_mimetype,md_affect".
                                    " FROM document_modele where md_id=$1",array($this->md_id));
        if ( count($array) == 0 ) return null;
        foreach ( array('md_name', 'md_lob','md_type', 'md_filename', 'md_mimetype','md_affect') as $idx)
        {
            $this->$idx=$array[0][$idx];
        }
    }

References $array, $idx, and cn.

Referenced by update().

move_uploaded_file()

Document_Modele::move_uploaded_file	(		$temporary_name,
			$target_path )

Definition at line 205 of file document_modele.class.php.

    {
        return move_uploaded_file ($temporary_name, $target_path);
    }

References move_uploaded_file().

Referenced by move_uploaded_file(), Save(), and update().

Here is the call graph for this function:

myList()

Document_Modele::myList

(

)

: show all the stored document_modele. return a string containing all the data separate by TD & TR tag

Returns

table in HTML Code

Definition at line 54 of file document_modele.class.php.

    {
        $dosid=dossier::id();
        $sql="select md_id,md_name,md_affect,dt_value,md_filename from document_modele join document_type on(dt_id=md_type) order by md_name";
        $Res=$this->cn->exec_sql($sql);
        $all=Database::fetch_all($Res);
        $r='';
        if ( Database::num_row($Res) != 0 ) {
 
          $r.='<p><form method="post">';
          $r.=dossier::hidden();
      $r.=\HtmlInput::filter_table("document_template_tb",'0,1,2,3',1);
          $r.='<table id="document_template_tb" class="result" >';
          $r.="<tr> ";
          $r.=th(_('Nom'));
          $r.=th(_('Catégorie'));
          $r.=th(_('Affect.'));
          $r.=th(_('Fichier'));
          $r.=th(_('Effacer'));
          $r.="</tr>";
      $idx=0;
          foreach ( $all as $row)
            {
          $even=($idx%2==0)?'class="odd"':'class="even"';
          $idx++;
              $r.="<tr $even>";
              $r.="<td>";
              $r.=h($row['md_name']);
              $r.="</td>";
              $r.="<td>";
              $r.=$row['dt_value'];
              $r.="</td>";
              $r.=td(h($row['md_affect']));
              $r.="<td>";
              $href=http_build_query(array('gDossier'=>$dosid,'md_id'=>$row['md_id'],'act'=>'RAW:document_template'));
              $r.='<A HREF="export.php?'.$href.'">'.h($row['md_filename']).'</a>';
              $r.="</td>";
              $r.="<TD>";
              $c=new ICheckBox();
              $c->name="dm_remove_".$row['md_id'];
              $r.=$c->input();
              $r.="</td>";
              $r.=td(\Icon_Action::modify(uniqid(),sprintf("modifyModeleDocument('%s','%s')",$row['md_id'],$dosid) ));
              $r.="</tr>";
            }
          $r.="</table>";
 
          // need hidden parameter for subaction
          $a=new IHidden();
          $a->name="sa";
          $a->value="rm_template";
          $r.=$a->input();
          $r.=HtmlInput::submit("rm_template",_("Effacer la sélection"));
        } else {
            echo h2(_("Aucun document"));
            echo _("Il n'y a aucun document, cliquez sur Ajouter pour en ajouter un");
        }
        $b=new IButton('show');
        $b->label="Ajout d'un document";
        $b->javascript="$('add_modele').style.display='block';new Draggable('add_modele',{starteffect:function(){
                      new Effect.Highlight(obj.id,{scroll:window,queue:'end'});}});";
                $r.=$b->input();
        $r.="</form></p>";
        return $r;
    }

References $a, $all, $b, $c, $href, $idx, $r, $Res, $row, $sql, _, cn, DatabaseCore\fetch_all(), h, h2(), Icon_Action\modify(), DatabaseCore\num_row(), td(), and th().

Here is the call graph for this function:

Save()

Document_Modele::Save

(

)

: Save a document_modele in the database, if the document_modele doesn't exist yet it will be first created (-> insert into document_modele) in that case the name and the type must be set set before calling Save, the name will be modified with sql_string

Definition at line 128 of file document_modele.class.php.

    {
        // if name is empty return immediately
        if ( trim(strlen($this->md_name))==0)
            return;
        try
        {
            // Start transaction
            $this->cn->start();
            // Save data into the table document_modele
            // if $this->md_id == -1 it means it is a new document model
            // so first we have to insert it
            // the name and the type must be set before calling save
            if ( $this->md_id == -1)
            {
 
                // insert into the table document_modele
                $this->md_id=$this->cn->get_next_seq('document_modele_md_id_seq');
                $sql="insert into document_modele(md_id,md_name,md_type,md_affect)
                     values ($1,$2,$3,$4)";
 
                $Ret=$this->cn->exec_sql($sql,array($this->md_id,$this->md_name,$this->md_type,$this->md_affect));
                // create the sequence for this modele of document
                $this->md_sequence="document_".$this->cn->get_next_seq("document_seq");
                // if start is not equal to 0 and he's a number than the user
                // request a number change
 
                if ( $this->start != 0 && isNumber($this->start) == 1 )
                {
                    $sql="alter sequence seq_doc_type_".$this->md_type." restart ".$this->start;
                    $this->cn->exec_sql($sql);
                }
 
            }
            // Save the file
            $new_name=tempnam($_ENV['TMP'],'document_');
            if ( strlen ($_FILES['doc']['tmp_name']) != 0 )
            {
                if ($this->move_uploaded_file($_FILES['doc']['tmp_name'],
                                       $new_name))
                {
                    // echo "Image saved";
                    $oid= $this->cn->lo_import($new_name);
                    if ( $oid == false )
                    {
                        echo_error('class/class_document_modele.php',__LINE__,"cannot upload document");
                        $this->cn->rollback();
                        return;
                    }
                    // Remove old document
                    $ret=$this->cn->exec_sql("select md_lob from document_modele where md_id=".$this->md_id);
                    if (Database::num_row($ret) != 0)
                    {
                        $r=Database::fetch_array($ret,0);
                        $old_oid=$r['md_lob'];
                        if (strlen(""??$old_oid) != 0)
                            $this->cn->lo_unlink($old_oid);
                    }
                    // Load new document
                    $this->cn->exec_sql("update document_modele set md_lob=".$oid.", md_mimetype='".$_FILES['doc']['type']."' ,md_filename='".$_FILES['doc']['name']."' where md_id=".$this->md_id);
                    $this->cn->commit();
                }
                else
                {
                    echo "<H1>"._("Erreur opération annulée")."</H1>";
                    $this->cn->rollback();
                   throw new Exception("DM191 : error loading  template".__FILE__.__LINE__);
                }
            }
        }
        catch (Exception $e)
        {
              record_log($e);
            $this->cn->rollback();
            return ;
        }
    }

References $e, $new_name, $r, $ret, $sql, $start, cn, echo_error(), DatabaseCore\fetch_array(), isNumber(), move_uploaded_file(), DatabaseCore\num_row(), record_log(), and return.

Here is the call graph for this function:

update()

Document_Modele::update

(

$p_array

)

: update a document_modele in the database,

Definition at line 315 of file document_modele.class.php.

    {
      $this->load();
        // if name is empty return immediately
        if ( trim(strlen($p_array['md_name']))==0)
            return;
        try
        {
            // Start transaction
            $this->cn->start();
            $sql="update document_modele set md_name=$1,md_type=$2,md_affect=$3 where md_id=$4";
            $this->cn->exec_sql($sql,array(
                                           $p_array['md_name'],
                                           $p_array['md_type'],
                                           $p_array['md_affect'],
                                           $this->md_id
                                           ));
            if ( $p_array['seq'] != 0 )
              $this->cn->alter_seq('seq_doc_type_'.$p_array['md_type'],$p_array['seq']);
 
            // Save the file
            $new_name=tempnam($_ENV['TMP'],'document_');
            if ( strlen ($_FILES['doc']['tmp_name']) != 0 )
            {
                if ($this->move_uploaded_file($_FILES['doc']['tmp_name'],
                                       $new_name))
                {
                    // echo "Image saved";
                    $oid= $this->cn->lo_import($new_name);
                    if ( $oid == false )
                    {
                        echo_error('class/class_document_modele.php',__LINE__,"cannot upload document");
                        $this->cn->rollback();
                        return;
                    }
                    // Remove old document
                    $ret=$this->cn->exec_sql("select md_lob from document_modele where md_id=".$this->md_id);
                    if (Database::num_row($ret) != 0)
                    {
                        $r=Database::fetch_array($ret,0);
                        $old_oid=$r['md_lob'];
                        if (strlen($old_oid) != 0)
                            $this->cn->lo_unlink($old_oid);
                    }
                    // Load new document
 
                    $this->cn->exec_sql("update document_modele 
                        set md_lob=$1, 
                            md_mimetype=$2,
                            md_filename=$3
                        where md_id=$4",[
                            $oid,
                            $_FILES['doc']['type'],
                            $_FILES['doc']['name'],
                            $this->md_id]);
                    $this->cn->commit();
                }
                else
                {
                    echo "<H1>Error</H1>";
                    $this->cn->rollback();
                    throw new Exception("Erreur".__FILE__.__LINE__);
                }
            }
        }
        catch (Exception $e)
        {
            record_log($e);
            $this->cn->rollback();
            return ;
        }
        $this->cn->commit();
    }

References $e, $new_name, $p_array, $r, $ret, $sql, cn, echo_error(), DatabaseCore\fetch_array(), load(), move_uploaded_file(), DatabaseCore\num_row(), record_log(), and return.

Here is the call graph for this function:

Field Documentation

$cn

Document_Modele::$cn

$cn database connection

Definition at line 28 of file document_modele.class.php.

$md_affect

Document_Modele::$md_affect

$md_affect if you can use it in VEN for sale, ACH for purchase or GES for follow-up

Definition at line 35 of file document_modele.class.php.

$md_filename

Document_Modele::$md_filename

$md_filename is the filename of the template

Definition at line 36 of file document_modele.class.php.

$md_id

Document_Modele::$md_id

$md_id pk

Definition at line 29 of file document_modele.class.php.

$md_lob

Document_Modele::$md_lob

$md_lob Document file

Definition at line 32 of file document_modele.class.php.

$md_mimetype

Document_Modele::$md_mimetype

$md_mimetype is the mimetype of the LOB

Definition at line 38 of file document_modele.class.php.

$md_name

Document_Modele::$md_name

$md_name template's name

Definition at line 30 of file document_modele.class.php.

$md_sequence

Document_Modele::$md_sequence

$md_sequence sequence name (autogenerate)

Definition at line 33 of file document_modele.class.php.

$md_type

Document_Modele::$md_type

$md_type template's type (letter, invoice, order...)

Definition at line 31 of file document_modele.class.php.

$sequence

Document_Modele::$sequence

$sequence sequence number used by the create sequence start with

Definition at line 34 of file document_modele.class.php.

$start

Document_Modele::$start

$md_filename is the filename of the template

Definition at line 37 of file document_modele.class.php.

Referenced by form(), and Save().

---

The documentation for this class was generated from the following file:

• include/class/document_modele.class.php