Parent class for the print_ledger class. More...

Inheritance diagram for Print_Ledger:

Collaboration diagram for Print_Ledger:

Public Member Functions
	__construct (\Database $p_cn, $orientation, $unit, $format, Acc_Ledger $p_ledger, $p_from, $p_to, $p_filter_operation)
	integer parm_periode.p_id , end periode;

	get_filter_operation ()

	get_from ()

	get_ledger ()

	get_to ()

	set_filter_operation ($filter_operation)
	Filter the operations ,.

	set_from ($from)

	set_ledger ($ledger)

	set_to ($to)

Public Member Functions inherited from PDF
	__construct (Database $p_cn, $orientation='P', $unit='mm', $format='A4')

	Footer ()

	get_tiers ($p_jr_id, $p_jrn_type)
	retrieve the client name and quick_code

	Header ()

	setDossierInfo ($dossier="n/a")

Public Member Functions inherited from PDF_Core
	__construct ( $orientation='P', $unit='mm', $format='A4')

	get_margin_bottom ()

	get_margin_left ()

	get_margin_right ()

	get_margin_top ()

	get_orientation ()

	get_page_size ()

	get_unit ()

	is_fill ($p_step)
	If the step is even then return 1 and set the backgroup color to blue , otherwise returns 0, and set the background color to white It is use to compute alternated colored row , it the parameter fill in write_cell and cell.

	line_new ($p_step=null)
	Print all the cell stored and call Ln (new line)

	LongLine ($w, $h, $txt, $border=0, $align='', $fill=false)

	write_cell ($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='')

Static Public Member Functions
static	available_ledger ($get_from_periode)
	find all the active ledger for the exerice of the periode and readable by the current user @global type $g_user

static	factory (Database $cn, $p_type_export, Acc_Ledger $p_ledger, $p_from, $p_to, $p_filter_operation)
	Create an object Print_Ledger* depending on $p_type_export ( 0 => accounting 1-> one row per operation 2-> detail of item)

Protected Member Functions
	build_filter_operation ()
	Build a SQL clause to filter operation depending if they are paid, unpaid or no filter.

Protected Member Functions inherited from PDF_Core
	print_row ()
	print the current array of cell and reset it , if different colors are set on the same row you have to print it before changing

Protected Attributes
	$filter_operation

Private Attributes
	$from

	$ledger
	concerned Ledger

	$to
	integer parm_periode.p_id , start periode;

Additional Inherited Members
Data Fields inherited from PDF
	$cn = null

	$date = ""

	$dossier = "n/a"

	$own = null

	$soc = ""

Detailed Description

Parent class for the print_ledger class.

Author: danydb

Strategie class for the print_ledger class

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

Constructor & Destructor Documentation

◆ __construct()

Print_Ledger::__construct	(	\Database	$p_cn,
			$orientation,
			$unit,
			$format,
		Acc_Ledger	$p_ledger,
			$p_from,
			$p_to,
			$p_filter_operation )

integer parm_periode.p_id , end periode;

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

    {
        parent::__construct($p_cn, $orientation, $unit, $format);
        $this->ledger=$p_ledger;
        $this->from=$p_from;
        $this->to=$p_to;
        $this->set_filter_operation($p_filter_operation);
    }

References from, set_filter_operation(), and to.

Here is the call graph for this function:

Member Function Documentation

◆ available_ledger()

static Print_Ledger::available_ledger ( $get_from_periode )

static

find all the active ledger for the exerice of the periode and readable by the current user @global type $g_user

Parameters

int $get_from_periode

Returns: array of ledger id

