Document used in accountancy : invoice , credit note, ... It is a specialization of Document used in Follow-UP. More...

Inheritance diagram for Acc_Document:

Collaboration diagram for Acc_Document:

Public Member Functions
	__construct ($cn, $jr_id=0)
	constructor

	create_document ($internal, $p_array)
	create the invoice and saved it as attachment to the operation,

	export_file ($destination_file)
	export the file to the file system and complet $this->d_mimetype, d_filename and

	get_document_xml ()

	link_download_xml ()
	return a string with a link download XML or an empty string if there is no XML to download

	replace_receipt ($new_oid)
	for FACTURX we replace the PDF save in DB by this one, always a PDF (since it is a FACTURX document)

	save_receipt ()
	Save a "piece justificative" , the name must be a receipt.

	set_document_xml ($document_xml)

	set_id ($jr_id)
	set_id fill up d_filename, d_mimetype,d_lob,d_description,jr_pj_number

	update ($filename)
	save the file into DB, will create a large object if there is no document to replace.

	update_document_xml ($oid)
	save the Large Object $oid in the column JRN.JR_DOCUMENT_XML

Public Member Functions inherited from Document
	__toString ()

	anchor ()
	create and compute a string for reference the doc <A ...>

	blank ()
	insert a minimal document and set the d_id

	compute_filename ($pj, $filename)
	Insert the receipt number into the filename , each generated file will have the name of the template (model) + receipt number)

	download ($aDocument)
	Download all documents in a ZIP files.

	get ()
	Get complete all the data member thx info from the database.

	get_all ($ag_id)
	get all the document of a given action

	parseDocument ($p_dir, $p_file, $p_type, $p_array)
	This function parse a document and replace all the predefined tags by a value.

	remove ()
	remove a row from the table document, the lob object is not deleted because can be linked elsewhere

	replace ($p_tag, $p_array)
	replace the TAG by the real value, this value can be into the database or in $_POST The possible tags are

	replace_special_tag ($p_qcode, $p_tag)
	replace a special tag *TAGxxxx with the value from fiche_detail, the xxxx is the ad_value

	send ()
	send the document

	transform2pdf ()
	transform the current Document to a PDF, returns the full path of the PDF from the TMP folder if the file IS a pdf , then export it and return the path to the file.

	update_description ($p_desc)

	upload ($p_ag_id)
	upload a file into document all the needed data are in $_FILES we don't increment the seq $_FILES : array containing by default $_FILES

Static Public Member Functions
static	display_supplementary_doc ($cn, $div, $jr_id)

Static Public Member Functions inherited from Document
static	insert_existing_document ($p_ag_id, $p_lob, $p_filename, $p_mimetype, $p_description="")
	Copy a existing OID (LOB) into the table document.

static	replace_value ($p_buffer, $p_pattern, $p_value, $p_limit=-1, $p_type='OOo')
	replace a pattern with a value in the buffer , handle the change for OOo type file and amount

Protected Member Functions
	saveGenerated ($p_file)
	insert the generated Document into the database, update the $this->d_id that is the PK of document. and load the PDF into the database.

Private Attributes
	$document_xml
	$document_xml (oid) XML document e-invoice

Additional Inherited Members
Data Fields inherited from Document
	$ag_id

	$d_description

	$d_filename

	$d_id

	$d_lob

	$d_mimetype

	$d_name

	$d_number

	$db

	$f_id

	$md_id

	$md_type

Protected Attributes inherited from Document
	$counter

Detailed Description

Document used in accountancy : invoice , credit note, ... It is a specialization of Document used in Follow-UP.

property :

d_id JRN.JR_ID
d_name name Receipt number
d_description Comment of the operation
d_mimetype mimetype of the document JRN.JR_PJ_TYPE
d_filename filename JRN.JR_PJ_NAME
document_xml oid of the XML invoice (including PDF) JRN.JR_DOCUMENT_XML
d_lob = JRN.JR_PJ

Definition at line 43 of file acc_document.class.php.

Constructor & Destructor Documentation

◆ __construct()

Acc_Document::__construct	(		$cn,
			$jr_id = 0 )

