API Documentation
\

\Horde_Core_Ajax_Response_HordeCore_Reload

A data object that indicates to the HordeCore javascript framework that the action was successful, but the page needs to be reloaded.

Copyright 2012-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()
send()
sendAndExit()
$cssfiles
$jsfiles
$jsonhtml
$tasks
$data
No constants found
_jsonData()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$cssfiles

$cssfiles : array

CSS files to be loaded by the browser.

Type

array

$jsfiles

$jsfiles : array

JavaScript files to be loaded by the browser.

Type

array

$jsonhtml

$jsonhtml : boolean

If true, output HTML-ized JSON instead of application/json.

Type

boolean

$tasks

$tasks : object

Task data to send to the browser.

Type

object

$data

$data : mixed

Response data to send to the browser.

Type

mixed

Methods

__construct()

__construct(mixed  $data = null)

Constructor.

Parameters

mixed $data

Response data to send to browser. For this class, this can be the URL to redirect to. If null, will reload the current URL of the browser.

send()

send()

Send response data to browser.

sendAndExit()

sendAndExit()

Send response data to browser and ends script execution.

_jsonData()

_jsonData() : object

Return a single property, 'reload', which indicates to the HordeCore framework that the page should be immediately reloaded.

The object may include a 'jsfiles' property, which is an array of URL-accessible javascript files to be loaded by the browser (since 2.10.0).

The object may include a 'msgs' property, which is an array of notification message objects with 3 properties: flags, message, and type.

The object may include a 'tasks' property, which is an array of keys (task names) / values (task data).

Returns

object —

HordeCore JSON object.