Core

Array of named placeholders e.g. ['title'=>'My Title'] -> replaces {title} in token with 'My Title'

Translated Token

Instance ID

ID of the user causing the action, null will automatically be set if a user is currently logged in

Specifying what has been done (e.g. WHAT has been added) this is default text if displaying user has no access to the linked page, will be set to document_index->title if not specified

User targeted with the action

= ['view' => $this->mod->context, 'page'=>'view', 'cmd'=>''] If no link is given, the doclink to the document index will be used automatically

Action ID specifies which kind of action has beed conducted Possible types: ACTIONLOG_ADD, ACTIONLOG_REMOVE, ACTIONLOG_COMMENT,.... (see class for more)

User ID mostly $XF->user->get_user_id()

Specifying what has been done (e.g. WHAT has been added) this is default text if displaying user has no access to the linked page

target User ID (e.g. user has visited profiel from target_user)

Link param array for generating a link to the action on the 'what' string

Post ID - Normally our primary ID

Post Type - If you have different types of Posts

Group ID

JSON Response (transferred via HTTP X-JSON Header)

Template Object (if no template is provided the default template of the current module will be used)

RenderModeAjax (by Default the mode is untouched, if set it will only be applied if the call is an ajax call)

SQL Query

Mode (fetch_assoc, fetch_array)

Filename (for logging and debugging)

Line No

Cache TTL in s (Results of this query are case)

Cache Group (can be used to remove all caches from the same group, e.g. template, user_details etc.)

reference to string indicates if query was an update/delete or an insert

Array with Result OR Insert ID OR Affected Rows OR False for "no rows found"

SQL Query (can contain named markers, e.g. :name)

['param_name'=>'param_value'] Assoc-Array with SQL Parameters. Will be escaped and inserted into the passed SQL

Mode (fetch_assoc, fetch_array)

Filename (for logging and debugging)

Line No

Cache TTL in s (Results of this query are case)

Cache Group (can be used to remove all caches from the same group, e.g. template, user_details etc.)

reference to string indicates if query was an update/delete or an insert

Array with Result OR Insert ID OR Affected Rows OR False for "no rows found"

xfs document ID

Error Message

Error Type

Render mode

(Throws Exception)

Group ID

Empty array if i18n_mode is not available

Parameter (Typical: mod_wwwres_relative, web_path_root, mod_template_path, mod_storage_path)

Instance ID

Value of Parameter

LinkHelper Params in Array Format

['label'=>'', 'target'=>'', 'class'=>'', 'title'=>'', 'href'=>'', 'full'=>''] Link Resource Array

Language/Culture (e.g. DE_DE)

internal dependency key

Group ID

Default Page

Default CMD

Returns an array with all available dependencies

Path to File

path to your file within your mod_storage_path

Show Inline? (Default:True)

Force a specific filename within the headers sent

Want the content zipped? (Default: False)

Resize Mode ['resize', 'crop', false] (Default: False)

Generate Public File Link? (not compatible with zipOnTheFly!) This will always resize all images during this call and make them available via public URL /_cache/..

Group ID

Hook/Callback Key As declared by the provider (e.g. recent_threads)

Provider Instance Name

Force a new object

Callback Object (Array for Callback or Object for Usage)

Hook/Callback Key as declared in your Instance Config

Limit to hooks from a certain instance?

Instantiate Hook Objects?

Return hooks which are depending on this parent context, true will use the current parent_context if available, '*' will remove parent context limitation

Explicitely set the expected hook classification, e.g. cms.contentPortlet

[[ 'instance_id' => (string) $instanceID 'parent_context' => (string) $parentContext 'caller_id' => (string) $callerID 'name' => (string) $name 'module_name' => (string) $module_name 'title' => (string) $title 'title_i18n' => (string) $title 'description' => (string) $description 'description_i18n' => (string) $description 'options' => (array) $options ]]

Contains array with url, full etc.

new or existing instance of name

Page ID

Cmd Params

Template Object

Parent Instance

Plugin Name

Plugin Prefix

with objects ('pluginName'=>Obj)

Resets all Variables and returns clean/new template

Template Object

Instance ID

Hook name

SQL Query with ? Marker

(1D - array for multiple params)

DEBUG Filename (FILE)

DEBUG Line (LINE)

UPDATE ###tbl|contact### set displayname = ?, status = ? WHERE id = ?;

$params = array($displayname,$status,$id)

User-ID or Array of Users

Token for updates for this Notification

Plaintext/Shortmessage without HTML

Link as URL or as Array (get_current_url)

FontAwesome-Icon Class

Type of Notification ('activity','todo','message')

SQL Query with ? Marker

(1D - array for multiple params)

DEBUG Filename (FILE)

DEBUG Line (LINE)

UPDATE ###tbl|contact### set displayname = ?, status = ? WHERE id = ?;

$params = array($displayname,$status,$id)

Parsed Query

Parsed Query

multi-dimensional context_links (use '-' for separator)

Set to true if all links are current_links

If set to FALSE these links will not be shown if JS is NOT present

HTML return link resource array

of links with Menu labels array(mainmenu_label => array(link1, link2, link3)) for a normal context menu, like print_context_menu array(mainmenu_label => array(link1, link2, submenu_label => array(link3, link4), link5))

of additional params for the first dropdown: class, icon_class

return link resource array

(Absolute on Disk)

OPTIONAL (defaults: inline_disposition=true, label=basename of file,icon=false,limit_string=false

HTML a tag

= [ 'label'=>$label, 'page'=>$page, 'cmd'=>$cmd, 'class'=>'btn', 'target'=>'_new', 'title'=>$title, 'confirmtext'=>("Are you sure?"), 'JS-FSLoader'=>['message' => 'loading..', 'autohide'=>'5000'], 'ajax_modal'=>['form' => ['reload'=>true,'reloadTable'=>'table_dom_id','reloadXUI'=>'xui_dom_id'], 'width'=> 800, 'height' => '80%', 'fullscreen' => true], 'ajax_update'=>$domId, 'ajax_replace'=>$domId, 'xdi' => DocumentIndex, 'xui_target' => UIAjaxComponent ]

Full HTML A Tag

Output (eg. html)

Name (Refers to YOUR entry in the config.yml)

CMD Params

string URL or false if not resolvable

xf_link LinkHelper

document index ID

The owner document which the document is attached to

The system_dms_document

Array of arguments passed via CMD parameter

True if data as passed as binary stream instead of filename

Set to true if args[1] contains a fill hdd path (not within mod_storage of current module). Caution!

group id

short name

group id

short name

Module Instance

Returns the cached result or null if no value has been stored

ID for the cache pool which should be used

path to the new file

virtual folder in the System DMS where the document is stored

filename in the System DMS

Document that owns all stored files by reference and subcategory of system dms

The new xfs_document in the system DMS

Group Security ID

Group Security IDs

Policy (e.g. read, write, delete)

Dynamic Value to check (e.g. category_id, thread_id, item_id) or * for static

of targetuser for privacy

local group_id if known

policy 'allow' or 'deny'

Tablename for Tree Policies

e.g. 'xf_'

e.g. "XELOS\Framework\Lib\"