Definition at line 257 of file print_ledger.class.php.

    {
        global $g_user;
        $cn=Dossier::connect();
        // Find periode 
        $periode=new Periode($cn, $get_from_periode);
        $exercice=$periode->get_exercice($get_from_periode);
 
        if ($g_user->Admin()==0&&$g_user->is_local_admin()==0&&$g_user->get_status_security_ledger()
                ==1)
        {
            $sql="select jrn_def_id 
                 from jrn_def join jrn_type on jrn_def_type=jrn_type_id
                 join user_sec_jrn on uj_jrn_id=jrn_def_id
                 where
                 uj_login=$1
                 and uj_priv in ('R','W')
                 and ( jrn_enable=1 
                        or 
                        exists (select 1 from jrn
                        where  
                            jr_def_id=jrn_def_id
                        and jr_tech_per in (select p_id from parm_periode where p_exercice=$2)))
                         order by jrn_def_name
                 ";
            $a_jrn=$cn->get_array($sql, array($g_user->login, $exercice));
        }
        else
        {
            $a_jrn=$cn->get_array("select jrn_def_id
                                 from jrn_def join jrn_type on jrn_def_type=jrn_type_id
                                 where
                                 jrn_enable=1 
                                 or exists(select 1 from jrn 
                                    where  
                                            jr_def_id=jrn_def_id 
                                        and jr_tech_per in (select p_id from parm_periode where p_exercice=$1))
                                        order by jrn_def_name
                                                         ", [$exercice]);
        }
        $a=[];
        $nb_jrn=count($a_jrn);
        for ($i=0; $i<$nb_jrn; $i++)
        {
            $a[]=$a_jrn[$i]['jrn_def_id'];
        }
        return $a;
    }

References $a, PDF\$cn, $exercice, $g_user, $get_from_periode, $i, $nb_jrn, $periode, and $sql.

Referenced by Acc_Ledger\get_rowSimple().

◆ build_filter_operation()

Print_Ledger::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 309 of file print_ledger.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().

Here is the call graph for this function:

◆ factory()

static Print_Ledger::factory	(	Database	$cn,
			$p_type_export,
		Acc_Ledger	$p_ledger,
			$p_from,
			$p_to,
			$p_filter_operation )

static

Create an object Print_Ledger* depending on $p_type_export ( 0 => accounting 1-> one row per operation 2-> detail of item)

Parameters

Database	$cn
char	$p_type_export	E(xtended) L(isting) A(ccounting) D(etail)
Acc_Ledger	$ledger

@Bug Strange PHP Bug when autoloader is not used , the require_once doesn't seems to work properly and does not include the files , except if you put them here

if you put them on the top of this file, export_ledger_pdf.php will include the files but not export_ledger_csv.php

For PDF output

Definition at line 110 of file print_ledger.class.php.

    {
        /**
         * @Bug
         * Strange PHP Bug when autoloader is not used , the require_once doesn't seems to
         * work properly and does not include the files , except if you put them here
         *
         * if you put them on the top of this file,  export_ledger_pdf.php will include the files
         * but not export_ledger_csv.php
         */
 
        /**
         * For PDF output
         */
        switch ($p_type_export) {
            case 'D':
                $own=new Noalyss_Parameter_Folder($cn);
                $jrn_type=$p_ledger->get_type();
                //---------------------------------------------
                // Detailled Printing (accounting )
                //---------------------------------------------
                if ($jrn_type=='ACH'||$jrn_type=='VEN')
                {
                    if (
                            ($jrn_type=='ACH'&&$cn->get_value('select count(qp_id) from quant_purchase')
                            ==0)||
                            ($jrn_type=='VEN'&&$cn->get_value('select count(qs_id) from quant_sold')
                            ==0)
                    )
                    {
                        $pdf=new Print_Ledger_Simple_without_vat($cn,
                                $p_ledger,$p_from,$p_to,$p_filter_operation);
                        $pdf->set_error(_('Ce journal ne peut être imprimé en mode simple'));
                        return $pdf;
                    }
                    if ($own->MY_TVA_USE=='Y')
                    {
                        $pdf=new Print_Ledger_Simple($cn, $p_ledger,$p_from,$p_to,$p_filter_operation);
                        return $pdf;
                    }
                    if ($own->MY_TVA_USE=='N')
                    {
                        $pdf=new Print_Ledger_Simple_without_vat($cn,
                                $p_ledger,$p_from,$p_to,$p_filter_operation);
                        return $pdf;
                    }
                }
                elseif ($jrn_type=='FIN')
                {
                    $pdf=new Print_Ledger_Financial($cn, $p_ledger,$p_from,$p_to);
                    return $pdf;
                } else 
                {
                    return new Print_Ledger_Detail($cn, $p_ledger,$p_from,$p_to);
                }
                break;
 
            case 'L':
                //----------------------------------------------------------------------
                // Simple Printing Purchase Ledger
                //---------------------------------------------------------------------
                $own=new Noalyss_Parameter_Folder($cn);
                $jrn_type=$p_ledger->get_type();
 
 
                if ($jrn_type=='ACH'||$jrn_type=='VEN')
                {
                    if (
                            ($jrn_type=='ACH'&&$cn->get_value('select count(qp_id) from quant_purchase')
                            ==0)||
                            ($jrn_type=='VEN'&&$cn->get_value('select count(qs_id) from quant_sold')
                            ==0)
                    )
                    {
                        $pdf=new Print_Ledger_Simple_without_vat($cn,
                                $p_ledger,$p_from,$p_to,$p_filter_operation);
                        $pdf->set_error(_('Ce journal ne peut être imprimé en mode simple'));
                        return $pdf;
                    }
                    if ($own->MY_TVA_USE=='Y')
                    {
                        $pdf=new Print_Ledger_Simple($cn, $p_ledger,$p_from,$p_to,$p_filter_operation);
                        return $pdf;
                    }
                    if ($own->MY_TVA_USE=='N')
                    {
                        $pdf=new Print_Ledger_Simple_without_vat($cn,
                                $p_ledger,$p_from,$p_to,$p_filter_operation);
                        return $pdf;
                    }
                }
 
                if ($jrn_type=='FIN')
                {  
                    $pdf=new Print_Ledger_Financial($cn, $p_ledger,$p_from,$p_to);
                    return $pdf;
                }
                $pdf=new Print_Ledger_Misc($cn, $p_ledger,$p_from,$p_to);
                return $pdf;
                break;
            case 'E':
                /**********************************************************
                 * Print Detail Operation + Item
                 * ********************************************************* */
                $own=new Noalyss_Parameter_Folder($cn);
                $jrn_type=$p_ledger->get_type();
                if ($jrn_type=='FIN')
                {
                    $pdf=new Print_Ledger_Detail($cn, $p_ledger,$p_from,$p_to);
                    return $pdf;
                }
                if ($jrn_type=='ODS'||$p_ledger->id==0)
                {
                    $pdf=new Print_Ledger_Detail($cn, $p_ledger,$p_from,$p_to);
                    return $pdf;
                }
                if (
                        ($jrn_type=='ACH'&&$cn->get_value('select count(qp_id) from quant_purchase')
                        ==0)||
                        ($jrn_type=='VEN'&&$cn->get_value('select count(qs_id) from quant_sold')
                        ==0)
                )
                {
                    $pdf=new Print_Ledger_Simple_without_vat($cn, $p_ledger,$p_from,$p_to,$p_filter_operation);
                    $pdf->set_error('Ce journal ne peut être imprimé en mode simple');
                    return $pdf;
                }
                $pdf=new Print_Ledger_Detail_Item($cn, $p_ledger,$p_from,$p_to,$p_filter_operation);
                return $pdf;
            case 'A':
                /***********************************************************
                 * Accounting
                 */
                $pdf=new Print_Ledger_Detail($cn, $p_ledger,$p_from,$p_to);
                return $pdf;
                break;
        } // end switch
    }

References PDF\$cn, $jrn_type, PDF\$own, $pdf, _, elseif, and Acc_Ledger\get_type().

Here is the call graph for this function:

◆ get_filter_operation()

Print_Ledger::get_filter_operation ( )

Definition at line 84 of file print_ledger.class.php.

    {
        return $this->filter_operation;
    }

References $filter_operation.

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

◆ get_from()

Print_Ledger::get_from ( )

Definition at line 57 of file print_ledger.class.php.

    {
        return $this->from;
    }

References $from.

Referenced by Print_Ledger_Financial\__construct(), Print_Ledger_Simple\__construct(), Print_Ledger_Detail\export(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), and Print_Ledger_Simple_Without_Vat\export().

◆ get_ledger()

Print_Ledger::get_ledger ( )

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

    {
        return $this->ledger;
    }

References $ledger.

Referenced by Print_Ledger_Financial\__construct(), Print_Ledger_Simple\__construct(), Print_Ledger_Simple_Without_Vat\__construct(), Print_Ledger_Detail\export(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), and Print_Ledger_Detail_Item\Footer().

◆ get_to()

Print_Ledger::get_to ( )

Definition at line 62 of file print_ledger.class.php.

    {
        return $this->to;
    }

References $to.

Referenced by Print_Ledger_Detail\export(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), and Print_Ledger_Simple_Without_Vat\export().

◆ set_filter_operation()

Print_Ledger::set_filter_operation ( $filter_operation )

Filter the operations ,.

Parameters

string $filter_operation : all , paid, unpaid

Returns: $this

Exceptions

Exception 5 , if filter invalid

Reimplemented from PDF.

Definition at line 94 of file print_ledger.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 _.

Referenced by __construct().

◆ set_from()

Print_Ledger::set_from ( $from )

Definition at line 73 of file print_ledger.class.php.

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

References $from, and from.

◆ set_ledger()

Print_Ledger::set_ledger ( $ledger )

Definition at line 67 of file print_ledger.class.php.

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

References $ledger.

◆ set_to()

Print_Ledger::set_to ( $to )

Definition at line 79 of file print_ledger.class.php.

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

References $to, and to.

Field Documentation

◆ $filter_operation

Print_Ledger::$filter_operation

protected

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

Referenced by get_filter_operation(), and set_filter_operation().

◆ $from

Print_Ledger::$from

private

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

Referenced by get_from(), and set_from().

◆ $ledger

Print_Ledger::$ledger

private

concerned Ledger

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

Referenced by Print_Ledger_Detail\__construct(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), get_ledger(), and set_ledger().

◆ $to

Print_Ledger::$to

private

integer parm_periode.p_id , start periode;

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

Referenced by get_to(), and set_to().

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

include/class/print_ledger.class.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ available_ledger()

◆ build_filter_operation()

◆ factory()

◆ get_filter_operation()

◆ get_from()

◆ get_ledger()

◆ get_to()

◆ set_filter_operation()

◆ set_from()

◆ set_ledger()

◆ set_to()

Field Documentation

◆ $filter_operation

◆ $from

◆ $ledger

◆ $to