manage the predefined operation, link to the table op_def and op_def_detail More...

Collaboration diagram for Pre_operation:

Public Member Functions
	__construct ($cn, $p_id=0)

	blank ()
	create a blank object to insert it later More...

	choose_ledger ($p_ledger_type, $p_default)
	Build the select list for choosing the ledger. More...

	compute_array ()

	count ()
	count the number of pred operation for a ledger More...

	delete ()
	delete a template operation and children More...

	display ()
	display the detail of predefined operation, normally everything is loaded More...

	display_list_operation ($p_url)
	show the button for selecting a predefined operation More...

	form_get ($p_url)
	show a form to use pre_op More...

	get_db ()

	get_description ()

	get_detail ()

	get_jrn_type ()

	get_list_ledger ()
	get the list of the predef. operation of a ledger More...

	get_name ()

	get_nb_item ()

	get_od_direct ()

	get_od_id ()

	get_operation ()

	get_post ()
	fill the object with the $_POST variable More...

	load ()
	load the data from the database and return an array More...

	save ()

	save_insert ()
	save the predef check first is the name is unique More...

	save_update ()

	set_db ($db)

	set_description ($description)

	set_detail (Pre_operation_detail $detail)

	set_jrn_type ($jrn_type)

	set_name ($name)

	set_nb_item ($nb_item)

	set_od_direct ($od_direct)

	set_od_id ($od_id)

	set_p_jrn ($p_jrn)
	set the ledger More...

	show_button_deprecated ()
	show the button for selecting a predefined operation More...

Static Public Member Functions
static	save_propose ()
	Propose to save the operation into a predefined operation. More...

Data Fields
	$od_direct

Private Attributes
	$db

	$description

	$detail

	$isloaded

	$jrn_type

	$name

	$nb_item

	$od_id

	$p_jrn

Detailed Description

manage the predefined operation, link to the table op_def and op_def_detail

Definition at line 30 of file pre_operation.class.php.

Constructor & Destructor Documentation

◆ __construct()

Pre_operation::__construct	(	$cn,
		$p_id = `0`
	)

Definition at line 42 of file pre_operation.class.php.

    {
        $this->db=$cn;
        $this->od_direct='f';
        $this->od_id=$p_id;
        $this->p_jrn=0;
        $this->jrn_type='x';
        $this->name='';
        $this->isloaded=false;
        $this->description="";
 
    }

References $cn, $p_id, db, and name.

Member Function Documentation

◆ blank()

Pre_operation::blank ( )

create a blank object to insert it later

Parameters

$p_ledger_id

Exceptions

Exception

Definition at line 212 of file pre_operation.class.php.

                     {
        $array["od_id"]=-1;
        $array['jrn_def_id']=0;
        $array['od_name']="";
        $array['od_item']=2;
        $array['od_jrn_type']=$this->get_jrn_type();
        $array['od_description']="";
        foreach (array('jrn_def_id','od_name','od_item','od_jrn_type','od_description') as $field) {
            $this->$field=$array[$field];
        }
        $this->od_jrn_type=$array['od_jrn_type'];
 
        $this->detail = Pre_operation_detail::build_detail($array['od_jrn_type'], $this->db);
        $darray[0]=$array;
        return $darray;
    }

References $array, Pre_operation_detail\build_detail(), db, and get_jrn_type().

Referenced by compute_array(), and load().

Here is the call graph for this function:

◆ choose_ledger()

Pre_operation::choose_ledger	(	$p_ledger_type,
		$p_default
	)

Build the select list for choosing the ledger.

Parameters

string	$p_string	ledger type ACH VEN or ODS
	$p_default	selected ledger , -1 if none

Returns: ISelect

Definition at line 508 of file pre_operation.class.php.

                                                      {
        $select_ledger=new ISelect("p_jrn");
        $select_ledger->value=$this->db->make_array("select jrn_def_id,jrn_def_name 
                                                    from jrn_def where jrn_def_type=$1 order by 2",
            0,
            [$p_ledger_type]);
        $select_ledger->selected=$p_default;
        return $select_ledger;
    }

References db.

Referenced by display().

◆ compute_array()

Pre_operation::compute_array ( )