constructor

Parameters

$cn	\Database
$jr_id	(int) JRN.JRID will be in d_id

Reimplemented from Document.

Definition at line 85 of file acc_document.class.php.

    {
        $this->db=$cn;
        $this->set_id($jr_id);
        // counter for MARCH_NEXT
        $this->counter=0;
 
    }

References $cn, $jr_id, db, and set_id().

Here is the call graph for this function:

Member Function Documentation

◆ create_document()

Acc_Document::create_document	(		$internal,
			$p_array )

create the invoice and saved it as attachment to the operation,

Parameters

$p_array

is normally the $_POST

 Array
 (
 [ledger_type] => VEN
 [gDossier] => x
 [nb_item] => 1 (number of item used to numerate e_marchX, e_quantX ,...)
 [p_jrn] => 2
 [p_jrn_predef] => 2
 [jrn_type] => VEN or ACH
 [e_date] => 10.06.2025 (date)
 [e_ech] => limite date
 [e_client] => CLIENT
 [e_pj] => 25.827
 [e_pj_suggest] => 25.827
 [e_comm] => E-INVOICE
 [p_currency_code] => 0
 [p_currency_rate] => 1 (rate if 1 for EURO)
 [jrn_note_input] =>
 [e_march0] => 7DVINV
 [e_march0_label] => Label of the operation
 [e_march0_price] => 10.0000
 [e_quant0] => 1.0000
 [htva_march0] => 10
 [e_march0_tva_id] => 1
 [e_march0_tva_amount] => 2.1
 [tva_march0] => 2.1
 [tvac_march0] => 12.1
 ...
 [mp_date] => (dd.mm.yyyy date of payment)
 [acompte] => 0 (amount to deduce as    advance payment)
 [e_comm_paiement] => (string : comment of the payment)
 [e_mp] => 0 (method of payment it is the XX in e_mp_qcode_XX)
 [e_mp_qcode_16] => Banque 1
 [e_mp_qcode_17] => Banque 2
 [view_invoice] => Enregistrer
 [gen_doc] => int DOCUMENT_MODELE.MD_ID , document template to use
 )
*

Todo: rewrite code : remove extract and +SQL value

Returns: void

Definition at line 231 of file acc_document.class.php.

                                                  {
        $this->f_id = $p_array['e_client'];
        // var md_id (int) DOCUMENT_MODELE.MD_ID
        $this->md_id = $p_array['gen_doc'];
        // var ag_id == 0 fake follow-up 
         $this->ag_id = 0;
        // var e_pj (string) receipt nb
        $p_array['e_pj'] = $this->db->get_value("select jr_pj_number from jrn where jr_id=$1"
                , [$this->d_id]);
        
        // $filename (string) compute filename based on the template
        $filename=$this->db->get_value ("select md_filename from document_modele where md_id=$1",
                [$this->md_id]);
        $filename = $p_array['e_pj']."-".$filename;
        //  generate the document and set d_lob,d_mimetype,
        // this function will call saveGenerated and save in DB
        $this->generate($p_array, $filename);
 
        // Update the comment with invoice number, if the comment is empty
        if (!isset($p_array['e_comm']) || noalyss_strlentrim($p_array['e_comm']) == 0) {
            $sql = "update jrn set jr_comment=' document " . $this->d_number . "' where jr_internal=$1";
            $this->db->exec_sql($sql, [$internal]);
        }
    }

References $p_array, $sql, ag_id, db, and noalyss_strlentrim().

Here is the call graph for this function:

◆ display_supplementary_doc()

static Acc_Document::display_supplementary_doc	(	$cn,
		$div,
		$jr_id )

static

