Class: HTML_Progress2_Ajax_StdDOMxml

Source Location: /HTML_Progress2-2.3.0a1/Progress2/Ajax/StdDOMxml.php

Class Overview

HTML_Progress2_Ajax_Common
   |
   --HTML_Progress2_Ajax_StdDOMxml

Ajax standard DOM XML driver class.

Author(s):

Laurent Laville <pear at laurent-laville.org>

Version:

Release: @package_version@

Copyright:

2007 The PHP Group

Methods

Inherited Variables

Class: HTML_Progress2_Ajax_Common

HTML_Progress2_Ajax_Common::$method
HTML_Progress2_Ajax_Common::$timeout
HTML_Progress2_Ajax_Common::$url
HTML_Progress2_Ajax_Common::$url_args

Inherited Methods

Class: HTML_Progress2_Ajax_Common

HTML_Progress2_Ajax_Common::__construct(): Constructor (ZE2) Summary
HTML_Progress2_Ajax_Common::getRequestMethod(): get HTTP Ajax requests method.
HTML_Progress2_Ajax_Common::getRequestTimeout(): get the timeout between each polling loop.
HTML_Progress2_Ajax_Common::getRequestUri(): get URL that handle Ajax requests.
HTML_Progress2_Ajax_Common::getScript(): Returns javascript progress meter handler.
HTML_Progress2_Ajax_Common::getUrlArguments(): get action arguments to handle task id.
HTML_Progress2_Ajax_Common::setRequestMethod(): set HTTP Ajax requests method.
HTML_Progress2_Ajax_Common::setRequestTimeout(): set timeout between each polling loop.
HTML_Progress2_Ajax_Common::setRequestUri(): set URL to handle Ajax requests.
HTML_Progress2_Ajax_Common::setUrlArguments(): set action arguments to handle task id.

Class Details

[line 57]
Ajax standard DOM XML driver class.

Provide handler of standard DOM XML usage. Available on all browsers Ajax compliant.

Here is a basic example:

 <?php

 require_once 'HTML/Progress2.php';
 
 $pb = new HTML_Progress2();
 // try to register the standard DOM XML Ajax driver
 $ae = $pb->registerAjax();
 if ($ae) {
   $ae->setRequestUri();
   $ae->setRequestMethod('post');
   $ae->setRequestTimeout(2500);
   $ae->setUrlArguments('startTask', 'targetId');
 }
 ?>

Author: Laurent Laville <pear@laurent-laville.org>
Version: Release: @package_version@
Copyright: 2007 The PHP Group
Link: http://pear.php.net/package/HTML_Progress2
Since: Class available since Release 2.3.0a1
License: PHP License 3.01

[ Top ]

Method Detail

__construct (Constructor) [line 90]

HTML_Progress2_Ajax_StdDOMxml __construct(

&$obj, object
$obj)

Constructor (ZE2) Summary

Creates an Ajax progress-meter default driver

See: HTML_Progress2_Ajax_Common::setRequestUri(), HTML_Progress2_Ajax_Common::setRequestMethod(), HTML_Progress2_Ajax_Common::setRequestTimeout()
Since: 2.3.0a1
Access: protected

Overrides HTML_Progress2_Ajax_Common::__construct() (Constructor (ZE2) Summary)

Parameters:

object	`$obj`	—	reference to a progress2 object
	`&$obj`	—

[ Top ]

HTML_Progress2_Ajax_StdDOMxml (Constructor) [line 72]

HTML_Progress2_Ajax_StdDOMxml HTML_Progress2_Ajax_StdDOMxml(

&$obj, object
$obj)

Constructor (ZE1)

Creates an Ajax progress-meter default driver

See: HTML_Progress2_Ajax_Common::setRequestUri(), HTML_Progress2_Ajax_Common::setRequestMethod(), HTML_Progress2_Ajax_Common::setRequestTimeout()
Since: 2.3.0a1
Access: public

Parameters:

object	`$obj`	—	reference to a progress2 object
	`&$obj`	—

[ Top ]

getScript [line 108]

string getScript(
[boolean
$raw = true])

Returns javascript progress meter handler.

Ajax code to handle the progress meter polling sequence.

See: HTML_Progress2::getScript()
Throws: HTML_PROGRESS2_ERROR_INVALID_INPUT
Since: 2.3.0a1
Access: public

Overrides HTML_Progress2_Ajax_Common::getScript() (Returns javascript progress meter handler.)

Parameters:

boolean $raw — (optional) html output with script tags or just raw data

[ Top ]