Acc_Ledger_History Class Reference

Display history of operation. More...

Inheritance diagram for Acc_Ledger_History:

Collaboration diagram for Acc_Ledger_History:

Public Member Functions
	__construct (Database $cn, $pa_ledger, $p_from, $p_to, $p_mode)
	export_accounting_html ()
	display accounting of operations m_mode=A
	export_detail_html ()
	display detail of operations m_mode=D
	export_extended_html ()
	display extended details of operation m_mode=E
	export_html ()
	call the right function , depending of m_mode
	export_oneline_html ()
	display operation on one line m_mode=L
	get_filter_operation ()
	Filter operation.
	get_from ()
	setter / getter
	get_ledger ()
	setter / getter
	get_ledger_type ()
	get_mode ()
	setter / getter
	get_row ($p_limit, $p_offset)
	get_tiers ($p_jrn_type, $jr_id)
	Retrieve the third : supplier for purchase, customer for sale, bank for fin,.
	get_tiers_id ($p_jrn_type, $jr_id)
	Return the f_id of the tiers , called by get_tiers.
	get_to ()
	setter / getter
	has_other_tax ()
	count the number of addition tax for the ledger
	set_a_ledger ($ma_ledger)
	setter ma_ledger (array of jrn_def_id)
	set_filter_operation ($filter_operation)
	Filter operation ,.
	set_from ($m_from)
	setter m_from (periode id)
	set_ledger_type ($ledger_type)
	set_m_mode ($m_mode)
	Setter.
	set_to ($m_to)
	setter m_to (periode id)

Static Public Member Functions
static	factory (Database $cn, $pa_ledger, $p_from, $p_to, $p_mode, $p_paid)
	Build the right object.

Data Fields
	$db
	database connx

Protected Member Functions
	add_additional_tax_info ()
	add additional info about additional tax.
	build_filter_operation ()
	Build a SQL clause to filter operation depending if they are paid, unpaid or no filter.
	prepare_reconcile_date ()
	Prepare the query for fetching the linked operation @staticvar int $prepare.

Protected Attributes
	$filter_operation
	type of ledger VEN , ACH , ODS, FIN
	$ledger_type
	$m_from
	Starting Periode : periode.p_id.
	$m_mode
	mode of export L : one line, E accounting writing , D : Detail
	$m_to
	Ending Periode : periode.p_id.
	$ma_ledger
	Array of ledger id : jrn_def.jrn_def_id.

Detailed Description

Display history of operation.

See also

acc_ledger_historyTest.php

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

Constructor & Destructor Documentation

__construct()

Acc_Ledger_History::__construct	(	Database	$cn,
			$pa_ledger,
			$p_from,
			$p_to,
			$p_mode )

Parameters

Database	$cn
array	$pa_ledger	array of jrn_def.jrn_def_id
integer	$p_from	periode
integer	$p_to
char	$p_mode	E D L or A , for Extended ,Detail , Listing , Accounting

Exceptions

Exception

if $pa_ledger is not an array

Reimplemented in Acc_Ledger_History_Financial, and Acc_Ledger_History_Generic.

Definition at line 52 of file acc_ledger_history.class.php.

    {
        if (is_array($pa_ledger) == FALSE) {
            throw new Exception (_('pa_ledger doit être un tableau'),EXC_PARAM_VALUE);
        }
        $this->db=$cn;
        $this->ma_ledger=$pa_ledger;
        $this->m_from=$p_from;
        $this->m_to=$p_to;
        $this->m_mode=$p_mode;
        $this->filter_operation='all';
    }

References $cn, _, db, and EXC_PARAM_VALUE.

Member Function Documentation

add_additional_tax_info()

Acc_Ledger_History::add_additional_tax_info ( )

protected

add additional info about additional tax.

Add to $this->data an array containing the info about a additional tax. Concerns only purchase and sales ledgers

$this->data[$i]['supp_tax']['ac_id'] id in Acc_Other_Tax
$this->data[$i]['supp_tax']['j_montant']  Amount of this tax
$this->data[$i]['supp_tax']['ac_label']   Label of this tax
$this->data[$i]['supp_tax']['ac_rate']    Rate of this tax
$this->data[$i]['supp_tax']['j_poste']    Accounting
 * 

