Anc_Key Class Reference

Class to manage distribution keys for Analytic accountancy. More...

Collaboration diagram for Anc_Key:

Public Member Functions
	__construct ($p_id=-1)
	delete ()
	delete the distribution key
	fill_table ($p_target, $p_amount)
	Call the Anc_Operation\display_form_plan with the right amounts.
	get_key ()
	input ()
	Show the detail for a key distribution and let you change it for adding or update.
	save ($p_array)
	save the data of a repartition key.
	set_key ($key)
	verify ($p_array)
	verify that data are ok

Static Public Member Functions
static	display_choice ($p_amount, $p_target, $p_ledger)
	display list of available keys
static	display_list ()
	display a list of keys, choose one to modify it
static	key_add ()
	show a form for adding a key + button to display it
static	key_available ($p_jrn)
	Return the number of keys available.

Protected Attributes
	$a_activity
	$a_ledger
	$a_row

Private Attributes
	$key

Detailed Description

Class to manage distribution keys for Analytic accountancy.

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

Constructor & Destructor Documentation

__construct()

Anc_Key::__construct

(

$p_id = -1

)

Definition at line 67 of file anc_key.class.php.

    {
        global $cn;
        $this->key=new Anc_Key_SQL($cn, $p_id);
        $this->a_ledger=null;
        $this->a_activity=null;
        $this->a_row=null;
    }

References $cn, and $p_id.

Member Function Documentation

delete()

Anc_Key::delete

(

)

delete the distribution key

Definition at line 397 of file anc_key.class.php.

    {
        $this->key->delete();
    }

display_choice()

static Anc_Key::display_choice ( $p_amount, $p_target, $p_ledger )

static

display list of available keys

Parameters

$p_amount	amount to distribute
$p_target	target to update
$p_ledger	is the jrn_def_id

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

    {
        global $cn;
        $a_key=$cn->get_array(' select kd_id,
                kd_name,
                kd_description
                from
                key_distribution
                join key_distribution_ledger using (kd_id)
                where
                jrn_def_id=$1',
                array(
                    $p_ledger
                ));
        if (empty($a_key))
        {
            echo _('Aucune clef disponible');
            echo _('Allez dans ANCKEY pour en ajouter pour ce journal');
        }
        include NOALYSS_TEMPLATE.'/anc_key_display_choice.php';
    }

References $cn, and _.

display_list()

static Anc_Key::display_list ( )

static

