Ajax
extends Ajax
in package
Handles Ajax Calls.
Table of Contents
- $fwPermissions : array<, array<, mixed>>
- $instance : object
- The only instance of using class
- $log : array<, string>
- $restops : array<, array<, mixed>>
- getinstance() : object
- Checks, instantiates and returns the only instance of the using class.
- handle() : void
- Handle AJAX operations
- log() : bool
- Return the log requirements array from the child
- permissions() : array<, string>
- Return the permission requirements array from the child
Properties
$fwPermissions
protected
static array<, array<, mixed>>
$fwPermissions
= [FrameworkAjaxBean::class => [], FrameworkAjaxHints::class => [], FrameworkAjaxPaging::class => [], FrameworkAjaxPwCheck::class => [], FrameworkAjaxShared::class => [], FrameworkAjaxTable::class => [], FrameworkAjaxTableSearch::class => [], FrameworkAjaxToggle::class => [], FrameworkAjaxUnique::class => [], FrameworkAjaxUniqueNl::class => []]
Allowed Framework operation codes. Values indicate: 'bean' => [ Must Login (TRUE/FALSE) , [['ContextName', 'RoleName']...], [...field names or empty for all...] ]
Empty fields array means all fields (except id which is always special) Evaluation of multiple context/role pairs is a logical AND. If you want an OR then you need to group the pairs to be ORed in yet another nested array.
$instance
The only instance of using class
protected
static object
$instance
= NULL
$log
protected
static array<, string>
$log
= []
A list of bean names for which logging is required
$restops
private
static array<, array<, mixed>>
$restops
= ['bean' => FrameworkAjaxBean::class, 'config' => FrameworkAjaxConfig::class, 'hints' => FrameworkAjaxHints::class, 'paging' => FrameworkAjaxPaging::class, 'pwcheck' => FrameworkAjaxPwCheck::class, 'shared' => FrameworkAjaxShared::class, 'table' => FrameworkAjaxTable::class, 'tablecheck' => FrameworkAjaxTableCheck::class, 'tablesearch' => FrameworkAjaxTableSearch::class, 'toggle' => FrameworkAjaxToggle::class, 'unique' => FrameworkAjaxUnique::class, 'uniquenl' => FrameworkAjaxUniqueNl::class]
Allowed Framework operation codes. Values indicate : [needs login, Roles that user must have]
Methods
getinstance()
Checks, instantiates and returns the only instance of the using class.
public
static getinstance() : object
Tags
Return values
object —handle()
Handle AJAX operations
public
handle(Context $context) : void
Parameters
- $context : Context
-
The context object for the site
Return values
void —log()
Return the log requirements array from the child
public
final log(string $bean) : bool
Parameters
- $bean : string
-
The name of a bean
Return values
bool —permissions()
Return the permission requirements array from the child
public
final permissions(string $which[, array<, mixed> $system = [] ]) : array<, string>
Parameters
- $which : string
-
The permissions required
- $system : array<, mixed> = []