Definition at line 416 of file acc_document.class.php.

    {
        $gDossier=\Dossier::id();
          $q=new Jrn_Sup_Document_SQL($cn);
            $a_row=$q->collect_objects(" where jr_id=$1 order by js_cbc_id", [$jr_id]);
          
            if ( count($a_row) > 0)
            {
                foreach ($a_row as $item) {
                    $export="export.php?";
                    $script="Supplement_Document.delete_document('$gDossier','$div','{$item->js_id}','$jr_id')";
                    $rowid=sprintf("row_js_%s_%s",$div,$item->js_id);
                    // @var $download (url) to send file
                    $download="export.php?". http_build_query(
                                        [
                                            "act"=>"RAW:suppl-document"
                                            ,"js_id"=>$item->js_id
                                            ,"gDossier"=>$gDossier
                                        ]);
                ?>
                <div class="row" id="<?=$rowid?>">
                    <div class="col">
                        <a href="<?=$download?>" download>      <?=$item->js_filename?></a>
                    </div>
                    <div class="col">
                        <?=$item->js_description?>
                    </div>
                    <div class="col">
                        <?=\Icon_Action::trash(uniqid("sdd"),$script)?>
                    </div>
                </div>
                <?php
                }// end foreach $a_row
            }// end if count
            //download ALL files from this operation
            
 
    }

References $a_row, $cn, $div, $export, $gDossier, $jr_id, $q, $script, Document\download(), and Icon_Action\trash().

Here is the call graph for this function:

◆ export_file()

Acc_Document::export_file ( $destination_file )

export the file to the file system and complet $this->d_mimetype, d_filename and

Parameters

$destination_file (string) full path to document

Returns: bool false for failure and string (the full path_name) for success

Reimplemented from Document.

Definition at line 261 of file acc_document.class.php.

                                            {
        
        if (empty($this->d_filename)) {
            return false; 
        }
 
        $this->db->start();
        if ($this->db->lo_export($this->d_lob, $destination_file) == false) {
            record_log("ACD122. cannot export");
            $this->db->commit();
            return false;
        }
        $this->db->commit();
 
        return $destination_file;
    }

References db, and record_log().

Here is the call graph for this function:

◆ get_document_xml()

Acc_Document::get_document_xml ( )

Definition at line 46 of file acc_document.class.php.

                                       {
        return $this->document_xml;
    }

References $document_xml.

◆ link_download_xml()

Acc_Document::link_download_xml ( )

return a string with a link download XML or an empty string if there is no XML to download

Definition at line 398 of file acc_document.class.php.

                                :string
    {
        $xml_oid=$this->db->get_value("select jr_document_xml from jrn where jr_id=$1",
                [$this->d_id]);
        if ($xml_oid == "") { return "";}
         $url= "export.php?".http_build_query(
                        [
                            "gDossier"=>\Dossier::id(),
                            "jr_id"=>$this->d_id,
                            "act"=>'RAW:xml-invoice'
                        ]);
        $r = sprintf('<a class="mtitle line" href="%s">',$url);
        $r .=  _("XML")
                .'<i class="icon-download">'
                .'</i>'
                .'</a>';
        return $r;
    }

References $r, $url, _, and db.

◆ replace_receipt()

Acc_Document::replace_receipt ( $new_oid )

for FACTURX we replace the PDF save in DB by this one, always a PDF (since it is a FACTURX document)

Definition at line 152 of file acc_document.class.php.

    {
        if ($this->d_lob != "") 
        {
            $this->db->lo_unlink($this->d_lob);
        }
        $this->d_lob=$new_oid;
        $this->db->exec_sql("
                            update jrn
                            set
                              jr_pj = $1
                              ,jr_pj_name =$2
                              ,jr_pj_type =$3
                              where jr_id=$4
                              ",
                                  [$this->d_lob
                                  ,$this->d_filename
                                  ,$this->d_mimetype
                                   ,$this->d_id]
                                );
        
    }

References db.

◆ save_receipt()

Acc_Document::save_receipt ( )

Save a "piece justificative" , the name must be a receipt.

If it is a XML document, split it into 2 parts : PDF and XML the PDF be stored in JR_PJ and the XML into JR_DOCUMENT_XML

Returns: $oid of the lob file if success null if a error occurs

pj is the $_FILES key

