Forecast Class Reference

manage the table forecast More...

Collaboration diagram for Forecast:

Public Member Functions
	__construct ($p_init, $p_id=0)
	constructor
	delete ()
	get_info ()
	get_parameter ($p_string)
	insert ()
	load ()
	load from db
	object_clone ()
	save ()
	set_parameter ($p_string, $p_value)
	update ()
	update the forecast table
	verify ()

Static Public Member Functions
static	load_all ($p_cn)
	load all the existing forecast

Private Attributes
	$cn

Static Private Attributes
static	$variable

Detailed Description

manage the table forecast

Definition at line 28 of file forecast.class.php.

Constructor & Destructor Documentation

__construct()

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

constructor

Parameters

$p_init

Database object

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

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

References $p_id, and cn.

Member Function Documentation

delete()

Forecast::delete

(

)

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

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

References $res, $sql, and cn.

get_info()

Forecast::get_info

(

)

Definition at line 63 of file forecast.class.php.

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

get_parameter()

Forecast::get_parameter

(

$p_string

)

Definition at line 43 of file forecast.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::insert

(

)

Definition at line 85 of file forecast.class.php.

    {
        if ( $this->verify() != 0 ) return;
        $sql="insert into forecast (f_name,f_start_date,f_end_date) ".
             " values ($1,$2,$3)  returning f_id";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->f_name,$this->f_start_date,$this->f_end_date)
             );
        $this->f_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::load

(

)

load from db

Returns

boolean true if found else false

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

                          :bool
    {
        $sql="select f_id, f_name,f_start_date ,f_end_date from forecast where f_id=$1";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->f_id)
             );
        if ( Database::num_row($res) == 0 ) return false;
        $row=Database::fetch_array($res,0);
        $a_index=array_values(self::$variable);
        foreach ( $a_index as $idx)
        {
            $this->$idx=$row[$idx];
        }
        return true;
    }

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

Referenced by object_clone().

Here is the call graph for this function:

load_all()

static Forecast::load_all ( $p_cn )

static

load all the existing forecast

Parameters

$p_cn

is an Database object

Returns

array of f_id and f_name

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

    {
        $sql="select f_id, f_name,f_start_date,f_end_date from forecast order by 2 desc";
        $ret=$p_cn->get_array($sql);
        return $ret;
    }

References $ret, and $sql.

object_clone()

Forecast::object_clone

(

)

Definition at line 148 of file forecast.class.php.

    {
      $this->load();
      /* save into the table forecast */
      $sql="insert into forecast(f_name,f_start_date,f_end_date) select 'clone '||f_name,f_start_date,f_end_date from forecast where f_id=$1 returning f_id";
      $new=$this->cn->get_value($sql,array($this->f_id));
 
      /* save into forecast_cat */
      $sql="insert into forecast_cat(fc_desc,f_id,fc_order)  select fc_desc,$1,fc_order from forecast_cat where f_id=$2 returning fc_id" ;
      $array=$this->cn->get_array($sql,array($new,$this->f_id));
 
      $old=$this->cn->get_array("select fc_id from forecast_cat where f_id=$1",array($this->f_id));
      /* save into forecast_item */
      for ($i=0;$i<count($array);$i++)
        {
          $this->cn->exec_sql("insert into forecast_item (fi_text,fi_account,fi_order,fc_id,fi_amount,fi_pid) ".
                              " select fi_text,fi_account,fi_order,$1,fi_amount,fi_pid ".
                              " from forecast_item where fc_id=$2",array($array[$i]['fc_id'],$old[$i]['fc_id']));
        }
    }

References $array, $i, $old, $sql, cn, and load().

Here is the call graph for this function:

save()

Forecast::save

(

)

Definition at line 76 of file forecast.class.php.

    {
        /* please adapt */
        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::set_parameter	(		$p_string,
			$p_value )

Definition at line 53 of file forecast.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()

Forecast::update

(

)

update the forecast table

Definition at line 100 of file forecast.class.php.

    {
        if ( $this->verify() != 0 ) return;
 
        $sql="update forecast set f_name=$1,f_start_date=$2,f_end_date=$3 ".
             " where f_id = $4";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->f_name,$this->f_start_date,$this->f_end_date, $this->f_id)
             );
 
    }

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

Referenced by save().

Here is the call graph for this function:

verify()

Forecast::verify

(

)

Definition at line 68 of file forecast.class.php.

    {
        // Verify that the elt we want to add is correct
        // the f_name must be unique (case insensitive)
        if ( noalyss_strlentrim($this->f_name)==0) throw new Exception(_('Le nom ne peut pas être vide'));
 
        return 0;
    }

References _, and noalyss_strlentrim().

Referenced by insert(), and update().

Here is the call graph for this function:

Field Documentation

$cn

Forecast::$cn

private

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

$variable

Forecast::$variable

staticprivate

Initial value:

=array ("id"=>"f_id",
      "name"=>"f_name","start_date"=>"f_start_date","end_date"=>"f_end_date"
      )

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

---

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

• include/class/forecast.class.php