Lettering Class Reference

mother class for the lettering by account and by card use the tables jnt_letter, letter_deb and letter_cred More...

Inheritance diagram for Lettering:

Collaboration diagram for Lettering:

Public Member Functions
	__construct ( $p_init)
	constructor
	delete ()
	get_info ()
	get_linked ($p_jlid)
	get_parameter ($p_string)
	insert ()
	insert_couple ($j_id1, $j_id2)
	Use to just insert a couple of lettered operation but do not make a link between operation.
	load ()
	remove_incoherent ()
	for some reason , sometimes, a record in letter_X doesn't have his counterpart in letter_Y
	save ($p_array)
	save from array, letter the accounting (or card) and create a link between operation
	seek ($cond, $p_array=null)
	retrieve * row thanks a condition
	set_parameter ($p_string, $p_value)
	show_letter ($p_jid)
	show_list ($p_type)
	wrapper : it call show_all, show_lettered or show_not_lettered depending of the parameter
	update ()
	verify ()

Data Fields
	$content
	$db
	$end
	$fil_amount_max
	$fil_amount_min
	$fil_deb
	$linked
	$object_type
	$sql_ledger
	$start

Protected Member Functions
	show_all ()
	show all the record from jrnx and their status (linked or not) it fills the array $this->content
	show_lettered ()
	show only the lettered records from jrnx it fills the array $this->content
	show_lettered_diff ()
	show only the lettered records from jrnx it fills the array $this->content
	show_not_lettered ()
	show only the not lettered records from jrnx it fills the array $this->content

Protected Attributes
	$variable
	$variable (array) data member

Detailed Description

mother class for the lettering by account and by card use the tables jnt_letter, letter_deb and letter_cred

• "account"=>"account", => the accounting of the j_id (use by Lettering_Account)
• "quick_code"=>"quick_code", => the quick_code of the j_id (used by Lettering_Card)
• "start"=>"start", => date of the first day
• "end"=>"end", => date of the last day
• "sql_ledger"=>"sql_ledger" => the sql clause to filter on the available ledgers

See also

unit-test/include/class/acc_letterTest.php

test scenario scenario/XML/ajax_display_letter.php

Definition at line 45 of file lettering.class.php.

Constructor & Destructor Documentation

__construct()

Lettering::__construct

(

$p_init

)

constructor

Parameters

$p_init

resource to database

Note

by default start and end are the 1.1.exercice to 31.12.exercice

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

    {
        $this->db=$p_init;
        $a=new Noalyss_user($p_init);
        $exercice=$a->get_exercice();
        if ($exercice>0)
        {
            $periode=new Periode($p_init);
            $aLimite=$periode->get_limit($exercice);
            $this->start=$aLimite[0]->first_day();
            $this->end=$aLimite[1]->last_day();
        }
        else
        {
            $this->start='01.01.'.$exercice;
            $this->end='31.12.'.$exercice;
        }
        // available ledgers
        $this->sql_ledger=noalyss_str_replace('jrn_def_id', 'jr_def_id', $a->get_ledger_sql('ALL', 3));
    }

References $a, $exercice, $periode, db, and noalyss_str_replace().

Here is the call graph for this function:

Member Function Documentation

delete()

Lettering::delete

(

)

Definition at line 488 of file lettering.class.php.

    {
        throw new Exception('delete not implemented');
    }

get_info()

Lettering::get_info

(

)

Definition at line 226 of file lettering.class.php.

    {
        return var_export(self::$variable, true);
    }

get_linked()

Lettering::get_linked

(

$p_jlid

)

Definition at line 352 of file lettering.class.php.

    {
        $sql="select j_id,j_date,to_char(j_date,'DD.MM.YYYY') as j_date_fmt,
             j_montant,j_debit,jr_comment,jr_internal,jr_id,jr_def_id,jr_pj_number,
             coalesce(comptaproc.get_letter_jnt(j_id),-1) as letter
             from jrnx join jrn on (j_grpt = jr_grpt_id)
                         where
                         j_id in (select j_id from letter_cred where jl_id=$1
                                        union all
                                        select j_id from letter_deb where jl_id=$1)
                                        order by j_date";
 
        $this->linked=$this->db->get_array($sql, array($p_jlid));
    }

References $sql, and db.

Referenced by show_letter().

get_parameter()

Lettering::get_parameter

(

$p_string

)

Definition at line 93 of file lettering.class.php.

    {
        if (array_key_exists($p_string, $this->variable))
        {
            $idx=$this->variable[$p_string];
            return $this->$idx;
        }
        else
            throw new Exception(__FILE__.":".__LINE__.$p_string.'Erreur attribut inexistant');
    }