Definition at line 286 of file acc_document.class.php.

    {
        $this->db->start();
        /**
         * pj is the $_FILES key
         */
        if ( $_FILES['pj']['name']=="") {
            return false;
        }
        $a_file= $this->db->upload('pj',only_oid:false);
        if ($a_file == false) {
            return false;
        }
        $oid=$a_file['oid'];
        // Remove old document if any
        $old_oid = $this->db->get_value("select jr_pj from jrn where jr_id=$1"
                ,[$this->d_id]);
        
        if ( $old_oid != "")
        {
            $this->db->lo_unlink( $old_oid);
        }
        
        // if there is a e-invoice in XML
        if (   $_FILES['pj']['type'] == 'text/xml' 
            || $_FILES['pj']['type'] == 'application/xml' 
            ) 
        {
            // save the XML 
            $this->db->exec_sql("update jrn set jr_document_xml = $1 
                where 
                jr_id=$2",
                    [$oid,$this->d_id]);
            
           $xmlreader= \Noalyss\XMLDocument\XML_Reader::build_from_file($a_file['filename']);
 
           //@var $embedded_file (array) keys = filecontent: binary data
           //,mimecode mimetype and filename (string)
           try 
           {
                
                // create a PDF with standard information
                $pdf=$xmlreader->to_pdf();
                $file_oid=$this->db->lo_write($pdf->Output("S"));
 
                //@var $file_oid OID of the large object saved in DB
                $this->d_name="invoice.pdf";
                $this->d_description="Auto generated invoice";
                $this->d_lob=$file_oid;
                $this->d_mimetype="application/pdf";
 
                // save extracted document into DB
                $this->db->exec_sql("update jrn set jr_pj=$1 , jr_pj_name=$2,
                                        jr_pj_type=$3  where jr_id=$4",
                                    array(
                                            $this->d_lob
                                        ,   $this->d_name
                                        ,   $this->d_description
                                        ,   $this->d_id 
                                    )
                                );
                // save all the documents into the DB
                // @var embedded_file (array of Noalyss\XML\Document_Reference)
                $embedded_file=$xmlreader->get_embedded_document();
                $nb_file = count($embedded_file);
                for ($i=0;$i <$nb_file ; $i++)
                {
                    // other documents save in jrn_sup_document
                    // @var $file (Binary File from XML)
                    $binary=$embedded_file[$i]->getBinary_object();
                    
                    //@var $sup_oid : oid of the supplemental
                    $sup_oid=$this->db->lo_write($binary->filecontent);
 
                    $jrn_sup_document=new Jrn_Sup_Document_SQL($this->db);
                    $jrn_sup_document->jr_id=$this->d_id;
                    $jrn_sup_document->js_mimetype=$binary->mimecode;
                    $jrn_sup_document->js_filename=$binary->filename;
                    $jrn_sup_document->js_lob=$sup_oid;
                    $jrn_sup_document->js_description=$embedded_file[$i]->getDescription();
                    $jrn_sup_document->js_cbc_id=$embedded_file[$i]->getId();
                    $jrn_sup_document->save();
                }
 
           } catch (\Exception $e ) {
               \record_log($e);
               throw new \Exception("X281 ",281,$e);
           }
        } else {
            $this->d_lob=$oid;
            $this->d_name=$_FILES['pj']['name'];
            $this->d_description=$_FILES['pj']['type'];
            
              // save extracted document into DB
            $this->db->exec_sql("update jrn set jr_pj=$1 , jr_pj_name=$2,
                                    jr_pj_type=$3  where jr_id=$4",
                                array(
                                        $this->d_lob
                                    ,   $this->d_name
                                    ,   $this->d_description
                                    ,   $this->d_id 
                                )
                    );
        }
        $this->db->commit();
 
        return $oid;
    }

References Document\$d_id, $e, $i, $pdf, db, and record_log().

Here is the call graph for this function:

◆ saveGenerated()

Acc_Document::saveGenerated ( $p_file )

protected

insert the generated Document into the database, update the $this->d_id that is the PK of document. and load the PDF into the database.

Parameters

$p_file is the generated file (full path)

Returns: 0 if no error otherwise 1

Reimplemented from Document.

