HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]
Prev Next
HTML_Progress_Monitor::setProgressHandler
sets the user callback of the progress monitor

Synopsis

require_once 'HTML/Progress/monitor.php';

void HTML_Progress_Monitor::setProgressHandler( mixed $handler)

Description

This method defines the user process to execute while the progress monitor is running.

This user callback is called by HTML_Progress_Monitor::callProgressHandler into the HTML_Progress_Monitor::notify method.

Parameter

    mixed $handler
  • a valid callback

Throws

Possible PEAR_Error values

Error level Error code Error message Solution
warning HTML_PROGRESS_ERROR_INVALID_CALLBACK invalid callback, parameter #1 "$handler" expecting "(a valid callback)" Fixed the user-callback reference

Note

( HTML_Progress >= 1.1 )

This function can not be called statically.

See

HTML_Progress::setAnimSpeed, HTML_Progress::sleep, HTML_Progress_Monitor::callProgressHandler, HTML_Progress_Monitor::run

Example

See example of HTML_Progress_Monitor::run.

Prev Up Next
HTML_Progress_Monitor::notify Reference Guide HTML_Progress_Monitor::callProgressHandler

Documentation generated on Sun, 12 Sep 2004 20:23:31 +0200 by phpDocumentor 1.3.0RC3