Progress_Bar Class Reference

Use one db for tracking progress bar value, the task id must be unique and let you follow the progress of a task. More...

Collaboration diagram for Progress_Bar:

Public Member Functions
	__construct ($p_task_id)
	answer ()
	Json answer of the task progressing if value is equal or greater than 100 , delete the row.
	get_value ()
	Get the progress value from db.
	increment ($p_step)
	increment value with $p_step
	set_value ($p_value)
	Store the progress value into the db.

Private Attributes
	$db
	database connexion
	$task_id
	$value
	task id (progress_bar.p_id)

Detailed Description

Use one db for tracking progress bar value, the task id must be unique and let you follow the progress of a task.

how it works : when calling an ajax , you have to create the task id and start the monitoring of it (js function = progress_bar_start). In your php script called by ajax you call Progress_Bar->set_value to show the progress. The timer created by progress_bar_start will check regularly the progress in the db. The ajax parameter for following the task is task_id

Note

you have to use session_write_close(); in the ajax file , otherwise, the function progress_bar_check will be blocked and won't update the progress bar

See also

progress_bar_start

progress_bar_check

Examples

progress-bar.test.php.

Definition at line 47 of file progress_bar.class.php.

Constructor & Destructor Documentation

__construct()

Progress_Bar::__construct

(

$p_task_id

)

Definition at line 56 of file progress_bar.class.php.

    {
        $this->db=new Database();
        $this->task_id=$p_task_id;
        // Find value from db
        $this->value = $this->db->get_value("select p_value from progress where p_id=$1",
                [$p_task_id]);
        
        // if task doesn't exists, create it
        if ( $this->db->size()==0) 
        {
            $this->value=0;
            $this->db->exec_sql("insert into progress(p_id,p_value) values ($1,0)",
                    [$p_task_id]);
            $this->db->exec_sql("delete from progress where p_created < now() - interval '3 hours' ");
        }
    }

References db, and value.

Member Function Documentation

answer()

Progress_Bar::answer

(

)

Json answer of the task progressing if value is equal or greater than 100 , delete the row.

Returns

type

Definition at line 105 of file progress_bar.class.php.

    {
        $this->get_value();
        
        header('Content-Type: application/json');
        echo json_encode(["value"=>$this->value]);
        if ($this->value>=100) {
            $this->db->exec_sql("delete from progress where p_id=$1",[$this->task_id]);
        }
        return;
    }

References db, get_value(), and value.

Here is the call graph for this function:

get_value()

Progress_Bar::get_value

(

)

Get the progress value from db.

Returns

integer between 0 & 100

Definition at line 93 of file progress_bar.class.php.

    {
        $this->value = $this->db->get_value("select p_value from progress where p_id=$1",
                [$this->task_id]);
        
        return $this->value;
    }

References $value, db, and value.

Referenced by answer().

increment()

Progress_Bar::increment

(

$p_step

)

increment value with $p_step

Parameters

int

$p_step

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

    {
        if ($this->value+$p_step > 100 ) {
            $this->set_value(100);
            return;
        }
        $this->set_value($this->value+$p_step);
    }

References $p_step, set_value(), and value.

Here is the call graph for this function:

set_value()

Progress_Bar::set_value

(

$p_value

)

Store the progress value into the db.

Parameters

integer

$p_value

value of the progress between 0 & 100 @exceptions code 1005 - if p_value is not in between 0 & 100

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

    {
        if ( $p_value > 100 || $p_value < 0 ) {
            throw new Exception("Invalid value",EXC_PARAM_VALUE);
        }
        $this->value=$p_value;
        $this->db->start();
        $this->db->exec_sql("update progress set p_value=$1 where p_id=$2",
                [$this->value,$this->task_id]);
        $this->db->commit();
    }

References db, EXC_PARAM_VALUE, and value.

Referenced by Document_Export\export_all(), and increment().

Field Documentation

$db

Progress_Bar::$db

private

database connexion

Definition at line 49 of file progress_bar.class.php.

$task_id

Progress_Bar::$task_id

private

Definition at line 50 of file progress_bar.class.php.

$value

Progress_Bar::$value

private

task id (progress_bar.p_id)

value of progress (between 0 & 100)

Definition at line 51 of file progress_bar.class.php.

Referenced by get_value().

---

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

• include/lib/progress_bar.class.php