Acc_Compute Class Reference

this class aims to compute different amount More...

Collaboration diagram for Acc_Compute:

Public Member Functions
	__construct ()
	compute_nd ()
	Compute the no deductible part of the amount, it reduce also the vat. More...
	compute_nd_vat ()
	compute_ndded_vat ()
	compute_perso ()
	compute_vat ()
	convert_euro ()
	convert_euro_vat ()
	correct ()
	display ()
	get_info ()
	get_parameter ($p_string)
	set_parameter ($p_string, $p_value)
	verify ($p_obj=null)
	! More...

Static Public Member Functions
static	test_me ()

Data Fields
	$check

Private Attributes
	$order

Static Private Attributes
static	$variable

Detailed Description

this class aims to compute different amount

This class compute without decimal error the following amount

• vat
• amount without vat
• no deductible vat
• personal part
• no deductible amount Nothing won't be saved to the database, this class will just compute and complete the object if you need to compute the vat and in another place all the details you'll have to use the clone function private static $variable=array( 'amount'=>'amount', 'amount_vat'=>'amount_vat', 'amount_vat_rate'=>'amount_vat_rate', 'nd_vat'=>'nd_vat', 'nd_vat_rate'=>'nd_vat_rate', 'nd_ded_vat'=>'nd_ded_vat', 'nd_ded_vat_rate'=>'nd_ded_vat_rate', 'amount_nd'=>'amount_nd', 'amount_nd_rate'=>'amount_nd_rate', 'nd_vat_rate'=>'nd_vat_rate', 'amount_perso'=>'amount_perso', 'amount_perso_rate'=>'amount_perso_rate' );

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

Constructor & Destructor Documentation

__construct()

Acc_Compute::__construct

(

)

Definition at line 81 of file acc_compute.class.php.

    {
        bcscale(4);
        foreach (self::$variable as $key=>$value)       $this->$key=0;
        $this->order=0;
        $this->check=true;
    }

References $value, and $variable.

Member Function Documentation

compute_nd()

Acc_Compute::compute_nd

(

)

Compute the no deductible part of the amount, it reduce also the vat.

Definition at line 138 of file acc_compute.class.php.

    {
        if ( $this->check && $this->order > 2 )  throw new Exception ('ORDER NOT RESPECTED');
 
        $this->amount_nd=bcmul($this->amount,$this->amount_nd_rate);
        $this->amount_nd=bcdiv($this->amount_nd,100);
        $this->amount_nd=round($this->amount_nd,2);
        // the nd part for the vat
        $nd_vat=bcmul($this->amount_vat,$this->amount_nd_rate);
        $nd_vat=bcdiv($nd_vat,100);
        $nd_vat=round($nd_vat,2);
 
    }

Referenced by Acc_Ledger_Purchase\compute_no_deductible().

compute_nd_vat()

Acc_Compute::compute_nd_vat

(

)

Definition at line 151 of file acc_compute.class.php.

    {
        if ( $this->check && $this->order > 3 ) throw new Exception ('ORDER NOT RESPECTED');
        $this->order=4;
 
        if ($this->amount_vat == 0 ) $this->compute_vat();
        $this->nd_vat=bcmul($this->amount_vat,$this->nd_vat_rate);
        $this->nd_vat=bcdiv($this->nd_vat,100);
        $this->nd_vat=round($this->nd_vat,2);
    }

References compute_vat().

Referenced by Acc_Ledger_Purchase\compute_no_deductible().

Here is the call graph for this function:

compute_ndded_vat()

Acc_Compute::compute_ndded_vat

(

)

Definition at line 162 of file acc_compute.class.php.

    {
        if ( $this->check && $this->order > 4 ) throw new Exception ('ORDER NOT RESPECTED');
        $this->order=5;
 
        if ($this->amount_vat == 0 ) $this->compute_vat();
        $this->nd_ded_vat=bcmul($this->amount_vat,$this->nd_ded_vat_rate);
        $this->nd_ded_vat=bcdiv($this->nd_ded_vat,100);
        $this->nd_ded_vat=round($this->nd_ded_vat,2);
    }

References compute_vat().

Referenced by Acc_Ledger_Purchase\compute_no_deductible().

Here is the call graph for this function:

compute_perso()

Acc_Compute::compute_perso

(

)

