API Documentation
\

\Horde_Core_Ajax_Imple

Class to attach PHP actions to javascript elements.

Copyright 2005-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
attach()
handle()
getDomId()
getImpleUrl()
No public properties found
No constants found
_impleParams()
_jsOnDoAction()
_jsOnComplete()
_attach()
_handle()
$_domid
$_auth
$_init
$_params
$_observe
N/A
No private methods found
No private properties found
N/A

Properties

$_domid

$_domid : integer

DOM ID incrementer. Shared by all Imple instances.

Type

integer

$_auth

$_auth : boolean

Does this imple require authentication?

Type

boolean

$_init

$_init : boolean

Has this imple been initialized?

Type

boolean

$_params

$_params : array

Parameters needed by the subclasses.

Type

array

$_observe

$_observe : string

The javascript event to observe.

Type

string

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Configuration parameters:

  • id: (string) [OPTIONAL] The DOM ID to attach to.

attach()

attach()

Attach the object to a javascript event.

handle()

handle(\Horde_Variables  $vars) : mixed

Imple handler.

Parameters

\Horde_Variables $vars

A variables object.

Returns

mixed —

Data to return to the browser.

getDomId()

getDomId() : string

Return the DOM ID this Imple is attached to.

Returns

string —

DOM ID.

getImpleUrl()

getImpleUrl() : \Horde_Url

The URL to the imple AJAX endpoint. This should only be used if the javascript code.

Returns

\Horde_Url —

URL to the AJAX endpoint.

_impleParams()

_impleParams() : array

Add the necessary parameters to the imple AJAX request.

Returns

array —

URL parameter hash.

_jsOnDoAction()

_jsOnDoAction(string  $js)

Javascript code to run before the action is sent to the AJAX endpoint.

e.memo contains the list of URL parameters.

Parameters

string $js

JS code to run.

_jsOnComplete()

_jsOnComplete(string  $js)

Javascript code to run on a successful AJAX response.

e.memo contains the AJAX response.

Parameters

string $js

JS code to run.

_attach()

_attach(boolean  $init) : mixed

Attach the object to a javascript event.

Parameters

boolean $init

Is this the first time this imple has been initialized?

Returns

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()

_handle(\Horde_Variables  $vars) : mixed

Imple handler.

Parameters

\Horde_Variables $vars

A variables object.

Returns

mixed —

Data to return to the browser.