Forecast_Cat Class Reference

this class is called normally from forecast, a forecast contains category like sales, expenses, each category contains items More...

Collaboration diagram for Forecast_Cat:

Public Member Functions
	__construct ($p_init, $p_id=0)
	constructor More...
	delete ()
	get_info ()
	get_parameter ($p_string)
	insert ()
	load ()
	make_array ($id)
	Make a array for a ISelect of the available cat. More...
	save ()
	set_parameter ($p_string, $p_value)
	update ()
	verify ()

Static Public Member Functions
static	load_all ($p_cn, $p_id)
	Load all the cat. More...
static	test_me ()
	unit test More...

Private Attributes
	$cn

Static Private Attributes
static	$variable =array ("id"=>"fc_id","order"=>"fc_order","desc"=>"fc_desc","forecast"=>"f_id")

Detailed Description

this class is called normally from forecast, a forecast contains category like sales, expenses, each category contains items

See also

Forecast

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

Constructor & Destructor Documentation

__construct()

Forecast_Cat::__construct	(		$p_init,
			$p_id = 0
	)

constructor

Parameters

$p_init

Database object

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

    {
        $this->cn=$p_init;
        $this->fc_id=$p_id;
    }

References $p_id, and cn.

Member Function Documentation

delete()

Forecast_Cat::delete

(

)

Definition at line 159 of file forecast_cat.class.php.

    {
        $sql="delete from forecast_cat where fc_id=$1";
        $res=$this->cn->exec_sql($sql,array($this->fc_id));
    }

References $res, $sql, and cn.

get_info()

Forecast_Cat::get_info

(

)

Definition at line 69 of file forecast_cat.class.php.

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

get_parameter()

Forecast_Cat::get_parameter

(

$p_string

)

Definition at line 47 of file forecast_cat.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.

Referenced by save().

insert()

Forecast_Cat::insert

(

)

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

    {
        if ( $this->verify() != 0 ) return;
 
        $sql="insert into forecast_cat (fc_desc,fc_order,f_id) ".
             " values ($1,$2,$3)  returning fc_id";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->fc_desc,$this->fc_order,$this->f_id)
             );
        $this->fc_id=Database::fetch_result($res,0,0);
    }

References $res, $sql, cn, DatabaseCore\fetch_result(), and verify().

Referenced by save().

Here is the call graph for this function:

load()

Forecast_Cat::load

(

)

Definition at line 129 of file forecast_cat.class.php.

    {
 
        $sql="select fc_desc, f_id,fc_order from forecast_cat where fc_id=$1";
 
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->fc_id)
             );
 
        if ( Database::num_row($res) == 0 ) return;
        $row=Database::fetch_array($res,0);
        foreach ($row as $idx=>$value)
        {
            $this->$idx=$value;
        }
 
    }

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

Here is the call graph for this function:

load_all()

static Forecast_Cat::load_all (   $p_cn,   $p_id  )

static

Load all the cat.

for a given forecast and return them into a array

Parameters

$p_cn	database connx
$p_id	is the forecast id (f_id)

Returns

an array with all the data

Definition at line 121 of file forecast_cat.class.php.

    {
        $sql="select fc_id,fc_desc,fc_order from forecast_cat where f_id=$1";
 
        $res=$p_cn->get_array($sql,array($p_id));
 
        return $res;
    }

References $p_id, $res, and $sql.

Referenced by Anticipation\form_cat_mod().

make_array()

Forecast_Cat::make_array

(

$id

)

Make a array for a ISelect of the available cat.

Parameters

$id	is forecast::f_id

Returns

array for ISelect

See also

ISelect

Definition at line 153 of file forecast_cat.class.php.

    {
        $sql="select fc_id,fc_desc from forecast_cat where f_id=$id";
        $ret=$this->cn->make_array($sql);
        return $ret;
    }

References $ret, $sql, and cn.

save()

Forecast_Cat::save

(

)

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

    {
        if (  $this->get_parameter("id") == 0 )
            $this->insert();
        else
            $this->update();
    }

References get_parameter(), insert(), and update().

Here is the call graph for this function:

set_parameter()

Forecast_Cat::set_parameter	(		$p_string,
			$p_value
	)

Definition at line 57 of file forecast_cat.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.

test_me()

static Forecast_Cat::test_me ( )

static

unit test

Definition at line 167 of file forecast_cat.class.php.

    {}

update()

Forecast_Cat::update

(

)

Definition at line 104 of file forecast_cat.class.php.

    {
        if ( $this->verify() != 0 ) return;
 
        $sql="update forecast_cat set fc_desc=$1,f_id=$2,fc_order=$3 ".
             " where fc_id = $4";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->fc_desc,$this->f_id, $this->fc_order,$this->fc_id)
             );
    }

References $res, $sql, cn, and verify().

Referenced by save().

Here is the call graph for this function:

verify()

Forecast_Cat::verify

(

)

Definition at line 73 of file forecast_cat.class.php.

    {
        if (strlen(trim($this->fc_order))==0)
        {
            $this->fc_order="1";
        }
        // Verify that the elt we want to add is correct
        // the f_name must be unique (case insensitive)
        return 0;
    }

Referenced by insert(), and update().

Field Documentation

$cn

Forecast_Cat::$cn

private

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

$variable

Forecast_Cat::$variable =array ("id"=>"fc_id","order"=>"fc_order","desc"=>"fc_desc","forecast"=>"f_id")

staticprivate

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

---

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

• include/class/forecast_cat.class.php