References $idx.

insert()

Lettering::insert

(

)

Definition at line 331 of file lettering.class.php.

    {
        if ($this->verify()!=0)
            return;
    }

References verify().

Here is the call graph for this function:

insert_couple()

Lettering::insert_couple	(		$j_id1,
			$j_id2 )

Use to just insert a couple of lettered operation but do not make a link between operation.

Definition at line 118 of file lettering.class.php.

    {
 
        /*  take needed data */
        $first=$this->db->get_value('select j_debit from jrnx where j_id=$1', array($j_id1));
        if ($this->db->count()==0)
            throw new Exception('Opération non existante');
 
        $second=$this->db->get_value('select j_debit from jrnx where j_id=$1', array($j_id2));
        if ($this->db->count()==0)
            throw new Exception('Opération non existante');
        $sql_already="select distinct(jl_id)
                        from jnt_letter
                        left outer join letter_deb using (jl_id)
                        left outer join letter_cred using (jl_id)
                        where
                        letter_deb.j_id = $1 or letter_cred.j_id=$1";
        $let1=0; $let2=0;
        $already=$this->db->get_array($sql_already, array($j_id1));
        if (count($already)>0)
        {
            if (count($already)==1)
            {
                // retrieve the letter
                $let1=$this->db->get_value("select distinct(jl_id)
                                                from jnt_letter
                                                left outer join letter_deb using (jl_id)
                                                left outer join letter_cred using (jl_id)
                                                where
                                                letter_deb.j_id = $1 or letter_cred.j_id=$1", array($j_id1));
            }
            else
            {
                return;
            }
        }
 
        $already=$this->db->get_array($sql_already, array($j_id2));
        if (count($already)>0)
        {
            if (count($already)==1)
            {
                // retrieve the letter
                $let2=$this->db->get_value("select distinct(jl_id)
                                                from jnt_letter
                                                left outer join letter_deb using (jl_id)
                                                left outer join letter_cred using (jl_id)
                                                where
                                                letter_deb.j_id = $1 or letter_cred.j_id=$1", array($j_id2));
            }
            else
            {
                return;
            }
        }
        $jl_id=0;
        // already linked together
        if ($let1!=0&&$let1==$let2)
            return;
 
        // already linked
     /*   if ($let1!=0&&$let2!=0&&$let1!=$let2)
            return;
*/
        // none is linked
        if ($let1==0&&$let2==0)
        {
            $jl_id=$this->db->get_next_seq("jnt_letter_jl_id_seq");
            $this->db->exec_sql('insert into jnt_letter(jl_id) values($1)', array($jl_id));
        } elseif ($let1==0&&$let2!=0)
        {
            // one is linked but not the other
            $jl_id=$let2;
        }elseif  ($let1!=0&&$let2==0) {
            $jl_id=$let1;
        } else {
            throw new \Exception ("LET179 invalid");
        }
 
        /* insert */
        if ($first=='t')
        {
            // save into letter_deb
            if ($let1==0)
                $ld_id=$this->db->get_value('insert into letter_deb(j_id,jl_id) values($1,$2) returning ld_id',
                        array($j_id1, $jl_id));
        }
        else
        {
            if ($let1==0)
                $lc_id=$this->db->get_value('insert into letter_cred(j_id,jl_id)  values($1,$2) returning lc_id',
                        array($j_id1, $jl_id));
        }
        if ($second=='t')
        {
            // save into letter_deb
            if ($let2==0)
                $ld_id=$this->db->get_value('insert into letter_deb(j_id,jl_id) values($1,$2) returning ld_id',
                        array($j_id2, $jl_id));
        }
        else
        {
            if ($let2==0)
                $lc_id=$this->db->get_value('insert into letter_cred(j_id,jl_id)  values($1,$2) returning lc_id',
                        array($j_id2, $jl_id));
        }
    }

References db, and elseif.

load()

Lettering::load

(

)

Definition at line 482 of file lettering.class.php.

    {
        
        throw new Exception('load not implemented');
    }

remove_incoherent()

Lettering::remove_incoherent

(

)

for some reason , sometimes, a record in letter_X doesn't have his counterpart in letter_Y

Definition at line 415 of file lettering.class.php.

    {
        $this->db->exec_sql("delete from letter_cred lc  where jl_id not in (select jl_id from letter_deb)");
        $this->db->exec_sql("delete from letter_deb lc  where jl_id not in (select jl_id from letter_cred)");
    }

References db.

save()

Lettering::save

(

$p_array

)

save from array, letter the accounting (or card) and create a link between operation

Parameters

$p_array

gDossier => string '13' (length=2) letter_j_id => is an array of j_id value ck => array of j_id to letter with j_id j_id => row to link

Definition at line 247 of file lettering.class.php.

    {
        
        if (!isset($p_array['letter_j_id']))
        {
            // if nothing selected then remove
             $this->db->exec_sql('delete from jnt_letter where jl_id=$1', array($p_array['jnt_id']));
            return;
        }
        $nb_letter_j_id=count($p_array['letter_j_id']);
        
        if ($nb_letter_j_id == 0 ) {
            $this->db->exec_sql('delete from jnt_letter where jl_id=$1', array($p_array['jnt_id']));
            return;
        }
        try
        {
            $this->db->start();
            
            $this->db->exec_sql('delete from jnt_letter where jl_id=$1', array($p_array['jnt_id']));
 
            $jl_id=$this->db->get_next_seq("jnt_letter_jl_id_seq");
            $this->db->exec_sql('insert into jnt_letter(jl_id) values($1)', array($jl_id));
 
            // save the source
            $deb=$this->db->get_value('select j_debit,j_montant from jrnx where j_id=$1', array($p_array['j_id']));
            if ($deb=='t')
            {
                // save into letter_deb
                $ld_id=$this->db->get_value('insert into letter_deb(j_id,jl_id) values($1,$2) returning ld_id',
                        array($p_array['j_id'], $jl_id));
            }
            else
            {
                $lc_id=$this->db->get_value('insert into letter_cred(j_id,jl_id)  values($1,$2) returning lc_id',
                        array($p_array['j_id'], $jl_id));
            }
            // save dest
            for ($i=0; $i<$nb_letter_j_id; $i++)
            {
                if (! isset($p_array['ck'][$i]) || $p_array['ck'][$i] == "-2" ) { continue ; }
                
                // save the dest
                $deb=$this->db->get_value('select j_debit,j_montant from jrnx where j_id=$1',
                        array($p_array['ck'][$i]));
                if ($deb=='t')
                {
                    // save into letter_deb
                    $ld_id=$this->db->get_value('insert into letter_deb(j_id,jl_id) values($1,$2) returning ld_id',
                            array($p_array['ck'][$i], $jl_id));
                }
                else
                {
                    $lc_id=$this->db->get_value('insert into letter_cred(j_id,jl_id)  values($1,$2) returning lc_id',
                            array($p_array['ck'][$i], $jl_id));
                }
                $acc_reconciliation_lettering=new Acc_Reconciliation_Lettering($this->db);
                $acc_reconciliation_lettering->insert_reconcilied($p_array['ck'][$i], $p_array['j_id']);
            } //end for
          
        }
        catch (Exception $exc)
        {
            echo $exc->getMessage();
            record_log($exc);
            $this->db->rollback();
            return;
        }
 
 
        $this->db->commit();
    }

References $deb, $i, $p_array, db, and record_log().

Here is the call graph for this function:

seek()

Lettering::seek	(		$cond,
			$p_array = null )

retrieve * row thanks a condition

Definition at line 323 of file lettering.class.php.

    {
        /*
          $sql="select * from * where $cond";
          return $this->cn->get_array($cond,$p_array)
         */
    }

References $p_array.

set_parameter()

Lettering::set_parameter	(		$p_string,
			$p_value )

Definition at line 104 of file lettering.class.php.

    {
        if (array_key_exists($p_string, $this->variable))
        {
            $idx=$this->variable[$p_string];
            $this->$idx=$p_value;
        }
        else
            throw new Exception(__FILE__.":".__LINE__.$p_string.'Erreur attribut inexistant');
    }

References $idx.

show_all()

Lettering::show_all ( )

protected

show all the record from jrnx and their status (linked or not) it fills the array $this->content

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

    {
        $this->get_all();
        $r="";
        ob_start();
        include(NOALYSS_TEMPLATE.'/letter_all.php');
        $r=ob_get_contents();
        ob_end_clean();
        return $r;
    }

References $r.

Referenced by show_list().

show_letter()

Lettering::show_letter

(

$p_jid

)

Definition at line 446 of file lettering.class.php.

    {
        $j_debit=$this->db->get_value('select j_Debit from jrnx where j_id=$1', array($p_jid));
        $amount_init=$this->db->get_value('select j_montant from jrnx where j_id=$1', array($p_jid));
 
        $this->get_filter($p_jid);
        // retrieve jnt_letter.id
        $sql="select distinct(jl_id) from jnt_letter  left outer join letter_deb using (jl_id) left outer join letter_cred using (jl_id)
             where letter_deb.j_id = $1 or letter_cred.j_id=$2";
        $a_jnt_id=$this->db->get_array($sql, array($p_jid, $p_jid));
 
        if (count($a_jnt_id)==0)
        {
            $jnt_id=-2;
        }
        else
        {
            $jnt_id=$a_jnt_id[0]['jl_id'];
        }
        $this->get_linked($jnt_id);
        ob_start();
        require_once NOALYSS_TEMPLATE.'/letter_prop.php';
        $r=ob_get_contents();
        ob_end_clean();
        $r.=HtmlInput::hidden('j_id', $p_jid);
        $r.=HtmlInput::hidden('jnt_id', $jnt_id);
 
        return $r;
    }

References $r, $sql, db, and get_linked().

Here is the call graph for this function:

show_lettered()

Lettering::show_lettered ( )

protected

show only the lettered records from jrnx it fills the array $this->content

Definition at line 371 of file lettering.class.php.

    {
        $this->get_letter();
        $r="";
        ob_start();
        include(NOALYSS_TEMPLATE.'/letter_all.php');
        $r=ob_get_contents();
        ob_end_clean();
        return $r;
    }

References $r.

Referenced by show_list().

show_lettered_diff()

Lettering::show_lettered_diff ( )

protected

show only the lettered records from jrnx it fills the array $this->content

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

    {
        $this->get_letter_diff();
        $r="";
        ob_start();
        include(NOALYSS_TEMPLATE.'/letter_all.php');
        $r=ob_get_contents();
        ob_end_clean();
        return $r;
    }

References $r.

Referenced by show_list().

show_list()

Lettering::show_list

(

$p_type

)

wrapper : it call show_all, show_lettered or show_not_lettered depending of the parameter

Parameters

$p_type

poss. values are all, unletter, letter

Definition at line 425 of file lettering.class.php.

    {
        
        switch ($p_type)
        {
            case 'all':
                return $this->show_all();
                break;
            case 'unletter':
                return $this->show_not_lettered();
                break;
            case 'letter':
                return $this->show_lettered();
                break;
            case 'letter_diff':
                return $this->show_lettered_diff();
                break;
        }
        throw new Exception("[$p_type] is no unknown");
    }

References $p_type, show_all(), show_lettered(), show_lettered_diff(), and show_not_lettered().

Here is the call graph for this function:

show_not_lettered()

Lettering::show_not_lettered ( )

protected

show only the not lettered records from jrnx it fills the array $this->content

Definition at line 401 of file lettering.class.php.

    {
        $this->get_unletter();
        $r="";
        ob_start();
        include(NOALYSS_TEMPLATE.'/letter_all.php');
        $r=ob_get_contents();
        ob_end_clean();
        return $r;
    }

References $r.

Referenced by show_list().

update()

Lettering::update

(

)

Definition at line 476 of file lettering.class.php.

    {
        if ($this->verify()!=0)
            return;
    }

References verify().

Here is the call graph for this function:

verify()

Lettering::verify

(

)

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

    {
        // Verify that the elt we want to add is correct
    }

Referenced by insert(), and update().

Field Documentation

$content

Lettering::$content

Definition at line 61 of file lettering.class.php.

$db

Lettering::$db

Definition at line 56 of file lettering.class.php.

$end

Lettering::$end

Definition at line 58 of file lettering.class.php.

$fil_amount_max

Lettering::$fil_amount_max

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

$fil_amount_min

Lettering::$fil_amount_min

Definition at line 63 of file lettering.class.php.

$fil_deb

Lettering::$fil_deb

Definition at line 64 of file lettering.class.php.

$linked

Lettering::$linked

Definition at line 65 of file lettering.class.php.

$object_type

Lettering::$object_type

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

$sql_ledger

Lettering::$sql_ledger

Definition at line 59 of file lettering.class.php.

$start

Lettering::$start

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

$variable

Lettering::$variable

protected

Initial value:

=array("account"=>"account", 
        "quick_code"=>"quick_code", 
        "start"=>"start", 
        "end"=>"end", 
        "sql_ledger"=>"sql_ledger" 
            )

$variable (array) data member

Todo

Lettering must be rewritten and use __set and __get instead of an array + data_member

Definition at line 49 of file lettering.class.php.

---

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

• include/class/lettering.class.php