Follow_Up Details are the details for an actions, it means the details of an order, delivery order, submit a quote... this class is linked to the table action_detail. More...

Collaboration diagram for Follow_Up_Detail:

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

	delete ()

	from_array ($array, $idx)
	Fill an Action_Detail Object with the data contained in an array.

	get_info ()

	get_parameter ($p_string)

	insert ()

	load ()
	load the todo_list row thanks it's ID

	load_all ()
	retrieve all the details of an Follow_Up

	save ()

	set_parameter ($p_string, $p_value)

	update ()

	verify ()

Static Public Member Functions
static	display (Follow_Up $p_follow_up, $p_view)

Data Fields
	$ad_id

	$ag_id

	$db

Static Private Attributes
static	$variable

Detailed Description

Follow_Up Details are the details for an actions, it means the details of an order, delivery order, submit a quote... this class is linked to the table action_detail.

"id"=>"ad_id", primary key
"qcode"=>"f_id", quick_code
"text"=>"ad_text", description lines
"price_unit"=>"ad_pu", price by unit
"quantity"=>"ad_quant", quantity
"tva_id"=>"ad_tva_id", tva_od
"tva_amount"=>"ad_tva_amount", vat amount
"total"=>"ad_total_amount", total amount including vat
"ag_id"=>"ag_id" => foreign key to action_gestion
db is the database connection

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

Constructor & Destructor Documentation

◆ __construct()

Follow_Up_Detail::__construct	(		$p_cn,
			$p_id = 0 )

Definition at line 55 of file follow_up_detail.class.php.

    {
        $this->db=$p_cn;
        $this->ad_id=$p_id;
    }

References $p_id, and db.

Member Function Documentation

◆ delete()

Follow_Up_Detail::delete ( )

Definition at line 192 of file follow_up_detail.class.php.

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

References $sql, and db.

◆ display()

static Follow_Up_Detail::display	(	Follow_Up	$p_follow_up,
			$p_view )

static

Definition at line 241 of file follow_up_detail.class.php.

    {
        $option=$p_follow_up->db->get_value("select do_option from document_option "
                . "  where document_type_id=$1 and do_code='detail_operation'",[$p_follow_up->dt_id]);
        
         require NOALYSS_TEMPLATE."/follow_up_detail_display.php";
    }

◆ from_array()

Follow_Up_Detail::from_array	(		$array,
			$idx )

Fill an Action_Detail Object with the data contained in an array.

Parameters

$array	[ad_id7] => ad_id [e_march7] => f_id [e_march7_label] => ad_text [e_march7_price] => ad_pu [e_quant7] => ad_quant [e_march7_tva_id] => ad_tva_id [e_march7_tva_amount] => ad_tva_amount [tvac_march7] => ad_total_amount [ag_id] => ag_id
$idx	is the idx (example 7)

Note

Definition at line 210 of file follow_up_detail.class.php.

    {
        $row=$array;
        $this->ad_id=(isset($row['ad_id'.$idx]))?$row['ad_id'.$idx]:0;
 
        $qcode=(isset($row['e_march'.$idx]))?$row['e_march'.$idx]:"";
        if (trim($qcode)=='')
        {
            $this->f_id=0;
        }
        else
        {
            $tmp=new Fiche($this->db);
            $tmp->get_by_qcode($qcode,false);
            $this->f_id=$tmp->id;
        }
        $this->ad_text=(isset($row['e_march'.$idx.'_label']))?$row['e_march'.$idx.'_label']:"";
        $this->ad_pu=(isset($row['e_march'.$idx.'_price']))?$row['e_march'.$idx.'_price']:0;
        $this->ad_quant=(isset($row['e_quant'.$idx]))?$row['e_quant'.$idx]:0;
        $this->ad_tva_id=(isset($row['e_march'.$idx.'_tva_id']))?$row['e_march'.$idx.'_tva_id']:0;
        $this->ad_tva_amount=(isset($row['e_march'.$idx.'_tva_amount']))?$row['e_march'.$idx.'_tva_amount']:0;
        $this->ad_total_amount=(isset($row['tvac_march'.$idx]))?$row['tvac_march'.$idx]:0;
        $this->ag_id=(isset($array['ag_id']))?$array['ag_id']:0;
        /* protect numeric */
        if (trim($this->ad_pu)=="" || isNumber($this->ad_pu)==0) $this->ad_pu=0;
        if (trim($this->ad_quant)=="" || isNumber($this->ad_quant)==0) $this->ad_quant=0;
        if (trim($this->ad_tva_amount)==""||isNumber($this->ad_tva_amount)==0) $this->ad_tva_amount=0;
        if (trim($this->ad_total_amount)==""||isNumber($this->ad_total_amount)==0) $this->ad_total_amount=0;
        if (trim($this->ad_tva_id)=="" || isNumber($this->ad_tva_id)==0) $this->ad_tva_id=0;
    }

References $array, $idx, $qcode, $row, $tmp, ag_id, db, and isNumber().

Here is the call graph for this function:

◆ get_info()

Follow_Up_Detail::get_info ( )

Definition at line 82 of file follow_up_detail.class.php.

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

◆ get_parameter()

Follow_Up_Detail::get_parameter ( $p_string )

Definition at line 60 of file follow_up_detail.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.

◆ insert()

Follow_Up_Detail::insert ( )