Definition at line 60 of file acc_document.class.php.

    {
 
        $this->db->start();
        $this->d_filename= basename($p_file);
        $this->d_mimetype= mime_content_type($p_file);
        $this->d_lob=$this->db->lo_import($p_file);
        if ($this->d_lob==false)
        {
            echo "ne peut pas importer [$p_file]";
            return 1;
        }
        $sql="update jrn set jr_pj=$1,jr_pj_name=$2,jr_pj_type=$3 where jr_id=$4 returning jr_id";
        $id=$this->db->get_value($sql, array($this->d_lob, $this->d_filename, $this->d_mimetype, $this->d_id));
        $this->db->commit();
        if ( $id == "") {
            throw new Exception("AD99 FILE NOT SAVED INTO DB",99);
        }
        
    }

References $id, $sql, and db.

◆ set_document_xml()

Acc_Document::set_document_xml ( $document_xml )

Definition at line 50 of file acc_document.class.php.

                                                    {
        $this->document_xml = $document_xml;
        return $this;
    }

References $document_xml.

◆ set_id()

Acc_Document::set_id ( $jr_id )

set_id fill up d_filename, d_mimetype,d_lob,d_description,jr_pj_number

Definition at line 96 of file acc_document.class.php.

                            {
        $this->d_id=$jr_id;
        if ( $jr_id == 0 ){
            return $this;
        }
        $row = $this->db->get_row("select jr_comment
            ,jr_pj
            ,jr_pj_name
            ,jr_pj_type 
            ,jr_pj_number
            ,jr_document_xml
            from jrn 
           where
            jr_id=$1", [$this->d_id]);
        if ( empty ($row)) {
            return $this;   
        }
        $this->d_name=$row['jr_pj_number'];
        $this->d_description=$row['jr_comment'];
        $this->d_mimetype=$row['jr_pj_type'];
        $this->d_filename=$row['jr_pj_name'];
        $this->d_lob=$row['jr_pj'];
        $this->document_xml=$row['jr_document_xml'];
        return $this;
    }

References $jr_id, $row, and db.

Referenced by __construct().

◆ update()

Acc_Document::update ( $filename )

save the file into DB, will create a large object if there is no document to replace.

It will change the d_filename, d_mimetype

Parameters

$d_filename (string) full path to the file to load into DB

Returns: false if d_id = 0 or the file doesn't exist, true for success

Definition at line 129 of file acc_document.class.php.

                               {
        if ($this->d_id == 0) return false;
        if ( ! file_exists($filename)) return false;
        $this->db->start();
        $this->d_mimetype= mime_content_type($filename);
        $this->d_filename= basename($filename);
        if ( $this->d_lob == "") {
            $this->db->lo_unlink($this->d_lob);
        } 
        
        $this->d_lob=$this->db->lo_import($filename);
        $this->db->exec_sql(
                "update jrn set jr_pj=$1,jr_pj_name=$2,jr_pj_type=$3 
                    where jr_id=$4",
                [$this->d_lob,$this->d_filename,$this->d_mimetype,$this->d_id]
                );
        $this->db->commit();
        return true;
    }

References db.

◆ update_document_xml()

Acc_Document::update_document_xml ( $oid )

save the Large Object $oid in the column JRN.JR_DOCUMENT_XML

Parameters

$oid( OID) PostgreSQL Object ID

Definition at line 178 of file acc_document.class.php.

                                      {
        $this->db->exec_sql("update jrn set jr_document_xml=$1 where 
            jr_id=$2",[
                $oid,
                $this->d_id
            ]);
 
    }

References db.

Field Documentation

◆ $document_xml

Acc_Document::$document_xml

private

$document_xml (oid) XML document e-invoice

Definition at line 44 of file acc_document.class.php.

Referenced by get_document_xml(), and set_document_xml().

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

include/class/acc_document.class.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create_document()

◆ display_supplementary_doc()

◆ export_file()

◆ get_document_xml()

◆ link_download_xml()

◆ replace_receipt()

◆ save_receipt()

◆ saveGenerated()

◆ set_document_xml()

◆ set_id()

◆ update()

◆ update_document_xml()

Field Documentation

◆ $document_xml