Definition at line 173 of file acc_compute.class.php.

    {
        if ( $this->check && $this->order != 1 ) throw new Exception ('ORDER NOT RESPECTED');
        $this->order=2;
        if ( $this->amount == 0 ) return;
        $this->amount_perso=bcmul($this->amount,$this->amount_perso_rate);
        $this->amount_perso=bcdiv($this->amount_perso,100);
        $this->amount_perso=round($this->amount_perso,2);
 
 
 
    }

Referenced by Acc_Ledger_Purchase\compute_no_deductible().

compute_vat()

Acc_Compute::compute_vat

(

)

Definition at line 127 of file acc_compute.class.php.

    {
        if ( $this->check && $this->order != 0 ) throw new Exception ('ORDER NOT RESPECTED');
        $this->amount_vat=bcmul($this->amount,$this->amount_vat_rate);
        $this->amount_vat=round($this->amount_vat,2);
        $this->amount_vat_currency=bcmul($this->amount_vat,$this->currency_rate);
        $this->order=1;
    }

Referenced by compute_nd_vat(), and compute_ndded_vat().

convert_euro()

Acc_Compute::convert_euro

(

)

Definition at line 89 of file acc_compute.class.php.

    {
        $local_amount=$this->amount;
        $this->amount=bcdiv($this->amount,$this->currency_rate,6);
        $this->amount_currency=$local_amount;
    }

References $amount.

convert_euro_vat()

Acc_Compute::convert_euro_vat

(

)

Definition at line 95 of file acc_compute.class.php.

    {
        $local_amount=$this->amount_vat;
        $this->amount_vat=bcdiv($this->amount_vat,$this->currency_rate,6);
        $this->amount_vat_currency=$local_amount;
    }

correct()

Acc_Compute::correct

(

)

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

    {
        $this->amount=bcsub($this->amount,$this->amount_perso);
        // correct the others amount
        $this->amount=bcsub($this->amount,$this->amount_nd);
        $this->amount_vat=bcsub($this->amount_vat,$this->nd_ded_vat);
        $this->amount_vat=round($this->amount_vat,2);
        $this->amount_vat=bcsub($this->amount_vat,$this->nd_vat);
        $this->amount_vat=round($this->amount_vat,2);
 
    }

display()

Acc_Compute::display

(

)

Definition at line 224 of file acc_compute.class.php.

    {
        foreach (self::$variable as $key=>$value)
        {
            echo 'key '.$key.' Description '.$value.' value is '.$this->$key.'<br>';
        }
    }

References $value, and $variable.

get_info()

Acc_Compute::get_info

(

)

Definition at line 123 of file acc_compute.class.php.

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

References $variable.

get_parameter()

Acc_Compute::get_parameter

(

$p_string

)

Definition at line 101 of file acc_compute.class.php.

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

References $idx, and $variable.

set_parameter()

Acc_Compute::set_parameter	(		$p_string,
			$p_value
	)

Definition at line 111 of file acc_compute.class.php.

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

References $idx, and $variable.

test_me()

static Acc_Compute::test_me ( )