Definition at line 386 of file acc_ledger_history.class.php.

    {
        $prepare=$this->db->is_prepare("supp_tax_info");
        if ( $prepare == false ){
            $this->db->prepare("supp_tax_info","
                select 
                   case when j.j_debit is false and jd.jrn_def_type='ACH'      then 0-j_montant
                      when j.j_debit is true and jd.jrn_def_type='VEN'      then 0-j_montant
                      else j.j_montant end j_montant,
                    jt1.ac_id,
                    ac_label,
                    ac_rate,j_poste 
                from 
                    jrn_tax jt1 
                    join acc_other_tax using (ac_id)
                    join jrnx j using (j_id) 
                    join jrn_def jd on (j.j_jrn_def=jd.jrn_def_id) 
                where j_grpt=$1
            ");
 
        }
        $data=$this->get_data();
        $nb_row=count($data);
 
        for ($i=0;$i<$nb_row;$i++)
        {
            $ret=$this->db->execute("supp_tax_info",array($data[$i]["jr_grpt_id"]));
            $array=Database::fetch_all($ret);
            $array=($array==false)?array():$array;
            $data[$i]["supp_tax"]=$array;
        }
        $this->set_data($data);
    }

References $array, $data, $i, $nb_row, $ret, db, and DatabaseCore\fetch_all().

Referenced by Acc_Ledger_History_Purchase\export_extended_html(), and Acc_Ledger_History_Sale\export_extended_html().

Here is the call graph for this function:

build_filter_operation()

Acc_Ledger_History::build_filter_operation ( )

protected

Build a SQL clause to filter operation depending if they are paid, unpaid or no filter.

Returns

string SQL Clause

Definition at line 319 of file acc_ledger_history.class.php.

    {
        switch ( $this->get_filter_operation() )
        {
            case 'all':
                $sql_filter="";
                break;
            case 'paid':
                $sql_filter=" and (jr_date_paid is not null or  jr_rapt ='paid' ) ";
                break;
            case 'unpaid':
                $sql_filter=" and (jr_date_paid  is null and coalesce(jr_rapt,'x') <> 'paid' ) ";
                break;
            default:
                throw new Exception(_("Filtre invalide",5));
                
        }
        return $sql_filter;
    }

References $sql_filter, _, and get_filter_operation().

Referenced by Acc_Ledger_History_Purchase\get_row(), and Acc_Ledger_History_Sale\get_row().

Here is the call graph for this function:

export_accounting_html()

Acc_Ledger_History::export_accounting_html ( )

abstract

display accounting of operations m_mode=A

Reimplemented in Acc_Ledger_History_Financial, Acc_Ledger_History_Generic, Acc_Ledger_History_Purchase, and Acc_Ledger_History_Sale.

export_detail_html()

Acc_Ledger_History::export_detail_html ( )

abstract

display detail of operations m_mode=D

Reimplemented in Acc_Ledger_History_Financial, Acc_Ledger_History_Generic, Acc_Ledger_History_Purchase, and Acc_Ledger_History_Sale.

export_extended_html()

Acc_Ledger_History::export_extended_html ( )

abstract

display extended details of operation m_mode=E

Reimplemented in Acc_Ledger_History_Financial, Acc_Ledger_History_Generic, Acc_Ledger_History_Purchase, and Acc_Ledger_History_Sale.

export_html()

Acc_Ledger_History::export_html ( )

abstract

call the right function , depending of m_mode

Reimplemented in Acc_Ledger_History_Financial, Acc_Ledger_History_Generic, Acc_Ledger_History_Purchase, and Acc_Ledger_History_Sale.

export_oneline_html()

Acc_Ledger_History::export_oneline_html ( )

abstract

display operation on one line m_mode=L

Reimplemented in Acc_Ledger_History_Financial, Acc_Ledger_History_Generic, Acc_Ledger_History_Purchase, and Acc_Ledger_History_Sale.

factory()

static Acc_Ledger_History::factory ( Database $cn, $pa_ledger, $p_from, $p_to, $p_mode, $p_paid )

static

Build the right object.

Parameters

Database	$cn	database conx
array	$pa_ledger	ledger of array
integer	$p_from	periode id
integer	$p_to	periode id
char	$p_mode	L (list operation) E (extended detail) A (accouting writing) D (Detailled VAT)
	$p_paid	values are all means all operations, paid only paid operation, unpaid for only unpaid

Returns

Acc_Ledger_History_Generic Acc_Ledger_History_Sale Acc_Ledger_History_Financial Acc_Ledger_History_Purchase

Examples

acc_ledger_historyTest.php.

Definition at line 162 of file acc_ledger_history.class.php.

    {
        // For Accounting writing , we use Acc_Ledger_History
        if ($p_mode=="A")
        {
            $ret=new Acc_Ledger_History_Generic($cn, $pa_ledger, $p_from, $p_to,
                    $p_mode);
            return $ret;
        }
        $nb_ledger=count($pa_ledger);
        $ledger=new Acc_Ledger($cn, $pa_ledger[0]);
        $type=$ledger->get_type();
 
        // If first one is ODS so Acc_Ledger_History
        if ($type=="ODS")
        {
            $ret=new Acc_Ledger_History_Generic($cn, $pa_ledger, $p_from, $p_to,
                    $p_mode);
            return $ret;
        }
        // If all of the same type then use the corresponding class
 
        for ($i=0; $i<$nb_ledger; $i++)
        {
            $ledger=new Acc_Ledger($cn, $pa_ledger[$i]);
            $type_next=$ledger->get_type();
 
            // If type different then we go back to the generic
            if ($type_next!=$type)
            {
                $ret=new Acc_Ledger_History_Generic($cn, $pa_ledger, $p_from,
                        $p_to, $p_mode);
                return $ret;
            }
        }
        switch ($type)
        {
            case "ACH":
                $ret=new Acc_Ledger_History_Purchase($cn, $pa_ledger, $p_from,
                        $p_to, $p_mode);
                $ret->set_filter_operation($p_paid);
                return $ret;
                break;
            case "FIN":
                $ret=new Acc_Ledger_History_Financial($cn, $pa_ledger, $p_from,
                        $p_to, $p_mode);
                return $ret;
                break;
            case "VEN":
                $ret=new Acc_Ledger_History_Sale($cn, $pa_ledger, $p_from,
                        $p_to, $p_mode);
                $ret->set_filter_operation($p_paid);
                return $ret;
                break;
 
            default:
                break;
        }
    }

References $cn, $i, $ledger, $ret, and $type.

Referenced by Print_Ledger_Simple\export(), and Print_Ledger_Simple_Without_Vat\export().

get_filter_operation()

Acc_Ledger_History::get_filter_operation

(

)

Filter operation.

Reimplemented in Acc_Ledger_History_Purchase.

Definition at line 341 of file acc_ledger_history.class.php.

    {
       return $this->filter_operation;
    }

References $filter_operation.

Referenced by build_filter_operation().

get_from()

Acc_Ledger_History::get_from

(

)

setter / getter

Returns

m_from (periode id)

Definition at line 68 of file acc_ledger_history.class.php.

    {
        return $this->m_from;
    }

References $m_from.

get_ledger()

Acc_Ledger_History::get_ledger

(

)

setter / getter

Returns

ma_ledger (array)

Definition at line 100 of file acc_ledger_history.class.php.

    {
        return $this->ma_ledger;
    }

References $ma_ledger.

get_ledger_type()

Acc_Ledger_History::get_ledger_type

(

)

Definition at line 72 of file acc_ledger_history.class.php.

    {
        return $this->ledger_type;
    }

References $ledger_type.

get_mode()

Acc_Ledger_History::get_mode

(

)

setter / getter

Returns

m_mode (A,L,E,D)

Definition at line 108 of file acc_ledger_history.class.php.

    {
        return $this->m_mode;
    }

References $m_mode.

get_row()

Acc_Ledger_History::get_row ( $p_limit, $p_offset )

abstract

Reimplemented in Acc_Ledger_History_Financial, Acc_Ledger_History_Generic, Acc_Ledger_History_Purchase, and Acc_Ledger_History_Sale.

get_tiers()

Acc_Ledger_History::get_tiers	(		$p_jrn_type,
			$jr_id )

Retrieve the third : supplier for purchase, customer for sale, bank for fin,.

Parameters

$p_jrn_type	type of the ledger FIN, VEN ACH or ODS
$jr_id	jrn.jr_id

Todo

duplicate function , also in Acc_Ledger\get_tiers, remove one

Definition at line 228 of file acc_ledger_history.class.php.

    {
        if ($p_jrn_type=='ODS')
            return ' ';
        $tiers=$this->get_tiers_id($p_jrn_type, $jr_id);
        if ($tiers==0)
            return "";
 
        $name=$this->db->get_value('select ad_value from fiche_detail where ad_id=1 and f_id=$1',
                array($tiers));
        $first_name=$this->db->get_value('select ad_value from fiche_detail where ad_id=32 and f_id=$1',
                array($tiers));
        return $name.' '.$first_name;
    }

References $jr_id, $name, $tiers, db, and get_tiers_id().

Referenced by Acc_Ledger_History_Generic\export_oneline_html().

Here is the call graph for this function:

get_tiers_id()

Acc_Ledger_History::get_tiers_id	(		$p_jrn_type,
			$jr_id )

Return the f_id of the tiers , called by get_tiers.

Parameters

$p_jrn_type	type of the ledger FIN, VEN ACH or ODS
$jr_id	jrn.jr_id

Definition at line 248 of file acc_ledger_history.class.php.

    {
        $tiers=0;
        switch ($p_jrn_type)
        {
            case 'VEN':
                $tiers=$this->db->get_value('select max(qs_client) '
                        . 'from quant_sold join jrnx using (j_id) '
                        . 'join jrn on (jr_grpt_id=j_grpt) where jrn.jr_id=$1',
                        array($jr_id));
                break;
            case 'ACH':
                $tiers=$this->db->get_value('select max(qp_supplier) '
                        . ' from quant_purchase '
                        . ' join jrnx using (j_id) '
                        . ' join jrn on (jr_grpt_id=j_grpt) '
                        . ' where jrn.jr_id=$1',
                        array($jr_id));
 
                break;
            case 'FIN':
                $tiers=$this->db->get_value('select qf_other from quant_fin where jr_id=$1',
                        array($jr_id));
                break;
        }
        if ($this->db->count()==0)
            return 0;
        return $tiers;
    }

References $jr_id, $tiers, and db.

Referenced by get_tiers().

get_to()

Acc_Ledger_History::get_to

(

)

setter / getter

Returns

m_to (periode id)

Definition at line 92 of file acc_ledger_history.class.php.

    {
        return $this->m_to;
    }

References $m_to.

has_other_tax()

Acc_Ledger_History::has_other_tax

(

)

count the number of addition tax for the ledger

Returns

integer

Definition at line 364 of file acc_ledger_history.class.php.

    {
        $str_ledger=join(',',$this->ma_ledger);
        $count=$this->db->get_value("select count(*) 
                from jrn_tax 
                    join jrnx using (j_id) 
                    join jrn on (jr_grpt_id=j_grpt) 
                    where jr_tech_per>=$1 and jr_tech_per <=$2
                    and jr_def_id in ($str_ledger) ",[$this->m_from,$this->m_to]);
        return $count;
    }

References $count, and db.

Referenced by Acc_Ledger_History_Purchase\export_csv(), Acc_Ledger_History_Sale\export_csv(), Acc_Ledger_History_Purchase\export_oneline_html(), and Acc_Ledger_History_Sale\export_oneline_html().

prepare_reconcile_date()

Acc_Ledger_History::prepare_reconcile_date ( )

protected

Prepare the query for fetching the linked operation @staticvar int $prepare.

Definition at line 283 of file acc_ledger_history.class.php.

    {
        static $not_done=TRUE;
        if ($not_done )  {
            $prepare_query = new Prepared_Query($this->db);
            $prepare_query->prepare_reconcile_date();
        }
        $not_done=FALSE;
    }

References db.

Referenced by Acc_Ledger_History_Purchase\export_csv(), Acc_Ledger_History_Sale\export_csv(), Acc_Ledger_History_Purchase\export_detail_html(), Acc_Ledger_History_Sale\export_detail_html(), Acc_Ledger_History_Purchase\export_extended_html(), Acc_Ledger_History_Sale\export_extended_html(), Acc_Ledger_History_Financial\export_oneline_html(), Acc_Ledger_History_Purchase\export_oneline_html(), and Acc_Ledger_History_Sale\export_oneline_html().

set_a_ledger()

Acc_Ledger_History::set_a_ledger

(

$ma_ledger

)

setter ma_ledger (array of jrn_def_id)

Definition at line 131 of file acc_ledger_history.class.php.

    {
        if (is_array($ma_ledger)==FALSE)
            throw new Exception(_("invalid parameter"), EXC_PARAM_VALUE);
        $this->ma_ledger=$ma_ledger;
        return $this;
    }

References $ma_ledger, _, and EXC_PARAM_VALUE.

set_filter_operation()

Acc_Ledger_History::set_filter_operation

(

$filter_operation

)

Filter operation ,.

Parameters

string

$filter_operation,valid

: all, paid, unpaid

Definition at line 350 of file acc_ledger_history.class.php.

    {
        if (in_array($filter_operation,['all','paid','unpaid']))
        {
            $this->filter_operation=$filter_operation;
            return $this;
        }
        throw new Exception(_("Filter invalide ".$filter_operation),5);
    }

References $filter_operation, and _.

set_from()

Acc_Ledger_History::set_from

(

$m_from

)

setter m_from (periode id)

Definition at line 115 of file acc_ledger_history.class.php.

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

References $m_from.

set_ledger_type()

Acc_Ledger_History::set_ledger_type

(

$ledger_type

)

Definition at line 77 of file acc_ledger_history.class.php.

    {
        if (! in_array($ledger_type,['ACH','ODS','VEN','FIN'])) {
            record_log('Acc_Ledger_History:set_ledger_type '.var_export($ledger_type,TRUE));
            throw new Exception (_("Donnée invalide",EXC_PARAM_VALUE));
        }
        
        $this->ledger_type=$ledger_type;
        return $this;
    }

References $ledger_type, _, EXC_PARAM_VALUE, and record_log().

Here is the call graph for this function:

set_m_mode()

Acc_Ledger_History::set_m_mode

(

$m_mode

)

Setter.

Parameters

$m_mode

D,A,L,E

Returns

$this

Exceptions

Exception

Definition at line 144 of file acc_ledger_history.class.php.

    {
        if ($m_mode!='E'&&$m_mode!='D'&&$m_mode!='L'&&$m_mode!='A')
            throw new Exception(_("invalid parameter"), EXC_PARAM_VALUE);
        $this->m_mode=$m_mode;
        return $this;
    }

References $m_mode, _, and EXC_PARAM_VALUE.

set_to()

Acc_Ledger_History::set_to

(

$m_to

)

setter m_to (periode id)

Definition at line 123 of file acc_ledger_history.class.php.

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

References $m_to.

Field Documentation

$db

Acc_Ledger_History::$db

database connx

Definition at line 39 of file acc_ledger_history.class.php.

$filter_operation

Acc_Ledger_History::$filter_operation

protected

type of ledger VEN , ACH , ODS, FIN

to filter paid, unpaid or all operation

Definition at line 41 of file acc_ledger_history.class.php.

Referenced by get_filter_operation(), Acc_Ledger_History_Purchase\get_filter_operation(), and set_filter_operation().

$ledger_type

Acc_Ledger_History::$ledger_type

protected

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

Referenced by get_ledger_type(), and set_ledger_type().

$m_from

Acc_Ledger_History::$m_from

protected

Starting Periode : periode.p_id.

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

Referenced by get_from(), and set_from().

$m_mode

Acc_Ledger_History::$m_mode

protected

mode of export L : one line, E accounting writing , D : Detail

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

Referenced by get_mode(), and set_m_mode().

$m_to

Acc_Ledger_History::$m_to

protected

Ending Periode : periode.p_id.

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

Referenced by get_to(), and set_to().

$ma_ledger

Acc_Ledger_History::$ma_ledger

protected

Array of ledger id : jrn_def.jrn_def_id.

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

Referenced by get_ledger(), and set_a_ledger().

---

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

• include/class/acc_ledger_history.class.php