Definition at line 229 of file pre_operation.class.php.

    {
        if ($this->od_id > 0) {
            $p_array = $this->load();
        } else {
            $p_array=$this->blank();
        }
        $array=array(
                   "e_comm"=>$p_array[0]["od_name"],
                   "nb_item"=>(($p_array[0]["od_item"]<10)?10:$p_array[0]["od_item"])   ,
                   "p_jrn"=>$p_array[0]["jrn_def_id"],
                   "jrn_type"=>$p_array[0]["od_jrn_type"],
                   "od_description"=>$p_array['0']['od_description']
               );
        $this->detail = Pre_operation_detail::build_detail($this->od_jrn_type, $this->db);
        $array += $this->detail->compute_array($this->od_id);
        return $array;
 
    }

References $array, $p_array, blank(), Pre_operation_detail\build_detail(), db, and load().

Referenced by display().

Here is the call graph for this function:

◆ count()

Pre_operation::count ( )

count the number of pred operation for a ledger

Definition at line 268 of file pre_operation.class.php.

    {
        $a=$this->db->count_sql("select od_id,od_name from op_predef ".
                                " where jrn_def_id= $1 ".
                                " and od_direct = $2 ".
                                " order by od_name",array($this->p_jrn,$this->od_direct));
        return $a;
    }

References $a, and db.

Referenced by display_list_operation(), and save_insert().

◆ delete()

Pre_operation::delete ( )

delete a template operation and children

Definition at line 117 of file pre_operation.class.php.

    {
        $sql="delete from op_predef where od_id=$1";
        $this->db->exec_sql($sql,array($this->od_id));
    }

References $sql, and db.

◆ display()

Pre_operation::display ( )

display the detail of predefined operation, normally everything is loaded

Definition at line 295 of file pre_operation.class.php.

    {
        $array=$this->compute_array();
        $select_ledger=$this->choose_ledger($array['jrn_type'],$array['p_jrn']);
 
        require NOALYSS_TEMPLATE."/pre_operation_display.php";
        echo $this->detail->display($array);
    }

References $array, choose_ledger(), and compute_array().

Here is the call graph for this function:

◆ display_list_operation()

Pre_operation::display_list_operation ( $p_url )

show the button for selecting a predefined operation

Definition at line 324 of file pre_operation.class.php.

    {
 
 
        $value=$this->db->get_array("select od_id,od_name,od_description from op_predef ".
            " where jrn_def_id=$1".
            " order by od_name",
            array($this->p_jrn));
 
        if ( $this->p_jrn=='') $value=array();
 
        $r="";
        if (count($value)==0) {
            $r.=_("Vous n'avez encore sauvé aucun modèle");
            return $r;
        }
        $r.=_('Cherche').' '.HtmlInput::filter_table('modele_op_tab', '0,1', '0');
        $r.='<table style="width:100%" id="modele_op_tab">';
        for ($i=0;$i<count($value);$i++) {
            $r.='<tr class="'.(($i%2==0)?"even":"odd").'">';
            $r.='<td style="font-weight:bold;vertical-align:top;text-decoration:underline">';
            $r.=sprintf('<a href="%s&pre_def=%s" onclick="waiting_box()">%s</a> ',
                $p_url,$value[$i]['od_id'],$value[$i]['od_name']);
            $r.='</td>';
            $r.='<td>'.h($value[$i]['od_description']).'</td>';
            $r.='</tr>';
        }
        $r.='</table>';
        return $r;
    }

References $i, $p_url, $r, $value, count(), db, and HtmlInput\filter_table().

Referenced by form_get().

Here is the call graph for this function:

◆ form_get()

Pre_operation::form_get ( $p_url )

show a form to use pre_op

Definition at line 305 of file pre_operation.class.php.

    {
        $r=HtmlInput::button_action(_("Modèle d'opérations"),
            ' $(\'modele_op_div\').style.display=\'block\';if ( $(\'lk_modele_op_tab\')) { $(\'lk_modele_op_tab\').focus();}');
        $r.='<div id="modele_op_div" class="noprint">';
        $r.=HtmlInput::title_box(_("Modèle d'opérations"), 'modele_op_div', 'hide',"","n");
        $hid=new IHidden();
        $r.=$hid->input("action","use_opd");
        $r.=$hid->input("jrn_type",$this->jrn_type);
        $r.= $this->display_list_operation($p_url);
        $r.=' <p style="text-align: center">'.
            HtmlInput::button_hide('modele_op_div').
            '</p>';
        $r.='</div>';
        return $r;
 
    }

References $hid, $p_url, $r, HtmlInput\button_action(), HtmlInput\button_hide(), display_list_operation(), and HtmlInput\title_box().

Here is the call graph for this function:

◆ get_db()

Pre_operation::get_db ( )

Returns: mixed

Definition at line 367 of file pre_operation.class.php.

    {
        return $this->db;
        return $this;
    }

References $db.

◆ get_description()

Pre_operation::get_description ( )

Returns: string

Definition at line 78 of file pre_operation.class.php.

    {
        return $this->description;
    }/**

References $description.

◆ get_detail()

Pre_operation::get_detail ( )

Returns: array

Definition at line 440 of file pre_operation.class.php.

    {
        return $this->detail;
        return $this;
    }

References $detail.

◆ get_jrn_type()

Pre_operation::get_jrn_type ( )

Returns: string

Definition at line 403 of file pre_operation.class.php.

    {
        return $this->jrn_type;
    }

References $jrn_type.

Referenced by blank().

◆ get_list_ledger()

Pre_operation::get_list_ledger ( )

get the list of the predef. operation of a ledger

Returns: string

Definition at line 279 of file pre_operation.class.php.

    {
        $sql="select od_id,od_name,od_description from op_predef ".
             " where jrn_def_id= $1 ".
             " and od_direct = $2 ".
             " order by od_name";
        $res=$this->db->exec_sql($sql,array($this->p_jrn,$this->od_direct));
        $all=Database::fetch_all($res);
        return $all;
    }

References $all, $res, $sql, db, and DatabaseCore\fetch_all().

Here is the call graph for this function:

◆ get_name()

Pre_operation::get_name ( )

Returns: string

Definition at line 422 of file pre_operation.class.php.

    {
        return $this->name;
        return $this;
    }

References $name.

◆ get_nb_item()

Pre_operation::get_nb_item ( )

Returns: mixed

Definition at line 385 of file pre_operation.class.php.

    {
        return $this->nb_item;
        return $this;
    }

References $nb_item.

◆ get_od_direct()

Pre_operation::get_od_direct ( )

Returns: string

Definition at line 458 of file pre_operation.class.php.

    {
        return $this->od_direct;
        return $this;
    }

References $od_direct.

◆ get_od_id()

Pre_operation::get_od_id ( )

Returns: int|mixed

Definition at line 477 of file pre_operation.class.php.

    {
        return $this->od_id;
    }

References $od_id.

◆ get_operation()

Pre_operation::get_operation ( )

Definition at line 354 of file pre_operation.class.php.

    {
        if ( $this->jrn_def_id=='') return array();
        $value=$this->db->make_array("select od_id,od_name from op_predef ".
            " where jrn_def_id=".sql_string($this->jrn_def_id).
            " and od_direct ='".sql_string($this->od_direct)."'".
            " order by od_name",1);
        return $value;
    }

References $value, db, jrn_def_id, and sql_string().

Here is the call graph for this function:

◆ get_post()

Pre_operation::get_post ( )

fill the object with the $_POST variable

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

    {
        $http=new HttpInput();
        $this->nb_item=$http->post('nb_item',"number");
        $this->p_jrn=$http->request('p_jrn',"number");
        $this->jrn_type=$http->post('jrn_type');
            $this->name=$http->post('opd_name');
 
        $this->description= $http->post('od_description');
        if ( $this->name=="")
        {
            $n=$this->db->get_next_seq('op_def_op_seq');
            $this->name=$this->jrn_type.$n;
 
        }
 
        // get also info for the details
        // common value
        $this->detail=Pre_operation_detail::build_detail($this->jrn_type,$this->db);
        $this->detail->get_post();
    }

References $http, Pre_operation_detail\build_detail(), db, and name.

Here is the call graph for this function:

◆ load()

Pre_operation::load ( )

load the data from the database and return an array

Returns: an double array containing all the data from database

Definition at line 185 of file pre_operation.class.php.

                   :array
    {
        $this->isloaded=true;
        //------------------------------------------
        // if new , then od_id == 0 and we need to use blank()
        //------------------------------------------
        if ($this->od_id == -1 ) {
            $array=$this->blank($this->p_jrn);
            return  $array;
        }
        $sql="select od_id,jrn_def_id,od_name,od_item,od_jrn_type,od_description".
             " from op_predef where od_id=$1 ".
             " order by od_name";
        $res=$this->db->exec_sql($sql,[$this->od_id]);
        $array=Database::fetch_all($res);
        foreach (array('jrn_def_id','od_name','od_item','od_jrn_type','od_description') as $field) {
            $this->$field=$array[0][$field];
        }
        $this->detail = Pre_operation_detail::build_detail($this->od_jrn_type, $this->db);
        $array+=$this->detail->load($this->od_id);
        return $array;
    }

References $array, $res, $sql, blank(), Pre_operation_detail\build_detail(), db, and DatabaseCore\fetch_all().

Referenced by compute_array().

Here is the call graph for this function:

◆ save()

Pre_operation::save ( )

Definition at line 122 of file pre_operation.class.php.

    {
        if ($this->od_id  < 1) {
            $this->save_insert();
        } else {
            $this->save_update();
        }
 
    }

References save_insert(), and save_update().

Here is the call graph for this function:

◆ save_insert()

Pre_operation::save_insert ( )

save the predef check first is the name is unique

Returns: true op.success otherwise false

Definition at line 143 of file pre_operation.class.php.

    {
 
        if (    $this->db->count_sql("select * from op_predef ".
                                  "where upper(od_name)=upper('".Database::escape_string($this->name)."')".
                                  "and jrn_def_id=".$this->p_jrn." and od_id <> ".$this->od_id)
                != 0 )
        {
            $this->name="copy_".$this->name."_".microtime(true);
        }
        if ( $this->count()  > MAX_PREDEFINED_OPERATION )
        {
            echo '<span class="notice">'.("Vous avez atteint le max. d'opération prédéfinie, désolé").'</span>';
            return false;
        }
        try {
            $this->db->start();
            $sql='insert into op_predef (jrn_def_id,od_name,od_item,od_jrn_type,od_direct,od_description) '.
                ' values '.
                "($1,$2,$3,$4,$5  ,$6)".
                'returning od_id';
            $this->od_id= $this->db->get_value($sql,array($this->p_jrn,
                $this->name,
                $this->nb_item,
                $this->jrn_type,
                $this->od_direct,
                $this->description,
            ));
 
 
            $this->detail->save($this->od_id,$this->nb_item);
            $this->db->commit();
        } catch (Exception $e) {
            record_log("PROP139.Failed save predefined operation ");
            $this->db->rollback();
        }
 
        return true;
    }

References $e, $sql, count(), db, MAX_PREDEFINED_OPERATION, name, and record_log().

Referenced by save().

Here is the call graph for this function:

◆ save_propose()

static Pre_operation::save_propose ( )

static

Propose to save the operation into a predefined operation.

Returns: HTML string

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

                                   {
        $r="";
        $r.= '<p class="decale">';
        $r.= _("Donnez un nom pour sauver cette opération comme modèle")." <br>";
        $opd_name = new IText('opd_name');
        $r.=_( "Nom du modèle " ) . $opd_name->input();
        $opd_description=new ITextarea('od_description');
        $opd_description->style=' class="itextarea" style="width:30em;height:4em;vertical-align:top"';
        $r.='</p>';
        $r.= '<p class="decale">';
        $r.= _('Description (max 50 car.)');   
        $r.='<br>';
        $r.=$opd_description->input();
        $r.='</p>';
        return $r;
    }

References $opd_description, and $r.

◆ save_update()

Pre_operation::save_update ( )

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

    {
        $sql = "update op_predef set jrn_def_id = $1 , od_name = $2 , 
                        od_item =$3, od_description = $4 where od_id=$5";
        $this->db->exec_sql($sql,array($this->p_jrn,$this->name,$this->nb_item,$this->description,$this->od_id));
        // delete detail&
        $this->db->exec_sql("delete from op_predef_detail where od_id = $1",array($this->od_id));
        $this->detail->save($this->od_id,$this->nb_item);
    }

References $sql, db, and name.

Referenced by save().

◆ set_db()

Pre_operation::set_db ( $db )

Parameters

mixed $db

Definition at line 376 of file pre_operation.class.php.

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

References $db, and db.

◆ set_description()

Pre_operation::set_description ( $description )

Parameters

string $description

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

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

References $description.

◆ set_detail()

Pre_operation::set_detail ( Pre_operation_detail $detail )

Parameters

array $detail

Definition at line 449 of file pre_operation.class.php.

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

References $detail.

◆ set_jrn_type()

Pre_operation::set_jrn_type ( $jrn_type )

Parameters

string $jrn_type

Definition at line 411 of file pre_operation.class.php.

    {
        $jrn_type=strtoupper($jrn_type);
        if ( ! in_array ($jrn_type,['ACH','FIN','VEN','ODS'] )) throw new Exception('prop03.invalid ledger type');
        $this->jrn_type = $jrn_type;
        return $this;
    }

References $jrn_type.

◆ set_name()

Pre_operation::set_name ( $name )

Parameters

string $name

Definition at line 431 of file pre_operation.class.php.

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

References $name, and name.

◆ set_nb_item()

Pre_operation::set_nb_item ( $nb_item )

Parameters

mixed $nb_item

Definition at line 394 of file pre_operation.class.php.

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

References $nb_item.

◆ set_od_direct()

Pre_operation::set_od_direct ( $od_direct )

Parameters

string $od_direct

Definition at line 467 of file pre_operation.class.php.

    {
        if ( !   in_array($od_direct,['f','t']))  throw new Exception('prop02.invalid od_direct');
        $this->od_direct = $od_direct;
        return $this;
    }

References $od_direct.

◆ set_od_id()

Pre_operation::set_od_id ( $od_id )

Parameters

int | mixed $od_id

Definition at line 485 of file pre_operation.class.php.

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

References $od_id.

◆ set_p_jrn()

Pre_operation::set_p_jrn ( $p_jrn )

set the ledger

Parameters

$p_jrn is the ledger (jrn_id)

Definition at line 495 of file pre_operation.class.php.

    {
        $this->p_jrn=$p_jrn;
        $this->jrn_type=$this->db->get_value("select jrn_def_type from jrn_def where jrn_def_id=$1",[$p_jrn]);
        return $this;
    }

References $p_jrn, and db.

◆ show_button_deprecated()

Pre_operation::show_button_deprecated ( )

show the button for selecting a predefined operation

Deprecated:

Definition at line 252 of file pre_operation.class.php.

    {
 
        $select=new ISelect();
        $value=$this->db->make_array("select od_id,od_name from op_predef ".
                                     " where jrn_def_id=".$this->p_jrn.
                                     " and od_direct ='".$this->od_direct."'".
                                     " order by od_name");
 
        if ( empty($value)==true) return "";
        $select->value=$value;
        $r=$select->input("pre_def");
 
        return $r;
    }

References $r, $select, $value, and db.

Field Documentation

◆ $db

Pre_operation::$db

private

$db database connection

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

Referenced by get_db(), and set_db().

◆ $description

Pre_operation::$description

private

description of the predefined operation

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

Referenced by get_description(), and set_description().

◆ $detail

Pre_operation::$detail

private

Pre_operation_detail object

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

Referenced by get_detail(), and set_detail().

◆ $isloaded

Pre_operation::$isloaded

private

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

◆ $jrn_type

Pre_operation::$jrn_type

private

$jrn_type

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

Referenced by get_jrn_type(), and set_jrn_type().

◆ $name

Pre_operation::$name

private

$name name of the predef. operation

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

Referenced by get_name(), and set_name().

◆ $nb_item

Pre_operation::$nb_item

private

$nb_item nb of item

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

Referenced by get_nb_item(), and set_nb_item().

◆ $od_direct

Pre_operation::$od_direct

Compatibility for ACH in direct mode, only for ODS

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

Referenced by get_od_direct(), and set_od_direct().

◆ $od_id

Pre_operation::$od_id

private

id of the Predefined Operation

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

Referenced by get_od_id(), and set_od_id().

◆ $p_jrn

Pre_operation::$p_jrn

private

$p_jrn jrn_def_id

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

Referenced by set_p_jrn().

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

include/class/pre_operation.class.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ blank()

◆ choose_ledger()

◆ compute_array()

◆ count()

◆ delete()

◆ display()

◆ display_list_operation()

◆ form_get()

◆ get_db()

◆ get_description()

◆ get_detail()

◆ get_jrn_type()

◆ get_list_ledger()

◆ get_name()

◆ get_nb_item()

◆ get_od_direct()

◆ get_od_id()

◆ get_operation()

◆ get_post()

◆ load()

◆ save()

◆ save_insert()

◆ save_propose()

◆ save_update()

◆ set_db()

◆ set_description()

◆ set_detail()

◆ set_jrn_type()

◆ set_name()

◆ set_nb_item()

◆ set_od_direct()

◆ set_od_id()

◆ set_p_jrn()

◆ show_button_deprecated()

Field Documentation

◆ $db

◆ $description

◆ $detail

◆ $isloaded

◆ $jrn_type

◆ $name

◆ $nb_item

◆ $od_direct

◆ $od_id

◆ $p_jrn