static

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

    {
        $a=new Acc_Compute();
        echo $a->get_info();
        echo '<hr>';
 
        // Compute some operation to see if the computed amount are
        // correct
 
        //Test VAT
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
 
        echo '<h1> Test VAT </h1>';
        echo '<h2> Data </h2>';
        $a->display();
 
        echo '<h2> Result </h2>';
        $a->compute_vat();
        $a->display();
        $a->verify();
        // Test VAT + perso
        $a=new Acc_Compute();
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
        $a->set_parameter('amount_perso_rate',0.5);
        echo '<h1> Test VAT + Perso</h1>';
        echo '<h2> Data </h2>';
        $a->display();
        $b=clone $a;
        $a->compute_vat();
        $a->compute_perso();
        $a->correct();
        echo '<h2> Result </h2>';
        $a->display();
        $a->verify($b);
        // TEST VAT + ND
        // Test VAT + perso
        $a=new Acc_Compute();
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
        $a->set_parameter('nd_vat_rate',0.5);
        $b=clone $a;
        echo '<h1> Test VAT + ND VAT</h1>';
        echo '<h2> Data </h2>';
        $a->display();
        $a->compute_vat();
        $a->compute_nd_vat();
        $a->correct();
        echo '<h2> Result </h2>';
        $a->display();
        $a->verify($b);
        // TEST VAT + ND
        // Test VAT + perso
        $a=new Acc_Compute();
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
        $a->set_parameter('nd_vat_rate',0.5);
        $a->set_parameter('amount_perso_rate',0.5);
 
        $b=clone $a;
        echo '<h1> Test VAT + ND VAT + perso</h1>';
        echo '<h2> Data </h2>';
        $a->display();
        $a->compute_vat();
        $a->compute_perso();
        $a->compute_nd_vat();
        $a->correct();
        echo '<h2> Result </h2>';
        $a->display();
        $a->verify($b);
        // TEST VAT + ND
        $a=new Acc_Compute();
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
        $a->set_parameter('amount_nd_rate',0.5);
 
        $b=clone $a;
        echo '<h1> Test VAT + ND </h1>';
        echo '<h2> Data </h2>';
        $a->display();
        $a->compute_vat();
        $a->compute_nd();
 
        $a->compute_perso();
        $a->compute_nd_vat();
        $a->correct();
        echo '<h2> Result </h2>';
        $a->display();
        $a->verify($b);
        // TEST VAT + ND
        // + Perso
        $a=new Acc_Compute();
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
        $a->set_parameter('amount_nd_rate',0.5);
        $a->set_parameter('amount_perso_rate',0.2857);
        $b=clone $a;
        echo '<h1> Test VAT + ND  + Perso</h1>';
        echo '<h2> Data </h2>';
        $a->display();
        $a->compute_vat();
        $a->compute_nd();
 
        $a->compute_perso();
        $a->compute_nd_vat();
        $a->correct();
        echo '<h2> Result </h2>';
        $a->display();
        $a->verify($b);
// TEST VAT + ND
        // + Perso
        $a=new Acc_Compute();
        $a->set_parameter('amount',1.23);
        $a->set_parameter('amount_vat_rate',0.21);
        $a->set_parameter('nd_ded_vat_rate',0.5);
 
        $b=clone $a;
        echo '<h1> Test VAT   +  TVA ND DED</h1>';
        echo '<h2> Data </h2>';
        $a->display();
        $a->compute_vat();
        $a->compute_nd();
 
        $a->compute_perso();
        $a->compute_nd_vat();
        $a->compute_ndded_vat();
        $a->correct();
        echo '<h2> Result </h2>';
        $a->display();
        $a->verify($b);
 
 
    }

References $a, and $b.

verify()

Acc_Compute::verify

(

$p_obj = null

)

!

verify that all the amount are positive or null otherwise throw a exception and the sum of amount + vat must equal to the sum of all the amount of the current object so you have to copy the object before computing anything and pass it as parameter

Parameters

compare

with a object copied before computing, if null there is no comparison

Definition at line 206 of file acc_compute.class.php.

    {
        foreach (self::$variable as $key=>$value)
        if ( $this->$value < 0 )
            throw new Exception (_("Montant invalide"));
 
        if ( $p_obj != null )
        {
            $sum=0;
            foreach ( array( 'amount','amount_vat','amount_nd','nd_vat','amount_perso','nd_ded_vat') as $value)
            $sum=bcadd($sum,$this->$value);
            if ( $p_obj->amount_vat == 0 ) $p_obj->compute_vat();
            $cmp=bcadd($p_obj->amount,$p_obj->amount_vat);
            $diff=bcsub($sum,$cmp);
            if ( $diff != 0.0 )
                throw new Exception (_("ECHEC VERIFICATION  : valeur totale = $sum valeur attendue = $cmp diff = $diff"));
        }
    }

References $diff, $value, and $variable.

Field Documentation

$check

Acc_Compute::$check

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

$order

Acc_Compute::$order

private

Definition at line 74 of file acc_compute.class.php.

$variable

Acc_Compute::$variable

staticprivate

Initial value:

=array( 'amount'=>'amount',
                                    'amount_vat'=>'amount_vat',
                                    'amount_vat_rate'=>'amount_vat_rate',
                                    'nd_vat'=>'nd_vat',
                                    'nd_vat_rate'=>'nd_vat_rate',
                                    'nd_ded_vat'=>'nd_ded_vat',
                                    'nd_ded_vat_rate'=>'nd_ded_vat_rate',
                                    'amount_nd'=>'amount_nd',
                                    'amount_nd_rate'=>'amount_nd_rate',
                                    'nd_vat_rate'=>'nd_vat_rate',
                                    'amount_perso'=>'amount_perso',
                                    'amount_perso_rate'=>'amount_perso_rate',
                                    'amount_currency'=>'amount_currency',
                                    'amount_vat_currency'=>'amount_vat_currency',
                                    'currency_rate'=>'currency_rate'
                                  )

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

---

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

• include/class/acc_compute.class.php