Acc_Payment Class Reference

Handle the table payment_method. More...

Collaboration diagram for Acc_Payment:

Public Member Functions
	__construct ($p_cn, $p_init=0)
	blank ()
	return an html with a form to add a new middle of payment
	form ()
	return a string with a form (into a table)
	from_array ($p_array)
	convert an array into an Acc_Payment object
	get_all ()
	retrieve all the data for all ledgers
	get_info ()
	get_parameter ($p_string)
	get_valide ()
	retrieve all the data for a ledger but filter on the valid record (jrn and fd not null
	load ()
	select ($p_select, $p_amount, $p_date, $p_comm)
	show several lines with radio button to select the payment method we want to use, the $_POST['e_mp'] will be set
	set_parameter ($p_string, $p_value)

Private Attributes
	$cn
	Database connection.
	$jrn_def_id
	$mp_fd_id
	$mp_id
	$mp_jrn_def_if
	$mp_lib
	$mp_qcode

Static Private Attributes
static	$variable

Detailed Description

Handle the table payment_method.

Note

the private data member are accessed via

• mp_id ==> id ( Primary key )
• mp_lib ==> lib (label)
• mp_jrn_def_id ==> ledger (Number of the ledger where to save)
• mp_fd_id ==> fiche_def (fiche class to use)
• mp_qcode ==> qcode (quick_code of the card)

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

Constructor & Destructor Documentation

__construct()

Acc_Payment::__construct	(		$p_cn,
			$p_init = 0 )

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

    {
        $this->cn=$p_cn;
        $this->mp_id=$p_init;
    }

References cn.

Member Function Documentation

blank()

Acc_Payment::blank

(

)

return an html with a form to add a new middle of payment

Definition at line 304 of file acc_payment.class.php.

    {
        //label
        $lib=new IText('mp_lib');
        $f_lib=$lib->input();
 
        $ledger_source=new ISelect('jrn_def_id');
        $ledger_source->value=$this->cn->make_array("select jrn_def_id,jrn_Def_name from
                              jrn_def where jrn_def_type  in ('ACH','VEN') order by jrn_def_name");
        $f_source=$ledger_source->input();
 
        // type of card
        $tcard=new ISelect('mp_fd_id');
        $tcard->value=$this->cn->make_array('select fd_id,fd_label from fiche_def join fiche_def_ref '.
                                            ' using (frd_id) where frd_id in (25,4) order by fd_label');
        $f_type_fiche=$tcard->input();
        $ledger_record=new ISelect('mp_jrn_def_id');
        $ledger_record->value=$this->cn->make_array("select jrn_def_id,jrn_Def_name from
                              jrn_def where jrn_def_type  in ('ODS','FIN')");
        $f_ledger_record=$ledger_record->input();
 
        // the card
        $qcode=new ICard();
        $qcode->noadd=true;
        $qcode->name='mp_qcode';
        $list=$this->cn->make_list('select fd_id from fiche_def where frd_id in (25,4)');
        $qcode->typecard=$list;
                $qcode->dblclick='fill_ipopcard(this);';
 
        $f_qcode=$qcode->input();
                $msg="Ajout d'un nouveau moyen de paiement";
        ob_start();
        require_once NOALYSS_TEMPLATE.'/new_mod_payment.php';
        $r=ob_get_contents();
        ob_end_clean();
        return $r;
    }

References $list, $msg, $qcode, $r, and cn.

form()

Acc_Payment::form

(

)

return a string with a form (into a table)

Parameters

none

Returns

a html string

Definition at line 157 of file acc_payment.class.php.

    {
        //label
        $lib=new IText('mp_lib');
        $lib->value=$this->mp_lib;
                $f_lib=$lib->input();
 
 
        $ledger_source=new ISelect('jrn_def_id');
        $ledger_source->value=$this->cn->make_array("select jrn_def_id,jrn_Def_name from
                              jrn_def where jrn_def_type  in ('ACH','VEN') order by jrn_def_name");
                $ledger_source->selected=$this->jrn_def_id;
        $f_source=$ledger_source->input();
 
        // type of card
        $tcard=new ISelect('mp_fd_id');
        $tcard->value=$this->cn->make_array('select fd_id,fd_label from fiche_def join fiche_def_ref '.
                                            ' using (frd_id) where frd_id in (25,4) order by fd_label');
                $tcard->selected=$this->mp_fd_id;
 
        $f_type_fiche=$tcard->input();
        $ledger_record=new ISelect('mp_jrn_def_id');
        $ledger_record->value=$this->cn->make_array("select jrn_def_id,jrn_Def_name from
                              jrn_def where jrn_def_type  in ('ODS','FIN')");
                $ledger_record->selected=$this->mp_jrn_def_id;
        $f_ledger_record=$ledger_record->input();
 
        // the card
        $qcode=new ICard();
        $qcode->noadd=true;
        $qcode->name='mp_qcode';
        $list=$this->cn->make_list('select fd_id from fiche_def where frd_id in (25,4)');
        $qcode->typecard=$list;
                $qcode->dblclick='fill_ipopcard(this);';
                $qcode->value=$this->mp_qcode;
 
        $f_qcode=$qcode->input();
 
                $msg="Modification de ".$this->mp_lib;
        ob_start();
        require_once NOALYSS_TEMPLATE.'/new_mod_payment.php';
        $r=ob_get_contents();
        ob_end_clean();
        return $r;
 
    }

References $jrn_def_id, $list, $mp_fd_id, $mp_lib, $mp_qcode, $msg, $qcode, $r, and cn.

from_array()

Acc_Payment::from_array

(

$p_array

)

convert an array into an Acc_Payment object

Parameters

array

to convert

Definition at line 293 of file acc_payment.class.php.

    {
        $a_index=array_values(self::$variable);
        // $idx=array('mp_id','mp_lib','mp_fd_id','mp_jrn_def_id','mp_qcode','jrn_def_id');
        foreach ($a_index as $l) {
            if (isset($p_array[$l])) $this->$l=$p_array[$l];
        }
    }

References $l, and $p_array.

get_all()

Acc_Payment::get_all

(

)

retrieve all the data for all ledgers

Parameters

non

Returns

an array of row

Definition at line 112 of file acc_payment.class.php.

    {
        $sql='select mp_id,mp_lib '.
             ' from payment_method order by mp_lib';
        $array=$this->cn->get_array($sql);
        $ret=array();
        if ( !empty($array) )
        {
            foreach ($array as $row)
            {
                $t=new Acc_Payment($this->cn,$row['mp_id']);
                $t->load();
                $ret[]=$t;
            }
        }
        return $ret;
    }

References $array, $ret, $row, $sql, $t, and cn.

get_info()

Acc_Payment::get_info

(

)

Definition at line 83 of file acc_payment.class.php.

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

get_parameter()

Acc_Payment::get_parameter

(

$p_string

)

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

    {
        if ( array_key_exists($p_string,self::$variable) )
        {
            $idx=self::$variable[$p_string];
            return $this->$idx;
        }
        else
                {
                        throw new Exception("Attribut inexistant $p_string");
                }
    }

References $idx.

get_valide()

Acc_Payment::get_valide

(

)

retrieve all the data for a ledger but filter on the valid record (jrn and fd not null

Parameters

non

Returns

an array of row

Definition at line 134 of file acc_payment.class.php.

    {
        $sql='select mp_id '.
             ' from payment_method '.
             ' where jrn_def_id=$1 and mp_jrn_def_id is not null and '.
             ' (mp_fd_id is not null or mp_qcode is not null)';
        $array=$this->cn->get_array($sql,array($this->jrn_def_id));
        $ret=array();
        if ( !empty($array) )
        {
            foreach ($array as $row)
            {
                $t=new Acc_Payment($this->cn,$row['mp_id']);
                $t->load();
                $ret[]=$t;
            }
        }
        return $ret;
    }

References $array, $ret, $row, $sql, $t, cn, and jrn_def_id.

Referenced by select().

load()

Acc_Payment::load

(

)

Definition at line 88 of file acc_payment.class.php.

                          :bool
    {
        $sql='select mp_id,mp_lib,mp_fd_id,mp_jrn_def_id,mp_qcode,jrn_def_id from payment_method '.
             ' where mp_id = $1';
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->mp_id)
             );
 
        if ( Database::num_row($res) == 0 ) return false;
        
        $row=Database::fetch_array($res,0);
        $a_index=array_values(self::$variable);
        foreach ($a_index as $idx)
        {
            $this->$idx=$row[$idx];
        }
        return true;
    }

References $idx, $res, $row, $sql, cn, DatabaseCore\fetch_array(), and DatabaseCore\num_row().

Here is the call graph for this function:

select()

Acc_Payment::select	(		$p_select,
			$p_amount,
			$p_date,
			$p_comm )

show several lines with radio button to select the payment method we want to use, the $_POST['e_mp'] will be set

Todo

this class is used only for storage of the defined payment method, not the payment itself, it must be moved to another class 'Operation_Payment'

Parameters

$p_selected	if the id choose
$p_date	date of payment
$p_amount	amount already paid
$p_comm	label of payment

Returns

html string

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

    {
        $r='';
        $array=$this->get_valide();
        $r.=HtmlInput::hidden('gDossier',dossier::id());
 
        if ( empty($array)==false ) {
            $date_pay=new IDate('mp_date');
            $date_pay->value=$p_date;
            $r.=sprintf(_("Date %s"),
                    $date_pay->input());
            $acompte=new INum('acompte');
            $acompte->value=$p_amount;
            $r.=_(" Acompte à déduire");
            $r.=$acompte->input();
            $r.='<p>';
            $e_comm_paiement=new IText('e_comm_paiement');
            $e_comm_paiement->value=$p_comm;
            $e_comm_paiement->table = 0;
            $e_comm_paiement->setReadOnly(false);
            $e_comm_paiement->size = 60;
            $e_comm_paiement->tabindex = 3;
            $r.=_(" Libellé du paiement");
            $r.=$e_comm_paiement->input();
            $r.='</p>';
        }
 
        $r.='<ol>';
        $r.='<li ><input type="radio" name="e_mp" value="0" checked>'._('Paiement encodé plus tard');
        $http=new HttpInput();
        if ( empty($array ) == false )
        {
            foreach ($array as $row)
            {
                $f='';
                /* if the qcode is  null the propose a search button to select
                   the card */
                if ( $row->mp_qcode==NULL)
                {
                    $a=new ICard();
                    $a->jrn=$row->mp_jrn_def_id;
                    $a->set_attribute('typecard',$row->mp_fd_id);
                    $a->name='e_mp_qcode_'.$row->mp_id;
                    $a->set_dblclick("fill_ipopcard(this);");
                    $a->set_callback('filter_card');
                    $a->set_function('fill_data');
                    $a->set_attribute('ipopup','ipopcard');
                    $a->set_attribute('label',$a->name.'_label');
                    if ( $p_select == $row->mp_id ) {
                        $a->value=$http->request("e_mp_qcode_".$p_select, "string","");
                    }
                    $s=new ISpan();
                    $s->name=$a->name.'_label';
                    $f=_(" paiement par ").$a->input().$s->input().$a->search();
                    
                }
                else
                {
                    /* if the qcode is not null then add a hidden variable with
                       the qcode */
 
                    $fiche=new Fiche($this->cn);
                    $fiche->get_by_qcode($row->mp_qcode);
                    $f=HtmlInput::hidden('e_mp_qcode_'.$row->mp_id,$row->mp_qcode);
 
                    //    $f.=$fiche->strAttribut(ATTR_DEF_NAME);
                }
                $check=( $p_select == $row->mp_id)?" checked " : "unchecked";
                $r.='<li><input type="radio" name="e_mp" value="'.$row->mp_id.'" '.$check.'>';
                $r.=$row->mp_lib.'  '.$f;
 
            }
        }
        $r.='</ol>';
        return $r;
    }

References $a, $acompte, $array, $check, $f, $fiche, $http, $p_date, $r, $row, $s, _, cn, and get_valide().

Here is the call graph for this function:

set_parameter()

Acc_Payment::set_parameter	(		$p_string,
			$p_value )

Definition at line 71 of file acc_payment.class.php.

    {
        if ( array_key_exists($p_string,self::$variable) )
        {
            $idx=self::$variable[$p_string];
            $this->$idx=$p_value;
        }
        else
            throw new Exception("Attribut inexistant $p_string");
 
 
    }

References $idx.

Field Documentation

$cn

Acc_Payment::$cn

private

Database connection.

Definition at line 53 of file acc_payment.class.php.

$jrn_def_id

Acc_Payment::$jrn_def_id

private

Definition at line 51 of file acc_payment.class.php.

Referenced by form().

$mp_fd_id

Acc_Payment::$mp_fd_id

private

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

Referenced by form().

$mp_id

Acc_Payment::$mp_id

private

Definition at line 47 of file acc_payment.class.php.

$mp_jrn_def_if

Acc_Payment::$mp_jrn_def_if

private

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

$mp_lib

Acc_Payment::$mp_lib

private

Definition at line 48 of file acc_payment.class.php.

Referenced by form().

$mp_qcode

Acc_Payment::$mp_qcode

private

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

Referenced by form().

$variable

Acc_Payment::$variable

staticprivate

Initial value:

=array("id"=>"mp_id",
                                   "lib"=>"mp_lib",
                                   "qcode"=>"mp_qcode",
                                   "ledger_target"=>"mp_jrn_def_id",
                                   "ledger_source"=>"jrn_def_id",
                                   "fiche_def"=>"mp_fd_id")

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

---

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

• include/class/acc_payment.class.php