HTML_Progress2::setProgressHandler

Name

HTML_Progress2::setProgressHandler — Sets the user progress callback function

Synopsis

      require_once 'HTML/Progress2.php';

void HTML_Progress2::setProgressHandler( $handler);

mixed

$handler;

Description

The process() function will call the user-callback defined here by this setProgressHandler() method.

The user-supplied progress function must return either positive for a step progression, using moveStep() method, or NULL for a standard progression, using moveNext() method.

Parameter

mixed $handler: Name of function or a class-method.

See

see HTML_Progress2::process

Throws

throws HTML_PROGRESS2_ERROR_INVALID_CALLBACK

Note

since 2.0.0

This function can not be called statically.

Prev	Up	Next
`HTML_Progress2::sleep`	Home	`HTML_Progress2::process`

HTML_Progress2 : The Definitive Guide