PHP Class Horde_Core_Ajax_Imple, horde
Copyright 2005-2016 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Mostrar archivo
Open project: horde/horde
Class Usage Examples
Protected Properties
Public Methods
Method |
Description |
|
__construct ( array $params = [] ) |
Constructor. |
|
attach ( ) |
Attach the object to a javascript event. |
|
getDomId ( ) : string |
Return the DOM ID this Imple is attached to. |
|
getImpleUrl ( ) : Horde_Url |
The URL to the imple AJAX endpoint. This should only be used if the
javascript code. |
|
handle ( Horde_Variables $vars ) : mixed |
Imple handler. |
|
Protected Methods
Method Details
__construct()
public method
public __construct ( array $params = [] ) |
$params |
array |
Configuration parameters:
- id: (string) [OPTIONAL] The DOM ID to attach to. |
_attach()
abstract protected method
Attach the object to a javascript event.
abstract protected _attach ( boolean $init ) : mixed |
$init |
boolean |
Is this the first time this imple has been
initialized? |
return |
mixed |
An array of javascript parameters. If false, the imple
handler will ignore this instance (calling code will be
responsible for calling imple endpoint). |
_handle()
abstract protected method
abstract protected _handle ( Horde_Variables $vars ) : mixed |
$vars |
Horde_Variables |
A variables object. |
return |
mixed |
Data to return to the browser. |
_impleParams()
final protected method
Add the necessary parameters to the imple AJAX request.
_jsOnComplete()
protected method
e.memo contains the AJAX response.
_jsOnDoAction()
protected method
e.memo contains the list of URL parameters.
Attach the object to a javascript event.
Return the DOM ID this Imple is attached to.
getImpleUrl()
final public method
The URL to the imple AJAX endpoint. This should only be used if the
javascript code.
final public getImpleUrl ( ) : Horde_Url |
return |
Horde_Url |
URL to the AJAX endpoint. |
public handle ( Horde_Variables $vars ) : mixed |
$vars |
Horde_Variables |
A variables object. |
return |
mixed |
Data to return to the browser. |
Property Details
$_auth protected_oe property
Does this imple require authentication?
protected bool $_auth |
return |
boolean |
|
$_domid protected_oe static_oe property
DOM ID incrementer. Shared by all Imple instances.
protected static int $_domid |
return |
integer |
|
$_init protected_oe property
Has this imple been initialized?
protected bool $_init |
return |
boolean |
|
$_observe protected_oe property
The javascript event to observe.
protected string $_observe |
return |
string |
|
$_params protected_oe property
Parameters needed by the subclasses.
protected array $_params |
return |
array |
|