Definition at line 99 of file follow_up_detail.class.php.

    {
        if ( $this->verify() != 0 ) return;
        $sql='INSERT INTO action_detail('.
             ' f_id, ad_text, ad_pu, ad_quant, ad_tva_id, ad_tva_amount,'.
             '   ad_total_amount, ag_id)'.
             ' VALUES ($1, $2, $3, $4,$5,$6,$7,$8) returning ad_id';
        $this->ad_id=$this->db->get_value($sql,array(
                                              $this->f_id,
                                              $this->ad_text,
                                              $this->ad_pu,
                                              $this->ad_quant,
                                              $this->ad_tva_id,
                                              $this->ad_tva_amount,
                                              $this->ad_total_amount,
                                              $this->ag_id
                                          )
                                         );
 
    }

References $sql, ag_id, db, and verify().

Referenced by save().

Here is the call graph for this function:

◆ load()

Follow_Up_Detail::load ( )

load the todo_list row thanks it's ID

Returns: boolean true if found else false

Definition at line 174 of file follow_up_detail.class.php.

                          :bool
    {
        $sql="SELECT ad_id, f_id, ad_text, ad_pu, ad_quant, ad_tva_id, ad_tva_amount,
             ad_total_amount, ag_id   FROM action_detail".
             " where ad_id=$1";
 
        $res=$this->db->get_array(
                                  $sql,
                                  array($this->ad_id)
                                 );
        if ( $this->db->count() == 0 ) return false;
        $row=$res[0];
        foreach (self::$variable as $idx)
        {
            $this->$idx=$row[$idx];
        }
        return true;
    }

References $idx, $res, $row, $sql, and db.

◆ load_all()

Follow_Up_Detail::load_all ( )

retrieve all the details of an Follow_Up

Returns: array of Action_Detail

See also: Follow_Up\get

Definition at line 147 of file follow_up_detail.class.php.

    {
        $sql="SELECT ad_id, f_id, ad_text, ad_pu, ad_quant, ad_tva_id, ad_tva_amount,
             ad_total_amount, ag_id   FROM action_detail ".
             " where ag_id=$1 order by ad_id";
        $res=$this->db->get_array(
                 $sql,
                 array($this->ag_id)
             );
        if ( $this->db->count() == 0 ) return array();
        $aRet=array();
        for($i=0;$i<count($res);$i++)
        {
            $a=new Follow_Up_Detail($this->db);
            $row=$res[$i];
            foreach ($row as $idx=>$value)
            {
                $a->$idx=$value;
            }
            $aRet[$i]=clone $a;
        }
        return $aRet;
    }

References $a, $i, $idx, $res, $row, $sql, $value, ag_id, and db.

◆ save()

Follow_Up_Detail::save ( )

Definition at line 91 of file follow_up_detail.class.php.

    {
        if (  $this->ad_id == 0 )
            $this->insert();
        else
            $this->update();
    }

References insert(), and update().

Here is the call graph for this function:

◆ set_parameter()

Follow_Up_Detail::set_parameter	(		$p_string,
			$p_value )

Definition at line 70 of file follow_up_detail.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.

◆ update()

Follow_Up_Detail::update ( )

Definition at line 120 of file follow_up_detail.class.php.

    {
        if ( $this->verify() != 0 ) return;
 
        $sql='UPDATE action_detail '.
             ' SET f_id=$1, ad_text=$2, ad_pu=$3, ad_quant=$4, ad_tva_id=$5,'.
             '     ad_tva_amount=$6, ad_total_amount=$7, ag_id=$8'.
             ' WHERE ad_id=$9';
        $this->id=$this->db->exec_sql($sql,array(
                                          $this->f_id,
                                          $this->ad_text,
                                          $this->ad_pu,
                                          $this->ad_quant,
                                          $this->ad_tva_id,
                                          $this->ad_tva_amount,
                                          $this->ad_total_amount,
                                          $this->ag_id,
                                          $this->ad_id
                                      )
                                     );
 
 
    }

References $sql, ag_id, db, and verify().

Referenced by save().

Here is the call graph for this function:

◆ verify()

Follow_Up_Detail::verify ( )

Definition at line 86 of file follow_up_detail.class.php.

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

Referenced by insert(), and update().

Field Documentation

◆ $ad_id

Follow_Up_Detail::$ad_id

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

◆ $ag_id

Follow_Up_Detail::$ag_id

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

◆ $db

Follow_Up_Detail::$db

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

◆ $variable

Follow_Up_Detail::$variable

staticprivate

Initial value:

=array(
                                 "id"=>"ad_id",
                                 "qcode"=>"f_id",
                                 "text"=>"ad_text",
                                 "price_unit"=>"ad_pu",
                                 "quantity"=>"ad_quant",
                                 "tva_id"=>"ad_tva_id",
                                 "tva_amount"=>"ad_tva_amount",
                                 "total"=>"ad_total_amount",
                                 "ag_id"=>"ag_id"
                             )

Definition at line 43 of file follow_up_detail.class.php.

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

include/class/follow_up_detail.class.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ display()

◆ from_array()

◆ get_info()

◆ get_parameter()

◆ insert()

◆ load()

◆ load_all()

◆ save()

◆ set_parameter()

◆ update()

◆ verify()

Field Documentation

◆ $ad_id

◆ $ag_id

◆ $db

◆ $variable