Horde_Core_Ajax_Application_Handler_Prefs
extends Horde_Core_Ajax_Application_Handler
in package
Defines AJAX calls used to interact with Horde preferences.
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.
Tags
Table of Contents
Properties
- $vars : Horde_Variables
- $_base : Horde_Core_Ajax_Application
- The base AJAX application object.
- $_external : array<string|int, mixed>
- A list of public method names that can be accessed externally (i.e.
- $_ignored : array<string|int, mixed>
- A list of public method names to ignore as actions.
- $_readOnly : array<string|int, mixed>
- A list of actions that require read-only session access.
Methods
- __construct() : mixed
- Constructor.
- __get() : mixed
- external() : bool
- Is the action accessible externally?
- has() : bool
- Determines if the action exists in this handler.
- readonly() : bool
- Is the action marked read-only?
- setPrefValue() : bool
- Sets a preference value.
Properties
$vars
public
Horde_Variables
$vars
The Variables object.
$_base
The base AJAX application object.
protected
Horde_Core_Ajax_Application
$_base
$_external
A list of public method names that can be accessed externally (i.e.
protected
array<string|int, mixed>
$_external
= array()
outside of the Horde framework).
$_ignored
A list of public method names to ignore as actions.
protected
array<string|int, mixed>
$_ignored
= array()
$_readOnly
A list of actions that require read-only session access.
protected
array<string|int, mixed>
$_readOnly
= array()
Methods
__construct()
Constructor.
public
__construct(Horde_Core_Ajax_Application $base) : mixed
Parameters
- $base : Horde_Core_Ajax_Application
-
The base AJAX application object.
__get()
public
final __get(mixed $name) : mixed
Parameters
- $name : mixed
external()
Is the action accessible externally?
public
final external(string $action) : bool
Parameters
- $action : string
-
An AJAX action.
Return values
bool —True if the action is acessible externally.
has()
Determines if the action exists in this handler.
public
final has(string $action) : bool
Parameters
- $action : string
-
An AJAX action.
Return values
bool —True if the action exists.
readonly()
Is the action marked read-only?
public
final readonly(string $action) : bool
Parameters
- $action : string
-
An AJAX action.
Return values
bool —True if the action is read-only.
setPrefValue()
Sets a preference value.
public
setPrefValue() : bool
Variables used:
- pref: (string) The preference name.
- value: (mixed) The preference value.
Return values
bool —True on success.