Warning: The general API is not yet stable and minor details may change.
(array) |
$customdata |
An array containing user defined data, language independant. |
(array) |
$customnlsdata |
An array containing user defined data, language dependant. |
(object) |
$data |
An object containing all the persistant data of the current object. |
(int) |
$id |
The unique id number of the current object. |
(int) |
$lastchanged |
The unix timestamp, when the object was last saved. |
(object) |
$nlsdata |
An object containing all the persistant data of the current object, which are language dependant and of the current language. |
(string) |
$nls |
The current language code, e.g. 'en' for English or 'nl' for Dutch. |
(string) |
$path |
The path to the current object in the object store. |
(string) |
$parent |
The path to the parent of the current object in the object store. |
(int) |
$priority |
The priority of the current object, which can be used to order objects. |
(string) |
$reqnls |
The language code the client requested. This may differ from the actual language code used. |
(string) |
$type |
The type of the current object, this may be a user defined type like 'pdir.myversion'. |
(string) |
$vtype |
The type of the current object, this is usually the same as $type, except for user defined types, in which case $vtype is the 'real' type: 'pdir' instead of 'pdir.myversion'. For shortcuts $vtype is the type of the target object. |
The following variables can always be used by getting/setting them with the getvar() / putvar() function.
(bool) |
nolangcheck |
If true, objects which aren't available in the current language will still show the user requested template, but in the default language instead. If false (default), the user.languageselect.html template will be called instead. |
(bool) |
allnls |
If true, objects will be shown in listings even if they aren't available in the current language. The default language will be used instead. If false, the objects will be skipped. Default value is false. |
(bool) |
ARShowTempla» teBorders |
If true, Ariadne will add DIV elements with title tags showing which template was used for which part of the output. This may be usefull for debugging templates. Default value is false. |