display a list of keys, choose one to modify it

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

    {
        global $cn;
        $a_key=$cn->get_array('select b.kd_id,b.kd_name,b.kd_description,
                (select sum(ke_percent) from key_distribution_detail as a where a.kd_id=b.kd_id) as distrib 
                from key_distribution as b order by b.kd_name');
        if (empty($a_key))
        {
            echo _('Aucune clef disponible');
        }
        include NOALYSS_TEMPLATE.'/anc_key_display_list.php';
    }

References $cn, and _.

fill_table()

Anc_Key::fill_table	(		$p_target,
			$p_amount )

Call the Anc_Operation\display_form_plan with the right amounts.

This function compute the array and amount to pass to the Anc_Operation\display_form_plan and replace the current table of activity with the value computed from the key.

@global $cn database connection

Parameters

$p_target	Table to be replaced
$p_amount	amount to distribute among activities

Definition at line 318 of file anc_key.class.php.

    {
        global $cn;
        /* number is the index of the plan, he's computed from p_target */
        $number=preg_replace('/det[0-9]*/', '', $p_target);
        $number=noalyss_str_replace('t', '', $number);
        $number=noalyss_str_replace('popup', '', $number);
        
        $op[$number]=$p_amount;
        $array['op']=$op;
        $a_plan=$cn->get_array('select pa_id from plan_analytique order by pa_id');
        for ($i=0;$i < count($a_plan);$i++)
        {
            $array['pa_id'][$i]=$a_plan[$i]['pa_id'];
        }
        
        $a_poste=$cn->get_array('select po_id,ke_percent,pa_id,ke_row
                 from key_distribution_activity 
                 join key_distribution_detail using (ke_id)  
                 where
                 kd_id=$1
                 order by ke_row,pa_id',
                 array($this->key->getp('id')));
 
        for ($i=0;$i< count($a_poste);$i++)
        {
            $hplan[$number][$i]=($a_poste[$i]['po_id']==null)?-1:$a_poste[$i]['po_id'];
        }
        $array['hplan']=$hplan;
        
         $a_amount=$cn->get_array("select distinct ke_row,ke_percent 
                 from key_distribution_activity 
                 join key_distribution_detail using (ke_id) 
                 where
                    kd_id=$1
                    and pa_id=$2
                 order by ke_row",
                 array($this->key->getp('id'),$a_plan[0]['pa_id']));
         bcscale(2);
        for ($i=0;$i< count($a_amount);$i++)
        {
            $val[$number][$i]=bcmul($p_amount,$a_amount[$i]['ke_percent']);
            $val[$number][$i]=bcdiv($val[$number][$i],100);
            $val[$number][$i]=abs($val[$number][$i]);
        }
        $array['val']=$val;
               
        $anc_operation=new Anc_Operation($cn);
        // find the div thanks the target which looks like "det4t0"
        // det4 is the div id and t0 is the row
        if (strpos($p_target, "et")){
            // cut off t[0-9]
            $pos=strrpos($p_target,"t");
            $anc_operation->in_div=substr($p_target,0,$pos);
            
        }
        echo $anc_operation->display_form_plan($array, 1, 1, $number, $p_amount,'',false);
        
    }

References $a_plan, $a_poste, $array, $cn, $i, $op, $pos, and noalyss_str_replace().

Here is the call graph for this function:

get_key()

Anc_Key::get_key

(

)

Definition at line 75 of file anc_key.class.php.

    {
        return $this->key;
    }

References $key.

input()

Anc_Key::input

(

)

Show the detail for a key distribution and let you change it for adding or update.

Definition at line 135 of file anc_key.class.php.

    {
        global $cn;
 
        $plan=$cn->get_array('
     select 
     pa_id,
     pa_name , 
     pa_description 
     from 
       plan_analytique 
     order by pa_name');
        $count_max=count($plan);
 
        $a_row=$cn->get_array('select ke_id,ke_row,ke_percent from key_distribution_detail 
         where
         kd_id=$1 order by ke_row', array($this->key->getp('id')));
 
        require_once NOALYSS_TEMPLATE.'/anc_key_input.php';
    }

References $a_row, and $cn.

Referenced by key_add().

key_add()

static Anc_Key::key_add ( )

static

show a form for adding a key + button to display it

Definition at line 381 of file anc_key.class.php.

    {
        $key=new Anc_Key();
        $key->key->setp('name',_('Nouvelle clef'));
        $key->key->setp('description',_('Description de la nouvelle clef'));
        ?>
<input type="button" class="smallbutton" value="<?php echo  _('Ajout')?>" onclick="$('key_add_div_id').show()">
<div id="key_add_div_id" style="display: none">
<?php
        $key->input();
        echo '</div>';
        
    }

References $key, _, input(), style, type, and value.

Here is the call graph for this function:

key_available()

static Anc_Key::key_available ( $p_jrn )

static

Return the number of keys available.

Return the number of keys available for the ledger given in parameter

@global $cn database connection

Parameters

$p_jrn

number of the ledger (jrn_def.jrn_def_id

Returns

number of available keys

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

    {
        global $cn;
        $count=$cn->get_value (' select count(*) 
            from key_distribution_ledger 
            join key_distribution using (kd_id)
            where
            jrn_def_id=$1', array($p_jrn));
        return $count;
    }

References $cn, $count, and $p_jrn.

save()

Anc_Key::save

(

$p_array

)

save the data of a repartition key.

Parameters

received

an array index : key_id : key_distribution.kd_id row : array of key_distribution.ke_id (row pa : array of plan_analytic.pa_id (column) po_id : double array, first index is the row second index is the first plan, the second the second plan...(column) percent array, one per row jrn : array of available ledgers

Note

if po_id == -1 then it is replaced by null, this why the pa_id is needed : to identify the column

  'key_id' => string '1' (length=1)
  "name_key" => "name"
  "description_key" => "description"
  'row' => 
    array
      0 => string '1' (length=1)
      1 => string '2' (length=1)
      2 => string '3' (length=1)
  'pa' => 
    array
      0 => string '1' (length=1)
      1 => string '2' (length=1)
  'po_id' => 
    array
      0 => 
        array
          0 => string '1' (length=1)
          1 => string '8' (length=1)
      1 => 
        array
          0 => string '2' (length=1)
          1 => string '-1' (length=2)
      2 => 
        array
          0 => string '3' (length=1)
          1 => string '8' (length=1)
  'percent' => 
    array
      0 => string '50.0000' (length=7)
      1 => string '20.0000' (length=7)
      2 => string '30.0000' (length=7)
  'jrn' => 
    array
      0 => string '3' (length=1)
      1 => string '2' (length=1)

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

    {
        global $cn;
        $this->verify($p_array);
        $cn->start();
        // for each row
        $http=new HttpInput();
        $http->set_array($p_array);
        
        $a_row=$http->extract('row',"array");
        $a_ledger=$http->extract("jrn","string",array());
        $a_percent=$http->extract('percent',"array",[]);
        $a_po_id=$http->extract('po_id',"array",[]);
        $a_plan=$http->extract('pa',"array",[]);
        try
        {
            $this->key->setp('name',$http->extract('name_key'));
            $this->key->setp('description',$http->extract('description_key'));
            $this->key->save();
            for ($i=0; $i<count($a_row); $i++)
            {
                //save key_distribution_row
                $key_row=new Anc_Key_Detail_SQL($cn);
                $key_row->setp('id', $a_row[$i]);
                $key_row->setp('key', $this->key->getp('id'));
                $key_row->setp('row', $i+1);
                $key_row->setp('percent', $a_percent[$i]);
                $key_row->save();
                //
                // Save each activity + percent
                $cn->exec_sql('delete from key_distribution_activity where ke_id=$1', array($key_row->getp('id')));
 
                // Don't save row with 0 %
                if ($a_percent[$i]==0)
                {
                    $key_row->delete();
                    continue;
                }
                for ($j=0; $j<count($a_po_id[$i]); $j++)
                {
                    $activity=new Anc_Key_Activity_SQL($cn);
                    $activity->setp('detail', $key_row->ke_id);
                    $value=($a_po_id[$i][$j]==-1)?null:$a_po_id[$i][$j];
                    $activity->setp('activity', $value);
                    $activity->setp('plan',$a_plan[$j]);
                    $activity->save();
                }
            }
            // delete all from key_distribution_ledger
            $cn->exec_sql('delete from key_distribution_ledger where kd_id=$1', array($this->key->getp('id')));
            for ($k=0; $k<count($a_ledger); $k++)
            {
                $ledger=new Anc_Key_Ledger_SQL($cn);
                $ledger->kd_id=$this->key->getp('id');
                $ledger->jrn_def_id=$a_ledger[$k];
                $ledger->save();
            }
            
            $cn->commit();
        }
        catch (Exception $e)
        {
            
            if ( DEBUGNOALYSS > 0 ) { echo $e->getTraceAsString(); } else { echo _('erreur').$e->getMessage();}
              record_log($e);
            $cn->rollback();
        }
    }

References $a_ledger, $a_plan, $a_row, $cn, $e, $http, $i, $ledger, $p_array, $value, _, record_log(), and verify().

Here is the call graph for this function:

set_key()

Anc_Key::set_key

(

$key

)

Definition at line 80 of file anc_key.class.php.

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

References $key.

verify()

Anc_Key::verify

(

$p_array

)

verify that data are ok

Parameters

type

$p_array

Definition at line 160 of file anc_key.class.php.

    {
        $http=new HttpInput();
        $http->set_array($p_array);
        
        $a_percent=$http->extract('percent',"array");
        
        if (count($a_percent)==0)
        {
            throw new Exception(_('Aucune répartition'));
        }
        $tot_percent=0;
        bcscale(4);
        for ($i=0; $i<count($a_percent); $i++)
        {
            $tot_percent=bcadd($tot_percent, $a_percent[$i]);
        }
        if ($tot_percent >100)
        {
            throw new Exception(_('Le total ne vaut pas 100, total calculé = ').$tot_percent);
        }
 
        if (trim($http->extract('name_key'))=='') {
            throw new Exception (_('Le nom ne peut être vide'));
        }
    }

References $http, $i, $p_array, and _.

Referenced by save().

Field Documentation

$a_activity

Anc_Key::$a_activity

protected

array of activity for which the key is available

Definition at line 44 of file anc_key.class.php.

$a_ledger

Anc_Key::$a_ledger

protected

the distribution key array of ledger (JRN_DEF.JRN_DEF_ID) for which the key is available

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

Referenced by save().

$a_row

Anc_Key::$a_row

protected

array of row from key_distribution_detail , detail of the key

Definition at line 46 of file anc_key.class.php.

Referenced by input(), and save().

$key

Anc_Key::$key

private

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

Referenced by get_key(), key_add(), and set_key().

---

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

• include/class/anc_key.class.php