• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

Autoloader — Class in namespace XELOS\Framework

Class Autoloader XELOS Autoloader for loading XELOS related class files Supporting XELOS Namespaces as well as a Fallback for files without namespace (XELOS < 7.0, deprecated)

$ Autoloader#alias_blacklist — Property in class Autoloader

Problematic ClassNames which are conflicting with PHP internals or Major Extensions (e.g. PEAR)

AuthenticationInterface — Class in namespace XELOS\Framework\Core\Authentication

AuthenticationInterface::authenticate_user() — Method in class AuthenticationInterface

BaseAuthentication::addConfigVarsToModuleInfoArray() — Method in class BaseAuthentication

Add correct config_var property to module info array

ActivedirectoryAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ ActivedirectoryAuthentication#ad_mappings — Property in class ActivedirectoryAuthentication

Map of (additional) Variables from the user info (such as email, telephone, etc.)

$ ActivedirectoryAuthentication#adldap — Property in class ActivedirectoryAuthentication

AD Ldap Object

$ ActivedirectoryAuthentication#auth_title — Property in class ActivedirectoryAuthentication

ActivedirectoryAuthentication::authenticate_user() — Method in class ActivedirectoryAuthentication

Authenticate User

AlternativeLoginAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ AlternativeLoginAuthentication#auth_title — Property in class AlternativeLoginAuthentication

AlternativeLoginAuthentication::authenticate_user() — Method in class AlternativeLoginAuthentication

Authenticate User

GuestAuthentication::authenticate_user() — Method in class GuestAuthentication

InviteAuthentication::authenticate_user() — Method in class InviteAuthentication

IpAuthentication::authenticate_user() — Method in class IpAuthentication

LdapAuthentication::authenticate_user() — Method in class LdapAuthentication

MobileAccessAuthentication::authenticate_user() — Method in class MobileAccessAuthentication

MultiFactorAuthentication::authenticate_user() — Method in class MultiFactorAuthentication

NtlmAuthentication::authenticate_user() — Method in class NtlmAuthentication

Authenticate Users

RadiusAuthentication::authenticate_user() — Method in class RadiusAuthentication

RemembermeAuthentication::authenticate_user() — Method in class RemembermeAuthentication

SuperuserAuthentication::authenticate_user() — Method in class SuperuserAuthentication

XelosAuthentication::authenticate_user() — Method in class XelosAuthentication

$ CommandDefinition#arguments — Property in class CommandDefinition

CommandDefinition::addArgument() — Method in class CommandDefinition

CommandDefinition::addOption() — Method in class CommandDefinition

Update::add_to_logfile() — Method in class Update

Add Messsage to LOG

Table::addColumn() — Method in class Table

Add columns for output. The

$ Input#arguments — Property in class Input

Input::applyCommand() — Method in class Input

Input::applyCommandDefinition() — Method in class Input

Input::askQuestion() — Method in class Input

TODO rewrite user input code

Output::applyColor() — Method in class Output

Color, Formatting

$ Core#action — Property in class Core

Access to actions defined in the class sub-folder action

Core::ajax_response() — Method in class Core

Returns the passed JSON and returns the module template directly to the view class for rendering

Core::add_class_to_registry() — Method in class Core

Core::add_config_array() — Method in class Core

Core::add_actionlog() — Method in class Core

Core::addActionLog() — Method in class Core

AccessException — Class in namespace XELOS\Framework\Core\Exception

Class AccessException

ApiException — Class in namespace XELOS\Framework\Core\Exception

AuditException — Class in namespace XELOS\Framework\Core\Exception

Class AuditException

AuthenticationException — Class in namespace XELOS\Framework\Core\Exception

Class AuthenticationException

AuthenticationUserException — Class in namespace XELOS\Framework\Core\Exception

This Exception will be thrown if the user has a problem which may/can be solved by the user himself

ActionHandlerHelper — Class in namespace XELOS\Framework\Core\Helper

ActionHandlerHelper::addAction() — Method in class ActionHandlerHelper

Bind possible action to trigger

ActionHelper — Class in namespace XELOS\Framework\Core\Helper

DocumentAddCategoryInterface::add_category() — Method in class DocumentAddCategoryInterface

DocumentAddFileInterface::add_file() — Method in class DocumentAddFileInterface

$ Template#auto_render_sub_blocks — Property in class Template

Template::add_template() — Method in class Template

Add a template to the registry

Template::auto_render_block() — Method in class Template

Template::add_renderer() — Method in class Template

Template::assign() — Method in class Template

Template::assign_xss() — Method in class Template

Template::append() — Method in class Template

Template::append_to_list() — Method in class Template

Template::assignMobileAppInfo() — Method in class Template

Template::assign_js() — Method in class Template

$ ObjectManager#auto_init — Property in class ObjectManager

This property controls if the init method of requested objects is called by this trait or not.

VarsTemplate::add_xml_wrapper() — Method in class VarsTemplate

Add xml definition and html,head and body tags around the given xml_source

$ Controller#action — Property in class Controller

Controller::add_css_file() — Method in class Controller

Add CSS file from the wwwres/css folder to the page

Controller::add_js_file() — Method in class Controller

Add JS file from the wwwres/js folder to the page

Controller::attach_link() — Method in class Controller

Attach a Link to each model in the collection

AuthenticationHook — Class in namespace XELOS\Framework\Module\Hook

Class AuthenticationHook

AuthenticationHook::authenticate_user() — Method in class AuthenticationHook

User authentication is wrapped for Auth Hooks

InstallEvents::afterTableUpdate() — Method in class InstallEvents

Called after SQL tranformations are applied to the database

InstallEvents::afterModuleUpdate() — Method in class InstallEvents

Only called after module has been updated

Collection::addAfterLoadListener() — Method in class Collection

Collection::applyScopeFromReferencingCollection() — Method in class Collection

Apply related collection scopes, assumes 1:n relation

Collection::applyScopeFromRelatedCollection() — Method in class Collection

Apply related collection scopes, assumes n:1/n:m relation

Collection::array() — Method in class Collection

Collection::all() — Method in class Collection

ActionlogActivityDocumentInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

ActionlogWallDocumentInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

This document is supposed to appear on the wall and should be processed by the actionlog indexer

AuditableInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

AuditableInterface::addAuditTrail() — Method in class AuditableInterface

Add Audit Trail

Model::add_formatted_property() — Method in class Model

Apply lib->format multi_format on passed property. The result will be written to ->[property]_formatted

Model::all() — Method in class Model

Return all models

ModelCollection::all() — Method in class ModelCollection

Find Function to find models using the passed condition

ModelCollection::attach() — Method in class ModelCollection

Set property values to models from array

ModelCollection::add_formatted_property() — Method in class ModelCollection

Apply lib->format multi_format on passed property. The result will be written to ->[property]_formatted

ModelCollection::append() — Method in class ModelCollection

Adds an Object to the models-array.

AuditableTrait — Class in namespace XELOS\Framework\Module\Model\Traits

Trait Auditable to be used in Models

$ AuditableTrait#auditingDisabled — Property in class AuditableTrait

Is auditing disabled?

$ AuditableTrait#auditExcludedProperties — Property in class AuditableTrait

AuditableTrait::addAuditTrail() — Method in class AuditableTrait

ScopesTrait::add_scope_condition() — Method in class ScopesTrait

Adds a condition to scope the following find functions

CollectionCacheTrait::all() — Method in class CollectionCacheTrait

Returns all items of the model. Caches the collection at first call

StateMachineTrait::after_transition() — Method in class StateMachineTrait

Register Transition Callback which will be called when field values change according to defined transition

XQLCollectionTrait::applyXQLFilter() — Method in class XQLCollectionTrait

XQLCollectionTrait::applyXQLPagination() — Method in class XQLCollectionTrait

Apply XQL Pagination to current Collection

SystemDaemonThreaded::afterThreadFinished() — Method in class SystemDaemonThreaded

Gets called if a thread finishes It can be used e.g. to clean up unfinished work in case of an ABORTED exit status

Document::add_sidebar() — Method in class Document

Add Sidebar-Actions as section

UIAjaxComponent::add_url_parameter() — Method in class UIAjaxComponent

Adds a parameter to url parameter list.

UIAjaxComponent::add_dependency() — Method in class UIAjaxComponent

Add an UIAjaxComponent object and register it under a certain name.

UIAjaxComponent::addLinkedContainer() — Method in class UIAjaxComponent

Link a container that will also be reloaded, if an ajax link has the current container as target.

UIAjaxComponent::add_css_class() — Method in class UIAjaxComponent

Adds a custom css class to the root element of this component.

Config::add_array() — Method in class Config

$ MySQLAdapter#autocommit — Property in class MySQLAdapter

MySQLAdapter::auto_query() — Method in class MySQLAdapter

ConditionGroup::addCondition() — Method in class ConditionGroup

ConditionGroup::addConditionGroup() — Method in class ConditionGroup

Event::add_listener() — Method in class Event

IM::add_global_group_context_exclude() — Method in class IM

Add Instances which should be ignored when applying global group context

IM::add_include_path() — Method in class IM

$ Lib#ajax — Property in class Lib

Ajax — Class in namespace XELOS\Framework\XF\Lib

$ Ajax#ajax_call — Property in class Ajax

$ Ajax#ajax_version — Property in class Ajax

APCUCacheHandler — Class in namespace XELOS\Framework\XF\Lib\Cache

Cache Handler to use APCU as caching backend

Filehandler::add_file() — Method in class Filehandler

Filehandler::add_to_zip() — Method in class Filehandler

Foaf::add_follow_user() — Method in class Foaf

Add user as follower of an user

GroupSecurity::add_global_group() — Method in class GroupSecurity

GroupSecurity::add_group_member() — Method in class GroupSecurity

Add Member to security Group

GroupSecurity::add_follow_user() — Method in class GroupSecurity

Add user as follower for this group

FakeData::add_property() — Method in class FakeData

Logger::addHandler() — Method in class Logger

Adds the given handler. The handler starts the logging immanently.

Logger::addContext() — Method in class Logger

Logger::alert() — Method in class Logger

$ Mail#auth — Property in class Mail

Modsetup::add_module_to_registry() — Method in class Modsetup

Policy::applySimplePoliciesToPages() — Method in class Policy

When the simple policy mode is active: Applies the page policies based on the dynamic policy config.

Request::accepts_mime() — Method in class Request

Checks if the browser accepts the passed mime types for this request. Parameter can contain wildcards using fnmatch syntax $XF->lib->request->accepts_mime("text/*")

Request::accepts_html() — Method in class Request

Returns true of the requesting browser accepts text/html as response mime type

Request::accepts_image() — Method in class Request

Returns true of the requesting browser accepts image/* as response mime type

Request::accepts_json() — Method in class Request

Returns true of the requesting browser accepts application/json as response mime type

Sec::aes_encrypt() — Method in class Sec

encrypts a string and returns a binary string

Sec::aes_decrypt() — Method in class Sec

Sec::aes_encrypt_ctr() — Method in class Sec

AES Counter Encryption (PHP Based)

Sec::aes_decrypt_ctr() — Method in class Sec

AES Counter Decryption (PHP Based)

$ SecureEvalClass#allowedCalls — Property in class SecureEvalClass

Allowed PHP Functions

SecureEvalClass::allowHarmlessCalls() — Method in class SecureEvalClass

Allow harmless php functions to be used e.g. explode,implode,date,time,round,trunc,rand,ceil,floor,srand,strtolower,strtoupper,substr

Stats::add_entry() — Method in class Stats

$ UserImport#autoGeneratePassword — Property in class UserImport

$ UserImport#allowPasswordChange — Property in class UserImport

$ UserImport#autoGenerateLogin — Property in class UserImport

$ UserImport#autoGenerateDisplayname — Property in class UserImport

$ UserImport#afterPrepareCallback — Property in class UserImport

A callback to further prepare/change the $userData. First parameter is he $userData array and second parameter is the $user object

Token::addOccurence() — Method in class Token

Add a new occurence of this token in the sources

Token::addTranslation() — Method in class Token

Adds a new translation for the given locale

TokenCollection::add() — Method in class TokenCollection

Adds a Token object to this collection. If the token already exists the token will be merged with the existing one

DocumentIndexCollection::all() — Method in class DocumentIndexCollection

DocumentIndexReferenceCollection::all() — Method in class DocumentIndexReferenceCollection

GroupCollection::all() — Method in class GroupCollection

InstanceRegistryCollection::all() — Method in class InstanceRegistryCollection

ModuleGroupSecurityCollection::all() — Method in class ModuleGroupSecurityCollection

ModuleGroupSecurityMemberCollection::all() — Method in class ModuleGroupSecurityMemberCollection

ModuleRegistryCollection::all() — Method in class ModuleRegistryCollection

NotificationCollection::all() — Method in class NotificationCollection

UserCollection::all() — Method in class UserCollection

UserMetaCollection::all() — Method in class UserMetaCollection

$ Model#audit_trail — Property in class Model

$ Model#audit_policy — Property in class Model

AuditPolicy — Class in namespace XELOS\Framework\XF\System\Model

Class Audit Policy

AuditTrail — Class in namespace XELOS\Framework\XF\System\Model

Class AuditTrail

DocumentIndex::add_follow_user() — Method in class DocumentIndex

Add user as follower. Only add 'auto_follow', if user has no other status

DocumentIndex::add_reference() — Method in class DocumentIndex

Add Document Reference

DocumentIndex::addReferences() — Method in class DocumentIndex

Add References to other DocumentIndexes (attachments or content_references e.g. trendvote) Leaving existing references untouched Returns all currently existing references for the given type

Group::all() — Method in class Group

InstanceRegistry::all() — Method in class InstanceRegistry

$ Pages#admin — Property in class Pages

Enum with string values: true|false

$ Pages#active — Property in class Pages

Policy::all() — Method in class Policy

User::assign_security_group() — Method in class User

User::add_log() — Method in class User

Add Audit Log entry

User::add_avatar_image() — Method in class User

Sets the users avatar picture

User::anonymize() — Method in class User

Trigger user meta delete and set login, email null and shorten surname of an user

$ UserDevices#auth_token — Property in class UserDevices

: stored in MySQL as varchar

$ UserLink#active — Property in class UserLink

$ UI#associated_content — Property in class UI

$ UI#admin_links — Property in class UI

$ UI#admin_link_instances — Property in class UI

UI::admin_message() — Method in class UI

Stores the passed message as admin message until the message expires or is marked read

UI::add_css_file() — Method in class UI

UI::add_js_file() — Method in class UI

UI::add_i18n_js() — Method in class UI

UI::add_js_block() — Method in class UI

UI::add_feed_link() — Method in class UI

UI::add_admin_link() — Method in class UI

UI::add_admin_link_for_instance() — Method in class UI

Shows passed instance's admin links as additional links in admin bar

UI::add_primary_admin_link() — Method in class UI

UI::add_template_link() — Method in class UI

UI::amchart() — Method in class UI

AjaxContainer — Class in namespace XELOS\Framework\XF\UI

Class AjaxContainer

Amchart — Class in namespace XELOS\Framework\XF\UI

AmchartBar — Class in namespace XELOS\Framework\XF\UI\Amchart

AmchartChart — Class in namespace XELOS\Framework\XF\UI\Amchart

AmchartChart::add_listener() — Method in class AmchartChart

https://docs.amcharts.com/3/javascriptcharts/AmChart#events

AmchartGantt — Class in namespace XELOS\Framework\XF\UI\Amchart

AmchartGantt::add_segment() — Method in class AmchartGantt

Add a segment to a category

AmchartGantt::add_category() — Method in class AmchartGantt

AmchartPie — Class in namespace XELOS\Framework\XF\UI\Amchart

Breadcrumb::add_level() — Method in class Breadcrumb

Breadcrumb::add_link() — Method in class Breadcrumb

Browse::add_viewmode() — Method in class Browse

Add an additional viewmode to the xui. You must provide the name of the viewmode (usually "details" or "gallery"), as well as a template that will be used to render the content of an element for the viewmode.

Carousel::add_slide() — Method in class Carousel

Add a new Slide (HTML) to carousel HTML should include the proper formatting (height / size) as carousel scales to this size

DocumentView::add_sidebar() — Method in class DocumentView

Add Sidebar-Actions as section

Faceted::add_category() — Method in class Faceted

add new category for items beeing grouped by the short_id will be used as parameter

Faceted::add_item() — Method in class Faceted

add an item to the faceted. The category, this item belongs to has to be added before

FacetedFilter::addCategoryChoiceByItems() — Method in class FacetedFilter

Adds Choice category with manually defined items

FacetedFilter::addCategoryChoiceByModelProperty() — Method in class FacetedFilter

Adds a choice category, with options based on a model property.

FacetedFilter::addCategoryMultipleChoiceByItems() — Method in class FacetedFilter

Adds a MultipleChoice category with manually defined items

FacetedFilter::addCategoryMultipleChoiceByModelProperty() — Method in class FacetedFilter

Adds a multiple choice category, with options based on a model property.

FacetedFilter::addCategoryToggle() — Method in class FacetedFilter

Adds toogle category. Either all items are displayed, or only items with given active item condition.

FacetedFilter::addCategoryTextSearch() — Method in class FacetedFilter

Adds search field filter.

FacetedFilter::addCategoryDate() — Method in class FacetedFilter

Adds date range filter.

FacetedFilter::addActiveValue() — Method in class FacetedFilter

Adds $value to category with $categoryKey. Overwrites existing value.

FacetedFilter::applyFacetFilters() — Method in class FacetedFilter

Applies scopes of active facets to $collection. Scope of $excludeCategoryKey will not be applied.

FacetedLegacy::applyFacetFilters() — Method in class FacetedLegacy

Applies scope conditions of the facets for the given ModelCollection.

FacetedLegacy::add_category() — Method in class FacetedLegacy

FacetedLegacy::addCategory() — Method in class FacetedLegacy

adds a new category for items beeing grouped by the short_id will be used as parameter

FacetedLegacy::addFacetedCategory() — Method in class FacetedLegacy

adds a new category for items being grouped by the short_id will be used as parameter

FacetedLegacy::addFacetedCategories() — Method in class FacetedLegacy

adds multiple new categories for items being grouped by the short_id will be used as parameter

FacetedLegacy::add_item() — Method in class FacetedLegacy

FacetedLegacy::addItem() — Method in class FacetedLegacy

Adds an item to a category

FacetedCategory::autoBuildItems() — Method in class FacetedCategory

Extended class has to auto build its FacetedCategoryItems.

FacetedCategory::addScopeCondition() — Method in class FacetedCategory

Extended class has to add the scope condition for its category based on the $active (aka selected) values

FacetedCategory::addDefaultValue() — Method in class FacetedCategory

Adds a default value for this category.

FacetedCategoryChoice::autoBuildItems() — Method in class FacetedCategoryChoice

FacetedCategoryChoice::addScopeCondition() — Method in class FacetedCategoryChoice

FacetedCategoryChoice::addItem() — Method in class FacetedCategoryChoice

Adds a FacetedCategoryItem to the $item array

FacetedCategoryDate::addScopeCondition() — Method in class FacetedCategoryDate

FacetedCategoryDate::autoBuildItems() — Method in class FacetedCategoryDate

FacetedCategoryMultipleChoice::addScopeCondition() — Method in class FacetedCategoryMultipleChoice

FacetedCategoryTextSearch::addScopeCondition() — Method in class FacetedCategoryTextSearch

FacetedCategoryTextSearch::autoBuildItems() — Method in class FacetedCategoryTextSearch

FacetedCategoryToggle::addScopeCondition() — Method in class FacetedCategoryToggle

FacetedCategoryToggle::autoBuildItems() — Method in class FacetedCategoryToggle

FacetedCategoryToggle::addItem() — Method in class FacetedCategoryToggle

Adds an FacetedCategoryItem to the $items list

Form::add_field() — Method in class Form

Form::add_sfield() — Method in class Form

Add (String) Field (params as separate string parameters)

Form::add_required_sfield() — Method in class Form

Add required (String) Field (params as separate string parameters)

Form::addComponent() — Method in class Form

Adds the given form component object to the form as field.

Form::add_field_text() — Method in class Form

Add a Textbox to your form

Form::add_field_search() — Method in class Form

Add a Search field to your form

Form::add_field_email() — Method in class Form

Add an Email field to your form

Form::add_field_phone() — Method in class Form

Add an Phone field to your form

Form::add_field_number() — Method in class Form

Add an Number field to your form

Form::add_field_url() — Method in class Form

Add an URL field to your form

Form::add_field_textbox_list() — Method in class Form

Add a Textbox list to your form

Form::add_field_textarea() — Method in class Form

Add a Textbox to your form

Form::add_field_section_break() — Method in class Form

Add a section_break to your form

Form::add_field_fieldset() — Method in class Form

Add a Fieldset to your form

Form::add_field_fieldset_close() — Method in class Form

Add a Fieldset Close to your form

Form::add_field_hidden() — Method in class Form

Add a hidden field to your form

Form::add_field_static_text() — Method in class Form

Add a static_text field to your form

Form::add_field_tag() — Method in class Form

Add a tag field to your form

Form::add_field_password() — Method in class Form

Add a password field to your form

Form::add_field_select() — Method in class Form

Add a select field to your form

Form::add_field_icon_select() — Method in class Form

Add a icon select field to your form

Form::add_field_color() — Method in class Form

Add a color picker to your form

Form::add_field_checkbox() — Method in class Form

Add a checkbox field to your form

Form::add_field_radio() — Method in class Form

Add a radio field to your form

Form::add_field_datetime() — Method in class Form

Add a datetime field to your form

Form::add_field_multitext() — Method in class Form

Add a multitext field to your form

Form::add_field_description() — Method in class Form

Add a description field to your form

Form::add_field_static_value() — Method in class Form

Add a static_value field to your form

Form::add_field_date() — Method in class Form

Add a date field to your form

Form::add_field_toggle_switch() — Method in class Form

Add a toggle switch field to your form

Form::add_field_rrule() — Method in class Form

Add a recurring rule field (datetime variant) to your form

Form::add_field_slider() — Method in class Form

Add a slider field to your form

Form::add_field_webfetcher() — Method in class Form

Add a group_selector field to your form

Form::add_field_group_selector() — Method in class Form

Add a group_selector field to your form

Form::add_field_user_selector() — Method in class Form

Add an user_selector field to your form

Form::add_field_document() — Method in class Form

Add a document selector field to your form

Form::add_field_media_attachment() — Method in class Form

Add a media attachment field which may contain an image or video

Form::add_field_content_attachment() — Method in class Form

Add content attachment field which may contain several content references like trendvotes

Form::add_field_captcha() — Method in class Form

Add a captcha

Form::add_field_cat_selector() — Method in class Form

Add a cat_selector field to your form

Form::add_field_category_selector() — Method in class Form

Add a cat_selector for one of the customer categories defined in the selector module

Form::add_field_policy_selector() — Method in class Form

Add a policy_selector field to your form

Form::add_field_file() — Method in class Form

Add a file field to your form

Form::add_field_multifile() — Method in class Form

Add a file field to your form

Form::add_field_choice() — Method in class Form

Form::add_field_geo_selector() — Method in class Form

Form::add_button_submit() — Method in class Form

Add a save/submit button

Form::add_button_reset() — Method in class Form

Add a save/submit button

Form::add_button_cancel() — Method in class Form

Add a cancel button

Form::add_field_dyn_config() — Method in class Form

Add a field to edit the given config variable

Form::add_field_config() — Method in class Form

Add a field to edit the given config variable

Form::add_button() — Method in class Form

Form::add_loading_message() — Method in class Form

Add a loading indicator when the form is submitted

Form::add_row_renderer_multifield_row() — Method in class Form

Create a single field row containing multiple fields, e.g. a select box and a textfield in one row

Form::add_row_renderer_multirow_table() — Method in class Form

Create a table with multiple rows containing multiple fields.

Form::add_row_renderer() — Method in class Form

Add a new row renderer

Form::add_additional_filesource() — Method in class Form

Add a additional filesource for form file elements

Form::addAjaxFormCallback() — Method in class Form

Adds a callback of a certain type to the form, which will then be triggered whenever the form is about to send a XMLHttpRequest to the form action.

Form::add_obj() — Method in class Form

FormEditor::add_field_property() — Method in class FormEditor

Add custom properties to certain fields

FormEditor::add_field_item() — Method in class FormEditor

Add another field item

FormBase::append() — Method in class FormBase

$ FormConfig#args — Property in class FormConfig

FormDocument::addPasteSource() — Method in class FormDocument

Adds a DOM selector which is used to pasting clip board content.

FormDocument::addAdditionalUploadParam() — Method in class FormDocument

Helper method that can be used to add additional arguments as parameters for requests made when documents are added or changed.

FormPassword::addRepeatPasswordField() — Method in class FormPassword

Adds a password repeat field to the same form as this one with the same config and sets this field for the repeat password check.

FormPassword::addStrengthIndicator() — Method in class FormPassword

Adds a static text field to the form which contains a random password for the user and the password complexity indicator which changes when the user types in the password field.

$ FroalaEditorBuilder#attachmentInsertGroups — Property in class FroalaEditorBuilder

$ FroalaEditorBuilder#allowHTML — Property in class FroalaEditorBuilder

FroalaInsertGroup::addItem() — Method in class FroalaInsertGroup

FroalaOption::attribution() — Method in class FroalaOption

Remove the Powered By Froala message.

FroalaOption::autofocus() — Method in class FroalaOption

Focus the editor instance when the page is loaded.

FroalaOption::app() — Method in class FroalaOption

The static string value froala

FroalaOption::apiKey() — Method in class FroalaOption

The API key for Froala's Codox integration. You can obtain a key from your Wave account. Froala Editor activation instructions can be found here.

FroalaOption::autoStart() — Method in class FroalaOption

Set to true, if co-editing session should start automatically on init(config). Set to false to initialize but delay start the co-editing (see the start() client API). Default setting is true.

HtmlGeneric::appendContent() — Method in class HtmlGeneric

Append content to be surrounded by tags

HtmlGeneric::addAttribute() — Method in class HtmlGeneric

Add Attribute for this element

Import::add_field() — Method in class Import

$ JavaScript#append — Property in class JavaScript

Append Inline JS to body via add_js_block?

Js::add_tooltip() — Method in class Js

$ Math#a — Property in class Math

Paging::addLinkedContainer() — Method in class Paging

Table::add_row() — Method in class Table

Add Single Row Object to Table

Table::add_col() — Method in class Table

Schedule Add Col to Table

Table::add_col_callback() — Method in class Table

Schedule Add Callback to Table Col (Will transform an existing col)

Table::add_col_replace() — Method in class Table

Simple Replace Function to be used in callbacks

Table::actions() — Method in class Table

Register Actions with the table object

TableEditor::add_multi_action() — Method in class TableEditor

TableRow::add_field() — Method in class TableRow

TableRow::add_filter() — Method in class TableRow

TableRow::add_class() — Method in class TableRow

TableRow::add_row_attributes() — Method in class TableRow

TableActionHandler::addRowAction() — Method in class TableActionHandler

Action for the user per row

TableActionHandler::addBulkAction() — Method in class TableActionHandler

TableActionHandler::addSelectAction() — Method in class TableActionHandler

Actions for the user based on selected table records

TableActionHandler::addSelectAllAction() — Method in class TableActionHandler

Actions valid for all records in the data object

Tabs::add_tab() — Method in class Tabs

Tabs::add_tab_link() — Method in class Tabs

Tabs::add_tab_links() — Method in class Tabs

TimeLine::add_timeline_row() — Method in class TimeLine

Add a row to the timeline

TimeLineRow::add_time_range() — Method in class TimeLineRow

Add a time range to the row

Tree::add_field() — Method in class Tree

Tree::add_additional_listener() — Method in class Tree

$ VideoPlayer#autoplay — Property in class VideoPlayer

$ Wizard#ajax_reload_interval — Property in class Wizard

Wizard::add_step_callback() — Method in class Wizard

put your comment there.

Wizard::add_step() — Method in class Wizard

put your comment there.

Wizard::add_data() — Method in class Wizard

put your comment there.

$ User#authentication_methods — Property in class User

Loaded from Config during init()

$ View#args — Property in class View

ActiveDirectoryAction — Class in namespace XELOS\Modules\AdSync\Action

ActiveDirectoryAction::autodiscoverGroups() — Method in class ActiveDirectoryAction

Try to autodiscover all groups in Active Directory

AzureActiveDirectoryAction — Class in namespace XELOS\Modules\AdSync\Action

Read users from AAD via api_microsoft

AdSyncController — Class in namespace XELOS\Modules\AdSync

XELOS Active Directory Sync

Action — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Action::ActiveDirectory() — Method in class Action

Action::AzureActiveDirectory() — Method in class Action

$ Model#ad_cache — Property in class Model

Model::ad_cache() — Method in class Model

$ Main#action — Property in class Main

AdCache — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated\Model

This file provides property and method documentation for the model ad_cache.

$ AdCache#accountexpires: — Property in class AdCache

stored in MySQL as timestamp

$ AdCache#accountcontrol: — Property in class AdCache

set NORMAL_ACCOUNT|LOCKOUT|PASSWORD_EXPIRED

AdCache::all() — Method in class AdCache

Returns all models. Query params can be e.g. order_by

$ SynchStatus#action: — Property in class SynchStatus

enum synchronize|ignore|no_login|disabled

SynchStatus::all() — Method in class SynchStatus

Returns all models. Query params can be e.g. order_by

AdSyncNavigation — Class in namespace XELOS\Modules\AdSync\Hook\Dashboard

AdCache — Class in namespace XELOS\Modules\AdSync\Model

AdSyncTest — Class in namespace XELOS\Modules\AdSync\Tests\Codeception\Unit

PasswordAction::addPasswordChangeFieldsToForm() — Method in class PasswordAction

Adds password and password repeat fields to the given $form. $user has to be set, if this password field is for an existing user.

AdministrationController — Class in namespace XELOS\Modules\Administration

AdministrationControllerDocumentation — Class in namespace XELOS\Modules\Administration\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ AdministrationControllerDocumentation#action — Property in class AdministrationControllerDocumentation

Action — Class in namespace XELOS\Modules\Administration\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#authentication — Property in class Page

Page::authentication() — Method in class Page

LanguageSettingLanguageConfig::addFormFields() — Method in class LanguageSettingLanguageConfig

UserAccountUserConfig::addAdditionalFormURLParam() — Method in class UserAccountUserConfig

UserAccountUserConfig::addFacetedCategoriesForBadges() — Method in class UserAccountUserConfig

UserAdvancedUserAdminConfig::addAdditionalFormURLParam() — Method in class UserAdvancedUserAdminConfig

LanguageConfigInterface::addFormFields() — Method in class LanguageConfigInterface

Add form fields to the passed $form

$ UserAdminConfig#adminContext — Property in class UserAdminConfig

If hook is used in administration this var is set to true

UserStatusBadgeProviderInterface::addFacetedCategoriesForBadges() — Method in class UserStatusBadgeProviderInterface

ApiService — Class in namespace XELOS\Modules\Administration\Hook\Webservice

AuthenticationPage — Class in namespace XELOS\Modules\Administration\Page

AdministrationControllerTest — Class in namespace XELOS\Modules\Administration\Tests\Codeception\Unit

UserList::addAdditionalActionHandlersTop() — Method in class UserList

UserList::addAdditionalActionHandlersBottom() — Method in class UserList

ApiCloudstorageController — Class in namespace XELOS\Modules\ApiCloudstorage

Class ApiCloudstorageController

UploadDocumentProcessor::ajax() — Method in class UploadDocumentProcessor

StorageContent::add_folder() — Method in class StorageContent

StorageContent::add_file() — Method in class StorageContent

ApiCloudstorageDocumentBrowser — Class in namespace XELOS\Modules\ApiCloudstorage\Selector

Class ApiCloudstorageDocumentBrowser

ApiMicrosoftController — Class in namespace XELOS\Modules\ApiMicrosoft

Class ApiMicrosoftController

ApiMicrosoftNavigation — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Dashboard

$ CoAuthorDocumentProcessor#apiCloudStorage — Property in class CoAuthorDocumentProcessor

AzureAuthentication — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\System

$ AzureAuthentication#auth_title — Property in class AzureAuthentication

AzureAuthentication::afterLogin() — Method in class AzureAuthentication

ApiPage — Class in namespace XELOS\Modules\ApiMicrosoft\Page

AuthOpenidController — Class in namespace XELOS\Modules\AuthOpenid

OpenidAuthentication::afterLogin() — Method in class OpenidAuthentication

AuthSamlController — Class in namespace XELOS\Modules\AuthSaml

Action — Class in namespace XELOS\Modules\AuthSaml\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#action — Property in class Main

Action — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#action — Property in class Main

Calendar::all() — Method in class Calendar

Returns all models. Query params can be e.g. order_by

Calendarset::all() — Method in class Calendarset

Returns all models. Query params can be e.g. order_by

$ Event#availability: — Property in class Event

enum free|busy|with_reservations|absent

$ Event#allday: — Property in class Event

stored in MySQL as tinyint

$ Event#access_token: — Property in class Event

stored in MySQL as varchar

Event::all() — Method in class Event

Returns all models. Query params can be e.g. order_by

Participant::all() — Method in class Participant

Returns all models. Query params can be e.g. order_by

Reminder::all() — Method in class Reminder

Returns all models. Query params can be e.g. order_by

$ ReminderQueue#acknowledged_at: — Property in class ReminderQueue

stored in MySQL as timestamp

ReminderQueue::all() — Method in class ReminderQueue

Returns all models. Query params can be e.g. order_by

SyncData::all() — Method in class SyncData

Returns all models. Query params can be e.g. order_by

$ SyncSetting#active: — Property in class SyncSetting

stored in MySQL as tinyint

SyncSetting::all() — Method in class SyncSetting

Returns all models. Query params can be e.g. order_by

AgendaPortlet — Class in namespace XELOS\Modules\Calendar\Hook\Pages

Action — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#action — Property in class Main

Component::all() — Method in class Component

Returns all models. Query params can be e.g. order_by

ComponentLive::all() — Method in class ComponentLive

Returns all models. Query params can be e.g. order_by

History::all() — Method in class History

Returns all models. Query params can be e.g. order_by

HistoryComponent::all() — Method in class HistoryComponent

Returns all models. Query params can be e.g. order_by

$ HistoryPage#active: — Property in class HistoryPage

stored in MySQL as tinyint

HistoryPage::all() — Method in class HistoryPage

Returns all models. Query params can be e.g. order_by

$ Page#active: — Property in class Page

stored in MySQL as tinyint

Page::all() — Method in class Page

Returns all models. Query params can be e.g. order_by

$ PageLive#active: — Property in class PageLive

stored in MySQL as tinyint

PageLive::all() — Method in class PageLive

Returns all models. Query params can be e.g. order_by

$ Partial#active: — Property in class Partial

stored in MySQL as tinyint

Partial::all() — Method in class Partial

Returns all models. Query params can be e.g. order_by

$ PartialLive#active: — Property in class PartialLive

stored in MySQL as tinyint

PartialLive::all() — Method in class PartialLive

Returns all models. Query params can be e.g. order_by

Action — Class in namespace XELOS\Modules\Comments\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#action — Property in class Main

$ Comment#attachments: — Property in class Comment

stored in MySQL as text

Comment::all() — Method in class Comment

Returns all models. Query params can be e.g. order_by

LinkInfo::all() — Method in class LinkInfo

Returns all models. Query params can be e.g. order_by

ApiService — Class in namespace XELOS\Modules\Comments\Hook\Webservice

Comment::addAttachments() — Method in class Comment

Add attachments to comment and add reference

CrmControllerTest::alternativeProvider() — Method in class CrmControllerTest

$ DocviewProcessor#actions — Property in class DocviewProcessor

ActivityIndexerSearchPreprocessor — Class in namespace XELOS\Modules\Doclink\Hook\Search

ApiService — Class in namespace XELOS\Modules\Doclink\Hook\Webservice

CategoryCollection::all() — Method in class CategoryCollection

$ EventplannerControllerDocumentation#action — Property in class EventplannerControllerDocumentation

Action — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

CategoryDocumentation::all() — Method in class CategoryDocumentation

Returns all models. Query params can be e.g. order_by

$ EventDocumentation#allow_registration: — Property in class EventDocumentation

stored in MySQL as tinyint

$ EventDocumentation#allow_external_registration: — Property in class EventDocumentation

stored in MySQL as tinyint

$ EventDocumentation#auto_deadline_subject: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#auto_deadline_description: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#auto_max_subject: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#auto_max_description: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#attachment1: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#attachment2: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#attachment2_label: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#attachment3: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#attachment3_label: — Property in class EventDocumentation

stored in MySQL as varchar

EventDocumentation::all() — Method in class EventDocumentation

Returns all models. Query params can be e.g. order_by

InvitationReplyLogDocumentation::all() — Method in class InvitationReplyLogDocumentation

Returns all models. Query params can be e.g. order_by

JobDocumentation::all() — Method in class JobDocumentation

Returns all models. Query params can be e.g. order_by

$ ParticipantDocumentation#accompanying_persons — Property in class ParticipantDocumentation

$ ParticipantDocumentation#answers: — Property in class ParticipantDocumentation

stored in MySQL as text

$ ParticipantDocumentation#additional_fields: — Property in class ParticipantDocumentation

stored in MySQL as text

ParticipantDocumentation::all() — Method in class ParticipantDocumentation

Returns all models. Query params can be e.g. order_by

ParticipantLogDocumentation::all() — Method in class ParticipantLogDocumentation

Returns all models. Query params can be e.g. order_by

RelatedEventsDocumentation::all() — Method in class RelatedEventsDocumentation

Returns all models. Query params can be e.g. order_by

AgendaPortlet — Class in namespace XELOS\Modules\Eventplanner\Hook\Pages

Participant::addTodoNotification() — Method in class Participant

Add Notification for participant if possible

RelatedEvents::add_event() — Method in class RelatedEvents

AdminPage — Class in namespace XELOS\Modules\Eventplanner\Page

CategoryCollection::all() — Method in class CategoryCollection

ThreadCollection::all() — Method in class ThreadCollection

$ ForumControllerDocumentation#action — Property in class ForumControllerDocumentation

Action — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

CategoryDocumentation::all() — Method in class CategoryDocumentation

Returns all models. Query params can be e.g. order_by

$ PostDocumentation#attachments: — Property in class PostDocumentation

stored in MySQL as text

PostDocumentation::all() — Method in class PostDocumentation

Returns all models. Query params can be e.g. order_by

$ ThreadDocumentation#attachments — Property in class ThreadDocumentation

ThreadDocumentation::all() — Method in class ThreadDocumentation

Returns all models. Query params can be e.g. order_by

VotesDocumentation::all() — Method in class VotesDocumentation

Returns all models. Query params can be e.g. order_by

ApiService — Class in namespace XELOS\Modules\Forum\Hook\Webservice

Post::addAttachments() — Method in class Post

Add attachments and reference Stolen from Comment::addAttachments()

Thread::addAttachments() — Method in class Thread

Add attachments and reference Stolen from Comment::addAttachments()

EditPage::addFormFieldContentAttachment() — Method in class EditPage

Add a field of type 'form-content-attachments' to the given form, to add or edit content references, e.g. Trendvote.

ForumCest::adminCreatesCategory() — Method in class ForumCest

ForumCest::adminEditCategory() — Method in class ForumCest

ForumCest::adminEditDiscussion() — Method in class ForumCest

LocationCollection::all() — Method in class LocationCollection

InstallEvents::afterTableUpdate() — Method in class InstallEvents

GeoSelectorProcessor::addressLookup() — Method in class GeoSelectorProcessor

Looks up a certain address at the API endpoint.

RecurringTaskCollection::all() — Method in class RecurringTaskCollection

TaskCollection::all() — Method in class TaskCollection

TaskListCollection::all() — Method in class TaskListCollection

$ GroupsTasksControllerDocumentation#action — Property in class GroupsTasksControllerDocumentation

Action — Class in namespace XELOS\Modules\GroupsTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaskDocumentation#attachments: — Property in class TaskDocumentation

stored in MySQL as text

TaskDocumentation::all() — Method in class TaskDocumentation

Returns all models. Query params can be e.g. order_by

ApiService — Class in namespace XELOS\Modules\GroupsTasks\Hook\Webservice

GroupCollection::all() — Method in class GroupCollection

MemberCollection::all() — Method in class MemberCollection

Action — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#admin — Property in class Page

Page::admin() — Method in class Page

$ Main#action — Property in class Main

Category::all() — Method in class Category

Returns all models. Query params can be e.g. order_by

$ Group#archived: — Property in class Group

stored in MySQL as tinyint

$ Group#approved: — Property in class Group

stored in MySQL as tinyint

Group::all() — Method in class Group

Returns all models. Query params can be e.g. order_by

Invitation::all() — Method in class Invitation

Returns all models. Query params can be e.g. order_by

Member::all() — Method in class Member

Returns all models. Query params can be e.g. order_by

$ Module#active: — Property in class Module

stored in MySQL as tinyint

Module::all() — Method in class Module

Returns all models. Query params can be e.g. order_by

$ Newsletter#api_id — Property in class Newsletter

$ Newsletter#additional_recipients: — Property in class Newsletter

stored in MySQL as text

$ Newsletter#attachment: — Property in class Newsletter

stored in MySQL as text

Newsletter::all() — Method in class Newsletter

Returns all models. Query params can be e.g. order_by

Pending::all() — Method in class Pending

Returns all models. Query params can be e.g. order_by

ApiModuleService — Class in namespace XELOS\Modules\Groups\Hook\Webservice

ApiService — Class in namespace XELOS\Modules\Groups\Hook\Webservice

ArchiveGroupJob — Class in namespace XELOS\Modules\Groups\Infrastructure\Job

InstallEvents::afterModuleUpdate() — Method in class InstallEvents

Only called after module has been updated

LeaveApplicationCollection::all() — Method in class LeaveApplicationCollection

TravelCollection::all() — Method in class TravelCollection

TimesheetState::asArray() — Method in class TimesheetState

Get all available states

$ JobQueueControllerDocumentation#action — Property in class JobQueueControllerDocumentation

Action — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#api — Property in class Page

Page::api() — Method in class Page

JobDocumentation::all() — Method in class JobDocumentation

Returns all models. Query params can be e.g. order_by

JobHistoryDocumentation::all() — Method in class JobHistoryDocumentation

Returns all models. Query params can be e.g. order_by

JobScheduler::abort() — Method in class JobScheduler

Abort a job

BatchJob::addJob() — Method in class BatchJob

Adds a QueueableJob to this batch job

JobQueueController::abortJobsOnThreadError() — Method in class JobQueueController

Aborting jobs indicates an error case and is used internally from daemon threads

Job::abort() — Method in class Job

Mark this Job as aborted (error)

$ LegalControllerDocumentation#action — Property in class LegalControllerDocumentation

Action — Class in namespace XELOS\Modules\Legal\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#accessibility — Property in class Page

$ Page#admin — Property in class Page

Page::accessibility() — Method in class Page

Page::admin() — Method in class Page

$ PageDocumentation#attachment: — Property in class PageDocumentation

stored in MySQL as varchar

PageDocumentation::all() — Method in class PageDocumentation

Returns all models. Query params can be e.g. order_by

InstallEvents::afterTableUpdate() — Method in class InstallEvents

AccessibilityPage — Class in namespace XELOS\Modules\Legal\Page

Class Overview

AdminPage — Class in namespace XELOS\Modules\Legal\Page

Class Overview

FormprocessorAction::add_formdata() — Method in class FormprocessorAction

Add formdata to processor

FormprocessorAction::add_field_data() — Method in class FormprocessorAction

Add Field Data

$ ListsControllerDocumentation#action — Property in class ListsControllerDocumentation

Action — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

CategoryDocumentation::all() — Method in class CategoryDocumentation

Returns all models. Query params can be e.g. order_by

$ ListDocumentation#as_template: — Property in class ListDocumentation

stored in MySQL as tinyint

$ ListDocumentation#active: — Property in class ListDocumentation

stored in MySQL as tinyint

$ ListDocumentation#action_link_label: — Property in class ListDocumentation

stored in MySQL as varchar

$ ListDocumentation#action_link_url: — Property in class ListDocumentation

stored in MySQL as varchar

ListDocumentation::all() — Method in class ListDocumentation

Returns all models. Query params can be e.g. order_by

$ ListItemDocumentation#assigned_user_ids: — Property in class ListItemDocumentation

stored in MySQL as varchar

ListItemDocumentation::all() — Method in class ListItemDocumentation

Returns all models. Query params can be e.g. order_by

ListStatusDocumentation::all() — Method in class ListStatusDocumentation

Returns all models. Query params can be e.g. order_by

Field::addFormEditorProperties() — Method in class Field

Adds the properties of the current field to the form editor passed to this method.

Field::addTableFieldProperties() — Method in class Field

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Field::addWorkflowPlaceholders() — Method in class Field

Fills the placeholders needed for workflows.

Field::addFieldToFaceted() — Method in class Field

Adds a field to the faceted search by its specifications.

Field::addUniqueProperty() — Method in class Field

Every field, that makes use of this method, will implement the field property 'is_unique', setting the field unique.

Field::addDefaultFilterValue() — Method in class Field

Serves an OptionList with selectable values from this field. If null is returned, this field is not supposed to act as a filter (Textarea for example doesn't make a good filter - self explanatory).

AssignedUsers — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

AssignedUsers::addFormEditorProperties() — Method in class AssignedUsers

Adds the properties of the current field to the form editor passed to this method.

CategorySelector::addTableFieldProperties() — Method in class CategorySelector

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

CategorySelector::addWorkflowPlaceholders() — Method in class CategorySelector

Checkbox::addFormEditorProperties() — Method in class Checkbox

Adds the properties of the current field to the form editor passed to this method.

Checkbox::addTableFieldProperties() — Method in class Checkbox

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Checkbox::addDefaultFilterValue() — Method in class Checkbox

Date::addFormEditorProperties() — Method in class Date

Adds the properties of the current field to the form editor passed to this method.

Date::addTableFieldProperties() — Method in class Date

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Date::addFieldToFaceted() — Method in class Date

Date::addWorkflowPlaceholders() — Method in class Date

Date::addDefaultFilterValue() — Method in class Date

Datetime::addTableFieldProperties() — Method in class Datetime

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Datetime::addWorkflowPlaceholders() — Method in class Datetime

Document::addFormEditorProperties() — Method in class Document

Adds the properties of the current field to the form editor passed to this method.

Document::addTableFieldProperties() — Method in class Document

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Document::addWorkflowPlaceholders() — Method in class Document

Fieldset::addFormEditorProperties() — Method in class Fieldset

Adds the properties of the current field to the form editor passed to this method.

Fieldset::addFieldToFaceted() — Method in class Fieldset

Fieldset::addTableFieldProperties() — Method in class Fieldset

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

FriendlyId::addFormEditorProperties() — Method in class FriendlyId

Adds the properties of the current field to the form editor passed to this method.

FriendlyId::addTableFieldProperties() — Method in class FriendlyId

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

ListStatus::addFormEditorProperties() — Method in class ListStatus

Adds the properties of the current field to the form editor passed to this method.

ListStatus::addWorkflowPlaceholders() — Method in class ListStatus

ListStatus::addTableFieldProperties() — Method in class ListStatus

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

ListStatus::addFieldToFaceted() — Method in class ListStatus

Multitext::addTableFieldProperties() — Method in class Multitext

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Multitext::addDefaultFilterValue() — Method in class Multitext

Serves an OptionList with selectable values from this field. If null is returned, this field is not supposed to act as a filter (Textarea for example doesn't make a good filter - self explanatory).

PrefilledField::addFormEditorProperties() — Method in class PrefilledField

Adds the properties of the current field to the form editor passed to this method.

Radio::addFormEditorProperties() — Method in class Radio

Adds the properties of the current field to the form editor passed to this method.

Radio::addTableFieldProperties() — Method in class Radio

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

ResourceField::addTableFieldProperties() — Method in class ResourceField

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

ResourceField::addFieldToFaceted() — Method in class ResourceField

Asset — Class in namespace XELOS\Modules\Lists\Hook\Base\Field\Resource

Asset::addFormEditorProperties() — Method in class Asset

Adds the properties of the current field to the form editor passed to this method.

Room::addFormEditorProperties() — Method in class Room

Adds the properties of the current field to the form editor passed to this method.

Service::addFormEditorProperties() — Method in class Service

Adds the properties of the current field to the form editor passed to this method.

Ticket::addFormEditorProperties() — Method in class Ticket

Adds the properties of the current field to the form editor passed to this method.

SectionBreak::addFormEditorProperties() — Method in class SectionBreak

Adds the properties of the current field to the form editor passed to this method.

SectionBreak::addFieldToFaceted() — Method in class SectionBreak

Select::addFormEditorProperties() — Method in class Select

Adds the properties of the current field to the form editor passed to this method.

Select::addTableFieldProperties() — Method in class Select

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

StaticText::addFieldToFaceted() — Method in class StaticText

StaticText::addFormEditorProperties() — Method in class StaticText

Honestly... a static text doesn't need to be shown in a table, as filter or somewhere else that is not the form.

Tag::addFormEditorProperties() — Method in class Tag

Adds the properties of the current field to the form editor passed to this method.

Tag::addTableFieldProperties() — Method in class Tag

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Tag::addWorkflowPlaceholders() — Method in class Tag

Fills the placeholders needed for workflows.

Textarea::addDefaultFilterValue() — Method in class Textarea

Textbox::addFormEditorProperties() — Method in class Textbox

Adds the properties of the current field to the form editor passed to this method.

Textbox::addFieldToFaceted() — Method in class Textbox

Textbox::addDefaultFilterValue() — Method in class Textbox

Timespan::addFormEditorProperties() — Method in class Timespan

Adds the properties of the current field to the form editor passed to this method.

Timespan::addTableFieldProperties() — Method in class Timespan

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

Timespan::addFieldToFaceted() — Method in class Timespan

Adds three items for the timespan field to render past, current and future (upcoming) items.

Timespan::addDefaultFilterValue() — Method in class Timespan

ToggleSwitch::addTableFieldProperties() — Method in class ToggleSwitch

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

UserSelector::addFormEditorProperties() — Method in class UserSelector

Adds the properties of the current field to the form editor passed to this method.

UserSelector::addTableFieldProperties() — Method in class UserSelector

Adds field specific properties to the table, like callbacks, replaces and/or column formats.

UserSelector::addWorkflowPlaceholders() — Method in class UserSelector

Fills the placeholders needed for workflows.

UserSelector::addFieldToFaceted() — Method in class UserSelector

UserSelector::addDefaultFilterValue() — Method in class UserSelector

AbstractPortletContext — Class in namespace XELOS\Modules\Lists\Hook\Pages\Context

ApiService — Class in namespace XELOS\Modules\Lists\Hook\Webservice

Class ApiService

InstallEvents::afterTableUpdate() — Method in class InstallEvents

Called after SQL tranformations are applied to the database

$ ListItem#assigned_user_ids: — Property in class ListItem

stored in MySQL as text

$ ListProperties#as_template — Property in class ListProperties

Is a template?

$ ListProperties#active — Property in class ListProperties

Active

ListProperties::all() — Method in class ListProperties

ProfileCollection::applyStoredCondition() — Method in class ProfileCollection

ProfileCollection::all() — Method in class ProfileCollection

Action — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#advanced_search — Property in class Page

Page::advanced_search() — Method in class Page

$ Main#action — Property in class Main

Profile::all() — Method in class Profile

Returns all models. Query params can be e.g. order_by

ProfileProperty::all() — Method in class ProfileProperty

Returns all models. Query params can be e.g. order_by

Property::all() — Method in class Property

Returns all models. Query params can be e.g. order_by

PropertyGroup::all() — Method in class PropertyGroup

Returns all models. Query params can be e.g. order_by

PropertyTab::all() — Method in class PropertyTab

Returns all models. Query params can be e.g. order_by

PropertyTabGroup::all() — Method in class PropertyTabGroup

Returns all models. Query params can be e.g. order_by

Autocomplete — Class in namespace XELOS\Modules\Lookbook\Fields

SystemHierarchy::addSpecialValues() — Method in class SystemHierarchy

SystemUser::addSpecialValues() — Method in class SystemUser

SystemUserGroup::addSpecialValues() — Method in class SystemUserGroup

SystemUserMeta::addSpecialValues() — Method in class SystemUserMeta

FieldInterface::addSpecialValues() — Method in class FieldInterface

Adds special values to saved properties.

FieldTrait::addSpecialValues() — Method in class FieldTrait

Article — Class in namespace XELOS\Modules\News\CF

ArticleCollection — Class in namespace XELOS\Modules\News\Collection

ArticleCollection::all() — Method in class ArticleCollection

CategoryCollection::all() — Method in class CategoryCollection

Action — Class in namespace XELOS\Modules\News\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Model#article — Property in class Model

Model::article() — Method in class Model

ArticleDocumentation — Class in namespace XELOS\Modules\News\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Article.

$ ArticleDocumentation#auto_hide_time: — Property in class ArticleDocumentation

stored in MySQL as datetime

$ ArticleDocumentation#attachment1: — Property in class ArticleDocumentation

stored in MySQL as varchar

$ ArticleDocumentation#attachments: — Property in class ArticleDocumentation

stored in MySQL as text

ArticleDocumentation::all() — Method in class ArticleDocumentation

Returns all models. Query params can be e.g. order_by

CategoryDocumentation::all() — Method in class CategoryDocumentation

Returns all models. Query params can be e.g. order_by

$ NewsControllerDocumentation#action — Property in class NewsControllerDocumentation

ApiService — Class in namespace XELOS\Modules\News\Hook\Webservice

ArticlePayload — Class in namespace XELOS\Modules\News\Hook\Workflows

Class xwf_payload_news_article

ArticlePublishAction — Class in namespace XELOS\Modules\News\Hook\Workflows

Class xwf_action_news_article_enable_topnews

$ PublishJob#articleDocumentIndex — Property in class PublishJob

Article — Class in namespace XELOS\Modules\News\Model

$ Article#abspath — Property in class Article

$ Category#abspath — Property in class Category

Category::afterLoad() — Method in class Category

Copy feature settings values to property array

Article — Class in namespace XELOS\Modules\News\UI

ArticleList — Class in namespace XELOS\Modules\News\UI

Class ArticleList

PageApiAction::apiActionResponse() — Method in class PageApiAction

PageApiAction::apiActionToggleVisibility() — Method in class PageApiAction

Toggles the hidden flag for the passed page

ComponentCollection::all() — Method in class ComponentCollection

PageCollection::all() — Method in class PageCollection

PageVersionCollection::all() — Method in class PageVersionCollection

Action — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

PageComponentDocumentation::all() — Method in class PageComponentDocumentation

Returns all models. Query params can be e.g. order_by

PageDocumentation::all() — Method in class PageDocumentation

Returns all models. Query params can be e.g. order_by

PageVersionDocumentation::all() — Method in class PageVersionDocumentation

Returns all models. Query params can be e.g. order_by

$ PagesControllerDocumentation#action — Property in class PagesControllerDocumentation

CollectionOptionHelper::addCollectionOptionsFDL() — Method in class CollectionOptionHelper

Generate FDL for collection

CollectionOptionHelper::applyCollectionOptions() — Method in class CollectionOptionHelper

Apply scopes / options previously set. Function is NOT doing permission checks/scopes

ApiService — Class in namespace XELOS\Modules\Pages\Hook\Webservice

ApiService

InstallEvents::afterModuleUpdate() — Method in class InstallEvents

PageRenderer::applyToTemplate() — Method in class PageRenderer

Applies all page config attributes (e.g. stageMode, hideTitle) to the template

AdminPage — Class in namespace XELOS\Modules\PersonalWorkspace\Page

Class XELOS\Modules\PersonalWorkspace\Page\xpage_personal_workspace_admin

ConfirmationCollection::all() — Method in class ConfirmationCollection

DocumentCollection::all() — Method in class DocumentCollection

Action — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#admin — Property in class Page

Page::admin() — Method in class Page

ConfirmationDocumentation::all() — Method in class ConfirmationDocumentation

Returns all models. Query params can be e.g. order_by

DocumentDocumentation::all() — Method in class DocumentDocumentation

Returns all models. Query params can be e.g. order_by

$ ReadConfirmationControllerDocumentation#action — Property in class ReadConfirmationControllerDocumentation

AdminProcessor — Class in namespace XELOS\Modules\ReadConfirmation\Hook\Doclink

$ AdminProcessor#actions — Property in class AdminProcessor

AdminPage — Class in namespace XELOS\Modules\ReadConfirmation\Page

Class Overview

HistoryAction::addEntry() — Method in class HistoryAction

Stores the search term of the user in the history table.

IndexerAction::addToIndex() — Method in class IndexerAction

Adds the passed DocumentIndex to the search index

$ ElasticSearchAdapter#aliasAccessOnly — Property in class ElasticSearchAdapter

When we have limited access - we may need to reduce some requests or they will fail and throw errors

ElasticSearchAdapter::addToIndex() — Method in class ElasticSearchAdapter

QueryBuilder::addQueryFilter() — Method in class QueryBuilder

QueryBuilder::addBlackListFilter() — Method in class QueryBuilder

Applies the instance blacklist config.

QueryBuilder::addAccessibleInstanceFilter() — Method in class QueryBuilder

Adds all accessible instances to the query.

QueryBuilder::addModuleGroupSecurityFilter() — Method in class QueryBuilder

Adds the accessible group security IDs to the query.

QueryBuilder::addDocumentUpdatedAtAfterFilter() — Method in class QueryBuilder

Adds a filter to the query which only returns documents with an updated_at after the given timestamp.

AttachmentTrait — Class in namespace XELOS\Modules\Search\Adapter\Traits

Action — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

FacetedFilterDocumentation::all() — Method in class FacetedFilterDocumentation

Returns all models. Query params can be e.g. order_by

SearchHistoryDocumentation::all() — Method in class SearchHistoryDocumentation

Returns all models. Query params can be e.g. order_by

$ SearchagentDocumentation#active: — Property in class SearchagentDocumentation

stored in MySQL as tinyint

SearchagentDocumentation::all() — Method in class SearchagentDocumentation

Returns all models. Query params can be e.g. order_by

TermDocumentation::all() — Method in class TermDocumentation

Returns all models. Query params can be e.g. order_by

$ SearchControllerDocumentation#action — Property in class SearchControllerDocumentation

AgentPortletShowPortlet — Class in namespace XELOS\Modules\Search\Hook\Portal

ApiService — Class in namespace XELOS\Modules\Search\Hook\Webservice

InstallEvents::afterModuleUpdate() — Method in class InstallEvents

SearchAdapterInterface::addToIndex() — Method in class SearchAdapterInterface

$ SearchIndexRecord#attachments — Property in class SearchIndexRecord

SearchIndexRecord::appendIndexContent() — Method in class SearchIndexRecord

SearchIndexRecord::addLocalizedContent() — Method in class SearchIndexRecord

Adds an additional language variant of this document

SearchIndexRecord::addMetaData() — Method in class SearchIndexRecord

Allows to set a single key-value pair in the meta data

SearchUpdateRecord::addMetaData() — Method in class SearchUpdateRecord

Allows to set a single key-value pair in the meta data

AbstractBrowserItem — Class in namespace XELOS\Modules\Selector\Abstracts

Class AbstractBrowserItem

$ AbstractBrowserItem#author — Property in class AbstractBrowserItem

AbstractDocumentBrowser — Class in namespace XELOS\Modules\Selector\Abstracts

Class AbstractDocumentBrowser

$ AbstractDocumentBrowser#allowed_file_types — Property in class AbstractDocumentBrowser

AbstractDocumentBrowser::applyOperations() — Method in class AbstractDocumentBrowser

Applies operation settings based on the context of the document model.

ApiService — Class in namespace XELOS\Modules\Selector\Hook\Webservice

Class ApiService

$ BrowserFile#allowedOperations — Property in class BrowserFile

Action — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PageDocumentation#active: — Property in class PageDocumentation

stored in MySQL as tinyint

$ PageDocumentation#always_show_last_active: — Property in class PageDocumentation

stored in MySQL as tinyint

PageDocumentation::all() — Method in class PageDocumentation

Returns all models. Query params can be e.g. order_by

PageHistoryDocumentation::all() — Method in class PageHistoryDocumentation

Returns all models. Query params can be e.g. order_by

PageLinkDocumentation::all() — Method in class PageLinkDocumentation

Returns all models. Query params can be e.g. order_by

$ SmartWikiControllerDocumentation#action — Property in class SmartWikiControllerDocumentation

InstallEvents::afterTableUpdate() — Method in class InstallEvents

This method will be called after tables are uptodate.

$ Page#active — Property in class Page

ActivityCollection — Class in namespace XELOS\Modules\SystemActionlog\Collection

Activity Collection is essentially a DocumentIndexCollection loaded with relevance and follow filters

Action — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

DocumentWallItemDocumentation::all() — Method in class DocumentWallItemDocumentation

Returns all models. Query params can be e.g. order_by

$ EntryDocumentation#action_id — Property in class EntryDocumentation

EntryDocumentation::all() — Method in class EntryDocumentation

Returns all models. Query params can be e.g. order_by

HiddenInstanceDocumentation::all() — Method in class HiddenInstanceDocumentation

Returns all models. Query params can be e.g. order_by

$ SystemActionlogControllerDocumentation#action — Property in class SystemActionlogControllerDocumentation

WallIndexEventDocumentIndexEvent::add_action_by_indexer() — Method in class WallIndexEventDocumentIndexEvent

$ SystemActionlogController#active_for_instances — Property in class SystemActionlogController

SystemActionlogController::add_action() — Method in class SystemActionlogController

$ Main#action — Property in class Main

$ BackupQueue#action: — Property in class BackupQueue

enum backup|restore

BackupQueue::all() — Method in class BackupQueue

Returns all models. Query params can be e.g. order_by

EventTrigger::all() — Method in class EventTrigger

Returns all models. Query params can be e.g. order_by

InstallQueue::all() — Method in class InstallQueue

Returns all models. Query params can be e.g. order_by

LicenseProblem::all() — Method in class LicenseProblem

Returns all models. Query params can be e.g. order_by

CategoryDocumentCollection::applyXQLPagination() — Method in class CategoryDocumentCollection

Apply XQL Pagination to current Collection

ApiService — Class in namespace XELOS\Modules\SystemDMS\Hook\Webservice

Class ApiService

InstallEvents::afterTableUpdate() — Method in class InstallEvents

Called after SQL tranformations are applied to the database

Category::add_category() — Method in class Category

Creates a sub directory from a given name

Category::add_file() — Method in class Category

Attaches a file, creating a document within this category

$ Document#attach_new_file — Property in class Document

$ Document#action_logged — Property in class Document

$ Document#action_links — Property in class Document

Set with XELOS\Modules\SystemDMS\Model\xm_system_dms_document::attach_document_actions

Document::attach_file() — Method in class Document

Document::attach_document_actions() — Method in class Document

Attach action Links for a document Links that would be set on field 'action_links' as array

• lock
• delete (only if policy matches)
• edit (only if policy matches)
• detail
• download

DocumentTemplate::all() — Method in class DocumentTemplate

Return all models

$ SystemDMSController#action — Property in class SystemDMSController

SystemDMSController::allow_table_export() — Method in class SystemDMSController

show the export link above the files table

SystemDMSController::allow_add_document() — Method in class SystemDMSController

show the add document link above the files table

SystemDMSController::add_link() — Method in class SystemDMSController

Action — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#action — Property in class Main

Category::all() — Method in class Category

Returns all models. Query params can be e.g. order_by

Document::all() — Method in class Document

Returns all models. Query params can be e.g. order_by

DocumentHistory::all() — Method in class DocumentHistory

Returns all models. Query params can be e.g. order_by

DocumentMetaData::all() — Method in class DocumentMetaData

Returns all models. Query params can be e.g. order_by

DocumentMetaField::all() — Method in class DocumentMetaField

Returns all models. Query params can be e.g. order_by

DocumentTemplate::all() — Method in class DocumentTemplate

Returns all models. Query params can be e.g. order_by

FileTemplate::all() — Method in class FileTemplate

Returns all models. Query params can be e.g. order_by

Preview::all() — Method in class Preview

Returns all models. Query params can be e.g. order_by

ZipImportJob::all() — Method in class ZipImportJob

Returns all models. Query params can be e.g. order_by

AdminSystemMailUserAdminConfig — Class in namespace XELOS\Modules\SystemMail\Hook\Administration

$ UserSystemMailUserConfig#admin_mode — Property in class UserSystemMailUserConfig

Action — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ChannelSettingDocumentation#active — Property in class ChannelSettingDocumentation

ChannelSettingDocumentation::all() — Method in class ChannelSettingDocumentation

Returns all models. Query params can be e.g. order_by

$ UserSettingDocumentation#active — Property in class UserSettingDocumentation

UserSettingDocumentation::all() — Method in class UserSettingDocumentation

Returns all models. Query params can be e.g. order_by

$ SystemNotificationControllerDocumentation#action — Property in class SystemNotificationControllerDocumentation

ActivityUpdateFrontendHook — Class in namespace XELOS\Modules\SystemNotification\Hook\System

Action — Class in namespace XELOS\Modules\SystemPwa\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

PushSubscriptionDocumentation::all() — Method in class PushSubscriptionDocumentation

Returns all models. Query params can be e.g. order_by

$ SystemPwaControllerDocumentation#action — Property in class SystemPwaControllerDocumentation

EventCollection::all() — Method in class EventCollection

Action — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Model#aggregate_dimension — Property in class Model

$ Model#aggregate_numeric — Property in class Model

Model::aggregate_dimension() — Method in class Model

Model::aggregate_numeric() — Method in class Model

$ Ui#aggregation_chart — Property in class Ui

AggregateDimensionDocumentation — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\Model

This file provides property and method documentation for the model AggregateDimension.

$ AggregateDimensionDocumentation#active: — Property in class AggregateDimensionDocumentation

stored in MySQL as tinyint

AggregateDimensionDocumentation::all() — Method in class AggregateDimensionDocumentation

Returns all models. Query params can be e.g. order_by

AggregateNumericDocumentation — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\Model

This file provides property and method documentation for the model AggregateNumeric.

$ AggregateNumericDocumentation#aggregate_dimension_id — Property in class AggregateNumericDocumentation

AggregateNumericDocumentation::all() — Method in class AggregateNumericDocumentation

Returns all models. Query params can be e.g. order_by

EventDocumentation::all() — Method in class EventDocumentation

Returns all models. Query params can be e.g. order_by

$ SystemStatsControllerDocumentation#action — Property in class SystemStatsControllerDocumentation

InstallEvents::afterTableUpdate() — Method in class InstallEvents

Called after SQL tranformations are applied to the database

AggregateDimension — Class in namespace XELOS\Modules\SystemStats\Model

AggregateNumeric — Class in namespace XELOS\Modules\SystemStats\Model

AggregationChart — Class in namespace XELOS\Modules\SystemStats\UI

Displays the data for an aggregation dimension.

Action — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CheckDocumentation#active: — Property in class CheckDocumentation

stored in MySQL as tinyint

CheckDocumentation::all() — Method in class CheckDocumentation

Returns all models. Query params can be e.g. order_by

$ NodeDocumentation#active: — Property in class NodeDocumentation

stored in MySQL as tinyint

NodeDocumentation::all() — Method in class NodeDocumentation

Returns all models. Query params can be e.g. order_by

$ SystemStatusControllerDocumentation#action — Property in class SystemStatusControllerDocumentation

GlobalTaskCollection::add_scope_condition() — Method in class GlobalTaskCollection

GlobalTaskListCollection::add_scope_condition() — Method in class GlobalTaskListCollection

RecurringTaskCollection::all() — Method in class RecurringTaskCollection

TaskCollection::all() — Method in class TaskCollection

TaskListCollection::all() — Method in class TaskListCollection

Action — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

RecurringTaskDocumentation::all() — Method in class RecurringTaskDocumentation

Returns all models. Query params can be e.g. order_by

$ TaskDocumentation#attachments: — Property in class TaskDocumentation

stored in MySQL as text

TaskDocumentation::all() — Method in class TaskDocumentation

Returns all models. Query params can be e.g. order_by

$ SystemTasksControllerDocumentation#action — Property in class SystemTasksControllerDocumentation

ApiService — Class in namespace XELOS\Modules\SystemTasks\Hook\Webservice

Class ApiService

InstallEvents::afterTableUpdate() — Method in class InstallEvents

Called after SQL tranformations are applied to the database

$ Task#attachments — Property in class Task

$ Task#active_labels — Property in class Task

1,2,3,4,..

$ Task#archived_at — Property in class Task

Task::addAttachments() — Method in class Task

Add attachments to task and add reference

$ TaskList#auto_archive — Property in class TaskList

AdminPage — Class in namespace XELOS\Modules\SystemTasks\Page

BaseWorker::applyXELOSConfigurationParameters() — Method in class BaseWorker

Action — Class in namespace XELOS\Modules\SystemXelosApp\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#authenticate — Property in class Page

Page::authenticate() — Method in class Page

$ Main#action — Property in class Main

$ PushClient#access_token: — Property in class PushClient

stored in MySQL as varchar

$ PushClient#appversion: — Property in class PushClient

stored in MySQL as varchar

PushClient::all() — Method in class PushClient

Returns all models. Query params can be e.g. order_by

Action — Class in namespace XELOS\Modules\Tagging\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#admin — Property in class Page

Page::admin() — Method in class Page

TagDocumentation::all() — Method in class TagDocumentation

Returns all models. Query params can be e.g. order_by

$ TaggingControllerDocumentation#action — Property in class TaggingControllerDocumentation

InstallEvents::afterTableUpdate() — Method in class InstallEvents

AdminPage — Class in namespace XELOS\Modules\Tagging\Page

Class Overview

InstallEvents::afterModuleUpdate() — Method in class InstallEvents

Only called after module has been updated

Action — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

TranslationDocumentDocumentation::all() — Method in class TranslationDocumentDocumentation

Returns all models. Query params can be e.g. order_by

TranslationDocumentation::all() — Method in class TranslationDocumentation

Returns all models. Query params can be e.g. order_by

TranslationFeedbackDocumentation::all() — Method in class TranslationFeedbackDocumentation

Returns all models. Query params can be e.g. order_by

$ TranslationJobDocumentation#add_to_search_index: — Property in class TranslationJobDocumentation

stored in MySQL as tinyint

TranslationJobDocumentation::all() — Method in class TranslationJobDocumentation

Returns all models. Query params can be e.g. order_by

$ TranslationControllerDocumentation#action — Property in class TranslationControllerDocumentation

TranslationSettingsLanguageConfig::addFormFields() — Method in class TranslationSettingsLanguageConfig

ApiCheck — Class in namespace XELOS\Modules\Translation\Hook\SystemStatus

InstallEvents::afterTableUpdate() — Method in class InstallEvents

AjaxtranslatePage — Class in namespace XELOS\Modules\Translation\Page

Pages for the GECKO registration process.

$ Main#action — Property in class Main

$ Result#answers: — Property in class Result

stored in MySQL as text

Result::all() — Method in class Result

Returns all models. Query params can be e.g. order_by

$ Trendvote#answers: — Property in class Trendvote

stored in MySQL as text

Trendvote::all() — Method in class Trendvote

Returns all models. Query params can be e.g. order_by

ApiService — Class in namespace XELOS\Modules\Trendvote\Hook\Webservice

InstallEvents::afterModuleUpdate() — Method in class InstallEvents

$ Trendvote#answers — Property in class Trendvote

Action — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#admin — Property in class Page

Page::admin() — Method in class Page

FileDocumentation::all() — Method in class FileDocumentation

Returns all models. Query params can be e.g. order_by

ScanDocumentation::all() — Method in class ScanDocumentation

Returns all models. Query params can be e.g. order_by

$ VirusScanControllerDocumentation#action — Property in class VirusScanControllerDocumentation

AdminPage — Class in namespace XELOS\Modules\VirusScan\Page

Class Overview

DigestAuthentication::authorizeUserFromDigest() — Method in class DigestAuthentication

OAuthClientAction::authorize() — Method in class OAuthClientAction

Process Authorization flows for oauth_clients

OAuthServerAction::authorize() — Method in class OAuthServerAction

Authorize Clients

OAuthServerAction::authorize_api_access() — Method in class OAuthServerAction

API Access

OAuthServerAction::auth_error_response() — Method in class OAuthServerAction

Return Auth Error Response

Method::addInputParameter() — Method in class Method

Adds an input parameter to the method definition.

Method::addOutputParameter() — Method in class Method

Adds an output parameter to the method definition.

Method::addInputXQLParameterObject() — Method in class Method

ParameterObject::addMember() — Method in class ParameterObject

Adds an member variable to the complex type definition.

ParameterObject::addMemberArray() — Method in class ParameterObject

ParameterObject::addMemberExpand() — Method in class ParameterObject

ParameterObject::addFilter() — Method in class ParameterObject

XQL::applySelectionToParameterObject() — Method in class XQL

InstallEvents::afterTableUpdate() — Method in class InstallEvents

Only called after module has been updated

$ OAuthClient#authorizeUrl — Property in class OAuthClient

The Authorization Endpoint performs Authentication of the End-User.

$ OAuthClient#accessTokenUrl — Property in class OAuthClient

To obtain an Access Token, an ID Token, and optionally a Refresh Token, the RP (Client) sends a Token Request to the Token Endpoint to obtain a Token Response

$ OAuthClient#accessToken — Property in class OAuthClient

Access token Object representing string like accessToken an authorization issued to the client refreshToken see refreshToken

OAuthClient::addScope() — Method in class OAuthClient

Adds a new scope to the existing scopes.

$ OpenIDConfiguration#authorizationEndpoint — Property in class OpenIDConfiguration

AuthorizePage — Class in namespace XELOS\Modules\Webservice\Page

Class AuthorizePage

$ WebserviceController#action — Property in class WebserviceController

Action — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

CategoryDocumentation::all() — Method in class CategoryDocumentation

Returns all models. Query params can be e.g. order_by

$ WidgetDocumentation#active — Property in class WidgetDocumentation

WidgetDocumentation::all() — Method in class WidgetDocumentation

Returns all models. Query params can be e.g. order_by

$ WidgetsControllerDocumentation#action — Property in class WidgetsControllerDocumentation

ActionException — Class in namespace XELOS\Modules\Workflows\Exceptions

Class ActionException

ActionIntegrationTestBase — Class in namespace XELOS\Modules\Workflows\Tests\Codeception\Integration

This base class can be used for integration tests to check the workflow actions in a workflow process.

$ ActionIntegrationTestBase#ACTION_HOOK_NAME — Property in class ActionIntegrationTestBase

$ ActionIntegrationTestBase#ACTION_TITLE — Property in class ActionIntegrationTestBase

$ ActionIntegrationTestBase#ACTION_IDENTIFIER — Property in class ActionIntegrationTestBase

ActionMappingIntegrationTest — Class in namespace XELOS\Modules\Workflows\Tests\Codeception\Integration

This integration test checks if the mapping action is processed correctly in the dummy workflow.

$ ActionMappingIntegrationTest#ACTION_HOOK_NAME — Property in class ActionMappingIntegrationTest

ActionStartProcessIntegrationTest — Class in namespace XELOS\Modules\Workflows\Tests\Codeception\Integration

This integration test checks if the start process correctly starts another process.

$ ActionStartProcessIntegrationTest#ACTION_HOOK_NAME — Property in class ActionStartProcessIntegrationTest

ActionHeaderFieldsIntegrationTest — Class in namespace XELOS\Modules\Workflows\Tests\Codeception\Unit

This integration test checks if the header fields action is processed correctly in the dummy workflow.

$ ActionHeaderFieldsIntegrationTest#ACTION_HOOK_NAME — Property in class ActionHeaderFieldsIntegrationTest

$ ExampleSurveyControllerDocumentation#action — Property in class ExampleSurveyControllerDocumentation

Action — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Model#answer — Property in class Model

Model::answer() — Method in class Model

$ Page#admin — Property in class Page

Page::admin() — Method in class Page

AnswerDocumentation — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Answer.

AnswerDocumentation::all() — Method in class AnswerDocumentation

Returns all models. Query params can be e.g. order_by

ParticipantDocumentation::all() — Method in class ParticipantDocumentation

Returns all models. Query params can be e.g. order_by

$ SurveyDocumentation#active: — Property in class SurveyDocumentation

stored in MySQL as tinyint

SurveyDocumentation::all() — Method in class SurveyDocumentation

Returns all models. Query params can be e.g. order_by

Answer — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Model

AdminPage — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Page

xelos page, is automatically called based on the page param: http://www.example.com/module/PAGE

AdminPage::afterFormSave() — Method in class AdminPage

Save our questionnaire with a callback

B

Bootloader — Class in namespace XELOS\Framework

XELOS Bootloader

Bootloader::boot() — Method in class Bootloader

Boot the XELOS Bootloader The Boot sequence will load all necessary files and configurations to be able to use the XF Core Singleton afterwards.

BaseAuthentication — Class in namespace XELOS\Framework\Core\Authentication

Build — Class in namespace XELOS\Framework\Core\Console\Command

Class Cache

$ Input#binary — Property in class Input

Output::block() — Method in class Output

Output::box() — Method in class Output

Print Text in box Example: ┌─────────────────────┐ │ No changes detected │ └─────────────────────┘

AuthenticationException::bindToActiveDirectoryFailed() — Method in class AuthenticationException

Bind to Active Directory failed

BuilderInterface — Class in namespace XELOS\Framework\Core\Interfaces

Interface BuilderInterface

BuilderInterface::build() — Method in class BuilderInterface

Function should return BuildObject (e.g. ExampleBuilder should return Example) and should be your last step of your build chain

$ Template#block_id — Property in class Template

BaseHook — Class in namespace XELOS\Framework\Module\Hook

Class BaseHook

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

Called before SQL tranformations are applied to the database

ModelCollection::batchProcess() — Method in class ModelCollection

Runs the passed function batched for the passed amount of models to reduce memory issues while creating too many model objects at once This function should be called on an unloaded Collection to be most effective This method is ignoring any limits which might have been set on the scopeQuery!

SystemDaemonThreaded::beginThread() — Method in class SystemDaemonThreaded

Gets called within a thread before running the execite loop

SystemDaemonThreaded::beforeNewThreadStart() — Method in class SystemDaemonThreaded

Gets calles before a Thread is being started Use this place to e.g. initialize/update static caches which can be reused in each thread to avoid init within each thread

SystemDaemonThreaded::beforeProcess() — Method in class SystemDaemonThreaded

Gets called during each management process loop It can be used e.g. to clean up unfinished work in case of an ABORTED exit status

MySQLAdapter::begin_transaction() — Method in class MySQLAdapter

$ Lib#browser — Property in class Lib

Browser — Class in namespace XELOS\Framework\XF\Lib

Browser, Useragent Snippets

Debug::backtrace() — Method in class Debug

Print/Return backtrace in readable format

File::backup_to_trash() — Method in class File

Copies the passed file/folder to the trash folder

File::basename() — Method in class File

UTF8 Compatible basename(), because php::basename() is still buggy (e.g.: removes all umlauts at the beginning of a filename)

Format::build_telephone_number() — Method in class Format

builds a callable telephone number from given string.

Notification::bulk() — Method in class Notification

NotificationBuilder::build() — Method in class NotificationBuilder

Build Message

NotificationBuilder::buildAndPublish() — Method in class NotificationBuilder

Build in User Context and Create Notification Job for Notification Message

Policy::batch_calculate_policy_clusters_and_user_diffs() — Method in class Policy

Calculates all policy clusters as well as user diffs, thus updating the whole system right management WARNING: May take a few minutes and can cause performance lacks!

QueueableJobBuilder::build() — Method in class QueueableJobBuilder

QueueableJobBuilder::buildAndSchedule() — Method in class QueueableJobBuilder

Build QueueableJob and schedule it

Sort::by_array_value() — Method in class Sort

Sorts an array by a certain array value, e.g. $a[0]['name']='a'; $a[1]['name']='b'; by array value 'name'

Sort::by_obj_func() — Method in class Sort

Sorts an array by a certain array value, e.g. $a[0]['name']='a'; $a[1]['name']='b'; by array value 'name'

Sort::by_model_property() — Method in class Sort

Sorts a model collection by a certain model property

$ UserDevices#browser — Property in class UserDevices

: stored in MySQL as varchar

Breadcrumb — Class in namespace XELOS\Framework\XF\UI

Browse — Class in namespace XELOS\Framework\XF\UI

$ Form#buttons — Property in class Form

FroalaEditorBuilder::buildJs() — Method in class FroalaEditorBuilder

ButtonOptions — Class in namespace XELOS\Framework\XF\UI\Link

Options for Context Menu WebComponent

$ Math#b — Property in class Math

Wizard::buildControlBar() — Method in class Wizard

put your comment there.

Badge — Class in namespace XELOS\Modules\Administration\Lib

BadgeList — Class in namespace XELOS\Modules\Administration\Lib

BadgeTest — Class in namespace XELOS\Modules\Administration\Tests\Codeception\Unit

BadgeTest::badgeProvider() — Method in class BadgeTest

BadgeTest::badgeRenderProvider() — Method in class BadgeTest

BadgeTest::badgeToArrayProvider() — Method in class BadgeTest

$ ParticipantLogDocumentation#backtrace: — Property in class ParticipantLogDocumentation

stored in MySQL as varchar

$ ThreadDocumentation#best_answer_post_id — Property in class ThreadDocumentation

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

Called before SQL tranformations are applied to the database

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

BatchJob — Class in namespace XELOS\Modules\JobQueue\Infrastructure\Job

Class BatchJob (FOR INTERNAL TESTS ONLY) Should be used to execute many jobs at once

SystemDaemon::beginThread() — Method in class SystemDaemon

Called after a new Thread has been started. Is only called once per thread.

SystemDaemon::beforeProcess() — Method in class SystemDaemon

Check for Maintenance Tasks

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

$ Property#browse: — Property in class Property

stored in MySQL as tinyint

ArticleCollection::byFilterByYearAndMonth() — Method in class ArticleCollection

Filter by published_at of the given year and month.

$ ArticleDocumentation#body_plain_i18n: — Property in class ArticleDocumentation

stored in MySQL as mediumtext

$ ArticleDocumentation#body_rendered_i18n: — Property in class ArticleDocumentation

stored in MySQL as mediumtext

Category::beforeSave() — Method in class Category

Prepare feature settings values for DB save

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

Called before SQL tranformations are applied to the database

IndexerAction::buildNormalizedAttachments() — Method in class IndexerAction

Resolves the attachment array into file paths

ElasticSearchAdapter::bulkUpdateDocumentsByCallback() — Method in class ElasticSearchAdapter

Mass Update to update a few search index attributes for many documents at once This command will not create new Index entries but only update existing ones

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

BrowserFile — Class in namespace XELOS\Modules\Selector\Lib

Class BrowserFile

BrowserFolder — Class in namespace XELOS\Modules\Selector\Lib

Class BrowserFolder

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

This method will be called before table are updated.

BackupQueue — Class in namespace XELOS\Modules\SystemAdmin\Docs\ClassGenerated\Model

This file provides property and method documentation for the model BackupQueue.

$ BackupQueue#backup_type: — Property in class BackupQueue

enum full|slim|db_only

InstallEvents::beforeTableUpdate() — Method in class InstallEvents

Called before SQL tranformations are applied to the database

$ TaskList#background_image — Property in class TaskList

$ TaskList#background_color — Property in class TaskList

BaseWorker — Class in namespace XELOS\Modules\SystemWorker\Worker

CommonOperationsTrait::buildLangStrings() — Method in class CommonOperationsTrait

Builds a map of available system languages in $lang_strings: ['de' => 'DE_DE', 'en' => 'EN_GB', ...]

BaseTranslationApi — Class in namespace XELOS\Modules\Translation\Lib\Api

Class BaseTranslationApi

C

$ Autoloader#classmap_cache — Property in class Autoloader

Lookup Cache

$ Autoloader#class_is_loaded — Property in class Autoloader

Loaded Classes

$ Autoloader#class_alias — Property in class Autoloader

Class Alias Lookup

$ Autoloader#composer_autoloader_loaded — Property in class Autoloader

Identifies if the Composer Autoloader has already been loaded

Autoloader::composer_autoload_error_handler() — Method in class Autoloader

Error Handler to catch Fatal Error during Composer Autoload Init

Autoloader::clear_cache() — Method in class Autoloader

Forces all Code Caches to Reload (Classmap, OPCache,...) Should be called after a Code Deployment to enforce Revalidation

BaseAuthentication::convertFromOldSyntax() — Method in class BaseAuthentication

Convert xauth_method_name to MethodAuthentication

$ ActivedirectoryAuthentication#config_id — Property in class ActivedirectoryAuthentication

$ AlternativeLoginAuthentication#config_id — Property in class AlternativeLoginAuthentication

$ LdapAuthentication#config_id — Property in class LdapAuthentication

$ RadiusAuthentication#config_id — Property in class RadiusAuthentication

CommandDefinition — Class in namespace XELOS\Framework\Core\Console\Base

Class CommandDefinition

CommandSet — Class in namespace XELOS\Framework\Core\Console\Base

Class CommandSet

$ CommandSet#console — Property in class CommandSet

$ CommandSet#commandDefinitions — Property in class CommandSet

Cache — Class in namespace XELOS\Framework\Core\Console\Command

Class Cache

Check — Class in namespace XELOS\Framework\Core\Console\Command

Class Check

Composer — Class in namespace XELOS\Framework\Core\Console\Command

Class Composer

Config — Class in namespace XELOS\Framework\Core\Console\Command

Class Config

Cron — Class in namespace XELOS\Framework\Core\Console\Command

Class StartDaemon

Console — Class in namespace XELOS\Framework\Core\Console

Class Console

Console::createCommandSet() — Method in class Console

Creates a new instance of CommandSet by given command and optionally module name.

ConsoleLogger — Class in namespace XELOS\Framework\Core\Console

Class ConsoleLogger

CommandNotFoundException — Class in namespace XELOS\Framework\Core\Console\Exception

Class CommandNotFoundException

ConsoleException — Class in namespace XELOS\Framework\Core\Console\Exception

Class ConsoleException

$ Input#command — Property in class Input

Core — Class in namespace XELOS\Framework\Core

Class Core

$ Core#config — Property in class Core

$ Core#context — Property in class Core

Core::clear_template() — Method in class Core

Core::check_download_file() — Method in class Core

Enum::constants() — Method in class Enum

Returns all existing constants

AuthenticationException::connectionToActiveDirectoryFailed() — Method in class AuthenticationException

Connection to Active Directory failed

ComplianceException — Class in namespace XELOS\Framework\Core\Exception

Class ComplianceException

ContentException — Class in namespace XELOS\Framework\Core\Exception

Class ContentException

ActionHelper::create() — Method in class ActionHelper

Create Action

ActionHelper::createFromOption() — Method in class ActionHelper

CollectionActionHelper — Class in namespace XELOS\Framework\Core\Helper

MagicDocumentHelper::create() — Method in class MagicDocumentHelper

MagicDocumentHelperList::createFromDocumentCollection() — Method in class MagicDocumentHelperList

$ MagicMethodHelper#controller — Property in class MagicMethodHelper

MagicMethodHelper::call_object() — Method in class MagicMethodHelper

MagicMethodHelper::createObject() — Method in class MagicMethodHelper

$ XUILinkHelper#context — Property in class XUILinkHelper

BuilderInterface::create() — Method in class BuilderInterface

Function should return a BuilderObject

CollectionActionHandlerInterface — Class in namespace XELOS\Framework\Core\Interfaces

ItemListInterface::create() — Method in class ItemListInterface

Template::clear_marker_cache() — Method in class Template

Template::cb_gettext() — Method in class Template

Template::convert_to_xml() — Method in class Template

Convert String to XML Node

CoreLinkMethods — Class in namespace XELOS\Framework\Core\Traits

Trait CoreLinkMethods

ItemListTrait::create() — Method in class ItemListTrait

ItemListTrait::count() — Method in class ItemListTrait

$ VarsTemplate#culture: — Property in class VarsTemplate

stored in MySQL as char

$ VarsTemplate#custom: — Property in class VarsTemplate

stored in MySQL as tinyint

$ VarsTemplate#created_at: — Property in class VarsTemplate

stored in MySQL as timestamp

Controller — Class in namespace XELOS\Framework\Module

Class Controller

$ Controller#collection — Property in class Controller

$ Controller#cf — Property in class Controller

DocumentItem::create_new() — Method in class DocumentItem

Creates a new DocumentModel

DocumentItem::can_create_new() — Method in class DocumentItem

Returns TRUE if the current user may create new documents

DocumentItem::can_copy_to_another_instance() — Method in class DocumentItem

Returns true if this cf type allows copying documents to different instances.

DocumentItem::create_copy_document_in_instance() — Method in class DocumentItem

Copys a given document to another instance

$ ModulePortlet#caller_reference — Property in class ModulePortlet

Instance calling this portlet

ModulePortlet::convertToCmsFDLWithDefaults() — Method in class ModulePortlet

Set current portlet configuration as default values as expected with old CMS This will override currently set defaults

ModulePortlet::copyReferences() — Method in class ModulePortlet

Copies the references from the staging page to the live page as passive or read references.

Job::create() — Method in class Job

Collection — Class in namespace XELOS\Framework\Module\Model

Collection::create() — Method in class Collection

DocumentModel::can_read_global() — Method in class DocumentModel

This function checks wether this document can be read by the logged in user and takes the full hierarchy (parent instances) and all possible rights contexts into account

DocumentModel::can_read_global_in_rights_context() — Method in class DocumentModel

Evaluates can_read_global inside a specific rights context

DocumentModel::can_read() — Method in class DocumentModel

Must return false if the current document is not accessible by the current user

DocumentModel::can_read_comments() — Method in class DocumentModel

Returns whether this model should allow related comments or not. The user can still be denied comments when the comments policy "write" is not given to the user.

DocumentModel::can_write_comments() — Method in class DocumentModel

Returns whether this model should allow to create comments or not. The user can still be denied to write comments when the comments policy "write" is not given to the user.

DocumentModel::can_read_comments_global() — Method in class DocumentModel

Checks whether this model can be commented on.

DocumentModel::can_share() — Method in class DocumentModel

Returns true if this document can be shared with groups or users.

DocumentModel::can_write_global() — Method in class DocumentModel

This function checks wether this document can be read by the logged in user and takes the full hierarchy (parent instances) and all possible rights contexts into account

DocumentModel::can_write_global_in_rights_context() — Method in class DocumentModel

Evaluates can_write_global inside a specific rights context

DocumentModel::can_see() — Method in class DocumentModel

Can see defaults to can_read_global, but can be overridden by supporting modules (e.g. closed group should be visible but not readable)

DocumentModel::can_write() — Method in class DocumentModel

Must return false if the current document can not be modified by the current user

DocumentModel::can_reference() — Method in class DocumentModel

Checks whether this document can be linked with read reference.

$ Model#class_name — Property in class Model

$ Model#changed — Property in class Model

$ Model#cache_function_result — Property in class Model

Model::clear_properties() — Method in class Model

Model::clear_cached_functions() — Method in class Model

Clears the cache for all functions or a specific one

Model::count_by_TABLE_COL_and_TABLE_COL2() — Method in class Model

Returns the count of all models with the specific column value

Model::count_all() — Method in class Model

$ ModelCollection#canBeScoped — Property in class ModelCollection

ModelCollection cannot be scoped anymore if manual changes have been made

ModelCollection::count() — Method in class ModelCollection

Returns the number of containing models Attention: This will load all models of the collection Use $model_collection->count_all() for this case to determine count without loading all models Note: this function is called if the php function count(this_collection) is used

ModelCollection::countAll() — Method in class ModelCollection

Return the maximum number of items in this collection, will return the count of all items in the database if the collection is a scoped collection and ignore limits set. Will return local count for manual collections

ModelCollection::count_all() — Method in class ModelCollection

CollectionCacheTrait — Class in namespace XELOS\Framework\Module\Model\Traits

Trait CollectionCacheTrait can be applied to Model

SoftDeleteTrait::canForceDelete() — Method in class SoftDeleteTrait

Makes sure the soft delete minimum keep duration is observed.

SystemCron::check_for_existing_instances() — Method in class SystemCron

Checks if instances are available and set init state to abort (no process() call) if not

$ SystemDaemon#cmd_params — Property in class SystemDaemon

$ UIAjaxComponent#css_classes — Property in class UIAjaxComponent

$ XF#config — Property in class XF

$ XF#cron_id — Property in class XF

Config — Class in namespace XELOS\Framework\XF

Class Config

$ Config#config — Property in class Config

Config::clear() — Method in class Config

put your comment there.

$ DB#connection_retries — Property in class DB

$ MySQLAdapter#charset — Property in class MySQLAdapter

$ MySQLAdapter#connection_retries — Property in class MySQLAdapter

MySQLAdapter::can_create_tmp_tables() — Method in class MySQLAdapter

Can the current user create temporary tables?

MySQLAdapter::connect() — Method in class MySQLAdapter

Connects to the database

MySQLAdapter::check_query() — Method in class MySQLAdapter

Checks the passed SQL query string for system-wide table placeholder markers and returns the query with the corresponding replacements e.g. ###sys|tablename### will be replaced to use the correct system table prefix

MySQLAdapter::check_query_cb() — Method in class MySQLAdapter

put your comment there.

MySQLAdapter::close() — Method in class MySQLAdapter

Close DB Connection

MySQLAdapter::collect_debug_profiling() — Method in class MySQLAdapter

Collect Profiling Infos from Database if in DEVMODE

MySQLAdapter::commit() — Method in class MySQLAdapter

Condition — Class in namespace XELOS\Framework\XF\DB\QueryBuilder

Object to reflect SQL conditions

ConditionGroup — Class in namespace XELOS\Framework\XF\DB\QueryBuilder

Class ConditionGroup

ConditionGroup::create() — Method in class ConditionGroup

Query::clear() — Method in class Query

Clears all scopes and conditions

$ Lib#connect — Property in class Lib

$ Lib#convert — Property in class Lib

$ Lib#cache — Property in class Lib

Cache — Class in namespace XELOS\Framework\XF\Lib

$ Cache#connection_error — Property in class Cache

Cache::connect() — Method in class Cache

Connect to configured cache adapter

Cache::clear_cache() — Method in class Cache

Cache::clear_request_cache() — Method in class Cache

APCUCacheHandler::connect() — Method in class APCUCacheHandler

APCUCacheHandler::clear_cache() — Method in class APCUCacheHandler

APCUCacheHandler::check_for_clear() — Method in class APCUCacheHandler

Checks if a frontend cache clear is required.

CacheHandlerInterface — Class in namespace XELOS\Framework\XF\Lib\Cache\Interfaces

Interface xelos_cache_interface for Caching Backend Adapters

CacheHandlerInterface::connect() — Method in class CacheHandlerInterface

Connect to the Caching Backend

CacheHandlerInterface::clear_cache() — Method in class CacheHandlerInterface

Clear whole Cache

MemcacheCacheHandler::connect() — Method in class MemcacheCacheHandler

MemcacheCacheHandler::clear_cache() — Method in class MemcacheCacheHandler

RedisCacheHandler::connect() — Method in class RedisCacheHandler

RedisCacheHandler::clear_cache() — Method in class RedisCacheHandler

Connect — Class in namespace XELOS\Framework\XF\Lib

Connect::call() — Method in class Connect

Wrapper for magic function

Connect::checkRepoAuthentication() — Method in class Connect

Connects to the repository WSDL and checks if it returns a 401 / Authentication Error

Connect::checkRepoSSL() — Method in class Connect

Checks if a SSL connection can be established with the Repo server.

Convert — Class in namespace XELOS\Framework\XF\Lib

Debug::count() — Method in class Debug

Debug::console() — Method in class Debug

Function for silent mode stream output directly to your Browser debug console

$ File#curl_info — Property in class File

Contains the info returned by CURL when calling $this->download_file_from_url();

File::cp_r() — Method in class File

File::cp() — Method in class File

File::change_file_extension() — Method in class File

File::check_uploaded_file() — Method in class File

Checks files uploaded through forms for:

File::check_for_virus() — Method in class File

Check a file for virus If a virus is found TRUE is returned, otherwise FALSE To use this function ClamAV (Daemon) had to be installed and the user belonged to the webserver group

File::concatPaths() — Method in class File

Builds a path by concating multiple path elements It ensures all path elements use the proper separator when being glued and secures all elements to avoid relative escapes (../ is not allowed) to ensure e.g. frontend input can not escape folder

File::convertIniSizeToBytes() — Method in class File

Converts a PHP INI Size as memory_limit size string to a byte value

File::complete_absolute_url() — Method in class File

Complete an URL to be absolute

File::curl_header_cb() — Method in class File

callback function for getting header values from curl, used by download_file_from_url

Filehandler::checkTypes() — Method in class Filehandler

Filehandler::create_zip_archive() — Method in class Filehandler

Creates a ZIP archive of passed files and stores on HDD or sends it on the fly to the browser You should use this function instead of the separate functions above

Foaf::connect() — Method in class Foaf

Format::convert_letters_to_telephone_number() — Method in class Format

converts letters in given telephone number to corresponding numbers

GroupSecurity::clear_group_members() — Method in class GroupSecurity

Update Memberlist of security Group

Hierarchy::convert_context_id() — Method in class Hierarchy

Get Context ID

Html::content_tag() — Method in class Html

Helper function to create HTML tags with content (e.g. CONTENT)

Html::close_tag() — Method in class Html

Returns the specified closing tag

$ I18n#culture — Property in class I18n

$ I18n#conventions — Property in class I18n

I18n::check_i18n_support() — Method in class I18n

I18n::clear_message_vars() — Method in class I18n

Clear Message Vars

I18n::convert_i18n_sql() — Method in class I18n

Converts given SQL containing i18n fields with user specific user language fields Example: SELECT name_i18n FROM test is converted to SELECT name_DE_DE as name_i18n FROM test Example2: SELECT name_i18n AS name FROM test is converted to SELECT name_DE_DE AS name FROM test

CsvImport — Class in namespace XELOS\Framework\XF\Lib\Installer\Seed

Class CsvImport Import Helper to use CSV files for model generation. The helper loops through all rows, generates a new model and passed the columns as property. Use the provided set_before_model_save() and set_after_model_save() to add custom code to be executed during the creation, e.g. if you need to call a custom model function or you need to convert data prior saving.

FakeData::create() — Method in class FakeData

$ Link#context — Property in class Link

$ Link#context_id — Property in class Link

$ Link#context_counter — Property in class Link

Link::cb_clean_arguments() — Method in class Link

Link::check_header() — Method in class Link

Check Header

DatabaseHandlerFactory::create() — Method in class DatabaseHandlerFactory

DefaultStreamHandlerFactory::create() — Method in class DefaultStreamHandlerFactory

DisplayHandlerFactory::create() — Method in class DisplayHandlerFactory

GelfHandlerFactory::create() — Method in class GelfHandlerFactory

NativeMailHandlerFactory::create() — Method in class NativeMailHandlerFactory

ThreadedStreamHandlerFactory::create() — Method in class ThreadedStreamHandlerFactory

HandlerFactoryInterface::create() — Method in class HandlerFactoryInterface

Returns a new instance of HandlerInterface.

$ Logger#context — Property in class Logger

Global context data used by all stream handlers.

Logger::closeHandler() — Method in class Logger

Close an active handler.

Logger::critical() — Method in class Logger

Mail::create() — Method in class Mail

Creates an email and returns the mail object

Mail::complete_html_links_cb() — Method in class Mail

Make relative links absolute to the current server

Modsetup::create_tables() — Method in class Modsetup

Modsetup::create_structure_array() — Method in class Modsetup

Modsetup::create_table_by_structure() — Method in class Modsetup

Modsetup::check_config_variables() — Method in class Modsetup

Modsetup::check_config_page() — Method in class Modsetup

Modsetup::check_systemconfig_variables() — Method in class Modsetup

Modsetup::check_cron() — Method in class Modsetup

Modsetup::check_daemon() — Method in class Modsetup

Check and Install Daemons

Modsetup::check_policies() — Method in class Modsetup

Modsetup::create_datasources() — Method in class Modsetup

Modsetup::create_dependencies() — Method in class Modsetup

Modsetup::check_shellplugin_availability() — Method in class Modsetup

Checks all registered integrations for their availability and updates the integration database

Modsetup::compare_pages_and_instance_registry() — Method in class Modsetup

Navigation::clearDynTreeCache() — Method in class Navigation

Clears cached dyntree entries

Notification::count_messages() — Method in class Notification

Count messages of types $status

Notification::count_todos() — Method in class Notification

Count todos

Notification::count_activity() — Method in class Notification

Count notifications

$ NotificationBuilder#CTAUrl — Property in class NotificationBuilder

NotificationBuilder::create() — Method in class NotificationBuilder

$ Privacy#custom_values — Property in class Privacy

Privacy::check() — Method in class Privacy

QueueableJobBuilder::create() — Method in class QueueableJobBuilder

QueueableJobBuilder::cancelAllByReferenceKey() — Method in class QueueableJobBuilder

QueueableJobBuilder::cancelByJobUniqueIdAndClass() — Method in class QueueableJobBuilder

Cancels job via $uniqueId and job class name

Quota::convert_unit() — Method in class Quota

Converts and returns the given size from one unit to other.

Quota::can_allocate() — Method in class Quota

Returns whether the given filesize can be allocated.

Sec::calculate_totp_code() — Method in class Sec

Calculate TOTP based on https://github.com/Dolondro/google-authenticator/blob/master/src/GoogleAuthenticator.php

Session::close() — Method in class Session

Call session_write_close function

Session::clear() — Method in class Session

Clear the passed Session key

Session::clean_session() — Method in class Session

Sets is_dirty flag to 0

SessionDirtyFlagStorageInterface::clean_user_session() — Method in class SessionDirtyFlagStorageInterface

Marks the session for the givven session_id as clean

SessionManagementInterface::connect() — Method in class SessionManagementInterface

Connect the Session Storage Handler and register via session_set_save_handler

NonpersistentSessionHandler::close() — Method in class NonpersistentSessionHandler

RedisSessionHandler::connect() — Method in class RedisSessionHandler

Connect to REDIS Service and Register Session Serializer in PHP if Connection was successful

SqlSessionHandler::close() — Method in class SqlSessionHandler

Closes the current session

SqlSessionHandler::clean_user_session() — Method in class SqlSessionHandler

Marks the session for the givven session_id as clean

SqlSessionHandler::connect() — Method in class SqlSessionHandler

Connect the Session Storage Handler and register via session_set_save_handler

Shell::command_exist() — Method in class Shell

Check if a certain command exists in Linux

Text::convert_to_utf8() — Method in class Text

Converts the passed string to UTF8 (auto detects current encoding) Required mbstring PHP Support!

Text::close_html_tags() — Method in class Text

close unclosed html tags

Text::convertToPlainText() — Method in class Text

Convert mixed text/html to text without entities and html This is NOT a replacement for XF->lib->sec

Threading::call_func_multithreaded() — Method in class Threading

Calls a Function with a number of number of different parameters via multi-threading.

Threading::call_user_func_array_in_new_process() — Method in class Threading

Starts a function in a new process. Returns the process id of the newly spawned process.. The called function should be self sustained, i.e. you cannot access any return params

DocumentIndexCollection::create() — Method in class DocumentIndexCollection

DocumentIndexReferenceCollection::create() — Method in class DocumentIndexReferenceCollection

GroupCollection::createOptionFromModel() — Method in class GroupCollection

GroupCollection::create() — Method in class GroupCollection

InstanceRegistryCollection::createOptionFromModel() — Method in class InstanceRegistryCollection

InstanceRegistryCollection::createOptionFromKey() — Method in class InstanceRegistryCollection

InstanceRegistryCollection::create() — Method in class InstanceRegistryCollection

ModuleGroupSecurityCollection::createOptionFromModel() — Method in class ModuleGroupSecurityCollection

ModuleGroupSecurityCollection::create() — Method in class ModuleGroupSecurityCollection

ModuleGroupSecurityMemberCollection::create() — Method in class ModuleGroupSecurityMemberCollection

ModuleRegistryCollection::createOptionFromKey() — Method in class ModuleRegistryCollection

ModuleRegistryCollection::createOptionFromModel() — Method in class ModuleRegistryCollection

ModuleRegistryCollection::create() — Method in class ModuleRegistryCollection

NotificationCollection::create() — Method in class NotificationCollection

UserCollection::createOptionFromModel() — Method in class UserCollection

UserCollection::create() — Method in class UserCollection

UserMetaCollection::createOptionFromModel() — Method in class UserMetaCollection

UserMetaCollection::create() — Method in class UserMetaCollection

$ Model#cron — Property in class Model

Cron — Class in namespace XELOS\Framework\XF\System\Model

$ DocumentIndex#canonical — Property in class DocumentIndex

$ DocumentIndex#canonical_parent — Property in class DocumentIndex

$ DocumentIndex#canonical_grandparent — Property in class DocumentIndex

$ DocumentIndex#canonical_greatgrandparent — Property in class DocumentIndex

DocumentIndex::clear_cache() — Method in class DocumentIndex

Clear local static cache of document indexes

DocumentIndex::create_job() — Method in class DocumentIndex

creates a new job and stores directly to db

DocumentIndex::change_title() — Method in class DocumentIndex

Changes the title of the document index, publishing the change to the related document.

DocumentIndex::can_read() — Method in class DocumentIndex

Wrapper of original function

DocumentIndex::can_read_global() — Method in class DocumentIndex

Wrapper of original function

DocumentIndex::can_see() — Method in class DocumentIndex

Wrapper of original function

DocumentIndex::can_write() — Method in class DocumentIndex

Wrapper of original function

DocumentIndex::can_write_global() — Method in class DocumentIndex

Wrapper of original function

DocumentIndex::can_read_comments() — Method in class DocumentIndex

DocumentIndex::can_read_comments_global() — Method in class DocumentIndex

Checks whether the related document model is allowing comments.

DocumentIndexJobQueueHistory::cleanupOldEntries() — Method in class DocumentIndexJobQueueHistory

Removes history entries which are older than the passed number of days

$ DocumentIndexLock#created_at — Property in class DocumentIndexLock

$ DocumentIndexPolicyCluster#created_at — Property in class DocumentIndexPolicyCluster

$ Group#created_at — Property in class Group

Group::calculateInheritedGroupIds() — Method in class Group

Calculates all inherited group ids of every group

$ Hierarchy#context_id — Property in class Hierarchy

Refers to hierarchy_context

HierarchyContext::create_hierarchy_from_array() — Method in class HierarchyContext

Create hierarchy node structure from tree array

I18nLanguage::count_by_status() — Method in class I18nLanguage

$ I18nToken#culture — Property in class I18nToken

Culture

$ I18nToken#custom — Property in class I18nToken

Custom

Navigation::can_read() — Method in class Navigation

Navigation::can_write() — Method in class Navigation

Must return false if the current document can not be modified by the current user

$ Notification#created_at — Property in class Notification

Time when the notification was first created in DB

$ NotificationRegistry#custom_priority — Property in class NotificationRegistry

low,medium,high

$ OnboardingCode#code — Property in class OnboardingCode

$ OnboardingCode#created_at — Property in class OnboardingCode

OnboardingCode::create() — Method in class OnboardingCode

Helper to create valid onboarding code for a user, this function will automatically create the code / pin for you

OnboardingCode::checkPin() — Method in class OnboardingCode

ThemeSet::compile() — Method in class ThemeSet

Compile Theme Set

User::can_write() — Method in class User

Determines if current working user is able to edit this user model

User::can_see() — Method in class User

Determines if current working user can see this user model

$ UserDevices#country — Property in class UserDevices

: stored in MySQL as varchar

$ UserDevices#created_at — Property in class UserDevices

: stored in MySQL as timestamp

$ UserLink#created_at — Property in class UserLink

$ UI#css_files — Property in class UI

$ UI#css_files_meta — Property in class UI

UI::catch_before_redirect() — Method in class UI

Is being triggered before the page get's redirected

UI::clear_css_files() — Method in class UI

UI::clear_js_files() — Method in class UI

UI::convert_www_to_hdd_path() — Method in class UI

Converts a ressourc web path to the local hdd path

UI::Carousel() — Method in class UI

$ AmchartChart#chart_options — Property in class AmchartChart

$ AmchartChart#colors — Property in class AmchartChart

Calendar — Class in namespace XELOS\Framework\XF\UI

Callback — Class in namespace XELOS\Framework\XF\UI

Carousel — Class in namespace XELOS\Framework\XF\UI

Class Carousel

Container — Class in namespace XELOS\Framework\XF\UI

Class Container

$ Container#content — Property in class Container

Country — Class in namespace XELOS\Framework\XF\UI

$ Country#country_id — Property in class Country

Css — Class in namespace XELOS\Framework\XF\UI

$ Css#condition — Property in class Css

$ FacetedCategory#callback — Property in class FacetedCategory

FacetedCategory::createCategory() — Method in class FacetedCategory

Class to create the category

FacetedCategoryChoice::createCategory() — Method in class FacetedCategoryChoice

FacetedCategoryDate::createCategory() — Method in class FacetedCategoryDate

FacetedCategoryItem::create() — Method in class FacetedCategoryItem

FacetedCategoryList::create() — Method in class FacetedCategoryList

FacetedCategoryMultipleChoice::createCategory() — Method in class FacetedCategoryMultipleChoice

FacetedCategoryTextSearch::createCategory() — Method in class FacetedCategoryTextSearch

FacetedCategoryToggle::createCategory() — Method in class FacetedCategoryToggle

Form::cb_model_get_property() — Method in class Form

Form::close_form() — Method in class Form

Form::close_fieldset() — Method in class Form

FormEditor::change_field_spec() — Method in class FormEditor

Add custom properties to certain fields

$ FormBase#config — Property in class FormBase

FormBase::concat() — Method in class FormBase

FormChoice::convertInputValueToArray() — Method in class FormChoice

Convert the given $value and ensures the value to be a usable array (e.g.: (string)"['1']" into: array(['1'])).

FormChoice::createFromLegacyFormComponent() — Method in class FormChoice

Create FormChoice for a legacy FormComponent

FormDocument::convertDefaultValue() — Method in class FormDocument

Converts the value as string representation into an array with values.

FormDocument::clear() — Method in class FormDocument

Clears (remove) the temp folder

$ FormPolicySelector#cols — Property in class FormPolicySelector

$ FormRowRenderer#column_width — Property in class FormRowRenderer

$ FormRowRenderer#css_classes — Property in class FormRowRenderer

FroalaEditorBuilder::createAttachmentInsertGroup() — Method in class FroalaEditorBuilder

Creates a new toolbar dropdown menu with custom entries.

FroalaEditorBuilder::createPreviewInsertGroup() — Method in class FroalaEditorBuilder

Creates a new toolbar dropdown menu with custom entries.

FroalaOption::charCounterCount() — Method in class FroalaOption

Enables or disables the display of the character counter.

FroalaOption::charCounterMax() — Method in class FroalaOption

The maximum number of characters allowed to be inserted into the rich text editor. -1 means that there is not limit set.

FroalaOption::codeBeautifierOptions() — Method in class FroalaOption

Specify the options for Code Beautifier.

FroalaOption::codeMirror() — Method in class FroalaOption

Disable or enable using the CodeMirror library to highlight the HTML view.
Note: This option requires the CodeMirror library to be included.

FroalaOption::codeMirrorOptions() — Method in class FroalaOption

Specify the options for CodeMirror.

FroalaOption::codeViewKeepActiveButtons() — Method in class FroalaOption

A list of buttons to keep active while editor is in Code View mode.

FroalaOption::colorsBackground() — Method in class FroalaOption

An array of colors used in the colors popup for background. Passing REMOVE as a value in the array will display the Clear Formatting button for colors.

FroalaOption::colorsButtons() — Method in class FroalaOption

Set the buttons the colors popup.

FroalaOption::colorsHEXInput() — Method in class FroalaOption

Show HEX input to choose custom color.

FroalaOption::colorsStep() — Method in class FroalaOption

The number of colors displayed on a line in the colors popup.

FroalaOption::colorsText() — Method in class FroalaOption

An array of colors used in the colors popup for text. Passing REMOVE as a value in the array will display the Clear Formatting button for colors.

FroalaOption::codoxOptions() — Method in class FroalaOption

Set options for codox plugin.

Option::create() — Method in class Option

OptionList::create() — Method in class OptionList

OptionListCollectionInterface::createOptionFromModel() — Method in class OptionListCollectionInterface

OptionListProcessorInterface::countAll() — Method in class OptionListProcessorInterface

Returns the count of all elements.

OptionListProcessorInterface::createOptionFromKey() — Method in class OptionListProcessorInterface

OptionListCollectionTrait::createOptionFromKey() — Method in class OptionListCollectionTrait

OptionListCollectionTrait::createOptionFromModel() — Method in class OptionListCollectionTrait

Html::createElement() — Method in class Html

$ HtmlUlList#class — Property in class HtmlUlList

$ Image#class — Property in class Image

Import::clear_tmp_data() — Method in class Import

Clear temp data

$ Instance#cmd — Property in class Instance

CallbackRendererInterface — Class in namespace XELOS\Framework\XF\UI\Interfaces

$ Item#created_at — Property in class Item

Js::create_dialog() — Method in class Js

$ Link#current_link — Property in class Link

MenuList::create() — Method in class MenuList

MenuList::createFromLinks() — Method in class MenuList

Create MenuList from legacy link array

MenuList::createFromRemoteURL() — Method in class MenuList

MenuListItem::create() — Method in class MenuListItem

MenuListItem::createEmpty() — Method in class MenuListItem

MenuListItem::createFromLink() — Method in class MenuListItem

ModalDialog::create() — Method in class ModalDialog

Options::create() — Method in class Options

$ Portlet#class — Property in class Portlet

$ ProgressBar#compact — Property in class ProgressBar

$ Reactions#compact_mode — Property in class Reactions

$ Table#cmd_array — Property in class Table

Table::cb_property() — Method in class Table

$ TableRow#col_count — Property in class TableRow

$ TimeLine#current_year — Property in class TimeLine

$ Tree#caption_field — Property in class Tree

$ Tree#caption_label — Property in class Tree

$ Tree#caption_label_i18n — Property in class Tree

$ Tree#css_item_class — Property in class Tree

$ Tree#css_icon_class — Property in class Tree

$ Tree#current_id — Property in class Tree

Tree::create_tree_array() — Method in class Tree

Tree::create_tree_path() — Method in class Tree

$ UserImage#class — Property in class UserImage

$ VCard#columns — Property in class VCard

$ Wizard#currentStepContent — Property in class Wizard

User::check_password() — Method in class User

Check password against a hashed version

User::clear() — Method in class User

$ AdCache#created_at: — Property in class AdCache

stored in MySQL as timestamp

AdCache::count_all() — Method in class AdCache

Returns the count

$ SynchStatus#created_at: — Property in class SynchStatus

stored in MySQL as timestamp

SynchStatus::count_all() — Method in class SynchStatus

Returns the count

PasswordAction::checkPasswordStrengthInForm() — Method in class PasswordAction

Checks the password strength for the previously generated password fields in addPasswordChangeFieldsToForm() or getPasswordChangeFdl()

$ UserAccountUserConfig#cancelUrl — Property in class UserAccountUserConfig

UserAuditLogUserAdminConfig::cbChangesChangedFields() — Method in class UserAuditLogUserAdminConfig

UserAuditLogUserAdminConfig::cbChangesChangedBy() — Method in class UserAuditLogUserAdminConfig

UserAuditLogUserAdminConfig::cbChangesMessage() — Method in class UserAuditLogUserAdminConfig

$ UserLanguageUserConfig#cancelUrl — Property in class UserLanguageUserConfig

ApiService::create_user() — Method in class ApiService

Create User

ApiService::change_login() — Method in class ApiService

Change Login

Badge::create() — Method in class Badge

BadgeList::create() — Method in class BadgeList

CloudDocumentBrowser — Class in namespace XELOS\Modules\ApiCloudstorage\Hook\Selector

Class CloudDocumentBrowser

CoAuthorDocumentProcessor — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Doclink

Class CoAuthorDocumentProcessor

MicrosoftOauthClient::checkClientAfterAuthorization() — Method in class MicrosoftOauthClient

$ OnedriveOauthClient#client_id — Property in class OnedriveOauthClient

OnedriveOauthClient::checkClientAfterAuthorization() — Method in class OnedriveOauthClient

OpenidOauthClient::checkClientAfterAuthorization() — Method in class OpenidOauthClient

$ Action#cronjobs — Property in class Action

Action::cronjobs() — Method in class Action

$ Model#calendar — Property in class Model

$ Model#calendarset — Property in class Model

Model::calendar() — Method in class Model

Model::calendarset() — Method in class Model

Calendar — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model calendar.

$ Calendar#created_at: — Property in class Calendar

stored in MySQL as timestamp

Calendar::count_all() — Method in class Calendar

Returns the count

Calendarset — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model calendarset.

Calendarset::count_all() — Method in class Calendarset

Returns the count

$ Event#calendar_id — Property in class Event

$ Event#config: — Property in class Event

stored in MySQL as text

$ Event#created_at: — Property in class Event

stored in MySQL as timestamp

Event::count_all() — Method in class Event

Returns the count

Participant::count_all() — Method in class Participant

Returns the count

Reminder::count_all() — Method in class Reminder

Returns the count

ReminderQueue::count_all() — Method in class ReminderQueue

Returns the count

$ SyncData#created_on: — Property in class SyncData

enum local|remote

$ SyncData#created_at: — Property in class SyncData

stored in MySQL as timestamp

SyncData::count_all() — Method in class SyncData

Returns the count

$ SyncSetting#calendar_id — Property in class SyncSetting

$ SyncSetting#created_at: — Property in class SyncSetting

stored in MySQL as timestamp

SyncSetting::count_all() — Method in class SyncSetting

Returns the count

CalendarInterface — Class in namespace XELOS\Modules\Calendar\Interfaces

Describes the required methods for calendar models.

$ Model#component — Property in class Model

$ Model#component_live — Property in class Model

Model::component() — Method in class Model

Model::component_live() — Method in class Model

$ Page#create — Property in class Page

Page::create() — Method in class Page

Component — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model component.

$ Component#component: — Property in class Component

stored in MySQL as varchar

$ Component#created_at: — Property in class Component

stored in MySQL as timestamp

Component::count_all() — Method in class Component

Returns the count

ComponentLive — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model component_live.

$ ComponentLive#component: — Property in class ComponentLive

stored in MySQL as varchar

ComponentLive::count_all() — Method in class ComponentLive

Returns the count

$ History#change: — Property in class History

enum page_change|page_remove|page_revert|page_add|page_publish|comp_add|comp_change|comp_remove|comp_sort|comp_revert

$ History#created_at: — Property in class History

stored in MySQL as timestamp

History::count_all() — Method in class History

Returns the count

$ HistoryComponent#component: — Property in class HistoryComponent

stored in MySQL as varchar

$ HistoryComponent#created_at: — Property in class HistoryComponent

stored in MySQL as timestamp

HistoryComponent::count_all() — Method in class HistoryComponent

Returns the count

$ HistoryPage#custom_css: — Property in class HistoryPage

stored in MySQL as text

$ HistoryPage#css_class: — Property in class HistoryPage

stored in MySQL as varchar

$ HistoryPage#cache_content: — Property in class HistoryPage

stored in MySQL as longtext

$ HistoryPage#cache_until: — Property in class HistoryPage

stored in MySQL as timestamp

$ HistoryPage#created_at: — Property in class HistoryPage

stored in MySQL as timestamp

HistoryPage::count_all() — Method in class HistoryPage

Returns the count

$ Page#custom_css: — Property in class Page

stored in MySQL as text

$ Page#css_class: — Property in class Page

stored in MySQL as varchar

$ Page#cache_setting: — Property in class Page

stored in MySQL as varchar

$ Page#cache_content: — Property in class Page

stored in MySQL as longtext

$ Page#cache_until: — Property in class Page

stored in MySQL as timestamp

$ Page#created_at: — Property in class Page

stored in MySQL as timestamp

Page::count_all() — Method in class Page

Returns the count

$ PageLive#custom_css: — Property in class PageLive

stored in MySQL as text

$ PageLive#css_class: — Property in class PageLive

stored in MySQL as varchar

$ PageLive#cache_setting: — Property in class PageLive

stored in MySQL as varchar

$ PageLive#cache_content: — Property in class PageLive

stored in MySQL as longtext

$ PageLive#css_files: — Property in class PageLive

stored in MySQL as text

$ PageLive#cache_until: — Property in class PageLive

stored in MySQL as timestamp

$ PageLive#created_at: — Property in class PageLive

stored in MySQL as timestamp

PageLive::count_all() — Method in class PageLive

Returns the count

$ Partial#css_class — Property in class Partial

Partial::count_all() — Method in class Partial

Returns the count

PartialLive::count_all() — Method in class PartialLive

Returns the count

CommentCollection — Class in namespace XELOS\Modules\Comments\Collection

CommentCollection::create() — Method in class CommentCollection

CommentsController — Class in namespace XELOS\Modules\Comments

Class CommentsController

$ Model#comment — Property in class Model

Model::comment() — Method in class Model

Comment — Class in namespace XELOS\Modules\Comments\Docs\ClassGenerated\Model

This file provides property and method documentation for the model comment.

$ Comment#comment: — Property in class Comment

stored in MySQL as text

$ Comment#created_at: — Property in class Comment

stored in MySQL as timestamp

Comment::count_all() — Method in class Comment

Returns the count

$ LinkInfo#created_at: — Property in class LinkInfo

stored in MySQL as timestamp

LinkInfo::count_all() — Method in class LinkInfo

Returns the count

ApiService::createDocumentComment() — Method in class ApiService

Create comment to document or wall post if uuid is 'me' or a group-uuid

ApiService::createShareComment() — Method in class ApiService

Create a comment to personal wall ('me') or group wall (group-uuid) with a shared document

Comment — Class in namespace XELOS\Modules\Comments\Model

Class Comment

Comment::can_read() — Method in class Comment

Comment::can_write() — Method in class Comment

Must return false if the current document can not be modified by the current user

Comment — Class in namespace XELOS\Modules\Comments\UI

Class Comment

CrmSync — Class in namespace XELOS\Modules\Crm\Hook\Base

Abstract Class for CRM Sync Plugins This abstract class incorporates the old interface and is the recommended way to create new sync plugins for the CRM

CrmSync::createContact() — Method in class CrmSync

This function should create a new/empty contact in source and return a reference key The CRM will use updateContactPropertyValues() afterwards to set the properties

CrmDocumentBrowser — Class in namespace XELOS\Modules\Crm\Selector

Class GroupsDocumentBrowser

CrmControllerTest — Class in namespace XELOS\Modules\Crm\Tests\Codeception\Unit

CategoryCollection — Class in namespace XELOS\Modules\DMS\Collection

CrmPortletShowTab — Class in namespace XELOS\Modules\DMS\Hook\CRM

CFViewNoteCFView — Class in namespace XELOS\Modules\DMS\Hook\DMS

Class XELOS\Modules\SystemDMS\Hook\DMS\xm_system_dms_cf_view_note

Category — Class in namespace XELOS\Modules\DMS\Model

Class Category

CategoryPage — Class in namespace XELOS\Modules\DMS\Page

Category — Class in namespace XELOS\Modules\DMS\UI

Category UI

ChannelCollection — Class in namespace XELOS\Modules\Doclink\Collection

ChannelCollection::createOptionFromModel() — Method in class ChannelCollection

ChannelCollection::create() — Method in class ChannelCollection

ChannelSourceDocumentCollection — Class in namespace XELOS\Modules\Doclink\Collection

ChannelSourceDocumentCollection::create() — Method in class ChannelSourceDocumentCollection

ChannelSubscriptionCollection — Class in namespace XELOS\Modules\Doclink\Collection

ChannelSubscriptionCollection::create() — Method in class ChannelSubscriptionCollection

ChannelFollowsShowPortlet — Class in namespace XELOS\Modules\Doclink\Hook\Portal

Shows channel follows available to user.

RegistrationAction::calc_max_accompanying_persons() — Method in class RegistrationAction

If max_participants is set in the event, the participant plus accompanying persons may not be bigger than max_participants

RegistrationAction::calc_max_company() — Method in class RegistrationAction

Calculates how many persons can accompany a participant taking max_participants into account.

CategoryCollection — Class in namespace XELOS\Modules\Eventplanner\Collection

CategoryCollection::createOptionFromModel() — Method in class CategoryCollection

CategoryCollection::create() — Method in class CategoryCollection

EventCollection::create() — Method in class EventCollection

$ Model#category — Property in class Model

Model::category() — Method in class Model

$ Page#categories — Property in class Page

Page::categories() — Method in class Page

CategoryDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Category.

$ CategoryDocumentation#created_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

CategoryDocumentation::count_all() — Method in class CategoryDocumentation

Returns the count

$ EventDocumentation#category_id: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#custom_id: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#city: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#created_by — Property in class EventDocumentation

$ EventDocumentation#confirmation_subject: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#confirmation_description: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#confirmation_additional: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#created_at: — Property in class EventDocumentation

stored in MySQL as timestamp

$ EventDocumentation#custom_data_1 — Property in class EventDocumentation

$ EventDocumentation#custom_data_2 — Property in class EventDocumentation

$ EventDocumentation#custom_data_3 — Property in class EventDocumentation

EventDocumentation::count_all() — Method in class EventDocumentation

Returns the count

$ InvitationReplyLogDocumentation#created_at: — Property in class InvitationReplyLogDocumentation

stored in MySQL as timestamp

InvitationReplyLogDocumentation::count_all() — Method in class InvitationReplyLogDocumentation

Returns the count

$ JobDocumentation#created_at: — Property in class JobDocumentation

stored in MySQL as timestamp

JobDocumentation::count_all() — Method in class JobDocumentation

Returns the count

$ ParticipantDocumentation#custom_id: — Property in class ParticipantDocumentation

stored in MySQL as varchar

$ ParticipantDocumentation#created_at: — Property in class ParticipantDocumentation

stored in MySQL as timestamp

ParticipantDocumentation::count_all() — Method in class ParticipantDocumentation

Returns the count

$ ParticipantLogDocumentation#created_at: — Property in class ParticipantLogDocumentation

stored in MySQL as timestamp

ParticipantLogDocumentation::count_all() — Method in class ParticipantLogDocumentation

Returns the count

$ RelatedEventsDocumentation#created_at: — Property in class RelatedEventsDocumentation

stored in MySQL as timestamp

RelatedEventsDocumentation::count_all() — Method in class RelatedEventsDocumentation

Returns the count

$ EventplannerController#config — Property in class EventplannerController

EventplannerController::create_state_buttons() — Method in class EventplannerController

EventplannerController::cb_handle_invitee_response() — Method in class EventplannerController

Called from system api mail

CRMParticipationShowPortlet — Class in namespace XELOS\Modules\Eventplanner\Hook\CRM

CalendarLinkGetEvents — Class in namespace XELOS\Modules\Eventplanner\Hook\Calendar

Category — Class in namespace XELOS\Modules\Eventplanner\Model

Class XELOS\Modules\Eventplanner\Model\Category

Event::canJoin() — Method in class Event

Event::create_html_mail_job() — Method in class Event

Creates an HTML email invitation.

Event::create_mail_job() — Method in class Event

Creates job in system_api_mail to handle invitations

Event::can_read() — Method in class Event

Checks if the user can read the event

Event::can_write() — Method in class Event

Checks if the current user is the owner, the organizer or the creator of the event and has therefore edit rights

Participant::count_by_event_id_and_status_and_query() — Method in class Participant

Participant::count_by_event_id_and_query() — Method in class Participant

Participant::count_by_event_id_and_status_and_query_and_unknown() — Method in class Participant

Participant::count_by_event_id_and_query_and_custom_id() — Method in class Participant

Participant::clearTodoNotification() — Method in class Participant

Clear any notification related to this participant/event

CategoriesPage — Class in namespace XELOS\Modules\Eventplanner\Page

ParticipantsPage::cb_table_displayname_column() — Method in class ParticipantsPage

ParticipantsPage::cb_invitation_status() — Method in class ParticipantsPage

ThreadAction::cleanupExceededThreads() — Method in class ThreadAction

CategoryCollection — Class in namespace XELOS\Modules\Forum\Collection

CategoryCollection::createOptionFromModel() — Method in class CategoryCollection

CategoryCollection::create() — Method in class CategoryCollection

PostCollection::createOptionFromModel() — Method in class PostCollection

ThreadCollection::createOptionFromModel() — Method in class ThreadCollection

ThreadCollection::create() — Method in class ThreadCollection

$ Model#category — Property in class Model

Model::category() — Method in class Model

CategoryDocumentation — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Category.

$ CategoryDocumentation#created_by — Property in class CategoryDocumentation

$ CategoryDocumentation#created_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

CategoryDocumentation::count_all() — Method in class CategoryDocumentation

Returns the count

$ PostDocumentation#content_plain: — Property in class PostDocumentation

stored in MySQL as text

$ PostDocumentation#content_html: — Property in class PostDocumentation

stored in MySQL as text

$ PostDocumentation#created_by — Property in class PostDocumentation

$ PostDocumentation#created_at: — Property in class PostDocumentation

stored in MySQL as timestamp

PostDocumentation::count_all() — Method in class PostDocumentation

Returns the count

$ ThreadDocumentation#category_id — Property in class ThreadDocumentation

$ ThreadDocumentation#content: — Property in class ThreadDocumentation

stored in MySQL as text

$ ThreadDocumentation#created_by — Property in class ThreadDocumentation

$ ThreadDocumentation#created_at: — Property in class ThreadDocumentation

stored in MySQL as timestamp

ThreadDocumentation::count_all() — Method in class ThreadDocumentation

Returns the count

VotesDocumentation::count_all() — Method in class VotesDocumentation

Returns the count

$ ForumController#contactlog — Property in class ForumController

ForumController::createPost() — Method in class ForumController

GroupsTemplateInit::clone_model() — Method in class GroupsTemplateInit

[Extended]

ApiService::createPost() — Method in class ApiService

Creates a new post as reply to a thread or another post.

CreateThreadAction — Class in namespace XELOS\Modules\Forum\Hook\Workflows

Category — Class in namespace XELOS\Modules\Forum\Model

Category Model

Category::can_read() — Method in class Category

Can read this category and its contents

Category::can_write() — Method in class Category

Can create new categories or edit this category This is NOT can_post!

Category::can_moderate() — Method in class Category

Can moderate threads within this category

Category::can_post() — Method in class Category

Can create posts, edit own posts

Category::can_create() — Method in class Category

Can create threads

Category::count_by_group_id() — Method in class Category

CategoryType — Class in namespace XELOS\Modules\Forum\Model

Class CategoryType

Post::can_read() — Method in class Post

Post::can_write() — Method in class Post

Checks if the current user can edit the current post.

Post::calculatePostCountsForThreads() — Method in class Post

Batch-Calculate Post Counts for given threads

Post::count_by_thread_id() — Method in class Post

Thread::can_read() — Method in class Thread

Can the current user read this thread?

Thread::canReply() — Method in class Thread

Returns true if the current user can reply to the thread.

Thread::can_moderate() — Method in class Thread

Returns if the user has the "moderate" policy for this thread

Thread::can_write() — Method in class Thread

Checks if the current user can edit his own thread.

Thread::calculateExpiryDates() — Method in class Thread

Thread::count_by_category_id() — Method in class Thread

Thread::count_by_group_id() — Method in class Thread

ForumCest::creatorTryToEditHisPost() — Method in class ForumCest

CreatorRole — Class in namespace XELOS\Modules\Forum\Tests\Codeception\Support

$ Step#currentThreadTitle — Property in class Step

$ Step#currentPostId — Property in class Step

$ Step#currentThreadId — Property in class Step

$ Step#currentCategoryId — Property in class Step

Step::createCategory() — Method in class Step

Step::createPost() — Method in class Step

$ VoteBox#css_classes — Property in class VoteBox

LocationCollection::create() — Method in class LocationCollection

$ GeoFeature#combinedOsmKey — Property in class GeoFeature

$ GeoFeature#city — Property in class GeoFeature

$ GeoFeature#country — Property in class GeoFeature

GeoSelectorProcessor::countAll() — Method in class GeoSelectorProcessor

Artificially returns a fix-sized as we cannot tell for sure how many items are available on the API, but we want to make sure the FormChoice is displayed with the search-bar.

GeoSelectorProcessor::createOptionFromKey() — Method in class GeoSelectorProcessor

Uses the document index ID from the original form model to fetch the location model and wrap into an Option.

$ Location#combined_osm_key — Property in class Location

$ Location#created_at — Property in class Location

Location::createFromGeoFeature() — Method in class Location

RecurringTaskCollection::create() — Method in class RecurringTaskCollection

TaskCollection::create() — Method in class TaskCollection

TaskListCollection::create() — Method in class TaskListCollection

$ TaskDocumentation#contributor_ids: — Property in class TaskDocumentation

stored in MySQL as text

$ TaskDocumentation#checklist: — Property in class TaskDocumentation

stored in MySQL as text

$ TaskDocumentation#category_num — Property in class TaskDocumentation

$ TaskDocumentation#created_by — Property in class TaskDocumentation

$ TaskDocumentation#created_at: — Property in class TaskDocumentation

stored in MySQL as timestamp

TaskDocumentation::count_all() — Method in class TaskDocumentation

Returns the count

CalendarLinkGetEvents — Class in namespace XELOS\Modules\GroupsTasks\Hook\Calendar

TaskList::can_read() — Method in class TaskList

CategoryCollection — Class in namespace XELOS\Modules\Groups\Collection

CategoryCollection::createOptionFromModel() — Method in class CategoryCollection

GroupCollection::createOptionFromModel() — Method in class GroupCollection

GroupCollection::create() — Method in class GroupCollection

MemberCollection::create() — Method in class MemberCollection

$ Model#category — Property in class Model

Model::category() — Method in class Model

$ Page#category — Property in class Page

Page::category() — Method in class Page

Category — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model category.

Category::count_all() — Method in class Category

Returns the count

$ Group#category_id — Property in class Group

$ Group#created_at: — Property in class Group

stored in MySQL as timestamp

Group::count_all() — Method in class Group

Returns the count

$ Invitation#created_at: — Property in class Invitation

stored in MySQL as timestamp

Invitation::count_all() — Method in class Invitation

Returns the count

$ Member#created_at: — Property in class Member

stored in MySQL as timestamp

Member::count_all() — Method in class Member

Returns the count

$ Module#caption: — Property in class Module

stored in MySQL as varchar

Module::count_all() — Method in class Module

Returns the count

$ Newsletter#created_at: — Property in class Newsletter

stored in MySQL as timestamp

Newsletter::count_all() — Method in class Newsletter

Returns the count

$ Pending#created_at: — Property in class Pending

stored in MySQL as timestamp

Pending::count_all() — Method in class Pending

Returns the count

LeaveApplicationCollection::create() — Method in class LeaveApplicationCollection

TravelCollection::create() — Method in class TravelCollection

$ JobDocumentation#created_at: — Property in class JobDocumentation

stored in MySQL as datetime

JobDocumentation::count_all() — Method in class JobDocumentation

Returns the count

$ JobHistoryDocumentation#created_at: — Property in class JobHistoryDocumentation

stored in MySQL as datetime

JobHistoryDocumentation::count_all() — Method in class JobHistoryDocumentation

Returns the count

JobScheduler::cancel() — Method in class JobScheduler

Cancel a job

BatchJob::clearJobs() — Method in class BatchJob

$ TestJob#correlationId — Property in class TestJob

JobQueueController::cancelJobs() — Method in class JobQueueController

Cancel is not an error case, you are cancelling jobs on purpose and it will only affect NEW jobs

JobQueueController::cancelJobByUniqueIdAndClass() — Method in class JobQueueController

Cancels job

Job::cancel() — Method in class Job

Mark this Job as cancelled

Job::calculateDuration() — Method in class Job

Job::count_by_job_uniqueness_hash_and_status() — Method in class Job

Job::count_by_status() — Method in class Job

Job::count_by_job_class_and_job_uniqueness_hash_and_status_and_id() — Method in class Job

CallbackPage — Class in namespace XELOS\Modules\JobQueue\Page

$ PageDocumentation#created_at: — Property in class PageDocumentation

stored in MySQL as timestamp

PageDocumentation::count_all() — Method in class PageDocumentation

Returns the count

$ LegalController#cmsPageName — Property in class LegalController

DisclaimerPage::cmsPageDisclaimer() — Method in class DisclaimerPage

Page that takes the config variable 'disclaimer_cms_page' as the instance's and page's name, separated by a dot.

LegalControllerCest::changeDisclaimerText() — Method in class LegalControllerCest

LegalControllerCest::changeImprint() — Method in class LegalControllerCest

ListProperties::create_new() — Method in class ListProperties

CategoryCollection — Class in namespace XELOS\Modules\Lists\Collection

CategoryCollection::createOptionFromModel() — Method in class CategoryCollection

ListItemCollection::create() — Method in class ListItemCollection

ListPropertiesCollection::createOptionFromModel() — Method in class ListPropertiesCollection

ListStatusCollection::createOptionFromModel() — Method in class ListStatusCollection

ListStatusCollection::create() — Method in class ListStatusCollection

$ Model#category — Property in class Model

$ Model#Category — Property in class Model

Model::category() — Method in class Model

$ Ui#category_selector — Property in class Ui

Ui::CategorySelector() — Method in class Ui

CategoryDocumentation — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Category.

CategoryDocumentation::count_all() — Method in class CategoryDocumentation

Returns the count

$ ListDocumentation#category_id — Property in class ListDocumentation

$ ListDocumentation#created_at: — Property in class ListDocumentation

stored in MySQL as timestamp

ListDocumentation::count_all() — Method in class ListDocumentation

Returns the count

$ ListItemDocumentation#created_at: — Property in class ListItemDocumentation

stored in MySQL as timestamp

ListItemDocumentation::count_all() — Method in class ListItemDocumentation

Returns the count

$ ListStatusDocumentation#created_at: — Property in class ListStatusDocumentation

stored in MySQL as timestamp

ListStatusDocumentation::count_all() — Method in class ListStatusDocumentation

Returns the count

CategorySelector — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Checkbox — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

ApiService::create_list_item() — Method in class ApiService

Takes the list ID and a JSON encoded array, which holds all the fields the list item requires to be filled out (at least required fields should be passed).

ListsController::create_workflows_payload() — Method in class ListsController

Create a Payload for Workflows by Form-ID

Category — Class in namespace XELOS\Modules\Lists\Model

Category::can_read() — Method in class Category

Can read

Category::can_write() — Method in class Category

Can write / manage

Category::can_moderate() — Method in class Category

Can moderate

$ ListItem#created_at — Property in class ListItem

: stored in MySQL as timestamp

ListItem::can_read() — Method in class ListItem

Checks if the current user can read this list item.

ListItem::canWriteAsUser() — Method in class ListItem

Checks whether the write access is called by the user (or at least as users view mode).

ListItem::can_write() — Method in class ListItem

Checks if the current user can write this list item.

$ ListProperties#category_id — Property in class ListProperties

Category ID

$ ListProperties#created_at — Property in class ListProperties

Create date

ListProperties::can_read() — Method in class ListProperties

Can read: User can read list

ListProperties::can_write() — Method in class ListProperties

Can write/edit items of this list

ListProperties::can_moderate() — Method in class ListProperties

Can moderate this list (can ALWAYS see ALL items)

ListProperties::can_manage() — Method in class ListProperties

Can manage this list (can create and configure lists)

ListProperties::canAddEntries() — Method in class ListProperties

Check, whether a user is able to add entries to an existing list by checking several cases.

ListProperties::copyToTarget() — Method in class ListProperties

Creates a copy of the list and related list statuses

$ ListStatus#created_at — Property in class ListStatus

: stored in MySQL as timestamp

ListStatus::can_write() — Method in class ListStatus

Checks if a user can edit a list item with this status and the assigned users.

CrmControllerCest — Class in namespace XELOS\Modules\Lists\Tests\Codeception\Acceptance

CrmControllerCest::createContact() — Method in class CrmControllerCest

Login and create a Testlist

ListsControllerCest::createList() — Method in class ListsControllerCest

Login and create a Testlist

ListsControllerCest::createListItem() — Method in class ListsControllerCest

Create ListItem in Testlist

ListsControllerCest::copyAndDeleteList() — Method in class ListsControllerCest

Copy and Delete the copy list to test management links

CategorySelector — Class in namespace XELOS\Modules\Lists\UI

ProfileCollection::create() — Method in class ProfileCollection

ProfilePropertyCollection::create() — Method in class ProfilePropertyCollection

PropertyCollection::create() — Method in class PropertyCollection

PropertyGroupCollection::create() — Method in class PropertyGroupCollection

$ Action#create_crm_sync — Property in class Action

Action::create_crm_sync() — Method in class Action

$ Profile#complete_ratio: — Property in class Profile

stored in MySQL as tinyint

$ Profile#created_at: — Property in class Profile

stored in MySQL as timestamp

Profile::count_all() — Method in class Profile

Returns the count

$ ProfileProperty#copy — Property in class ProfileProperty

$ ProfileProperty#created_at: — Property in class ProfileProperty

stored in MySQL as timestamp

ProfileProperty::count_all() — Method in class ProfileProperty

Returns the count

$ Property#config: — Property in class Property

stored in MySQL as text

$ Property#created_at: — Property in class Property

stored in MySQL as timestamp

Property::count_all() — Method in class Property

Returns the count

$ PropertyGroup#config: — Property in class PropertyGroup

stored in MySQL as varchar

$ PropertyGroup#component_name: — Property in class PropertyGroup

stored in MySQL as varchar

$ PropertyGroup#component_id: — Property in class PropertyGroup

stored in MySQL as varchar

$ PropertyGroup#custom_css_class: — Property in class PropertyGroup

stored in MySQL as varchar

PropertyGroup::count_all() — Method in class PropertyGroup

Returns the count

PropertyTab::count_all() — Method in class PropertyTab

Returns the count

PropertyTabGroup::count_all() — Method in class PropertyTabGroup

Returns the count

Checkbox — Class in namespace XELOS\Modules\Lookbook\Fields

Country — Class in namespace XELOS\Modules\Lookbook\Fields

Article::create_new() — Method in class Article

Creates a new DocumentModel

Article::can_copy_to_another_instance() — Method in class Article

Returns true if this cf type allows copying documents to different instances

Article::create_copy_document_in_instance() — Method in class Article

Copys a given document to another instance

ArticleCollection::create() — Method in class ArticleCollection

CategoryCollection — Class in namespace XELOS\Modules\News\Collection

CategoryCollection::createOptionFromModel() — Method in class CategoryCollection

Used in OptionListProcessor

CategoryCollection::create() — Method in class CategoryCollection

$ Model#category — Property in class Model

Model::category() — Method in class Model

$ ArticleDocumentation#category_id — Property in class ArticleDocumentation

$ ArticleDocumentation#created_at: — Property in class ArticleDocumentation

stored in MySQL as timestamp

ArticleDocumentation::count_all() — Method in class ArticleDocumentation

Returns the count

CategoryDocumentation — Class in namespace XELOS\Modules\News\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Category.

$ CategoryDocumentation#created_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

CategoryDocumentation::count_all() — Method in class CategoryDocumentation

Returns the count

GroupsTemplateInit::clone_model() — Method in class GroupsTemplateInit

[Extended]

Article::can_read() — Method in class Article

Article::can_write() — Method in class Article

Article::cancelPublishRequest() — Method in class Article

Cancel an existing publish request

Article::canPublish() — Method in class Article

Current User can publish this article

Article::canUnpublish() — Method in class Article

Current User can unpublish this article

Article::can_read_comments() — Method in class Article

Article::can_write_comments() — Method in class Article

Checks if the 'active_comments' feature is active

Category — Class in namespace XELOS\Modules\News\Model

Category::can_read() — Method in class Category

Can user see this category?

Category::can_write() — Method in class Category

Can user modify this category? (NOT: User can write articles in category..)

NewsCest::createCategory() — Method in class NewsCest

NewsCest::createArticle() — Method in class NewsCest

ComponentCollection — Class in namespace XELOS\Modules\Pages\Collection

ComponentCollection::create() — Method in class ComponentCollection

PageCollection::createOptionFromModel() — Method in class PageCollection

PageCollection::create() — Method in class PageCollection

PageVersionCollection::create() — Method in class PageVersionCollection

$ Model#component — Property in class Model

$ PageComponentDocumentation#created_at: — Property in class PageComponentDocumentation

stored in MySQL as timestamp

PageComponentDocumentation::count_all() — Method in class PageComponentDocumentation

Returns the count

$ PageDocumentation#created_at: — Property in class PageDocumentation

stored in MySQL as timestamp

$ PageDocumentation#created_user_id — Property in class PageDocumentation

PageDocumentation::count_all() — Method in class PageDocumentation

Returns the count

$ PageVersionDocumentation#created_at: — Property in class PageVersionDocumentation

stored in MySQL as timestamp

$ PageVersionDocumentation#created_user_id — Property in class PageVersionDocumentation

PageVersionDocumentation::count_all() — Method in class PageVersionDocumentation

Returns the count

CollectionOptionHelper — Class in namespace XELOS\Modules\Pages\Hook\Base

Generic Collection Options in pages when working with Collections

CommentsPortlet — Class in namespace XELOS\Modules\Pages\Hook\Pages

Component — Class in namespace XELOS\Modules\Pages\Model

Component::can_read() — Method in class Component

Must return false if the current document is not accessible by the current user

Component::can_write() — Method in class Component

Must return false if the current document can not be modified by the current user

$ Page#created_at — Property in class Page

Page::can_read() — Method in class Page

User may see the page and access content on publishedVersion

Page::can_write() — Method in class Page

User may edit this page and work on draftVersion

Page::canPublish() — Method in class Page

Can user publish this page?

Page::can_delete() — Method in class Page

User may delete the PUBLISHED page

$ PageVersion#created_at — Property in class PageVersion

PageVersion::can_read() — Method in class PageVersion

Must return false if the current document is not accessible by the current user

PageVersion::can_write() — Method in class PageVersion

Must return false if the current document can not be modified by the current user

PageVersion::can_delete() — Method in class PageVersion

PageVersion::cancelPublishRequest() — Method in class PageVersion

Cancel an existing publish request

Template::can_read() — Method in class Template

Must return false if the current document is not accessible by the current user

TemplateCategory::can_read() — Method in class TemplateCategory

Must return false if the current document is not accessible by the current user

PagesController::can_read() — Method in class PagesController

Checks general read access for pages

PagesController::can_write() — Method in class PagesController

Checks general write access for pages

Workspace::can_read() — Method in class Workspace

Workspace::can_write() — Method in class Workspace

ConfirmationCollection — Class in namespace XELOS\Modules\ReadConfirmation\Collection

ConfirmationCollection::create() — Method in class ConfirmationCollection

DocumentCollection::create() — Method in class DocumentCollection

$ Model#confirmation — Property in class Model

Model::confirmation() — Method in class Model

ConfirmationDocumentation — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Confirmation.

$ ConfirmationDocumentation#confirmed_at — Property in class ConfirmationDocumentation

$ ConfirmationDocumentation#created_at — Property in class ConfirmationDocumentation

stored in MySQL as timestamp

ConfirmationDocumentation::count_all() — Method in class ConfirmationDocumentation

Returns the count

$ DocumentDocumentation#created_at — Property in class DocumentDocumentation

stored in MySQL as timestamp

DocumentDocumentation::count_all() — Method in class DocumentDocumentation

Returns the count

AdminProcessor::confirm() — Method in class AdminProcessor

Confirmation — Class in namespace XELOS\Modules\ReadConfirmation\Model

Confirmation::can_read() — Method in class Confirmation

Document::can_read() — Method in class Document

HistoryAction::cleanup() — Method in class HistoryAction

ElasticSearchAdapter::cleanIndex() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::createIndexIfNotExists() — Method in class ElasticSearchAdapter

Create index if it does not exist and creation is possible

ElasticSearchAdapter::createSnapshot() — Method in class ElasticSearchAdapter

Code is only here for documentation purposes / Work in Progress Requirement: add path.repo in config (e.g. path.repo=/usr/share/elasticsearch/data/backup )

ElasticSearchAdapter::cleanupOldIndicesAndSnapshots() — Method in class ElasticSearchAdapter

Remove old Monitoring Indices todo: Might NOT be a good idea if ES is a shared instance.. , add config option and trigger in maintenance cron

ElasticSearchAdapter::createUpdateFilteredAlias() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::createUserAndRoleForAlias() — Method in class ElasticSearchAdapter

User will get access to the alias pointing to their index

$ FacetedFilterDocumentation#created_at: — Property in class FacetedFilterDocumentation

stored in MySQL as timestamp

FacetedFilterDocumentation::count_all() — Method in class FacetedFilterDocumentation

Returns the count

$ SearchHistoryDocumentation#counter — Property in class SearchHistoryDocumentation

$ SearchHistoryDocumentation#created_at: — Property in class SearchHistoryDocumentation

stored in MySQL as timestamp

SearchHistoryDocumentation::count_all() — Method in class SearchHistoryDocumentation

Returns the count

$ SearchagentDocumentation#created_at: — Property in class SearchagentDocumentation

stored in MySQL as timestamp

SearchagentDocumentation::count_all() — Method in class SearchagentDocumentation

Returns the count

TermDocumentation::count_all() — Method in class TermDocumentation

Returns the count

SearchAdapterInterface::cleanIndex() — Method in class SearchAdapterInterface

Cleans the index (removes all data) and setups structure.

$ SearchController#categoryAggregationSize — Property in class SearchController

SearchController::check_for_term() — Method in class SearchController

checks if there is a search term present in DB.

TabsTrait::createTabs() — Method in class TabsTrait

$ AbstractBrowserItem#created_at — Property in class AbstractBrowserItem

$ AbstractDocumentBrowser#custom_operation_title — Property in class AbstractDocumentBrowser

$ AbstractDocumentBrowser#confirmMessages — Property in class AbstractDocumentBrowser

UserSelectorProcessor::countAll() — Method in class UserSelectorProcessor

UserSelectorProcessor::createOptionFromKey() — Method in class UserSelectorProcessor

Page::can_create_new() — Method in class Page

Returns TRUE if the current user may create new documents

Page::create_new() — Method in class Page

Creates a new xelos_document_model

$ Page#comments — Property in class Page

Page::comments() — Method in class Page

$ PageDocumentation#content_plain: — Property in class PageDocumentation

stored in MySQL as longtext

$ PageDocumentation#content_html: — Property in class PageDocumentation

stored in MySQL as longtext

$ PageDocumentation#change_log: — Property in class PageDocumentation

stored in MySQL as varchar

$ PageDocumentation#created_user_id — Property in class PageDocumentation

$ PageDocumentation#created_at: — Property in class PageDocumentation

stored in MySQL as timestamp

PageDocumentation::count_all() — Method in class PageDocumentation

Returns the count

$ PageHistoryDocumentation#content_plain: — Property in class PageHistoryDocumentation

stored in MySQL as longtext

$ PageHistoryDocumentation#content_html: — Property in class PageHistoryDocumentation

stored in MySQL as longtext

$ PageHistoryDocumentation#change_log: — Property in class PageHistoryDocumentation

stored in MySQL as varchar

$ PageHistoryDocumentation#created_user_id — Property in class PageHistoryDocumentation

$ PageHistoryDocumentation#created_at: — Property in class PageHistoryDocumentation

stored in MySQL as timestamp

PageHistoryDocumentation::count_all() — Method in class PageHistoryDocumentation

Returns the count

$ PageLinkDocumentation#count — Property in class PageLinkDocumentation

$ PageLinkDocumentation#created_at: — Property in class PageLinkDocumentation

stored in MySQL as timestamp

PageLinkDocumentation::count_all() — Method in class PageLinkDocumentation

Returns the count

GroupsTemplateInit::clone_model() — Method in class GroupsTemplateInit

[Extended]

$ Page#content_plain — Property in class Page

$ Page#content_html — Property in class Page

$ Page#change_log — Property in class Page

$ Page#created_user_id — Property in class Page

$ Page#created_at — Property in class Page

Page::can_read() — Method in class Page

Page::can_write() — Method in class Page

CommentsPage — Class in namespace XELOS\Modules\SmartWiki\Page

$ SmartWikiController#current_page — Property in class SmartWikiController

SmartWikiController::cb_attachments_name() — Method in class SmartWikiController

SmartWikiController::createRootPage() — Method in class SmartWikiController

SystemCron::cleanup_drafts() — Method in class SystemCron

WikiCest::createPage() — Method in class WikiCest

ActivityCollection::createActivityCollection() — Method in class ActivityCollection

ActivityCollection::countAll() — Method in class ActivityCollection

Overriding countAll to use the join query

ActivityCollection::create() — Method in class ActivityCollection

DocumentWallItemDocumentation::count_all() — Method in class DocumentWallItemDocumentation

Returns the count

$ EntryDocumentation#created_at: — Property in class EntryDocumentation

stored in MySQL as timestamp

EntryDocumentation::count_all() — Method in class EntryDocumentation

Returns the count

HiddenInstanceDocumentation::count_all() — Method in class HiddenInstanceDocumentation

Returns the count

CmsWallContentPortlet — Class in namespace XELOS\Modules\SystemActionlog\Hook\Cms

SendWallDigestJob::create() — Method in class SendWallDigestJob

SettingsPage::calculate_activity() — Method in class SettingsPage

$ BackupQueue#created_at: — Property in class BackupQueue

stored in MySQL as timestamp

BackupQueue::count_all() — Method in class BackupQueue

Returns the count

$ EventTrigger#created_at: — Property in class EventTrigger

stored in MySQL as timestamp

EventTrigger::count_all() — Method in class EventTrigger

Returns the count

$ InstallQueue#created_at: — Property in class InstallQueue

stored in MySQL as timestamp

InstallQueue::count_all() — Method in class InstallQueue

Returns the count

LicenseProblem::count_all() — Method in class LicenseProblem

Returns the count

TrashAction::cleanup() — Method in class TrashAction

Cleanup the trash folder (used by cron)

Document::can_create_new() — Method in class Document

Returns TRUE if the current user may create new documents

Document::create_new() — Method in class Document

Creates a new xelos_document_model

Document::create_copy_document_in_instance() — Method in class Document

Copies a given document to another instance

CategoryCollection — Class in namespace XELOS\Modules\SystemDMS\Collection

CategoryCollection::createOptionFromModel() — Method in class CategoryCollection

CategoryDocumentCollection — Class in namespace XELOS\Modules\SystemDMS\Collection

CategoryDocumentCollection combines categories and documents from DocumentIndex within one collection.

CategoryDocumentCollection::createWithCategoryModel() — Method in class CategoryDocumentCollection

CategoryDocumentCollection::create() — Method in class CategoryDocumentCollection

DocumentCollection::createOptionFromModel() — Method in class DocumentCollection

CrmPortletShowTab — Class in namespace XELOS\Modules\SystemDMS\Hook\CRM

Class XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_crm_portlet

CFViewNoteCFView — Class in namespace XELOS\Modules\SystemDMS\Hook\DMS

Class XELOS\Modules\SystemDMS\Hook\DMS\xm_system_dms_cf_view_note

GroupsTemplateInit::clone_model() — Method in class GroupsTemplateInit

WebdavService::create_dir() — Method in class WebdavService

Resource Handler wraps Create Dir/Collection

WebdavService::copy() — Method in class WebdavService

Copy File or Folder

WebdavService::categoryPathToId() — Method in class WebdavService

ApiService::createFileCopy() — Method in class ApiService

PreviewJob::create() — Method in class PreviewJob

CategoryTabInterface — Class in namespace XELOS\Modules\SystemDMS\Interfaces

Interface CategoryTabInterface

Category — Class in namespace XELOS\Modules\SystemDMS\Model

Category::can_read() — Method in class Category

Returns if current user can read this category

Category::can_write() — Method in class Category

Returns if current user can write this category

Category::can_delete() — Method in class Category

Category::create_xfs_category() — Method in class Category

Creates a category for the instance in the xfs root category

$ Document#current_category_id — Property in class Document

Document::can_read() — Method in class Document

Checks if current User can read this Document

Document::can_write() — Method in class Document

Checks if current User can write this Document

Document::can_delete() — Method in class Document

Returns if current User can delete this Document

DocumentHistory::changeTableForRecovery() — Method in class DocumentHistory

Change Table, Saving the model into document table

DocumentHistory::count_by_deleted_and_group_id() — Method in class DocumentHistory

DocumentTemplate::cache_group() — Method in class DocumentTemplate

gets the name of the cache_group, which is relevant for doc-templates

CategoryPage — Class in namespace XELOS\Modules\SystemDMS\Page

Class CategoryPage

CategoryService — Class in namespace XELOS\Modules\SystemDMS\Service

Class CategoryService

CategoryService::create() — Method in class CategoryService

Creates and returns a new category.

$ SystemDMSController#cf — Property in class SystemDMSController

SystemDMSController::copy_document_by_di() — Method in class SystemDMSController

Copies an existing document by its document index id.

CategoryCest — Class in namespace XELOS\Modules\SystemDMS\Tests\Codeception\Phantom

Class CategoryCest

CategoryCest::createNewSubCategory() — Method in class CategoryCest

CategoryCest::createNewSiblingCategory() — Method in class CategoryCest

Category — Class in namespace XELOS\Modules\SystemDMS\UI

Class Document

ContentFirst — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Model#category — Property in class Model

Model::category() — Method in class Model

$ Page#category — Property in class Page

Page::category() — Method in class Page

Category — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model category.

$ Category#content_updated_at: — Property in class Category

stored in MySQL as timestamp

$ Category#created_at — Property in class Category

: stored in MySQL as timestamp

Category::count_all() — Method in class Category

Returns the count

$ Document#category_id — Property in class Document

$ Document#checksum — Property in class Document

: stored in MySQL as varchar

$ Document#created_at: — Property in class Document

stored in MySQL as timestamp

Document::count_all() — Method in class Document

Returns the count

$ DocumentHistory#category_id — Property in class DocumentHistory

$ DocumentHistory#checksum — Property in class DocumentHistory

: stored in MySQL as varchar

$ DocumentHistory#created_at — Property in class DocumentHistory

: stored in MySQL as timestamp

DocumentHistory::count_all() — Method in class DocumentHistory

Returns the count

$ DocumentMetaData#created_at: — Property in class DocumentMetaData

stored in MySQL as timestamp

DocumentMetaData::count_all() — Method in class DocumentMetaData

Returns the count

$ DocumentMetaField#created_at — Property in class DocumentMetaField

: stored in MySQL as timestamp

DocumentMetaField::count_all() — Method in class DocumentMetaField

Returns the count

$ DocumentTemplate#created_at — Property in class DocumentTemplate

: stored in MySQL as timestamp

DocumentTemplate::count_all() — Method in class DocumentTemplate

Returns the count

$ FileTemplate#created_at — Property in class FileTemplate

: stored in MySQL as timestamp

FileTemplate::count_all() — Method in class FileTemplate

Returns the count

$ Preview#checksum — Property in class Preview

$ Preview#created_at: — Property in class Preview

stored in MySQL as timestamp

Preview::count_all() — Method in class Preview

Returns the count

$ ZipImportJob#category_id: — Property in class ZipImportJob

stored in MySQL as varchar

$ ZipImportJob#created_at — Property in class ZipImportJob

: stored in MySQL as timestamp

ZipImportJob::count_all() — Method in class ZipImportJob

Returns the count

ChannelSettingDocumentation — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated\Model

This file provides property and method documentation for the model UserSetting.

$ ChannelSettingDocumentation#channel_instance_id — Property in class ChannelSettingDocumentation

$ ChannelSettingDocumentation#channel_name — Property in class ChannelSettingDocumentation

$ ChannelSettingDocumentation#created_at — Property in class ChannelSettingDocumentation

ChannelSettingDocumentation::count_all() — Method in class ChannelSettingDocumentation

Returns the count

$ UserSettingDocumentation#channel_instance_id — Property in class UserSettingDocumentation

$ UserSettingDocumentation#channel_name — Property in class UserSettingDocumentation

$ UserSettingDocumentation#channel_config — Property in class UserSettingDocumentation

$ UserSettingDocumentation#created_at — Property in class UserSettingDocumentation

UserSettingDocumentation::count_all() — Method in class UserSettingDocumentation

Returns the count

CreateNotificationJob — Class in namespace XELOS\Modules\SystemNotification\Infrastructure\Job

Creates Notifications and schedules sending jobs for each channel

CreateNotificationJob::create() — Method in class CreateNotificationJob

$ SendNotificationJob#channelIdentifier — Property in class SendNotificationJob

SendNotificationJob::create() — Method in class SendNotificationJob

NotificationAction::clearNotification() — Method in class NotificationAction

$ PushSubscriptionDocumentation#created_at: — Property in class PushSubscriptionDocumentation

stored in MySQL as timestamp

PushSubscriptionDocumentation::count_all() — Method in class PushSubscriptionDocumentation

Returns the count

CronAction — Class in namespace XELOS\Modules\SystemStats\Action

CronAction::cleanUp() — Method in class CronAction

Cleanup existing data

EventCollection::create() — Method in class EventCollection

$ Action#cron — Property in class Action

Action::cron() — Method in class Action

$ AggregateDimensionDocumentation#created_at: — Property in class AggregateDimensionDocumentation

stored in MySQL as timestamp

AggregateDimensionDocumentation::count_all() — Method in class AggregateDimensionDocumentation

Returns the count

AggregateNumericDocumentation::count_all() — Method in class AggregateNumericDocumentation

Returns the count

EventDocumentation::count_all() — Method in class EventDocumentation

Returns the count

Collector — Class in namespace XELOS\Modules\SystemStats\Hook

Collector::createNewCollectorDimension() — Method in class Collector

Collector::createNewCollectorDataForCollectorDimension() — Method in class Collector

CollectorData — Class in namespace XELOS\Modules\SystemStats\Lib

CollectorDimension — Class in namespace XELOS\Modules\SystemStats\Lib

$ Model#check — Property in class Model

Model::check() — Method in class Model

CheckDocumentation — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Check.

$ CheckDocumentation#check_id: — Property in class CheckDocumentation

stored in MySQL as varchar

CheckDocumentation::count_all() — Method in class CheckDocumentation

Returns the count

NodeDocumentation::count_all() — Method in class NodeDocumentation

Returns the count

Check — Class in namespace XELOS\Modules\SystemStatus\Hook\Base

Class Check

CacheCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

ClamavCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

ConnectionCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

CronCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

Check — Class in namespace XELOS\Modules\SystemStatus\Model

Check::count_by_state_and_active_and_node_id() — Method in class Check

GlobalTaskCollection::create() — Method in class GlobalTaskCollection

GlobalTaskCollection::countAll() — Method in class GlobalTaskCollection

GlobalTaskListCollection::create() — Method in class GlobalTaskListCollection

GlobalTaskListCollection::countAll() — Method in class GlobalTaskListCollection

RecurringTaskCollection::create() — Method in class RecurringTaskCollection

TaskCollection::createOptionFromModel() — Method in class TaskCollection

TaskCollection::create() — Method in class TaskCollection

TaskListCollection::createOptionFromModel() — Method in class TaskListCollection

TaskListCollection::create() — Method in class TaskListCollection

$ RecurringTaskDocumentation#created_at: — Property in class RecurringTaskDocumentation

stored in MySQL as timestamp

RecurringTaskDocumentation::count_all() — Method in class RecurringTaskDocumentation

Returns the count

$ TaskDocumentation#contributor_ids: — Property in class TaskDocumentation

stored in MySQL as text

$ TaskDocumentation#checklist: — Property in class TaskDocumentation

stored in MySQL as text

$ TaskDocumentation#created_by — Property in class TaskDocumentation

$ TaskDocumentation#created_at: — Property in class TaskDocumentation

stored in MySQL as timestamp

TaskDocumentation::count_all() — Method in class TaskDocumentation

Returns the count

CalendarLinkGetEvents — Class in namespace XELOS\Modules\SystemTasks\Hook\Calendar

ContactlogShowSidebar — Class in namespace XELOS\Modules\SystemTasks\Hook\Crm

ApiService::createTask() — Method in class ApiService

Create tasks via API

ApiService::createColumn() — Method in class ApiService

Create columns for list

$ Task#contributor_ids — Property in class Task

Comma-separated list of users who should be notified about changes

$ Task#created_by — Property in class Task

Author of the task

$ Task#created_at — Property in class Task

$ Task#checkbox_link — Property in class Task

Task::can_read() — Method in class Task

Task::can_write() — Method in class Task

TaskList::can_read() — Method in class TaskList

Must return false if the current document is not accessible by the current user

TaskList::can_write() — Method in class TaskList

Must return false if the current document can not be modified by the current user

TaskList::count_by_user_id() — Method in class TaskList

TaskListColumn::createDefaultCollectionForList() — Method in class TaskListColumn

Create the default Columns for a list

CheckCallbackPage — Class in namespace XELOS\Modules\SystemWorker\Page

LibreofficeWorker::convertFileToPDF() — Method in class LibreofficeWorker

Send file to worker, convert

$ PushClient#created_at: — Property in class PushClient

stored in MySQL as timestamp

PushClient::count_all() — Method in class PushClient

Returns the count

TagCollection::createOptionFromModel() — Method in class TagCollection

TagCollection::createOptionFromKey() — Method in class TagCollection

TagDocumentation::count_all() — Method in class TagDocumentation

Returns the count

CloudShowPortlet — Class in namespace XELOS\Modules\Tagging\Hook\Portal

Show Tag Cloud based on Tagging Information

Tag::cleanTags() — Method in class Tag

Filter, Trim, Unique Tags

TaggingController::calculateTagCount() — Method in class TaggingController

Calculates the amount of references the tags use and puts this number into the separate 'tag_count' column.

FeedbackAction::createFeedbackJob() — Method in class FeedbackAction

CommonOperationsTrait — Class in namespace XELOS\Modules\Translation\Action\Traits

CommonOperationsTrait::createTranslationJob() — Method in class CommonOperationsTrait

Creates a translation_job model

TranslateAction::createTranslationJobs() — Method in class TranslateAction

Creates translation jobs in the translation job queue to translate $content into $languages

$ TranslationDocumentDocumentation#content_i18n: — Property in class TranslationDocumentDocumentation

stored in MySQL as mediumtext

$ TranslationDocumentDocumentation#cache_key: — Property in class TranslationDocumentDocumentation

stored in MySQL as varchar

$ TranslationDocumentDocumentation#ctrl_hash: — Property in class TranslationDocumentDocumentation

stored in MySQL as varchar

$ TranslationDocumentDocumentation#created_at: — Property in class TranslationDocumentDocumentation

stored in MySQL as timestamp

TranslationDocumentDocumentation::count_all() — Method in class TranslationDocumentDocumentation

Returns the count

$ TranslationDocumentation#content_i18n: — Property in class TranslationDocumentation

stored in MySQL as mediumtext

$ TranslationDocumentation#cache_key: — Property in class TranslationDocumentation

stored in MySQL as varchar

$ TranslationDocumentation#created_at: — Property in class TranslationDocumentation

stored in MySQL as timestamp

TranslationDocumentation::count_all() — Method in class TranslationDocumentation

Returns the count

$ TranslationFeedbackDocumentation#content: — Property in class TranslationFeedbackDocumentation

stored in MySQL as mediumtext

$ TranslationFeedbackDocumentation#created_at: — Property in class TranslationFeedbackDocumentation

stored in MySQL as timestamp

TranslationFeedbackDocumentation::count_all() — Method in class TranslationFeedbackDocumentation

Returns the count

$ TranslationJobDocumentation#content: — Property in class TranslationJobDocumentation

stored in MySQL as mediumtext

$ TranslationJobDocumentation#created_at: — Property in class TranslationJobDocumentation

stored in MySQL as timestamp

TranslationJobDocumentation::count_all() — Method in class TranslationJobDocumentation

Returns the count

$ BaseTranslationApi#content — Property in class BaseTranslationApi

BaseTranslationApi::checkRequirements() — Method in class BaseTranslationApi

Checks if all requirements are set for a successfull translation call

Deepl::checkRequirements() — Method in class Deepl

Transperfect::checkRequirements() — Method in class Transperfect

CommonOperationsTrait — Class in namespace XELOS\Modules\Translation\Model\Traits

Translation::can_read() — Method in class Translation

TranslationDocument::can_read() — Method in class TranslationDocument

TranslationFeedback::can_read() — Method in class TranslationFeedback

TranslationJob::can_read() — Method in class TranslationJob

TranslationJob::count_by_target_model_and_target_id() — Method in class TranslationJob

Returns count of jobs of target_model and target_id

ResultCollection::create() — Method in class ResultCollection

TrendvoteCollection::create() — Method in class TrendvoteCollection

$ Result#created_at: — Property in class Result

stored in MySQL as timestamp

Result::count_all() — Method in class Result

Returns the count

$ Trendvote#created_at: — Property in class Trendvote

stored in MySQL as timestamp

Trendvote::count_all() — Method in class Trendvote

Returns the count

Result::count_by_trendvote_id() — Method in class Result

$ Trendvote#created_at — Property in class Trendvote

Trendvote::can_read() — Method in class Trendvote

Must return false if the current document is not accessible by the current user

Trendvote::can_write() — Method in class Trendvote

Must return false if the current document can not be modified by the current user

$ FileDocumentation#created_at: — Property in class FileDocumentation

stored in MySQL as timestamp

FileDocumentation::count_all() — Method in class FileDocumentation

Returns the count

$ ScanDocumentation#created_at: — Property in class ScanDocumentation

stored in MySQL as timestamp

ScanDocumentation::count_all() — Method in class ScanDocumentation

Returns the count

File::count_by_scan_id() — Method in class File

Service::createMethod() — Method in class Service

Create new service method

ModelCRUD::create() — Method in class ModelCRUD

Creates a generic CRUD interface for a Model

ModelMethod::create() — Method in class ModelMethod

XQL::createFromArray() — Method in class XQL

OAuthClientHook::createState() — Method in class OAuthClientHook

Get a state value for OAuth flow

OAuthClientHook::createOAuthClient() — Method in class OAuthClientHook

Return OAuth Client

OAuthClientHook::checkClientAfterAuthorization() — Method in class OAuthClientHook

You can check/process the client connection before the client is saved as oauth_access in webservices, this point can also be used to do custom redirects

$ OAuthClient#clientId — Property in class OAuthClient

The application's Client ID.

$ OAuthClient#clientSecret — Property in class OAuthClient

The application's Client Secret.

$ OAuthClient#code — Property in class OAuthClient

The authorization code received from the authorization server

$ Model#category — Property in class Model

Model::category() — Method in class Model

$ Page#categories — Property in class Page

Page::categories() — Method in class Page

CategoryDocumentation — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated\Model

This file provides property and method documentation for the model category.

$ CategoryDocumentation#created_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

CategoryDocumentation::count_all() — Method in class CategoryDocumentation

Returns the count

$ WidgetDocumentation#category_id — Property in class WidgetDocumentation

$ WidgetDocumentation#created_at: — Property in class WidgetDocumentation

stored in MySQL as timestamp

WidgetDocumentation::count_all() — Method in class WidgetDocumentation

Returns the count

CategoryWidgetShowPortlet — Class in namespace XELOS\Modules\Widgets\Hook\Portal

Class CategoryWidgetShowPortlet

Category — Class in namespace XELOS\Modules\Widgets\Model

Class XELOS\Modules\Widgets\Model\Category

Category::can_view_widgets() — Method in class Category

Can view widgets

Category::can_edit_widgets() — Method in class Category

Can edit widgets

Widget::can_read() — Method in class Widget

Widget::can_write() — Method in class Widget

Must return false if the current document can not be modified by the current user

Widget::count_by_category_id() — Method in class Widget

CategoriesPage — Class in namespace XELOS\Modules\Widgets\Page

Class XELOS\Modules\Widgets\Page\CategoriesPage

SettingsPage::cb_table_actions() — Method in class SettingsPage

Calback for table actions

ActionIntegrationTestBase::createAction() — Method in class ActionIntegrationTestBase

Creates the action for the transition and saves it in the DB.

ActionIntegrationTestBase::createItem() — Method in class ActionIntegrationTestBase

Starts the workflow of the process, returns the item.

AnswerDocumentation::count_all() — Method in class AnswerDocumentation

Returns the count

$ ParticipantDocumentation#created_at: — Property in class ParticipantDocumentation

stored in MySQL as timestamp

ParticipantDocumentation::count_all() — Method in class ParticipantDocumentation

Returns the count

$ SurveyDocumentation#created_at: — Property in class SurveyDocumentation

stored in MySQL as timestamp

SurveyDocumentation::count_all() — Method in class SurveyDocumentation

Returns the count

CmsSimplePortletShowPortlet — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Hook\Portal

Class SimpleShowPortlet

D

$ UserDetails#displayname — Property in class UserDetails

$ CommandDefinition#description — Property in class CommandDefinition

Daemon — Class in namespace XELOS\Framework\Core\Console\Command

Class StartDaemon

Debug — Class in namespace XELOS\Framework\Core\Console\Command

Class Debug

Docker — Class in namespace XELOS\Framework\Core\Console\Command

Class Docker

Core::dbquery() — Method in class Core

Core::dbquery_with_params() — Method in class Core

Core::dblquery() — Method in class Core

Calls dbquery() after given SQL has been converted by $XF->lib->i18n->convert_i18n_sql()

Core::delete_file() — Method in class Core

Deletes the file stored in the storage DMS.

DataNotFoundException — Class in namespace XELOS\Framework\Core\Exception

DatabaseConnectionException — Class in namespace XELOS\Framework\Core\Exception

XELOS Database Exception Thrown when the database connection failed.

DatabaseException — Class in namespace XELOS\Framework\Core\Exception

XELOS Query Exception Thrown when the query contains an error.

DeprecationException — Class in namespace XELOS\Framework\Core\Exception

XELOS Deprecation Exception

DocumentAddCategoryInterface — Class in namespace XELOS\Framework\Core\Interfaces

Interface DocumentAddCategoryInterface

DocumentAddFileInterface — Class in namespace XELOS\Framework\Core\Interfaces

Interface DocumentAddFileInterface

$ Template#data_blocks — Property in class Template

Template::disable_render_stage() — Method in class Template

DISABLE Pre-Rendering and resets staging params

Controller::document() — Method in class Controller

ModulePageCollector::dynTreeAutocompletion() — Method in class ModulePageCollector

Generates and returns the completed sentences for the dyn tree params field.

$ AuthenticationHook#description — Property in class AuthenticationHook

Short description of authentication method

DocumentItem — Class in namespace XELOS\Framework\Module\Hook

An abstract class for content-first documents Each instance provides content-first functionality one specific DocumentModel

$ ModulePortlet#download_handler — Property in class ModulePortlet

ModulePortlet::delete() — Method in class ModulePortlet

Cleanup references or stored data associated with this portlet instance.

Collection::delete() — Method in class Collection

Creates a delete statement for the scoped collection and executes it.

DocumentModel — Class in namespace XELOS\Framework\Module\Model

$ DocumentModel#documentIndex — Property in class DocumentModel

DocumentModel::disable_silent_mode() — Method in class DocumentModel

Disables the silent mode Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

DocumentModel::delete() — Method in class DocumentModel

see also doc of Model->delete().

DoclinkableDocumentInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

Interface DoclinkableDocumentModelInterface

DuplicatableInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

Interface DuplicatableModelInterface

DuplicatableInterface::duplicate() — Method in class DuplicatableInterface

Model::delete() — Method in class Model

Model::debug() — Method in class Model

Model::disable_table_group_id() — Method in class Model

Disable the use of the group ID in all queries made

Model::delete_by_TABLE_COL() — Method in class Model

on the desired collection.

ModelCollection::debug() — Method in class ModelCollection

Use for debugging

DocumentCollectionTrait — Class in namespace XELOS\Framework\Module\Model\Traits

DuplicatableModelTrait — Class in namespace XELOS\Framework\Module\Model\Traits

Trait DuplicatableModelTrait

DuplicatableModelTrait::duplicate() — Method in class DuplicatableModelTrait

Duplicate Model and associated content This function will replicate the current model and its associated content:

• Referenced Documents will be referenced by passive or read reference
• Tags will be copied

$ Page#default_page — Property in class Page

$ SystemDaemon#daemon_name — Property in class SystemDaemon

Document — Class in namespace XELOS\Framework\Module\UI

Class Document

$ Document#document_index — Property in class Document

$ UIAjaxComponent#deferredLoading — Property in class UIAjaxComponent

$ UIAjaxComponent#deferredLoadingMessage — Property in class UIAjaxComponent

$ XF#db — Property in class XF

Config::disable_return_cache() — Method in class Config

this will diable the internal config return cache this is usefull if a huge amount of set calls will follow

Config::delete_setting() — Method in class Config

deletes a given var from config db

DB — Class in namespace XELOS\Framework\XF

Database Wrapper (mySQL)

$ DB#db — Property in class DB

$ MySQLAdapter#debug_query_count — Property in class MySQLAdapter

$ MySQLAdapter#debug_profile — Property in class MySQLAdapter

$ MySQLAdapter#debug_last_query — Property in class MySQLAdapter

$ MySQLAdapter#debug_last_status — Property in class MySQLAdapter

$ MySQLAdapter#db — Property in class MySQLAdapter

MySQLAdapter::debug() — Method in class MySQLAdapter

Prints information about the last query and it's result code

$ Lib#date — Property in class Lib

$ Lib#debug — Property in class Lib

$ Lib#doclink — Property in class Lib

Cache::disable_cache_custom_config() — Method in class Cache

Cache::disable_cache() — Method in class Cache

Disables the cache for the rest of this page call

Date — Class in namespace XELOS\Framework\XF\Lib

$XF->lib->date->ph_check('DE', mktime(0,0,0,8,2,2006)); returns true or flase if it is a public holiday $XF->lib->date->ph_getCaption();returns the name of the with ph_check asked holiday $XF->lib->date->ph_pregenerateHolidays(2005,2006); pregenerates all Holidays from 2005 to 2006 and saves it in db

Debug — Class in namespace XELOS\Framework\XF\Lib

$ Debug#DEBUG_FUNCTION — Property in class Debug

$ Debug#debug_functions — Property in class Debug

Debug::disableDebugging() — Method in class Debug

Debug::disableDebugFunction() — Method in class Debug

Debug::display_error_page() — Method in class Debug

Output error page with debugging infos

Debug::disable() — Method in class Debug

Disable Debbuging

Debug::dumpDebugFile() — Method in class Debug

Dumps all collected DEBUG data to a file located at /_file/debug/ and the Request ID as folder name

Debug::dump() — Method in class Debug

Function to debug on live systems

Debug::dd() — Method in class Debug

Function to debug on live systems and die

Doclink — Class in namespace XELOS\Framework\XF\Lib

Error::debug() — Method in class Error

Outputs debug message to separate debugging log file (/var/log/debug.log)

File::du() — Method in class File

File::decode_file() — Method in class File

File::download_file_from_url() — Method in class File

Downloads a file from a url.

$ Filehandler#destinationpath — Property in class Filehandler

$ Filehandler#destinationfile — Property in class Filehandler

Filehandler::download_file() — Method in class Filehandler

Initiates download of the via GPvars[download_id] passed file link

Filehandler::deflate_zip() — Method in class Filehandler

Foaf::disconnect() — Method in class Foaf

Removes the two way connection between first id and second id and leaves a oneway between second and first

$ Link#dep_params — Property in class Link

Link::decode_special_chars() — Method in class Link

Decode Special Chars like [/,#=]

DefaultFormatter — Class in namespace XELOS\Framework\XF\Lib\Logger\Formatter

Class DefaultFormatter

DatabaseHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger\HandlerFactory

Class DatabaseStreamHandlerFactory

DefaultStreamHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger\HandlerFactory

Class FileStreamHandlerFactory

DisplayHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger\HandlerFactory

Class DisplayStreamHandlerFactory

DatabaseHandler — Class in namespace XELOS\Framework\XF\Lib\Logger\Handler

Class DatabaseHandler

DisplayHandler — Class in namespace XELOS\Framework\XF\Lib\Logger\Handler

Class DisplayStreamHandler

$ Logger#deferredSetups — Property in class Logger

$ Logger#deferredLogs — Property in class Logger

Logger::debug() — Method in class Logger

Modsetup::drop_tables() — Method in class Modsetup

Modsetup::drop_all_tables() — Method in class Modsetup

$ NotificationBuilder#documentIndex — Property in class NotificationBuilder

$ Request#delete — Property in class Request

Session::destroy() — Method in class Session

Destroys the current session and starts a fresh session

NonpersistentSessionHandler::destroy() — Method in class NonpersistentSessionHandler

SqlSessionHandler::destroy() — Method in class SqlSessionHandler

Text::decode_from_imap_mime() — Method in class Text

Deocodes the mime declaration in a string and returns a valid UTF-8 string.

Yaml::dump() — Method in class Yaml

Dump YAML from PHP array statically

DocumentIndexCollection — Class in namespace XELOS\Framework\XF\System\Collection

DocumentIndexReferenceCollection — Class in namespace XELOS\Framework\XF\System\Collection

$ Model#daemon — Property in class Model

$ Model#document_index — Property in class Model

$ Model#document_index_job_queue — Property in class Model

$ Model#document_index_job_queue_history — Property in class Model

$ Model#document_index_lock — Property in class Model

$ Model#document_index_policy_cluster — Property in class Model

$ Model#document_index_reference — Property in class Model

$ Model#document_registry — Property in class Model

$ Model#document_relations — Property in class Model

AuditPolicy::delete() — Method in class AuditPolicy

AuditPolicy::delete_by_created_at() — Method in class AuditPolicy

AuditTrail::delete() — Method in class AuditTrail

AuditTrail::delete_by_created_at() — Method in class AuditTrail

Daemon — Class in namespace XELOS\Framework\XF\System\Model

DocumentIndex — Class in namespace XELOS\Framework\XF\System\Model

$ DocumentIndex#document_registry_info_lookup — Property in class DocumentIndex

DocumentIndex::delete() — Method in class DocumentIndex

Delete this document index and all jobs associated Usually the index will be deleted as result from

DocumentIndex::deleteReferences() — Method in class DocumentIndex

Delete references before deleting model, notify modules that this 'attachment' is gone now

DocumentIndexJobQueue — Class in namespace XELOS\Framework\XF\System\Model

Class DocumentIndexJobQueue

$ DocumentIndexJobQueue#document_index_id — Property in class DocumentIndexJobQueue

DocumentIndexJobQueue::deleteOldProcessingJobs() — Method in class DocumentIndexJobQueue

DocumentIndexJobQueue::delete_by_id() — Method in class DocumentIndexJobQueue

DocumentIndexJobQueueHistory — Class in namespace XELOS\Framework\XF\System\Model

Class DocumentIndexJobQueueHistory

DocumentIndexJobQueueHistory::delete_by_id() — Method in class DocumentIndexJobQueueHistory

DocumentIndexLock — Class in namespace XELOS\Framework\XF\System\Model

Class DocumentIndexLock

$ DocumentIndexLock#document_index_id — Property in class DocumentIndexLock

DocumentIndexLock::deleteOldLocks() — Method in class DocumentIndexLock

Deletes all visitors where the last interaction / view exceeds the given ttl.

DocumentIndexPolicyCluster — Class in namespace XELOS\Framework\XF\System\Model

Class DocumentIndexPolicyCluster

$ DocumentIndexPolicyCluster#document_index_id — Property in class DocumentIndexPolicyCluster

DocumentIndexPolicyCluster::deleteOldClusters() — Method in class DocumentIndexPolicyCluster

DocumentIndexPolicyCluster::delete_by_document_index_id() — Method in class DocumentIndexPolicyCluster

DocumentIndexReference — Class in namespace XELOS\Framework\XF\System\Model

$ DocumentIndexReference#document_index_id — Property in class DocumentIndexReference

$ DocumentIndexReference#document_canonical — Property in class DocumentIndexReference

DocumentRegistry — Class in namespace XELOS\Framework\XF\System\Model

$ DocumentRegistry#document_type — Property in class DocumentRegistry

'file', 'person', 'article', 'comment'

DocumentRelations — Class in namespace XELOS\Framework\XF\System\Model

Follows::delete() — Method in class Follows

Group::delete() — Method in class Group

$ Hierarchy#description_plain_i18n — Property in class Hierarchy

Description

$ Hierarchy#description_html_i18n — Property in class Hierarchy

Description

$ I18nToken#domain — Property in class I18nToken

Domain

$ Notification#document_index_id — Property in class Notification

$ Pages#description — Property in class Pages

$ Policy#description — Property in class Policy

Policy2Group::doCopyGroupSecurityPolicies() — Method in class Policy2Group

Policy2Group::delete_by_group_security_id_and_policy_id() — Method in class Policy2Group

ThemeSet::delete() — Method in class ThemeSet

Delete Theme Set and remove resource folder

User::deleteUserFromSystem() — Method in class User

Hard delete user from system_user table. NO policy/rights check included!

User::delete() — Method in class User

Disables the user

$ UserDevices#device_id — Property in class UserDevices

: stored in MySQL as varchar

UserDevices::delete() — Method in class UserDevices

Delete Authorized Device and associated API access

UserDevices::delete_by_id() — Method in class UserDevices

UserDevices::delete_by_is_temporary_and_updated_at() — Method in class UserDevices

UserGroup::delete() — Method in class UserGroup

$ Calendar#day_info — Property in class Calendar

Doclink — Class in namespace XELOS\Framework\XF\UI

Class DocLink

$ Doclink#document_index_id — Property in class Doclink

$ Doclink#document_index — Property in class Doclink

$ Doclink#displaystyle — Property in class Doclink

Document — Class in namespace XELOS\Framework\XF\UI

Class Document, Wrapper

DocumentList — Class in namespace XELOS\Framework\XF\UI

Class DocumentList

DocumentLock — Class in namespace XELOS\Framework\XF\UI

Class DocumentLock

$ DocumentLock#document_index_id — Property in class DocumentLock

DocumentView — Class in namespace XELOS\Framework\XF\UI

$ DocumentView#document_index — Property in class DocumentView

$ FacetedCategory#defaultValues — Property in class FacetedCategory

$ Form#date_components — Property in class Form

Form::display_feedback() — Method in class Form

Form::display_form() — Method in class Form

Form::display_field() — Method in class Form

FormEditor::disable_i18n_mode() — Method in class FormEditor

Disable i18n mode

FormBase::destroy() — Method in class FormBase

FormButton::display_field() — Method in class FormButton

FormCaptcha::display_field() — Method in class FormCaptcha

FormCatSelector::display_field() — Method in class FormCatSelector

FormCheckbox::display_field() — Method in class FormCheckbox

FormCheckbox::display_field_print() — Method in class FormCheckbox

Display field in print mode

FormChoice::display_field() — Method in class FormChoice

FormColor::display_field() — Method in class FormColor

$ FormComponent#db_handler — Property in class FormComponent

FormComponent::display_field() — Method in class FormComponent

FormComponent::display_field_print() — Method in class FormComponent

Special Field Display for Print Purposes

FormConfig::display_field() — Method in class FormConfig

FormContentAttachment::display_field() — Method in class FormContentAttachment

FormDate::display_field() — Method in class FormDate

FormDate::display_field_print() — Method in class FormDate

Display field in print mode

FormDatetime::display_field() — Method in class FormDatetime

FormDatetime::display_field_print() — Method in class FormDatetime

Display field in print mode

FormDescription::display_field() — Method in class FormDescription

FormDocument::display_field() — Method in class FormDocument

Renders the GUI

FormDocument::display_field_print() — Method in class FormDocument

Display field in print mode

FormEmail::display_field() — Method in class FormEmail

Display field

FormFieldset::display_field() — Method in class FormFieldset

FormFieldset::display_field_print() — Method in class FormFieldset

Special Field Display for Print Purposes

FormFieldsetClose::display_field() — Method in class FormFieldsetClose

FormFile::display_field() — Method in class FormFile

FormFile::display_field_print() — Method in class FormFile

Display field in print mode

FormFile::delete_file() — Method in class FormFile

FormGeoSelector::display_field() — Method in class FormGeoSelector

FormGroupSelector::display_field() — Method in class FormGroupSelector

FormHidden::display_field() — Method in class FormHidden

FormHidden::display_field_print() — Method in class FormHidden

Display field in print mode

FormIconSelect::display_field() — Method in class FormIconSelect

FormMediaAttachment::display_field() — Method in class FormMediaAttachment

FormMultifile::display_field() — Method in class FormMultifile

FormMultitext::display_field() — Method in class FormMultitext

FormMultitext::display_field_print() — Method in class FormMultitext

Display field in print mode

FormNumber::display_field() — Method in class FormNumber

Display field

FormPassword::display_field() — Method in class FormPassword

Display field

FormPhone::display_field() — Method in class FormPhone

Display field

FormPolicySelector::display_field() — Method in class FormPolicySelector

FormRowRenderer::display_field() — Method in class FormRowRenderer

FormRowRendererMultirowTable::display_field() — Method in class FormRowRendererMultirowTable

FormRrule::display_field() — Method in class FormRrule

FormSearch::display_field() — Method in class FormSearch

Display field

FormSectionBreak::display_field() — Method in class FormSectionBreak

FormSectionBreak::display_field_print() — Method in class FormSectionBreak

Display field in print mode

FormSelect::display_field() — Method in class FormSelect

FormSelect::display_field_print() — Method in class FormSelect

Display field in print mode

FormSlider::display_field() — Method in class FormSlider

FormSlider::display_field_print() — Method in class FormSlider

Display field in print mode

FormStaticText::display_field() — Method in class FormStaticText

FormStaticText::display_field_print() — Method in class FormStaticText

Display field in print mode

FormStaticValue::display_field() — Method in class FormStaticValue

FormTag::display_field() — Method in class FormTag

FormTextarea::display_field() — Method in class FormTextarea

Display field

FormTextarea::display_field_print() — Method in class FormTextarea

Display field in print mode

FormTextbox::display_field() — Method in class FormTextbox

Display field

FormTextbox::display_field_print() — Method in class FormTextbox

Display field in print mode

FormTextboxList::display_field() — Method in class FormTextboxList

FormTileSelection::display_field() — Method in class FormTileSelection

FormToggleSwitch::display_field() — Method in class FormToggleSwitch

FormToggleSwitch::display_field_print() — Method in class FormToggleSwitch

Display field in print mode

FormUrl::display_field() — Method in class FormUrl

Display field

FormUserSelector::display_field() — Method in class FormUserSelector

FormUserSelector::display_field_print() — Method in class FormUserSelector

Display field in print mode

FormWebfetcher::display_field() — Method in class FormWebfetcher

$ FroalaEditorBuilder#domId — Property in class FroalaEditorBuilder

$ FroalaEditorBuilder#documentIndex — Property in class FroalaEditorBuilder

FroalaOption::dragInline() — Method in class FroalaOption

Specifies how the dragged elements should be placed in the new position. When this option is disabled, the dragged elements are placed between block tags and not inside them.

FroalaOption::direction() — Method in class FroalaOption

Sets the direction of the text. Possible values are: 'auto', 'ltr' and 'rtl'. When the option is set to auto the editor automatically detects if the keyboard input is RTL or LTR. However only the text inside the editing box changes direction, the toolbar remains the same.

FroalaOption::disableRightClick() — Method in class FroalaOption

Disables the default browser context menu. It's recommended to be used if <a href="#toolbarVisibleWithoutSelection" title="toolbarVisibleWithoutSelection" target="_blank">toolbarVisibleWithoutSelection option is enabled.

FroalaOption::documentReady() — Method in class FroalaOption

Turns on the editor best setup for editing documents.

FroalaOption::docId() — Method in class FroalaOption

A unique identifier for the document. In a content management service, this could for example be the resource identifier for the document.

FormTextboxTrait::display_textbox_field() — Method in class FormTextboxTrait

Image::determine_url() — Method in class Image

put your comment there.

Image::debug() — Method in class Image

$ Item#di_id — Property in class Item

$ Item#document_model — Property in class Item

$ Item#doclink — Property in class Item

Paging::debug() — Method in class Paging

ProgressBar::debug() — Method in class ProgressBar

$ Reactions#document_index_id — Property in class Reactions

The Document ID for which the reactions should be displayed

Table::deactivateAjax() — Method in class Table

TableEditor::delete_record() — Method in class TableEditor

$ Tree#delete_recursively — Property in class Tree

Tree::disable_form() — Method in class Tree

Tree::display() — Method in class Tree

$ ViewModeSwitcher#default — Property in class ViewModeSwitcher

Wizard::disable_control_next() — Method in class Wizard

put your comment there.

Wizard::disable_control_prev() — Method in class Wizard

put your comment there.

$ AdCache#displayname: — Property in class AdCache

stored in MySQL as varchar

AdCache::delete_by_id() — Method in class AdCache

Delete rows specified by condition and returns the affected rows.

DirectoryServiceInterface — Class in namespace XELOS\Modules\AdSync\Interfaces

Interface for Directory Service Implementation

DirectoryServiceConfigTrait — Class in namespace XELOS\Modules\AdSync\Traits

Trait for Directory Service Configuration

$ Page#design — Property in class Page

Page::design() — Method in class Page

DesignPage — Class in namespace XELOS\Modules\Administration\Page

Class Overview

StorageProvider::do_download() — Method in class StorageProvider

Initialize and executes the download of a selected remote file.

$ OnedriveStorageProvider#drive — Property in class OnedriveStorageProvider

OnedriveStorageProvider::deleteDriveItem() — Method in class OnedriveStorageProvider

Delete the driveItemId from OneDrive

OnedriveStorageProvider::downloadDriveItem() — Method in class OnedriveStorageProvider

Download the requested remote file and save the content to temp path

$ MicrosoftOauthClient#description — Property in class MicrosoftOauthClient

$ OnedriveOauthClient#description — Property in class OnedriveOauthClient

DirectoryPage — Class in namespace XELOS\Modules\ApiMicrosoft\Page

$ OpenidOauthClient#description — Property in class OpenidOauthClient

$ Page#detail — Property in class Page

Page::detail() — Method in class Page

$ Ui#detail — Property in class Ui

$ Calendar#description: — Property in class Calendar

stored in MySQL as text

Calendar::delete_by_id() — Method in class Calendar

Delete rows specified by condition and returns the affected rows.

Calendarset::delete_by_id() — Method in class Calendarset

Delete rows specified by condition and returns the affected rows.

$ Event#description: — Property in class Event

stored in MySQL as text

Event::delete_by_id() — Method in class Event

Delete rows specified by condition and returns the affected rows.

Participant::delete_by_id() — Method in class Participant

Delete rows specified by condition and returns the affected rows.

Reminder::delete_by_id() — Method in class Reminder

Delete rows specified by condition and returns the affected rows.

ReminderQueue::delete_by_id() — Method in class ReminderQueue

Delete rows specified by condition and returns the affected rows.

SyncData::delete_by_id() — Method in class SyncData

Delete rows specified by condition and returns the affected rows.

$ SyncSetting#direction: — Property in class SyncSetting

enum both|from_sync|to_sync

SyncSetting::delete_by_id() — Method in class SyncSetting

Delete rows specified by condition and returns the affected rows.

Component::delete_by_id() — Method in class Component

Delete rows specified by condition and returns the affected rows.

ComponentLive::delete_by_id() — Method in class ComponentLive

Delete rows specified by condition and returns the affected rows.

History::delete_by_id() — Method in class History

Delete rows specified by condition and returns the affected rows.

HistoryComponent::delete_by_id() — Method in class HistoryComponent

Delete rows specified by condition and returns the affected rows.

HistoryPage::delete_by_id() — Method in class HistoryPage

Delete rows specified by condition and returns the affected rows.

Page::delete_by_id() — Method in class Page

Delete rows specified by condition and returns the affected rows.

PageLive::delete_by_id() — Method in class PageLive

Delete rows specified by condition and returns the affected rows.

Partial::delete_by_id() — Method in class Partial

Delete rows specified by condition and returns the affected rows.

PartialLive::delete_by_id() — Method in class PartialLive

Delete rows specified by condition and returns the affected rows.

CommentsController::deleteGroupContext() — Method in class CommentsController

Deletes the models of this comments instance that is to be deleted.

Comment::delete_by_id() — Method in class Comment

Delete rows specified by condition and returns the affected rows.

$ LinkInfo#description: — Property in class LinkInfo

stored in MySQL as text

LinkInfo::delete_by_id() — Method in class LinkInfo

Delete rows specified by condition and returns the affected rows.

Comment::delete() — Method in class Comment

CrmSync::deleteContact() — Method in class CrmSync

This function should delete the contact associated with the reference key

Document — Class in namespace XELOS\Modules\DMS\CF

DocumentCollection — Class in namespace XELOS\Modules\DMS\Collection

DMSController — Class in namespace XELOS\Modules\DMS

Class DMSController

DMSNavigation — Class in namespace XELOS\Modules\DMS\Hook\Dashboard

Document — Class in namespace XELOS\Modules\DMS\Model

Class Document

DocumentHistory — Class in namespace XELOS\Modules\DMS\Model

Class DocumentHistory

DocumentMetaData — Class in namespace XELOS\Modules\DMS\Model

Class DocumentMetaData

DocumentMetaField — Class in namespace XELOS\Modules\DMS\Model

Class DocumentMetaField

DocumentTemplate — Class in namespace XELOS\Modules\DMS\Model

Class DocumentTemplate

DocumentPage — Class in namespace XELOS\Modules\DMS\Page

Class DocumentPage

Document — Class in namespace XELOS\Modules\DMS\UI

Class Document

DocumentGalleryPanel — Class in namespace XELOS\Modules\DMS\UI

Panel that displays the content of a category as a gallery

DocumentPage — Class in namespace XELOS\Modules\DMS\UI

Class DocumentPage

DocumentPageSidebar — Class in namespace XELOS\Modules\DMS\UI

Class DocumentPageSidebar

DocumentPageViews — Class in namespace XELOS\Modules\DMS\UI

Class DocumentPageViews

DocumentPanel — Class in namespace XELOS\Modules\DMS\UI

Wrapper Panel that displays all documents of a currently selected category

DocumentTablePanel — Class in namespace XELOS\Modules\DMS\UI

Panel that displays the content of a category as a table

DocviewProcessor — Class in namespace XELOS\Modules\Doclink\Hook\Doclink

Class CoAuthorDocumentProcessor

DocviewProcessor::doCountView() — Method in class DocviewProcessor

DocumentActivityCollector — Class in namespace XELOS\Modules\Doclink\Hook\SystemStats

DocumentViewsCollector — Class in namespace XELOS\Modules\Doclink\Hook\SystemStats

$ Page#detail — Property in class Page

Page::detail() — Method in class Page

$ Ui#details — Property in class Ui

CategoryDocumentation::delete_by_id() — Method in class CategoryDocumentation

Delete rows specified by condition and returns the affected rows.

$ EventDocumentation#deadline: — Property in class EventDocumentation

stored in MySQL as timestamp

$ EventDocumentation#desc_plain_i18n: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#desc_rendered_i18n: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#decline_subject: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#decline_description: — Property in class EventDocumentation

stored in MySQL as text

EventDocumentation::delete_by_id() — Method in class EventDocumentation

Delete rows specified by condition and returns the affected rows.

InvitationReplyLogDocumentation::delete_by_id() — Method in class InvitationReplyLogDocumentation

Delete rows specified by condition and returns the affected rows.

$ JobDocumentation#download_url: — Property in class JobDocumentation

stored in MySQL as varchar

JobDocumentation::delete_by_id() — Method in class JobDocumentation

Delete rows specified by condition and returns the affected rows.

ParticipantDocumentation::delete_by_id() — Method in class ParticipantDocumentation

Delete rows specified by condition and returns the affected rows.

ParticipantLogDocumentation::delete_by_id() — Method in class ParticipantLogDocumentation

Delete rows specified by condition and returns the affected rows.

RelatedEventsDocumentation::delete_by_id() — Method in class RelatedEventsDocumentation

Delete rows specified by condition and returns the affected rows.

EventplannerController::deleteGroupContext() — Method in class EventplannerController

Event::delete() — Method in class Event

see also doc of Model->delete().

Participant::delete() — Method in class Participant

DetailPage — Class in namespace XELOS\Modules\Eventplanner\Page

Details — Class in namespace XELOS\Modules\Eventplanner\UI

$ CategoryDocumentation#descr: — Property in class CategoryDocumentation

stored in MySQL as text

CategoryDocumentation::delete_by_id() — Method in class CategoryDocumentation

Delete rows specified by condition and returns the affected rows.

PostDocumentation::delete_by_id() — Method in class PostDocumentation

Delete rows specified by condition and returns the affected rows.

ThreadDocumentation::delete_by_id() — Method in class ThreadDocumentation

Delete rows specified by condition and returns the affected rows.

VotesDocumentation::delete_by_id() — Method in class VotesDocumentation

Delete rows specified by condition and returns the affected rows.

ForumController::deleteGroupContext() — Method in class ForumController

Category::delete() — Method in class Category

Post::delete() — Method in class Post

Thread::delete() — Method in class Thread

$ FeedPage#default_page — Property in class FeedPage

$ Location#document_index_id — Property in class Location

$ TaskDocumentation#description: — Property in class TaskDocumentation

stored in MySQL as text

$ TaskDocumentation#deadline: — Property in class TaskDocumentation

stored in MySQL as timestamp

TaskDocumentation::delete_by_id() — Method in class TaskDocumentation

Delete rows specified by condition and returns the affected rows.

$ Page#directory — Property in class Page

Page::directory() — Method in class Page

Category::delete_by_id() — Method in class Category

Delete rows specified by condition and returns the affected rows.

Group::delete_by_id() — Method in class Group

Delete rows specified by condition and returns the affected rows.

Invitation::delete_by_id() — Method in class Invitation

Delete rows specified by condition and returns the affected rows.

Member::delete_by_id() — Method in class Member

Delete rows specified by condition and returns the affected rows.

$ Module#description: — Property in class Module

stored in MySQL as varchar

Module::delete_by_id() — Method in class Module

Delete rows specified by condition and returns the affected rows.

Newsletter::delete_by_id() — Method in class Newsletter

Delete rows specified by condition and returns the affected rows.

Pending::delete_by_id() — Method in class Pending

Delete rows specified by condition and returns the affected rows.

$ EventplannerPortlet#dep_hook_info — Property in class EventplannerPortlet

$ FilesPortlet#dep_hook_info — Property in class FilesPortlet

$ GroupsPortlet#dep_hook_info — Property in class GroupsPortlet

$ NewsPortlet#dep_hook_info — Property in class NewsPortlet

DeleteGroupJob — Class in namespace XELOS\Modules\Groups\Infrastructure\Job

$ JobDocumentation#duration — Property in class JobDocumentation

JobDocumentation::delete_by_id() — Method in class JobDocumentation

Delete rows specified by condition and returns the affected rows.

$ JobHistoryDocumentation#duration — Property in class JobHistoryDocumentation

JobHistoryDocumentation::delete_by_id() — Method in class JobHistoryDocumentation

Delete rows specified by condition and returns the affected rows.

$ JobScheduler#debug — Property in class JobScheduler

JobHistory::delete_by_finished_at() — Method in class JobHistory

$ SystemDaemon#daemon_name — Property in class SystemDaemon

$ Page#disclaimer — Property in class Page

Page::disclaimer() — Method in class Page

PageDocumentation::delete_by_id() — Method in class PageDocumentation

Delete rows specified by condition and returns the affected rows.

DisclaimerPage — Class in namespace XELOS\Modules\Legal\Page

Class Overview

$ CategoryDocumentation#description: — Property in class CategoryDocumentation

stored in MySQL as text

CategoryDocumentation::delete_by_id() — Method in class CategoryDocumentation

Delete rows specified by condition and returns the affected rows.

ListDocumentation::delete_by_id() — Method in class ListDocumentation

Delete rows specified by condition and returns the affected rows.

ListItemDocumentation::delete_by_id() — Method in class ListItemDocumentation

Delete rows specified by condition and returns the affected rows.

$ ListStatusDocumentation#default: — Property in class ListStatusDocumentation

stored in MySQL as tinyint

ListStatusDocumentation::delete_by_id() — Method in class ListStatusDocumentation

Delete rows specified by condition and returns the affected rows.

Date — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Datetime — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Document — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Class Document

DateContext — Class in namespace XELOS\Modules\Lists\Hook\Pages\Context

ListsController::deleteGroupContext() — Method in class ListsController

Deletes all models which might have been left over, even though the instance is about to be deleted.

$ Category#description: — Property in class Category

stored in MySQL as text

Category::delete() — Method in class Category

Delete this category and all forms within

ListProperties::delete() — Method in class ListProperties

Delete List and all contained items

$ ListStatus#default — Property in class ListStatus

ListsControllerCest::deleteListItem() — Method in class ListsControllerCest

Delete ListItem in Testliste

$ Action#dbdesigner — Property in class Action

Action::dbdesigner() — Method in class Action

$ Profile#displayname: — Property in class Profile

stored in MySQL as varchar

Profile::delete_by_id() — Method in class Profile

Delete rows specified by condition and returns the affected rows.

$ Property#description_i18n: — Property in class Property

stored in MySQL as text

$ Property#default: — Property in class Property

stored in MySQL as text

Property::delete_by_id() — Method in class Property

Delete rows specified by condition and returns the affected rows.

$ PropertyGroup#description_i18n: — Property in class PropertyGroup

stored in MySQL as text

PropertyGroup::delete_by_id() — Method in class PropertyGroup

Delete rows specified by condition and returns the affected rows.

PropertyTab::delete_by_id() — Method in class PropertyTab

Delete rows specified by condition and returns the affected rows.

Country::decorateSearchTableValue() — Method in class Country

Date — Class in namespace XELOS\Modules\Lookbook\Fields

Class Date

Date::decorateSearchTableValue() — Method in class Date

Email::decorateSearchTableValue() — Method in class Email

Image::decorateSearchTableValue() — Method in class Image

Phoneno::decorateSearchTableValue() — Method in class Phoneno

SystemUserGroup::decorateSearchTableValue() — Method in class SystemUserGroup

SystemUserMeta::decorateSearchTableValue() — Method in class SystemUserMeta

Tagging::decorateSearchTableValue() — Method in class Tagging

UserSelector::decorateSearchTableValue() — Method in class UserSelector

FieldInterface::decorateSearchTableValue() — Method in class FieldInterface

Alters the search table row value at the 'advanced search' page.

FieldTrait::decorateSearchTableValue() — Method in class FieldTrait

$ ArticleDocumentation#deleted_at — Property in class ArticleDocumentation

ArticleDocumentation::delete_by_id() — Method in class ArticleDocumentation

Delete rows specified by condition and returns the affected rows.

$ CategoryDocumentation#deleted_at — Property in class CategoryDocumentation

CategoryDocumentation::delete_by_id() — Method in class CategoryDocumentation

Delete rows specified by condition and returns the affected rows.

Article::delete() — Method in class Article

Category::delete() — Method in class Category

see also doc of Model->delete().

NewsController::deleteGroupContext() — Method in class NewsController

Deletes both all categories and articles found in this instance.

NewsCest::deleteArticle() — Method in class NewsCest

NewsCest::deleteCategory() — Method in class NewsCest

$ PageComponentDocumentation#data: — Property in class PageComponentDocumentation

stored in MySQL as blob

$ PageComponentDocumentation#deleted_at — Property in class PageComponentDocumentation

PageComponentDocumentation::delete_by_id() — Method in class PageComponentDocumentation

Delete rows specified by condition and returns the affected rows.

$ PageDocumentation#deleted_at — Property in class PageDocumentation

PageDocumentation::delete_by_id() — Method in class PageDocumentation

Delete rows specified by condition and returns the affected rows.

$ PageVersionDocumentation#deleted_at — Property in class PageVersionDocumentation

PageVersionDocumentation::delete_by_id() — Method in class PageVersionDocumentation

Delete rows specified by condition and returns the affected rows.

$ Page#deleted_at — Property in class Page

Page::delete() — Method in class Page

Delete page and all its Versions

$ PageVersion#deleted_at — Property in class PageVersion

PageVersion::duplicatePage() — Method in class PageVersion

$ Template#description_i18n — Property in class Template

$ Workspace#dms — Property in class Workspace

DocumentsPage — Class in namespace XELOS\Modules\PersonalWorkspace\Page

Class XELOS\Modules\PersonalWorkspace\Page\xpage_personal_workspace_documents

DocumentCollection — Class in namespace XELOS\Modules\ReadConfirmation\Collection

$ Model#document — Property in class Model

Model::document() — Method in class Model

$ ConfirmationDocumentation#document_index_id — Property in class ConfirmationDocumentation

ConfirmationDocumentation::delete_by_id() — Method in class ConfirmationDocumentation

Delete rows specified by condition and returns the affected rows.

DocumentDocumentation — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Document.

$ DocumentDocumentation#document_index_id — Property in class DocumentDocumentation

DocumentDocumentation::delete_by_id() — Method in class DocumentDocumentation

Delete rows specified by condition and returns the affected rows.

$ Confirmation#document_index_id — Property in class Confirmation

Confirmation::deleteByDocumentIndexId() — Method in class Confirmation

Delete all confirmation requests concerning the given document index and also remove associated notifications for all users

Confirmation::delete() — Method in class Confirmation

Delete Confirmation Request and remove existing notifications

Confirmation::delete_by_document_index_id() — Method in class Confirmation

Document — Class in namespace XELOS\Modules\ReadConfirmation\Model

$ Document#document_index_id — Property in class Document

Document::delete() — Method in class Document

ElasticSearchAdapter::deleteUserAndRole() — Method in class ElasticSearchAdapter

$ Model#document_elasticsearch — Property in class Model

Model::document_elasticsearch() — Method in class Model

$ FacetedFilterDocumentation#deleted_at — Property in class FacetedFilterDocumentation

FacetedFilterDocumentation::delete_by_id() — Method in class FacetedFilterDocumentation

Delete rows specified by condition and returns the affected rows.

SearchHistoryDocumentation::delete_by_id() — Method in class SearchHistoryDocumentation

Delete rows specified by condition and returns the affected rows.

SearchagentDocumentation::delete_by_id() — Method in class SearchagentDocumentation

Delete rows specified by condition and returns the affected rows.

TermDocumentation::delete_by_id() — Method in class TermDocumentation

Delete rows specified by condition and returns the affected rows.

DocumentElasticsearch — Class in namespace XELOS\Modules\Search\Model

Class DocumentElasticsearch

DocumentElasticsearch::delete() — Method in class DocumentElasticsearch

$ SearchController#daemon_mode — Property in class SearchController

DocumentBrowserHookInterface — Class in namespace XELOS\Modules\Selector\Interfaces

Interface DocumentBrowserHookInterface

$ PageDocumentation#documents: — Property in class PageDocumentation

stored in MySQL as text

PageDocumentation::delete_by_id() — Method in class PageDocumentation

Delete rows specified by condition and returns the affected rows.

PageHistoryDocumentation::delete_by_id() — Method in class PageHistoryDocumentation

Delete rows specified by condition and returns the affected rows.

PageLinkDocumentation::delete_by_id() — Method in class PageLinkDocumentation

Delete rows specified by condition and returns the affected rows.

$ Page#documents — Property in class Page

Page::delete() — Method in class Page

deletes a page including all attachments and subpages

SmartWikiController::deleteGroupContext() — Method in class SmartWikiController

Deletes every page in this instance.

$ Model#document_wall_item — Property in class Model

Model::document_wall_item() — Method in class Model

DocumentWallItemDocumentation — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\Model

This file provides property and method documentation for the model document_wall_item.

$ DocumentWallItemDocumentation#document_index_id — Property in class DocumentWallItemDocumentation

DocumentWallItemDocumentation::delete_by_id() — Method in class DocumentWallItemDocumentation

Delete rows specified by condition and returns the affected rows.

$ EntryDocumentation#document_index_id — Property in class EntryDocumentation

EntryDocumentation::delete_by_id() — Method in class EntryDocumentation

Delete rows specified by condition and returns the affected rows.

HiddenInstanceDocumentation::delete_by_id() — Method in class HiddenInstanceDocumentation

Delete rows specified by condition and returns the affected rows.

$ SendWallDigestJob#digestSinceTimestamp — Property in class SendWallDigestJob

DocumentWallItem — Class in namespace XELOS\Modules\SystemActionlog\Model

BackupQueue::delete_by_id() — Method in class BackupQueue

Delete rows specified by condition and returns the affected rows.

EventTrigger::delete_by_id() — Method in class EventTrigger

Delete rows specified by condition and returns the affected rows.

InstallQueue::delete_by_id() — Method in class InstallQueue

Delete rows specified by condition and returns the affected rows.

DaemonHelperTrait — Class in namespace XELOS\Modules\SystemAdmin\Lib\Daemon

DocumentIndexDaemonLegacy — Class in namespace XELOS\Modules\SystemAdmin\Lib\Daemon

DocumentIndexDaemonThreaded — Class in namespace XELOS\Modules\SystemAdmin\Lib\Daemon

$ SystemDaemon#daemon_name — Property in class SystemDaemon

Document — Class in namespace XELOS\Modules\SystemDMS\CF

Class XELOS\Modules\SystemDMS\CF\xcf_system_dms_document

DocumentCollection — Class in namespace XELOS\Modules\SystemDMS\Collection

WebdavService::delete() — Method in class WebdavService

Delete File or Folder

WebdavService::document_index_to_path() — Method in class WebdavService

Document index to WebDAV path

$ PreviewJob#documentIndex — Property in class PreviewJob

PreviewJob::downloadEncodedVideoHD() — Method in class PreviewJob

Step 2 for video

DocumentItemViewInterface — Class in namespace XELOS\Modules\SystemDMS\Interfaces

Interface DocumentItemViewInterface

$ Category#duplicate — Property in class Category

This is coming from group template init

Category::delete() — Method in class Category

Delete Category

Category::decrease_folder_size() — Method in class Category

Decreases the size of this and all affected folders.

Document — Class in namespace XELOS\Modules\SystemDMS\Model

Class XELOS\Modules\SystemDMS\Model\xm_system_dms_document

Document::delete() — Method in class Document

Delete Document

DocumentHistory — Class in namespace XELOS\Modules\SystemDMS\Model

XELOS\Modules\SystemDMS\Model\xm_system_dms_document_history Class

DocumentMetaData — Class in namespace XELOS\Modules\SystemDMS\Model

DocumentMetaField — Class in namespace XELOS\Modules\SystemDMS\Model

Holds the defined fields for document templates

DocumentTemplate — Class in namespace XELOS\Modules\SystemDMS\Model

DocumentTemplate::delete() — Method in class DocumentTemplate

Deletes the template

DocumentTemplate::delete_cache() — Method in class DocumentTemplate

Deletes the cached data

Preview::delete() — Method in class Preview

Deletes the corresponding preview files.

XfsDocument::delete() — Method in class XfsDocument

DocumentPage — Class in namespace XELOS\Modules\SystemDMS\Page

Class DocumentPage

$ SystemDMSController#default_view_mode — Property in class SystemDMSController

Default category mode of document panel

$ SystemDMSController#default_document_page — Property in class SystemDMSController

This determines where files links are pointing to

SystemDMSController::deleteGroupContext() — Method in class SystemDMSController

Deletes all category which relates to the given group.

CategoryCest::deleteCategory() — Method in class CategoryCest

Document — Class in namespace XELOS\Modules\SystemDMS\UI

Class Document

DocumentGalleryPanel — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_document_gallery_panel Panel that displays the content of a category as a gallery

DocumentPage — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_document_page

DocumentPageSidebar — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_document_page_sidebar

DocumentPageViews — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_document_page_views

DocumentPanel — Class in namespace XELOS\Modules\SystemDMS\UI

Wrapper Panel that displays all documents of a currently selected category

DocumentTablePanel — Class in namespace XELOS\Modules\SystemDMS\UI

Panel that displays the content of a category as a table

FormFilterSpecification::display_field() — Method in class FormFilterSpecification

Renders the component

FormReportSpecification::display_field() — Method in class FormReportSpecification

Render the form component

$ Action#document — Property in class Action

$ ContentFirst#document — Property in class ContentFirst

$ Model#document — Property in class Model

$ Model#document_history — Property in class Model

$ Model#document_meta_data — Property in class Model

$ Model#document_meta_field — Property in class Model

$ Model#document_template — Property in class Model

Model::document() — Method in class Model

Model::document_history() — Method in class Model

Model::document_meta_data() — Method in class Model

Model::document_meta_field() — Method in class Model

Model::document_template() — Method in class Model

$ Page#document — Property in class Page

Page::document() — Method in class Page

$ Ui#document — Property in class Ui

$ Ui#document_gallery_panel — Property in class Ui

$ Ui#document_page — Property in class Ui

$ Ui#document_page_sidebar — Property in class Ui

$ Ui#document_page_views — Property in class Ui

$ Ui#document_panel — Property in class Ui

$ Ui#document_table_panel — Property in class Ui

$ Category#description_i18n — Property in class Category

: stored in MySQL as text

$ Category#display_mode — Property in class Category

: enum simple|preview

Category::delete_by_id() — Method in class Category

Delete rows specified by condition and returns the affected rows.

Document — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model document.

Document::delete_by_id() — Method in class Document

Delete rows specified by condition and returns the affected rows.

DocumentHistory — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model document_history.

$ DocumentHistory#deleted_from: — Property in class DocumentHistory

stored in MySQL as varchar

$ DocumentHistory#deleted — Property in class DocumentHistory

: stored in MySQL as tinyint

DocumentHistory::delete_by_id() — Method in class DocumentHistory

Delete rows specified by condition and returns the affected rows.

DocumentMetaData — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model document_meta_data.

$ DocumentMetaData#document_id — Property in class DocumentMetaData

DocumentMetaData::delete_by_id() — Method in class DocumentMetaData

Delete rows specified by condition and returns the affected rows.

DocumentMetaField — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model document_meta_field.

$ DocumentMetaField#description_i18n — Property in class DocumentMetaField

: stored in MySQL as varchar

DocumentMetaField::delete_by_id() — Method in class DocumentMetaField

Delete rows specified by condition and returns the affected rows.

DocumentTemplate — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model doc_template.

$ DocumentTemplate#description: — Property in class DocumentTemplate

stored in MySQL as varchar

DocumentTemplate::delete_by_id() — Method in class DocumentTemplate

Delete rows specified by condition and returns the affected rows.

$ FileTemplate#description — Property in class FileTemplate

: stored in MySQL as varchar

FileTemplate::delete_by_id() — Method in class FileTemplate

Delete rows specified by condition and returns the affected rows.

$ Preview#document_id — Property in class Preview

Preview::delete_by_id() — Method in class Preview

Delete rows specified by condition and returns the affected rows.

ZipImportJob::delete_by_id() — Method in class ZipImportJob

Delete rows specified by condition and returns the affected rows.

ChannelSettingDocumentation::delete_by_id() — Method in class ChannelSettingDocumentation

Delete rows specified by condition and returns the affected rows.

UserSettingDocumentation::delete_by_id() — Method in class UserSettingDocumentation

Delete rows specified by condition and returns the affected rows.

PushSubscriptionDocumentation::delete_by_id() — Method in class PushSubscriptionDocumentation

Delete rows specified by condition and returns the affected rows.

$ AggregateDimensionDocumentation#dimension_group: — Property in class AggregateDimensionDocumentation

stored in MySQL as varchar

$ AggregateDimensionDocumentation#dimension_name: — Property in class AggregateDimensionDocumentation

stored in MySQL as varchar

$ AggregateDimensionDocumentation#dimension_title_i18n: — Property in class AggregateDimensionDocumentation

stored in MySQL as varchar

AggregateDimensionDocumentation::delete_by_id() — Method in class AggregateDimensionDocumentation

Delete rows specified by condition and returns the affected rows.

$ AggregateNumericDocumentation#date: — Property in class AggregateNumericDocumentation

stored in MySQL as date

EventDocumentation::delete_by_id() — Method in class EventDocumentation

Delete rows specified by condition and returns the affected rows.

AggregateDimension::detectDimensionsFromHooks() — Method in class AggregateDimension

$ CheckDocumentation#details: — Property in class CheckDocumentation

stored in MySQL as text

CheckDocumentation::delete_by_id() — Method in class CheckDocumentation

Delete rows specified by condition and returns the affected rows.

NodeDocumentation::delete_by_id() — Method in class NodeDocumentation

Delete rows specified by condition and returns the affected rows.

$ Result#details — Property in class Result

DaemonCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

DatabaseCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

DiskCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

DocumentIndexCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

$ RecurringTaskDocumentation#deadline_days — Property in class RecurringTaskDocumentation

RecurringTaskDocumentation::delete_by_id() — Method in class RecurringTaskDocumentation

Delete rows specified by condition and returns the affected rows.

$ TaskDocumentation#description: — Property in class TaskDocumentation

stored in MySQL as text

$ TaskDocumentation#deadline: — Property in class TaskDocumentation

stored in MySQL as timestamp

TaskDocumentation::delete_by_id() — Method in class TaskDocumentation

Delete rows specified by condition and returns the affected rows.

$ ContactlogShowSidebar#documentIndex — Property in class ContactlogShowSidebar

$ Task#description — Property in class Task

$ Task#deadline — Property in class Task

Timestamp

$ Task#duplicate — Property in class Task

Task::delete() — Method in class Task

TaskList::delete() — Method in class TaskList

Delete Task

TaskListColumn::delete() — Method in class TaskListColumn

Deleting the column will delete all tasks within

SystemTasksController::deleteGroupContext() — Method in class SystemTasksController

Fetches all lists in this instance and deletes them, which will also trigger the deletion of all their tasks assigned.

VideoWorker::downloadConvertedVideo() — Method in class VideoWorker

VideoWorker::downloadSubtitles() — Method in class VideoWorker

PushClient::delete_by_id() — Method in class PushClient

Delete rows specified by condition and returns the affected rows.

TagDocumentation::delete_by_id() — Method in class TagDocumentation

Delete rows specified by condition and returns the affected rows.

Tag::deleteUnusedTags() — Method in class Tag

$ TagDocument#document_index_id — Property in class TagDocument

$ TranslationDocumentDocumentation#document_index_id — Property in class TranslationDocumentDocumentation

TranslationDocumentDocumentation::delete_by_id() — Method in class TranslationDocumentDocumentation

Delete rows specified by condition and returns the affected rows.

TranslationDocumentation::delete_by_id() — Method in class TranslationDocumentation

Delete rows specified by condition and returns the affected rows.

TranslationFeedbackDocumentation::delete_by_id() — Method in class TranslationFeedbackDocumentation

Delete rows specified by condition and returns the affected rows.

TranslationJobDocumentation::delete_by_id() — Method in class TranslationJobDocumentation

Delete rows specified by condition and returns the affected rows.

Deepl — Class in namespace XELOS\Modules\Translation\Lib\Api

Class Deepl

CommonOperationsTrait::delete() — Method in class CommonOperationsTrait

Deletes model and also deletes possible related translation_job models

TranslationFeedback::delete() — Method in class TranslationFeedback

Deletes model and also deletes possible related translation_job models

$ SystemDaemon#daemon_name — Property in class SystemDaemon

TranslationController::daemonProcessQueue() — Method in class TranslationController

Called by daemon to process the TranslationJob queue

Trendvote::delete_by_id() — Method in class Trendvote

Delete rows specified by condition and returns the affected rows.

Trendvote::delete() — Method in class Trendvote

Delete current trendvote and all its results.

FileDocumentation::delete_by_id() — Method in class FileDocumentation

Delete rows specified by condition and returns the affected rows.

ScanDocumentation::delete_by_id() — Method in class ScanDocumentation

Delete rows specified by condition and returns the affected rows.

DigestAuthentication — Class in namespace XELOS\Modules\Webdav\Hook\System

This class is being used exclusively for webdav requests and is not made public in the general authentication methods But we still want to keep the class / handling consistent - so we use the generic AuthenticationHook scheme

OAuthClientAction::decodeState() — Method in class OAuthClientAction

Parsing the state which keeps on end the modulename and hookname necessary to identifier

$ OAuthClientHook#description — Property in class OAuthClientHook

Description for the OAuth Client Hook will be used in create modal client

OAuthClient::disconnect() — Method in class OAuthClient

Logout

DocPage — Class in namespace XELOS\Modules\Webservice\Page

CategoryDocumentation::delete_by_id() — Method in class CategoryDocumentation

Delete rows specified by condition and returns the affected rows.

$ WidgetDocumentation#description_i18n: — Property in class WidgetDocumentation

stored in MySQL as text

WidgetDocumentation::delete_by_id() — Method in class WidgetDocumentation

Delete rows specified by condition and returns the affected rows.

AnswerDocumentation::delete_by_id() — Method in class AnswerDocumentation

Delete rows specified by condition and returns the affected rows.

ParticipantDocumentation::delete_by_id() — Method in class ParticipantDocumentation

Delete rows specified by condition and returns the affected rows.

SurveyDocumentation::delete_by_id() — Method in class SurveyDocumentation

Delete rows specified by condition and returns the affected rows.

E

$ UserDetails#email — Property in class UserDetails

Output::error() — Method in class Output

Core::error_response() — Method in class Core

Enum — Class in namespace XELOS\Framework\Core

Class Enum

ActionHelper::execute() — Method in class ActionHelper

Execute callback

CollectionActionHelper::expects() — Method in class CollectionActionHelper

Which type of collection is expected?

CollectionActionHelper::execute() — Method in class CollectionActionHelper

FormActionHelper::execute() — Method in class FormActionHelper

MagicDocumentHelper::enableExtendedAttachmentInfo() — Method in class MagicDocumentHelper

ModelActionHelper::expects() — Method in class ModelActionHelper

Which type of model is expected?

ModelActionHelper::execute() — Method in class ModelActionHelper

Template::enable_render_stage() — Method in class Template

ENABLE Pre-Rendering for template parsing

$ VarsTemplate#editor_id — Property in class VarsTemplate

GroupControllerInterface::ensureInitialization() — Method in class GroupControllerInterface

Makes sure the instance is initialized properly and ready to use.

Job::execute() — Method in class Job

Execute is your primary job execution function

Job::executeInJobQueue() — Method in class Job

When execute is called from Queue an additional QueueableJob Object is passed to execute

DocumentModel::enable_silent_mode() — Method in class DocumentModel

Sets the silent mode to true Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

Model::enable_table_group_id() — Method in class Model

Enable the use of the group ID in all queries made

$ SystemCron#error_count — Property in class SystemCron

Current Error Count

SystemDaemonThreaded::endThread() — Method in class SystemDaemonThreaded

Gets called within a thread before stopping thread

UIAjaxComponent::enable_periodical_update() — Method in class UIAjaxComponent

Enables the periodical update via ajax.

$ XF#event — Property in class XF

XF::exit() — Method in class XF

Config::enter_install_mode() — Method in class Config

Config::enable_return_cache() — Method in class Config

enable the caching of get config calls this will clear the current cache

Config::extract_config_fdl() — Method in class Config

Private helper that generates the fdl from a given config array.

MySQLAdapter::error() — Method in class MySQLAdapter

Returns a string description of the last error

MySQLAdapter::errno() — Method in class MySQLAdapter

Returns the error code for the most recent function call

MySQLAdapter::escape_string() — Method in class MySQLAdapter

MySQLAdapter::extract_search_term() — Method in class MySQLAdapter

MySQLAdapter::executeMysqlRestore() — Method in class MySQLAdapter

Restore mysql database from a mysqldump backup file

MySQLAdapter::executeMysqlDump() — Method in class MySQLAdapter

Take a mysqldump backup file

PartitionQuery::execute() — Method in class PartitionQuery

Query::escapeField() — Method in class Query

Escapes the passed mysql fieldname with backticks

Query::escapeValue() — Method in class Query

Escapes the passed value for using it in a mysql query

Query::execute() — Method in class Query

Execute Query and return Resultset

Event — Class in namespace XELOS\Framework\XF

Class Event

$ Event#event_registry — Property in class Event

$ Lib#export — Property in class Lib

$ Lib#error — Property in class Lib

Cache::enable_cache() — Method in class Cache

Enable the cache for the rest of this page call

ExtendedSoapClient — Class in namespace XELOS\Framework\XF\Lib\Connect

Class CustomSOAPClient

Date::extrapolate_date_by_rrule() — Method in class Date

Wrapper for rrule dependency Check https://github.com/rlanvin/php-rrule/wiki/RRule for more details

Date::evaluateRRule() — Method in class Date

Date::evaluate_rrule() — Method in class Date

$ Debug#enable_output — Property in class Debug

$ Debug#enable_debugging — Property in class Debug

Debug::enableDebugging() — Method in class Debug

Debug::enableDebugFunction() — Method in class Debug

Enable a certain debugging feature

Debug::enableTimeProfiling() — Method in class Debug

Enables timing sections throughout the framework with query counts.

Debug::endSection() — Method in class Debug

Stops a time section. Pass $type to sum multiple sections up, e.g. all sections of type 'query' will result in a sum

Environment — Class in namespace XELOS\Framework\XF\Lib

Error — Class in namespace XELOS\Framework\XF\Lib

Class Error

Export — Class in namespace XELOS\Framework\XF\Lib

Export Helper

$ Export#export_handler — Property in class Export

File::encode_file() — Method in class File

File::enable_stream_wrapper() — Method in class File

Include / Enable a certain stream wrapper Example: "smb://user:pass@server/share/path"

$ Filehandler#errors — Property in class Filehandler

Format::empty2nbsp() — Method in class Format

Formats the output for a table cell - if empty a NBSP is returned

Hierarchy::evaluate_result() — Method in class Hierarchy

evaluate_result

Link::encode_link_param() — Method in class Link

Encode Special Chars like [/,#=]

Logger::exception() — Method in class Logger

Logger::error() — Method in class Logger

Logger::emergency() — Method in class Logger

$ Mail#extract_html_options — Property in class Mail

Mail::extract_html_images() — Method in class Mail

Extracts all HTML Image Sources, changes their src names, downloads the files and returns an email attachment array Use to change external HTML image sources to inline attachment images

Mail::extract_html_images_cb() — Method in class Mail

Extract HTML images

Mention::extractMentionedUserIDs() — Method in class Mention

Get the IDs of the users and users that are members of groups mentioned in the text in either JSON or HTML notation.

$ Modsetup#errors — Property in class Modsetup

$ Modsetup#execute_sql — Property in class Modsetup

Modsetup::execute_sql_queue() — Method in class Modsetup

Modsetup::end_install_transaction() — Method in class Modsetup

closes given transaction and returns

Notification::email() — Method in class Notification

Send an email with notification template

Sec::execute_circumventing_rights() — Method in class Sec

Executes a given callback in CMD mode, thus circumventing any rights DO NOT USE LIGHTLY!!! This primarily aims at allowing reference and link resolval!

SecureEvalClass::execute() — Method in class SecureEvalClass

Execute the script

Shell::execute_cmd() — Method in class Shell

Shell::execute_cmd_in_background() — Method in class Shell

TokenCollection::exists() — Method in class TokenCollection

Returns true if the passed Token object exists. If a requiredLanguage is passed the token must also have a matching translation set

$ AuditTrail#event — Property in class AuditTrail

['created', 'updated', 'deleted', 'restored', 'misc'], default: 'misc'

ErrorLog — Class in namespace XELOS\Framework\XF\System\Model

$ Hierarchy#explicit_users — Property in class Hierarchy

Set of User IDs

User::enable_field_verification() — Method in class User

Enable the verification for the passed fields The following save() call will trigger a new verification request and informs the user to confirm this change

AjaxContainer::enable_periodical_update() — Method in class AjaxContainer

Enable updating of container via AJAX all x seconds

AjaxContainer::enable_use_back_history() — Method in class AjaxContainer

AjaxContainer::enable_fill_via_ajax() — Method in class AjaxContainer

If fill via Ajax is enabled, the callback data is not included in the original template output put will be loaded using an ajax request right after the page has been loaded Use this feature to offload load intensive data queries

AmchartGantt::enable_export() — Method in class AmchartGantt

Enables the export functionality for the graph

Breadcrumb::eval_xtag_params() — Method in class Breadcrumb

put your comment there.

Calendar::enable_paging() — Method in class Calendar

Enables the user to page through months/years

Calendar::enable_month_select() — Method in class Calendar

Enables the user to select months/years via dropdown

$ Doclink#exclude_actions — Property in class Doclink

$ Form#error_fields — Property in class Form

FroalaOption::embedlyKey() — Method in class FroalaOption

Your key from Embed.ly to remove the "Powered By Banner".

FroalaOption::embedlyEditButtons() — Method in class FroalaOption

The buttons that appear in the edit Embed.ly popup, when an embedded object is selected.

FroalaOption::embedlyInsertButtons() — Method in class FroalaOption

The buttons that appear in the insert Embed.ly popup, when an embeded object is inserted into the WYSIWYG editor.

FroalaOption::embedlyScriptPath() — Method in class FroalaOption

The default script path for the Embedly JS.

FroalaOption::emoticonsButtons() — Method in class FroalaOption

Buttons set for emoticons popup.

FroalaOption::emoticonsSet() — Method in class FroalaOption

An array of emoticons available in the insert emoticon popup. Each emoticon is defined by an Object containing the code and description of each emoticon.

FroalaOption::emoticonsUseImage() — Method in class FroalaOption

Use EmojiOne svg images instead of Unicode text.

FroalaOption::emoticonsStep() — Method in class FroalaOption

The number of emoticons displayed on a line in the insert emoticon popup.

FroalaOption::entities() — Method in class FroalaOption

A list with the characters that are reserved in HTML. More details about using entities in HTML can be found on <a href="https://dev.w3.org/html5/html-author/charref" target="_blank" rel="nofollow">W3C and <a href="https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references" target="_blank" rel="nofollow">Wikipedia.

FroalaOption::editInPopup() — Method in class FroalaOption

Edit the text inside the HTML element on which the editor is initialized on in a popup.

FroalaOption::editorClass() — Method in class FroalaOption

Set a custom class for the WYSIWYG editor editing box.

FroalaOption::enter() — Method in class FroalaOption

Set the default tag to be used when ENTER key is hit. Possible values are FroalaEditor.ENTER_P, FroalaEditor.ENTER_DIV or FroalaEditor.ENTER_BR.

FroalaOption::events() — Method in class FroalaOption

The options used for WebSpellChecker.

$ HtmlGeneric#exclude — Property in class HtmlGeneric

$ Table#export_filename — Property in class Table

When exported the file will have the name provided here.

Table::enable_optional_fields() — Method in class Table

Table::enable_table_options() — Method in class Table

Table::enable_periodical_update() — Method in class Table

Enable periodical update (JS function)

Table::enable_tooltips() — Method in class Table

Table::enable_grouping() — Method in class Table

Table::enable_select_column() — Method in class Table

Table::export() — Method in class Table

Export (get_table-Alias)

TableEditor::enable_model_sort() — Method in class TableEditor

TableEditor::enableAjax() — Method in class TableEditor

Tree::enable_checkboxes() — Method in class Tree

Wizard::enable_control_next() — Method in class Wizard

put your comment there.

User::executeInUserContext() — Method in class User

Execute function in user context

View::execute() — Method in class View

UserDevicesUserConfig::extractAuthCode() — Method in class UserDevicesUserConfig

ExportPage — Class in namespace XELOS\Modules\Administration\Page

$ MicrosoftOauthClient#endpoint — Property in class MicrosoftOauthClient

$ OnedriveOauthClient#endpoint — Property in class OnedriveOauthClient

$ Action#export — Property in class Action

Action::export() — Method in class Action

$ Model#event — Property in class Model

$ Model#event_core — Property in class Model

$ Model#event_instance — Property in class Model

Model::event() — Method in class Model

Model::event_core() — Method in class Model

Model::event_instance() — Method in class Model

$ Page#edit — Property in class Page

$ Page#event_invitation — Property in class Page

Page::edit() — Method in class Page

Page::event_invitation() — Method in class Page

$ Calendarset#export_calendars: — Property in class Calendarset

stored in MySQL as text

Event — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model event.

$ Event#end_date: — Property in class Event

stored in MySQL as date

$ Event#end: — Property in class Event

stored in MySQL as timestamp

$ Event#event_mode: — Property in class Event

enum event_only|event_invitation|event_vote|event_vote_link|event_vote_closed

$ Participant#event_id — Property in class Participant

$ SyncData#event_id — Property in class SyncData

$ SyncData#event_data: — Property in class SyncData

stored in MySQL as mediumblob

$ Page#edit — Property in class Page

Page::edit() — Method in class Page

$ HistoryPage#edited_by — Property in class HistoryPage

$ Page#edited_by — Property in class Page

$ PageLive#edited_by — Property in class PageLive

CommentsController::ensureInitialization() — Method in class CommentsController

Not much is needed to run this instance after installation, so just the init method will be called.

$ PostAction#events — Property in class PostAction

$ PostAction#event_series — Property in class PostAction

EventCollection — Class in namespace XELOS\Modules\Eventplanner\Collection

EventplannerControllerDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Model#event — Property in class Model

Model::event() — Method in class Model

$ Page#event_action — Property in class Page

Page::event_action() — Method in class Page

$ Ui#event — Property in class Ui

EventDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Event.

$ EventDocumentation#end: — Property in class EventDocumentation

stored in MySQL as timestamp

$ InvitationReplyLogDocumentation#event_id — Property in class InvitationReplyLogDocumentation

$ JobDocumentation#event_id — Property in class JobDocumentation

$ ParticipantDocumentation#event_id — Property in class ParticipantDocumentation

$ ParticipantDocumentation#email: — Property in class ParticipantDocumentation

stored in MySQL as varchar

$ ParticipantLogDocumentation#event_id — Property in class ParticipantLogDocumentation

$ RelatedEventsDocumentation#event_ids: — Property in class RelatedEventsDocumentation

stored in MySQL as varchar

EventplannerController — Class in namespace XELOS\Modules\Eventplanner

EventplannerController::ensureInitialization() — Method in class EventplannerController

Makes sure at least one category exists.

EventManagementNavigation — Class in namespace XELOS\Modules\Eventplanner\Hook\Dashboard

EventplannerUpcomingShowPortlet — Class in namespace XELOS\Modules\Eventplanner\Hook\Portal

Event — Class in namespace XELOS\Modules\Eventplanner\Model

Participant::exchange_placeholders() — Method in class Participant

EventActionPage — Class in namespace XELOS\Modules\Eventplanner\Page

Event — Class in namespace XELOS\Modules\Eventplanner\UI

$ Page#edit — Property in class Page

Page::edit() — Method in class Page

ForumController::ensureInitialization() — Method in class ForumController

Create default category and thread

EditPage — Class in namespace XELOS\Modules\Forum\Page

Class EditPage

$ Step#editCategoryRoute — Property in class Step

$ Step#editThreadRoute — Property in class Step

$ Step#editPostRoute — Property in class Step

Step::editCategory() — Method in class Step

Step::editPost() — Method in class Step

$ Model#external_invitation — Property in class Model

Model::external_invitation() — Method in class Model

EventplannerPortlet — Class in namespace XELOS\Modules\Groups\Hook\Pages

ArchiveGroupJob::execute() — Method in class ArchiveGroupJob

DeleteGroupJob::execute() — Method in class DeleteGroupJob

GroupUserContentJob::execute() — Method in class GroupUserContentJob

SetInactiveAndNotifyJob::execute() — Method in class SetInactiveAndNotifyJob

$ JobDocumentation#error_message: — Property in class JobDocumentation

stored in MySQL as text

$ JobHistoryDocumentation#error_message: — Property in class JobHistoryDocumentation

stored in MySQL as text

JobScheduler::executeQueuedJob() — Method in class JobScheduler

BatchJob::execute() — Method in class BatchJob

Schedule all jobs in this batch

BatchJob::executeInJobQueue() — Method in class BatchJob

TestJob::execute() — Method in class TestJob

Execute is your primary job execution function

$ Page#edit_item — Property in class Page

Page::edit_item() — Method in class Page

EnsureFormPayloadAction — Class in namespace XELOS\Modules\Lists\Hook\Workflows

ReindexJob::execute() — Method in class ReindexJob

ListsController::ensureInitialization() — Method in class ListsController

Makes sure a default category will be set with it's corresponding rights preset

$ ListItem#end_at — Property in class ListItem

Timespan value to end at

EditItemPage — Class in namespace XELOS\Modules\Lists\Page

Email — Class in namespace XELOS\Modules\Lookbook\Fields

EventCollector — Class in namespace XELOS\Modules\Lookbook\Hook\SystemStats

PublishJob::execute() — Method in class PublishJob

NewsController::ensureInitialization() — Method in class NewsController

This makes sure at least one category exists.

$ Page#editor — Property in class Page

Page::editor() — Method in class Page

EditorPage — Class in namespace XELOS\Modules\Pages\Page

Class Overview

ExportPage — Class in namespace XELOS\Modules\Pages\Page

Class Overview

ReadConfirmationController::ensureInitialization() — Method in class ReadConfirmationController

Makes sure the instance is initialized properly and ready to use.

ElasticSearchAdapter — Class in namespace XELOS\Modules\Search\Adapter

Elastic Search Adapter Uses an Elastic Search Server for indexing and search operations in XELOS

$ ElasticSearchAdapter#elastic_client — Property in class ElasticSearchAdapter

ElasticSearch Client - is initialized on first getElasticSearchClient() call

$ ElasticSearchAdapter#elastic_index_name — Property in class ElasticSearchAdapter

ElasticSearch Index Name

$ ElasticSearchAdapter#elastic_alias_name — Property in class ElasticSearchAdapter

We will use the alias name as primary method to read, write to the index Default is {$elastic_index_name}-alias = xelos-alias

$ ElasticSearchAdapter#elastic_index_version — Property in class ElasticSearchAdapter

Increase this manually if changes to the index were made which required re-indexing Please note that not all operations can be done with a local reindex and may require an XELOS reindex process. You should cover this in MAJOR releases and with a proper install event.

$ ElasticSearchAdapter#elastic_shard_count — Property in class ElasticSearchAdapter

When using a single instance, using 1 shard will save memory When using a cluster, you should have at least 3 shards otherwise they cannot be balanced ES Defaults (v6=5, v7=1)

$ ElasticSearchAdapter#elastic_replica_count — Property in class ElasticSearchAdapter

When using a single instance, no replica will be started, even with replica=1 (Status will stay yellow) When using a cluster, you should use at least 1 replica - but we can also use 2 replica for more read performance ES Default: 1

$ ElasticSearchAdapter#elastic_tentant_id — Property in class ElasticSearchAdapter

Ability to use a shared elastic index

QueryBuilder::escapeQuery() — Method in class QueryBuilder

Elastic Search has Reserved Characters which need escaping https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters

$ AbstractDocumentBrowser#enable_load_more — Property in class AbstractDocumentBrowser

$ AbstractDocumentBrowser#enable_search — Property in class AbstractDocumentBrowser

$ AbstractDocumentBrowser#enable_context_menu — Property in class AbstractDocumentBrowser

$ BrowserFile#ext — Property in class BrowserFile

$ Page#edit — Property in class Page

$ Page#export — Property in class Page

Page::edit() — Method in class Page

Page::export() — Method in class Page

EditPage — Class in namespace XELOS\Modules\SmartWiki\Page

ExportPage — Class in namespace XELOS\Modules\SmartWiki\Page

SmartWikiController::export_pages() — Method in class SmartWikiController

Exports wiki pages to various output formats

SmartWikiController::ensureInitialization() — Method in class SmartWikiController

This makes sure at least the home page exists.

EntryCollection — Class in namespace XELOS\Modules\SystemActionlog\Collection

$ Model#entry — Property in class Model

Model::entry() — Method in class Model

EntryDocumentation — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\Model

This file provides property and method documentation for the model entry.

SendWallDigestJob::execute() — Method in class SendWallDigestJob

Execute is your primary job execution function

Entry — Class in namespace XELOS\Modules\SystemActionlog\Model

Class XELOS\Modules\SystemActionlog\Model\xm_system_actionlog_entry

$ SystemActionlogController#exclude_instances — Property in class SystemActionlogController

$ SystemActionlogController#exclude_users — Property in class SystemActionlogController

EventTrigger — Class in namespace XELOS\Modules\SystemAdmin\Docs\ClassGenerated\Model

This file provides property and method documentation for the model EventTrigger.

$ EventTrigger#event: — Property in class EventTrigger

stored in MySQL as varchar

PreviewJob::execute() — Method in class PreviewJob

Main Job Execution Logic

Category::evaluateTemplateId() — Method in class Category

Evaluates the first possible template ID from the category (and parent categories) and returns it.

$ SystemDMSController#enable_search_index — Property in class SystemDMSController

SystemDMSController::ensureInitialization() — Method in class SystemDMSController

Creates a default category within current context if no root category exists.

FolderTreePanel::enrich_with_ancestors() — Method in class FolderTreePanel

Add the document index ids of all ancestors of the document indexes in the passed array

$ ZipImportJob#error_msg — Property in class ZipImportJob

: stored in MySQL as varchar

EmailNotificationChannel — Class in namespace XELOS\Modules\SystemNotification\Hook\Notification

Class EmailNotificationHook

CreateNotificationJob::execute() — Method in class CreateNotificationJob

SendNotificationJob::execute() — Method in class SendNotificationJob

$ PushSubscription#error_count — Property in class PushSubscription

EventCollection — Class in namespace XELOS\Modules\SystemStats\Collection

$ Model#event — Property in class Model

Model::event() — Method in class Model

EventDocumentation — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Event.

EventCollector — Class in namespace XELOS\Modules\SystemStats\Hook\SystemStats

Event — Class in namespace XELOS\Modules\SystemStats\Model

TaskList::ensure_default_list() — Method in class TaskList

checks if there is at least one list and if not, create one

SystemTasksController::ensureInitialization() — Method in class SystemTasksController

Uses another method to make sure at least one list exists and this instance is ready to use.

VideoWorker::encodeVideo() — Method in class VideoWorker

$ TranslationJobDocumentation#error_count — Property in class TranslationJobDocumentation

$ Trendvote#end_at: — Property in class Trendvote

stored in MySQL as timestamp

$ Trendvote#end_at — Property in class Trendvote

FileDeleteJob::execute() — Method in class FileDeleteJob

OAuthClientAction::encodeState() — Method in class OAuthClientAction

Method::execute() — Method in class Method

Execute Method with argument supplied by the API

ModelMethod::extractAttachmentInfoFromInputArray() — Method in class ModelMethod

Extract attachment information from InputArray

$ OAuthClient#endSessionUrl — Property in class OAuthClient

A URL where you can end a session by revoking an access_token.

$ OAuthClient#expires — Property in class OAuthClient

The lifetime in seconds of the access token

$ OpenIDConfiguration#endSessionEndpoint — Property in class OpenIDConfiguration

OauthAccess::exists() — Method in class OauthAccess

ExportException — Class in namespace XELOS\Modules\Workflows\Exceptions

Class ImportException

ExampleBeatTheSystemController — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleBeatTheSystem

ExampleSurveyControllerDocumentation — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ SurveyDocumentation#end_date: — Property in class SurveyDocumentation

stored in MySQL as timestamp

ExampleSurveyController — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey

F

$ Autoloader#file_prefix — Property in class Autoloader

File Prefixes used by XELOS in front of module name

Autoloader::from_camel_case() — Method in class Autoloader

Returns the passed name in underscore writing (TestClass --> test_class)

$ UserDetails#firstname — Property in class UserDetails

Table::fillByArray() — Method in class Table

Fills the table with a passed data array containing rows and their named/keyed columns Special Keys: _separator Set this key and will it with a separator caption to output a separator line

Table::fillByModelCollection() — Method in class Table

Fill by Model Collection

$ Core#full_module_namespace_support — Property in class Core

FormActionHelper — Class in namespace XELOS\Framework\Core\Helper

Use this action for form actions based on a single model

$ Template#file_cache — Property in class Template

$ Template#final_render_call — Property in class Template

Template::format_template_specialchars() — Method in class Template

Escape / Convert Template specific characters (###;{{{;}}})

ItemListTrait::first() — Method in class ItemListTrait

Get first element

$ ObjectManager#factory_mode — Property in class ObjectManager

This property effects the object cache. By default it is set to false to enable the object cache for all requested objects. If this property is set true, the object cache will be disabled.

$ Controller#full_module_namespace_support — Property in class Controller

$ LegacyController#full_module_namespace_support — Property in class LegacyController

Collection::filterByTags() — Method in class Collection

Returns articles if they are in one of the given tags.

Collection::filterByDocumentIndexCollection() — Method in class Collection

Filter a DocumentCollection by using a DocumentIndexCollection

Collection::filterBySearchQuery() — Method in class Collection

Collection::filterByDateRange() — Method in class Collection

Scope the Collection with $start date and/or $end date on the given $dateProperty.

Collection::filterByReferencingCollection() — Method in class Collection

Apply filter scopes based on a relation, e.g. filter a UserCollection by using user_id from your DocumentCollection This function is similar to ->scope_by_id($referencingCollection->pluck('related_id')) but will avoid db calls and minimize queries whenever possible.

Collection::filterByRelatedCollection() — Method in class Collection

Apply filter scopes based on a relation, e.g. filter a ArticleCollection by using id from a UserCollection This function is similar to ->scope_by_user_id($userCollection->pluck('id')) but will avoid db calls and minimize queries whenever possible.

Collection::filter() — Method in class Collection

DocumentModel::fetchByUuid() — Method in class DocumentModel

Get Document by using the uuid

SoftDeleteInterface::forceDelete() — Method in class SoftDeleteInterface

$ Model#find_by_separators — Property in class Model

Model::find() — Method in class Model

Find Function to find models using the passed condition

Model::functionNameToQuery() — Method in class Model

Converts a findby* function name to SQL query.

Model::find_by_TABLE_COL() — Method in class Model

Returns all models with a specific column value. Query params can be e.g. order_by

Model::find_all_by_TABLE_COL_and_TABLE_COL2() — Method in class Model

Returns loaded ModelCollection

ModelCollection::filter() — Method in class ModelCollection

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

ModelCollection::first() — Method in class ModelCollection

Get first model of collection, without shifting

CollectionCacheTrait::find_by_id() — Method in class CollectionCacheTrait

Wraps the find_by_id() method, to use the search_by_id() method on the cached model collection

CollectionCacheTrait::find_all_by_id() — Method in class CollectionCacheTrait

Wraps the find_all_by_id() method, to use the search_all_by_id() method on the cached model collection

SoftDeleteTrait::forceDelete() — Method in class SoftDeleteTrait

Will execute standard model delete method.

$ MySQLAdapter#fatal_on_error — Property in class MySQLAdapter

MySQLAdapter::formatQueryForSinglelineOutput() — Method in class MySQLAdapter

Helper to Format multi-line SQL statements into a single line for log output NOTE: The resulting query string is for display purposes only and should not be used again as query as also field values may be shortened

PartitionQuery::fromQuery() — Method in class PartitionQuery

$ Lib#format — Property in class Lib

$ Lib#file — Property in class Lib

$ Lib#filehandler — Property in class Lib

$ Lib#foaf — Property in class Lib

Ajax::finish() — Method in class Ajax

Connect::function_exists() — Method in class Connect

Checks wether a certain function is available on the connect server side

Convert::from_file() — Method in class Convert

Convert::from_stream() — Method in class Convert

Convert::from_pdf() — Method in class Convert

Convert::from_txt() — Method in class Convert

Convert::from_ppt() — Method in class Convert

Convert::from_xls() — Method in class Convert

Try converting old 97 Excel to string e.g. for search index

Convert::from_doc() — Method in class Convert

Try converting old .doc files to string

Convert::from_html() — Method in class Convert

Convert::from_docx() — Method in class Convert

Return Text only from Word 2007 Document

Convert::from_xlsx() — Method in class Convert

Return Text only from Excel 2007 Document

Convert::from_pptx() — Method in class Convert

Return Text only from Powerpoint 2007 Document

$ Debug#forced_debugging — Property in class Debug

SlimTimer::finish() — Method in class SlimTimer

File — Class in namespace XELOS\Framework\XF\Lib

File::filter_by_extension() — Method in class File

File::filter_by_wildcard() — Method in class File

File::filter_onlyfiles() — Method in class File

File::file_exists_cached() — Method in class File

Checks if the passed file exists, cached for the current call

Filehandler — Class in namespace XELOS\Framework\XF\Lib

$ Filehandler#fileinfo — Property in class Filehandler

Foaf — Class in namespace XELOS\Framework\XF\Lib

Format — Class in namespace XELOS\Framework\XF\Lib

Format Library which allows a country specific formatting of numbers and dates and various other format functions

Format::format_text() — Method in class Format

Format Text String e.g. with Markdown

Format::format_highlight_syntax() — Method in class Format

Highlight Passed Text using a Syntax Highlighter Engine

Format::format_userlink() — Method in class Format

Takes a numeric input and returns an rendered XUI_USERLINK

Format::format_cast() — Method in class Format

Format::format_contrast_color() — Method in class Format

Format::format_uuid() — Method in class Format

Format UUID (binary 16) to string representation

Format::formatUUID() — Method in class Format

Format::format_sprintf() — Method in class Format

Format::format_string() — Method in class Format

Format::format_by_callback() — Method in class Format

Format::format_filesize() — Method in class Format

Format file size

Format::format_insert() — Method in class Format

Format::format_boolean() — Method in class Format

Formats a boolean value

Format::format_percent() — Method in class Format

Formats a percent value

Format::format_duration() — Method in class Format

Format Duration

Format::format_time() — Method in class Format

Formats a time

Format::format_date() — Method in class Format

Formats a date

Format::format_friendly_date() — Method in class Format

Format::format_datetime() — Method in class Format

Formats a date time

Format::format_timespan() — Method in class Format

Formats a timespan between two dates

Format::format_money() — Method in class Format

Formats a money amount

Format::format_number() — Method in class Format

Formats a number according to local standards and options

Format::format_email() — Method in class Format

Format::format_rrule() — Method in class Format

Formats an rrule to a verbose label

Format::format_number_js() — Method in class Format

Formats a number to be used in javascript (replace ',' with '.' and remove any spaces

Format::format_text_js() — Method in class Format

Formats a text to be included in javascript

Format::format_actionplaceholder() — Method in class Format

Format::format_hashtags() — Method in class Format

Returns a well formatted HTML of the passed tags with special formatting of the hashtags

Format::format_template_specialchars() — Method in class Format

FakeData — Class in namespace XELOS\Framework\XF\Lib\Installer\Seed

Class FakeData Helper Class to generate Models based on FAKE data

DefaultFormatter::format() — Method in class DefaultFormatter

HtmlMailFormatter::format() — Method in class HtmlMailFormatter

$ Mail#force_from_address — Property in class Mail

$ Mail#force_from_name — Property in class Mail

Policy::find_users_with_policy() — Method in class Policy

QueueableJobBuilder::findByJobUniqueId() — Method in class QueueableJobBuilder

Sec::filename() — Method in class Sec

Make sure a filename does not contain any directory characters to prevent unallowed traversals

$ UserImport#findExistingUserCallback — Property in class UserImport

A callback to find an existing user. $userData is given as first function parameter.

DocumentIndexCollection::filterByIsVisible() — Method in class DocumentIndexCollection

Do not show hidden document indexes

DocumentIndexReferenceCollection::filterByReferenceModule() — Method in class DocumentIndexReferenceCollection

InstanceRegistryCollection::filterByAccessible() — Method in class InstanceRegistryCollection

InstanceRegistryCollection::first() — Method in class InstanceRegistryCollection

ModuleGroupSecurityCollection::filterByGroupInstanceAndRelatedCollection() — Method in class ModuleGroupSecurityCollection

ModuleGroupSecurityCollection::filterByAccessible() — Method in class ModuleGroupSecurityCollection

Filter collection by membership and group type

ModuleGroupSecurityCollection::filterByGroupHasAccessibleComments() — Method in class ModuleGroupSecurityCollection

ModuleRegistryCollection::filterByAccessible() — Method in class ModuleRegistryCollection

ModuleRegistryCollection::first() — Method in class ModuleRegistryCollection

NotificationCollection::filterByUser() — Method in class NotificationCollection

Filter notifications for user

NotificationCollection::filterByParentDocumentId() — Method in class NotificationCollection

Returns all notifications for all documents which have the passed document as parent

NotificationCollection::filterByDefaultNotificationStatus() — Method in class NotificationCollection

Filter Collection by the default states, which shows "visible notifications" to the user

UserCollection::filterByUserGroup() — Method in class UserCollection

Filter users having a specific group/role

UserCollection::filterByUserGroups() — Method in class UserCollection

Only include users from specific user groups

UserCollection::filterByStatus() — Method in class UserCollection

Filter collection by user status

UserCollection::filterByLastLogin() — Method in class UserCollection

Adds scope with $start date and/or $end date for last_login.

UserCollection::filterByIsVisible() — Method in class UserCollection

Remove users which are considered not visible by the current user

UserCollection::filterByIsWriteable() — Method in class UserCollection

Remove users which are considered not writable by the current user

UserCollection::filterUsersGroupsByPolicyAccess() — Method in class UserCollection

Narrows down the current user-collection to the passed policy-collection and the values.

UserCollection::filterByPageAccess() — Method in class UserCollection

Filters the current user-collection by the given pages and their access to it.

UserCollection::filterByAccessibleGroups() — Method in class UserCollection

Scopes the current user-collection by the passed group security ID.

$ Model#follows — Property in class Model

FrontendBackgroundUpdateInterface — Class in namespace XELOS\Framework\XF\System\Hook

Interface FrontendBackgroundUpdateInterface

AuditTrail::find_by_id() — Method in class AuditTrail

DocumentIndex::fetchDocumentIndexById() — Method in class DocumentIndex

Returns the document index object This uses an internal cache if already fetched.

DocumentIndex::fetchDocumentIndex() — Method in class DocumentIndex

Returns the document index object for given model information.

DocumentIndex::fetchDocumentIndexByUuid() — Method in class DocumentIndex

Returns the document index object for given model information.

DocumentIndex::fetchDocumentIndexCollectionByUuid() — Method in class DocumentIndex

Returns the document index object for given model information.

DocumentIndex::fetchDocumentIndexCollectionByUuidOrId() — Method in class DocumentIndex

Returns the document index object for given model information.

DocumentIndex::fetchDocumentIndexes() — Method in class DocumentIndex

DocumentIndex::fetchRelatedDocumentByUuid() — Method in class DocumentIndex

Return documentModel for given ModuleControllerClass

DocumentIndex::find_all_by_id() — Method in class DocumentIndex

Returns a collection document index models or false if not found

DocumentIndex::find_by_id() — Method in class DocumentIndex

Returns a collection document index model or false if not found

DocumentIndex::findWithDeletedById() — Method in class DocumentIndex

Returns a document even if deleted This method avoids caching mechanisms of document index, as cache will not have deleted items

DocumentIndex::filterReadable() — Method in class DocumentIndex

Return document only if considered readable/accessible by the current user

DocumentIndex::find_all_by_post_id_and_post_type_and_instance_id() — Method in class DocumentIndex

DocumentIndex::find_all_by_parent_document() — Method in class DocumentIndex

DocumentIndex::find_all_by_parent_group_document() — Method in class DocumentIndex

DocumentIndex::find_by_uuid() — Method in class DocumentIndex

DocumentIndexJobQueue::fetchNextJobs() — Method in class DocumentIndexJobQueue

Returns the next jobs and marks them as being processed

DocumentIndexJobQueue::fetchJobsForClusterEval() — Method in class DocumentIndexJobQueue

DocumentIndexJobQueue::finish() — Method in class DocumentIndexJobQueue

Marks this job as finished and removes it from the queue

DocumentIndexJobQueue::find_all_by_processing_owner() — Method in class DocumentIndexJobQueue

DocumentIndexPolicyCluster::find_all_by_document_index_id() — Method in class DocumentIndexPolicyCluster

DocumentIndexPolicyCluster::find_all_by_document_index_id_and_sample_user_id() — Method in class DocumentIndexPolicyCluster

DocumentIndexReference::find_all_by_reference_canonical() — Method in class DocumentIndexReference

Find all references pointing to the given document canonicals

DocumentIndexReference::find_by_document_canonical_and_reference_canonical() — Method in class DocumentIndexReference

DocumentIndexReference::find_by_document_index_id_and_reference_index_id() — Method in class DocumentIndexReference

DocumentIndexReference::find_all_by_document_index_id() — Method in class DocumentIndexReference

Follows — Class in namespace XELOS\Framework\XF\System\Model

Follows::find_all_by_target_type_and_target_id() — Method in class Follows

Follows::find_by_user_id_and_target_type_and_target_id() — Method in class Follows

GlobalConfig::find_by_module_name_and_config_var() — Method in class GlobalConfig

GlobalConfig::find_by_id() — Method in class GlobalConfig

Group::find_all_by_resolved_id() — Method in class Group

Return all Security Groups which match id or name

Group::find_all_children_by_root() — Method in class Group

Returns a ModelCollection of Group models, which are direct children of given $root

Hierarchy::find_all_by_canonical() — Method in class Hierarchy

Hierarchy::find_by_id() — Method in class Hierarchy

Hierarchy::find_all_by_context_id() — Method in class Hierarchy

HierarchyContext::find_by_id() — Method in class HierarchyContext

I18nLanguage::find_by_status() — Method in class I18nLanguage

InstanceConfig::find_by_instance_id_and_config_var() — Method in class InstanceConfig

InstanceConfig::find_by_id() — Method in class InstanceConfig

InstanceConfig::find_all_by_config_var_and_config_value() — Method in class InstanceConfig

InstanceRegistry::find_by_instance_id() — Method in class InstanceRegistry

InstanceRegistry::find_all_by_module_name() — Method in class InstanceRegistry

InstanceRegistry::find_all_by_instance_id() — Method in class InstanceRegistry

ModuleGroupSecurity::find_all_by_member() — Method in class ModuleGroupSecurity

Get all groups the user is a member of

ModuleGroupSecurity::find_by_id() — Method in class ModuleGroupSecurity

ModuleRegistry::find_by_module_name() — Method in class ModuleRegistry

Navigation::find_by_id() — Method in class Navigation

Notification::find_all_by_token() — Method in class Notification

Notification::find_all_by_user_id_and_status_and_type() — Method in class Notification

Notification::find_all_by_user_id_and_status_and_token_and_instance_id() — Method in class Notification

Notification::find_by_instance_id_and_user_id_and_token() — Method in class Notification

Notification::find_by_id() — Method in class Notification

$ OnboardingCode#fail_count — Property in class OnboardingCode

OnboardingCode::findByFullOnboardingCode() — Method in class OnboardingCode

Find

OnboardingCode::find_by_user_id() — Method in class OnboardingCode

$ Pages#filter_allow — Property in class Pages

$ Pages#filter_deny — Property in class Pages

Pages::find_all_by_level_and_instance_id() — Method in class Pages

Pages::find_all_by_id() — Method in class Pages

Policy::find_by_name() — Method in class Policy

Policy::find_by_name_and_instance_id() — Method in class Policy

Policy::find_all_by_instance_id_and_type() — Method in class Policy

Policy::find_all_by_instance_id() — Method in class Policy

Policy::find_by_instance_id_and_name() — Method in class Policy

Policy::find_all_by_instance_id_and_name() — Method in class Policy

Policy2Group::find_all_by_policy_id_and_parity() — Method in class Policy2Group

Policy2Group::find_by_policy_id_and_group_security_id_and_group_id_and_value() — Method in class Policy2Group

Policy2User::find_all_by_policy_id_and_parity() — Method in class Policy2User

ThemeSet::find_by_id() — Method in class ThemeSet

User::filter_user_ids_by_status() — Method in class User

Filter a given set of user_ids and returning only user_ids with matching status

User::find_all_by_user_group() — Method in class User

Find all users belonging to a certain security group, which are NOT disabled

User::find_all_by_id() — Method in class User

User::find_all_by_displayname() — Method in class User

User::find_by_login() — Method in class User

User::find_by_id() — Method in class User

UserDevices::find_by_id() — Method in class UserDevices

UserDevices::find_all_by_auth_token_and_updated_at() — Method in class UserDevices

UserDevices::find_all_by_is_temporary_and_is_apiclient_and_updated_at() — Method in class UserDevices

UserLog::find_by_id() — Method in class UserLog

UserPropertyLog::find_all_by_user_log_id() — Method in class UserPropertyLog

$ UI#flash_messages — Property in class UI

$ UI#feed_links — Property in class UI

UI::flash_message() — Method in class UI

Stores the passed message as flash message until the next page call

AmchartBar::fill_by_array() — Method in class AmchartBar

Fill Chart with Assoc Array (Category => Value, Category => Value)

AmchartBar::format_category_as_date() — Method in class AmchartBar

Formats the category name into an local date

AmchartPie::fill_by_array() — Method in class AmchartPie

Fill Chart with Assoc Array (Category => Value, Category => Value)

Breadcrumb::fill_by_table() — Method in class Breadcrumb

Breadcrumb::fill_by_tree() — Method in class Breadcrumb

$ Css#folder — Property in class Css

Faceted — Class in namespace XELOS\Framework\XF\UI

FacetedFilter — Class in namespace XELOS\Framework\XF\UI

FacetedLegacy — Class in namespace XELOS\Framework\XF\UI

FacetedCategory — Class in namespace XELOS\Framework\XF\UI\Faceted

$ FacetedCategory#faceted — Property in class FacetedCategory

FacetedCategoryChoice — Class in namespace XELOS\Framework\XF\UI\Faceted

Facet filter, with multiple items to choose from

FacetedCategoryDate — Class in namespace XELOS\Framework\XF\UI\Faceted

FacetedCategoryItem — Class in namespace XELOS\Framework\XF\UI\Faceted

FacetedCategoryList — Class in namespace XELOS\Framework\XF\UI\Faceted

FacetedCategoryMultipleChoice — Class in namespace XELOS\Framework\XF\UI\Faceted

Facet filter, with multiple items to choose from

FacetedCategoryTextSearch — Class in namespace XELOS\Framework\XF\UI\Faceted

FacetedCategoryToggle — Class in namespace XELOS\Framework\XF\UI\Faceted

Toggle Option.

Form — Class in namespace XELOS\Framework\XF\UI

Class Form

$ Form#fields — Property in class Form

$ Form#field_default_options — Property in class Form

$ Form#feedback — Property in class Form

Form::form_request_valid() — Method in class Form

Form::form_has_required_fields() — Method in class Form

Returns true if the form contains required fields

Form::fdl2form() — Method in class Form

FormEditor — Class in namespace XELOS\Framework\XF\UI

$ FormEditor#field_name — Property in class FormEditor

$ FormEditor#form_name — Property in class FormEditor

FormBase — Class in namespace XELOS\Framework\XF\UI\Form

Class FormBase

$ FormBase#form — Property in class FormBase

$ FormBase#field_disable_save — Property in class FormBase

Set to false if this field is not "saveable", e.g. static test

FormButton — Class in namespace XELOS\Framework\XF\UI\Form

Class FormButton

FormCaptcha — Class in namespace XELOS\Framework\XF\UI\Form

Class FormCaptcha Field is automatically considered as required

FormCatSelector — Class in namespace XELOS\Framework\XF\UI\Form

the following fdl is needed to initiate a callback: 'callback'=>array($module_instance,'callback_func_name'[,array('param_key'=>'param_value',...)]) the selector will call the method $this->callback_func_name(Array $params) after the tree has been initialized.

FormCategorySelector — Class in namespace XELOS\Framework\XF\UI\Form

Class FormCategorySelector

FormCheckbox — Class in namespace XELOS\Framework\XF\UI\Form

FormChoice — Class in namespace XELOS\Framework\XF\UI\Form

FormColor — Class in namespace XELOS\Framework\XF\UI\Form

Class FormColor

FormComponent — Class in namespace XELOS\Framework\XF\UI\Form

Class FormComponent

$ FormComponent#form — Property in class FormComponent

FormConfig — Class in namespace XELOS\Framework\XF\UI\Form

$ FormConfig#field — Property in class FormConfig

FormContentAttachment — Class in namespace XELOS\Framework\XF\UI\Form

Attachment component to manage content references like Trendvotes

FormDate — Class in namespace XELOS\Framework\XF\UI\Form

Class FormDate

FormDatetime — Class in namespace XELOS\Framework\XF\UI\Form

Class FormDatetime

FormDescription — Class in namespace XELOS\Framework\XF\UI\Form

Class FormDescription

$ FormDescription#field_disable_save — Property in class FormDescription

FormDocument — Class in namespace XELOS\Framework\XF\UI\Form

Class FormDocument

FormDynConfig — Class in namespace XELOS\Framework\XF\UI\Form

Class FormDynConfig

FormEmail — Class in namespace XELOS\Framework\XF\UI\Form

Class FormEmail

FormFieldset — Class in namespace XELOS\Framework\XF\UI\Form

Class FormFieldset

FormFieldsetClose — Class in namespace XELOS\Framework\XF\UI\Form

Class FormFieldsetClose

FormFile — Class in namespace XELOS\Framework\XF\UI\Form

Class FormFile

$ FormFile#file_select — Property in class FormFile

$ FormFile#file_name — Property in class FormFile

$ FormFile#file_path — Property in class FormFile

FormGeoSelector — Class in namespace XELOS\Framework\XF\UI\Form

FormGroupSelector — Class in namespace XELOS\Framework\XF\UI\Form

Class FormGroupSelector

FormHidden — Class in namespace XELOS\Framework\XF\UI\Form

Class FormHidden

FormIconSelect — Class in namespace XELOS\Framework\XF\UI\Form

Class FormIconSelect

FormMediaAttachment — Class in namespace XELOS\Framework\XF\UI\Form

Attachment component to manage a single media attachment with a large preview

FormMultifile — Class in namespace XELOS\Framework\XF\UI\Form

Class FormMultifile

FormMultitext — Class in namespace XELOS\Framework\XF\UI\Form

Class FormMultitext

FormNumber — Class in namespace XELOS\Framework\XF\UI\Form

Class FormNumber

FormPassword — Class in namespace XELOS\Framework\XF\UI\Form

Class FormPassword

FormPhone — Class in namespace XELOS\Framework\XF\UI\Form

Class FormPhone

FormPolicySelector — Class in namespace XELOS\Framework\XF\UI\Form

Class FormPolicySelector

FormRadio — Class in namespace XELOS\Framework\XF\UI\Form

Class FormRadio

FormRowRenderer — Class in namespace XELOS\Framework\XF\UI\Form

Class FormRowRenderer

$ FormRowRenderer#form — Property in class FormRowRenderer

Reference to form

$ FormRowRenderer#fields — Property in class FormRowRenderer

$ FormRowRenderer#field_data — Property in class FormRowRenderer

FormRowRendererMultifieldRow — Class in namespace XELOS\Framework\XF\UI\Form

Class FormRowRendererMultifieldRow

FormRowRendererMultirowTable — Class in namespace XELOS\Framework\XF\UI\Form

Class FormRowRenderer_multirow_table

FormRrule — Class in namespace XELOS\Framework\XF\UI\Form

Class FormRRule

FormSearch — Class in namespace XELOS\Framework\XF\UI\Form

Class FormEmail

FormSectionBreak — Class in namespace XELOS\Framework\XF\UI\Form

Class FormSectionBreak

$ FormSectionBreak#field_disable_save — Property in class FormSectionBreak

FormSelect — Class in namespace XELOS\Framework\XF\UI\Form

FormSlider — Class in namespace XELOS\Framework\XF\UI\Form

FormStaticText — Class in namespace XELOS\Framework\XF\UI\Form

Class FormStaticText

$ FormStaticText#field_disable_save — Property in class FormStaticText

FormStaticValue — Class in namespace XELOS\Framework\XF\UI\Form

Class FormStaticValue

FormTag — Class in namespace XELOS\Framework\XF\UI\Form

Class FormTag

FormTextarea — Class in namespace XELOS\Framework\XF\UI\Form

FormTextbox — Class in namespace XELOS\Framework\XF\UI\Form

FormTextboxList — Class in namespace XELOS\Framework\XF\UI\Form

Class FormTextboxList

FormTileSelection — Class in namespace XELOS\Framework\XF\UI\Form

Class FormTileSelection

FormToggleSwitch — Class in namespace XELOS\Framework\XF\UI\Form

Class FormToggleSwitch

FormUrl — Class in namespace XELOS\Framework\XF\UI\Form

Class FormUrl

FormUserSelector — Class in namespace XELOS\Framework\XF\UI\Form

Class FormUserSelector

FormWebfetcher — Class in namespace XELOS\Framework\XF\UI\Form

Class FormWebfetcher

FroalaEditorBuilder — Class in namespace XELOS\Framework\XF\UI\Form\Helper

Class FroalaEditorBuilder

FroalaInsertGroup — Class in namespace XELOS\Framework\XF\UI\Form\Helper

Class FroalaInsertGroup

FroalaOption — Class in namespace XELOS\Framework\XF\UI\Form\Helper

Class FroalaOption

FroalaOption::fileAllowedTypes() — Method in class FroalaOption

The list of file types that are allowed to be uploaded. Although this will restrict uploading other types of files, we strongly recommend you to check the file type on the server too.

FroalaOption::fileInsertButtons() — Method in class FroalaOption

The list of buttons that appear in the insert file popup, when inserting a new file into the WYSIWYG editor.

FroalaOption::fileMaxSize() — Method in class FroalaOption

The maximum file size allowed on upload in bytes. The default value is 10MB. Although this makes an additional check before uploading the file, it is highly recommended to check file size on your server too.

FroalaOption::fileUpload() — Method in class FroalaOption

Enable or disable file upload.

FroalaOption::fileUploadMethod() — Method in class FroalaOption

The HTTP file upload request type.

FroalaOption::fileUploadParam() — Method in class FroalaOption

Customize the name of the parameter that contains the file in the upload request.

FroalaOption::fileUploadParams() — Method in class FroalaOption

Pass additional parameters to the file upload request.

FroalaOption::fileUploadToS3() — Method in class FroalaOption

Set the options for file upload to S3. All the fields from the example below are required. Also make sure that you have enabled <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html" title="CORS" target="_blank" rel="nofollow">CORS on Amazon.

Note: uploadURL property can be used instead of bucket and region properties to specify a custom URL from Amazon where to upload the image.

FroalaOption::fileUploadURL() — Method in class FroalaOption

The URL where the files uploaded by the user are saved. When a file is uploaded, the editor sends the file to the server through a HTTP request. The server should process the data from the file parameter of the request and return a JSON object containing a link field with the link to the uploaded file. More details can be found in the File Upload concept article.
E.g. {link: 'path/to/file.pdf'}.

Note 1: By default, the files are stored on our servers, but if you want to have full control over them, you should consider implementing the upload on your server. The files stored on our servers, may be deleted at any time without any notice.
Note 2: If the domain where the file is saved is not the same with the one where the editor is running, you may need to enable <a href="#requestWithCORS" title="requestWithCORS" target="_blank">requestWithCORS option and make specific customizations on the server. For more information please refer to Cross-origin resource sharing.

FroalaOption::fileUseSelectedText() — Method in class FroalaOption

Enables using the file's name instead of the selected text when a file is inserted.

FroalaOption::fontFamily() — Method in class FroalaOption

Defines the fonts that appear under the Font Family button from the rich text editor's toolbar.

FroalaOption::fontFamilyDefaultSelection() — Method in class FroalaOption

The text to display when the font family is unkown or nothing is selected.

FroalaOption::fontFamilySelection() — Method in class FroalaOption

The Font Family button from the WYSIWYG editor's toolbar is replaced with a dropdown showing the actual font family name for the current text selection.

FroalaOption::fontSizeSelection() — Method in class FroalaOption

The Font Size button from the WYSIWYG editor's toolbar is replaced with a dropdown showing the actual font size value for the current text selection.

FroalaOption::fontSize() — Method in class FroalaOption

Defines the font sizes that appear under the Font Size button from the rich text editor's toolbar.

FroalaOption::fontSizeDefaultSelection() — Method in class FroalaOption

The text to display when the font size is unkown or nothing is selected.

FroalaOption::fontSizeUnit() — Method in class FroalaOption

The unit to be used for the font size.

FroalaOption::formEditButtons() — Method in class FroalaOption

Buttons for form edit popup.

FroalaOption::formMultipleStyles() — Method in class FroalaOption

To enable applying multiple css on form elements.

FroalaOption::formStyles() — Method in class FroalaOption

Options for applying styles on form.

FroalaOption::formUpdateButtons() — Method in class FroalaOption

Buttons for form popup.

FroalaOption::fullPage() — Method in class FroalaOption

Allows the usage of HTML, HEAD, BODY tags and DOCTYPE declaration.
Note: Enabling this option will automatically enables the <a href="#iframe" title="iframe" target="_blank">iframe option.

FroalaOption::faButtons() — Method in class FroalaOption

The list of Font Awesome buttons to show in the popup for inserting icons.

FroalaOption::fontAwesomeSets() — Method in class FroalaOption

The list of Font Awesome icons to show in the modal for inserting icons.

FroalaOption::fontAwesomeTemplate() — Method in class FroalaOption

Set the template to be used for the Font Awesome icons inserted in the editor.

OptionList::first() — Method in class OptionList

OptionListProcessorInterface::filterBySearchQuery() — Method in class OptionListProcessorInterface

FormTextboxTrait — Class in namespace XELOS\Framework\XF\UI\Form\Traits

Trait FormTextboxTrait

FormValidationTrait — Class in namespace XELOS\Framework\XF\UI\Form\Traits

Image::fit_attributes() — Method in class Image

should be called before render!

$ JavaScript#folder — Property in class JavaScript

ModalDialog::fromLegacyOptionsArray() — Method in class ModalDialog

Create the ModalDialog from the legacy options array.

$ Table#field_filter — Property in class Table

$ Table#fields_visible — Property in class Table

$ Table#field_tooltips — Property in class Table

Table::fill_by_sql() — Method in class Table

Fill Table with Query

Table::fill_by_callback() — Method in class Table

Table::fill_by_model_find() — Method in class Table

Table::fillByModelCollection() — Method in class Table

Use collection as source for table data

Table::fill_by_array() — Method in class Table

Schedule Fill table by array

Table::fillByQuery() — Method in class Table

$ TableRow#fields — Property in class TableRow

$ TableRow#fields_format — Property in class TableRow

$ TableRow#fields_clean — Property in class TableRow

$ TableRow#field_links — Property in class TableRow

$ TableRow#field_type — Property in class TableRow

Tree::fill_by_sql() — Method in class Tree

Fill Tree by query Required fields in the query: id, pid, caption Optional: class

Tree::fill_by_callback() — Method in class Tree

Tree::fill_by_array() — Method in class Tree

$ VideoPlayer#format — Property in class VideoPlayer

$ Wizard#finalCallback — Property in class Wizard

User::find_policy_values() — Method in class User

Find matches for a policy (Answers the question: To what IDs does the user have access)

User::find_policy() — Method in class User

AdCache::find_by_id() — Method in class AdCache

Returns all models by id and ids. Query params can be e.g. order_by

AdCache::find_all_by_id() — Method in class AdCache

Returns the first model with the given id. Query params can be e.g. order_by

AdCache::find_by_objectsid() — Method in class AdCache

SynchStatus::find_by_objectsid() — Method in class SynchStatus

$ UserAccountUserConfig#form — Property in class UserAccountUserConfig

$ UserLanguageUserConfig#form — Property in class UserLanguageUserConfig

$ UserAdminConfig#formName — Property in class UserAdminConfig

Calendar::find_by_id() — Method in class Calendar

Returns all models by id and ids. Query params can be e.g. order_by

Calendar::find_all_by_id() — Method in class Calendar

Returns the first model with the given id. Query params can be e.g. order_by

Calendarset::find_by_id() — Method in class Calendarset

Returns all models by id and ids. Query params can be e.g. order_by

Calendarset::find_all_by_id() — Method in class Calendarset

Returns the first model with the given id. Query params can be e.g. order_by

Event::find_by_id() — Method in class Event

Returns all models by id and ids. Query params can be e.g. order_by

Event::find_all_by_id() — Method in class Event

Returns the first model with the given id. Query params can be e.g. order_by

Participant::find_by_id() — Method in class Participant

Returns all models by id and ids. Query params can be e.g. order_by

Participant::find_all_by_id() — Method in class Participant

Returns the first model with the given id. Query params can be e.g. order_by

Reminder::find_by_id() — Method in class Reminder

Returns all models by id and ids. Query params can be e.g. order_by

Reminder::find_all_by_id() — Method in class Reminder

Returns the first model with the given id. Query params can be e.g. order_by

ReminderQueue::find_by_id() — Method in class ReminderQueue

Returns all models by id and ids. Query params can be e.g. order_by

ReminderQueue::find_all_by_id() — Method in class ReminderQueue

Returns the first model with the given id. Query params can be e.g. order_by

SyncData::find_by_id() — Method in class SyncData

Returns all models by id and ids. Query params can be e.g. order_by

SyncData::find_all_by_id() — Method in class SyncData

Returns the first model with the given id. Query params can be e.g. order_by

SyncSetting::find_by_id() — Method in class SyncSetting

Returns all models by id and ids. Query params can be e.g. order_by

SyncSetting::find_all_by_id() — Method in class SyncSetting

Returns the first model with the given id. Query params can be e.g. order_by

Component::find_by_id() — Method in class Component

Returns all models by id and ids. Query params can be e.g. order_by

Component::find_all_by_id() — Method in class Component

Returns the first model with the given id. Query params can be e.g. order_by

ComponentLive::find_by_id() — Method in class ComponentLive

Returns all models by id and ids. Query params can be e.g. order_by

ComponentLive::find_all_by_id() — Method in class ComponentLive

Returns the first model with the given id. Query params can be e.g. order_by

History::find_by_id() — Method in class History

Returns all models by id and ids. Query params can be e.g. order_by

History::find_all_by_id() — Method in class History

Returns the first model with the given id. Query params can be e.g. order_by

HistoryComponent::find_by_id() — Method in class HistoryComponent

Returns all models by id and ids. Query params can be e.g. order_by

HistoryComponent::find_all_by_id() — Method in class HistoryComponent

Returns the first model with the given id. Query params can be e.g. order_by

HistoryPage::find_by_id() — Method in class HistoryPage

Returns all models by id and ids. Query params can be e.g. order_by

HistoryPage::find_all_by_id() — Method in class HistoryPage

Returns the first model with the given id. Query params can be e.g. order_by

Page::find_by_id() — Method in class Page

Returns all models by id and ids. Query params can be e.g. order_by

Page::find_all_by_id() — Method in class Page

Returns the first model with the given id. Query params can be e.g. order_by

PageLive::find_by_id() — Method in class PageLive

Returns all models by id and ids. Query params can be e.g. order_by

PageLive::find_all_by_id() — Method in class PageLive

Returns the first model with the given id. Query params can be e.g. order_by

Partial::find_by_id() — Method in class Partial

Returns all models by id and ids. Query params can be e.g. order_by

Partial::find_all_by_id() — Method in class Partial

Returns the first model with the given id. Query params can be e.g. order_by

PartialLive::find_by_id() — Method in class PartialLive

Returns all models by id and ids. Query params can be e.g. order_by

PartialLive::find_all_by_id() — Method in class PartialLive

Returns the first model with the given id. Query params can be e.g. order_by

Comment::find_by_id() — Method in class Comment

Returns all models by id and ids. Query params can be e.g. order_by

Comment::find_all_by_id() — Method in class Comment

Returns the first model with the given id. Query params can be e.g. order_by

Comment::find_all_by_group_id() — Method in class Comment

LinkInfo::find_by_id() — Method in class LinkInfo

Returns all models by id and ids. Query params can be e.g. order_by

LinkInfo::find_all_by_id() — Method in class LinkInfo

Returns the first model with the given id. Query params can be e.g. order_by

LinkInfo::find_all_by_group_id() — Method in class LinkInfo

Comment::find_all_by_pid() — Method in class Comment

Comment::find_all_by_group_id_and_created_at() — Method in class Comment

Comment::find_by_id() — Method in class Comment

LinkInfo::find_by_url() — Method in class LinkInfo

FilesPortlet — Class in namespace XELOS\Modules\DMS\Hook\Pages

FilterPanel — Class in namespace XELOS\Modules\DMS\UI

UI Component that allow the user to filter other DMS panels based on a specific set of qualities such as

• index search term
• filename
• author
• filesize
• template variables
• tags

FolderTreePanel — Class in namespace XELOS\Modules\DMS\UI

Panel that displays the category tree, highlighting the currently selected

FormFilterSpecification — Class in namespace XELOS\Modules\DMS\UI\Form

FormReportSpecification — Class in namespace XELOS\Modules\DMS\UI\Form

ChannelSubscriptionCollection::filterByUser() — Method in class ChannelSubscriptionCollection

FollowedDocumentsShowPortlet — Class in namespace XELOS\Modules\Doclink\Hook\Portal

EventCollection::filterByIsReadable() — Method in class EventCollection

EventCollection::filterByIsWriteable() — Method in class EventCollection

EventCollection::filterMyEvents() — Method in class EventCollection

EventCollection::filterByFutureEvents() — Method in class EventCollection

Filter and show only events in the future

EventCollection::filterByStartAndEnd() — Method in class EventCollection

Filter events for a specific date range Will remove a potential future filter

EventCollection::filterByCategory() — Method in class EventCollection

Filter Collection by category_id

CategoryDocumentation::find_by_id() — Method in class CategoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

CategoryDocumentation::find_all_by_id() — Method in class CategoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

EventDocumentation::find_by_id() — Method in class EventDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

EventDocumentation::find_all_by_id() — Method in class EventDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ InvitationReplyLogDocumentation#from_email: — Property in class InvitationReplyLogDocumentation

stored in MySQL as varchar

$ InvitationReplyLogDocumentation#from_name: — Property in class InvitationReplyLogDocumentation

stored in MySQL as varchar

InvitationReplyLogDocumentation::find_by_id() — Method in class InvitationReplyLogDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

InvitationReplyLogDocumentation::find_all_by_id() — Method in class InvitationReplyLogDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

JobDocumentation::find_by_id() — Method in class JobDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

JobDocumentation::find_all_by_id() — Method in class JobDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ ParticipantDocumentation#firstname: — Property in class ParticipantDocumentation

stored in MySQL as varchar

ParticipantDocumentation::find_by_id() — Method in class ParticipantDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ParticipantDocumentation::find_all_by_id() — Method in class ParticipantDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

ParticipantLogDocumentation::find_by_id() — Method in class ParticipantLogDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ParticipantLogDocumentation::find_all_by_id() — Method in class ParticipantLogDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

RelatedEventsDocumentation::find_by_id() — Method in class RelatedEventsDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

RelatedEventsDocumentation::find_all_by_id() — Method in class RelatedEventsDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Category::find_categories_by_ids() — Method in class Category

Category::find_categories() — Method in class Category

Event::find_by_id() — Method in class Event

Event::find_all_by_id() — Method in class Event

Numberrange::find_by_id() — Method in class Numberrange

Participant::find_all_by_event_id_and_query() — Method in class Participant

Participant::find_all_by_event_id_and_status_and_query() — Method in class Participant

Participant::find_all_by_event_id_and_query_and_custom_id() — Method in class Participant

Participant::find_all_by_event_id_and_status_and_query_and_unknown() — Method in class Participant

Participant::find_by_id_and_event_id() — Method in class Participant

overwritten find by function (joins with system_user table)

Participant::find_by_user_id_and_event_id() — Method in class Participant

overwritten find by function (joins with system_user table)

Participant::find_by_email_and_event_id() — Method in class Participant

overwritten find by function (joins with system_user table)

Participant::find_by_custom_id() — Method in class Participant

Find the participant with the given custom_id

Participant::find_by_event_id_and_custom_id() — Method in class Participant

Find the participant with the given custom_id

Participant::find_all_by_event_id() — Method in class Participant

Participant::find_by_event_id_and_user_id() — Method in class Participant

Participant::find_by_event_id_and_email() — Method in class Participant

Participant::find_all_by_event_id_and_id() — Method in class Participant

Participant::find_all_by_event_id_and_status() — Method in class Participant

Participant::find_by_id() — Method in class Participant

RelatedEvents::find_by_event_id() — Method in class RelatedEvents

RelatedEvents::find_by_id() — Method in class RelatedEvents

ModerateAction::findParentsBySearchAction() — Method in class ModerateAction

Tries to find writable parent elements of search query request from autocomplete

CategoryCollection::fetchLastEntry() — Method in class CategoryCollection

ThreadCollection::fetchPosts() — Method in class ThreadCollection

ForumControllerDocumentation — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Page#feed — Property in class Page

Page::feed() — Method in class Page

CategoryDocumentation::find_by_id() — Method in class CategoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

CategoryDocumentation::find_all_by_id() — Method in class CategoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

PostDocumentation::find_by_id() — Method in class PostDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PostDocumentation::find_all_by_id() — Method in class PostDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

ThreadDocumentation::find_by_id() — Method in class ThreadDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ThreadDocumentation::find_all_by_id() — Method in class ThreadDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

VotesDocumentation::find_by_id() — Method in class VotesDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

VotesDocumentation::find_all_by_id() — Method in class VotesDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

ForumController — Class in namespace XELOS\Modules\Forum

ForumController Class

$ Category#filled_by_array — Property in class Category

Category::find_by_p_id_and_group_id() — Method in class Category

Category::find_all_by_group_id() — Method in class Category

Category::find_all_by_p_id() — Method in class Category

$ Post#filled_by_array — Property in class Post

Post::fill_by_array() — Method in class Post

Post::find_by_thread_id() — Method in class Post

Post::find_all_by_thread_id() — Method in class Post

Thread::findAllExpiring() — Method in class Thread

Thread::find_all_by_category_id() — Method in class Thread

Votes::find_by_instance_id_and_thread_id_and_user_id() — Method in class Votes

FeedPage — Class in namespace XELOS\Modules\Forum\Page

ForumCest — Class in namespace XELOS\Modules\Forum\Tests\Codeception\Acceptance

ForumTest — Class in namespace XELOS\Modules\Forum\Tests\Codeception\Unit

GeoSelectorProcessor::filterBySearchQuery() — Method in class GeoSelectorProcessor

Constructs the URL of the API endpoint and fires a request against it.

$ TaskDocumentation#finished_by — Property in class TaskDocumentation

$ TaskDocumentation#finished_at: — Property in class TaskDocumentation

stored in MySQL as timestamp

TaskDocumentation::find_by_id() — Method in class TaskDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TaskDocumentation::find_all_by_id() — Method in class TaskDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

GroupCollection::filterByIsApproved() — Method in class GroupCollection

Category::find_by_id() — Method in class Category

Returns all models by id and ids. Query params can be e.g. order_by

Category::find_all_by_id() — Method in class Category

Returns the first model with the given id. Query params can be e.g. order_by

$ Group#first_steps_status — Property in class Group

Group::find_by_id() — Method in class Group

Returns all models by id and ids. Query params can be e.g. order_by

Group::find_all_by_id() — Method in class Group

Returns the first model with the given id. Query params can be e.g. order_by

Invitation::find_by_id() — Method in class Invitation

Returns all models by id and ids. Query params can be e.g. order_by

Invitation::find_all_by_id() — Method in class Invitation

Returns the first model with the given id. Query params can be e.g. order_by

Member::find_by_id() — Method in class Member

Returns all models by id and ids. Query params can be e.g. order_by

Member::find_all_by_id() — Method in class Member

Returns the first model with the given id. Query params can be e.g. order_by

Module::find_by_id() — Method in class Module

Returns all models by id and ids. Query params can be e.g. order_by

Module::find_all_by_id() — Method in class Module

Returns the first model with the given id. Query params can be e.g. order_by

Newsletter::find_by_id() — Method in class Newsletter

Returns all models by id and ids. Query params can be e.g. order_by

Newsletter::find_all_by_id() — Method in class Newsletter

Returns the first model with the given id. Query params can be e.g. order_by

Pending::find_by_id() — Method in class Pending

Returns all models by id and ids. Query params can be e.g. order_by

Pending::find_all_by_id() — Method in class Pending

Returns the first model with the given id. Query params can be e.g. order_by

FilesPortlet — Class in namespace XELOS\Modules\Groups\Hook\Pages

$ JobDocumentation#finished_at: — Property in class JobDocumentation

stored in MySQL as datetime

JobDocumentation::find_by_id() — Method in class JobDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

JobDocumentation::find_all_by_id() — Method in class JobDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ JobHistoryDocumentation#finished_at: — Property in class JobHistoryDocumentation

stored in MySQL as datetime

JobHistoryDocumentation::find_by_id() — Method in class JobHistoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

JobHistoryDocumentation::find_all_by_id() — Method in class JobHistoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

JobScheduler::finish() — Method in class JobScheduler

Finish a job onFinish()

Job::finish() — Method in class Job

Mark this Job as finished (successful)

Job::fetchNextJobs() — Method in class Job

Returns the next jobs and marks them as being processed

Job::fetchNextJob() — Method in class Job

Job::find_all_by_owner_thread() — Method in class Job

Job::find_all_by_owner_thread_and_status() — Method in class Job

Job::find_by_id_token() — Method in class Job

Job::find_by_id_token_and_status() — Method in class Job

Job::find_all_by_reference_id_and_status() — Method in class Job

Job::find_all_by_reference_id_and_user_id_and_status() — Method in class Job

JobHistory::find_by_id_token() — Method in class JobHistory

PageDocumentation::find_by_id() — Method in class PageDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageDocumentation::find_all_by_id() — Method in class PageDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

FormprocessorAction — Class in namespace XELOS\Modules\Lists\Action

$ FormprocessorAction#fdl — Property in class FormprocessorAction

$ FormprocessorAction#formdata — Property in class FormprocessorAction

$ FormprocessorAction#field_id_index — Property in class FormprocessorAction

FormprocessorEmailAction — Class in namespace XELOS\Modules\Lists\Action

FormprocessorWorkflowAction — Class in namespace XELOS\Modules\Lists\Action

Class XELOS\Modules\Lists\Action\FormprocessorWorkflowAction This Class will start the workflow for a list item

CategoryCollection::filterByIsReadable() — Method in class CategoryCollection

Filters the collection by categories, that are readable by the user.

ListItemCollection::filterByStatus() — Method in class ListItemCollection

Applies a scope query to the status passed according to the list passed. Be aware, that a list has to be set anyhow by either passing a list, or defining a scope query before. If neither of this happened before, this method will throw an InvalidMethodCallOrderException.

ListPropertiesCollection::filterByDateLikeFields() — Method in class ListPropertiesCollection

Filters the collection down to lists having either a date, datetime and/or timespan field.

ListPropertiesCollection::filterByStatusAvailable() — Method in class ListPropertiesCollection

Filters all lists by the occurrences of list statuses of any source.

ListPropertiesCollection::filterByIsReadable() — Method in class ListPropertiesCollection

$ Action#formprocessor — Property in class Action

$ Action#formprocessor_email — Property in class Action

$ Action#formprocessor_workflow — Property in class Action

Action::formprocessor() — Method in class Action

Action::formprocessor_email() — Method in class Action

Action::formprocessor_workflow() — Method in class Action

CategoryDocumentation::find_by_id() — Method in class CategoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

CategoryDocumentation::find_all_by_id() — Method in class CategoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ ListDocumentation#form_identifier: — Property in class ListDocumentation

stored in MySQL as varchar

$ ListDocumentation#form_description: — Property in class ListDocumentation

stored in MySQL as text

$ ListDocumentation#form_struct: — Property in class ListDocumentation

stored in MySQL as text

$ ListDocumentation#form_link: — Property in class ListDocumentation

stored in MySQL as tinyint

$ ListDocumentation#form_process: — Property in class ListDocumentation

stored in MySQL as varchar

ListDocumentation::find_by_id() — Method in class ListDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ListDocumentation::find_all_by_id() — Method in class ListDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ ListItemDocumentation#form_data: — Property in class ListItemDocumentation

stored in MySQL as text

$ ListItemDocumentation#facetted_1: — Property in class ListItemDocumentation

stored in MySQL as varchar

$ ListItemDocumentation#facetted_2: — Property in class ListItemDocumentation

stored in MySQL as varchar

$ ListItemDocumentation#facetted_3: — Property in class ListItemDocumentation

stored in MySQL as varchar

$ ListItemDocumentation#facetted_4: — Property in class ListItemDocumentation

stored in MySQL as varchar

$ ListItemDocumentation#facetted_5: — Property in class ListItemDocumentation

stored in MySQL as varchar

ListItemDocumentation::find_by_id() — Method in class ListItemDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ListItemDocumentation::find_all_by_id() — Method in class ListItemDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

ListStatusDocumentation::find_by_id() — Method in class ListStatusDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ListStatusDocumentation::find_all_by_id() — Method in class ListStatusDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Field — Class in namespace XELOS\Modules\Lists\Hook\Base

Field::formatValueForDisplay() — Method in class Field

Formats the values before they will be inserted into the table at the ItemList component.

Fieldset — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

FriendlyId — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

StaticText::formatValueForDisplay() — Method in class StaticText

Textbox::formatValueForDisplay() — Method in class Textbox

Formats the values before they will be inserted into the table at the ItemList component.

FilterListItemsAction — Class in namespace XELOS\Modules\Lists\Hook\Workflows

Category::find_by_id() — Method in class Category

Category::find_all_by_id() — Method in class Category

Category::find_all_by_pid() — Method in class Category

$ ListItem#form_data — Property in class ListItem

: stored in MySQL as text

$ ListItem#facetted_1 — Property in class ListItem

$ ListItem#facetted_2 — Property in class ListItem

$ ListItem#facetted_3 — Property in class ListItem

$ ListItem#facetted_4 — Property in class ListItem

$ ListItem#facetted_5 — Property in class ListItem

ListItem::find_by_id() — Method in class ListItem

ListItem::find_by_id_and_list_id() — Method in class ListItem

ListItem::find_all_by_id() — Method in class ListItem

ListItem::find_all_by_list_id() — Method in class ListItem

ListItem::find_all_by_list_id_and_status_id() — Method in class ListItem

ListItem::find_all_by_id_and_list_id() — Method in class ListItem

$ ListProperties#form_identifier — Property in class ListProperties

Identifier

$ ListProperties#form_type — Property in class ListProperties

Type [standalone|workflow]

$ ListProperties#form_description — Property in class ListProperties

Description

$ ListProperties#form_struct — Property in class ListProperties

Structure JSON encoded array of form fields

$ ListProperties#form_link — Property in class ListProperties

Form link for redirecting after form submits

$ ListProperties#form_process — Property in class ListProperties

Processor [workflows]

ListProperties::find_by_id() — Method in class ListProperties

ListProperties::find_by_form_identifier() — Method in class ListProperties

ListProperties::find_all_by_category_id() — Method in class ListProperties

ListProperties::find_all_by_active() — Method in class ListProperties

ListProperties::find_all_by_id() — Method in class ListProperties

ListProperties::find_all_by_form_identifier() — Method in class ListProperties

ListProperties::find_all_by_category_id_and_active() — Method in class ListProperties

ListProperties::find_all_by_category_id_and_active_and_title() — Method in class ListProperties

ListStatus::find_by_id() — Method in class ListStatus

ListStatus::find_by_list_id() — Method in class ListStatus

ListStatus::find_by_list_id_and_default() — Method in class ListStatus

ListStatus::find_all_by_id() — Method in class ListStatus

ListStatus::find_all_by_list_id() — Method in class ListStatus

ListStatus::find_all_by_list_id_and_default() — Method in class ListStatus

ListStatus::find_all_by_list_id_and_default_and_id() — Method in class ListStatus

SettingsPage::fillCategoryTreeCB() — Method in class SettingsPage

ProfileCollection::filterByVisible() — Method in class ProfileCollection

ProfileCollection::filterCompanyDepartmentProfiles() — Method in class ProfileCollection

Filter Profile Collection for profiles from same department, company

ProfileCollection::filterByUserGroups() — Method in class ProfileCollection

Only include users from specific user groups

ProfileCollection::filterByIsContact() — Method in class ProfileCollection

Filter Collection by profiles who are a contact

PropertyCollection::filterByVisible() — Method in class PropertyCollection

Profile::find_by_id() — Method in class Profile

Returns all models by id and ids. Query params can be e.g. order_by

Profile::find_all_by_id() — Method in class Profile

Returns the first model with the given id. Query params can be e.g. order_by

Property::find_by_id() — Method in class Property

Returns all models by id and ids. Query params can be e.g. order_by

Property::find_all_by_id() — Method in class Property

Returns the first model with the given id. Query params can be e.g. order_by

PropertyGroup::find_by_id() — Method in class PropertyGroup

Returns all models by id and ids. Query params can be e.g. order_by

PropertyGroup::find_all_by_id() — Method in class PropertyGroup

Returns the first model with the given id. Query params can be e.g. order_by

PropertyTab::find_by_id() — Method in class PropertyTab

Returns all models by id and ids. Query params can be e.g. order_by

PropertyTab::find_all_by_id() — Method in class PropertyTab

Returns the first model with the given id. Query params can be e.g. order_by

Checkbox::formatProperty() — Method in class Checkbox

Date::formatProperty() — Method in class Date

Email::formatProperty() — Method in class Email

Followers — Class in namespace XELOS\Modules\Lookbook\Fields

Follows — Class in namespace XELOS\Modules\Lookbook\Fields

Image::formatProperty() — Method in class Image

Memo::formatProperty() — Method in class Memo

Phoneno::formatProperty() — Method in class Phoneno

Select::formatProperty() — Method in class Select

SystemUser::formatProperty() — Method in class SystemUser

SystemUserGroup::formatProperty() — Method in class SystemUserGroup

SystemUserMeta::formatProperty() — Method in class SystemUserMeta

Url::formatProperty() — Method in class Url

UserSelector::formatProperty() — Method in class UserSelector

FollowersExtension — Class in namespace XELOS\Modules\Lookbook\Hooks\Lookbook

Class FollowersExtension

FollowingExtension — Class in namespace XELOS\Modules\Lookbook\Hooks\Lookbook

Class FollowersExtension

FieldInterface — Class in namespace XELOS\Modules\Lookbook\Interfaces

Interface FieldInterface

FieldInterface::formatProperty() — Method in class FieldInterface

Format status-properties which have been set as template markers.

FieldTrait — Class in namespace XELOS\Modules\Lookbook\Interfaces

FieldTrait::formatProperty() — Method in class FieldTrait

Trims the property value from line breaks and empty spaces.

ArticleCollection::filterByCategoryIds() — Method in class ArticleCollection

Filter by given category IDs.

ArticleCollection::filterByYear() — Method in class ArticleCollection

Filter by published_at of the given year.

ArticleCollection::filterByAccessibleCategories() — Method in class ArticleCollection

ArticleCollection::filterByAutoHideAndAccess() — Method in class ArticleCollection

Default filter which is always active to

• hide auto_hide_time articles
  • hide news articles published in the future
  • show all articles for users with the delete policy
  • show own articles for users with the write policy

ArticleCollection::filterByWritableCategories() — Method in class ArticleCollection

ArticleCollection::filterByIsPublishable() — Method in class ArticleCollection

Filers to articles which can be published by the current user

ArticleCollection::filterByIsTopNews() — Method in class ArticleCollection

Returns only top news.

ArticleCollection::filterByIsNormalNews() — Method in class ArticleCollection

Returns only top news.

ArticleCollection::filterByPublished() — Method in class ArticleCollection

Returns only published articles which are visible

ArticleCollection::filterByPublishedForUsers() — Method in class ArticleCollection

Returns only published articles.

ArticleCollection::filterByDraft() — Method in class ArticleCollection

Returns only drafted articles.

ArticleCollection::filterByHidden() — Method in class ArticleCollection

Select hidden articles.

ArticleCollection::filterByPublishedToday() — Method in class ArticleCollection

Returns article created, updated or published today.

ArticleCollection::filterByUpdatedAtStartEnd() — Method in class ArticleCollection

Filter articles updated_at for a specific date range

ArticleCollection::filterByDateRange() — Method in class ArticleCollection

CategoryCollection::filterByIsReadable() — Method in class CategoryCollection

CategoryCollection::filterByIsWritable() — Method in class CategoryCollection

ArticleDocumentation::find_by_id() — Method in class ArticleDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ArticleDocumentation::find_all_by_id() — Method in class ArticleDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ CategoryDocumentation#feature_settings — Property in class CategoryDocumentation

CategoryDocumentation::find_by_id() — Method in class CategoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

CategoryDocumentation::find_all_by_id() — Method in class CategoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ Article#feature_settings — Property in class Article

Article::find_all_by_category_id() — Method in class Article

PageCollection::filterByIsReadable() — Method in class PageCollection

PageCollection::filterByCanPublish() — Method in class PageCollection

Filters the collection to all pages on which the current user has publish rights

PageCollection::filterByCanWrite() — Method in class PageCollection

Filters the collection to all pages on which the current user has publish rights

PageCollection::filterByIsPage() — Method in class PageCollection

Filters to the Type Page

PageCollection::filterByIsNoTemplate() — Method in class PageCollection

Filters to be not of type template

PageCollection::filterByWaitingForApproval() — Method in class PageCollection

PageComponentDocumentation::find_by_id() — Method in class PageComponentDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageComponentDocumentation::find_all_by_id() — Method in class PageComponentDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

PageDocumentation::find_by_id() — Method in class PageDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageDocumentation::find_all_by_id() — Method in class PageDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

PageVersionDocumentation::find_by_id() — Method in class PageVersionDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageVersionDocumentation::find_all_by_id() — Method in class PageVersionDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Page::find_all_by_pid() — Method in class Page

$ PageVersion#format_version — Property in class PageVersion

Workspace::find_by_user_id() — Method in class Workspace

ConfirmationDocumentation::find_by_id() — Method in class ConfirmationDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ConfirmationDocumentation::find_all_by_id() — Method in class ConfirmationDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

DocumentDocumentation::find_by_id() — Method in class DocumentDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

DocumentDocumentation::find_all_by_id() — Method in class DocumentDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Confirmation::find_by_document_index_id_and_user_id() — Method in class Confirmation

Confirmation::find_all_by_document_index_id() — Method in class Confirmation

Document::find_all_by_document_index_id() — Method in class Document

IndexerAction::findAndSetTags() — Method in class IndexerAction

Finds tags from tagging module and sets them.

$ Model#faceted_filter — Property in class Model

Model::faceted_filter() — Method in class Model

FacetedFilterDocumentation — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\Model

This file provides property and method documentation for the model FacetedFilter.

FacetedFilterDocumentation::find_by_id() — Method in class FacetedFilterDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

FacetedFilterDocumentation::find_all_by_id() — Method in class FacetedFilterDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

SearchHistoryDocumentation::find_by_id() — Method in class SearchHistoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

SearchHistoryDocumentation::find_all_by_id() — Method in class SearchHistoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

SearchagentDocumentation::find_by_id() — Method in class SearchagentDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

SearchagentDocumentation::find_all_by_id() — Method in class SearchagentDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

TermDocumentation::find_by_id() — Method in class TermDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TermDocumentation::find_all_by_id() — Method in class TermDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Field — Class in namespace XELOS\Modules\Search\Hook\Base\SearchMetaData

FacetedFilter — Class in namespace XELOS\Modules\Search\Model

FacetedFilter::find_all_by_visible() — Method in class FacetedFilter

SearchHistory::find_all_by_user_id() — Method in class SearchHistory

UserSelectorProcessor::filterBySearchQuery() — Method in class UserSelectorProcessor

PageDocumentation::find_by_id() — Method in class PageDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageDocumentation::find_all_by_id() — Method in class PageDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

PageHistoryDocumentation::find_by_id() — Method in class PageHistoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageHistoryDocumentation::find_all_by_id() — Method in class PageHistoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ PageLinkDocumentation#from_page_id — Property in class PageLinkDocumentation

$ PageLinkDocumentation#from_page_slug: — Property in class PageLinkDocumentation

stored in MySQL as varchar

$ PageLinkDocumentation#from_version_id — Property in class PageLinkDocumentation

PageLinkDocumentation::find_by_id() — Method in class PageLinkDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PageLinkDocumentation::find_all_by_id() — Method in class PageLinkDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

PageHistory::findLastActivePageVersion() — Method in class PageHistory

gets the last active version of a page from history or null if tere wasn't one

ActivityCollection::filterByDocumentWallItemTable() — Method in class ActivityCollection

ActivityCollection::filterByPostUpdateTime() — Method in class ActivityCollection

$ Page#feed — Property in class Page

$ DocumentWallItemDocumentation#followed_group_security_id — Property in class DocumentWallItemDocumentation

$ DocumentWallItemDocumentation#followed_user_id — Property in class DocumentWallItemDocumentation

$ DocumentWallItemDocumentation#followed_document_index_id — Property in class DocumentWallItemDocumentation

DocumentWallItemDocumentation::find_by_id() — Method in class DocumentWallItemDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

DocumentWallItemDocumentation::find_all_by_id() — Method in class DocumentWallItemDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ EntryDocumentation#full_link: — Property in class EntryDocumentation

stored in MySQL as varchar

EntryDocumentation::find_by_id() — Method in class EntryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

EntryDocumentation::find_all_by_id() — Method in class EntryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

HiddenInstanceDocumentation::find_by_id() — Method in class HiddenInstanceDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

HiddenInstanceDocumentation::find_all_by_id() — Method in class HiddenInstanceDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

DocumentWallItem::find_all_by_document_index_id() — Method in class DocumentWallItem

Entry::find_compressed() — Method in class Entry

Find compressed

FeedPage — Class in namespace XELOS\Modules\SystemActionlog\Page

BackupQueue::find_by_id() — Method in class BackupQueue

Returns all models by id and ids. Query params can be e.g. order_by

BackupQueue::find_all_by_id() — Method in class BackupQueue

Returns the first model with the given id. Query params can be e.g. order_by

EventTrigger::find_by_id() — Method in class EventTrigger

Returns all models by id and ids. Query params can be e.g. order_by

EventTrigger::find_all_by_id() — Method in class EventTrigger

Returns the first model with the given id. Query params can be e.g. order_by

InstallQueue::find_by_id() — Method in class InstallQueue

Returns all models by id and ids. Query params can be e.g. order_by

InstallQueue::find_all_by_id() — Method in class InstallQueue

Returns the first model with the given id. Query params can be e.g. order_by

CategoryCollection::filterByReadable() — Method in class CategoryCollection

Filter to only readable categories.

CategoryCollection::filterBySearchQuery() — Method in class CategoryCollection

DocumentCollection::filterBySearchQuery() — Method in class DocumentCollection

DocumentCollection::fetchByCategoryUuid() — Method in class DocumentCollection

Fetches all documents of a category with the given UUID.

FullyIntegratedInterface — Class in namespace XELOS\Modules\SystemDMS\Interfaces

Interface FullyIntegratedInterface

Category::fill_structure() — Method in class Category

Category::find_by_pid() — Method in class Category

Category::find_by_xfs_source() — Method in class Category

Category::find_all_by_group_id() — Method in class Category

Category::find_all_by_structure() — Method in class Category

Category::find_all_by_group_id_and_pid() — Method in class Category

Category::find_all_by_pid_and_group_id() — Method in class Category

Category::find_all_by_reference_id() — Method in class Category

Category::find_all_by_pid() — Method in class Category

Category::find_by_id_and_group_id() — Method in class Category

Category::find_by_foldername_and_pid() — Method in class Category

Category::find_all_by_system_folder() — Method in class Category

$ Document#file_extension — Property in class Document

Accessible via XELOS\Modules\SystemDMS\Model\xm_system_dms_document::get_file_extension

$ Document#file_path — Property in class Document

Accessible via XELOS\Modules\SystemDMS\Model\xm_system_dms_document::get_file_path

Document::find_by_id_and_group_id() — Method in class Document

Document::find_all_by_category_id() — Method in class Document

Document::find_by_xfs_path() — Method in class Document

Document::find_by_id_and_category_id() — Method in class Document

DocumentHistory::find_all_by_deleted_and_group_id() — Method in class DocumentHistory

DocumentHistory::find_all_by_id_and_group_id() — Method in class DocumentHistory

DocumentMetaData::find_all_by_document_id_and_version_id() — Method in class DocumentMetaData

DocumentMetaData::find_all_by_document_id() — Method in class DocumentMetaData

DocumentMetaField::format_data() — Method in class DocumentMetaField

Renders a specific value, depending on the field type

DocumentMetaField::find_all_by_template_id() — Method in class DocumentMetaField

DocumentMetaField::find_all_by_template_id_and_show_as_hierarchy() — Method in class DocumentMetaField

DocumentMetaField::find_all_by_template_id_and_show_as_filter() — Method in class DocumentMetaField

DocumentMetaField::find_all_by_show_as_filter() — Method in class DocumentMetaField

DocumentMetaField::find_by_id_and_template_id() — Method in class DocumentMetaField

DocumentTemplate::find_all_by_group_id() — Method in class DocumentTemplate

FileTemplate — Class in namespace XELOS\Modules\SystemDMS\Model

Preview::find_by_document_id_and_version_id() — Method in class Preview

Preview::find_by_document_id_and_version_id_and_type() — Method in class Preview

Preview::find_by_document_id_and_version_id_and_checksum_and_status() — Method in class Preview

Preview::find_by_document_id_and_version_id_and_checksum_and_status_and_type() — Method in class Preview

Preview::find_all_by_document_id_and_version_id_and_status() — Method in class Preview

$ XfsDocument#file_url — Property in class XfsDocument

$ XfsDocument#filename — Property in class XfsDocument

XfsDocument::find_xfs_documents_by_xfs_url() — Method in class XfsDocument

XfsDocument::find_by_id() — Method in class XfsDocument

Returns all models. Query params can be e.g. order_by

XfsDocument::find_xfs_documents_by_xfs_path() — Method in class XfsDocument

XfsDocument::find_all_by_category_id() — Method in class XfsDocument

XfsDocument::find_all_by_id() — Method in class XfsDocument

ZipImportJob::find_by_id_and_user_id() — Method in class ZipImportJob

ZipImportJob::find_by_status() — Method in class ZipImportJob

$ SystemDMSController#force_view_mode — Property in class SystemDMSController

$ SystemDMSController#force_category_restriction — Property in class SystemDMSController

Param will force document panel to treat a given category id as top category

FilterPanel — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_filter_panel

FolderTreePanel — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_folder_tree_panel

FormFilterSpecification — Class in namespace XELOS\Modules\SystemDMS\UI\Form

This component provides an editor for defining a single filter specification consisting of several components. These filter specifications are usually reused by the report specification form component through using its helper.

FormReportSpecification — Class in namespace XELOS\Modules\SystemDMS\UI\Form

This component provides an editor for defining report specifications by wrapping several other form components in a XUI component and manually

$ Model#file_template — Property in class Model

Model::file_template() — Method in class Model

$ Ui#filter_panel — Property in class Ui

$ Ui#folder_tree_panel — Property in class Ui

$ Category#foldername — Property in class Category

: stored in MySQL as varchar

Category::find_by_id() — Method in class Category

Returns all models by id and ids. Query params can be e.g. order_by

Category::find_all_by_id() — Method in class Category

Returns the first model with the given id. Query params can be e.g. order_by

$ Document#filename — Property in class Document

: stored in MySQL as varchar

$ Document#fileversion — Property in class Document

$ Document#filesize — Property in class Document

Document::find_by_id() — Method in class Document

Returns all models by id and ids. Query params can be e.g. order_by

Document::find_all_by_id() — Method in class Document

Returns the first model with the given id. Query params can be e.g. order_by

$ DocumentHistory#filename — Property in class DocumentHistory

: stored in MySQL as varchar

$ DocumentHistory#fileversion — Property in class DocumentHistory

$ DocumentHistory#filesize — Property in class DocumentHistory

DocumentHistory::find_by_id() — Method in class DocumentHistory

Returns all models by id and ids. Query params can be e.g. order_by

DocumentHistory::find_all_by_id() — Method in class DocumentHistory

Returns the first model with the given id. Query params can be e.g. order_by

DocumentMetaData::find_by_id() — Method in class DocumentMetaData

Returns all models by id and ids. Query params can be e.g. order_by

DocumentMetaData::find_all_by_id() — Method in class DocumentMetaData

Returns the first model with the given id. Query params can be e.g. order_by

$ DocumentMetaField#fdl — Property in class DocumentMetaField

: stored in MySQL as text

$ DocumentMetaField#format — Property in class DocumentMetaField

: stored in MySQL as text

DocumentMetaField::find_by_id() — Method in class DocumentMetaField

Returns all models by id and ids. Query params can be e.g. order_by

DocumentMetaField::find_all_by_id() — Method in class DocumentMetaField

Returns the first model with the given id. Query params can be e.g. order_by

DocumentTemplate::find_by_id() — Method in class DocumentTemplate

Returns allmodels by id and ids. Query params can be e.g. order_by

DocumentTemplate::find_all_by_id() — Method in class DocumentTemplate

Returns the first model with the given id. Query params can be e.g. order_by

FileTemplate — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model file_template.

FileTemplate::find_by_id() — Method in class FileTemplate

Returns all models by id and ids. Query params can be e.g. order_by

FileTemplate::find_all_by_id() — Method in class FileTemplate

Returns the first model with the given id. Query params can be e.g. order_by

Preview::find_by_id() — Method in class Preview

Returns all models by id and ids. Query params can be e.g. order_by

Preview::find_all_by_id() — Method in class Preview

Returns the first model with the given id. Query params can be e.g. order_by

$ ZipImportJob#file — Property in class ZipImportJob

: stored in MySQL as varchar

ZipImportJob::find_by_id() — Method in class ZipImportJob

Returns all models by id and ids. Query params can be e.g. order_by

ZipImportJob::find_all_by_id() — Method in class ZipImportJob

Returns the first model with the given id. Query params can be e.g. order_by

AdminSystemMailUserAdminConfig::forward_table_edit_cb() — Method in class AdminSystemMailUserAdminConfig

ChannelSettingDocumentation::find_by_id() — Method in class ChannelSettingDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ChannelSettingDocumentation::find_all_by_id() — Method in class ChannelSettingDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

UserSettingDocumentation::find_by_id() — Method in class UserSettingDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

UserSettingDocumentation::find_all_by_id() — Method in class UserSettingDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

NotificationChannel::flush() — Method in class NotificationChannel

NotificationChannelInterface::flush() — Method in class NotificationChannelInterface

Triggered after queuing, should reset your queue and do the actual sending

UserSetting::find_all_by_user_id() — Method in class UserSetting

PushSubscriptionDocumentation::find_by_id() — Method in class PushSubscriptionDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

PushSubscriptionDocumentation::find_all_by_id() — Method in class PushSubscriptionDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

PushSubscription::find_all_by_user_id() — Method in class PushSubscription

PushSubscription::find_by_user_id_and_public_key() — Method in class PushSubscription

EventCollection::filterByUser() — Method in class EventCollection

Returns only events for current or given user.

EventCollection::filterByTypeLogin() — Method in class EventCollection

Returns only events of type login and login_failed

EventCollection::filterByDateRange() — Method in class EventCollection

AggregateDimensionDocumentation::find_by_id() — Method in class AggregateDimensionDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

AggregateDimensionDocumentation::find_all_by_id() — Method in class AggregateDimensionDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

EventDocumentation::find_by_id() — Method in class EventDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

EventDocumentation::find_all_by_id() — Method in class EventDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

CheckDocumentation::find_by_id() — Method in class CheckDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

CheckDocumentation::find_all_by_id() — Method in class CheckDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

NodeDocumentation::find_by_id() — Method in class NodeDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

NodeDocumentation::find_all_by_id() — Method in class NodeDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Check::find_by_instance_id_and_check_id_and_node_id() — Method in class Check

Check::find_all_by_instance_id_and_check_id_and_active() — Method in class Check

Check::find_all_by_instance_id_and_node_id() — Method in class Check

Check::find_all_by_node_id() — Method in class Check

Node::find_by_node_name() — Method in class Node

Node::find_all_by_active() — Method in class Node

GlobalTaskCollection::filterByIsNotArchived() — Method in class GlobalTaskCollection

GlobalTaskCollection::filterByIsReadable() — Method in class GlobalTaskCollection

GlobalTaskListCollection::filterByIsReadable() — Method in class GlobalTaskListCollection

TaskCollection::filterByIsReadable() — Method in class TaskCollection

TaskCollection::filterByIsArchived() — Method in class TaskCollection

TaskCollection::filterByIsNotArchived() — Method in class TaskCollection

TaskCollection::filterByType() — Method in class TaskCollection

Filters by task type ["open" | "closed"]

TaskCollection::filterByHasDeadline() — Method in class TaskCollection

Filters by tasks, that have a deadline set

TaskListCollection::filterByIsReadable() — Method in class TaskListCollection

RecurringTaskDocumentation::find_by_id() — Method in class RecurringTaskDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

RecurringTaskDocumentation::find_all_by_id() — Method in class RecurringTaskDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

$ TaskDocumentation#finished_by — Property in class TaskDocumentation

$ TaskDocumentation#finished_at: — Property in class TaskDocumentation

stored in MySQL as timestamp

TaskDocumentation::find_by_id() — Method in class TaskDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TaskDocumentation::find_all_by_id() — Method in class TaskDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

RecurringTask::find_all_by_rrule() — Method in class RecurringTask

RecurringTask::find_by_task_id() — Method in class RecurringTask

RecurringTask::find_all_by_target_list_id() — Method in class RecurringTask

$ Task#finished_by — Property in class Task

Finished by User

Task::find_by_id() — Method in class Task

Task::find_all_by_group_id() — Method in class Task

Task::find_all_by_list_id() — Method in class Task

Task::find_all_by_id() — Method in class Task

Task::find_all_by_list_column_id() — Method in class Task

Task::find_all_by_list_column_id_and_list_id() — Method in class Task

TaskList::find_by_id() — Method in class TaskList

TaskList::find_all_by_group_id() — Method in class TaskList

TaskList::find_all_by_user_id() — Method in class TaskList

TaskList::find_all_by_id() — Method in class TaskList

TaskListColumn::find_all_by_id() — Method in class TaskListColumn

TaskListColumn::find_by_list_id_and_sort() — Method in class TaskListColumn

PushClient::find_by_id() — Method in class PushClient

Returns all models by id and ids. Query params can be e.g. order_by

PushClient::find_all_by_id() — Method in class PushClient

Returns the first model with the given id. Query params can be e.g. order_by

TagCollection::filterByNotDeprecated() — Method in class TagCollection

Hide deprecated tags

TagCollection::find_by_tag_text() — Method in class TagCollection

TagDocumentation::find_by_id() — Method in class TagDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TagDocumentation::find_all_by_id() — Method in class TagDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Tag::findOrCreateByText() — Method in class Tag

Tag::findAllByDocumentIndexId() — Method in class Tag

Tag::find_all_by_tag_text() — Method in class Tag

Tag::find_by_tag_text() — Method in class Tag

TagDocument::findAllByTagIDAndInstanceIDAndGroupIDAndPostType() — Method in class TagDocument

Find all Documents matching Instance/Group ID for a certain tag_id

TagDocument::findAllByTagIDAndParentDocument() — Method in class TagDocument

Find all Documents matching Instance/Group ID for a certain tag_id

TagDocument::find_all_by_document_index_id() — Method in class TagDocument

FeedbackAction — Class in namespace XELOS\Modules\Translation\Action

$ Action#feedback — Property in class Action

Action::feedback() — Method in class Action

$ Page#feedback — Property in class Page

Page::feedback() — Method in class Page

TranslationDocumentDocumentation::find_by_id() — Method in class TranslationDocumentDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TranslationDocumentDocumentation::find_all_by_id() — Method in class TranslationDocumentDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

TranslationDocumentation::find_by_id() — Method in class TranslationDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TranslationDocumentation::find_all_by_id() — Method in class TranslationDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

TranslationFeedbackDocumentation::find_by_id() — Method in class TranslationFeedbackDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TranslationFeedbackDocumentation::find_all_by_id() — Method in class TranslationFeedbackDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

TranslationJobDocumentation::find_by_id() — Method in class TranslationJobDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

TranslationJobDocumentation::find_all_by_id() — Method in class TranslationJobDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

TranslationDocument::find_by_document_index_id_and_cache_key() — Method in class TranslationDocument

Returns Model for document index id and cache key

TranslationDocument::find_all_by_document_index_id() — Method in class TranslationDocument

Finds all translation models for document_index_id

TranslationFeedback::find_by_source_model_and_source_id_and_target_language() — Method in class TranslationFeedback

TranslationJob::find_all_by_target_model_and_error_count() — Method in class TranslationJob

with error count restriction

TranslationJob::find_all_by_target_model_and_target_id() — Method in class TranslationJob

Returns jobs of target_model and target_id

FeedbackPage — Class in namespace XELOS\Modules\Translation\Page

Pages for the GECKO registration process.

FormtranslatePage — Class in namespace XELOS\Modules\Translation\Page

Pages for the GECKO registration process.

Trendvote::find_by_id() — Method in class Trendvote

Returns all models by id and ids. Query params can be e.g. order_by

Trendvote::find_all_by_id() — Method in class Trendvote

Returns the first model with the given id. Query params can be e.g. order_by

Result::find_by_user_id_and_trendvote_id() — Method in class Result

Result::find_by_trendvote_id() — Method in class Result

Result::find_all_by_trendvote_id() — Method in class Result

$ Model#file — Property in class Model

Model::file() — Method in class Model

FileDocumentation — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated\Model

This file provides property and method documentation for the model File.

$ FileDocumentation#filename: — Property in class FileDocumentation

stored in MySQL as varchar

FileDocumentation::find_by_id() — Method in class FileDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

FileDocumentation::find_all_by_id() — Method in class FileDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

ScanDocumentation::find_by_id() — Method in class ScanDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ScanDocumentation::find_all_by_id() — Method in class ScanDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

FileDeleteJob — Class in namespace XELOS\Modules\VirusScan\Infrastructure\Job

File — Class in namespace XELOS\Modules\VirusScan\Model

File::find_all_by_scan_id() — Method in class File

Scan::find_by_run_status() — Method in class Scan

OAuthClient::fromArray() — Method in class OAuthClient

OauthAccess::findBySecureAccessToken() — Method in class OauthAccess

OauthAccess::findBySecureRefreshToken() — Method in class OauthAccess

OauthAccess::find_by_id() — Method in class OauthAccess

OauthAccess::find_by_hook_name_and_hook_instance_and_user_id() — Method in class OauthAccess

OauthAccess::find_by_refresh_token() — Method in class OauthAccess

OauthAccess::find_all_by_user_id_and_expires_at_and_access_token() — Method in class OauthAccess

OauthAccess::find_by_user_id_and_expires_at_and_access_token() — Method in class OauthAccess

OauthAccess::find_by_user_id_and_expires_at_and_authorization_code() — Method in class OauthAccess

OauthAccess::find_by_expires_at_and_access_token() — Method in class OauthAccess

OauthAccess::find_by_expires_at_and_access_token_and_authorization_code() — Method in class OauthAccess

OauthAccess::find_by_access_token() — Method in class OauthAccess

OauthAccess::find_by_access_token_or_refresh_token() — Method in class OauthAccess

OauthAccess::find_by_authorization_code() — Method in class OauthAccess

CategoryDocumentation::find_by_id() — Method in class CategoryDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

CategoryDocumentation::find_all_by_id() — Method in class CategoryDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

WidgetDocumentation::find_by_id() — Method in class WidgetDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

WidgetDocumentation::find_all_by_id() — Method in class WidgetDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

Widget::find_all_by_active() — Method in class Widget

Widget::find_all_by_active_and_id() — Method in class Widget

Widget::find_all_by_active_and_category_id() — Method in class Widget

Widget::find_all_by_category_id() — Method in class Widget

AnswerDocumentation::find_by_id() — Method in class AnswerDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

AnswerDocumentation::find_all_by_id() — Method in class AnswerDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

ParticipantDocumentation::find_by_id() — Method in class ParticipantDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

ParticipantDocumentation::find_all_by_id() — Method in class ParticipantDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

SurveyDocumentation::find_by_id() — Method in class SurveyDocumentation

Returns all models by id and ids. Query params can be e.g. order_by

SurveyDocumentation::find_all_by_id() — Method in class SurveyDocumentation

Returns the first model with the given id. Query params can be e.g. order_by

G

Autoloader::get_class_path() — Method in class Autoloader

Returns the HDD filepath for the passed class

Autoloader::generate_classmap() — Method in class Autoloader

Generate Classmap if not exists

Autoloader::get_classmap_path_from_ns() — Method in class Autoloader

Returns the base path for the classmap based on the XELOS namespaced path

Autoloader::get_path_from_ns() — Method in class Autoloader

Returns the base path for the classmap based on the XELOS namespaced path

Autoloader::getClassInfoFromNS() — Method in class Autoloader

Returns module_name, vendor, path for XELOS Namespace

Autoloader::get_modules() — Method in class Autoloader

Returns a list of all modules in the module and vendor/*module/ path

Autoloader::get_module_name_from_path() — Method in class Autoloader

Extracts the module name from the full hdd path

Autoloader::get_ns_from_path() — Method in class Autoloader

Extracts a full file path to a file namespace based on the path components if possible

AuthenticationInterface::get_user_details() — Method in class AuthenticationInterface

AuthenticationInterface::get_module_info() — Method in class AuthenticationInterface

Return Auth Method information as keyed array [name, description, config]

AuthenticationInterface::getSessionTTL() — Method in class AuthenticationInterface

Return TTL Time for Session

BaseAuthentication::getSessionTTL() — Method in class BaseAuthentication

BaseAuthentication::getAuthMethod() — Method in class BaseAuthentication

Get Auth Method

BaseAuthentication::getAuthConfig() — Method in class BaseAuthentication

Return configuration variable for auth method

BaseAuthentication::getAuthID() — Method in class BaseAuthentication

Get internal Auth ID

$ ActivedirectoryAuthentication#group_mappings — Property in class ActivedirectoryAuthentication

Map of AD groups to XELOS groups

ActivedirectoryAuthentication::get_user_details() — Method in class ActivedirectoryAuthentication

Get User Details

ActivedirectoryAuthentication::get_module_info() — Method in class ActivedirectoryAuthentication

AlternativeLoginAuthentication::get_user_details() — Method in class AlternativeLoginAuthentication

Get User Details

AlternativeLoginAuthentication::get_module_info() — Method in class AlternativeLoginAuthentication

GuestAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

GuestAuthentication::get_user_details() — Method in class GuestAuthentication

GuestAuthentication::get_module_info() — Method in class GuestAuthentication

InviteAuthentication::get_user_details() — Method in class InviteAuthentication

InviteAuthentication::get_module_info() — Method in class InviteAuthentication

Return Auth Method information as keyed array [name, description, config]

IpAuthentication::get_user_details() — Method in class IpAuthentication

IpAuthentication::get_module_info() — Method in class IpAuthentication

$ LdapAuthentication#group_mapping — Property in class LdapAuthentication

LdapAuthentication::get_user_details() — Method in class LdapAuthentication

LdapAuthentication::get_module_info() — Method in class LdapAuthentication

MobileAccessAuthentication::get_user_details() — Method in class MobileAccessAuthentication

MobileAccessAuthentication::get_module_info() — Method in class MobileAccessAuthentication

MultiFactorAuthentication::get_user_details() — Method in class MultiFactorAuthentication

MultiFactorAuthentication::get_module_info() — Method in class MultiFactorAuthentication

NtlmAuthentication::get_user_details() — Method in class NtlmAuthentication

Standard Authentication Function for XelosV3

NtlmAuthentication::get_module_info() — Method in class NtlmAuthentication

RadiusAuthentication::get_user_details() — Method in class RadiusAuthentication

RadiusAuthentication::get_module_info() — Method in class RadiusAuthentication

RemembermeAuthentication::get_user_details() — Method in class RemembermeAuthentication

RemembermeAuthentication::get_module_info() — Method in class RemembermeAuthentication

SuperuserAuthentication::get_user_details() — Method in class SuperuserAuthentication

SuperuserAuthentication::get_module_info() — Method in class SuperuserAuthentication

XelosAuthentication::get_user_details() — Method in class XelosAuthentication

Return User Details

XelosAuthentication::get_module_info() — Method in class XelosAuthentication

$ UserDetails#guest — Property in class UserDetails

$ UserDetails#groups — Property in class UserDetails

UserDetails::getProperties() — Method in class UserDetails

Get UserDetails as Array

UserDetails::getPictureURL() — Method in class UserDetails

CommandDefinition::getHandler() — Method in class CommandDefinition

CommandDefinition::getName() — Method in class CommandDefinition

CommandDefinition::getDescription() — Method in class CommandDefinition

CommandDefinition::getArguments() — Method in class CommandDefinition

CommandDefinition::getOptions() — Method in class CommandDefinition

CommandSet::getCommandDefinition() — Method in class CommandSet

CommandSet::getCommandDefinitions() — Method in class CommandSet

CommandSet::getLogger() — Method in class CommandSet

Help::getGlobalOptions() — Method in class Help

Console::getLogger() — Method in class Console

Console::getAvailableCommands() — Method in class Console

Returns all available commands

ConsoleLogger::getLogLevel() — Method in class ConsoleLogger

Input::getBinaryName() — Method in class Input

Input::getCommand() — Method in class Input

Input::getCommandArray() — Method in class Input

Input::getVendorName() — Method in class Input

Input::getModuleName() — Method in class Input

Input::getArgument() — Method in class Input

Input::getArguments() — Method in class Input

Input::getArgumentCount() — Method in class Input

Input::getOption() — Method in class Input

Input::getOptions() — Method in class Input

Input::getVerbosity() — Method in class Input

Output::getVerbosity() — Method in class Output

$ Core#group_context — Property in class Core

$ Core#group_name — Property in class Core

$ Core#GPvars — Property in class Core

Core::getI18nTokenDomain() — Method in class Core

Return i18n Token Domain

Core::get_plugin() — Method in class Core

Core::get_plugins_by_prefix() — Method in class Core

Core::get_dep_page() — Method in class Core

Core::get_group() — Method in class Core

Core::getGroupContext() — Method in class Core

Core::get_security_level() — Method in class Core

Core::get_config() — Method in class Core

Core::get_object() — Method in class Core

Call specific object - allows to use constructor-params (overload function) This function is primarily called from the magic GET and CALL Methods

Core::get_page() — Method in class Core

Core::get_hook() — Method in class Core

Core::get_hooks() — Method in class Core

Core::getHooksAsObject() — Method in class Core

Core::getGroupSecurityId() — Method in class Core

Get the group_security_id for this instance (optional: based on a local group_context)

Core::get_dep() — Method in class Core

Core::getDependencyInGuessGroupContext() — Method in class Core

Get dependency with unknown group context

Core::get_deps() — Method in class Core

Core::get_parent_context() — Method in class Core

Get Parent Context

Core::get_template() — Method in class Core

Core::get_xf_link() — Method in class Core

Core::get_file_url() — Method in class Core

Constructs and returns a download link for file

Core::get_resize_hash() — Method in class Core

Calculate Resize Hash !Is also called static

Core::get_thumb_url() — Method in class Core

Core::get_preview_url() — Method in class Core

Core::get_file_link() — Method in class Core

Get File Link

Core::get_file_url_args() — Method in class Core

Core::get_actionlog() — Method in class Core

Return the actionlog instance

Core::get_dyn_config() — Method in class Core

Core::get_context_id() — Method in class Core

gets the numerical Context-ID (PrimaryKey in Instance_Registry)

Core::get_default_i18n() — Method in class Core

Get the default language set for this instance

Core::get_available_languages() — Method in class Core

Get the configured languages for this instance

Core::get_i18n_translation_required() — Method in class Core

Returns true if the i18n translation has been set to required for this instance

Core::get_document_index_id() — Method in class Core

returns the global document id fron document_index

Core::get_document_index() — Method in class Core

returns the global document index fron document_index

Core::get_system_dms() — Method in class Core

Returns the default dms to store application files.

Core::getSystemDMS() — Method in class Core

Get System DMS, using static cache

DatabaseException::getQuery() — Method in class DatabaseException

Returns the Query causing this exception

ActionHandlerHelper::getCollection() — Method in class ActionHandlerHelper

Return collection if is set

ActionHandlerHelper::getRegisteredActions() — Method in class ActionHandlerHelper

Return actions that are registered in this handler for a specific trigger

ActionHandlerHelper::getActionHandlerEndpoint() — Method in class ActionHandlerHelper

ActionHandlerHelper::getIterator() — Method in class ActionHandlerHelper

ActionHelper::getConfirmationQuestion() — Method in class ActionHelper

ActionHelper::getFeedbackMessage() — Method in class ActionHelper

ActionHelper::getIsDownload() — Method in class ActionHelper

ActionHelper::getOption() — Method in class ActionHelper

CollectionActionHelper::getCollection() — Method in class CollectionActionHelper

FormActionHelper::getForm() — Method in class FormActionHelper

I18nTokenHelper::getTranslatedString() — Method in class I18nTokenHelper

Return the translation of this token

$ LinkContextHelper#GPvars — Property in class LinkContextHelper

LinkContextHelper::get_xf_link() — Method in class LinkContextHelper

MagicDocumentHelper::get_document_index() — Method in class MagicDocumentHelper

Returns the document_index

MagicDocumentHelper::get_file_url() — Method in class MagicDocumentHelper

Returns the url to download this file

MagicDocumentHelper::get_file_link() — Method in class MagicDocumentHelper

Get file link

MagicDocumentHelper::get_file_path() — Method in class MagicDocumentHelper

Retrieves the file path for this document, in case any should exist

MagicDocumentHelper::get_doclink_url() — Method in class MagicDocumentHelper

Returns the url to the doclink

MagicDocumentHelper::get_preview_link() — Method in class MagicDocumentHelper

Returns a link to the document opening the doc viewer

MagicDocumentHelper::get_document_xui() — Method in class MagicDocumentHelper

Return the xui element for the document

MagicDocumentHelper::getFileExtension() — Method in class MagicDocumentHelper

MagicDocumentHelper::getType() — Method in class MagicDocumentHelper

What is the nature/type of this document

MagicDocumentHelper::get_webdav_url() — Method in class MagicDocumentHelper

Returns the webdav url that can be used to directly open the document belonging to this file.

MagicDocumentHelper::getAttachmentInfo() — Method in class MagicDocumentHelper

Information which is relevant for a attachment document and can be transmitted to frontend without security implications

MagicDocumentHelper::getWebserviceParameterObject() — Method in class MagicDocumentHelper

Make this object easier to use in API

MagicDocumentHelperList::getIterator() — Method in class MagicDocumentHelperList

MagicMethodHelper::get_object() — Method in class MagicMethodHelper

ModelActionHelper::getModel() — Method in class ModelActionHelper

SerializedObjectHelper::getSerializeProperties() — Method in class SerializedObjectHelper

$ XUILinkHelper#GPvars — Property in class XUILinkHelper

XUILinkHelper::get_config() — Method in class XUILinkHelper

XUILinkHelper::get_xf_link() — Method in class XUILinkHelper

CollectionActionHandlerInterface::getCollection() — Method in class CollectionActionHandlerInterface

ItemListInterface::getItems() — Method in class ItemListInterface

Template::get_xtag_registry() — Method in class Template

Returns the xtag registry

Template::get_config() — Method in class Template

Get Config Value of Custom Theme Config

Template::get_template_debug() — Method in class Template

Returns the debug output for the current template

Template::get_render_mode() — Method in class Template

Template::get_output_mode() — Method in class Template

Template::get_render_blocks() — Method in class Template

Template::get_rendered_object() — Method in class Template

Calls the render() function recursively of the passed object and returns the content

Template::get_marker_content() — Method in class Template

Template::get_marker_block() — Method in class Template

Template::generateTemplateCacheKey() — Method in class Template

Template::get_xtag_marker_value() — Method in class Template

Template::getFileCacheContent() — Method in class Template

Template::getAccessibilityClasses() — Method in class Template

Returns a string with all active accessibility classes

Template::getExpertConfig() — Method in class Template

CoreLinkMethods::get_link() — Method in class CoreLinkMethods

CoreLinkMethods::get_url() — Method in class CoreLinkMethods

CoreLinkMethods::get_current_link() — Method in class CoreLinkMethods

CoreLinkMethods::get_current_url() — Method in class CoreLinkMethods

ItemListTrait::getItems() — Method in class ItemListTrait

ItemListTrait::getIterator() — Method in class ItemListTrait

ObjectManager::get_lib_class_dir() — Method in class ObjectManager

Returns the path to class directory.

ObjectManager::get_lib_class_prefix() — Method in class ObjectManager

Returns the defined prefix for all classes.

ObjectManager::get_object_cache() — Method in class ObjectManager

Returns an array containing all objects were requested.

ObjectManager::getObjectIfAvailable() — Method in class ObjectManager

This method will return an object without killing the whole process by triggering a fatal error You can use this method if its possible that the object is not available, e.g. due to user configurations

VarsTemplate::get_block_attribute() — Method in class VarsTemplate

Get Block Attribute

VarsTemplate::get_blocks() — Method in class VarsTemplate

get an array with all existing blocks

VarsTemplate::get_xml() — Method in class VarsTemplate

Get XML Document as string

VarsTemplate::get_property() — Method in class VarsTemplate

VarsTemplate::get_block_xml() — Method in class VarsTemplate

VarsTemplate::getLocalizedXMLStringFromFile() — Method in class VarsTemplate

Loads the Vars file and tries to fetch the localized content for the given language.

Controller::get_model() — Method in class Controller

Controller::get_action() — Method in class Controller

Controller::get_view() — Method in class Controller

Controller::get_vars() — Method in class Controller

Get Vars Model

Controller::get_vars_from_text() — Method in class Controller

Create a Vars model from text

Controller::get_parsed_message() — Method in class Controller

GroupControllerInterface — Class in namespace XELOS\Framework\Module\Controller

Interface GroupControllerInterface

GroupControllerInterface::guessGroupId() — Method in class GroupControllerInterface

Guess the group ID by evaluating GP and CMD Vars

ModulePageCollector::getDynTreeParams() — Method in class ModulePageCollector

Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.

ModulePageCollector::getModulePages() — Method in class ModulePageCollector

Defines an array containing pages, which will then be returned to the group navigation form in order to display them as entries in the select field 'ref_page'.

ModulePageCollector::getCommandsForPage() — Method in class ModulePageCollector

Used to fetch the methods from the page passed.

AuthenticationHook::getAuthHook() — Method in class AuthenticationHook

Load Auth Method Hook without Access Check

AuthenticationHook::getSessionTTL() — Method in class AuthenticationHook

AuthenticationHook::get_user_details() — Method in class AuthenticationHook

AuthenticationHook::get_module_info() — Method in class AuthenticationHook

Return Auth Method information as keyed array [name, description, config]

AuthenticationHook::getAuthConfig() — Method in class AuthenticationHook

Return configuration variable for auth method

AuthenticationHook::getAuthID() — Method in class AuthenticationHook

Get internal Auth ID

AuthenticationHook::getConfigurationFDL() — Method in class AuthenticationHook

Return optional Configuration options as Form Definition Array

BaseHook::getHookInfoValue() — Method in class BaseHook

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

BaseHook::getHookIdentifier() — Method in class BaseHook

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

BaseHook::getHookName() — Method in class BaseHook

BaseHook::getHookInstance() — Method in class BaseHook

BaseHook::getHookDescription() — Method in class BaseHook

BaseHook::getHookTitle() — Method in class BaseHook

BaseHook::getObject() — Method in class BaseHook

BaseHook::getOption() — Method in class BaseHook

Returns the option with $key set in the config.yml

DocumentItem::get_description() — Method in class DocumentItem

Returns an i18n string describing the document type for which this content first library was created. The description should consist of approximately 30 words.

DocumentItem::get_location() — Method in class DocumentItem

Returns the "location" a document is located at in its home instance.

DocumentItem::get_location_form_element() — Method in class DocumentItem

Returns a fdl array containing specification on how to setup a location form element.

DocumentItem::get_icon_class() — Method in class DocumentItem

Returns the FontAwesome Class that can be used for items in the DMS

DocumentItem::get_views() — Method in class DocumentItem

Returns an array of name=>title pairs of all views that are available for the current document.

DocumentItem::get_view() — Method in class DocumentItem

Returns a specific view for the given document

DocumentItem::get_draft_view() — Method in class DocumentItem

Returns a view for editing the document before it is finally created.

DocumentItem::get_comments_instance() — Method in class DocumentItem

Returns the comments instance for a given document

PortletMigrationInterface::getPagesMigrationStatus() — Method in class PortletMigrationInterface

Required: What is the support level in migration?

PortletMigrationInterface::getPagesMigrationComponent() — Method in class PortletMigrationInterface

Optional: Which Pages Component is recommended for migration?

PortletMigrationInterface::getPagesMigrationHelpText() — Method in class PortletMigrationInterface

Optional: Be more specific about the migration

ModulePortlet::getCmsComponent() — Method in class ModulePortlet

Getter for the cms component which displays this portlet

ModulePortlet::getPagesMigrationStatus() — Method in class ModulePortlet

Used in combination with PortletMigrationInterface

ModulePortlet::getPagesMigrationComponent() — Method in class ModulePortlet

Used in combination with PortletMigrationInterface

ModulePortlet::getPagesMigrationHelpText() — Method in class ModulePortlet

Used in combination with PortletMigrationInterface

ModulePortlet::get_options() — Method in class ModulePortlet

ModulePortlet::get_config() — Method in class ModulePortlet

ModulePortlet::get_fdl() — Method in class ModulePortlet

If the portlet offers options please supply fdl for options

ModulePortlet::get_title() — Method in class ModulePortlet

ModulePortlet::get_title_link() — Method in class ModulePortlet

ModulePortlet::get_html() — Method in class ModulePortlet

ModulePortlet::getCallingContext() — Method in class ModulePortlet

ModulePortlet::getPageContext() — Method in class ModulePortlet

ModulePortlet::getEmptyPlaceholder() — Method in class ModulePortlet

Return Empty Placeholder WebComponent

NavigationHook::getIconClass() — Method in class NavigationHook

NavigationHook::getTitleI18n() — Method in class NavigationHook

NavigationHook::getDescriptionI18n() — Method in class NavigationHook

NavigationHook::getUrlParams() — Method in class NavigationHook

NavigationHook::getNavigationEntry() — Method in class NavigationHook

NavigationHook::getAdditionalUrlParams() — Method in class NavigationHook

Job::getStatus() — Method in class Job

Get the status of your job

Collection::getSearchQueryConditionGroup() — Method in class Collection

Get the Condition for simple text search/filter

Collection::getWebserviceParameterObject() — Method in class Collection

Get generic description of collection for webservice API

DocumentModel::getMod() — Method in class DocumentModel

DocumentModel::get_silent_mode() — Method in class DocumentModel

Returns if the silent mode is currently active Objects in silent mode do not cause document index job queues, thus saving them is much more performant but does not update the search index, the wall or other similar system modules

DocumentModel::get_document_index() — Method in class DocumentModel

Returns the related document index.

DocumentModel::get_document_tmp_folder() — Method in class DocumentModel

Returns the path for this documents storage path This folder is automatically cleared when the document is removed

DocumentModel::get_document_registry_info() — Method in class DocumentModel

Return the information from the document registry This information contains additional meta data as well as relational information

DocumentModel::get_xui_document() — Method in class DocumentModel

Get XUI Document Representation

DocumentModel::get_cf() — Method in class DocumentModel

Return the cf library for this model type

AuditableInterface::getAuditTrail() — Method in class AuditableInterface

Get Audit Trail

AuditableInterface::getAuditIncludeProperties() — Method in class AuditableInterface

Get the (Auditable) attributes included in audit.

AuditableInterface::getAuditExcludeProperties() — Method in class AuditableInterface

Get the (Auditable) attributes excluded from audit.

DuplicatableInterface::getNonDuplicatableFields() — Method in class DuplicatableInterface

XQLApiInterface::getWebserviceParameterObject() — Method in class XQLApiInterface

XQLApiInterface::getXQLResult() — Method in class XQLApiInterface

XQLApiInterface::getAPIResult() — Method in class XQLApiInterface

Model::getDBSchema() — Method in class Model

Get DB Schema if available

Model::get_table_name() — Method in class Model

Returns the table name of this model.

Model::get_model_table_name() — Method in class Model

Returns the SQL table of this model (if available)

Model::get_table_primary_key() — Method in class Model

Model::getPrimaryKeyValue() — Method in class Model

Get the primary id (post_id) for this model

Model::get_model_name() — Method in class Model

Returns the SQL table of this model (if available)

Model::get_property() — Method in class Model

Model::get_properties() — Method in class Model

Returns the complete properties array

Model::getPropertyMarkers() — Method in class Model

Return properties and markers

Model::get_properties_meta() — Method in class Model

Model::get_db_properties() — Method in class Model

Returns all properties which are available as DB field (= can be used as find_by() properties) with its currently known raw value Please note that smartTimeFields (updated_at, created_at) are not converted to mysql-date format

Model::getCollectionByQuery() — Method in class Model

Model::getModelCollection() — Method in class Model

Return a new unscoped model collection for further processing

Model::get_created_at_formatted() — Method in class Model

Return a Formatted DateTime

Model::get_updated_at_formatted() — Method in class Model

Return a Formatted DateTime

Model::get_request_cache() — Method in class Model

Return Cache Entry if it exists

Model::get_i18n_property() — Method in class Model

Return the property translated property value if available

Model::getI18nPropertyVariants() — Method in class Model

Returns a list of all property name variants for all languages, e.g. "title_i18n" -> "title_i18n, title_DE_DE, title_EN_EN"

Model::getTouchedProperties() — Method in class Model

Return properties which have been touched/set after model was initialized/loaded We know these values have been set, but they might not have changed

Model::getChangedProperties() — Method in class Model

Return properties which have been changed after model was initialized/loaded We know these values have been changed locally, but these changes are NOT necessarily reflecting the DB diff

Model::getI18nTokenForProperty() — Method in class Model

Gets an I18nToken for a model property (e.g. title_i18n)

ModelCollection::get_model_class() — Method in class ModelCollection

put your comment there.

ModelCollection::get_models() — Method in class ModelCollection

Returns array with objects

ModelCollection::getDocumentIndexes() — Method in class ModelCollection

Prefetch and returns document index objects for all items of this collection.

ModelCollection::getRelatedDocumentIndexCollection() — Method in class ModelCollection

Returns a DocumentIndexCollection which is NOT loaded

ModelCollection::get_model() — Method in class ModelCollection

Returns the Default-Model (-Type) for this Collection

ModelCollection::get_db_properties() — Method in class ModelCollection

ModelCollection::getIterator() — Method in class ModelCollection

foreach($collection) .

ModelWithThumbnail::get_thumbnail_document() — Method in class ModelWithThumbnail

AuditableTrait::getAuditEvents() — Method in class AuditableTrait

Get audit events

AuditableTrait::getAuditTrail() — Method in class AuditableTrait

Get the last auditTrail records for current Model

AuditableTrait::getAuditIncludeProperties() — Method in class AuditableTrait

Get the auditable properties to include in audit Defaults to all attributes in the DB Schema

AuditableTrait::getAuditExcludeProperties() — Method in class AuditableTrait

Get the (Auditable) properties excluded from audit.

ScopesTrait::getScopeQuery() — Method in class ScopesTrait

Returns the Query object which is being used for building the query The function creates a new Query object if required to enable lazy loading

DocumentCollectionTrait::getWebserviceParameterObject() — Method in class DocumentCollectionTrait

Get generic description of collection for webservice API

DuplicatableModelTrait::getUniquePropertyValue() — Method in class DuplicatableModelTrait

Helper Function to iterate over existing field values to ensure a valid name. a "_ID" with an increasing ID will be appended if the value already exists

DuplicatableModelTrait::getNonDuplicatableFields() — Method in class DuplicatableModelTrait

SoftDeleteTrait::getSoftDeleteKeepDays() — Method in class SoftDeleteTrait

Returns how many days the soft deleted documents are kept.

XQLCollectionTrait::getWebserviceParameterObject() — Method in class XQLCollectionTrait

Get generic description of collection for webservice API

XQLCollectionTrait::getXQLResult() — Method in class XQLCollectionTrait

Apply XELOS Query Language Object

• [Optional] Apply $filter
• [Optional] Apply $pagination
• [Optional] Populate $expand
• [Optional] Remove fields which are not required by $select

XQLCollectionTrait::getAPIResult() — Method in class XQLCollectionTrait

Fullfill API Request and return result

XQLCollectionTrait::getXQLReferenceClosure() — Method in class XQLCollectionTrait

Returns a closure that adds an AfterLoadListener to filter elements of a reference collection and attach them as expand property to this collection, e.g. articles referencing to user by user_id

Page::get_page() — Method in class Page

Standard Get Page Controller

SetupPage::get_step_instance_policy() — Method in class SetupPage

SetupPage::get_configuration_steps() — Method in class SetupPage

SetupPage::get_setup_step() — Method in class SetupPage

SystemCron::getErrorCount() — Method in class SystemCron

SystemCron::getLastExecution() — Method in class SystemCron

Return last execution timestamp

SystemDaemonThreaded::getThreadConfig() — Method in class SystemDaemonThreaded

Returns an array with all threads which should run and their options By default we use the configured number of Max Threads

SystemDaemonThreaded::getRequiredThreadCount() — Method in class SystemDaemonThreaded

Returns the number of required Threads By default this is the maximum number of configured threads but best-practise is to make this adaptive by your workload and use your queue length to adjust the thread count to reduce the number of running threads during low load situations

Document::get_title() — Method in class Document

Return Document Title

Document::get_title_icon_class() — Method in class Document

Return CSS Icon class for title

Document::get_description() — Method in class Document

Return Document Description

Document::get_image() — Method in class Document

Return Document Image URL (mod->get_file_url)

Document::get_full_preview() — Method in class Document

Return Full Preview for this document

Document::get_sidebar() — Method in class Document

Get Sidebars for Full Preview

Document::get_doclink_actions() — Method in class Document

Document::getDocumentThumbnail() — Method in class Document

Return Document Video Thumbnail URL

Document::getCard() — Method in class Document

This function may be overridden by other document classes.

Document::getCardCompact() — Method in class Document

This function may be overridden by other document classes.

UIAjaxComponent::get_dependency() — Method in class UIAjaxComponent

Returns a dependent object in order to interact with it

UIAjaxComponent::getLinkHelper() — Method in class UIAjaxComponent

UIAjaxComponent::getPlaceholderContent() — Method in class UIAjaxComponent

Returns a placeholder which is used to display while this component is loading the content.

UIAjaxComponent::getCurrentAjaxLink() — Method in class UIAjaxComponent

$ UIComponent#GPvars — Property in class UIComponent

UIComponent::get() — Method in class UIComponent

Get Variable / Option

UIComponent::get_unique_dom_id() — Method in class UIComponent

Generates a unique dom id, dependent on the provided UID, as well as the current context.

UIComponent::get_view() — Method in class UIComponent

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

$ XF#GPvars — Property in class XF

$ XF#grd_count — Property in class XF

Config::get() — Method in class Config

Config::get_explicit() — Method in class Config

Get the config setting for the current user of an explicit level (global, [instance_name] or user) If you need the user config for another user than the current, use function 'get_explicit_for_user' instead

Config::get_explicit_for_user() — Method in class Config

Get the explicit config setting for a specific user

Config::get_from_session() — Method in class Config

Config::get_dyn_value() — Method in class Config

Config::get_config_fdl() — Method in class Config

Returns the config fdl for a regular config field

Config::get_dyn_config_fdl() — Method in class Config

Returns the config fdl for a dyn config field

Config::get_constant() — Method in class Config

Accessor for USER constants.

MySQLAdapter::get_server_vars() — Method in class MySQLAdapter

Server Variables

MySQLAdapter::getMySQLServerVersion() — Method in class MySQLAdapter

Return Server Version as MYSQL Version This function will try to manipulate mariadb versions to match corresponding mysql version

MySQLAdapter::getMariaDBServerVersion() — Method in class MySQLAdapter

Return the MariaDB Server Version if MariaDB is detected

MySQLAdapter::get_query_count() — Method in class MySQLAdapter

Returns the number of executed queries since connecting the database server

MySQLAdapter::get_table_structure() — Method in class MySQLAdapter

MySQLAdapter::get_database_status() — Method in class MySQLAdapter

Returns the "SHOW STATUS" result in an array

MySQLAdapter::get_link() — Method in class MySQLAdapter

Returns the mysqli link object

MySQLAdapter::get_charset() — Method in class MySQLAdapter

Condition::getField() — Method in class Condition

Condition::getValue() — Method in class Condition

Condition::getSQL() — Method in class Condition

ConditionGroup::getSQL() — Method in class ConditionGroup

PartitionQuery::getPartitionColumn() — Method in class PartitionQuery

PartitionQuery::getInternalOrderBySQL() — Method in class PartitionQuery

OrderBy without ALIAS as these will NOT be available internally

PartitionQuery::getScopeLimit() — Method in class PartitionQuery

PartitionQuery::getSQL() — Method in class PartitionQuery

PartitionQuery::getPartitionCounts() — Method in class PartitionQuery

Query::groupBy() — Method in class Query

Add a group by condition to the Query

Query::getSQL() — Method in class Query

Returns the full SQL string for this Query

Query::getScopeWhere() — Method in class Query

Returns an array with all defined Conditions

Query::getScopeWhereGroup() — Method in class Query

Returns an array with all defined Conditions

Query::getOrderBySQL() — Method in class Query

Return ORDER BY part of the query

Query::getScopeLimit() — Method in class Query

Return Limit

Query::getWhereConditionsForField() — Method in class Query

Checks if a condition for the specified field is specified NOTE: This check does not (yet) cover whereRaw() conditions with custom syntaxes

Query::getWhereSQL() — Method in class Query

Builds the WHERE Condition SQL

Query::getSelectSQL() — Method in class Query

Builds the SELECT SQL

Query::getSelectedFields() — Method in class Query

Query::getTable() — Method in class Query

Query::getJoins() — Method in class Query

IM::get_hook_instances() — Method in class IM

IM::get_mod_instance_list() — Method in class IM

IM::get_instance_list() — Method in class IM

Returns an array of all available instances

IM::get_global_group_parent_context() — Method in class IM

returns global group parent context reference [Core] (if set). false if not set

IM::get_global_group_context() — Method in class IM

returns global group context if set

IM::get_instance() — Method in class IM

IM::getDefaultInstance() — Method in class IM

Return the default instance for given ModuleControllerClass

IM::get_mod_instance() — Method in class IM

IM::get_instance_reference() — Method in class IM

Retrieve an Object Reference from the "lib-array"

IM::get_module_icon() — Method in class IM

IM::get_module_meta() — Method in class IM

IM::get_instance_meta() — Method in class IM

IM::get_module_name_for_instance() — Method in class IM

Search and return Module Name Returns false if current user has no access rights for passed instance, otherwise the name of the module is returned

IM::get_default_instance() — Method in class IM

returns the default instance of the given module or false if no default is available

IM::get_related_instances() — Method in class IM

Returns all related instances(grand parent, parent, children and siblings)

IM::get_changed_files() — Method in class IM

Returns all changed files from modules and system.

$ Lib#group_security — Property in class Lib

Browser::get_user_agent() — Method in class Browser

put your comment there.

Browser::get_version() — Method in class Browser

Returns numeric version of client

Browser::get_browser_info() — Method in class Browser

Returns browser name and version info

Browser::get_resolution() — Method in class Browser

Returns the browser resultion and device pixel ration / retine (dpr) if available The values are being detected in the frontend via JavaScript and passed as cookie. Therefore the first request to a XELOS system might not have the values ready

Browser::get_touch_status() — Method in class Browser

Returns if the browser device has_touch: The device is generally capable of interpreting touch inputs (e.g. Windows Tables with Touchscreen) use_touch: The user is currently using the device in touch mode. Use this value for best interface compatibility with hybrid devices (e.g. Windows Touch Laptop which is being used with a traditional mouse)

Browser::get_browser_shortname() — Method in class Browser

Returns a human readable short string of the current browser of the user

Browser::get_long_info() — Method in class Browser

Get long Information about everything we can find out at this point

Browser::get_ip() — Method in class Browser

returns the client ip and checks therefor if user was forwarded by a proxy

Browser::get_hostname() — Method in class Browser

Returns the client hostname (DNS) if available

Browser::getXelosAppVersion() — Method in class Browser

Checks if the request comes from the XELOS App and determines the version based on the user agent returns the major app version or 0 if the reques does not come from the APP

Browser::getRequestInfo() — Method in class Browser

Get Request Info

Cache::get() — Method in class Cache

Cache::get_grouped_cached_keys() — Method in class Cache

Cache::get_status() — Method in class Cache

Returns current Cache Status

Cache::get_detailed_status() — Method in class Cache

Cache::get_current_adapter_name() — Method in class Cache

Returns the full class name of the current adapter

APCUCacheHandler::get() — Method in class APCUCacheHandler

APCUCacheHandler::get_grouped_cached_keys() — Method in class APCUCacheHandler

APCUCacheHandler::get_detailed_status() — Method in class APCUCacheHandler

CacheHandlerInterface::get() — Method in class CacheHandlerInterface

CacheHandlerInterface::get_grouped_cached_keys() — Method in class CacheHandlerInterface

CacheHandlerInterface::get_detailed_status() — Method in class CacheHandlerInterface

MemcacheCacheHandler::get() — Method in class MemcacheCacheHandler

MemcacheCacheHandler::get_grouped_cached_keys() — Method in class MemcacheCacheHandler

MemcacheCacheHandler::get_detailed_status() — Method in class MemcacheCacheHandler

RedisCacheHandler::getServerURLs() — Method in class RedisCacheHandler

Get REDIS Server Info based on CONFIG/CONSTANTS

RedisCacheHandler::getServerAuth() — Method in class RedisCacheHandler

Get REDIS Server AUTH Code based on CONFIG/CONSTANTS

RedisCacheHandler::get() — Method in class RedisCacheHandler

RedisCacheHandler::get_grouped_cached_keys() — Method in class RedisCacheHandler

RedisCacheHandler::get_detailed_status() — Method in class RedisCacheHandler

Connect::getSoapClient() — Method in class Connect

Connect::getFunctionDetails() — Method in class Connect

Returns the function detail parameters for this function.

Connect::get_encoded_license_info() — Method in class Connect

Check License

Connect::get_licensed_modules() — Method in class Connect

Returns a list with all module ids (names) that are included in the current license.

Connect::get_license_info() — Method in class Connect

Connect::get_my_ip() — Method in class Connect

Returns the current public IP address if possible

Date::get_weekday_names() — Method in class Date

Date::get_month_names() — Method in class Date

Date::get_first_day_of_month() — Method in class Date

Date::get_day_start() — Method in class Date

Date::get_day_end() — Method in class Date

Date::get_age() — Method in class Date

Return age in years for this timestamp

Date::get_first_day_of_week() — Method in class Date

Date::get_last_day_of_week() — Method in class Date

Date::get_last_day_of_month() — Method in class Date

Date::get_verbal_timespans() — Method in class Date

Returns all available verbal timespans

Date::get_timespan_to_timestamp() — Method in class Date

Pass a timespan id (use get_verbal_timespans()) and returns an array with start and end timestamp

Date::guess_date_format() — Method in class Date

Determines the date format on basis of its format

Date::get_timestamp_from_datestring() — Method in class Date

Translates a given time string to the corresponding timestamp

Date::get_easter() — Method in class Date

Return Easter TS

Date::get_german_holidays() — Method in class Date

Get German Holidays

Date::get_date_range() — Method in class Date

Get Date Range

Debug::getLastQueryProfilerResult() — Method in class Debug

Debug::get_previous_call() — Method in class Debug

Returns an array with the last step

Debug::get_sourcecode_line() — Method in class Debug

Debug::get_execution_time() — Method in class Debug

Debug::getTimerSections() — Method in class Debug

Debug::getTimerStats() — Method in class Debug

Returns an array containing the aggregated timer statistics

SlimTimer::getRuntime() — Method in class SlimTimer

Doclink::get_registry_data_by_model_name() — Method in class Doclink

Returns an array with all document registry data

Doclink::get_doclink_url() — Method in class Doclink

Get URL to page where the doclink document originates from

Error::get_log_level() — Method in class Error

Get Log Level

Error::getLogLevelName() — Method in class Error

Export::get_table_formats() — Method in class Export

Export::get_feedcreator() — Method in class Export

File::get_mime_by_extension() — Method in class File

File::get_mime() — Method in class File

File::get_filename_without_extension() — Method in class File

File::get_file_extension() — Method in class File

File::get_file_extension_by_mime() — Method in class File

File::get_file_details() — Method in class File

File::get_file_encoding() — Method in class File

Returns the encoding of the file.

File::get_file_charset() — Method in class File

Returns the charset of the given file. This method uses exec() to

File::get_contents() — Method in class File

Returns the content of a file or url by curl.

File::get_file_contents() — Method in class File

File::get_temp_name() — Method in class File

File::get_temp_folder() — Method in class File

File::get_temp_backup_folder() — Method in class File

Creates a temporary folder for backup data and returns the path.

File::get_document_temp_folder() — Method in class File

File::get_cascaded_folder() — Method in class File

Returns a cascaded path based on the passed id to prevent file system storage limitations. 10.000 files per folder will be used.

File::get_cache_file() — Method in class File

File::getVideoExtensions() — Method in class File

returns an array with ffmpeg compatible video extensions this is populated from video worker

File::get_friendly_filename() — Method in class File

File::get_friendly_filesize() — Method in class File

Get friendly filesize

File::get_secure_filename() — Method in class File

File::get_first_file_found() — Method in class File

File::get_max_upload_size() — Method in class File

File::get_editable_file_types() — Method in class File

Editable File Types for XOI or directly via MS-Office

File::getFileInfo() — Method in class File

Get File Information

Filehandler::get_cached_imageresize() — Method in class Filehandler

Filehandler::get_image() — Method in class Filehandler

Get Image from File Path

Filehandler::gif_info() — Method in class Filehandler

Filehandler::get_download_id() — Method in class Filehandler

Returns a download ID for the given file

Filehandler::get_order_id() — Method in class Filehandler

Returns a order ID for the given file

Filehandler::get_zip() — Method in class Filehandler

Foaf::getConnectionPath() — Method in class Foaf

Foaf::getAllContacts() — Method in class Foaf

Foaf::get_pending_contacts_from() — Method in class Foaf

returns all pending contacts from user [overloaded function of get_pending_contacts_to()]

Foaf::get_pending_contacts_to() — Method in class Foaf

returns all pending contacts to user [overloaded function of get_pending_contacts_to()]

Foaf::get_pending_contacts() — Method in class Foaf

returns all pending contacts

Foaf::get_contact_id_list() — Method in class Foaf

Same as get_all_contacts but returns 1-dim array conaining only the user ids

Format::get_formatted_tag_cloud() — Method in class Format

Formats a get_tag_cloud() return using different font-sizes

GroupSecurity — Class in namespace XELOS\Framework\XF\Lib

GroupSecurity::get_global_group() — Method in class GroupSecurity

Get Global Group ID for your local ID (using your group module instance, e.g. groups or groupizer)

GroupSecurity::get_local_group() — Method in class GroupSecurity

Get local Group ID for your global group_security_id (using your group module instance, e.g. groups or groupizer)

GroupSecurity::get_local_group_meta() — Method in class GroupSecurity

Get Metainformation Global Group ID for your local ID (using your group module instance, e.g. groups or groupizer)

GroupSecurity::get_global_group_meta() — Method in class GroupSecurity

Get Metainformation Global Group ID for your global ID

GroupSecurity::get_instance_global_group() — Method in class GroupSecurity

Get Global Group ID for your local ID (using your grouped instance, e.g. forum) Function will traverse parent contexts and return the first global group found

GroupSecurity::get_instance_local_group() — Method in class GroupSecurity

Get LOCAL Group ID for your group_securiy_id (using your grouped instance, e.g. forum)

GroupSecurity::get_accessible_groups() — Method in class GroupSecurity

Get Groups of this user which are accessible

GroupSecurity::get_accessible_groups_by_policycheck() — Method in class GroupSecurity

Determine the group_security_ids for a specific resource in a grouped module

GroupSecurity::get_available_roles_for_global_group() — Method in class GroupSecurity

retruns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

GroupSecurity::get_available_users_for_global_group() — Method in class GroupSecurity

retruns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

GroupSecurity::get_members_for_global_group() — Method in class GroupSecurity

Returns an array of all available role ids if detectable detectable means that the gid contains to a instance of the type group (other will come e.g. multitenant)

Hierarchy::get_default_context() — Method in class Hierarchy

Get Default Hierarchy Context

Hierarchy::get_current() — Method in class Hierarchy

Get current hierarchy position for current user in specific context

Hierarchy::get_superiors() — Method in class Hierarchy

Get Superior Users from Context ID You can apply additional filters which will limit the applicable users

Hierarchy::get_users_by_level() — Method in class Hierarchy

Helper for get_superiors

Hierarchy::get_subordinates() — Method in class Hierarchy

Get Subordinates from Context ID You can apply additional filters which will limit the applicable users

Hierarchy::get_hierarchy() — Method in class Hierarchy

Get Hierarchy

Hierarchy::get_hierarchy_node() — Method in class Hierarchy

Get a single hierarchy node (uses caching)

I18n::get_locale() — Method in class I18n

I18n::getLocaleConv() — Method in class I18n

Mimics localeconv() using Intl Library

I18n::get_language() — Method in class I18n

I18n::get_culture() — Method in class I18n

I18n::get_conventions() — Method in class I18n

Returns the conventions of the current locale

I18n::get_timezone() — Method in class I18n

I18n::get_translation() — Method in class I18n

Returns the translation for the passed token.

I18n::get_translated_tokens() — Method in class I18n

Returns an array with all translated tokens during this page call

I18n::get_parsed_message() — Method in class I18n

I18n::getTranslation() — Method in class I18n

Translates a token and replaces the placeholders in it.

I18n::get_available_languages() — Method in class I18n

gets languages found in tbl|system_i18n_language.

I18n::get_country_list() — Method in class I18n

querys tbl|system_lib_country and returns array with list of countries.

I18n::get_language_select() — Method in class I18n

Get language selection menu

I18n::getCurrentTranslationVersion() — Method in class I18n

Return the current translation version

Import::get_table_formats() — Method in class Import

Returns all available export formats

Import::get_assoc_csv_array() — Method in class Import

Returns an assoc array with header row values as data row index.

Link::get_defaults() — Method in class Link

Link::get_url() — Method in class Link

GET URL

Link::get_current_url() — Method in class Link

Link::get_current_link() — Method in class Link

Return Link as Ressource-Array using the parameters of the current page call

Link::get_link() — Method in class Link

Return Link as Ressource-Array

Link::getContextMenu() — Method in class Link

Generate Context Menu (WebComponent)

Link::get_host() — Method in class Link

Returns the host with protocol and port if is not the default port.

Link::getDomain() — Method in class Link

Returns the current domain name with TLD.

Link::get_filtered_GPvars() — Method in class Link

Link::get_context_hidden_field() — Method in class Link

Link::get_context_id() — Method in class Link

Link::get_context_counter() — Method in class Link

Link::get_internal_url_info() — Method in class Link

Link::get_url_info() — Method in class Link

Parse URL and retrieve information

Link::getCurrentRequestURI() — Method in class Link

Return the current Request URI, without access checks Allows to pass custom query Params Filter XELOS a_ params from URL

Link::getModifiedRequestURI() — Method in class Link

Modify a Request URI, without access checks Allows to pass custom query Params Filter XELOS a_ params from URL

GelfHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger\HandlerFactory

Class DatabaseStreamHandlerFactory

Logger::getDefaultLevel() — Method in class Logger

Returns the log level defined in XF_LOG_LEVEL

Logger::getStats() — Method in class Logger

Logger::getInMemoryLogs() — Method in class Logger

Logger::getLastLogEntry() — Method in class Logger

Returns the last logged entry

GlobalContext — Class in namespace XELOS\Framework\XF\Lib\Logger\Processor

Class GlobalContext

Mail::get_sender() — Method in class Mail

Mail::get_errors() — Method in class Mail

Mail::get_smtp_log() — Method in class Mail

Mail::get_draft_header() — Method in class Mail

Mail::get_mail_template() — Method in class Mail

Get mail Template

Modsetup::get_config_values() — Method in class Modsetup

Modsetup::get_dependency_values() — Method in class Modsetup

Modsetup::get_config_group_details() — Method in class Modsetup

Modsetup::get_table_prefix() — Method in class Modsetup

Modsetup::get_dependencies_check_array() — Method in class Modsetup

Modsetup::get_shellplugin_usage_list() — Method in class Modsetup

Returns an array with information about each shellplugin's usage by the installed modules

Modsetup::get_config_yml() — Method in class Modsetup

Get config.yml values for a module

Modsetup::get_database_yml() — Method in class Modsetup

Get config.yml values for a module

Modsetup::get_schema() — Method in class Modsetup

Modsetup::get_system_maintenance_message() — Method in class Modsetup

If system is in maintenance mode, the maintenance message is returned. Otherwise false

Modsetup::getSystemMaintenanceInfo() — Method in class Modsetup

Get Maintenance Info

Navigation::get_nav_tree() — Method in class Navigation

Navigation::getNavNode() — Method in class Navigation

Get information about nav node, if visible to user

Navigation::get_nav_array() — Method in class Navigation

Navigation::getFullNavArray() — Method in class Navigation

Returns the navigation array including hidden values

Navigation::get_navid_path() — Method in class Navigation

Navigation::guess_navid() — Method in class Navigation

Tries to get the navigation ID for the given instance, page and cmd args

Navigation::getDynTreeCacheKey() — Method in class Navigation

Get Cache Key Prefix for Dyntree

Navigation::get_current_nav_id() — Method in class Navigation

proxy function

Navigation::get_navigation_details() — Method in class Navigation

put your comment there.

Notification::getTodos() — Method in class Notification

Returns the todo notification with added features:

• Lookbook Friend requests
• Pending workflows

Notification::get_notifications() — Method in class Notification

get all notifications

Notification::getMessageNotifications() — Method in class Notification

This function returns a scoped but unloaded collection. You can apply limit and additional scopes

Notification::getActivityNotifications() — Method in class Notification

This function returns a scoped but unloaded collection. You can apply limit and additional scopes

Notification::getTodoNotifications() — Method in class Notification

This function returns a scoped but unloaded collection. You can apply limit and additional scopes

Notification::getCountsCacheKey() — Method in class Notification

NotificationMessage::getRecipientUserID() — Method in class NotificationMessage

NotificationMessage::getStatus() — Method in class NotificationMessage

NotificationMessage::getType() — Method in class NotificationMessage

NotificationMessage::getToken() — Method in class NotificationMessage

NotificationMessage::getSourceInstanceId() — Method in class NotificationMessage

NotificationMessage::getSubject() — Method in class NotificationMessage

NotificationMessage::getHtml() — Method in class NotificationMessage

NotificationMessage::getText() — Method in class NotificationMessage

NotificationMessage::getIconCSSClass() — Method in class NotificationMessage

NotificationMessage::getCTAUrl() — Method in class NotificationMessage

Call To Action URL - when the user clicks the notifcation - where should he go to ?

NotificationMessage::getSourceRegistryId() — Method in class NotificationMessage

NotificationMessage::getDocumentIndexId() — Method in class NotificationMessage

Policy::get_policy_key_by_names() — Method in class Policy

Generate the policy key for a given policy setting

Policy::get_policy_key() — Method in class Policy

Generate the policy key for a given policy setting

Policy::get_user_clusters_for_instance_ids() — Method in class Policy

Returns users grouped into clusters that have the same rights An array of instance ids can be passed in order to group users that have the same rights within the scope of these instances.

Policy::get_user_clusters() — Method in class Policy

Return users in clusters that have the same rights settings A document index may be passed to group the users to clusters that have the same rights for that particular document

Policy::get_all_parent_contexts() — Method in class Policy

Returns the instance ids of all ancestors for a given instance id, including the passed one

Policy::get_hook_policy_value() — Method in class Policy

Retrieves a dummy policy value for a given hook

Policy::getUserCollectionWithResourceAccess() — Method in class Policy

Combines user-collection based filter-methods to apply scopes to a new user-collection.

QueueableJob::getMaxRetries() — Method in class QueueableJob

When requested on existing job, this will show max retries left

QueueableJob::getRetryDelay() — Method in class QueueableJob

QueueableJob::getUniqueId() — Method in class QueueableJob

Can be implemented on the Job to avoid running the same task multiple times at once If the task already exists in the queue and is waiting or in process the next tasks won't be scheduled

QueueableJob::getReferenceKey() — Method in class QueueableJob

Define a reference ID which can later be used to lookup this job

QueueableJob::getReScheduleDelay() — Method in class QueueableJob

Returns the number of seconds if the tasks should be rescheduled or false if not

QueueableJob::getIdToken() — Method in class QueueableJob

ID Token will become available AFTER schedule

QueueableJob::getJob() — Method in class QueueableJob

QueueableJob::getQueue() — Method in class QueueableJob

QueueableJob::getJobQueueModule() — Method in class QueueableJob

Helper to get the JobQueue module

QueueableJob::getScheduledDateTime() — Method in class QueueableJob

QueueableJob::getJobCallbackURI() — Method in class QueueableJob

Returns the URI to the job status page

QueueableJob::getJobApiToken() — Method in class QueueableJob

Quota::get_used() — Method in class Quota

Returns the used size.

Quota::get_size() — Method in class Quota

Returns the quota size.

Quota::get_percent() — Method in class Quota

Return the percent number.

$ Request#get — Property in class Request

Request::get_var() — Method in class Request

Request::get_input() — Method in class Request

Read everything from STDIN e.g. for PUT Requests

Request::getMethod() — Method in class Request

Sec::generate_password() — Method in class Sec

Wrapper for pronouncable password

Sec::generate_random_password() — Method in class Sec

Returns a generated password string

Sec::generate_pronouncable_password() — Method in class Sec

Generate pronouncable password

Sec::get_password_score() — Method in class Sec

Check how good a password is (Score > 4 is acceptable, Score > 7 is good)

Sec::generate_totp_secret() — Method in class Sec

Generates a Secret for TOTP Authentication

Sec::generateJWTToken() — Method in class Sec

Generates a JWT Token.

Sec::getJWTAlgorithm() — Method in class Sec

Determine JWT Algorithm

Session::get_session_id() — Method in class Session

Returns the current, cleaned Session ID

Session::get() — Method in class Session

Get the value for the passed key. The value can be stored using set() and is available until the user session is destroyed

Session::get_session_handler_info() — Method in class Session

Returns information about the current session handler

Session::get_current_sessions() — Method in class Session

Returns a List of User IDs having a Session

SessionManagementInterface::get_current_sessions() — Method in class SessionManagementInterface

Returns an array with current (unexpired) user sessions containing at least the fields SESSION_ID, USER_ID More fields are possible but not required (depends on session handler)

NonpersistentSessionHandler::gc() — Method in class NonpersistentSessionHandler

RedisSessionHandler::get_current_sessions() — Method in class RedisSessionHandler

SqlSessionHandler::gc() — Method in class SqlSessionHandler

Garbage Collector to remove old Sessions (called based on session.gc_probability)

SqlSessionHandler::get_current_sessions() — Method in class SqlSessionHandler

Returns an array with current (unexpired) user sessions containing at least the fields SESSION_ID, USER_ID More fields are possible but not required (depends on session handler)

Shell::get_daemon_process_id() — Method in class Shell

Shell::get_module_cron_object() — Method in class Shell

Loads the specified module cron object and returns it

Shell::get_process_id() — Method in class Shell

Shell::getProcessOwner() — Method in class Shell

Return current process owner

Shell::getConfiguredProcessOwners() — Method in class Shell

Returns the configured process owners with their linux userinfo

Ssl::get_protocol() — Method in class Ssl

Text::get_diff() — Method in class Text

Text::get_diff_render() — Method in class Text

Text::get_soundex() — Method in class Text

Soundex "Like" based on Locale

Text::get_hashtags() — Method in class Text

Extracts all hashtags in the given text and returns them as array

Text::getNormalizedLetters() — Method in class Text

Returns a list of umlauts and accent letters with their corresponding normalized letters.

Threading::getProcessCaption() — Method in class Threading

Thumbnail::generate() — Method in class Thumbnail

Generate a Thumb for the passed file and returns the file path to the generated image

Thumbnail::get_output_mime() — Method in class Thumbnail

Returns the MIME Type of the generated thumbs

Thumbnail::generatePreviewsOfDocument() — Method in class Thumbnail

Evaluates the proper thumb doc of a document If the document index does not yet have a thumb_doc property, it is evaluated and saved.

Thumbnail::get_document_thumbnail_url() — Method in class Thumbnail

Generates the url to a thumbnail of given proportions for a specific document index. Returns false if an error occurred.

Thumbnail::get_supported_file_types() — Method in class Thumbnail

Get Support File Types

$ UserImport#generatedPasswordLength — Property in class UserImport

$ UserImport#generatedPasswordStrength — Property in class UserImport

UserImport::getMode() — Method in class UserImport

UserImport::getAutoGeneratePassword() — Method in class UserImport

UserImport::getAllowPasswordChange() — Method in class UserImport

UserImport::getGeneratedPasswordLength() — Method in class UserImport

UserImport::getGeneratedPasswordStrength() — Method in class UserImport

UserImport::getAutoGenerateLogin() — Method in class UserImport

UserImport::getAutoGenerateDisplayname() — Method in class UserImport

UserImport::getUniqueIdentifierField() — Method in class UserImport

UserImport::getAfterPrepareCallback() — Method in class UserImport

UserImport::getFindExistingUserCallback() — Method in class UserImport

Token::getDomain() — Method in class Token

Returns the Domain of the token (e.g. default)

Token::getTokenId() — Method in class Token

Returns the token including the domain prefix

Token::getTranslation() — Method in class Token

Returns an array with all available translations and the locale as array key

Token::getOccurence() — Method in class Token

Returns an array with all occurences of this token in the source

Token::getPluralToken() — Method in class Token

Returns a plural tokenId if set or FALS if not

TokenCollection::get() — Method in class TokenCollection

Returns the Token for the passed Token ID

TokenCollection::getTokens() — Method in class TokenCollection

Returns an array with all token objects in this collection

System::get_page() — Method in class System

Internally we provide a fake page for users to gain access to system models, but we are not returning any content here

System::getCurrentVersion() — Method in class System

Returns the current version of XELOS by selecting the higher version of XELOS Core and XELOS Tools.

DocumentIndexCollection::getRelatedDocumentModelCollection() — Method in class DocumentIndexCollection

Will only return models that are matching the specified type/source You can trigger a preload/association between DocumentModel and DocumentIndex by calling get_document_index on the document model

DocumentIndexCollection::getWebserviceParameterObject() — Method in class DocumentIndexCollection

Get generic description of collection for webservice API

DocumentIndexCollection::getIterator() — Method in class DocumentIndexCollection

DocumentIndexCollection::get_model() — Method in class DocumentIndexCollection

DocumentIndexReferenceCollection::getWebserviceParameterObject() — Method in class DocumentIndexReferenceCollection

Get generic description of collection for webservice API

DocumentIndexReferenceCollection::getIterator() — Method in class DocumentIndexReferenceCollection

DocumentIndexReferenceCollection::get_model() — Method in class DocumentIndexReferenceCollection

GroupCollection — Class in namespace XELOS\Framework\XF\System\Collection

GroupCollection::getOptionListWithSeparators() — Method in class GroupCollection

Return Optionlist with folders as separators

GroupCollection::getIterator() — Method in class GroupCollection

InstanceRegistryCollection::getDefaultInstance() — Method in class InstanceRegistryCollection

Get Default Instance for ModuleName

InstanceRegistryCollection::getIterator() — Method in class InstanceRegistryCollection

ModuleGroupSecurityCollection::getWebserviceParameterObject() — Method in class ModuleGroupSecurityCollection

Get generic description of collection for webservice API

ModuleGroupSecurityCollection::getIterator() — Method in class ModuleGroupSecurityCollection

ModuleGroupSecurityMemberCollection::getIterator() — Method in class ModuleGroupSecurityMemberCollection

ModuleRegistryCollection::getIterator() — Method in class ModuleRegistryCollection

NotificationCollection::getWebserviceParameterObject() — Method in class NotificationCollection

Get generic description of collection for webservice API

NotificationCollection::getIterator() — Method in class NotificationCollection

UserCollection::getSearchQueryConditionGroup() — Method in class UserCollection

UserCollection::getWebserviceParameterObject() — Method in class UserCollection

Get generic description of collection for webservice API

UserCollection::getIterator() — Method in class UserCollection

UserMetaCollection::getIterator() — Method in class UserMetaCollection

$ Model#group — Property in class Model

$ Model#global_config — Property in class Model

AuditPolicy::get_property() — Method in class AuditPolicy

AuditTrail::get_property() — Method in class AuditTrail

AuditTrail::getAuditedProperties() — Method in class AuditTrail

Get keys for properties included in this audit

AuditTrail::generateAuditPropertiesHash() — Method in class AuditTrail

$ DocumentIndex#group_id — Property in class DocumentIndex

DocumentIndex::getDocumentPolicyClusters() — Method in class DocumentIndex

Returns all document policy clusters for this document

DocumentIndex::get_canonical() — Method in class DocumentIndex

DocumentIndex::getCanonicalParent() — Method in class DocumentIndex

Gets the canonical paht of the parent element. Returns null if there is no parent.

DocumentIndex::get_canonical_url() — Method in class DocumentIndex

DocumentIndex::get_recent_documents() — Method in class DocumentIndex

DocumentIndex::get_group_security_id() — Method in class DocumentIndex

Get global group_security_id for this document Uses lib->group_security

DocumentIndex::get_instance_string() — Method in class DocumentIndex

DocumentIndex::get_instance_meta() — Method in class DocumentIndex

Return Meta information for the instance

DocumentIndex::get_canonical_document_index_ids() — Method in class DocumentIndex

Return document index ids representing the canonical of this document The last id will be this document return int[] Array of document_index_ids

DocumentIndex::get_breadcrumb() — Method in class DocumentIndex

Return Breadcrumb showing the primary location of this element

DocumentIndex::get_breadcrumb_links() — Method in class DocumentIndex

DocumentIndex::get_url() — Method in class DocumentIndex

Returns the goto URL for this specific document

DocumentIndex::get_perma_url() — Method in class DocumentIndex

Returns the perma URL (_doc/goto/{uuid}) for this document

DocumentIndex::get_instance_url() — Method in class DocumentIndex

DocumentIndex::get_title() — Method in class DocumentIndex

Get title

DocumentIndex::get_displayname() — Method in class DocumentIndex

Returns the displayname of the user of this document

DocumentIndex::get_related_document() — Method in class DocumentIndex

Get the original document model

DocumentIndex::get_all_related_documents() — Method in class DocumentIndex

Function will set related_model for given document index models to improve loading

DocumentIndex::get_paths() — Method in class DocumentIndex

Return all potential canonical paths element The upper container where this element resides in could be refered

DocumentIndex::get_possible_rights_context() — Method in class DocumentIndex

DocumentIndex::get_instance_obj() — Method in class DocumentIndex

DocumentIndex::get_deleted_related_document() — Method in class DocumentIndex

DocumentIndex::get_document_registry_info() — Method in class DocumentIndex

Return the information from the document registry This information contains additional meta data as well as relational information

DocumentIndex::get_root() — Method in class DocumentIndex

DocumentIndex::get_parent() — Method in class DocumentIndex

Get a parent element

DocumentIndex::get_parent_group() — Method in class DocumentIndex

Get a parent element

DocumentIndex::get_parent_document_index() — Method in class DocumentIndex

Get a parent element

DocumentIndex::getParentCanonicals() — Method in class DocumentIndex

Returns an array with the canonicals of all parents e.g. /3/2/1/ -> ['/3/2/1', '/3/2/', '/3/']

DocumentIndex::get_children_document() — Method in class DocumentIndex

Get child elements

DocumentIndex::get_thumb_url() — Method in class DocumentIndex

Returns an url to the thumb of this document if available

DocumentIndex::get_uuid() — Method in class DocumentIndex

UUID in Hex Presentation, will automatically generate a uuid if not present yet

DocumentIndex::get_uuid_formatted() — Method in class DocumentIndex

Formatted version of uuid

DocumentIndex::getFollows() — Method in class DocumentIndex

Is user a follower ?

DocumentIndex::get_references() — Method in class DocumentIndex

Get all document_index references this document has

DocumentIndex::get_referenced_from() — Method in class DocumentIndex

Get all document_index which are referenced from the current document_index

DocumentIndex::getDocumentIndexReferences() — Method in class DocumentIndex

Get all document_references this document has

DocumentIndex::get_references_from() — Method in class DocumentIndex

Get all document_references which are pointing to this current document_index

DocumentIndex::getMagicDocumentHelper() — Method in class DocumentIndex

Assumes a related document which implements FullyIntegratedInterface

DocumentIndex::getModelCollection() — Method in class DocumentIndex

DocumentIndexJobQueue::getDocumentIndexModel() — Method in class DocumentIndexJobQueue

Returns the related Document Index Entry

DocumentIndexJobQueue::getQueueSizeByStep() — Method in class DocumentIndexJobQueue

Returns the current queue (not in processing state) with counts per processing step

DocumentIndexJobQueueHistory::getStatistics() — Method in class DocumentIndexJobQueueHistory

Calculate some quick statistics

DocumentIndexLock::get_visiting_users() — Method in class DocumentIndexLock

Returns the currently users that watching the document. The users are sorted by the entry creation time (ASC). The first user is the EDIT mode the one that locks the document and all other users queued as viewer.

DocumentIndexLock::getLockingUser() — Method in class DocumentIndexLock

DocumentIndexLock::getTTL() — Method in class DocumentIndexLock

DocumentIndexReference::get_referenced_index_object() — Method in class DocumentIndexReference

Return the document index of the referenced object

DocumentIndexReference::get_document_index_object() — Method in class DocumentIndexReference

Return the document index of the reference

DocumentIndexReference::getModelCollection() — Method in class DocumentIndexReference

DocumentRegistry::get_property_model_name() — Method in class DocumentRegistry

Accessor to avoid conflict of Model->model_name which refers to "document_registry" This function returns the model_name of the related document_model and not of itself... see also (fallback is similar to): Model::get_model_name()

DocumentRegistry::get_property_table_name() — Method in class DocumentRegistry

DocumentRegistry::get_document_relations() — Method in class DocumentRegistry

Return the current relations of this document to other documents and instances

DocumentRegistry::get_instance() — Method in class DocumentRegistry

DocumentRegistry::get_cf() — Method in class DocumentRegistry

Follows::getFollowedDocumentsForUser() — Method in class Follows

Follows::getFollowByDocumentIndexAndUserID() — Method in class Follows

GlobalConfig — Class in namespace XELOS\Framework\XF\System\Model

GlobalConfig::get_config_value() — Method in class GlobalConfig

Group — Class in namespace XELOS\Framework\XF\System\Model

Class Group

Group::get_label_i18n() — Method in class Group

Group::getInheritedGroupIds() — Method in class Group

Returns all inherited group ids for the given $groupIds array including groupIds

Group::get_user_count() — Method in class Group

Counts all users in this group.

Group::getUsers() — Method in class Group

Returns all users in this group as unloaded collection

Group::getModelCollection() — Method in class Group

Return a new unscoped model collection for further processing

Hierarchy::get_users() — Method in class Hierarchy

Get all associated users for this hierarchy node

Hierarchy::get_children() — Method in class Hierarchy

Get all children for this node

Hierarchy::get_parents() — Method in class Hierarchy

Get parents for this node

Hierarchy::get_canonical() — Method in class Hierarchy

Get Canonical Representation of this Node

InstanceConfig::get_config_value() — Method in class InstanceConfig

InstanceRegistry::get_property_model_name() — Method in class InstanceRegistry

Accessor to avoid conflict of Model->model_name which refers to "document_registry" This function returns the model_name of the related document_model and not of itself... see also (fallback is similar to): Model::get_model_name()

InstanceRegistry::get_property_table_name() — Method in class InstanceRegistry

InstanceRegistry::getModelCollection() — Method in class InstanceRegistry

$ ModuleGroupSecurity#group_id — Property in class ModuleGroupSecurity

ModuleGroupSecurity::getDocumentIndex() — Method in class ModuleGroupSecurity

Returns the DocumentIndex object

ModuleGroupSecurity::getModelCollection() — Method in class ModuleGroupSecurity

ModuleGroupSecurityMember::getModelCollection() — Method in class ModuleGroupSecurityMember

ModuleRegistry::get_path() — Method in class ModuleRegistry

Get Path to Module Directory

Notification::getScopedCollection() — Method in class Notification

Get a scoped Modelcollection of Notifications

Notification::getNotificationRegistry() — Method in class Notification

Get information about the registered trigger

Notification::getPriority() — Method in class Notification

Get Priority for this notification based on registry information

Notification::generateReferenceKey() — Method in class Notification

Notification::getMarkAsReadLink() — Method in class Notification

Returns an url to this notification link which marks the notification as read when being opened

Notification::getModelCollection() — Method in class Notification

OnboardingCode::generateUniqueCode() — Method in class OnboardingCode

Generate and set Code

OnboardingCode::generatePIN() — Method in class OnboardingCode

Generate and set PIN

OnboardingCode::getFullOnboardingCode() — Method in class OnboardingCode

Get OnBoarding Code with SERVER, CODE and PIN (if available)

OnboardingCode::getOnboardingDomainCode() — Method in class OnboardingCode

Get OnboardingDomainCode from XELOS Service

Pages::getModelCollection() — Method in class Pages

Policy::getModelCollection() — Method in class Policy

ThemeSet::get_config() — Method in class ThemeSet

Return Config Array

ThemeSet::get_color() — Method in class ThemeSet

Return Config Array

ThemeSet::get_theme_set_folder() — Method in class ThemeSet

ThemeSet::get_theme_data_array() — Method in class ThemeSet

ThemeSet::getCurrentThemeSet() — Method in class ThemeSet

Get current theme set if available and configured

User::get() — Method in class User

User::get_property() — Method in class User

User::get_properties() — Method in class User

Returns the complete properties array

User::get_user_ids_by_security_group() — Method in class User

User::get_fullname() — Method in class User

User::get_user_id() — Method in class User

User::get_short_profile() — Method in class User

Returns an array with a short user profile depending on the installed helpers and modules the source can be e.g. system profile or lookbook

User::get_user_setting() — Method in class User

User::get_user_pic() — Method in class User

User::get_portrait_url() — Method in class User

put your comment there.

User::get_avatar_url() — Method in class User

Returns the URL for the user avatar

User::get_user_groups() — Method in class User

User::get_current_online_status() — Method in class User

Returns the current online status of the current user

User::get_online_status_mapping() — Method in class User

Returns a list of available status types incl. label

User::get_i18n_language() — Method in class User

Return Language like $culture_only false = "EN_GB" $culture_only true = "GB"

User::getModelCollection() — Method in class User

UserDevices::generate_device_id() — Method in class UserDevices

Generates and sets the device_id from the current time, the user id and the user agent.

UserDevices::get_current_device() — Method in class UserDevices

Returns the current device of the logged in user.

UserDevices::generate_auth_token() — Method in class UserDevices

Generates a new device-specific auth token if none exists.

UserLog::get_diff() — Method in class UserLog

UI::get_flash_messages() — Method in class UI

Returns array of flash messages

UI::get_admin_messages() — Method in class UI

Returns array of admin messages

UI::get_flash_message_html() — Method in class UI

Returns a pre-rendered flash message output and clears messages from flash list

UI::get_js_files() — Method in class UI

UI::get_css_files() — Method in class UI

UI::get_css_files_meta() — Method in class UI

UI::get_associated_content() — Method in class UI

Get Associated Content (for SPDY Push)

UI::get_less_variable_files() — Method in class UI

Get LESS variable files

UI::get_js_files_base() — Method in class UI

UI::get_js_files_base_files() — Method in class UI

Get JS Files

UI::get_js_files_meta() — Method in class UI

UI::get_feed_links_meta() — Method in class UI

UI::get_admin_bar() — Method in class UI

UI::get_admin_bar_config() — Method in class UI

Returns all available Adminbar Options as JSON Object

UI::get_js_blocks_raw() — Method in class UI

UI::get_last_js_block() — Method in class UI

Return last JS Block and remove from array

UI::get_js_blocks() — Method in class UI

UI::get_unique_dom_id() — Method in class UI

UI::get_unique_string() — Method in class UI

UI::getClassShortForNs() — Method in class UI

Returns the Classname from a given Namespace.

UI::getCssClassForObject() — Method in class UI

UI::getCssClassForNs() — Method in class UI

Builds a css class for the given Namespace like [vendor]-[module]-[name] e.g.: blueend-ui-carousel

UI::getSecureInlineScriptTag() — Method in class UI

Get Inline Script Tag with CSP Nonce and Subresource Integrity Attribute

UI::getCSPNonce() — Method in class UI

Get the CSP Nonce to secure JS/CSS Blocks https://content-security-policy.com/nonce/

AjaxContainer::get_content() — Method in class AjaxContainer

Returns the content of this container. Calls callback if neccessary

AjaxContainer::get_reload_link() — Method in class AjaxContainer

Returns a link which reloads the container

Amchart::get_chart_pie() — Method in class Amchart

Get PIE Chart

Amchart::get_chart_bar() — Method in class Amchart

Get BAR Chart

Amchart::get_chart_gantt() — Method in class Amchart

Get a gantt chart

Amchart::get_chart_custom() — Method in class Amchart

Amchart::get_chart_map() — Method in class Amchart

AmchartChart::get_chart_definition() — Method in class AmchartChart

Returns a reference to the chart definition passed to the constructor.

AmchartChart::get_unique_dom_id() — Method in class AmchartChart

Returns the unique dom ID for this chart.

Breadcrumb::generate_default_navigation_breadcrumb() — Method in class Breadcrumb

put your comment there.

Calendar::getSelectedDateTimestamp() — Method in class Calendar

Has the date of this component been set via the GPVars? Returns the current selection as timestamp

Calendar::get_current_month() — Method in class Calendar

Get selected month from paging

Container::getPlaceholderContent() — Method in class Container

Place

Country::get_country_id() — Method in class Country

Doclink::getDocumentOptions() — Method in class Doclink

Queries api for document options

DocumentLock::get_locking_user_id() — Method in class DocumentLock

Return the user id of the user that locks the document.

DocumentView::get_doclink_actions() — Method in class DocumentView

Faceted::get_all_active_items() — Method in class Faceted

returns an array of all active items

Faceted::getAllActiveConditions() — Method in class Faceted

Return all active conditions

Faceted::get_current_filter() — Method in class Faceted

Faceted::getCurrentFilter() — Method in class Faceted

Faceted::get_active_value_for_category() — Method in class Faceted

Works only after process()

FacetedFilter::getCollection() — Method in class FacetedFilter

getter

FacetedFilter::getMaxFacetElements() — Method in class FacetedFilter

getter

FacetedFilter::getCategories() — Method in class FacetedFilter

FacetedFilter::getCategory() — Method in class FacetedFilter

FacetedFilter::getActiveValue() — Method in class FacetedFilter

Returns the active value(s) for the $categoryKey

FacetedFilter::getCurrentGPVarsFilter() — Method in class FacetedFilter

Returns the current active filters based on the GPVars (e.g.: ['category' => ['1' => true], 'date' => ['start' => $start, 'end' => $end]])

FacetedFilter::getHasFilter() — Method in class FacetedFilter

Returns if there is an active filter

FacetedLegacy::getModelCollection() — Method in class FacetedLegacy

Returns the model collection

FacetedLegacy::get_all_active_items() — Method in class FacetedLegacy

returns an array of all active items

FacetedLegacy::getAllActiveConditions() — Method in class FacetedLegacy

Return all active conditions

FacetedLegacy::get_current_filter() — Method in class FacetedLegacy

FacetedLegacy::getCurrentFilter() — Method in class FacetedLegacy

Returns the current active filters (e.g.: ['category' => ['1' => true], 'date' => ['start' => $start, 'end' => $end]])

FacetedLegacy::getCurrentFilterAjax() — Method in class FacetedLegacy

FacetedLegacy::get_active_value_for_category() — Method in class FacetedLegacy

Works only after process()

FacetedLegacy::getHasFilter() — Method in class FacetedLegacy

Returns if there is an active filter

FacetedCategory::getDisplayType() — Method in class FacetedCategory

Extended class has to return one of the display types defined via constant in this class!

FacetedCategory::getLabel() — Method in class FacetedCategory

FacetedCategory::getHasMoreItems() — Method in class FacetedCategory

FacetedCategory::getIconClass() — Method in class FacetedCategory

FacetedCategory::getShowInMoreOnly() — Method in class FacetedCategory

Getter for showInMoreOnly

FacetedCategory::getDefaultValues() — Method in class FacetedCategory

getter

FacetedCategory::getOptions() — Method in class FacetedCategory

Returns the options array used mainly by the vue component

FacetedCategory::getActiveItems() — Method in class FacetedCategory

Returns items of this category, which are active

FacetedCategory::getKey() — Method in class FacetedCategory

FacetedCategory::getShowItemCount() — Method in class FacetedCategory

FacetedCategory::getIterator() — Method in class FacetedCategory

FacetedCategory::getItems() — Method in class FacetedCategory

FacetedCategoryChoice::getDisplayType() — Method in class FacetedCategoryChoice

FacetedCategoryChoice::getLabelOptionList() — Method in class FacetedCategoryChoice

FacetedCategoryDate::getDisplayType() — Method in class FacetedCategoryDate

FacetedCategoryDate::getOptions() — Method in class FacetedCategoryDate

FacetedCategoryItem::getLabel() — Method in class FacetedCategoryItem

FacetedCategoryItem::getValue() — Method in class FacetedCategoryItem

FacetedCategoryItem::getCount() — Method in class FacetedCategoryItem

FacetedCategoryItem::getCondition() — Method in class FacetedCategoryItem

FacetedCategoryList::getIterator() — Method in class FacetedCategoryList

FacetedCategoryMultipleChoice::getOptions() — Method in class FacetedCategoryMultipleChoice

FacetedCategoryTextSearch::getDisplayType() — Method in class FacetedCategoryTextSearch

FacetedCategoryTextSearch::getOptions() — Method in class FacetedCategoryTextSearch

FacetedCategoryToggle::getDisplayType() — Method in class FacetedCategoryToggle

FacetedCategoryToggle::getOptions() — Method in class FacetedCategoryToggle

Form::get_curent_process_id_lookup_name() — Method in class Form

Form::get_current_process_id() — Method in class Form

Returns a unique id for the current form processing.

Form::get_mod() — Method in class Form

Form::get_additional_filesources() — Method in class Form

Get all dms instances available for this portlet to use as file-source in form

Form::get_request_var() — Method in class Form

Form::get_field_data() — Method in class Form

Form::get_field_dom_id() — Method in class Form

Returns the ID for the form element, e.g. used in FormDocument.

Form::get_field_value() — Method in class Form

Get the property associated with a specific field

Form::get_field_default_value() — Method in class Form

Form::get_field_object() — Method in class Form

Form::get_field_values() — Method in class Form

Form::getWritableFieldValues() — Method in class Form

Get the properties of all available and writable fields

Form::get_edit_var() — Method in class Form

Form::get_close_form() — Method in class Form

Returns the Form Closing HTML

Form::getAjaxFormCallbacks() — Method in class Form

Callbacks getter method.

Form::get_open_form() — Method in class Form

Form::getLinkFormParams() — Method in class Form

Returns a link array containing the base parameters for this form (xui_form_name, ...) to be identified as this form in the form->process() function

Form::get_buttons_array() — Method in class Form

Get Buttons Array

Form::get_field() — Method in class Form

Form::get_feedback() — Method in class Form

Return the last Feedback Message

Form::getIsAjaxForm() — Method in class Form

Form::getFormActionURL() — Method in class Form

Get current FORM Action URL

Form::getModel() — Method in class Form

Return Model associated with form (if available)

Form::getDocumentModel() — Method in class Form

Return DocumentModel associated with form (if available)

Form::getDocumentIndex() — Method in class Form

Return DocumentIndex associated with form (if available)

FormBase::get() — Method in class FormBase

FormBase::getConfig() — Method in class FormBase

FormBase::get_properties() — Method in class FormBase

FormBase::get_group() — Method in class FormBase

FormChoice::getAdditionalUrlParams() — Method in class FormChoice

FormChoice::getUrl() — Method in class FormChoice

Get URL for Dynamic Choice Queries

FormChoice::getOptionList() — Method in class FormChoice

FormChoice::getOptionListPreset() — Method in class FormChoice

FormChoice::getOptionListProcessor() — Method in class FormChoice

FormChoice::getIsMultiple() — Method in class FormChoice

FormChoice::getNoValue() — Method in class FormChoice

FormChoice::getNoValueIcon() — Method in class FormChoice

FormChoice::getHideDescription() — Method in class FormChoice

FormChoice::getIsCompact() — Method in class FormChoice

FormChoice::getSerializeFormat() — Method in class FormChoice

Get current expected value format

FormComponent::get_validation_options() — Method in class FormComponent

FormComponent::get_description() — Method in class FormComponent

FormComponent::get_value() — Method in class FormComponent

FormComponent::get_display_value() — Method in class FormComponent

returns the displayed value

FormComponent::getLabel() — Method in class FormComponent

Get Field label

FormComponent::getIsVisible() — Method in class FormComponent

Determine visibilty based on user input on dependent fields

FormComponent::getDomSelector() — Method in class FormComponent

Return Dom Selector for this field within the current form (This is NOT necessary unique if you are having 2 forms with identical names in form and field names

FormComponent::getElementVisibilityClass() — Method in class FormComponent

Get Element Visibility Class Formerly known as tag class

FormConfig::get_config_fdl() — Method in class FormConfig

FormContentAttachment::getAllowReordering() — Method in class FormContentAttachment

Returns if images are allowed

FormDocument::getDefault() — Method in class FormDocument

Returns the default value for this component.

FormDocument::getDelimiter() — Method in class FormDocument

Returns the separator of multiple values.

FormDocument::getImageEditSettings() — Method in class FormDocument

Returns the settings for the image edit functionality.

FormDocument::getImagePreviewSize() — Method in class FormDocument

Returns the current image preview size

FormDocument::getImagePreviewResizeWidth() — Method in class FormDocument

Returns the preview image width based on the display mode. This is used to resize images on the server depending on the required frontend size

FormDocument::getImagePreviewResizeHeight() — Method in class FormDocument

Returns the preview image height based on the display mode and cropping. This is used to resize images on the server depending on the required frontend size

FormDocument::getOwnerDocument() — Method in class FormDocument

Returns a document model.

FormDocument::getNoDocumentMessage() — Method in class FormDocument

Returns a message which is displayed when no document is selected.

FormDocument::getNoDocumentIcon() — Method in class FormDocument

Returns an icon to reflect the possible file types

FormDocument::getUploadLabel() — Method in class FormDocument

Returns a custom label name for the upload field.

FormDocument::getNoUpload() — Method in class FormDocument

Returns whether client side upload listener should be attached or not.

FormDocument::getPasteSource() — Method in class FormDocument

Returns a DOM selector which is used to pasting clip board content.

FormDocument::getOnChange() — Method in class FormDocument

Returns a string that contains a js callback function name.

FormDocument::getLocation() — Method in class FormDocument

Returns a relative location path.

FormDocument::getWebDir() — Method in class FormDocument

Returns the storage path where to save files.

FormDocument::getSaveInCascadedFolder() — Method in class FormDocument

This option is used by the replace location with id method.

FormDocument::getSelectorAutoSubmit() — Method in class FormDocument

Returns whether a submit should be triggered after a document selection.

FormDocument::getMinReferenceLevel() — Method in class FormDocument

FormDocument::getDisableLinks() — Method in class FormDocument

Returns if the user is allowed to select links

FormDocument::get_unique_dom_id() — Method in class FormDocument

Get a unique DOM ID Replaces . with _ to prevent possible ambiguous ID's like #form_id.cms_comp

FormDocument::get_tmp_folder() — Method in class FormDocument

FormDocument::get_uploaded_documents() — Method in class FormDocument

FormDocument::get_items() — Method in class FormDocument

FormDocument::getAdditionalUploadParams() — Method in class FormDocument

FormDynConfig::get_config_fdl() — Method in class FormDynConfig

FormFile::getLocation() — Method in class FormFile

Returns a relative location path.

FormFile::getMime() — Method in class FormFile

Returns the supported mime types.

FormFile::getAcceptedExtensions() — Method in class FormFile

Returns the previously set file extensions or system wide if not set

FormFile::getUseSystemDMS() — Method in class FormFile

Returns whether the system dms will be used for storing or not.

FormFile::getWebDir() — Method in class FormFile

Returns the storage path where to save files.

FormFile::getMaxUploadSize() — Method in class FormFile

Returns the maximum upload size.

FormFile::getHideOptions() — Method in class FormFile

Returns whether to display upload options or not.

FormFile::getDownloadHandler() — Method in class FormFile

Returns a download handler.

FormFile::getContentType() — Method in class FormFile

Returns the content type.

FormFile::getUploadCallback() — Method in class FormFile

Returns the upload callback.

FormFile::getMaxWidth() — Method in class FormFile

Returns a maximum width for images.

FormFile::getMaxHeight() — Method in class FormFile

Returns a maximum height for images.

FormFile::getSaveInCascadedFolder() — Method in class FormFile

This option is used by the replace location with id method.

FormGeoSelector::getDocumentIndexId() — Method in class FormGeoSelector

FormGroupSelector::get_selector_link() — Method in class FormGroupSelector

FormHidden::get_display_value_for() — Method in class FormHidden

FormIconSelect::getOptionList() — Method in class FormIconSelect

FormMediaAttachment::getAllowImage() — Method in class FormMediaAttachment

Returns if images are allowed

FormMediaAttachment::getAllowVideo() — Method in class FormMediaAttachment

Returns if videos are allowed

FormMediaAttachment::getImageRoundShape() — Method in class FormMediaAttachment

Returns true if the round image mask is enabled

FormMediaAttachment::getImageAspectRatio() — Method in class FormMediaAttachment

Returns the currently ratio as float value (1.7777 = 16:9)

FormMediaAttachment::getIsMultiple() — Method in class FormMediaAttachment

This function is only preparation for future usage and will currently always return false

FormPolicySelector::get_rights() — Method in class FormPolicySelector

FormPolicySelector::getPolicyUserCounts() — Method in class FormPolicySelector

Returns an array with policies and User counts having this policy

FormStaticText::get_display_value_for() — Method in class FormStaticText

callback function for preg_replace replacing {fieldname} in text value

FormTextarea::getWYSIWYGInserts() — Method in class FormTextarea

FormTextarea::getWYSIWYGCustomInserts() — Method in class FormTextarea

FormTextarea::getDocumentSelector() — Method in class FormTextarea

FormUserSelector::getIsMultiple() — Method in class FormUserSelector

Rather 'complex' getter that checks for the 'multiple' usage of the user selector, taking legacy implementations into account.

FroalaEditorBuilder::getOptions() — Method in class FroalaEditorBuilder

Get Options as JSON Object StringFormat

FroalaEditorBuilder::getToolbarButtons() — Method in class FroalaEditorBuilder

Returns the setup of the toolbar based on the property simpleToolbar which defines the features used by the toolbar. If simpleToolbar is used, this method returns a setup which contains less buttons.

FroalaEditorBuilder::getToolbarButtonsReduced() — Method in class FroalaEditorBuilder

Reduce the amount of visible Toolbar Buttons for smaller versions of the standard toolbar

FroalaInsertGroup::getKey() — Method in class FroalaInsertGroup

FroalaInsertGroup::getLabel() — Method in class FroalaInsertGroup

FroalaInsertGroup::getItems() — Method in class FroalaInsertGroup

FroalaInsertGroup::getIcon() — Method in class FroalaInsertGroup

FroalaOption::getName() — Method in class FroalaOption

FroalaOption::getValue() — Method in class FroalaOption

Option::getKey() — Method in class Option

Option::getTitle() — Method in class Option

Option::getDescription() — Method in class Option

Option::getIconClass() — Method in class Option

Option::getImgURL() — Method in class Option

Option::getIconFgColor() — Method in class Option

Returns the Icon Foreground Color (HEX String)

Option::getIconBgColor() — Method in class Option

Returns the Icon Background Color (HEX String)

Option::getIconShape() — Method in class Option

Returns the Icon Shape

Option::getIsSeparator() — Method in class Option

Option::getIsDisabled() — Method in class Option

OptionList::getOption() — Method in class OptionList

OptionList::getFirstEnabledOption() — Method in class OptionList

Returns the first option of this list, that is enabled (not disabled).

OptionList::getIterator() — Method in class OptionList

OptionListCollectionTrait::getOptionListWithGroupSeparators() — Method in class OptionListCollectionTrait

Html::get_tree() — Method in class Html

Html::get_column_list() — Method in class Html

Sorts the passed items into a multi column list with auto column leveling

HtmlGeneric::getAttribute() — Method in class HtmlGeneric

Get Attribute previously set for this element

Image::generate_full_url() — Method in class Image

Image::generate_absolute_path() — Method in class Image

Image::get_placeholder_image_by_content_type() — Method in class Image

put your comment there.

Image::get_url() — Method in class Image

Image::get_folder_prefix() — Method in class Image

Image::get_label() — Method in class Image

Image::get_alt() — Method in class Image

Image::get_static_url() — Method in class Image

Image::get_appearance_mode() — Method in class Image

Image::get_resize() — Method in class Image

Image::get_crop() — Method in class Image

Image::get_content_type() — Method in class Image

Image::get_height() — Method in class Image

Image::get_width() — Method in class Image

Image::get_disable_replacer() — Method in class Image

Image::get_public_file_link() — Method in class Image

$ Import#group_fields — Property in class Import

Import::get_stepping() — Method in class Import

Import::get_tmp_data() — Method in class Import

get temp data

Item::get_id() — Method in class Item

Item::get_di_id() — Method in class Item

Item::get_name() — Method in class Item

Item::get_info() — Method in class Item

Returns an info text.

Item::get_type() — Method in class Item

Returns the item type

Item::get_document_model() — Method in class Item

Item::get_icon_class() — Method in class Item

Item::get_created_at() — Method in class Item

Item::get_updated_at() — Method in class Item

Item::get_thumbnail_url() — Method in class Item

Item::get_doclink() — Method in class Item

Returns the html block for doclink link

Item::get_source() — Method in class Item

$ Link#GPvars — Property in class Link

MenuList::getRemoteURL() — Method in class MenuList

MenuListItem::getUrl() — Method in class MenuListItem

MenuListItem::getExecJS() — Method in class MenuListItem

MenuListItem::getConfirmDialog() — Method in class MenuListItem

MenuListItem::getModalDialog() — Method in class MenuListItem

MenuOptions::getPriority() — Method in class MenuOptions

ModalDialog::getTitle() — Method in class ModalDialog

ModalDialog::getWidth() — Method in class ModalDialog

ModalDialog::getMaxWidth() — Method in class ModalDialog

ModalDialog::getHeight() — Method in class ModalDialog

ModalDialog::getMaxHeight() — Method in class ModalDialog

ModalDialog::getId() — Method in class ModalDialog

ModalDialog::getXuiTarget() — Method in class ModalDialog

ModalDialog::getTitleIconCssClass() — Method in class ModalDialog

ModalDialog::getYesButtonLabel() — Method in class ModalDialog

ModalDialog::getNoButtonLabel() — Method in class ModalDialog

ModalDialog::getCssClasses() — Method in class ModalDialog

ModalDialog::getFormParameters() — Method in class ModalDialog

Get the form reload parameters.

Options::getLabel() — Method in class Options

Options::getId() — Method in class Options

Options::getClass() — Method in class Options

Options::getIconClass() — Method in class Options

Options::getUrl() — Method in class Options

Options::getTitle() — Method in class Options

Paging::get_records_per_page() — Method in class Paging

Paging::get_last_record_of_page() — Method in class Paging

Paging::get_first_record_of_page() — Method in class Paging

Paging::get_page_count() — Method in class Paging

Paging::get_number_of_current_page() — Method in class Paging

Paging::getCurrentOffset() — Method in class Paging

Calculates and returns the current offset value usable by $modelCollection->limit()

Paging::getLoadPrevious() — Method in class Paging

$ Table#grouping — Property in class Table

$ Table#group_type — Property in class Table

$ Table#GPvars — Property in class Table

Table::getId() — Method in class Table

Returns the table id.

Table::getSelectedIds() — Method in class Table

Returns the selected IDs in a multi action table.

Table::get_table() — Method in class Table

Get HTML Table

Table::get_action() — Method in class Table

Table::get_page_control() — Method in class Table

Return Page Control

Table::getCMDArray() — Method in class Table

Return the current table command which where given encoded via _GET params for this table instance

Table::getTableUid() — Method in class Table

TableEditor::getParam() — Method in class TableEditor

Get a single param value

TableEditor::get_action() — Method in class TableEditor

TableEditor::get_primary_key() — Method in class TableEditor

TableEditor::get_table() — Method in class TableEditor

TableEditor::get_edit_link() — Method in class TableEditor

TableEditor::get_new_link() — Method in class TableEditor

Get new Link (Action)

TableEditor::get_form() — Method in class TableEditor

TableRow::get_field() — Method in class TableRow

TableRow::get_field_attributes() — Method in class TableRow

TableRow::get_row_separator() — Method in class TableRow

TableRow::get_row() — Method in class TableRow

TableActionHandler::getSelectField() — Method in class TableActionHandler

TableActionHandler::getSelectedIds() — Method in class TableActionHandler

Get the selected ids from the table

Tabs::get_tab_links() — Method in class Tabs

TimeLineRow::get_label() — Method in class TimeLineRow

Get the row label

TimeLineRow::get_time_ranges() — Method in class TimeLineRow

Get the time ranges

Translation::getTranslationTemplate() — Method in class Translation

Returns the template for the given $translationResult.

$ Tree#group_field — Property in class Tree

Supply the group field to filter the tree by group

$ Tree#group_id — Property in class Tree

Tree::get_form() — Method in class Tree

Tree::get_current_id() — Method in class Tree

Get currently selected Node ID This works only properly AFTER process()

Tree::get_unique_id() — Method in class Tree

Tree::get_checked_nodes() — Method in class Tree

Tree::get_flat_tree() — Method in class Tree

Tree::getRootPid() — Method in class Tree

Getter for the root id

Tree::get_parents() — Method in class Tree

Tree::get_childs() — Method in class Tree

Tree::get_siblings() — Method in class Tree

Returns an array with all sibling IDs

Tree::get_element() — Method in class Tree

UserImage::getUserId() — Method in class UserImage

UserImage::getHeight() — Method in class UserImage

UserImage::getWidth() — Method in class UserImage

UserLink::get_wrapped_html_link() — Method in class UserLink

creates an userlink html (a) arround given inner html can be used for making a profile image clickable

VCard::getShowOnlineStatus() — Method in class VCard

Returns the previously set showOnlineStatus value, or false if user status is disabled in config

VCard::getShowStatusProperties() — Method in class VCard

VCard::getColumns() — Method in class VCard

VCard::getAdditionalProperties() — Method in class VCard

ViewModeSwitcher::getSelectedViewmode() — Method in class ViewModeSwitcher

Wizard::get_data() — Method in class Wizard

put your comment there.

Wizard::get_model() — Method in class Wizard

put your comment there.

Wizard::get_unique_dom_id() — Method in class Wizard

Generates a unique dom id, dependent on the provided UID, as well as the current context.

$ User#GPvars — Property in class User

User::get_mobile_token() — Method in class User

User::get_page_options() — Method in class User

User::get_accessible_pages() — Method in class User

User::get_filter_where_statement() — Method in class User

Returns a SQL filter to filter by the usergroup of the current user (using fileds filter_allow and filter_deny)

User::get_user_obj() — Method in class User

User::get_user_id_by_email() — Method in class User

returns user_id found through given email address Warning: expects user emails to be unique! only one id is returned

User::get_user_obj_by_email() — Method in class User

returns user_object found through given email address Warning: expects user emails to be unique! only one object is returned

User::get_user_id_by_login() — Method in class User

Return User ID by given login/password

User::get_user_by_login() — Method in class User

Return User ID by given login/password

User::get_user_id() — Method in class User

!Accessor

User::get_session_auth_method() — Method in class User

Get the current Auth Method for this session

User::get() — Method in class User

Save a user setting (Duration: Session Lifetime) return mixed

User::get_setting() — Method in class User

Get a user setting (Duration: User Lifetime) return bool success

User::get_message() — Method in class User

Gets the last user message with the given status

User::get_groups() — Method in class User

User::get_group_class() — Method in class User

Get Group Classes for user

User::get_policy_cluster_centroids() — Method in class User

Loads the Centroid of a given Policy Cluster into cache and returns it

User::get_policy_user_diff() — Method in class User

Loads the Policy User Diff of a given user into cache and returns it

User::get_policy_security_level() — Method in class User

Returns the required minimum security level for the passed policy

User::get_userid_by_email() — Method in class User

User::get_group_tree() — Method in class User

Return the rights/roles/group tree todo This method should not be here, but in usermanagement_hook

User::get_user_ids_by_meta_value() — Method in class User

returns an array of all user_ids matching the given meta-field conditions

User::getMetaPopData() — Method in class User

Fetches the meta data off the database from the selected user, if given. Otherwise the current user will be selected.

User::getTempSecurityGroupId() — Method in class User

User::getUserLimit() — Method in class User

Returns the user limit specified in the XELOS licence

User::getActiveUserCountForLicense() — Method in class User

Get the count of users which are counted as active in terms of the license

$ View#GPvars — Property in class View

View::get_instance() — Method in class View

Returns the reference of the main instance.

View::get_route_params() — Method in class View

View::getTemplateController() — Method in class View

View::get_last_page_url() — Method in class View

Returns the page the user came from (determined by referer, checked for validity)

View::getDefaultPageUrl() — Method in class View

Returns the default page url for the current user

View::get_first_page_of_instance() — Method in class View

View::get_current_module() — Method in class View

Determine currently executed main module

View::get_current_nav_id() — Method in class View

Determine currently viewed nav_id

View::get_current_instance() — Method in class View

Determine currently executed main instance

View::get_current_page() — Method in class View

Determine currently executed Page

View::get_current_cmd() — Method in class View

Determine current commands

View::get_primary_template() — Method in class View

Return the primary template object

ActiveDirectoryAction::getDirectoryUsers() — Method in class ActiveDirectoryAction

Returns all Users available in the configured Active Directory

AzureActiveDirectoryAction::getDirectoryUsers() — Method in class AzureActiveDirectoryAction

Returns all Users available in the configured Active Directory

LdapAction::getDirectoryUsers() — Method in class LdapAction

Returns all Users available in the configured Active Directory

AdSyncController::getDirectoryService() — Method in class AdSyncController

$ AdCache#groups: — Property in class AdCache

stored in MySQL as text

AdSyncNavigation::getIconClass() — Method in class AdSyncNavigation

AdSyncNavigation::getUrlParams() — Method in class AdSyncNavigation

DirectoryServiceInterface::getDirectoryUsers() — Method in class DirectoryServiceInterface

Return all users within directory

DirectoryServiceInterface::getConfigOptions() — Method in class DirectoryServiceInterface

DirectoryServiceInterface::getAttributeMapping() — Method in class DirectoryServiceInterface

DirectoryServiceInterface::getGroupMapping() — Method in class DirectoryServiceInterface

AdCache::get_groups() — Method in class AdCache

DirectoryServiceConfigTrait::getConfigOptions() — Method in class DirectoryServiceConfigTrait

Return Configuration for Service

DirectoryServiceConfigTrait::getAttributeMapping() — Method in class DirectoryServiceConfigTrait

Return Attribute Mapping from module configuration

DirectoryServiceConfigTrait::getGroupMapping() — Method in class DirectoryServiceConfigTrait

Return Group Mapping from module configuration

PasswordAction::getPasswordChangeFdl() — Method in class PasswordAction

Generates the FDL for the password and password repeat fields for a $user

AdministrationController::getUserStatusBadgeProviders() — Method in class AdministrationController

AdministrationController::generateUserMenu() — Method in class AdministrationController

Central helper method for generating the action menus for user accounts.

AdministrationController::getUserDevicesHook() — Method in class AdministrationController

UserAccountUserConfig::generateBadgesForUsers() — Method in class UserAccountUserConfig

UserDevicesUserConfig::getOauth() — Method in class UserDevicesUserConfig

UserDevicesUserConfig::getWebService() — Method in class UserDevicesUserConfig

UserDevicesUserConfig::getPdfCreator() — Method in class UserDevicesUserConfig

UserDevicesUserConfig::getOnboardingUrl() — Method in class UserDevicesUserConfig

UserAdminConfig::getFormName() — Method in class UserAdminConfig

UserAdminConfig::getTitle() — Method in class UserAdminConfig

UserAdminConfig::getIconClass() — Method in class UserAdminConfig

UserAdminConfig::getShowInAdminContext() — Method in class UserAdminConfig

Returns true if this config should be shown in admin mode

UserAdminConfig::getData() — Method in class UserAdminConfig

UserExportBase::getPropertyIdentifier() — Method in class UserExportBase

UserExportBase::getUserExportFields() — Method in class UserExportBase

UserExportBase::getPropertyValues() — Method in class UserExportBase

UserStatusBadgeProviderInterface::generateBadgesForUsers() — Method in class UserStatusBadgeProviderInterface

Badge::getPriority() — Method in class Badge

Badge::getUserId() — Method in class Badge

BadgeList::getIterator() — Method in class BadgeList

ExportPage::get_page() — Method in class ExportPage

HierarchyPage::get_page() — Method in class HierarchyPage

UserGroupsPage::get_page() — Method in class UserGroupsPage

UserPage::get_page() — Method in class UserPage

UserPage::getOnboardingPDFTemplate() — Method in class UserPage

UserSessionsPage::get_page() — Method in class UserSessionsPage

UserList::getAdditionalActionLinksTop() — Method in class UserList

UserList::getAdditionalActionHandlersTop() — Method in class UserList

UserList::getAdditionalActionLinksBottom() — Method in class UserList

UserList::getAdditionalActionHandlersBottom() — Method in class UserList

ApiCloudstorageController::get_providers() — Method in class ApiCloudstorageController

Returns all loaded storage provider.

ApiCloudstorageController::get_provider() — Method in class ApiCloudstorageController

Returns a specific storage provider.

ApiCloudstorageController::get_cloud_content_tree() — Method in class ApiCloudstorageController

Returns an xui_tree that contains the storage content.

UploadDocumentProcessor::get_action() — Method in class UploadDocumentProcessor

Returns action if any cloud service is registered in the cloud service manager.

UploadDocumentProcessor::get_actions() — Method in class UploadDocumentProcessor

put your comment there.

CloudDocumentBrowser::get_document_browser() — Method in class CloudDocumentBrowser

CloudDocumentBrowser::get_name() — Method in class CloudDocumentBrowser

CloudDocumentBrowser::get_thumbnail_url() — Method in class CloudDocumentBrowser

StorageProvider::get_provider_title() — Method in class StorageProvider

Returns the title of the provider storage service.

StorageProvider::get_provider_name() — Method in class StorageProvider

Returns a name identifier of the provider storage service.

StorageProvider::get_icon_class_name() — Method in class StorageProvider

Returns the xelos icon class name which presents the provider storage service.

StorageProvider::get_account_quota_total() — Method in class StorageProvider

Returns size in bytes of total space of the storage.

StorageProvider::get_account_quota_used() — Method in class StorageProvider

Returns size in bytes of used space of the storage.

StorageProvider::get_content() — Method in class StorageProvider

Returns an instance of StorageContent that contains all files requested by the given path which is provider specific

StorageProvider::get_account_quota_free() — Method in class StorageProvider

Returns the account free storage quota in bytes.

StorageProvider::get_account_quota_used_percent() — Method in class StorageProvider

Returns the account used storage quota in percent.

StorageContent::get_folders() — Method in class StorageContent

StorageContent::get_files() — Method in class StorageContent

ApiCloudstorageDocumentBrowser::get_items() — Method in class ApiCloudstorageDocumentBrowser

ApiCloudstorageDocumentBrowser::get_title() — Method in class ApiCloudstorageDocumentBrowser

Returns a title for this browser.

ApiMicrosoftController::getGraphClient() — Method in class ApiMicrosoftController

ApiMicrosoftController::getApplicationClient() — Method in class ApiMicrosoftController

OnedriveBusinessStorageProvider::get_provider_title() — Method in class OnedriveBusinessStorageProvider

Returns the title of the provider storage service.

OnedriveBusinessStorageProvider::get_provider_name() — Method in class OnedriveBusinessStorageProvider

Returns a name identifier of the provider storage service.

$ OnedriveStorageProvider#graph — Property in class OnedriveStorageProvider

OnedriveStorageProvider::get_provider_title() — Method in class OnedriveStorageProvider

Returns the title of the provider storage service.

OnedriveStorageProvider::get_provider_name() — Method in class OnedriveStorageProvider

Returns a name identifier of the provider storage service.

OnedriveStorageProvider::get_icon_class_name() — Method in class OnedriveStorageProvider

Returns the xelos icon class name which presents the provider storage service.

OnedriveStorageProvider::get_account_quota_total() — Method in class OnedriveStorageProvider

Returns size in bytes of total space of the storage.

OnedriveStorageProvider::get_account_quota_used() — Method in class OnedriveStorageProvider

Returns size in bytes of used space of the storage.

OnedriveStorageProvider::get_content() — Method in class OnedriveStorageProvider

Returns an instance of StorageContent that contains all files requested by the given path which is provider specific

OutlookPersonalCalenderGetEvents::get_calendars() — Method in class OutlookPersonalCalenderGetEvents

OutlookPersonalCalenderGetEvents::get_event_by_id() — Method in class OutlookPersonalCalenderGetEvents

Fetches the event from the /me/events/{id} endpoint.

OutlookPersonalCalenderGetEvents::get_events() — Method in class OutlookPersonalCalenderGetEvents

Fetches the events for the selected timeframe. Caches the retrieved events for 5 minutes.

ApiMicrosoftNavigation::getIconClass() — Method in class ApiMicrosoftNavigation

ApiMicrosoftNavigation::getUrlParams() — Method in class ApiMicrosoftNavigation

CoAuthorDocumentProcessor::get_action() — Method in class CoAuthorDocumentProcessor

Returns action if any cloud service is registered in the cloud service manager.

PresenceUserLinks::get_link_info() — Method in class PresenceUserLinks

Returns an array that contains the link id as key and link data array as value.

PresenceUserLinks::get_link_data() — Method in class PresenceUserLinks

Returns an array contains the link parameters as array.

OutlookInboxShowPortlet::get_fdl() — Method in class OutlookInboxShowPortlet

If the portlet offers options please supply fdl for options

OutlookInboxShowPortlet::get_html() — Method in class OutlookInboxShowPortlet

SearchMessagesSearchIntegration::getDocumentsBySearch() — Method in class SearchMessagesSearchIntegration

Search for "Documents"

SearchMessagesSearchIntegration::getDocumentCountBySearch() — Method in class SearchMessagesSearchIntegration

Gets the maximum available hits count for this search-term

SearchMessagesSearchIntegration::getMinLength() — Method in class SearchMessagesSearchIntegration

Returns the min length of a single search word

SearchMessagesSearchIntegration::getTabTitle() — Method in class SearchMessagesSearchIntegration

SearchMessagesSearchIntegration::getFacetedFilters() — Method in class SearchMessagesSearchIntegration

Return facets for the search sidebar.

AzureAuthentication::getConfigurationFDL() — Method in class AzureAuthentication

MicrosoftOauthClient::getOAuthClient() — Method in class MicrosoftOauthClient

Return OAuthClient to Webservices

OnedriveOauthClient::getOAuthClient() — Method in class OnedriveOauthClient

OpenidAuthentication::getConfigurationFDL() — Method in class OpenidAuthentication

OpenidAuthentication::getOAuthInfo() — Method in class OpenidAuthentication

OpenidAuthentication::getUserInfo() — Method in class OpenidAuthentication

OpenidOauthClient::getOAuthClient() — Method in class OpenidOauthClient

Return OAuthClient to Webservices

AuthSamlController::get_saml_auth() — Method in class AuthSamlController

AuthSamlController::get_saml_auth_settings() — Method in class AuthSamlController

SamlAuthentication::getConfigurationFDL() — Method in class SamlAuthentication

$ Calendar#group_id — Property in class Calendar

$ Calendarset#group_id — Property in class Calendarset

AgendaPortlet::get_title() — Method in class AgendaPortlet

AgendaPortlet::get_fdl() — Method in class AgendaPortlet

$ Component#group_id — Property in class Component

$ ComponentLive#group_id — Property in class ComponentLive

$ History#group_id — Property in class History

$ HistoryComponent#group_id — Property in class HistoryComponent

$ HistoryPage#group_id — Property in class HistoryPage

$ Page#group_id — Property in class Page

$ PageLive#group_id — Property in class PageLive

$ Partial#group_id — Property in class Partial

$ PartialLive#group_id — Property in class PartialLive

ParserAction::get_link() — Method in class ParserAction

Get link from text when there is a link inside

CommentCollection::getWebserviceParameterObject() — Method in class CommentCollection

Get generic description of collection for webservice API

CommentCollection::getIterator() — Method in class CommentCollection

CommentsController::getCommentsStreamTag() — Method in class CommentsController

CommentsController::getCommentsInstanceForDocumentIndex() — Method in class CommentsController

Return the comment template with correct context for a document index

CommentsController::get_comment_count() — Method in class CommentsController

CommentsController::get_comments() — Method in class CommentsController

Returns all comments for the current post

CommentsController::guessGroupId() — Method in class CommentsController

Guess the group ID by evaluating GP and CMD Vars

CommentsController::get_current_document_index() — Method in class CommentsController

$ Comment#group_id — Property in class Comment

Comment::get_comment_model() — Method in class Comment

Returns all comment models

Comment::get_previous_comments() — Method in class Comment

Returns a collection of previous comments

Comment::get_next_comments() — Method in class Comment

Returns a collection of previous comments

Comment::get_link_info() — Method in class Comment

Get Link Info

Comment::get_comment_formatted() — Method in class Comment

Returns the links formatted as HTML incl. all kinds of parsing

Comment::get_user_displayname() — Method in class Comment

Comment::get_user_picture_url() — Method in class Comment

Comment::get_friendly_created_at() — Method in class Comment

returns friendly formatted created at string

Comment::get_attachments_ids() — Method in class Comment

Comment::get_render_attachments() — Method in class Comment

Comment::get_legacy_attachments() — Method in class Comment

Return parsed legacy document indexes as array. Used in template

Comment::get_attachment_dis() — Method in class Comment

Returns all attachment as document index objects

Comment::get_title() — Method in class Comment

Return a title representing the comment without HTML/Markdown

Comment::getModelCollection() — Method in class Comment

LinkInfo::get_secure_url() — Method in class LinkInfo

Returns the URL incl. redirect if enabled on system

LinkInfo::get_is_url_external() — Method in class LinkInfo

Returns true if the link url is an external URL (not on current XELOS host)

LinkInfo::get_image_url() — Method in class LinkInfo

LinkInfo::get_full_image_url() — Method in class LinkInfo

Comment::get_title() — Method in class Comment

Comment::get_description() — Method in class Comment

Comment::get_full_preview() — Method in class Comment

Comment::getCard() — Method in class Comment

This function may be overridden by other document classes.

CrmSync::getContactProperties() — Method in class CrmSync

This function should return all available properties of the source, which are meant to be available for synchronisation The keys should not change afterwards, as they will be used for mapping and identification

CrmSync::getNewContacts() — Method in class CrmSync

This function should return reference keys for contacts which have been created in source since the last sync The CRM will call getContactPropertyValues() for the given contacts to retrieve the data

CrmSync::getContactPropertyValues() — Method in class CrmSync

Return the properties of the specified contact

CrmSync::getContactIsDeleted() — Method in class CrmSync

This function should return true, when the referenced contact has been deleted in source The function will be called before getContactPropertyValues and as a result may delete the crm contact

CrmSync::get_sync_fields() — Method in class CrmSync

Get all Fields available for Synchronisation

CrmSync::get_field_values() — Method in class CrmSync

Returns Values of specified Fields after sync time

CrmDocumentBrowser::get_items() — Method in class CrmDocumentBrowser

CrmDocumentBrowser::get_title() — Method in class CrmDocumentBrowser

Returns a title for this browser.

DMSController::get_view() — Method in class DMSController

DMSController::get_vars() — Method in class DMSController

DMSController::get_my_documents_folder() — Method in class DMSController

Returns the personal workspace folder for the current user

DMSController::getCommandsForPage() — Method in class DMSController

Needs to be done this way, since methods from traits won't be inherited and therefor not be called right here.

DMSNavigation::getIconClass() — Method in class DMSNavigation

DMSNavigation::getUrlParams() — Method in class DMSNavigation

GroupsTemplateInit — Class in namespace XELOS\Modules\DMS\Hook\Groups

FilesPortlet::get_title() — Method in class FilesPortlet

FilesPortlet::get_fdl() — Method in class FilesPortlet

If the portlet offers options please supply fdl for options

FilesPortlet::get_html() — Method in class FilesPortlet

ChannelCollection::getIterator() — Method in class ChannelCollection

ChannelSourceDocumentCollection::getIterator() — Method in class ChannelSourceDocumentCollection

ChannelSubscriptionCollection::getIterator() — Method in class ChannelSubscriptionCollection

DocviewProcessor::get_action() — Method in class DocviewProcessor

Returns action if any cloud service is registered in the cloud service manager.

ChannelFollowsShowPortlet::get_title() — Method in class ChannelFollowsShowPortlet

Get the title

ChannelFollowsShowPortlet::get_fdl() — Method in class ChannelFollowsShowPortlet

Form definition language

ChannelFollowsShowPortlet::get_html() — Method in class ChannelFollowsShowPortlet

Get HTML

FollowedDocumentsShowPortlet::get_title() — Method in class FollowedDocumentsShowPortlet

FollowedDocumentsShowPortlet::get_fdl() — Method in class FollowedDocumentsShowPortlet

Get Config from this portlet

FollowedDocumentsShowPortlet::get_html() — Method in class FollowedDocumentsShowPortlet

SearchMetaData::getFields() — Method in class SearchMetaData

SearchMetaData::getLabelForValue() — Method in class SearchMetaData

DocumentActivityCollector::getDimensions() — Method in class DocumentActivityCollector

Return the available data dimensions for this collector

DocumentActivityCollector::getAggregatedDataForDimension() — Method in class DocumentActivityCollector

Return the data for each dimension, if you cannot provide data for the requested time or aggregation level

DocumentViewsCollector::getDimensions() — Method in class DocumentViewsCollector

Return the available data dimensions for this collector

DocumentViewsCollector::getAggregatedDataForDimension() — Method in class DocumentViewsCollector

Return the data for each dimension, if you cannot provide data for the requested time or aggregation level

GroupActivityCollector — Class in namespace XELOS\Modules\Doclink\Hook\SystemStats

GroupActivityCollector::getDimensions() — Method in class GroupActivityCollector

Return the available data dimensions for this collector

GroupActivityCollector::getAggregatedDataForDimension() — Method in class GroupActivityCollector

Return the data for each dimension, if you cannot provide data for the requested time or aggregation level

SocialActivityCollector::getDimensions() — Method in class SocialActivityCollector

Return the available data dimensions for this collector

SocialActivityCollector::getAggregatedDataForDimension() — Method in class SocialActivityCollector

Return the data for each dimension, if you cannot provide data for the requested time or aggregation level

PostAction::get_related_table() — Method in class PostAction

PostAction::get_gantt_chart() — Method in class PostAction

RegistrationAction::get_event_questions_form() — Method in class RegistrationAction

RegistrationAction::get_event_questions_answers() — Method in class RegistrationAction

Returns the answers for the event questions

CategoryCollection::getIterator() — Method in class CategoryCollection

EventCollection::getIterator() — Method in class EventCollection

$ CategoryDocumentation#group_id — Property in class CategoryDocumentation

$ EventDocumentation#group_id — Property in class EventDocumentation

EventplannerController::get_event_details() — Method in class EventplannerController

builds array with event details (cached per script call)

EventplannerController::generate_button_links() — Method in class EventplannerController

EventplannerController::get_event_list() — Method in class EventplannerController

returns the event list

EventplannerController::get_category_id() — Method in class EventplannerController

EventplannerController::guessGroupId() — Method in class EventplannerController

EventplannerController::get_additional_fields() — Method in class EventplannerController

It is possible to define additional fields in the config:

• e.g. display the company from the lookbook it is a system user. Either the property title or the property shortname can be used.

EventplannerController::get_additional_field_value() — Method in class EventplannerController

Returns the value of an additional field.

EventplannerController::get_tabs() — Method in class EventplannerController

EventplannerController::get_tos_url() — Method in class EventplannerController

EventplannerController::get_option_links() — Method in class EventplannerController

EventplannerController::getEventMapHTML() — Method in class EventplannerController

Displays the event location on the Google Maps portlet from the CMS.

EventplannerController::getCommandsForPage() — Method in class EventplannerController

EventplannerController::getAllowExternalUsers() — Method in class EventplannerController

CalendarLinkGetEvents::get_events() — Method in class CalendarLinkGetEvents

Returns an object collection of event items

CalendarLinkGetEvents::get_calendars() — Method in class CalendarLinkGetEvents

Returns an array of all available calendars

EventManagementNavigation::getIconClass() — Method in class EventManagementNavigation

EventManagementNavigation::getUrlParams() — Method in class EventManagementNavigation

AgendaPortlet::get_title() — Method in class AgendaPortlet

AgendaPortlet::get_fdl() — Method in class AgendaPortlet

AgendaPortlet::get_html() — Method in class AgendaPortlet

EventplannerUpcomingShowPortlet::getPagesMigrationStatus() — Method in class EventplannerUpcomingShowPortlet

EventplannerUpcomingShowPortlet::getPagesMigrationComponent() — Method in class EventplannerUpcomingShowPortlet

EventplannerUpcomingShowPortlet::getPagesMigrationHelpText() — Method in class EventplannerUpcomingShowPortlet

EventplannerUpcomingShowPortlet::get_fdl() — Method in class EventplannerUpcomingShowPortlet

PayloadParticipantPayload::get_placeholders() — Method in class PayloadParticipantPayload

ProcessParticipantAction::get_fdl() — Method in class ProcessParticipantAction

ProcessParticipantAction::get_user_interface() — Method in class ProcessParticipantAction

Category::getModelCollection() — Method in class Category

Event::get_is_expired() — Method in class Event

True if the event has ended.

Event::get_is_deadline_passed() — Method in class Event

True if the deadline has passed.

Event::get_domain() — Method in class Event

Returns the XELOS Host URL.

Event::get_attachment2_label() — Method in class Event

Event::get_attachment3_label() — Method in class Event

Event::get_attachment1_url() — Method in class Event

Preview / Teaser Image

Event::get_attachment2_link() — Method in class Event

Event::get_attachment3_link() — Method in class Event

Event::get_description_limited() — Method in class Event

Event::get_start_formated() — Method in class Event

Event::get_end_formated() — Method in class Event

Event::get_user_status() — Method in class Event

Event::get_custom_id() — Method in class Event

Event::get_current_participant_count() — Method in class Event

Event::get_participating_participant_count() — Method in class Event

Event::get_vcal_attachment() — Method in class Event

Event::getAttachmentPreviews() — Method in class Event

Returns document previews for the attachments with the given label.

Event::getCarouselImages() — Method in class Event

Returns attachments2 and attachment3 if they are images.

Event::getInternalInfoHTML() — Method in class Event

Event::getModelCollection() — Method in class Event

Participant::get_event() — Method in class Participant

Participant::get_user() — Method in class Participant

Participant::get_displayname() — Method in class Participant

Participant::get_displayname_without_email() — Method in class Participant

Participant::get_custom_id() — Method in class Participant

Participant::getMailParams() — Method in class Participant

DetailPage::get_page() — Method in class DetailPage

Default get_page method

EventActionPage::get_page() — Method in class EventActionPage

Default get_page method

PostPage::get_page() — Method in class PostPage

Standard Get Page Controller

SetupPage::get_configuration_steps() — Method in class SetupPage

checks several points for being configured and returns an array with the checks and their results

SetupPage::get_setup_step() — Method in class SetupPage

Details::getParticipant() — Method in class Details

Event::getDocumentThumbnail() — Method in class Event

Return Document Video Thumbnail URL

Event::get_description() — Method in class Event

Return Document Description

Event::get_full_preview() — Method in class Event

Full Preview for Doclink Viewer

ModerateAction::getModeratableElements() — Method in class ModerateAction

Skims all ids of given post ids, where the current user has no can moderate rights on parent thread(s).

ModerateAction::getWritableParentsBySearchterm() — Method in class ModerateAction

Returns writable parent elements for $type(post||thread) filtered by $searchQuery and exluding $excludeIds

CategoryCollection::getReadableSubCategoryCollection() — Method in class CategoryCollection

Get CategoryCollection for given parent Category filter for current user

CategoryCollection::getIterator() — Method in class CategoryCollection

PostCollection::getWebserviceParameterObject() — Method in class PostCollection

Get generic description of collection for webservice API

ThreadCollection::getWebserviceParameterObject() — Method in class ThreadCollection

Get generic description of collection for webservice API

ThreadCollection::getIterator() — Method in class ThreadCollection

$ CategoryDocumentation#group_id — Property in class CategoryDocumentation

$ PostDocumentation#group_id — Property in class PostDocumentation

$ ThreadDocumentation#group_id — Property in class ThreadDocumentation

ForumController::get_breadcrumb() — Method in class ForumController

ForumController::get_dyn_tree() — Method in class ForumController

ForumController::guessGroupId() — Method in class ForumController

Guess the group ID by evaluating GP and CMD Vars

ForumController::getCommandsForPage() — Method in class ForumController

Returns mixed suggestions, containing both categories and threads as result.

ForumController::getForumInstanceForDocumentIndex() — Method in class ForumController

Return the forum instance with correct context for a document_index

ForumController::getThreads() — Method in class ForumController

Returns a thread collection, that may be scoped to the parent document.

ForumController::getPosts() — Method in class ForumController

Returns a post collection, that may be scoped to the parent document.

GroupsTemplateInit — Class in namespace XELOS\Modules\Forum\Hook\Groups

RecentShowPortlet::get_fdl() — Method in class RecentShowPortlet

RecentShowPortlet::get_html() — Method in class RecentShowPortlet

RecentShowPortlet::getPagesMigrationStatus() — Method in class RecentShowPortlet

RecentShowPortlet::getPagesMigrationComponent() — Method in class RecentShowPortlet

RecentShowPortlet::getPagesMigrationHelpText() — Method in class RecentShowPortlet

CreateThreadAction::get_fdl() — Method in class CreateThreadAction

ThreadPayload::get_fdl() — Method in class ThreadPayload

Get FDL for states

ThreadPayload::get_placeholders() — Method in class ThreadPayload

Get all placeholders with payload property values: It's required that the identifier of the form is the same as the payload identifier.

UpdateThreadAction::get_fdl() — Method in class UpdateThreadAction

Category::get_is_empty() — Method in class Category

Primarily is called via the template.

Category::get_type_label() — Method in class Category

Category::get_type_info() — Method in class Category

Category::getContextMenuList() — Method in class Category

Category::get_parent() — Method in class Category

Category::getParentId() — Method in class Category

Returns the parent id

Category::get_category_dyn_tree() — Method in class Category

Category::get_user_id() — Method in class Category

Category::get_sub_categories() — Method in class Category

Get Accessible Sub Categories

Category::get_threads() — Method in class Category

Get Threads in this category

Category::get_recent_threads() — Method in class Category

Category::getExpires() — Method in class Category

Category::getExpiresAt() — Method in class Category

Category::getExpiryDescription() — Method in class Category

Category::getModelCollection() — Method in class Category

MovableInterface::getParentId() — Method in class MovableInterface

Returns the parent id of the element

Post::getParentId() — Method in class Post

Returns the parent id, which is the thread_id

Post::get_parent() — Method in class Post

Post::get_user_id() — Method in class Post

Post::get_category_id() — Method in class Post

Post::get_reply_link() — Method in class Post

Post::getLegacyAttachments() — Method in class Post

Return paths to

Post::getModelCollection() — Method in class Post

Thread::get_tags() — Method in class Thread

Thread::get_content_html() — Method in class Thread

Thread::getCollectionByQuery() — Method in class Thread

Thread::getReplyLink() — Method in class Thread

Thread::getContextMenuList() — Method in class Thread

Thread::getParentId() — Method in class Thread

Returns the parent id, which is the category_id

Thread::get_parent() — Method in class Thread

Thread::get_type() — Method in class Thread

Thread::get_recent_posts() — Method in class Thread

Thread::get_posts() — Method in class Thread

Get Threads in this category

Thread::get_post_count() — Method in class Thread

Number of posts in this thread

Thread::get_state() — Method in class Thread

state should be required, but some models didn't save the state-field proper => default Fallback: state = open

Thread::get_user_id() — Method in class Thread

Wrapper for standard model logic where user_id is the author, created_by is a historical naming not used anymore

Thread::get_thread_icon() — Method in class Thread

Thread icon is mainly dependent on category, this function will return icon based on category type

Thread::getLegacyAttachments() — Method in class Thread

Attachments in thread are serialized, but cannot contain old paths (due to X9 db change this is very unlikely)

Thread::getModelCollection() — Method in class Thread

Votes::getAllVoteValues() — Method in class Votes

EditPage::get_page() — Method in class EditPage

EditPage::getPostFormForThread() — Method in class EditPage

SetupPage::get_configuration_steps() — Method in class SetupPage

checks several points for being configured and returns an array with the checks and their results

SetupPage::get_setup_step() — Method in class SetupPage

ShowPage::get_page() — Method in class ShowPage

ThreadPreview::get_title() — Method in class ThreadPreview

ThreadPreview::get_description() — Method in class ThreadPreview

ThreadPreview::get_image() — Method in class ThreadPreview

ThreadPreview::get_full_preview() — Method in class ThreadPreview

Render a preview of the thread

ThreadPreview::getCardCompact() — Method in class ThreadPreview

This function may be overridden by other document classes.

VoteBox::get_vote_value() — Method in class VoteBox

GeoIpTest — Class in namespace XELOS\Modules\GeoDb\Tests\Codeception\Unit

LocationCollection::getIterator() — Method in class LocationCollection

GeodbController — Class in namespace XELOS\Modules\Geodb

GeodbController::get_country_from_ip() — Method in class GeodbController

GeodbController::getGeoFeatureFromAdress() — Method in class GeodbController

GeodbController::getLocationsForDocumentIndexes() — Method in class GeodbController

Get Locations if available for a given DocumentIndex Collection Supports loaded and unloaded collections

GeodbController::getGeoSelectorProcessor() — Method in class GeodbController

Use the Selector Process to lookup adress manually or get an OptionList to be passend on in FormChoice

GeodbController::getMapLocationUI() — Method in class GeodbController

GET UI for a map showing locations based on given DocumentIndexCollection

GeodbController::getDocumentIndexesForLocation() — Method in class GeodbController

Get Documents matching a certain area - Concept Version!

GeoIpAuthentication — Class in namespace XELOS\Modules\Geodb\Hook\System

GeoIpAuthentication::getConfigurationFDL() — Method in class GeoIpAuthentication

GeoFeature — Class in namespace XELOS\Modules\Geodb\Lib

$ GeoFeature#geoHash — Property in class GeoFeature

GeoFeature::getTitle() — Method in class GeoFeature

Constructs a presentable title in case the 'name' property is not available.

GeoSelectorProcessor — Class in namespace XELOS\Modules\Geodb\Lib

GeoSelectorProcessor::getGeoFeatures() — Method in class GeoSelectorProcessor

$ Location#geohash — Property in class Location

Location::get_specifications() — Method in class Location

Magic getter method that directly decodes the serialized GeoFeature object on invocation.

Location::getModelCollection() — Method in class Location

MapLocation::getInitialZoom() — Method in class MapLocation

RecurringTaskCollection::get_model() — Method in class RecurringTaskCollection

RecurringTaskCollection::getIterator() — Method in class RecurringTaskCollection

TaskCollection::getIterator() — Method in class TaskCollection

TaskListCollection::getOptionListWithSeparators() — Method in class TaskListCollection

Return Optionlist with folders as separators

TaskListCollection::getIterator() — Method in class TaskListCollection

GroupsTasksControllerDocumentation — Class in namespace XELOS\Modules\GroupsTasks\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ TaskDocumentation#group_id — Property in class TaskDocumentation

GroupsTasksController — Class in namespace XELOS\Modules\GroupsTasks

GroupsTasksController::get_view() — Method in class GroupsTasksController

GroupsTasksController::get_vars() — Method in class GroupsTasksController

Get Vars Model

GroupsTasksController::getCommandsForPage() — Method in class GroupsTasksController

CalendarLinkGetEvents::get_calendars() — Method in class CalendarLinkGetEvents

Returns an array of all available calendars

GroupsTemplateInit — Class in namespace XELOS\Modules\GroupsTasks\Hook\Groups

Task::get_checkbox_link() — Method in class Task

Generate an Ajax Clickable Checkbox Link (GROUPS-TASKS)

TaskList::get_readable_lists() — Method in class TaskList

Return lists the user has access to In Groups Mode all lists are accessible if the user has access to main page

GroupCollection — Class in namespace XELOS\Modules\Groups\Collection

GroupCollection::getWebserviceParameterObject() — Method in class GroupCollection

Get generic description of collection for webservice API

GroupCollection::getIterator() — Method in class GroupCollection

MemberCollection::getIterator() — Method in class MemberCollection

$ Model#group — Property in class Model

$ Model#group_navigation — Property in class Model

Model::group() — Method in class Model

Model::group_navigation() — Method in class Model

$ Ui#grouplist — Property in class Ui

$ Category#group_id — Property in class Category

Group — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model group.

$ Group#group_id — Property in class Group

$ Invitation#group_id — Property in class Invitation

$ Member#group_id — Property in class Member

$ Module#group_id — Property in class Module

$ Newsletter#group_id — Property in class Newsletter

$ Pending#group_id — Property in class Pending

GroupsPortlet — Class in namespace XELOS\Modules\Groups\Hook\Pages

GroupsPortlet::get_fdl() — Method in class GroupsPortlet

GroupsPortlet::get_html() — Method in class GroupsPortlet

GroupDocumentUpdateDocumentIndexEvent — Class in namespace XELOS\Modules\Groups\Hook\System

GroupsExtension — Class in namespace XELOS\Modules\Groups\Hooks\Lookbook

Class FollowersExtension

GroupsExtension::get_properties() — Method in class GroupsExtension

GroupsExtension::getExtensionConfigFields() — Method in class GroupsExtension

Creates config fields for every property extension/hook type.

GroupUserContentJob — Class in namespace XELOS\Modules\Groups\Infrastructure\Job

GroupsDocumentBrowser — Class in namespace XELOS\Modules\Groups\Selector

Class GroupsDocumentBrowser

GroupsDocumentBrowser::get_items() — Method in class GroupsDocumentBrowser

GroupsDocumentBrowser::get_title() — Method in class GroupsDocumentBrowser

Returns a title for this browser.

LeaveApplicationCollection::getWebserviceParameterObject() — Method in class LeaveApplicationCollection

Get generic description of collection for webservice API

LeaveApplicationCollection::getIterator() — Method in class LeaveApplicationCollection

TravelCollection::getIterator() — Method in class TravelCollection

JobScheduler::generateJobIdToken() — Method in class JobScheduler

JobScheduler::getScheduledTimeValue() — Method in class JobScheduler

JobScheduler::getQueueableJob() — Method in class JobScheduler

JobStatus::getStatus() — Method in class JobStatus

JobStatus::getStatusMessage() — Method in class JobStatus

JobStatus::getProgress() — Method in class JobStatus

JobStatus::getErrorMessage() — Method in class JobStatus

TestJob::getReferenceId() — Method in class TestJob

JobQueueController::getJobByUniqueId() — Method in class JobQueueController

Get a job by unique id, will return all active jobs even when already in progress

JobQueueController::getStatusByUniqueId() — Method in class JobQueueController

Retrieve Status for Job by Unique ID

Job::getWaitingJobCount() — Method in class Job

Job::getVerboseStatus() — Method in class Job

Get the verbose message of current JobStatus

Job::getOwnerUIDPrefix() — Method in class Job

Returns a unique Owner UID which is being used to identify jobs being processed by a specific thread / server node

Job::getScheduledAt() — Method in class Job

JobHistory::getQueueStatistics() — Method in class JobHistory

SystemDaemon::getRequiredThreadCount() — Method in class SystemDaemon

Calculate the number of threads we should currently use. If we have no open jobs we reduce the number of running threads to reduce system load. We scale threads dynamic to match workload.

LegalController::getImprintLink() — Method in class LegalController

Returns the Link incl. Label to the Imprint Page

LegalController::getAccessibilityDeclarationLink() — Method in class LegalController

LegalController::getCmsPageName() — Method in class LegalController

Fetches the CMS page's name from the config and sanitizes it.

LegalController::getFileLink() — Method in class LegalController

Function to receive the (public) link to the disclaimer's attachment.

Page::getPage() — Method in class Page

There's only one disclaimer.

AdminPage::get_page() — Method in class AdminPage

FormprocessorAction::get_data_by_field_id() — Method in class FormprocessorAction

Get Formdata by field ID

FormprocessorEmailAction::getList() — Method in class FormprocessorEmailAction

FormprocessorEmailAction::get_attachments() — Method in class FormprocessorEmailAction

Get attachments

FormprocessorEmailAction::get_html() — Method in class FormprocessorEmailAction

Get rendered HTML email

ListProperties::get_views() — Method in class ListProperties

Returns an array of name=>title pairs of all views that are available for the current document.

ListProperties::get_view() — Method in class ListProperties

Returns a specific view for the given document

ListProperties::get_draft_view() — Method in class ListProperties

Returns a view for editing the document before it is finally created.

ListProperties::get_icon_class() — Method in class ListProperties

Returns the css icon class.

ListItemCollection::getIterator() — Method in class ListItemCollection

$ CategoryDocumentation#group_id — Property in class CategoryDocumentation

$ ListDocumentation#group_id — Property in class ListDocumentation

$ ListItemDocumentation#group_id — Property in class ListItemDocumentation

$ ListStatusDocumentation#group_id — Property in class ListStatusDocumentation

Field::getHTMLLabel() — Method in class Field

Returns the label needed for the HTML generated email.

Field::getHTMLValue() — Method in class Field

Returns the value needed for the HTML generated mail.

Field::getAnswersWithCounts() — Method in class Field

Helper method for pre-fetching the faceted filter items count, which ends up being more performant than letting the faceted filters calculate each item count in its own.

Field::getFacetedField() — Method in class Field

Gets a field from the faceted search.

CategorySelector::getHTMLValue() — Method in class CategorySelector

Returns the value needed for the HTML generated mail.

Checkbox::getHTMLValue() — Method in class Checkbox

Returns the value needed for the HTML generated mail.

Date::getHTMLValue() — Method in class Date

Returns the value needed for the HTML generated mail.

Datetime::getHTMLValue() — Method in class Datetime

Returns the value needed for the HTML generated mail.

Document::getHTMLValue() — Method in class Document

Returns the value needed for the HTML generated mail.

Fieldset::getHTMLValue() — Method in class Fieldset

Returns the value needed for the HTML generated mail.

ListStatus::getFacetedField() — Method in class ListStatus

Gets a field from the faceted search.

Multitext::getHTMLValue() — Method in class Multitext

Returns the value needed for the HTML generated mail.

Radio::getHTMLValue() — Method in class Radio

Returns the value needed for the HTML generated mail.

SectionBreak::getHTMLValue() — Method in class SectionBreak

Returns the value needed for the HTML generated mail.

Select::getHTMLValue() — Method in class Select

Returns the value needed for the HTML generated mail.

StaticText::getHTMLValue() — Method in class StaticText

Returns the value needed for the HTML generated mail.

ToggleSwitch::getHTMLValue() — Method in class ToggleSwitch

Returns the value needed for the HTML generated mail.

UserSelector::getHTMLValue() — Method in class UserSelector

Returns the value needed for the HTML generated mail.

TimespanGetEvents::get_calendars() — Method in class TimespanGetEvents

Returns an array of all available calendars

TimespanGetEvents::get_event_by_id() — Method in class TimespanGetEvents

Return single matching the given event_id

TimespanGetEvents::get_events() — Method in class TimespanGetEvents

Returns an object collection of event items

ListsNavigation::getIconClass() — Method in class ListsNavigation

ListsNavigation::getUrlParams() — Method in class ListsNavigation

ListsNavigation::getAdditionalUrlParams() — Method in class ListsNavigation

AbstractPortletContext::getContextOption() — Method in class AbstractPortletContext

AbstractPortletContext::getContent() — Method in class AbstractPortletContext

DateContext::getContextOption() — Method in class DateContext

Does this list contain any date-like fields and is this context / date portlet available for the selected list?

DateContext::getContent() — Method in class DateContext

ProgressContext::getContextOption() — Method in class ProgressContext

ProgressContext::getContent() — Method in class ProgressContext

TemplateContext::getContextOption() — Method in class TemplateContext

TemplateContext::getContent() — Method in class TemplateContext

ListsPagesPortlet::get_title() — Method in class ListsPagesPortlet

ListsPagesPortlet::get_fdl() — Method in class ListsPagesPortlet

ListsPagesPortlet::get_html() — Method in class ListsPagesPortlet

ListsGanttShowPortlet::get_title() — Method in class ListsGanttShowPortlet

ListsGanttShowPortlet::get_fdl() — Method in class ListsGanttShowPortlet

Get Config from this portlet

ListsGanttShowPortlet::get_html() — Method in class ListsGanttShowPortlet

ListsGanttShowPortlet::getPagesMigrationStatus() — Method in class ListsGanttShowPortlet

ListsGanttShowPortlet::getPagesMigrationComponent() — Method in class ListsGanttShowPortlet

ListsGanttShowPortlet::getPagesMigrationHelpText() — Method in class ListsGanttShowPortlet

ListsPortletShowPortlet::get_title() — Method in class ListsPortletShowPortlet

ListsPortletShowPortlet::get_fdl() — Method in class ListsPortletShowPortlet

Get Config from this portlet

ListsPortletShowPortlet::get_html() — Method in class ListsPortletShowPortlet

ListsPortletShowPortlet::getPagesMigrationStatus() — Method in class ListsPortletShowPortlet

ListsPortletShowPortlet::getPagesMigrationComponent() — Method in class ListsPortletShowPortlet

ListsPortletShowPortlet::getPagesMigrationHelpText() — Method in class ListsPortletShowPortlet

ListsSingleShowPortlet::get_title() — Method in class ListsSingleShowPortlet

ListsSingleShowPortlet::get_fdl() — Method in class ListsSingleShowPortlet

Get Config from this portlet.

ListsSingleShowPortlet::get_html() — Method in class ListsSingleShowPortlet

Returns the portlet's HTML.

ListsSingleShowPortlet::getPagesMigrationStatus() — Method in class ListsSingleShowPortlet

ListsSingleShowPortlet::getPagesMigrationComponent() — Method in class ListsSingleShowPortlet

ListsSingleShowPortlet::getPagesMigrationHelpText() — Method in class ListsSingleShowPortlet

EnsureFormPayloadAction::get_fdl() — Method in class EnsureFormPayloadAction

EnsureFormPayloadAction::get_user_interface() — Method in class EnsureFormPayloadAction

FilterListItemsAction::get_fdl() — Method in class FilterListItemsAction

ListItemPayload::get_fdl() — Method in class ListItemPayload

Get FDL for states

ListItemPayload::get_file_url() — Method in class ListItemPayload

copied from xelos core, but prepended web_dir to path_to_file

ListItemPayload::get_placeholders() — Method in class ListItemPayload

Get all placeholders with payload property values: It's required that the identifier of the form is the same as the payload identifier.

ListItemPayload::get_payload_properties() — Method in class ListItemPayload

Get payload properties

SetFieldAction::get_fdl() — Method in class SetFieldAction

Get form definition settings

SetFieldAction::get_user_interface() — Method in class SetFieldAction

Action UI-Interface

ShowFormAction::get_fdl() — Method in class ShowFormAction

ShowFormAction::get_user_interface() — Method in class ShowFormAction

Action UI-Interface

UpdateStatusAction::get_fdl() — Method in class UpdateStatusAction

ListsController::guessGroupId() — Method in class ListsController

ListsController::getFieldByType() — Method in class ListsController

Returns an instance of the field type passed dynamically.

ListsController::getCommandsForPage() — Method in class ListsController

Returns a different set of suggestions, depending on which page was passed.

$ Category#group_id — Property in class Category

Category::getReadableCategories() — Method in class Category

Get Categories which are considered readable to the current user

Category::getManagableCategories() — Method in class Category

Get Categories which are considered managable to the current user

Category::getModelCollection() — Method in class Category

ListItem::get_fdl() — Method in class ListItem

Returns the form FDL to display a specific item or an empty form for this list

ListItem::getListProperties() — Method in class ListItem

ListItem::get_title() — Method in class ListItem

Returns the first two filled out fields in the list item.

ListItem::get_friendly_id() — Method in class ListItem

Return "running" ID for this list item

ListItem::getItemData() — Method in class ListItem

Returns form_data decoded

ListItem::getItemDataByType() — Method in class ListItem

Get ItemData by type

ListItem::getFilteredItems() — Method in class ListItem

Get list items of the same list filtered by the parameters. $this is included if parameters are matching.

ListItem::getListItemPlaceholder() — Method in class ListItem

Get Placeholders for ListItem

ListItem::getModelCollection() — Method in class ListItem

$ ListProperties#group_id — Property in class ListProperties

Group ID

ListProperties::get_category() — Method in class ListProperties

Access the list category.

ListProperties::get_form_fdl() — Method in class ListProperties

Return the current form in FDL array format

ListProperties::get_status_pop_data() — Method in class ListProperties

ListProperties::get_default_status() — Method in class ListProperties

ListProperties::getListStatusCollection() — Method in class ListProperties

ListProperties::getUniqueField() — Method in class ListProperties

ListProperties::get_facetted_fields() — Method in class ListProperties

Returns the form field IDs for the facetted filter fields facetted_1 - facetted_5 in the list item, but not the list status, because it is saved in a separate row.

ListProperties::get_facetted_values() — Method in class ListProperties

Returns all distinct values of a facetted field.

ListProperties::getAccessibleItems() — Method in class ListProperties

Get all accessible items for current user as unloaded collection

ListProperties::getSecondarySortableFields() — Method in class ListProperties

ListProperties::getOrderFieldBy() — Method in class ListProperties

Function will return an order field to be used in SQL or Collection sorting

ListProperties::getFieldsByType() — Method in class ListProperties

Return FDL for fields of specified type

ListProperties::getPresets() — Method in class ListProperties

ListProperties::getSortableFields() — Method in class ListProperties

Returns all the sortable fields of a list, which might be the first 3.

ListProperties::getAvailableWorkflowStatuses() — Method in class ListProperties

Returns a scoped model collection of workflow statuses that belong to this list (process_workflow_id).

ListProperties::getModelCollection() — Method in class ListProperties

ListStatus::get_fields() — Method in class ListStatus

Returns the FDL for the table editor form.

ListStatus::get_status_pop_data() — Method in class ListStatus

Returns the possible values for the list status policy

ListStatus::get_list_status_pop_data() — Method in class ListStatus

ListStatus::getModelCollection() — Method in class ListStatus

ItemOverviewPage::generateNavbarContent() — Method in class ItemOverviewPage

ListEditorPage::get_page() — Method in class ListEditorPage

ListEditorPage::getFormEditPresets() — Method in class ListEditorPage

ItemEditor::getPreset() — Method in class ItemEditor

ItemList::getViewMode() — Method in class ItemList

ItemList::getShowFacetedFilters() — Method in class ItemList

ItemList::generateCustomOverview() — Method in class ItemList

Use custom templates to generate overview

ItemList::getManageActionLinks() — Method in class ItemList

Get Action Links specific to list

ItemList::getListItems() — Method in class ItemList

ItemList::getFacetedFilters() — Method in class ItemList

ItemPreview::get_title() — Method in class ItemPreview

Return Document Title

ItemPreview::get_title_icon_class() — Method in class ItemPreview

Get Icon Class

ItemPreview::get_description() — Method in class ItemPreview

ItemPreview::get_image() — Method in class ItemPreview

ItemPreview::get_full_preview() — Method in class ItemPreview

Render a preview of the thread

ListPreview::get_title() — Method in class ListPreview

Return Document Title

ListPreview::get_title_icon_class() — Method in class ListPreview

Get Icon Class

ListPreview::get_description() — Method in class ListPreview

ListPreview::get_image() — Method in class ListPreview

ListPreview::get_full_preview() — Method in class ListPreview

Render a preview of the thread

ProfileCollection::getShortProfilesArray() — Method in class ProfileCollection

Mimic the old "get_short_profiles_by('id', $ids)"

ProfileCollection::getIterator() — Method in class ProfileCollection

$ Profile#group_context — Property in class Profile

$ Property#group_context — Property in class Property

$ Property#group_id — Property in class Property

$ PropertyGroup#group_context — Property in class PropertyGroup

$ PropertyTab#group_context — Property in class PropertyTab

$ PropertyTabGroup#group_id — Property in class PropertyTabGroup

$ PropertyTabGroup#group_context — Property in class PropertyTabGroup

Autocomplete::getConfigFields() — Method in class Autocomplete

Autocomplete::getEditFDL() — Method in class Autocomplete

Checkbox::getPropertySearchQuery() — Method in class Checkbox

Country::getEditFDL() — Method in class Country

Date::getConfigFields() — Method in class Date

Date::getEditFDL() — Method in class Date

Date::getPropertySearchQuery() — Method in class Date

Date::getAdditionalEditFDL() — Method in class Date

Email::getConfigFields() — Method in class Email

Email::getEditFDL() — Method in class Email

Followers::getEditFDL() — Method in class Followers

Follows::getEditFDL() — Method in class Follows

Image::getEditFDL() — Method in class Image

Memo::getConfigFields() — Method in class Memo

Memo::getEditFDL() — Method in class Memo

Number::getConfigFields() — Method in class Number

Number::getEditFDL() — Method in class Number

Phoneno::getConfigFields() — Method in class Phoneno

Phoneno::getEditFDL() — Method in class Phoneno

Select::getPropertySearchQuery() — Method in class Select

SystemHierarchy::getConfigFields() — Method in class SystemHierarchy

SystemHierarchy::getEditFDL() — Method in class SystemHierarchy

SystemUser::getConfigFields() — Method in class SystemUser

SystemUser::getEditFDL() — Method in class SystemUser

SystemUserGroup::getConfigFields() — Method in class SystemUserGroup

SystemUserGroup::getEditFDL() — Method in class SystemUserGroup

SystemUserGroup::getPropertySearchQuery() — Method in class SystemUserGroup

SystemUserMeta::getConfigFields() — Method in class SystemUserMeta

SystemUserMeta::getEditFDL() — Method in class SystemUserMeta

SystemUserMeta::getPropertySearchQuery() — Method in class SystemUserMeta

Tagging::getConfigFields() — Method in class Tagging

Tagging::getEditFDL() — Method in class Tagging

Text::getConfigFields() — Method in class Text

Text::getEditFDL() — Method in class Text

Url::getConfigFields() — Method in class Url

Url::getEditFDL() — Method in class Url

UserSelector::getEditFDL() — Method in class UserSelector

Zip::getConfigFields() — Method in class Zip

Zip::getEditFDL() — Method in class Zip

EventCollector::getDimensions() — Method in class EventCollector

EventCollector::getAggregatedDataForDimension() — Method in class EventCollector

Return the data for each dimension *

Webservice::get_profile() — Method in class Webservice

Get Profile Data

FollowersExtension::get_properties() — Method in class FollowersExtension

FollowersExtension::get_fdl() — Method in class FollowersExtension

If the portlet offers options please supply fdl for options

FollowersExtension::getFollowUserIds() — Method in class FollowersExtension

Returns the active and no_login user ids for profiles which match the group_filter_ids.

FollowersExtension::getImages() — Method in class FollowersExtension

FollowersExtension::getExtensionConfigFields() — Method in class FollowersExtension

FollowingExtension::get_properties() — Method in class FollowingExtension

UserListPortlet::get_fdl() — Method in class UserListPortlet

If the portlet offers options please supply fdl for options

UserListPortlet::get_html() — Method in class UserListPortlet

Render Portlet

FieldInterface::getConfigFields() — Method in class FieldInterface

FieldInterface::getEditFDL() — Method in class FieldInterface

Transform field into form definition language

FieldInterface::getAdditionalEditFDL() — Method in class FieldInterface

Get additional fields in form definition language

FieldInterface::getPropertySearchQuery() — Method in class FieldInterface

Get property search query part to make the property searchable

FieldTrait::getConfigFields() — Method in class FieldTrait

FieldTrait::getEditFDL() — Method in class FieldTrait

FieldTrait::getAdditionalEditFDL() — Method in class FieldTrait

FieldTrait::getPropertySearchQuery() — Method in class FieldTrait

Puts the search word into the query by comparing with 'LIKE' syntax with lower case on both, the profile property value from the database and the search word.

HasLabelsInterface::getValueLabels() — Method in class HasLabelsInterface

Replace all keys with the according labels in the property's value.

HasLabelsTrait::getConfigFields() — Method in class HasLabelsTrait

Provides a default has_labels config option.

HasLabelsTrait::getEditFDL() — Method in class HasLabelsTrait

Generates key => value pairs to map database-saved keys to displayed labels for form fields (e.g. in select dropdowns), if field has labels.

HasLabelsTrait::getValueLabels() — Method in class HasLabelsTrait

Replaces all keys with the according labels in the property's value.

PropertyGroupExtensionInterface::getExtensionConfigFields() — Method in class PropertyGroupExtensionInterface

Creates config fields for every property extension/hook type.

LookbookProfileTest::getLookbookProfileMethod() — Method in class LookbookProfileTest

Get lookbook profile method

Article::get_description() — Method in class Article

Returns an i18n string describing the document type for which this content first library was created. The description should consist of approximately 30 words.

Article::get_location() — Method in class Article

Returns the "location" a document is located at in its home instance.

Article::get_location_form_element() — Method in class Article

Returns a fdl array containing specification on how to setup a location form element.

Article::get_icon_class() — Method in class Article

Returns the FontAwesome Class that can be used for items in the DMS

Article::get_views() — Method in class Article

Returns an array of name=>title pairs of all views that are available for the current document.

Article::get_view() — Method in class Article

Returns a specific view for the given document

Article::get_draft_view() — Method in class Article

Returns a view for editing the document before it is finally created.

Article::get_comments_instance() — Method in class Article

Returns the comments instance for a given document

ArticleCollection::getUserIds() — Method in class ArticleCollection

Get authors of the articles for current where condition

ArticleCollection::getWebserviceParameterObject() — Method in class ArticleCollection

Get generic description of collection for webservice API

ArticleCollection::getIterator() — Method in class ArticleCollection

CategoryCollection::getIterator() — Method in class CategoryCollection

$ ArticleDocumentation#group_id — Property in class ArticleDocumentation

$ CategoryDocumentation#group_id — Property in class CategoryDocumentation

GroupsTemplateInit — Class in namespace XELOS\Modules\News\Hook\Groups

LatestNewsPortlet::get_fdl() — Method in class LatestNewsPortlet

Get Config from this portlet

LatestNewsPortlet::get_html() — Method in class LatestNewsPortlet

RSSShowPortlet::get_fdl() — Method in class RSSShowPortlet

RSSShowPortlet::get_title() — Method in class RSSShowPortlet

RSSShowPortlet::get_html() — Method in class RSSShowPortlet

RSSShowPortlet::getPagesMigrationStatus() — Method in class RSSShowPortlet

RSSShowPortlet::getPagesMigrationComponent() — Method in class RSSShowPortlet

RSSShowPortlet::getPagesMigrationHelpText() — Method in class RSSShowPortlet

RecentShowPortlet::get_fdl() — Method in class RecentShowPortlet

Get Config from this portlet

RecentShowPortlet::get_html() — Method in class RecentShowPortlet

Returns the portlet HTML

RecentShowPortlet::getPagesMigrationStatus() — Method in class RecentShowPortlet

RecentShowPortlet::getPagesMigrationComponent() — Method in class RecentShowPortlet

RecentShowPortlet::getPagesMigrationHelpText() — Method in class RecentShowPortlet

ArticlePayload::get_fdl() — Method in class ArticlePayload

Get

ArticlePayload::get_placeholders() — Method in class ArticlePayload

Get all placeholders with payload property values: It's required that the identifier of the form is the same as the payload identifier.

ArticlePublishAction::get_fdl() — Method in class ArticlePublishAction

Get form definition

$ PublishJob#groupId — Property in class PublishJob

PublishJob::generatePushNotifications() — Method in class PublishJob

Generates push notifications for all users who can read this article

PublishJob::generateReadConfirmations() — Method in class PublishJob

Generates read confirmations

Article::getFeatures() — Method in class Article

Get the feature settings for the article

Article::get_related_category() — Method in class Article

Category of this article

Article::get_preview_image_url() — Method in class Article

Generate URL to preview attachment

Article::get_attachments() — Method in class Article

Get attachments

Article::get_attachments_folder() — Method in class Article

Get attachments folder for this article

Article::get_attachment_items() — Method in class Article

Get attachments

Article::get_is_hidden() — Method in class Article

Is this article hidden

Article::getStatistics() — Method in class Article

Returns an array containing article statistics as likes, comments and views

Article::getPublishStatusInfo() — Method in class Article

Returns an array with all relevant infos for the current article status incl. label, icon, class

Article::getStatusBadgesInfo() — Method in class Article

Returns an array with badges information about this articles status like published, has read confirmation, top news and push notifications

Article::get_thumbnail_document() — Method in class Article

Article::get_thumbnail_document_model() — Method in class Article

Article::get_teaser_img_small() — Method in class Article

Get Teaser IMG Url (small)

Article::get_teaser_img_large() — Method in class Article

Get Teaser IMG Url (large, if available)

Article::getArticleVideoURL() — Method in class Article

Returns the URL to the attachment1 video.

Article::getPublishedAt() — Method in class Article

Get Published at DateTime

Article::getSortedAttachments() — Method in class Article

Returns the attachments of this article in the same order they have been saved/uploaded.

Article::getModelCollection() — Method in class Article

Category::getReadableCategories() — Method in class Category

Category::get_category_list() — Method in class Category

Category::get_related_articles() — Method in class Category

put your comment there.

Category::getFeatureLabel() — Method in class Category

Returns the label for a feature field name

Category::getFeatureDescription() — Method in class Category

Returns the label for a feature field name

Category::getFeatureIcon() — Method in class Category

Returns the label for a feature field name

Category::getRequirementText() — Method in class Category

Returns the requirement info for a feature

Category::getFeatureDefault() — Method in class Category

Returns the default value of this feature

Category::getAudienceInfo() — Method in class Category

Returns the counts of all users being editor, author and reader in this category This operation is slow and should be used scarcely

Category::getModelCollection() — Method in class Category

NewsController::get_page() — Method in class NewsController

NewsController::guessGroupId() — Method in class NewsController

Guess the group ID by evaluating GP and CMD Vars

NewsController::getCommandsForPage() — Method in class NewsController

Returns an array consisting of both categories and articles, filtered by the search string passed.

OverviewPage::get_page() — Method in class OverviewPage

PostPage::get_page() — Method in class PostPage

ReadPage::get_page() — Method in class ReadPage

SettingsPage::get_page() — Method in class SettingsPage

Standard Get Page Controller

SetupPage::get_configuration_steps() — Method in class SetupPage

checks several points for being configured and returns an array with the checks and their results

SetupPage::get_setup_step() — Method in class SetupPage

Article::get_title() — Method in class Article

Return Document Title

Article::get_description() — Method in class Article

Return Document Description

Article::get_image() — Method in class Article

Return Document Image URL (mod->get_file_url)

Article::get_full_preview() — Method in class Article

Return Full Preview for this document

ArticleList::getViewMode() — Method in class ArticleList

PageApiAction::getApiActionsForPage() — Method in class PageApiAction

Get action URLs for a specific PageModel respecting the status of the page and the role of the currently interacting user

PageApiAction::getApiActionsForPageVersion() — Method in class PageApiAction

ComponentCollection::getIterator() — Method in class ComponentCollection

PageCollection::getIterator() — Method in class PageCollection

PageVersionCollection::getIterator() — Method in class PageVersionCollection

CollectionOptionHelper::getCollectionOrderByFDL() — Method in class CollectionOptionHelper

Ordering Option Field

CollectionOptionHelper::getPrefixedConfigName() — Method in class CollectionOptionHelper

Get internal config name used by CollectioOptionHelper

CommentsPortlet::get_title() — Method in class CommentsPortlet

CommentsPortlet::get_fdl() — Method in class CommentsPortlet

If the portlet offers options please supply fdl for options

CommentsPortlet::get_html() — Method in class CommentsPortlet

JsonPathElement::getValue() — Method in class JsonPathElement

Returns the FIRST value of the passed JSONPath

JsonPathElement::getElements() — Method in class JsonPathElement

Returns the elements matching the provided path as JsonPathElement Object to allow modifications

JsonPathElement::getJson() — Method in class JsonPathElement

Retuns the current state as JSON String

PageJsonProcessor::getJson() — Method in class PageJsonProcessor

Return Page JSON incl. all modifications

PageJsonProcessor::getAttachmentUuids() — Method in class PageJsonProcessor

Returns an array of all used attachment uuids

PageJsonProcessor::getContentReferenceUuids() — Method in class PageJsonProcessor

Return array of all used content reference uuids (e.g. trendvote)

PageJsonProcessor::getIndexableContent() — Method in class PageJsonProcessor

Returns an array of all indexable content of the page

PageJsonProcessor::getJsonElements() — Method in class PageJsonProcessor

Runs a custom query against the JSON

Component::getModelCollection() — Method in class Component

Page::getUrl() — Method in class Page

Page::getStatusInfo() — Method in class Page

Central function to determine the overall page stati incl. icon, color and label definitions to be used in the UI

Page::getLanguageInfo() — Method in class Page

Returns a list of all available languages (not hidden)

Page::getAudienceInfo() — Method in class Page

Returns information about the audience settings of this page

Page::generateUrlKey() — Method in class Page

Generates a valid url key based on the passed string

Page::getPublishedVersion() — Method in class Page

Get current PUBLISHED PageVersion if available

Page::getDraftVersion() — Method in class Page

Get current DRAFT PageVersion if available

Page::getOrCreateDraftVersion() — Method in class Page

Returns an existing draft version or creates a new draft

Page::getModelCollection() — Method in class Page

PageVersion::getPage() — Method in class PageVersion

Returns corresponding Page Model

PageVersion::getAttachmentDocuments() — Method in class PageVersion

Return all attachments as document index collection

PageVersion::getModelCollection() — Method in class PageVersion

ShowPage::get_page() — Method in class ShowPage

PagesController::getPortlet() — Method in class PagesController

PagesController::get_dyn_tree() — Method in class PagesController

Dynamically generates the tree structure for existing pages.

PagesController::getDynTreeParams() — Method in class PagesController

Page::get_title_icon_class() — Method in class Page

Return CSS Icon class for title

Page::get_title() — Method in class Page

Return Document Title

Page::get_description() — Method in class Page

Return Document Description

Page::get_full_preview() — Method in class Page

Return Full Preview for this document

PersonalWorkspaceDocumentBrowser::get_items() — Method in class PersonalWorkspaceDocumentBrowser

PersonalWorkspaceDocumentBrowser::get_title() — Method in class PersonalWorkspaceDocumentBrowser

Returns a title for this browser.

SelectorBrowser::get_document_browser() — Method in class SelectorBrowser

SelectorBrowser::get_name() — Method in class SelectorBrowser

SelectorBrowser::get_thumbnail_url() — Method in class SelectorBrowser

Workspace::get_title() — Method in class Workspace

Workspace::get_dms() — Method in class Workspace

Returns a dms instance in user group context.

Workspace::get_quota_size() — Method in class Workspace

Returns the quota size in megabytes.

Workspace::get_root_folder() — Method in class Workspace

Returns the root workspace folder.

DocumentsPage::get_page() — Method in class DocumentsPage

RecentPage::get_page() — Method in class RecentPage

PersonalWorkspaceController::get_workspace() — Method in class PersonalWorkspaceController

Returns an workspace instance which contains the dms based on users group context and quota information.

PersonalWorkspaceController::get_dyn_tree() — Method in class PersonalWorkspaceController

PersonalWorkspaceController::get_page() — Method in class PersonalWorkspaceController

ConfirmationCollection::getSearchQueryConditionGroup() — Method in class ConfirmationCollection

Get the Condition for simple text search/filter

ConfirmationCollection::getIterator() — Method in class ConfirmationCollection

DocumentCollection::getSearchQueryConditionGroup() — Method in class DocumentCollection

Callback for the faceted search filter.

DocumentCollection::getIterator() — Method in class DocumentCollection

$ ConfirmationDocumentation#group_id — Property in class ConfirmationDocumentation

$ DocumentDocumentation#group_id — Property in class DocumentDocumentation

ReadConfirmationNavigation::getIconClass() — Method in class ReadConfirmationNavigation

ReadConfirmationNavigation::getUrlParams() — Method in class ReadConfirmationNavigation

AdminProcessor::get_action() — Method in class AdminProcessor

Returns action if any cloud service is registered in the cloud service manager.

ReadConfirmationShowPortlet::get_title() — Method in class ReadConfirmationShowPortlet

ReadConfirmationShowPortlet::get_fdl() — Method in class ReadConfirmationShowPortlet

Get Config from this portlet

ReadConfirmationShowPortlet::get_html() — Method in class ReadConfirmationShowPortlet

Confirmation::getActivityData() — Method in class Confirmation

Returns the activity on a specific document or all of them.

Confirmation::getModelCollection() — Method in class Confirmation

Document::getModelCollection() — Method in class Document

OverviewPage::getOverviewTable() — Method in class OverviewPage

Get the table used in overview and CMS Portlet

ReadConfirmationController::guessGroupId() — Method in class ReadConfirmationController

Guess the group ID by evaluating GP and CMD Vars

ReadConfirmationController::getReadConfirmationDocuments() — Method in class ReadConfirmationController

Returns Read Confirmation Douments based on given documentIndex Collection

HistoryAction::getLastEntries() — Method in class HistoryAction

Returns the last entries of the current user sorted by last access (updated_at) descending.

IndexerAction::getSearchAdapter() — Method in class IndexerAction

Returns the currently used Search Adapter

ElasticSearchAdapter::getFromIndex() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::getIndexInfo() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::getElasticSearchClient() — Method in class ElasticSearchAdapter

Returns a connected Elastic Search Client Object

ElasticSearchAdapter::getUnsupportedElasticSearchVersion() — Method in class ElasticSearchAdapter

Get unsupported elastic search version

ElasticSearchAdapter::getVersionedIndexName() — Method in class ElasticSearchAdapter

Get Elastic Index Name with Version suffix This should be used when trying to create or delete index, use getAliasName for Search and Queries

ElasticSearchAdapter::getAliasName() — Method in class ElasticSearchAdapter

Get Elastic Index Name with Version suffix

ElasticSearchAdapter::getHasRestrictedAccess() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::getIndexSchemaStatus() — Method in class ElasticSearchAdapter

Returns true if the index schema is uptodate, false if not.

ElasticSearchAdapter::getIndexSetting() — Method in class ElasticSearchAdapter

Get Index Settings

ElasticSearchAdapter::getSearchUpdateDSL() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::getMaintenanceUI() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::getSnapshots() — Method in class ElasticSearchAdapter

Get list of snapshots taken

ElasticSearchAdapter::getDocumentIndexCollectionFromIndex() — Method in class ElasticSearchAdapter

Returns a document index collection of search results without rights, instance access or group security checks.

QueryBuilder::getDocumentSearchQuery() — Method in class QueryBuilder

Returns an ElasticSearch Query Array based on the passed parameters and all search instance settings

QueryBuilder::getSimpleSearchBuilder() — Method in class QueryBuilder

Returns the QueryBuilder without instance and group access checks and without aggregations.

QueryBuilder::getSearchtermSuggestQuery() — Method in class QueryBuilder

QueryBuilder::getQuery() — Method in class QueryBuilder

AttachmentTrait::getAttachmentFulltextContent() — Method in class AttachmentTrait

Returns the fulltext content of all attachments of SearchIndexRecord.

AttachmentTrait::getAttachmentFileExtensions() — Method in class AttachmentTrait

Returns all found file extensions of all attachments of SearchIndexRecord.

AttachmentTrait::getAttachmentsHash() — Method in class AttachmentTrait

Returns a combined hash string of all file contents of the attachments of SearchIndexRecord.

SearchIntegration::getDocumentsBySearch() — Method in class SearchIntegration

Search for "Documents"

SearchIntegration::getDocumentCountBySearch() — Method in class SearchIntegration

Gets the maximum available hits count for this search-term

SearchIntegration::getMinLength() — Method in class SearchIntegration

Returns the min length of a single search word

SearchIntegration::getTabTitle() — Method in class SearchIntegration

SearchIntegration::getFacetedFilters() — Method in class SearchIntegration

Return facets for the search sidebar.

SearchMetaData::getFields() — Method in class SearchMetaData

SearchMetaData::getKeys() — Method in class SearchMetaData

SearchMetaData::getLabelForKey() — Method in class SearchMetaData

SearchMetaData::getLabelForValue() — Method in class SearchMetaData

SearchMetaData::getSearchQuery() — Method in class SearchMetaData

Returns the search query for the given key and value.

SearchMetaData::getAggregation() — Method in class SearchMetaData

SearchMetaData::getValuesForKey() — Method in class SearchMetaData

Field::getLabel() — Method in class Field

Field::getKey() — Method in class Field

AgentPortletShowPortlet::get_title() — Method in class AgentPortletShowPortlet

AgentPortletShowPortlet::get_html() — Method in class AgentPortletShowPortlet

AgentPortletShowPortlet::getPagesMigrationStatus() — Method in class AgentPortletShowPortlet

AgentPortletShowPortlet::getPagesMigrationComponent() — Method in class AgentPortletShowPortlet

AgentPortletShowPortlet::getPagesMigrationHelpText() — Method in class AgentPortletShowPortlet

PortletSearchShowPortlet::get_title() — Method in class PortletSearchShowPortlet

PortletSearchShowPortlet::get_html() — Method in class PortletSearchShowPortlet

PortletSearchShowPortlet::get_fdl() — Method in class PortletSearchShowPortlet

If the portlet offers options please supply fdl for options

PortletSearchShowPortlet::getPagesMigrationStatus() — Method in class PortletSearchShowPortlet

PortletSearchShowPortlet::getPagesMigrationComponent() — Method in class PortletSearchShowPortlet

PortletSearchShowPortlet::getPagesMigrationHelpText() — Method in class PortletSearchShowPortlet

SearchDocumentBrowser::get_items() — Method in class SearchDocumentBrowser

SearchDocumentBrowser::get_title() — Method in class SearchDocumentBrowser

Returns a title for this browser.

SearchDocumentBrowser::get_items_by_search() — Method in class SearchDocumentBrowser

Returns all items found by given term.

SearchSelectorBrowser::get_document_browser() — Method in class SearchSelectorBrowser

SearchSelectorBrowser::get_name() — Method in class SearchSelectorBrowser

SearchSelectorBrowser::get_thumbnail_url() — Method in class SearchSelectorBrowser

SearchAdapterInterface::getIndexInfo() — Method in class SearchAdapterInterface

Returns an array that contains information about the search index.

SearchAdapterInterface::getMaintenanceUI() — Method in class SearchAdapterInterface

Return Optional UI Component for advanced maintenance UI

SearchDocumentInterface::get_facetted_search_info() — Method in class SearchDocumentInterface

Returns facet search data based on the last search query.

SearchDocumentInterface::get_searchterm_suggest() — Method in class SearchDocumentInterface

Function will return suggestions based on input usually spell corrected or similar queries (Did you mean ...)

SearchDocumentInterface::get_documents_by_search() — Method in class SearchDocumentInterface

Search for "Documents"

SearchDocumentInterface::get_document_count_by_search() — Method in class SearchDocumentInterface

Gets the maximum available hits count for this search-term

SearchDocumentInterface::get_min_length() — Method in class SearchDocumentInterface

Returns the min length of a single search word

SearchMetaDataInterface::getFields() — Method in class SearchMetaDataInterface

Returns an array of Fields which define which fields are available for filtering and which for sorting.

SearchMetaDataInterface::getKeys() — Method in class SearchMetaDataInterface

Returns the keys used in the index which should be displayed as faceted filters.

SearchMetaDataInterface::getLabelForKey() — Method in class SearchMetaDataInterface

Returns the label for the given meta data key.

SearchMetaDataInterface::getLabelForValue() — Method in class SearchMetaDataInterface

Returns the label for the given meta data value. Return the value if it is unchanged.

SearchMetaDataInterface::getSearchQuery() — Method in class SearchMetaDataInterface

Returns the search query for the given key and value.

SearchMetaDataInterface::getAggregation() — Method in class SearchMetaDataInterface

Define a custom aggregation for the meta_data. This aggregation can be used for counts of the custom values.

SearchMetaDataInterface::getValuesForKey() — Method in class SearchMetaDataInterface

Enables custom values with their own counts instead of the values defined when writing to the search index.

DocumentElasticsearch::get_min_length() — Method in class DocumentElasticsearch

Returns the min length of a single search word

DocumentElasticsearch::get_searchterm_suggest() — Method in class DocumentElasticsearch

Get Searchterm suggestions based on Elastic Search Term Suggester

DocumentElasticsearch::get_documents_by_search() — Method in class DocumentElasticsearch

DocumentElasticsearch::get_last_search_total_result_count() — Method in class DocumentElasticsearch

Returns the number of total results (unlimited) of the last search

DocumentElasticsearch::get_facetted_search_info() — Method in class DocumentElasticsearch

DocumentElasticsearch::getFacetValues() — Method in class DocumentElasticsearch

Loads additional filter values for the given facet. Uses get_faceted_search with only one selected facet.

DocumentElasticsearch::get_document_count_by_search() — Method in class DocumentElasticsearch

FacetedFilter::getCategories() — Method in class FacetedFilter

Searchagent::get_search_result_count() — Method in class Searchagent

Searchagent::get_search_results() — Method in class Searchagent

IndexPage::get_page() — Method in class IndexPage

Show Page as Index

OverviewPage::get_page() — Method in class OverviewPage

Main Search Page

SearchagentPage::get_page() — Method in class SearchagentPage

Search Agent

SearchagentPage::get_searchagent_tabs() — Method in class SearchagentPage

SuggestPage::get_page() — Method in class SuggestPage

Auto-Suggest Feature

SearchController::get_page() — Method in class SearchController

SearchController::getSearchAdapter() — Method in class SearchController

SearchController::get_notifications() — Method in class SearchController

Notify user about Searchagent-Matches (Function is called by System Notifications Cron)

SearchController::get_document() — Method in class SearchController

Retrieves a document search model (depending on the search_engine config setting (sql/lucene))

SearchController::get_documents_by_search() — Method in class SearchController

SearchController::getSearchSortBy() — Method in class SearchController

Returns the sort options for the search results.

SearchIndexContentRecord::getTitle() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::getSummary() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::getIndexContent() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::getLocale() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::getIsAutoTranslated() — Method in class SearchIndexContentRecord

Returns true if this Content has not been translated by humans (Auto Translated)

SearchIndexRecord::getTitle() — Method in class SearchIndexRecord

SearchIndexRecord::getUrl() — Method in class SearchIndexRecord

SearchIndexRecord::getSummary() — Method in class SearchIndexRecord

SearchIndexRecord::getIndexContent() — Method in class SearchIndexRecord

Sets the content which shall be additionally be indexed. By default the title and summary are already indexed.

SearchIndexRecord::getLocale() — Method in class SearchIndexRecord

SearchIndexRecord::getAttachments() — Method in class SearchIndexRecord

SearchIndexRecord::getNormalizedAttachments() — Method in class SearchIndexRecord

SearchIndexRecord::getRelatedPostId() — Method in class SearchIndexRecord

SearchIndexRecord::getTags() — Method in class SearchIndexRecord

SearchIndexRecord::getPreProcessingData() — Method in class SearchIndexRecord

Used by Pre-Processing Logic to store / get additional data during indexing

SearchIndexRecord::getContentRecords() — Method in class SearchIndexRecord

Returns an array of localized Content objects containing all available translations for this document

SearchIndexRecord::getRemoveFromIndex() — Method in class SearchIndexRecord

Returns true of this index record has been marked for index removal

SearchIndexRecord::getDocumentIndex() — Method in class SearchIndexRecord

SearchIndexRecord::getPostId() — Method in class SearchIndexRecord

SearchIndexRecord::getPostType() — Method in class SearchIndexRecord

SearchIndexRecord::getGroupSecurityId() — Method in class SearchIndexRecord

SearchIndexRecord::getUserId() — Method in class SearchIndexRecord

SearchIndexRecord::getCreatedAt() — Method in class SearchIndexRecord

Returns the initial document creation date as UNIX timestamp

SearchIndexRecord::getUpdatedAt() — Method in class SearchIndexRecord

Returns the last document update date as UNIX timestamp

SearchIndexRecord::getMetaData() — Method in class SearchIndexRecord

SearchUpdateRecord::getDocumentIndexId() — Method in class SearchUpdateRecord

SearchUpdateRecord::getMetaData() — Method in class SearchUpdateRecord

SearchUpdateRecord::getProperties() — Method in class SearchUpdateRecord

ResultPanel::getSearchterm() — Method in class ResultPanel

SearchIntegrationResultPanel::getSearchTerm() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::getSearchIndexRecords() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::getSearchIndexCount() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::getPaging() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::getIntegrationHook() — Method in class SearchIntegrationResultPanel

TabsTrait::getTabs() — Method in class TabsTrait

AbstractBrowserItem::get_size() — Method in class AbstractBrowserItem

Returns the size of this file in bytes.

AbstractBrowserItem::get_author() — Method in class AbstractBrowserItem

Returns the author of this item.

AbstractBrowserItem::get_source() — Method in class AbstractBrowserItem

Returns the source where this item is placed.

AbstractBrowserItem::get_id() — Method in class AbstractBrowserItem

Returns the identifier of this item.

AbstractBrowserItem::get_name() — Method in class AbstractBrowserItem

Returns the name of this item.

AbstractBrowserItem::get_secure_name() — Method in class AbstractBrowserItem

Return the name with escaping for usage in XSS context

AbstractBrowserItem::get_name_tooltip() — Method in class AbstractBrowserItem

Returns the name of this item with optional source.

AbstractBrowserItem::get_thumbnail_url() — Method in class AbstractBrowserItem

Returns the url of the thumbnail image of this item. This method should return an empty string if there is no thumbnail, in this case, the item displays an icon based on the extension or type of this item.

AbstractBrowserItem::get_selectable() — Method in class AbstractBrowserItem

Returns the numeric representation of the selectable value.

AbstractBrowserItem::get_item_type() — Method in class AbstractBrowserItem

Returns the type of this item. Possible types are folder and file.

AbstractBrowserItem::get_created_at() — Method in class AbstractBrowserItem

Returns the creation time in unix timestamp format.

AbstractBrowserItem::get_modified_at() — Method in class AbstractBrowserItem

Returns the modification time in unix timestamp format.

AbstractDocumentBrowser::get_custom_operation_title() — Method in class AbstractDocumentBrowser

Returns a custom title for the operation button or null if not set.

AbstractDocumentBrowser::getConfirmMessages() — Method in class AbstractDocumentBrowser

AbstractDocumentBrowser::get_mode() — Method in class AbstractDocumentBrowser

Returns the browse mode.

AbstractDocumentBrowser::get_item_limit() — Method in class AbstractDocumentBrowser

Returns the limit how many items should be loaded per one call.

AbstractDocumentBrowser::get_multiple_selection() — Method in class AbstractDocumentBrowser

Returns a boolean whether multiple items can be selected or not.

AbstractDocumentBrowser::get_show_operation_options() — Method in class AbstractDocumentBrowser

Returns whether to show the option to set the operation for selecting item (link, move, copy).

AbstractDocumentBrowser::get_enable_load_more() — Method in class AbstractDocumentBrowser

Returns whether more documents should be loaded on scroll.

AbstractDocumentBrowser::get_enable_context_menu() — Method in class AbstractDocumentBrowser

Returns whether the context menu should be displayed or not.

AbstractDocumentBrowser::get_enable_search() — Method in class AbstractDocumentBrowser

Returns whether the search should be displayed or not.

AbstractDocumentBrowser::get_items() — Method in class AbstractDocumentBrowser

Returns all items for the given item identifier.

AbstractDocumentBrowser::get_title() — Method in class AbstractDocumentBrowser

Returns a title for this browser.

DocumentBrowserHookInterface::get_document_browser() — Method in class DocumentBrowserHookInterface

Returns a specific document browser for the requested module.

DocumentBrowserHookInterface::get_name() — Method in class DocumentBrowserHookInterface

Returns the name for this document browser provider.

DocumentBrowserHookInterface::get_thumbnail_url() — Method in class DocumentBrowserHookInterface

Returns the url of a thumbnail for this document browser provider.

SearchableDocumentBrowserInterface::get_items_by_search() — Method in class SearchableDocumentBrowserInterface

Returns all items found by given term.

BrowserFile::get_ext() — Method in class BrowserFile

Returns the file extension.

BrowserFile::get_media_type() — Method in class BrowserFile

Returns the media type.

BrowserFile::get_revision() — Method in class BrowserFile

Returns the revision for this file.

BrowserFile::get_user_id() — Method in class BrowserFile

Returns the user id who create this file.

BrowserFile::getAllowedOperationsString() — Method in class BrowserFile

UserSelectorProcessor::getUserList() — Method in class UserSelectorProcessor

Page::get_icon_class() — Method in class Page

Returns the FontAwesome Class that can be used for items in the DMS

Page::get_views() — Method in class Page

Returns an array of name=>title pairs of all views that are available for the current document.

Page::get_draft_view() — Method in class Page

Returns a view for editing the document before it is finally created.

Page::get_view() — Method in class Page

Returns a specific view for the given document

Page::get_comments_instance() — Method in class Page

Returns the comments instance for a given document

$ PageDocumentation#group_id — Property in class PageDocumentation

$ PageHistoryDocumentation#group_id — Property in class PageHistoryDocumentation

$ PageLinkDocumentation#group_id — Property in class PageLinkDocumentation

GroupsTemplateInit — Class in namespace XELOS\Modules\SmartWiki\Hook\Groups

$ Page#group_id — Property in class Page

Page::getDocumentsArray() — Method in class Page

Page::get_documents() — Method in class Page

Return attaced documents

Page::get_numeric_id() — Method in class Page

workaround for legacy code

Page::get_parent_pages() — Method in class Page

Returns an array with all parent page elements

Page::getSlugForString() — Method in class Page

returns a string or number into a valid slug for use in an url does no check waether or not it already exixts

Page::getValidPageSlug() — Method in class Page

returns a valid page ID inf the form of $title_$cnt where $cnt increses until a unsued title is found

Page::getContentHTMLFormatted() — Method in class Page

Returns the links formatted as HTML incl. all kinds of parsing

Page::get_all_pages() — Method in class Page

returns links to all pages based on users policy users get only active pages users who can write also get all inactive pages users who can delete also get other users personal drafts

Page::get_history() — Method in class Page

Page::get_last_change() — Method in class Page

Page::get_user_id() — Method in class Page

Workaround for user_id

Page::getRootPage() — Method in class Page

Page::getPossibleRootPagesCount() — Method in class Page

Page::getNonDuplicatableFields() — Method in class Page

CommentsPage::get_page() — Method in class CommentsPage

EditPage::get_page() — Method in class EditPage

ExportPage::get_page() — Method in class ExportPage

HistoryPage::get_page() — Method in class HistoryPage

IndexPage::get_page() — Method in class IndexPage

IndexPage::get_toc_tree_object() — Method in class IndexPage

IndexPage::get_toc_tree() — Method in class IndexPage

InfoPage::get_page() — Method in class InfoPage

ShowPage::get_page() — Method in class ShowPage

SourcePage::get_page() — Method in class SourcePage

SmartWikiController::get_tabs() — Method in class SmartWikiController

SmartWikiController::get_attachment_table() — Method in class SmartWikiController

Returns an xui_table object holding the documents table of the passed page

SmartWikiController::getWikiPage() — Method in class SmartWikiController

Returns the page object for the passed page reference

SmartWikiController::getRootPage() — Method in class SmartWikiController

SmartWikiController::guessGroupId() — Method in class SmartWikiController

Guess the group ID by evaluating GP and CMD Vars

SmartWikiController::getEditorInserts() — Method in class SmartWikiController

Generates a list of all possible editor Inserts values for the given page

SmartWikiController::getAllTemplates() — Method in class SmartWikiController

returns an array of template tiles indexed by their ids to use in popdata

SmartWikiController::getPossibleParentPages() — Method in class SmartWikiController

returns a usable array for the cat selector, excluding the current page if not null

SmartWikiController::get_dyn_tree() — Method in class SmartWikiController

SmartWikiController::getCommandsForPage() — Method in class SmartWikiController

Returns the available pages as "show='page'" command.

SmartWikiController::getDynTreeParams() — Method in class SmartWikiController

Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.

Page::get_title() — Method in class Page

Page::get_full_preview() — Method in class Page

ActivityCollection::getWebserviceParameterObject() — Method in class ActivityCollection

Get generic description of collection for webservice API

EntryCollection::getWebserviceParameterObject() — Method in class EntryCollection

Get generic description of collection for webservice API

EntryCollection::getIterator() — Method in class EntryCollection

EntryCollection::get_model() — Method in class EntryCollection

$ EntryDocumentation#group_security_id — Property in class EntryDocumentation

CmsWallContentPortlet::get_title() — Method in class CmsWallContentPortlet

Get the title

CmsWallContentPortlet::get_html() — Method in class CmsWallContentPortlet

Show the rendered portlet

CmsWallContentPortlet::getPagesMigrationStatus() — Method in class CmsWallContentPortlet

CmsWallContentPortlet::getPagesMigrationComponent() — Method in class CmsWallContentPortlet

CmsWallContentPortlet::getPagesMigrationHelpText() — Method in class CmsWallContentPortlet

WallPortlet::get_title() — Method in class WallPortlet

WallPortlet::get_html() — Method in class WallPortlet

WallPortlet::get_fdl() — Method in class WallPortlet

If the portlet offers options please supply fdl for options

PortletActionlogShowPortlet::get_title() — Method in class PortletActionlogShowPortlet

PortletActionlogShowPortlet::get_fdl() — Method in class PortletActionlogShowPortlet

PortletActionlogShowPortlet::get_html() — Method in class PortletActionlogShowPortlet

Used in Portal extension

PortletActionlogShowPortlet::get_properties() — Method in class PortletActionlogShowPortlet

Used in lookbook extension

PortletActionlogShowPortlet::getExtensionConfigFields() — Method in class PortletActionlogShowPortlet

PortletActionlogShowPortlet::getPagesMigrationStatus() — Method in class PortletActionlogShowPortlet

PortletActionlogShowPortlet::getPagesMigrationComponent() — Method in class PortletActionlogShowPortlet

PortletActionlogShowPortlet::getPagesMigrationHelpText() — Method in class PortletActionlogShowPortlet

DocumentWallItem::get_document_index() — Method in class DocumentWallItem

Entry::get_what_params() — Method in class Entry

Entry::get_user_avatar_url() — Method in class Entry

Entry::get_user_image() — Method in class Entry

Entry::get_user_link() — Method in class Entry

Entry::get_message() — Method in class Entry

Entry::generate_message() — Method in class Entry

Entry::get_friendly_time() — Method in class Entry

returns friendly formated created at string

Entry::getModelCollection() — Method in class Entry

WallPage::getWebComponent() — Method in class WallPage

Returns the WebComponent Tag HTML based on the base config and the passed config params

SystemActionlogController::get_entries() — Method in class SystemActionlogController

get logged actions. You can restrict the result by the parameters instance and user

SystemActionlogController::get_entries_tpl() — Method in class SystemActionlogController

returns a tpl with the generated actions

Document::get_icon_class() — Method in class Document

Document::get_views() — Method in class Document

Returns an array of name=>title pairs of all views that are available for the current document.

Document::get_view() — Method in class Document

Returns a specific view for the given document

Document::get_draft_view() — Method in class Document

Returns a view for editing the document before it is finally created.

Document::get_comments_instance() — Method in class Document

Returns the comments instance for a given document

CategoryCollection::getWebserviceParameterObject() — Method in class CategoryCollection

Get generic description of collection for webservice API

CategoryCollection::getIterator() — Method in class CategoryCollection

CategoryCollection::get_model() — Method in class CategoryCollection

CategoryDocumentCollection::getWebserviceParameterObject() — Method in class CategoryDocumentCollection

Get generic description of collection for webservice API

DocumentCollection::getWebserviceParameterObject() — Method in class DocumentCollection

Get generic description of collection for webservice API

DocumentCollection::getIterator() — Method in class DocumentCollection

DocumentCollection::get_model() — Method in class DocumentCollection

CrmPortletShowTab::get_template() — Method in class CrmPortletShowTab

CFViewNoteCFView::get_title() — Method in class CFViewNoteCFView

Returns the title of this view.

CFViewNoteCFView::get_supported_file_ext() — Method in class CFViewNoteCFView

Returns an array that contains all file extensions which is supported by this content first view.

CFViewNoteCFView::get_view() — Method in class CFViewNoteCFView

Returns the view which represents a document handling view.

GroupsTemplateInit — Class in namespace XELOS\Modules\SystemDMS\Hook\Groups

Copy Structure, Data & Policies (Group-Template -> Group)

PortletActionShowPortlet::get_title() — Method in class PortletActionShowPortlet

Return Title String

PortletActionShowPortlet::get_fdl() — Method in class PortletActionShowPortlet

Returns Form to select Options

PortletActionShowPortlet::get_html() — Method in class PortletActionShowPortlet

PortletActionShowPortlet::get_available_category_ids() — Method in class PortletActionShowPortlet

PortletActionShowPortlet::getPagesMigrationStatus() — Method in class PortletActionShowPortlet

PortletActionShowPortlet::getPagesMigrationComponent() — Method in class PortletActionShowPortlet

PortletActionShowPortlet::getPagesMigrationHelpText() — Method in class PortletActionShowPortlet

PortletFolderhierarchyShowPortlet::get_title() — Method in class PortletFolderhierarchyShowPortlet

PortletFolderhierarchyShowPortlet::get_fdl() — Method in class PortletFolderhierarchyShowPortlet

Returns Form to select Options

PortletFolderhierarchyShowPortlet::get_html() — Method in class PortletFolderhierarchyShowPortlet

PortletFolderhierarchyShowPortlet::getPagesMigrationStatus() — Method in class PortletFolderhierarchyShowPortlet

PortletFolderhierarchyShowPortlet::getPagesMigrationComponent() — Method in class PortletFolderhierarchyShowPortlet

PortletFolderhierarchyShowPortlet::getPagesMigrationHelpText() — Method in class PortletFolderhierarchyShowPortlet

PortletFolderviewShowPortlet::get_title() — Method in class PortletFolderviewShowPortlet

PortletFolderviewShowPortlet::get_fdl() — Method in class PortletFolderviewShowPortlet

Get form definition layer

PortletFolderviewShowPortlet::get_html() — Method in class PortletFolderviewShowPortlet

Get HTML

PortletFolderviewShowPortlet::getPagesMigrationStatus() — Method in class PortletFolderviewShowPortlet

PortletFolderviewShowPortlet::getPagesMigrationComponent() — Method in class PortletFolderviewShowPortlet

PortletFolderviewShowPortlet::getPagesMigrationHelpText() — Method in class PortletFolderviewShowPortlet

PortletNavigatorShowPortlet::get_title() — Method in class PortletNavigatorShowPortlet

Return Title String

PortletNavigatorShowPortlet::get_fdl() — Method in class PortletNavigatorShowPortlet

PortletNavigatorShowPortlet::get_html() — Method in class PortletNavigatorShowPortlet

Return HTML

PortletNavigatorShowPortlet::getPagesMigrationStatus() — Method in class PortletNavigatorShowPortlet

PortletNavigatorShowPortlet::getPagesMigrationComponent() — Method in class PortletNavigatorShowPortlet

PortletNavigatorShowPortlet::getPagesMigrationHelpText() — Method in class PortletNavigatorShowPortlet

PortletReportShowPortlet::get_title() — Method in class PortletReportShowPortlet

PortletReportShowPortlet::get_fdl() — Method in class PortletReportShowPortlet

Returns Form to select Options

PortletReportShowPortlet::get_html() — Method in class PortletReportShowPortlet

Render the portlet in display mode This will either display a user specified description or a summary of the filters, as well as a link to the files

PortletReportShowPortlet::getPagesMigrationStatus() — Method in class PortletReportShowPortlet

PortletReportShowPortlet::getPagesMigrationComponent() — Method in class PortletReportShowPortlet

PortletReportShowPortlet::getPagesMigrationHelpText() — Method in class PortletReportShowPortlet

SearchMetaData::getFields() — Method in class SearchMetaData

SearchMetaData::getLabelForValue() — Method in class SearchMetaData

Returns custom labels for the filesize.

SearchMetaData::getValuesForKey() — Method in class SearchMetaData

Based on the custom aggregation adds the count of the different files sizes to the values.

SearchMetaData::getSearchQuery() — Method in class SearchMetaData

Uses the default search query for the file extension; adds a custom range query for the filesize.

SearchMetaData::getAggregation() — Method in class SearchMetaData

Custom aggregation to group the filesizes in < 1MB, 1-5MB and > 5MB buckets.

SystemDMSDocumentBrowser::get_items() — Method in class SystemDMSDocumentBrowser

SystemDMSDocumentBrowser::get_title() — Method in class SystemDMSDocumentBrowser

Returns a title for this browser.

SelectorBrowser::get_document_browser() — Method in class SelectorBrowser

SelectorBrowser::get_name() — Method in class SelectorBrowser

SelectorBrowser::get_thumbnail_url() — Method in class SelectorBrowser

$ WebdavService#group_title — Property in class WebdavService

WebdavService::get_directory_listing() — Method in class WebdavService

GET method handler for directories This is a very simple mod_index lookalike.

WebdavService::get_lockinfo() — Method in class WebdavService

Get lock info

WebdavService::get_propinfo() — Method in class WebdavService

Get Properties for path

WebdavService::get_catinfo() — Method in class WebdavService

Get Information about category

WebdavService::get_docinfo() — Method in class WebdavService

Get properties for a single file/resource

WebdavService::getETag() — Method in class WebdavService

SavePayloadAction::get_fdl() — Method in class SavePayloadAction

Get form definition

CategoryTabInterface::get_title() — Method in class CategoryTabInterface

DocumentItemViewInterface::get_title() — Method in class DocumentItemViewInterface

Returns the title of this view.

DocumentItemViewInterface::get_supported_file_ext() — Method in class DocumentItemViewInterface

Returns an array that contains all file extensions which is supported by this content first view.

DocumentItemViewInterface::get_view() — Method in class DocumentItemViewInterface

Returns the view which represents a document handling view.

FullyIntegratedInterface::get_file_path() — Method in class FullyIntegratedInterface

Returns the file path.

FullyIntegratedInterface::getBasePath() — Method in class FullyIntegratedInterface

Returns the base path of this file.

Category::get_thumbnail_document() — Method in class Category

Category::get_sub_categories() — Method in class Category

Gets all Child-Categories of this Category, with the same Group-Context (important for Root-Categories)

Category::get_uniqe_foldername() — Method in class Category

will determine a new folder name, which isn't set in the same parent-Category

Category::get_documents() — Method in class Category

get related documents of this category

Category::get_categories_by_pid() — Method in class Category

Lookup Category ID

Category::get_category_dyn_tree() — Method in class Category

Get categories for navigation

Category::get_catselect_tree() — Method in class Category

Function designed to work well with cat_selector form elements

Category::get_catselect_tree_write() — Method in class Category

Function designed to work well with cat_selector form elements

Category::get_tree_data() — Method in class Category

Category::get_category_tree() — Method in class Category

Category::get_parent_categories() — Method in class Category

Returns an array of ancestor categories tree arrays for this category.

Category::get_child_ids() — Method in class Category

recursive function, returns all child ids of category

Category::get_path() — Method in class Category

Category::get_default_category() — Method in class Category

Returns the default category for the current folder

Category::get_xfs_instance_category() — Method in class Category

Returns an instance specific category as system folder from system dms.

Category::getModelCollection() — Method in class Category

Document::get_latest_version_id() — Method in class Document

Document::get_filename_without_extension() — Method in class Document

Check for the current FileName without Extension

Document::get_file_extension() — Method in class Document

Check for the current File-Extension

Document::get_filename_url() — Method in class Document

gets the url-friendly filename

Document::get_related_category() — Method in class Document

Document::get_author() — Method in class Document

Returns the author name of the current document

Document::get_filesize() — Method in class Document

gets the filesize in Bytes for the current file

Document::get_filemtime() — Method in class Document

Returns the time the file was last modified. The time is returned as a Unix timestamp, which is suitable for the date() function.

Document::get_formatted_data() — Method in class Document

If a template is used for this document, the values are formatted.

Document::get_download_link_full() — Method in class Document

Return a download link to the corresponding file

Document::get_download_link() — Method in class Document

Document::get_download_url() — Method in class Document

Document::get_documents_by_category() — Method in class Document

Returns all document objects of the passed category

Document::get_documents_by_search() — Method in class Document

Returns all document objects with the passed tag

Document::get_history() — Method in class Document

Returns a list with all versioned document objects

Document::generate_file_path() — Method in class Document

Document::get_file_path_relative() — Method in class Document

Document::get_file_base_path() — Method in class Document

Document::get_file_path() — Method in class Document

Returns the file path of this or the reference document.

Document::get_webdav_url() — Method in class Document

Document::get_file_url() — Method in class Document

Get File Download URL

Document::get_lock() — Method in class Document

Get the lock of the referenced document

Document::get_thumb_url() — Method in class Document

Returns an url to the thumb of this document if available The thumb is cropped to the passed dimensions. If you need an uncropped version please use get_preview_url

Document::get_thumb_url_if_set() — Method in class Document

Document::get_preview_url() — Method in class Document

Returns an url with a resized preview (not cropped) If you need a cropped image use get_thumb_url() instead

Document::getPreviewFiles() — Method in class Document

Get Preview Files if available for this document

Document::getPreview() — Method in class Document

Document::getPreviews() — Method in class Document

Document::get_preview_pages() — Method in class Document

Generates the preview pages and returns them

Document::get_thumbnail_document() — Method in class Document

Document::getReferenceDocument() — Method in class Document

Document::getReferenceDocumentIndex() — Method in class Document

Document::get_icon_class() — Method in class Document

Document::get_version_download_url() — Method in class Document

Document::get_version_string() — Method in class Document

Document::getBasePath() — Method in class Document

Document::getPreviewStoragePath() — Method in class Document

Document::getPreviewInfo() — Method in class Document

Centralized function to collect all necessary information to allow the frontend to display the content

Document::getModelCollection() — Method in class Document

DocumentMetaField::get_current_values() — Method in class DocumentMetaField

Returns a list of all currently used values

DocumentTemplate::get_available_templates() — Method in class DocumentTemplate

Returns a list with all available templates

DocumentTemplate::get_form() — Method in class DocumentTemplate

FileTemplate::get_template_location() — Method in class FileTemplate

Returns the location relative to the mod storage path, where the uploaded templates are stored.

FileTemplate::get_template_file_content() — Method in class FileTemplate

Preview::getFiles() — Method in class Preview

Preview::getSubtitles() — Method in class Preview

Preview::getProgress() — Method in class Preview

Returns the progress of the conversion if

Preview::getAspectRatio() — Method in class Preview

Preview::getDocument() — Method in class Preview

XfsDocument::get_document() — Method in class XfsDocument

Simple Accessor return XELOS\Modules\SystemDMS\Model\xm_system_dms_document

XfsDocument::get_document_index() — Method in class XfsDocument

Simple Accessor

XfsDocument::get_filename() — Method in class XfsDocument

Simple Accessor

XfsDocument::get_file_url() — Method in class XfsDocument

Generate and return a file_url for this file

XfsDocument::get_local_file_path() — Method in class XfsDocument

Returns the file path of the file in the System DMS filesource

ZipImportJob::get_filename() — Method in class ZipImportJob

Return the basename of the zip file that is to be imported

ZipImportJob::get_target_folder_name() — Method in class ZipImportJob

Return the name of the folder the zip file is to be imported into

ZipImportJob::get_target_folder_url() — Method in class ZipImportJob

ZipImportJob::get_completed_count() — Method in class ZipImportJob

Return the number of files already imported into the DMS

ZipImportJob::get_current_file_count() — Method in class ZipImportJob

Returns the count of files from temp folder which should be imported.

CategoryPage::get_page() — Method in class CategoryPage

DocumentPage::get_page() — Method in class DocumentPage

Shows the default page

SystemDMSController::getTrashPath() — Method in class SystemDMSController

Returns the path to the trash storage.

SystemDMSController::get_allow_add_document() — Method in class SystemDMSController

SystemDMSController::get_show_file_options() — Method in class SystemDMSController

SystemDMSController::get_quota() — Method in class SystemDMSController

Returns a quota object.

SystemDMSController::getShowNavBar() — Method in class SystemDMSController

SystemDMSController::get_current_view_mode() — Method in class SystemDMSController

Get current View Mode

SystemDMSController::get_usage_size() — Method in class SystemDMSController

Get usage size based on folder sizes, can be filtered by group_id optionally, will automatically group if DMS is in group_context

SystemDMSController::guessGroupId() — Method in class SystemDMSController

Guess the group ID by evaluating GP and CMD Vars

SystemDMSController::get_file_url() — Method in class SystemDMSController

SystemDMSController::get_file_link() — Method in class SystemDMSController

SystemDMSController::get_dyn_tree() — Method in class SystemDMSController

SystemDMSController::get_my_documents_folder() — Method in class SystemDMSController

Returns the personal folder for the current user

SystemDMSController::getRootCategory() — Method in class SystemDMSController

SystemDMSController::getXFSRootCategory() — Method in class SystemDMSController

Get the XELOS File Root for attachments and System Files

SystemDMSController::getCommandsForPage() — Method in class SystemDMSController

Return suggestions by categories and documents, filtered by read-level policy and their captions via the search string.

SystemDMSController::getDynTreeParams() — Method in class SystemDMSController

Placeholder method, that simply returns an empty array, in case the user chose a module, which isn't able to provide dynamic tree parameters.

Category::get_description() — Method in class Category

Category::get_full_preview() — Method in class Category

Document::get_title() — Method in class Document

Document::get_description() — Method in class Document

Document::get_image() — Method in class Document

Document::get_full_preview() — Method in class Document

Document::get_title_icon_class() — Method in class Document

Document::getDocumentThumbnail() — Method in class Document

Return Document Video Thumbnail URL*

Document::getVideoStream() — Method in class Document

Returns Video Streams in various formats

DocumentPageSidebar::getDocumentActionsForSidebar() — Method in class DocumentPageSidebar

Generate document actions

FilterPanel::get_current_filter() — Method in class FilterPanel

FilterPanel::get_sql_where() — Method in class FilterPanel

Processes the current filter and generates a WHERE condition for SQL queries on the document table This WHERE condition is used by dependent DMS panels to filter their elements

FilterPanel::get_condition() — Method in class FilterPanel

Returns an array of all document index ids that match the given search from all dms instances Carefull: template conditions can only be found in one specific (the current) instance!!!

FolderTreePanel::get_category_tree() — Method in class FolderTreePanel

Generate a tree array containing all tree elements Used as a callback by the created xui tree

FolderTreePanel::get_matches() — Method in class FolderTreePanel

ViewDocumentDetails::get_document_history_table() — Method in class ViewDocumentDetails

XfsDocument::get_xfs_render_type() — Method in class XfsDocument

Returns the render type of this document.

$ Category#group_id — Property in class Category

$ Document#group_id — Property in class Document

$ DocumentHistory#group_id — Property in class DocumentHistory

$ DocumentTemplate#group_id — Property in class DocumentTemplate

$ ZipImportJob#group_id — Property in class ZipImportJob

AdminSystemMailUserAdminConfig::get() — Method in class AdminSystemMailUserAdminConfig

UserSystemMailUserConfig::get() — Method in class UserSystemMailUserConfig

UserSystemMailUserConfig::get_forward_form() — Method in class UserSystemMailUserConfig

UserSystemMailUserConfig::get_alias_table() — Method in class UserSystemMailUserConfig

NotificationChannel::getStandardSettingsXUI() — Method in class NotificationChannel

NotificationChannel::getName() — Method in class NotificationChannel

NotificationChannel::getDescription() — Method in class NotificationChannel

NotificationChannelInterface::getName() — Method in class NotificationChannelInterface

Returns the name of this channel.

NotificationChannelInterface::getDescription() — Method in class NotificationChannelInterface

User visible description of this channel.

NotificationChannelInterface::getUserSettingsXUI() — Method in class NotificationChannelInterface

Return UI Component for the user to configure this channel and display the current status of this channel

EmailNotificationChannel::getUserSettingsXUI() — Method in class EmailNotificationChannel

TodoPortlet::get_fdl() — Method in class TodoPortlet

If the portlet offers options please supply fdl for options

TodoPortlet::get_html() — Method in class TodoPortlet

SystemNotificationController::getPriorityInfo() — Method in class SystemNotificationController

Get general information about the notification priorities available

SystemNotificationController::getChannels() — Method in class SystemNotificationController

SystemNotificationController::getChannel() — Method in class SystemNotificationController

PushNotificationChannel::getName() — Method in class PushNotificationChannel

Channel Name

PushNotificationChannel::getDescription() — Method in class PushNotificationChannel

PushNotificationChannel::getUserSettingsXUI() — Method in class PushNotificationChannel

Settings for user

SystemPwaController::getManifestLink() — Method in class SystemPwaController

Get URL for PWA Manifest

SystemPwaController::getPushNotificationLink() — Method in class SystemPwaController

Get URL for PWA Manifest

SystemPwaController::getConfiguration() — Method in class SystemPwaController

Get Push Configuration Params

EventCollection::getIterator() — Method in class EventCollection

Collector::getDimensions() — Method in class Collector

Return the available data dimensions for this collector

Collector::getAggregatedDataForDimension() — Method in class Collector

Return the data for each dimension, if you cannot provide data for the requested time or aggregation level

Collector::getTimespan() — Method in class Collector

Returns the start and end datetime of the timestamp for a given aggregation level.

WhoisonlineShowPortlet::get_title() — Method in class WhoisonlineShowPortlet

WhoisonlineShowPortlet::get_fdl() — Method in class WhoisonlineShowPortlet

WhoisonlineShowPortlet::get_html() — Method in class WhoisonlineShowPortlet

EventCollector::getDimensions() — Method in class EventCollector

EventCollector::getAggregatedDataForDimension() — Method in class EventCollector

Return the data for each dimension *

CollectorData::getCollectorDimension() — Method in class CollectorData

CollectorData::getAggregatedData() — Method in class CollectorData

CollectorDimension::getDimensionKey() — Method in class CollectorDimension

CollectorDimension::getDimensionGroupKey() — Method in class CollectorDimension

CollectorDimension::getTitle() — Method in class CollectorDimension

CollectorDimension::getTitleShort() — Method in class CollectorDimension

CollectorDimension::getDescription() — Method in class CollectorDimension

CollectorDimension::getStyle() — Method in class CollectorDimension

CollectorDimension::getType() — Method in class CollectorDimension

AggregateDimension::getCollector() — Method in class AggregateDimension

AggregateDimension::getCollectorDimension() — Method in class AggregateDimension

AggregateDimension::getDataSeries() — Method in class AggregateDimension

AggregateDimension::get_instance_string() — Method in class AggregateDimension

Get Instance ID as string

Event::getModelCollection() — Method in class Event

SystemStatsController::get_users_online() — Method in class SystemStatsController

Returns a list of users which are currently online

SystemStatsController::get_users_online_count() — Method in class SystemStatsController

Returns number of users online

SystemStatsController::getDataSeries() — Method in class SystemStatsController

Returns the time series data for the passed dimension

SystemStatsController::getGroupDataSeries() — Method in class SystemStatsController

AggregationChart::getPlaceholderContent() — Method in class AggregationChart

AggregationChart::getDimensions() — Method in class AggregationChart

AggregationChart::getChartTitle() — Method in class AggregationChart

AggregationChart::getAggregationLevel() — Method in class AggregationChart

Check::get_title() — Method in class Check

Check::get_details() — Method in class Check

Returns all relevant details for this check as title, scope and icon

Check::get_check_result() — Method in class Check

Returns the check results as Result item

Node::get_state() — Method in class Node

Node::get_title() — Method in class Node

Node::get_operation_info() — Method in class Node

OverviewPage::get_page() — Method in class OverviewPage

SystemStatusController::get_system_check_results() — Method in class SystemStatusController

Returns an array of all checks and their last results

SystemStatusController::get_system_status() — Method in class SystemStatusController

Returns the current overall system check across all checks This call does not execute any checks but summarizes all existing check results

SystemStatusController::get_current_node() — Method in class SystemStatusController

Get Node Model for the server this script is running on

GlobalTaskCollection — Class in namespace XELOS\Modules\SystemTasks\Collection

Fake Collection using multiple internal collections to represent virtual tasks board acros instances

GlobalTaskCollection::get_models() — Method in class GlobalTaskCollection

Returns array with objects

GlobalTaskCollection::getSubCollections() — Method in class GlobalTaskCollection

GlobalTaskListCollection — Class in namespace XELOS\Modules\SystemTasks\Collection

Fake Collection using multiple internal collections to represent virtual tasks board acros instances

GlobalTaskListCollection::get_models() — Method in class GlobalTaskListCollection

Returns array with objects

RecurringTaskCollection::getRelatedTaskCollection() — Method in class RecurringTaskCollection

Get tasks related to the recurring tasks

RecurringTaskCollection::get_model() — Method in class RecurringTaskCollection

RecurringTaskCollection::getIterator() — Method in class RecurringTaskCollection

TaskCollection::getRelatedTaskListCollection() — Method in class TaskCollection

Get the lists related to the current task collection

TaskCollection::getRelatedRecurringTaskCollection() — Method in class TaskCollection

Get recurring task information RecurringTaskCollection

TaskCollection::get_model() — Method in class TaskCollection

TaskCollection::getIterator() — Method in class TaskCollection

TaskListCollection::getRelatedTaskCollection() — Method in class TaskListCollection

Get tasks from the current lists

TaskListCollection::getRelatedRecurringTaskCollection() — Method in class TaskListCollection

Get recurring task information RecurringTaskCollection

TaskListCollection::get_model() — Method in class TaskListCollection

TaskListCollection::getIterator() — Method in class TaskListCollection

$ RecurringTaskDocumentation#group_id — Property in class RecurringTaskDocumentation

$ TaskDocumentation#group_id — Property in class TaskDocumentation

CalendarLinkGetEvents::get_events() — Method in class CalendarLinkGetEvents

Returns an object collection of event items

CalendarLinkGetEvents::get_calendars() — Method in class CalendarLinkGetEvents

Get calendars

CalendarLinkGetEvents::get_event_by_id() — Method in class CalendarLinkGetEvents

ContactlogShowSidebar::get_title() — Method in class ContactlogShowSidebar

ContactlogShowSidebar::get_name() — Method in class ContactlogShowSidebar

ContactlogShowSidebar::get_icon_class() — Method in class ContactlogShowSidebar

http://fortawesome.github.io/Font-Awesome/icons/

ContactlogShowSidebar::get_count() — Method in class ContactlogShowSidebar

Returns the count of available tasks within a contact.

ContactlogShowSidebar::get_links() — Method in class ContactlogShowSidebar

Generate a doc link that displays the modal for creating new tasks.

TaskManagementNavigation::getIconClass() — Method in class TaskManagementNavigation

TaskManagementNavigation::getUrlParams() — Method in class TaskManagementNavigation

NewTaskProcessor::get_action() — Method in class NewTaskProcessor

TasksPortlet::get_title() — Method in class TasksPortlet

ShowTasksShowPortlet::get_title() — Method in class ShowTasksShowPortlet

ShowTasksShowPortlet::get_fdl() — Method in class ShowTasksShowPortlet

ShowTasksShowPortlet::get_html() — Method in class ShowTasksShowPortlet

ShowTasksShowPortlet::getPagesMigrationStatus() — Method in class ShowTasksShowPortlet

ShowTasksShowPortlet::getPagesMigrationComponent() — Method in class ShowTasksShowPortlet

ShowTasksShowPortlet::getPagesMigrationHelpText() — Method in class ShowTasksShowPortlet

RecurringTask::getModelCollection() — Method in class RecurringTask

$ Task#group_id — Property in class Task

Task::get_list() — Method in class Task

get model of list this task is assigned to retrun TaskList|null

Task::getIsArchived() — Method in class Task

Is Task considered archived?

Task::get_icon_class() — Method in class Task

Get icon Class for current status

Task::get_comment_count() — Method in class Task

Returns the number of comments for this task

Task::get_attachments() — Method in class Task

Task::getAttachmentsArray() — Method in class Task

Task::get_checklist() — Method in class Task

Get Checklist Array from JSON

Task::get_author() — Method in class Task

Task::get_responsible_user() — Method in class Task

Returns the displayname of the responsible user.

Task::getReferencedTasks() — Method in class Task

tbd: might be useful in ApiService to show subtasks

Task::getTypeOptionList() — Method in class Task

Get OptionList for Type

Task::getPriorityOptionList() — Method in class Task

Get OptionList for Priority

Task::getLabelOptionList() — Method in class Task

Get currently active labels for this task

Task::get_description_html() — Method in class Task

Get description formatted as HTML

Task::getModelCollection() — Method in class Task

$ TaskList#group_id — Property in class TaskList

TaskList::get_readable_lists() — Method in class TaskList

Get all Task Lists

TaskList::get_shared_user() — Method in class TaskList

TaskList::getColumns() — Method in class TaskList

TaskList::get_category_labels() — Method in class TaskList

Backwards compatibility only, This will NOT return the db value but the

TaskList::getTaskLabelOptionList() — Method in class TaskList

TaskList::getModelCollection() — Method in class TaskList

MainPage::get_page() — Method in class MainPage

MainPage::getKanbanWebComponentTpl() — Method in class MainPage

MainPage::getWebComponentBaseConfig() — Method in class MainPage

Generates the Base Config for the Task Web Component + allows to pass additional parameters

SystemTasksController::get_page() — Method in class SystemTasksController

SystemTasksController::guessGroupId() — Method in class SystemTasksController

Guess the group ID by evaluating GP and CMD Vars

Task::get_title_icon_class() — Method in class Task

Return CSS Icon class for title

Task::get_description() — Method in class Task

Task::get_image() — Method in class Task

Task::get_full_preview() — Method in class Task

TasksList::get_title_icon_class() — Method in class TasksList

Return CSS Icon class for title

TasksList::get_description() — Method in class TasksList

Return Document Description

WorkerException::getOperation() — Method in class WorkerException

SystemWorkerController::getConfiguredWorkers() — Method in class SystemWorkerController

Return all available worker classes

SystemWorkerController::getLibreofficeWorker() — Method in class SystemWorkerController

Get LibreofficWorker if possible

SystemWorkerController::getVideoWorker() — Method in class SystemWorkerController

BaseWorker::getWorkerID() — Method in class BaseWorker

BaseWorker::getApiHost() — Method in class BaseWorker

BaseWorker::getWorkerStats() — Method in class BaseWorker

Retrieve current worker stats Currently this is primarily based upon Openswoole (see https://openswoole.com/docs/modules/swoole-server-stats )

BaseWorker::getName() — Method in class BaseWorker

BaseWorker::getIconClass() — Method in class BaseWorker

BaseWorker::getApiClient() — Method in class BaseWorker

BaseWorker::getWorkerPackageMaxLength() — Method in class BaseWorker

Fetches the package_max_length setting from the video worker instance used for comparison with the local setting.

BaseWorker::getLocalPackageMaxLength() — Method in class BaseWorker

Fetches the package max length from the environment variables (most likely the Docker environment) and calculates the length according to the unit.

BaseWorker::getCallbackCheckResult() — Method in class BaseWorker

Sends a request containing the callback URI in order to test, whether the callback can be called from the worker back to XELOS.

BaseWorker::getWorkerRequestLog() — Method in class BaseWorker

Returns the logs of worker requests.

LibreofficeWorker::getIconClass() — Method in class LibreofficeWorker

LibreofficeWorker::getApiClient() — Method in class LibreofficeWorker

VideoWorker::getVideoMetadata() — Method in class VideoWorker

VideoWorker::generatePreviewImages() — Method in class VideoWorker

VideoWorker::getApiClient() — Method in class VideoWorker

VideoWorker::getIconClass() — Method in class VideoWorker

MobileNotificationChannel::getUserSettingsXUI() — Method in class MobileNotificationChannel

Webservice::get_tabs() — Method in class Webservice

Load Access URL for XELOS App NOTE: This is only being used by the APP to get the current links / stati. The menu items themself are being defined in the info() webservice call above

Webservice::get_config() — Method in class Webservice

get config Set

TaggingNavigation::getIconClass() — Method in class TaggingNavigation

TaggingNavigation::getUrlParams() — Method in class TaggingNavigation

CloudShowPortlet::get_title() — Method in class CloudShowPortlet

CloudShowPortlet::get_fdl() — Method in class CloudShowPortlet

CloudShowPortlet::get_html() — Method in class CloudShowPortlet

CloudShowPortlet::getPagesMigrationStatus() — Method in class CloudShowPortlet

CloudShowPortlet::getPagesMigrationComponent() — Method in class CloudShowPortlet

CloudShowPortlet::getPagesMigrationHelpText() — Method in class CloudShowPortlet

Tag::get_document_count() — Method in class Tag

Is only set when retrieved as PopularTag

Tag::getPopularTags() — Method in class Tag

Get Popular Tags with optional filters

Tag::getRelatedTags() — Method in class Tag

Show Tags related to current tag (i.e. tags often combined with current tag)

Tag::getModelCollection() — Method in class Tag

TagPage::get_page() — Method in class TagPage

Standard Get Page Controller

TaggingController::getTagsForDocument() — Method in class TaggingController

Get all tags associated to the given document

TaggingController::getTagLinksForDocument() — Method in class TaggingController

Get Tag Links for document

TaggingController::getDocumentsForTag() — Method in class TaggingController

Get all documents matching a tag

TaggingController::getDocumentsForTagByParentDocument() — Method in class TaggingController

Get all documents matching a tag

TaggingController::getPopularTags() — Method in class TaggingController

Get Popular Tags, e.g. to build Tag Cloud

TaggingController::getLinkToTagPage() — Method in class TaggingController

Returns a link array for the passed tag for its tag page

TaggingController::getURLToTagPage() — Method in class TaggingController

Returns URL for the passed tag for its tag page or null

TaggingController::get_tags() — Method in class TaggingController

TaggingController::get_posts_by_tag() — Method in class TaggingController

TaggingController::get_tag_cloud() — Method in class TaggingController

TaggingController::get_formatted_tag_cloud() — Method in class TaggingController

CommonOperationsTrait::getLangStrings() — Method in class CommonOperationsTrait

Getter for $lang_strings

CommonOperationsTrait::getDbLanguageString() — Method in class CommonOperationsTrait

TranslateProcessor::get_action() — Method in class TranslateProcessor

Get action

BaseTranslationApi::getUrl() — Method in class BaseTranslationApi

BaseTranslationApi::getSourceLanguage() — Method in class BaseTranslationApi

BaseTranslationApi::getContent() — Method in class BaseTranslationApi

BaseTranslationApi::getTargetLanguage() — Method in class BaseTranslationApi

BaseTranslationApi::getTranslatedContent() — Method in class BaseTranslationApi

BaseTranslationApi::getAPIStatus() — Method in class BaseTranslationApi

Deepl::getKey() — Method in class Deepl

Deepl::getAPIStatus() — Method in class Deepl

Transperfect::getKey() — Method in class Transperfect

Transperfect::getUrl() — Method in class Transperfect

Trims the url provided by config value and also removes a trailing slash if present.

Transperfect::getTranslation() — Method in class Transperfect

Queries API and returns result data array

CommonOperationsTrait::getOriginalContent() — Method in class CommonOperationsTrait

Returns the $original_language content if possible

CommonOperationsTrait::getTranslatedContent() — Method in class CommonOperationsTrait

CommonOperationsTrait::getContentForLocale() — Method in class CommonOperationsTrait

Returns the content for the given $locale... if there is any

CommonOperationsTrait::getMissingTranslations() — Method in class CommonOperationsTrait

Determines which language has not translation yet

TranslationFeedback::getSourceModel() — Method in class TranslationFeedback

Returns the source Translation model for which this model is the feedback/improved translation

TranslationFeedback::getSourceContent() — Method in class TranslationFeedback

Get the original content of the source

TranslationFeedback::getSourceLanguage() — Method in class TranslationFeedback

Get the original_language field of the source model

TranslationFeedback::getSourceAutoTranslationForLanguage() — Method in class TranslationFeedback

Get the original auto translation from the source model for $language

FeedbackPage::get_page() — Method in class FeedbackPage

TranslationControllerHelper::getConfig() — Method in class TranslationControllerHelper

Returns the config array for $name

TranslationControllerTest::getTranslatedProvider() — Method in class TranslationControllerTest

TranslationController::getTranslated() — Method in class TranslationController

Get translated $content for $target_language

TranslationController::getTranslationModel() — Method in class TranslationController

Tries to find translation model and a possible existing feedback model.

TranslationController::getTranslationApi() — Method in class TranslationController

Returns the Translation API currently selected in config

TranslationController::getDocumentIndexHtmlContent() — Method in class TranslationController

Returns the fullpreview/html_content of a DocumentIndex object.

TranslationController::getDisableLinkForLanguage() — Method in class TranslationController

Generates a link to set the disabled state for the translation for $language

TranslationController::getTranslationSettingsLink() — Method in class TranslationController

Generates the link to the Auto translation settings page (e.g. used in the user link dropdown)

TranslationController::getFormFieldsTranslationLink() — Method in class TranslationController

Generates the link to auto translate the i18n form fields

TranslationController::getFeedbackLink() — Method in class TranslationController

Generates the link for the translation feedback

ResultCollection::getIterator() — Method in class ResultCollection

TrendvoteCollection::getWebserviceParameterObject() — Method in class TrendvoteCollection

Get generic description of collection for webservice API

TrendvoteCollection::getIterator() — Method in class TrendvoteCollection

$ Trendvote#group_id — Property in class Trendvote

Result::getAnswers() — Method in class Result

Parse the indexes of the given answers into an array.

Result::getModelCollection() — Method in class Result

$ Trendvote#group_id — Property in class Trendvote

Trendvote::getTimingState() — Method in class Trendvote

Returns the current timing state for the trendvote based on its start_at and end_at fields.

Trendvote::getAnswers() — Method in class Trendvote

Decode and return all answers of the trendvote (currently JSON only).

Trendvote::getResults() — Method in class Trendvote

Get corresponding ResultCollection (unloaded)

Trendvote::getModelCollection() — Method in class Trendvote

Trendvote::get_title() — Method in class Trendvote

Return Document Title

Trendvote::get_title_icon_class() — Method in class Trendvote

Return CSS Icon class for title

Trendvote::get_description() — Method in class Trendvote

Return Document Description

Trendvote::get_full_preview() — Method in class Trendvote

Return Full Preview for this document

DigestAuthentication::getConfigurationFDL() — Method in class DigestAuthentication

DigestAuthentication::getDigestPasswordForUser() — Method in class DigestAuthentication

Get current Digest for userId

DigestAuthentication::generateNewDigestPasswordForUser() — Method in class DigestAuthentication

Generate new Digest for User

OAuthServerAction::getScopeSeparator() — Method in class OAuthServerAction

OAuthServerAction::get_authorization_url() — Method in class OAuthServerAction

Return Authorization URL

OAuthServerAction::getEndpointInformation() — Method in class OAuthServerAction

Return Endpoint information to be used in OAuth Flows

Service::getMethodCallback() — Method in class Service

Returns the callback of a method if it is defined.

Service::getMethod() — Method in class Service

Get Service Method

Service::get_service_description() — Method in class Service

Returns the registered webservice methods.

Service::getJsonRpcResponse() — Method in class Service

Method::getInputParameters() — Method in class Method

Method::getOutputParameters() — Method in class Method

Method::getName() — Method in class Method

The name depends on the version. If a version bigger than 1 is set, the method name is suffixed with _v{$versionNumber}

Method::getVersion() — Method in class Method

Method::getCallback() — Method in class Method

Method::getDescription() — Method in class Method

Method::getHttpMethod() — Method in class Method

Method::getResource() — Method in class Method

Method::getResourceId() — Method in class Method

Method::getIsInternal() — Method in class Method

ModelCRUD::generateReadAllMethod() — Method in class ModelCRUD

Wrapper for "$modelCollection->all()" will not perform rights checks, you can pass a scoped collection which implies your rights

ModelCRUD::generateReadMethod() — Method in class ModelCRUD

Wrapper for "model->find_all_by_id()" - Will perform can_read() Check

ModelCRUD::generateCountMethod() — Method in class ModelCRUD

Wrapper for "count_all" - this will NOT apply any read/write checks

ModelCRUD::generateCreateMethod() — Method in class ModelCRUD

ModelCRUD::generateUpdateMethod() — Method in class ModelCRUD

Wrapper for Model Update, will check can_write() before update

ModelCRUD::generateDeleteMethod() — Method in class ModelCRUD

Wrapper for $model->delete() - will perform can_write check

ModelCRUD::generateDeleteAllMethod() — Method in class ModelCRUD

Will delete all models in batch. Does NOT perform access check

ModelMethod::getAttachmentProperties() — Method in class ModelMethod

ParameterObject::getName() — Method in class ParameterObject

Returns the object name

ParameterObject::getMembers() — Method in class ParameterObject

Returns the defined members.

ParameterObject::getMemberXQL() — Method in class ParameterObject

ParameterObject::getMemberExpandClosure() — Method in class ParameterObject

ParameterObject::getFilterClosure() — Method in class ParameterObject

ParameterObject::getFilterParameter() — Method in class ParameterObject

ParameterObject::getFilters() — Method in class ParameterObject

XQL::getFilter() — Method in class XQL

XQL::getPaginationLimit() — Method in class XQL

XQL::getPaginationStart() — Method in class XQL

XQL::getPaginationSeekUUID() — Method in class XQL

XQL::getPaginationSeekValue() — Method in class XQL

XQL::getPaginationOrderField() — Method in class XQL

XQL::getPaginationOrderDirection() — Method in class XQL

OAuthClientHook::getDescription() — Method in class OAuthClientHook

Get description for the OAuth Client Hook will be used in create modal client

OAuthClientHook::getTitle() — Method in class OAuthClientHook

Get title for the OAuth Client Hook will be used in create modal client

OAuthClientHook::getIconClass() — Method in class OAuthClientHook

Get icon for the OAuth Client Hook will be used in create modal client

OAuthClientHook::getConnectedClient() — Method in class OAuthClientHook

Get connected client which belongs to specific oauth hook.

OAuthClientHook::getOAuthModel() — Method in class OAuthClientHook

OAuthClientHook::getOAuthClient() — Method in class OAuthClientHook

OAuthClientHook::get_connection_fdl() — Method in class OAuthClientHook

TODO: What if the service requires the user to enter something during the connection?

ServiceInterface::get_service_description() — Method in class ServiceInterface

OAuthClient::getClientId() — Method in class OAuthClient

Get application's Client ID.

OAuthClient::getClientSecret() — Method in class OAuthClient

Get application's Client Secret

OAuthClient::getRedirectUrl() — Method in class OAuthClient

OAuthClient::getAuthorizeUrl() — Method in class OAuthClient

OAuthClient::getAccessTokenUrl() — Method in class OAuthClient

OAuthClient::getScope() — Method in class OAuthClient

OAuthClient::getScopeArray() — Method in class OAuthClient

Returns the scope as array.

OAuthClient::getState() — Method in class OAuthClient

OAuthClient::getRefreshToken() — Method in class OAuthClient

OAuthClient::getExpires() — Method in class OAuthClient

OAuthClient::getCode() — Method in class OAuthClient

OAuthClient::getPostLogoutRedirectUrl() — Method in class OAuthClient

OAuthClient::getEndSessionUrl() — Method in class OAuthClient

OAuthClient::getJwksUrl() — Method in class OAuthClient

OAuthClient::getIssuerUrl() — Method in class OAuthClient

OAuthClient::getUserinfoEndpointUrl() — Method in class OAuthClient

OAuthClient::getAccessToken() — Method in class OAuthClient

Function to test connection directly to an oauth server

OAuthClient::getAccessTokenAsString() — Method in class OAuthClient

OAuthClient::getIdToken() — Method in class OAuthClient

Get potential ID Token (OIDC)

OAuthClient::getAuthorizationUrl() — Method in class OAuthClient

Start Authorization Code Grant flow (redirect to authorizeUrl)

OAuthProvider::getAuthorizationParameters() — Method in class OAuthProvider

Returns authorization parameters based on provided options.

OpenIDConfiguration::getAuthorizationEndpoint() — Method in class OpenIDConfiguration

Get Authorization Endpoint

OpenIDConfiguration::getTokenEndpoint() — Method in class OpenIDConfiguration

Get AccessToken Endpoint

OpenIDConfiguration::getJwksUri() — Method in class OpenIDConfiguration

Get JSON Web Key Set Uri

OpenIDConfiguration::getIssuerUri() — Method in class OpenIDConfiguration

Get IssuerUri

OpenIDConfiguration::getEndSessionEndpoint() — Method in class OpenIDConfiguration

Get Logout Endpoint

OpenIDConfiguration::getUserinfoEndpoint() — Method in class OpenIDConfiguration

Get Userinfo Endpoint

OauthAccess::get_connected_accounts_sql() — Method in class OauthAccess

OauthAccess::get_oauth_client() — Method in class OauthAccess

OauthAccess::get_client_from_oauth_data() — Method in class OauthAccess

OauthAccess::getHook() — Method in class OauthAccess

Get the hook corresponding to this OAuth Access

OauthAccess::generateToken() — Method in class OauthAccess

Generate a random string with id prefix for identification/lookup

AuthorizePage::get_page() — Method in class AuthorizePage

Standard Get Page Controller

JsonPage::get_page() — Method in class JsonPage

JsonPage::get_json_error() — Method in class JsonPage

JSON-RPC Error

JsonPage::getModuleServiceHook() — Method in class JsonPage

RestPage::get_page() — Method in class RestPage

WebserviceController::get_page() — Method in class WebserviceController

WebserviceController::getConnectedClientsTable() — Method in class WebserviceController

Returns a table which contains all connected oauth clients.

WebserviceController::getConnectedClientsCount() — Method in class WebserviceController

Returns the number of connected clients

WebserviceController::getDisconnectedClientLinks() — Method in class WebserviceController

WebserviceController::get_soap_client() — Method in class WebserviceController

WebserviceController::get_delimiter() — Method in class WebserviceController

Returns Func Delimiter used to separate instance/function/portname

WebserviceController::get_oauth_info() — Method in class WebserviceController

Get OAuth Info

WidgetsPortlet::get_title() — Method in class WidgetsPortlet

WidgetsPortlet::get_fdl() — Method in class WidgetsPortlet

Get Config from this portlet

WidgetsPortlet::get_html() — Method in class WidgetsPortlet

Get HTML

CategoryWidgetShowPortlet::get_title() — Method in class CategoryWidgetShowPortlet

Get the title

CategoryWidgetShowPortlet::get_fdl() — Method in class CategoryWidgetShowPortlet

Form definition language

CategoryWidgetShowPortlet::get_html() — Method in class CategoryWidgetShowPortlet

Get HTML

CategoryWidgetShowPortlet::getPagesMigrationStatus() — Method in class CategoryWidgetShowPortlet

CategoryWidgetShowPortlet::getPagesMigrationComponent() — Method in class CategoryWidgetShowPortlet

CategoryWidgetShowPortlet::getPagesMigrationHelpText() — Method in class CategoryWidgetShowPortlet

PortletWidgetsShowPortlet::get_title() — Method in class PortletWidgetsShowPortlet

Get the title

PortletWidgetsShowPortlet::get_fdl() — Method in class PortletWidgetsShowPortlet

Form definition language

PortletWidgetsShowPortlet::get_html() — Method in class PortletWidgetsShowPortlet

Get HTML

PortletWidgetsShowPortlet::getPagesMigrationStatus() — Method in class PortletWidgetsShowPortlet

PortletWidgetsShowPortlet::getPagesMigrationComponent() — Method in class PortletWidgetsShowPortlet

PortletWidgetsShowPortlet::getPagesMigrationHelpText() — Method in class PortletWidgetsShowPortlet

Widget::get_icon_url() — Method in class Widget

Get icon URL

SettingsPage::getTable() — Method in class SettingsPage

HeaderFieldsAction::get_fdl() — Method in class HeaderFieldsAction

HeaderFieldsAction::getFieldLabels() — Method in class HeaderFieldsAction

Returns all set field labels. Fields with empty labels are not returned.

ExampleBeatTheSystemController::get_page() — Method in class ExampleBeatTheSystemController

Return the Content for a given page

CmsSimplePortletShowPortlet::get_fdl() — Method in class CmsSimplePortletShowPortlet

If the portlet offers options please supply fdl for options

CmsSimplePortletShowPortlet::get_title() — Method in class CmsSimplePortletShowPortlet

CmsSimplePortletShowPortlet::get_html() — Method in class CmsSimplePortletShowPortlet

Survey::get_survey_stats() — Method in class Survey

Return statistical information about this survey

H

Autoloader::hasXelosNamespace() — Method in class Autoloader

Returns true if the passed class is in the XELOS namespace

MultiFactorAuthentication::handleAuthentication() — Method in class MultiFactorAuthentication

Handle the MFA authentication, e.g. ask for the second factor and validate it

$ CommandDefinition#handler — Property in class CommandDefinition

CommandSet::hasCommandDefinition() — Method in class CommandSet

Help — Class in namespace XELOS\Framework\Core\Console\Command

Class Help

Input::hasCommand() — Method in class Input

Input::hasVendorName() — Method in class Input

Input::hasModuleName() — Method in class Input

Input::hasArgument() — Method in class Input

Input::hasOption() — Method in class Input

Output::hasVerbosity() — Method in class Output

Returns true if the current verbosity includes the passed verbosity level

Output::h1() — Method in class Output

Output::h2() — Method in class Output

Output::h3() — Method in class Output

Core::has_hook_access() — Method in class Core

Checks if the user has access to the hook

Core::hasDependency() — Method in class Core

Does module have an existing dependency

Enum::has() — Method in class Enum

Check if the enum has the given value

ContentException::handle_exception() — Method in class ContentException

$ Template#html_blocks — Property in class Template

Template::handle_custom_namespace() — Method in class Template

This function is used to fund

$ VarsTemplate#hash: — Property in class VarsTemplate

stored in MySQL as binary

ModulePortlet::handleDeletedDocumentReferences() — Method in class ModulePortlet

When a CMS component, the document index references are checked to make sure that the uploaded documents are deleted.

DocumentModel::handle_reference_delete() — Method in class DocumentModel

Function is called in routine as part of the index event 'delete' Be aware that the original referenced document will not exist at time of calling This event/callback gives the opportunity to clean up the existing reference (e.g. you are referencing to this document and it you need to act upond this element being deleted)

Model::hasExistingDatabaseRecord() — Method in class Model

Does this model represent an existing database record? (can be updated)

Model::hasTouchedProperties() — Method in class Model

Returns true if at least one property is marked as changed

Model::hasChangedProperties() — Method in class Model

$ SetupPage#hide_continue_button — Property in class SetupPage

SystemDaemon::halt() — Method in class SystemDaemon

SystemDaemonThreaded::handleProcessThread() — Method in class SystemDaemonThreaded

Default Entry Point for each Thread which covers the basic abort checks and thread lifetime handling

MySQLAdapter::hasUtf8mb4Support() — Method in class MySQLAdapter

Returns true if the current mySQL server supports utf8mb4 (Emoji)

MySQLAdapter::hasJsonSupport() — Method in class MySQLAdapter

Does this mysql server support JSON fields?

MySQLAdapter::hasUuidBinSupport() — Method in class MySQLAdapter

Is UUID_TO_BIN and BIN_TO_UUID available?

MySQLAdapter::hasIntDisplayWidthSupport() — Method in class MySQLAdapter

Display width specification for integer data types was deprecated in MySQL 8.0.17

Query::hasScopeWhere() — Method in class Query

Check if a specific whereScope has been applied to the collection

Query::hasJoins() — Method in class Query

$ Lib#hierarchy — Property in class Lib

$ Lib#html — Property in class Lib

Convert::html_to_latex() — Method in class Convert

Converts basic HTML tags to the LATEX syntax

$ Debug#haltOnBreakpoint — Property in class Debug

Debug::haltOnNextBreakpoint() — Method in class Debug

If called the execution will stop on the next setBreakpoint() call and prints the passed output

Doclink::handle_doclink_url() — Method in class Doclink

Foaf::hide_connection() — Method in class Foaf

Format::html_to_imgresized() — Method in class Format

DEPRECATED - Please use >image_resize_parse

Format::highlight_search_words() — Method in class Format

Hierarchy — Class in namespace XELOS\Framework\XF\Lib

Helper for Data from Sys::Hierarchy

Html — Class in namespace XELOS\Framework\XF\Lib

HTML Helper Functions

HtmlMailFormatter — Class in namespace XELOS\Framework\XF\Lib\Logger\Formatter

HandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger

Class HandlerFactory

HandlerFactoryInterface — Class in namespace XELOS\Framework\XF\Lib\Logger\Interfaces

Interface HandlerFactoryInterface

$ Logger#handlers — Property in class Logger

Logger::handleException() — Method in class Logger

$ Mail#host — Property in class Mail

$ Mail#helo — Property in class Mail

$ NotificationBuilder#htmlToken — Property in class NotificationBuilder

Text::htmlentities() — Method in class Text

Convert all applicable characters to HTML entities

Validate::hex_color() — Method in class Validate

Token::hasTranslation() — Method in class Token

Returns true if a translation for the passed locale exists

$ Model#hierarchy — Property in class Model

$ Model#hierarchy_context — Property in class Model

$ Model#hierarchy_user — Property in class Model

$ Model#hook_registry — Property in class Model

$ DocumentIndex#hasPrefetchRightsContexts — Property in class DocumentIndex

DocumentIndex::has_related_document() — Method in class DocumentIndex

DocumentIndex::hasAccessibleDependencyInstanceRelation() — Method in class DocumentIndex

Check wether we have a dependency relation for this document, which is active and accessible to the current user

DocumentIndex::handle_reference_delete() — Method in class DocumentIndex

Function is called in routine as part of the index event 'delete' Be aware that the original referenced document will not exist at time of calling This event/callback gives the opportunity to clean up the existing reference (e.g. you are referencing to this document and it you need to act upond this element being deleted)

DocumentIndexReference::hasRequiredLevel() — Method in class DocumentIndexReference

Does this reference fulfill the minimum requirement and does target/attachment allow this level?

Hierarchy — Class in namespace XELOS\Framework\XF\System\Model

HierarchyContext — Class in namespace XELOS\Framework\XF\System\Model

HierarchyUser — Class in namespace XELOS\Framework\XF\System\Model

HookRegistry — Class in namespace XELOS\Framework\XF\System\Model

Class HookRegistry

$ Notification#html — Property in class Notification

OnboardingCode::hasClearTextPIN() — Method in class OnboardingCode

The object will have the cleartext pin component only after generation. When this code was loaded from DB the code is not readable

$ Pages#hidden — Property in class Pages

$ UI#html — Property in class UI

$ Breadcrumb#hide_links — Property in class Breadcrumb

$ DocumentList#has_legacy — Property in class DocumentList

$ FacetedCategory#hasMoreItems — Property in class FacetedCategory

FacetedCategory::hasItems() — Method in class FacetedCategory

Are FacetedCategoryItems defined?

FacetedCategory::hasCallback() — Method in class FacetedCategory

Does category have a callback?

FacetedCategoryDate::hasItems() — Method in class FacetedCategoryDate

DateFilter do not have or need items

FacetedCategoryTextSearch::hasItems() — Method in class FacetedCategoryTextSearch

Text search fields do not have or need items

Form::handle_ajax_response() — Method in class Form

FormEditor::hide_i18n_switcher() — Method in class FormEditor

FormComponent::hasCombinedInputFields() — Method in class FormComponent

Does this component use combined input fields which required special handling from form?

FormComponent::hasRequiredStyle() — Method in class FormComponent

Return if the component should be shown as required with specified style class.

FormConfig::hasCombinedInputFields() — Method in class FormConfig

Does this component use combined input fields which required special handling from form?

FormFile::hasThumbnail() — Method in class FormFile

Returns TRUE if a thumbnail should be displayed.

$ FormRowRenderer#hide_labels — Property in class FormRowRenderer

FormRrule::hasCombinedInputFields() — Method in class FormRrule

FroalaOption::height() — Method in class FroalaOption

Set a height for the rich text editor's editing box.

FroalaOption::heightMax() — Method in class FroalaOption

Set a maximum height for the rich text editor's editing box.

FroalaOption::heightMin() — Method in class FroalaOption

Set a minimum height for the rich text editor's editing box.

FroalaOption::htmlAllowComments() — Method in class FroalaOption

Allow comments inside the edited HTML.

FroalaOption::htmlAllowedAttrs() — Method in class FroalaOption

The list of allowed attributes to be used for tags.

FroalaOption::htmlAllowedEmptyTags() — Method in class FroalaOption

The list of tags that are not removed when they have no content inside.

FroalaOption::htmlAllowedStyleProps() — Method in class FroalaOption

The list of allowed CSS attributes to be used for tags.

FroalaOption::htmlAllowedTags() — Method in class FroalaOption

The list of allowed tags.

FroalaOption::htmlDoNotWrapTags() — Method in class FroalaOption

The list of tags that should not be wrapped inside block tags.

FroalaOption::htmlExecuteScripts() — Method in class FroalaOption

Allow running scripts that are entered in Code View.

FroalaOption::htmlIgnoreCSSProperties() — Method in class FroalaOption

A list of CSS properties to be ignored when useClasses option is disabled and the CSS from external stylesheets is converted to inline style.

FroalaOption::htmlRemoveTags() — Method in class FroalaOption

The list of tags that are removed together with their content.

FroalaOption::htmlSimpleAmpersand() — Method in class FroalaOption

Allows the usage of simple ampersands (&) instead of the relative HTML entity (&amp;). This is not recommended by the W3C XHTML specifications, so this option should remain false whenever possible.

FroalaOption::htmlUntouched() — Method in class FroalaOption

Leave the HTML inside the editor untouched without doing any special processing to it except HTML cleaning.

FroalaOption::helpSets() — Method in class FroalaOption

An object of items to show in the help modal.

Html — Class in namespace XELOS\Framework\XF\UI

HtmlGeneric — Class in namespace XELOS\Framework\XF\UI

HtmlTree — Class in namespace XELOS\Framework\XF\UI

Wrapper class for Html->get_tree() usable by xtags

HtmlUlList — Class in namespace XELOS\Framework\XF\UI

Wrapper class for Html->ul_list() usable by xtags

ImageEdit::handle_document_creation() — Method in class ImageEdit

$ Table#hidden_array_sort_field — Property in class Table

$ Table#hide_head_rows — Property in class Table

Table::hide_head_rows() — Method in class Table

TableRow::hide_field() — Method in class TableRow

TableActionHandler::hasBulkAction() — Method in class TableActionHandler

Do we have a registered Bulk Action?

TableActionHandler::hasRowAction() — Method in class TableActionHandler

$ UserImage#height — Property in class UserImage

The height of the image in pixel.

$ UserImage#href — Property in class UserImage

User::hash_password() — Method in class User

Hash the password for the user database with bcrypt

User::has_access() — Method in class User

User::has_policy() — Method in class User

User::has_policy_by_security_level() — Method in class User

User::has_tree_policy() — Method in class User

View::handle_special_page() — Method in class View

$ Page#hierarchy — Property in class Page

Page::hierarchy() — Method in class Page

UserAccountUserConfig::hidden() — Method in class UserAccountUserConfig

UserAccountUserConfig::hideOwnerField() — Method in class UserAccountUserConfig

UserAdvancedUserAdminConfig::hideDeleteUserSection() — Method in class UserAdvancedUserAdminConfig

functions to hide some fields

UserAdvancedUserAdminConfig::hideUserMetaSection() — Method in class UserAdvancedUserAdminConfig

UserAdvancedUserAdminConfig::hideUserConfigSection() — Method in class UserAdvancedUserAdminConfig

UserDevicesUserConfig::hidden() — Method in class UserDevicesUserConfig

UserGroupsUserAdminConfig::hideLinkToGroupsAdmin() — Method in class UserGroupsUserAdminConfig

UserLanguageUserConfig::hidden() — Method in class UserLanguageUserConfig

UserPolicyUserAdminConfig::hidden() — Method in class UserPolicyUserAdminConfig

UserAdminConfig::hidden() — Method in class UserAdminConfig

Is Tab hidden?

HierarchyPage — Class in namespace XELOS\Modules\Administration\Page

ApiCloudstorageController::has_cloud_service_provider() — Method in class ApiCloudstorageController

Returns true if the provider exists, otherwise false.

StorageProvider::hideWhenDisconnected() — Method in class StorageProvider

ApiCloudstorageDocumentBrowser::handle_selection() — Method in class ApiCloudstorageDocumentBrowser

OnedriveBusinessStorageProvider::hideWhenDisconnected() — Method in class OnedriveBusinessStorageProvider

$ Action#helper — Property in class Action

Action::helper() — Method in class Action

$ SyncSetting#hook_name: — Property in class SyncSetting

stored in MySQL as varchar

$ SyncSetting#hook_identity_id: — Property in class SyncSetting

stored in MySQL as text

$ Action#history — Property in class Action

Action::history() — Method in class Action

$ Model#history — Property in class Model

$ Model#history_component — Property in class Model

$ Model#history_page — Property in class Model

Model::history() — Method in class Model

Model::history_component() — Method in class Model

Model::history_page() — Method in class Model

$ Page#history — Property in class Page

Page::history() — Method in class Page

History — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model history.

HistoryComponent — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model history_component.

$ HistoryComponent#history_id — Property in class HistoryComponent

HistoryPage — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model history_page.

$ HistoryPage#history_id — Property in class HistoryPage

$ HistoryPage#head_tags: — Property in class HistoryPage

stored in MySQL as text

$ Page#head_tags: — Property in class Page

stored in MySQL as text

$ Page#hide_in_dyn_nav: — Property in class Page

stored in MySQL as tinyint

$ PageLive#head_tags: — Property in class PageLive

stored in MySQL as text

$ PageLive#hide_in_dyn_nav: — Property in class PageLive

stored in MySQL as tinyint

RegistrationAction::handle_process() — Method in class RegistrationAction

Handle process

EventCollection::hasFilterStart() — Method in class EventCollection

Is collection filtered by startAndEnd? This function is NOT filterung futureEvents, its purpose is to detect a manual date scope (facet)

EventplannerController::handle_invitation_reply() — Method in class EventplannerController

Sets the participant status in the event

ProcessParticipantAction::has_ui_action() — Method in class ProcessParticipantAction

UpdateThreadAction::has_ui_action() — Method in class UpdateThreadAction

Category::hasSubCategories() — Method in class Category

Checks if the current Categorie has any subcategories

Category::hasTreePolicy() — Method in class Category

$ GeoFeature#houseNumber — Property in class GeoFeature

$ Group#head_color: — Property in class Group

stored in MySQL as varchar

$ Group#head_icon: — Property in class Group

stored in MySQL as varchar

Hidden — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

EnsureFormPayloadAction::has_ui_action() — Method in class EnsureFormPayloadAction

SetFieldAction::has_ui_action() — Method in class SetFieldAction

ShowFormAction::has_ui_action() — Method in class ShowFormAction

ListProperties::hasField() — Method in class ListProperties

Has this list a field of a certain type?

ListProperties::hasPresets() — Method in class ListProperties

$ Action#hierarchy — Property in class Action

Action::hierarchy() — Method in class Action

$ Page#hierarchy — Property in class Page

Page::hierarchy() — Method in class Page

$ PropertyGroup#hide_empty_fields: — Property in class PropertyGroup

stored in MySQL as tinyint

$ PropertyGroup#hide_privacy_fields: — Property in class PropertyGroup

stored in MySQL as tinyint

$ PropertyTab#hidden: — Property in class PropertyTab

stored in MySQL as tinyint

HasLabelsInterface — Class in namespace XELOS\Modules\Lookbook\Interfaces

Interface HasLabelsInterface

HasLabelsInterface::hasLabels() — Method in class HasLabelsInterface

Return whether the field is configured to use labels.

HasLabelsTrait — Class in namespace XELOS\Modules\Lookbook\Interfaces

HasLabelsTrait::hasLabels() — Method in class HasLabelsTrait

Returns whether the field is configured to use labels.

Article::handle_reference_delete() — Method in class Article

An attached document was deleted

Article::hasComments() — Method in class Article

Checks if there are existing comments for this article

PageApiAction::handleAPICallsForPage() — Method in class PageApiAction

$ PageDocumentation#hidden: — Property in class PageDocumentation

stored in MySQL as tinyint

$ Page#hidden — Property in class Page

Page::hasPermissions() — Method in class Page

Does this page have permission set?

Page::hasTemporaryUrlKey() — Method in class Page

Checks if the current UrlKey is only temporary

PageVersion::hasDifferences() — Method in class PageVersion

Compares the two pageVersions and returns true if they have differences (e.g. other title or content)

HistoryAction — Class in namespace XELOS\Modules\Search\Action

Class HistoryAction

$ Action#history — Property in class Action

Action::history() — Method in class Action

AbstractDocumentBrowser::handle_selection() — Method in class AbstractDocumentBrowser

This method is called after the selection in the browser is submitted by the user. This method give the possibility to handle the selected files before they will be processed by further submit handling.

$ BrowserFolder#has_children — Property in class BrowserFolder

BrowserFolder::has_children() — Method in class BrowserFolder

Returns whether this folder has sub folders or not.

$ Page#history — Property in class Page

Page::history() — Method in class Page

HistoryPage — Class in namespace XELOS\Modules\SmartWiki\Page

HistoryPage::history_table_edited_by_cb() — Method in class HistoryPage

HistoryPage::history_table_updated_at_cb() — Method in class HistoryPage

HistoryPage::history_table_changes_cb() — Method in class HistoryPage

HistoryPage::history_table_compare_cb() — Method in class HistoryPage

$ Model#hidden_instance — Property in class Model

Model::hidden_instance() — Method in class Model

$ Page#history — Property in class Page

Page::history() — Method in class Page

HiddenInstanceDocumentation — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\Model

This file provides property and method documentation for the model hidden_instance.

HiddenInstance — Class in namespace XELOS\Modules\SystemActionlog\Model

Class XELOS\Modules\SystemActionlog\Model\xmodel_system_actionlog_hidden_instance

HistoryPage — Class in namespace XELOS\Modules\SystemActionlog\Page

$ SystemActionlogController#hide_unresolvable_links — Property in class SystemActionlogController

$ SystemActionlogController#hide_sidebar — Property in class SystemActionlogController

$ SystemActionlogController#hide_timeline — Property in class SystemActionlogController

$ EventTrigger#hook_name: — Property in class EventTrigger

stored in MySQL as varchar

$ EventTrigger#hook_module: — Property in class EventTrigger

stored in MySQL as varchar

$ EventTrigger#hook_instance: — Property in class EventTrigger

stored in MySQL as varchar

UnzipAction::handleJob() — Method in class UnzipAction

Handles a zip import job which has the status waiting or prepared.

ApiService::handleFileUpload() — Method in class ApiService

Handle the file upload using PUT request method

Category::handle_reference_delete() — Method in class Category

Document::handle_reference_delete() — Method in class Document

SystemDMSController::hasDefaultAccess() — Method in class SystemDMSController

Returns true if the default access is allowed, otherwise false.

FolderTreePanel::has_or_contains_matches() — Method in class FolderTreePanel

$ Category#has_policy — Property in class Category

: stored in MySQL as tinyint

$ ZipImportJob#hidden — Property in class ZipImportJob

: stored in MySQL as tinyint

$ UserSystemMailUserConfig#hidden — Property in class UserSystemMailUserConfig

$ AggregateDimensionDocumentation#hook_name — Property in class AggregateDimensionDocumentation

Task::handle_reference_delete() — Method in class Task

We will delete tasks which were added as tasks TO a certain document if that document gets deleted. (Type=1 References)

$ TranslationDocumentDocumentation#hash: — Property in class TranslationDocumentDocumentation

stored in MySQL as varchar

$ TranslationDocumentation#hash: — Property in class TranslationDocumentation

stored in MySQL as varchar

$ TranslationFeedbackDocumentation#hash: — Property in class TranslationFeedbackDocumentation

stored in MySQL as varchar

BaseTranslationApi::hasFeedbackLoop() — Method in class BaseTranslationApi

Transperfect::hasFeedbackLoop() — Method in class Transperfect

TranslationController::hasFeedbackLoop() — Method in class TranslationController

OAuthServerAction::hasScopeAccess() — Method in class OAuthServerAction

ParameterObject::hasMember() — Method in class ParameterObject

ParameterObject::hasFilter() — Method in class ParameterObject

XQL::hasFilter() — Method in class XQL

XQL::hasPagination() — Method in class XQL

XQL::hasPaginationSeek() — Method in class XQL

XQL::hasDebug() — Method in class XQL

OAuthClientHook::hasConnectedClient() — Method in class OAuthClientHook

Check wether the user has a connected OAuth Client

OAuthClient::hasExpired() — Method in class OAuthClient

JsonPage::handleFileUploadToSystemDMS() — Method in class JsonPage

Small endpoint wrapper to call the upload service

HeaderFieldsAction — Class in namespace XELOS\Modules\Workflows\Hook\Workflows

HeaderFieldsActionTest — Class in namespace XELOS\Modules\Workflows\Tests

This unit test checks the public methods of the HeaderFieldsAction.

I

InviteAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

IpAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

MultiFactorAuthentication::instance() — Method in class MultiFactorAuthentication

Using a singleton pattern here to make sure that we know the state during a request We might see multiple configurations causing the MFA to trigger twice

MultiFactorAuthentication::isInUse() — Method in class MultiFactorAuthentication

Is it generally possible to use MFA? either required or optinally?

MultiFactorAuthentication::isTOTPAllowed() — Method in class MultiFactorAuthentication

Could the user use TOTP to secure the login?

MultiFactorAuthentication::isRequired() — Method in class MultiFactorAuthentication

Is a multifactor authentication required for the current request?

NtlmAuthentication::isAvailable() — Method in class NtlmAuthentication

Check wether NTLM Auth should be used for the current request or not

I18n — Class in namespace XELOS\Framework\Core\Console\Command

Class I18n

Info — Class in namespace XELOS\Framework\Core\Console\Command

Class Info

Install — Class in namespace XELOS\Framework\Core\Console\Command

Class Install

$ Console#input — Property in class Console

InvalidArgumentException — Class in namespace XELOS\Framework\Core\Console\Exception

Class InvalidArgumentException

InvalidOptionException — Class in namespace XELOS\Framework\Core\Console\Exception

Class InvalidOptionException

Input — Class in namespace XELOS\Framework\Core\Console

Class Input

Input::isInteractive() — Method in class Input

Input::isAskingForHelp() — Method in class Input

Input::isVerbose() — Method in class Input

$ Core#instance_copy_id — Property in class Core

Core::init() — Method in class Core

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

Core::isXlabsFeaturePreview() — Method in class Core

Enum::is() — Method in class Enum

Check if the enum is the given value

AuthenticationException::isAuthenticationMethodActiveDirectory() — Method in class AuthenticationException

True, if authentication method is Active Directory

InsufficientRightsException — Class in namespace XELOS\Framework\Core\Exception

Class InsufficientRightsException

InvalidClassException — Class in namespace XELOS\Framework\Core\Exception

InvalidMethodCallOrderException — Class in namespace XELOS\Framework\Core\Exception

Use this Exception if a method is present but not used as intended (e.g. wrong order or context)

I18nTokenHelper — Class in namespace XELOS\Framework\Core\Helper

MagicDocumentHelper::isVideo() — Method in class MagicDocumentHelper

MagicDocumentHelper::isImage() — Method in class MagicDocumentHelper

SerializedObjectHelper::isUnserializableArray() — Method in class SerializedObjectHelper

IndexEventInterface — Class in namespace XELOS\Framework\Core\Interfaces

ItemInterface — Class in namespace XELOS\Framework\Core\Interfaces

ItemListInterface — Class in namespace XELOS\Framework\Core\Interfaces

Template::init_template_vars() — Method in class Template

put your comment there.

Template::is_final_render_call() — Method in class Template

Is the current render cycle the last cycle? (i.e. initiated from view)

Template::initBaseTemplate() — Method in class Template

Initialize common basic template markers like wwwres folders, system name and settings

ItemListTrait — Class in namespace XELOS\Framework\Core\Traits

ItemTrait — Class in namespace XELOS\Framework\Core\Traits

$ ObjectManager#injection_objects — Property in class ObjectManager

This is an assoc array and contains objects that will be injected into each requested object. Each containing object will be injected by the name of the key. E.g. ['mod' => $object] this would inject the property named mod with the value of $object.

$ VarsTemplate#id — Property in class VarsTemplate

$ VarsTemplate#instance_id: — Property in class VarsTemplate

stored in MySQL as varchar

$ VarsTemplate#is_custom — Property in class VarsTemplate

VarsTemplate::init() — Method in class VarsTemplate

BaseHook::isAvailable() — Method in class BaseHook

Returns true if this hook is available otherwise false.

IndexEventHook — Class in namespace XELOS\Framework\Module\Hook

Class IndexEventHook

IndexEventHook::isAvailable() — Method in class IndexEventHook

Returns true if this hook is available otherwise false.

$ ModulePortlet#isEmpty — Property in class ModulePortlet

Can be set with setIsEmpty() and should be set to true if there is no data for this portlet It is used by the frontend to allow hiding elements if empty

ModulePortlet::init() — Method in class ModulePortlet

ModulePortlet::isAvailable() — Method in class ModulePortlet

ModulePortlet::isEmpty() — Method in class ModulePortlet

Returns true if the portlet returns an empty result (is used be the frontend to hide empty elements)

ModulePortlet::isPagesContext() — Method in class ModulePortlet

Is this portlet used in pages?

ModulePortlet::isPagesEditorContext() — Method in class ModulePortlet

Is this portlet currently used in pages editor?

NavigationHook::isAvailable() — Method in class NavigationHook

Dynamic check for each derived hook, checking, whether the page (or the primary link) is available at all.

InstallEvents — Class in namespace XELOS\Framework\Module

Class InstallEvents

InstallEvents::initializeAfterInstall() — Method in class InstallEvents

Only called when module is installed

InstallEvents::isVersionLessThan() — Method in class InstallEvents

Returns true if the given old revision relates to an older version then the given version.

InstallEvents::isVersionGreaterThan() — Method in class InstallEvents

Returns true if the given old revision relates to an newer version then the given version.

$ Collection#isDocumentModel — Property in class Collection

Collection::init() — Method in class Collection

Use init for default sort order of your collection

DocumentModel::isAuditingEnabled() — Method in class DocumentModel

If Auditing is disabled on global rule, the automatic implementation will also disable auditing on document model level If you want a model which is auditing ALWAYS you are advised to override this function and return true on your own conditions you may use define('FORCE_AUDIT_MODE',true) in config.custom.php to force auditing for all instances

AuditableInterface::initAuditableTrait() — Method in class AuditableInterface

IndexableByHooksInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

Models implementing this interface show that the document may be passed to additional processors during indexing.

IndexableDocumentInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

General Index Document Models should have a document_registry entry in config.yml

SoftDeleteInterface::initSoftDeleteTrait() — Method in class SoftDeleteInterface

Model::init() — Method in class Model

Initializes the model

ModelCollection::is_loaded() — Method in class ModelCollection

Returns true if this collection has been filled

ModelCollection::invoke() — Method in class ModelCollection

Calls the passed method for each object

ModelCollection::isScopeable() — Method in class ModelCollection

Returns true if the collection has no manual modifications yet

AuditableTrait::initAuditableTrait() — Method in class AuditableTrait

Init Method

AuditableTrait::isAuditingEnabled() — Method in class AuditableTrait

Determine whether auditing is enabled.

CollectionCacheTrait::init() — Method in class CollectionCacheTrait

When trait is used in module, we need to apply a namespace

DuplicatableModelTrait::isReferenceDuplicationAllowed() — Method in class DuplicatableModelTrait

Should reference items be duplicated (deep copy of dms objects) If false (default), references will be replicated as shallow read references to their original items

SoftDeleteTrait::initSoftDeleteTrait() — Method in class SoftDeleteTrait

SoftDeleteTrait::isSoftDeleted() — Method in class SoftDeleteTrait

SetupPage::init() — Method in class SetupPage

SetupPage::is_configured() — Method in class SetupPage

returns true if everything is configured and returns false if at least one point is not yet done

SetupPage::is_setup_step_finished() — Method in class SetupPage

return true if given setup step is finished default: return false

$ SystemCron#init_state — Property in class SystemCron

SystemDaemon::isShutdown() — Method in class SystemDaemon

Returns true if the daemon process is in the shutdown phase to be ended

Document::init() — Method in class Document

put your comment there.

Document::isVideo() — Method in class Document

UIComponent::init() — Method in class UIComponent

put your comment there.

$ XF#im — Property in class XF

XF::instance() — Method in class XF

Returns an instance of xf class.

XF::init() — Method in class XF

Initializes main xf components.

Config::init() — Method in class Config

Config::is_install_mode() — Method in class Config

MySQLAdapter::is_cluster() — Method in class MySQLAdapter

Is Database a Galera Cluster?

MySQLAdapter::isMariaDB() — Method in class MySQLAdapter

Detect if the server is a MariaDB server (used to catch some specialties of MariaDB)

MySQLAdapter::insert() — Method in class MySQLAdapter

Inserts the passed values into the given table

IM — Class in namespace XELOS\Framework\XF

Class IM

IM::instance_exists() — Method in class IM

$ Lib#import — Property in class Lib

$ Lib#i18n — Property in class Lib

Ajax::is_ajax() — Method in class Ajax

Browser::is_unsupported_browser() — Method in class Browser

Checks if the current browser of the user is supported or not by this xelos version

Browser::is_hdpi_device() — Method in class Browser

Returns true if the DEVICE is a HighDPI / Retina Device

Browser::is_post_request() — Method in class Browser

Browser::isRequestMethod() — Method in class Browser

Is current Request of given Method?

Browser::is_ie() — Method in class Browser

Returns TRUE of agent is Internet Explorer

Browser::is_firefox() — Method in class Browser

Returns TRUE of agent is Firefox

Browser::is_chrome() — Method in class Browser

Returns TRUE of agent is Chrome

Browser::is_mobile() — Method in class Browser

Is Mobile Device/Browser?

Browser::is_xdc() — Method in class Browser

Returns TRUE of agent is xelos Desktop Connector Tool (xdc)

Browser::is_xoi() — Method in class Browser

Returns TRUE of agent is xelos Office Integration (XOI)

Browser::is_ios() — Method in class Browser

Returns true if it is an iOS browser and not the XELOS app.

Browser::is_device_iphone() — Method in class Browser

Browser::is_device_ipad() — Method in class Browser

Browser::is_device_ipod_touch() — Method in class Browser

Browser::is_safari_webapp() — Method in class Browser

Browser::is_xelos_app() — Method in class Browser

Checks for XELOS App Useragent

Browser::is_ms_office() — Method in class Browser

Checks for MS Office App Useragent

Browser::is_ms_office_mobile() — Method in class Browser

Checks for MS Office Mobile App Useragent e.g. Microsoft Office Word/2.23.304 (iOS/12.1.4; Phone; de-DE; AppStore; Apple/iPhone10,6)

Browser::is_android() — Method in class Browser

Checks if the browser is running on Android and is not the XELOS app.

Browser::is_mobile_safari() — Method in class Browser

mobile Safari for

Browser::isVUEBlobRequest() — Method in class Browser

Is the current request a blob request? Content requested in this call will be added to the iframe with src="blob:" and is slighty restricted: e.g. when origin-security is applied in JS content or forms are missing the action="" attribute

Browser::isVUEFrameRequest() — Method in class Browser

Very similar to the BlobRequest, but iframe is not using blob binary

Browser::is_ip_in_range() — Method in class Browser

Check if a given ip is in a network

Browser::isMatchingNetmask() — Method in class Browser

Check if client/browser matches a given set of networks/ip ranges

Cache::init() — Method in class Cache

Cache::is_enabled() — Method in class Cache

Returns true of the caching system is active

APCUCacheHandler::init() — Method in class APCUCacheHandler

APCUCacheHandler::is_cli_supported() — Method in class APCUCacheHandler

CacheHandlerInterface::init() — Method in class CacheHandlerInterface

CacheHandlerInterface::is_cli_supported() — Method in class CacheHandlerInterface

MemcacheCacheHandler::init() — Method in class MemcacheCacheHandler

MemcacheCacheHandler::is_cli_supported() — Method in class MemcacheCacheHandler

RedisCacheHandler::init() — Method in class RedisCacheHandler

RedisCacheHandler::is_cli_supported() — Method in class RedisCacheHandler

Debug::is_enabled() — Method in class Debug

Checks wether a certain debug flag has been enabled (for sub-debug functions)

Doclink::increaseViewCounter() — Method in class Doclink

Environment::increaseMemoryLimit() — Method in class Environment

Increase the PHP Memory Limit to the passed value if the current value is smaller

Environment::increaseTimeLimit() — Method in class Environment

Increase Time Limit of process if the current value is smaller

Environment::increaseMemoryLimitIfNeeded() — Method in class Environment

This function makes sure the passed percentage of memory is kept free. If the free memory for this process runs below this level the memory will be automatically increased

Error::init() — Method in class Error

Initialize for Vars

File::init() — Method in class File

File::is_subfolder() — Method in class File

File::isEmptyDirectory() — Method in class File

File::is_image() — Method in class File

File::isImageExtension() — Method in class File

If file extension considered an image format?

File::is_video() — Method in class File

File::isVideoExtension() — Method in class File

If file extension considered a rocessable and previewable video format? Must be compatible and supported by ffmpeg conversion process

File::is_secure_filename() — Method in class File

Check if Filename meets the nonstrict security guidelines

File::is_ioncube_encoded() — Method in class File

Checks if the passed PHP file is encoded via Ioncube

File::inival_to_bytes() — Method in class File

function used by get_max_upload_size to convert the ini values to a byte values

Filehandler::imageResize() — Method in class Filehandler

Resizes the passed image to the given size.

Filehandler::imageGetOrientation() — Method in class Filehandler

Filehandler::image_crop() — Method in class Filehandler

Filehandler::increase_memory_limit() — Method in class Filehandler

Returns an GD Image Ressource of the passed file

Foaf::isConnected() — Method in class Foaf

Foaf::is_contact() — Method in class Foaf

True if ot_id user is a direct contact of the from_id

Foaf::is_pending_connection() — Method in class Foaf

Returns true of the first passed user has requested the contact for the second and is still pending

Format::image_resize_parse() — Method in class Format

Adds XF image resize params to each image in the passed HTML string e.g. will be replaced to:

Format::image_resize_parse_cb() — Method in class Format

Callback for image_resize_parse

Format::is_utf8() — Method in class Format

Checks the given string for utf-8 encoding.

GroupSecurity::init() — Method in class GroupSecurity

Hierarchy::init_tree() — Method in class Hierarchy

Initialize a hierarchy tree Loads all hierarchy nodes as collection into internal array

I18n — Class in namespace XELOS\Framework\XF\Lib

Language Tools

I18n::init() — Method in class I18n

I18n::isJsonToken() — Method in class I18n

Returns true if the passed token seems to be in the new JSON token format / technical token (e.g. "xelos.token.dialog.error.label")

Import — Class in namespace XELOS\Framework\XF\Lib

CsvImport::import() — Method in class CsvImport

Runs the import process and generates the models

Link::init() — Method in class Link

Init Default Vars

Link::is_request_secure() — Method in class Link

Link::is_request_authentic() — Method in class Link

Link::isExternalURI() — Method in class Link

Is the given URL considered an external URI? Or internal (absolute with same host or relative URI)

DatabaseHandler::isHandling() — Method in class DatabaseHandler

InMemoryHandler — Class in namespace XELOS\Framework\XF\Lib\Logger\Handler

Class InMemoryHandler

$ InMemoryHandler#inMemory — Property in class InMemoryHandler

$ Logger#inMemoryLogs — Property in class Logger

Logger::isDefaultLevel() — Method in class Logger

Logger::info() — Method in class Logger

Mail::is_valid_email() — Method in class Mail

Checks wether the passes email has a valid format (using reg-ex)

Modsetup::init() — Method in class Modsetup

Modsetup::insert_initial_values() — Method in class Modsetup

Modsetup::insert_pages_to_navigation() — Method in class Modsetup

Modsetup::insert_default_config() — Method in class Modsetup

Modsetup::insert_provided_hooks() — Method in class Modsetup

Modsetup::install_new_instance() — Method in class Modsetup

Modsetup::insert_document_registry() — Method in class Modsetup

Modsetup::insert_notification_registry() — Method in class Modsetup

Modsetup::is_system_maintenance() — Method in class Modsetup

Return true if system is in maintenance mode

Modsetup::isRequiredDependency() — Method in class Modsetup

Notification::invalidate_counts() — Method in class Notification

Invalidate counts

$ NotificationBuilder#icon — Property in class NotificationBuilder

$ NotificationBuilder#instanceId — Property in class NotificationBuilder

Policy::invalidate_user_policy_diff() — Method in class Policy

Invalidate User Policy Diff for passed User IDs All Invalidated User Policy Diffs will be Reloaded the next Time a New / Dirty Session is loaded

Policy::invalidate_policy_cluster() — Method in class Policy

Privacy::init() — Method in class Privacy

$ QueueableJob#idToken — Property in class QueueableJob

Token ID - available during Execution

Request::is_webservice_call() — Method in class Request

Sec::init() — Method in class Sec

Sec::input() — Method in class Sec

Filter INPUT based on certain rules:

• XSS: Encode ALL Special Chars ('"<>& and chars with ASCII value less 32)

Sec::input_array() — Method in class Sec

Takes an array and casts values / escapes values according to type

Sec::iv_encrypt() — Method in class Sec

Sec::iv_decrypt() — Method in class Sec

Sec::isValidJWTToken() — Method in class Sec

Will check the standard security criteria of the supplied JWT Token If no security (expiration, signature) is provided, this method will only decode the token

Sec::isValidUUID() — Method in class Sec

Check if this looks like a valid uuid (32 chars, hex only)

Session::is_dirty() — Method in class Session

Returns true if the current session is marked as dirty

SessionDirtyFlagStorageInterface::is_dirty() — Method in class SessionDirtyFlagStorageInterface

Dirty?

SqlSessionHandler::is_dirty() — Method in class SqlSessionHandler

Dirty?

Shell::is_process_running() — Method in class Shell

Shell::isProcessOwnedByRoot() — Method in class Shell

Is the current process run by the root user?

Ssl::is_ssl() — Method in class Ssl

Text::is_html() — Method in class Text

checks if the string contains any html tags and returns true if so

Threading::is_child_stopped() — Method in class Threading

Check Status of a child process

Threading::is_child_process() — Method in class Threading

Is the current process a child process?

Thumbnail::init() — Method in class Thumbnail

Initialize Thumbnail Engine

UserImport::init() — Method in class UserImport

Initialize the import

UserImport::import() — Method in class UserImport

Token::isProbablyUntranslated() — Method in class Token

Token::isEmpty() — Method in class Token

System::init() — Method in class System

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

$ DocumentIndexCollection#isDocumentModel — Property in class DocumentIndexCollection

DocumentIndexCollection::init() — Method in class DocumentIndexCollection

Use init for default sort order of your collection

$ DocumentIndexReferenceCollection#isDocumentModel — Property in class DocumentIndexReferenceCollection

DocumentIndexReferenceCollection::init() — Method in class DocumentIndexReferenceCollection

Use init for default sort order of your collection

GroupCollection::init() — Method in class GroupCollection

Use init for default sort order of your collection

InstanceRegistryCollection — Class in namespace XELOS\Framework\XF\System\Collection

InstanceRegistryCollection::init() — Method in class InstanceRegistryCollection

Use init for default sort order of your collection

$ ModuleGroupSecurityCollection#isDocumentModel — Property in class ModuleGroupSecurityCollection

ModuleGroupSecurityCollection::init() — Method in class ModuleGroupSecurityCollection

Use init for default sort order of your collection

ModuleGroupSecurityMemberCollection::init() — Method in class ModuleGroupSecurityMemberCollection

Use init for default sort order of your collection

ModuleRegistryCollection::init() — Method in class ModuleRegistryCollection

Use init for default sort order of your collection

NotificationCollection::init() — Method in class NotificationCollection

Use init for default sort order of your collection

PagesCollection::init() — Method in class PagesCollection

Use init for default sort order of your collection

PolicyCollection::init() — Method in class PolicyCollection

Use init for default sort order of your collection

UserCollection::init() — Method in class UserCollection

Use init for default sort order of your collection

UserCollection::isAdminSearchMode() — Method in class UserCollection

UserMetaCollection::init() — Method in class UserMetaCollection

Use init for default sort order of your collection

$ Model#instance_config — Property in class Model

$ Model#i18n_language — Property in class Model

$ Model#i18n_token — Property in class Model

$ Model#instance_registry — Property in class Model

$ Model#instance_setup — Property in class Model

$ AuditTrail#id — Property in class AuditTrail

$ AuditTrail#instance_id — Property in class AuditTrail

$ DocumentIndex#id — Property in class DocumentIndex

$ DocumentIndex#instance_id — Property in class DocumentIndex

$ DocumentIndex#instance_string — Property in class DocumentIndex

$ DocumentIndex#is_hidden — Property in class DocumentIndex

DocumentIndex::init() — Method in class DocumentIndex

Initializes the model

DocumentIndex::injectDocumentIndex() — Method in class DocumentIndex

Injects the document index object into a related model by setter injection.

DocumentIndex::is_follow_user() — Method in class DocumentIndex

DocumentIndex::is_hidden() — Method in class DocumentIndex

Returns if this document index is marked "hidden"

DocumentIndex::isAttachment() — Method in class DocumentIndex

Is this document considered to be an attachment?

DocumentIndex::isPersonalAttachment() — Method in class DocumentIndex

Is this document considered accessible as personal attachment?

DocumentIndex::isPersonalReference() — Method in class DocumentIndex

We need some way to make Trendvote available for linking (similar to isPersonalAttachment) after creation

$ DocumentIndexJobQueue#id — Property in class DocumentIndexJobQueue

$ DocumentIndexLock#id — Property in class DocumentIndexLock

$ DocumentIndexReference#id — Property in class DocumentIndexReference

$ DocumentRegistry#instance — Property in class DocumentRegistry

$ DocumentRegistry#id — Property in class DocumentRegistry

$ DocumentRegistry#instance_id — Property in class DocumentRegistry

Group::isHidden() — Method in class Group

Should this group be visible in selectors and dialogs?

$ Hierarchy#id — Property in class Hierarchy

I18nLanguage — Class in namespace XELOS\Framework\XF\System\Model

I18nToken — Class in namespace XELOS\Framework\XF\System\Model

$ I18nToken#id — Property in class I18nToken

ID

$ I18nToken#in_js — Property in class I18nToken

InstanceConfig — Class in namespace XELOS\Framework\XF\System\Model

InstanceRegistry — Class in namespace XELOS\Framework\XF\System\Model

InstanceSetup — Class in namespace XELOS\Framework\XF\System\Model

$ ModuleGroupSecurity#id — Property in class ModuleGroupSecurity

$ ModuleGroupSecurity#instance_id — Property in class ModuleGroupSecurity

Navigation::init() — Method in class Navigation

Model should use the currently active navigation set dynamically

$ Notification#id — Property in class Notification

$ Notification#instance_id: — Property in class Notification

{type: varchar, size: 50}

$ Notification#icon — Property in class Notification

Icon Class

Notification::isSeen() — Method in class Notification

Notification::isRead() — Method in class Notification

Notification::isNew() — Method in class Notification

Notification::isProcessed() — Method in class Notification

$ OnboardingCode#id — Property in class OnboardingCode

$ Pages#id — Property in class Pages

$ Pages#instance_id — Property in class Pages

$ Policy#id — Property in class Policy

$ Policy#instance_id — Property in class Policy

User::init() — Method in class User

User::in_group() — Method in class User

Check if User is in a specific group

User::is_online() — Method in class User

Returns true if the current user is online

User::isAnonymized() — Method in class User

$ UserDevices#id — Property in class UserDevices

$ UserDevices#is_mobile — Property in class UserDevices

: stored in MySQL as tinyint

$ UserDevices#is_apiclient: — Property in class UserDevices

stored in MySQL as tinyint

$ UserDevices#is_temporary: — Property in class UserDevices

stored in MySQL as tinyint

$ UserLink#id — Property in class UserLink

$ UserLink#icon — Property in class UserLink

UI::init() — Method in class UI

UI::init_ui() — Method in class UI

Initilized before VIEW execution with Event Trigger, Restore session values

Amchart::init() — Method in class Amchart

put your comment there.

$ Callback#instance_id — Property in class Callback

The instance ID

$ Doclink#include_actions — Property in class Doclink

Doclink::init() — Method in class Doclink

Object initializer

DocumentLock::init() — Method in class DocumentLock

Class initialization

DocumentLock::is_locked() — Method in class DocumentLock

Returns whether the target document index is locked or not.

Faceted::is_active() — Method in class Faceted

Returns true if the passed item is currently active

FacetedFilter::isEmptyCategory() — Method in class FacetedFilter

Returns true, if the category has been explicitly set to empty

FacetedLegacy::is_active() — Method in class FacetedLegacy

Returns true if the passed item is currently active

FacetedCategory::isRequired() — Method in class FacetedCategory

FacetedCategory::invokeCallBack() — Method in class FacetedCategory

FacetedCategoryDate::isActive() — Method in class FacetedCategoryDate

FacetedCategoryDate::invokeCallBack() — Method in class FacetedCategoryDate

FacetedCategoryItem::isActive() — Method in class FacetedCategoryItem

FacetedCategoryItem::isDefault() — Method in class FacetedCategoryItem

FacetedCategoryItem::isDisabled() — Method in class FacetedCategoryItem

Indicates if this item has been disabled and should not be displayed

FacetedCategoryTextSearch::invokeCallBack() — Method in class FacetedCategoryTextSearch

$ Form#is_validated — Property in class Form

$ Form#image_mimes — Property in class Form

Form::insertField() — Method in class Form

Inserts a form component in the field array of the form.

Form::is_validated() — Method in class Form

Form passed all validations?

$ FormEditor#id — Property in class FormEditor

FormBase::init_obj() — Method in class FormBase

Initializes the form base

FormBase::is_displayed() — Method in class FormBase

Checks if the field is hidden by a tag. It is important when validating

FormCaptcha::init() — Method in class FormCaptcha

Init will be called AFTER __construct() and init_obj() with $this->form set

FormComponent::init() — Method in class FormComponent

Init will be called AFTER __construct() and init_obj() with $this->form set

FormComponent::isReadonly() — Method in class FormComponent

Returns TRUE if field is readonly, FALSE otherwise.

FormComponent::insertBefore() — Method in class FormComponent

Insert this field before the specified field

FormComponent::insertAfter() — Method in class FormComponent

Insert this field after the specified field

FormConfig::init_obj() — Method in class FormConfig

FormConfig::init() — Method in class FormConfig

FormContentAttachment::isAllowedContentType() — Method in class FormContentAttachment

Checks if the passed element is of the allowed content type (e.g. Trendvote)

FormDate::init() — Method in class FormDate

Init will be called AFTER __construct() and init_obj() with $this->form set

FormDocument::init() — Method in class FormDocument

Initialize the component, loading all dependent instances and required JS and CSS files

FormDocument::isAutoStore() — Method in class FormDocument

This class provides an automated handling for storing attached / uploaded documents. This handling will be triggered on save and if this option (auto store) is TRUE.

FormDocument::isSerialized() — Method in class FormDocument

Returns TRUE if the values of this component are serialized.

FormDocument::isMultiple() — Method in class FormDocument

Returns TRUE if this component supports multiple document selection.

FormDocument::isFormSubmitOnChange() — Method in class FormDocument

Returns whether changes to attachments should trigger a form submit.

FormFieldset::init() — Method in class FormFieldset

Init will be called AFTER __construct() and init_obj() with $this->form set

FormFieldsetClose::init() — Method in class FormFieldsetClose

Init will be called AFTER __construct() and init_obj() with $this->form set

$ FormFile#image_mimes — Property in class FormFile

FormFile::init() — Method in class FormFile

Initialize

FormMultifile::init() — Method in class FormMultifile

Init will be called AFTER __construct() and init_obj() with $this->form set

FormMultitext::init() — Method in class FormMultitext

Init will be called AFTER __construct() and init_obj() with $this->form set

FormPolicySelector::init() — Method in class FormPolicySelector

Init will be called AFTER __construct() and init_obj() with $this->form set

FormTag::init() — Method in class FormTag

FormUserSelector::init() — Method in class FormUserSelector

Init will be called AFTER __construct() and init_obj() with $this->form set

FormWebfetcher::init() — Method in class FormWebfetcher

Init will be called AFTER __construct() and init_obj() with $this->form set

$ FroalaInsertGroup#items — Property in class FroalaInsertGroup

FroalaOption::iconsTemplate() — Method in class FroalaOption

Set the template to be used for the icons inside the editor UI.

FroalaOption::iframe() — Method in class FroalaOption

When this option is enabled, the editor's content will be placed in an iframe and isolated from the rest of the page.

FroalaOption::iframeDefaultStyle() — Method in class FroalaOption

Default style needed by the editor to be used inside the iframe to display content.

FroalaOption::iframeStyle() — Method in class FroalaOption

Custom style to be used inside the iframe to display content. This style is added over the iframeDefaultStyle style.

FroalaOption::iframeStyleFiles() — Method in class FroalaOption

An array with custom CSS files to inject inside the iframe to display content.

FroalaOption::indentMargin() — Method in class FroalaOption

The number of pixels to use for indenting the current line.

FroalaOption::initOnClick() — Method in class FroalaOption

Only the minimum required events are initialized on page load and the rest of them when the user clicks inside the editable area. This is very useful when using multiple editors on the same page because it reduces the page load time.

FroalaOption::imageAllowedTypes() — Method in class FroalaOption

The list of image types that are allowed to be uploaded. Although this will restrict uploading other types of files, we strongly recommend you to check the file type on the server too.

FroalaOption::imageAltButtons() — Method in class FroalaOption

The list of buttons that appear in the edit image alternate text popup, when changing the alternate text of the image.

FroalaOption::imageCORSProxy() — Method in class FroalaOption

Proxy server to be used for reading images inserted by URL and upload them to a custom server. By default we provide a proxy hosted on our servers, however for full control, we recommend setting up your own proxy by using the details from CORS Anywhere.

FroalaOption::imageDefaultAlign() — Method in class FroalaOption

Sets the default image alignment when it is inserted in the rich text editor. Possible values are 'left', 'center' and 'right'.

FroalaOption::imageDefaultDisplay() — Method in class FroalaOption

Sets the default display for an image when is is inserted in the rich text. Possible options are: 'inline' and 'block'.

FroalaOption::imageDefaultMargin() — Method in class FroalaOption

Sets the default width of the image when it is inserted in the rich text editor. Setting it to 0 will not set any width.

FroalaOption::imageDefaultWidth() — Method in class FroalaOption

Sets the default width of the image when it is inserted in the rich text editor. Setting it to 0 will not set any width.

FroalaOption::imageEditButtons() — Method in class FroalaOption

The list of buttons that appear in the edit image popup, when an image is selected. If Image Aviary plugin is included, then 'aviary' can be used as an option as well.

FroalaOption::imageInsertButtons() — Method in class FroalaOption

The list of buttons that appear in the insert image popup, when inserting a new image into the WYSIWYG editor.

FroalaOption::imageMaxSize() — Method in class FroalaOption

The maximum image size allowed on upload in bytes. The default value is 10MB. Although this makes an additional check before uploading the image, it is highly recommended to check image size on your server too.

FroalaOption::imageMinWidth() — Method in class FroalaOption

The minimum width in PX the image can be resized to.

FroalaOption::imageMove() — Method in class FroalaOption

Allows changing the position of the images by dragging them. This option will work correctly only when including the draggable plugin.

FroalaOption::imageMultipleStyles() — Method in class FroalaOption

Allows multiple image styles to be selected at a time.

FroalaOption::imagePaste() — Method in class FroalaOption

Allows pasting images from clipboard.

FroalaOption::imagePasteProcess() — Method in class FroalaOption

Use default image settings for pasted images.

FroalaOption::imageResize() — Method in class FroalaOption

Disables image resize when set to false.

FroalaOption::imageResizeWithPercent() — Method in class FroalaOption

By default the image resize is using PX. Enabling this option will use % instead when resizing an image inside the editor.

FroalaOption::imageRoundPercent() — Method in class FroalaOption

Force image percent to round to integer while resizing.

FroalaOption::imageOutputSize() — Method in class FroalaOption

When this option is enabled, the images will get the width and height set as attribute in the output.

FroalaOption::imageSizeButtons() — Method in class FroalaOption

The list of buttons that appear in the edit image size popup, when editing the image's width and height.

FroalaOption::imageSplitHTML() — Method in class FroalaOption

Enables splitting the HTML when inserting a new image.

FroalaOption::imageStyles() — Method in class FroalaOption

Set custom styles for the selected image. The classes should be defined in CSS, otherwise no changes will be visible on the image's appearance.

FroalaOption::imageTUIOptions() — Method in class FroalaOption

Set options for TUI editor plugin.

FroalaOption::imageTextNear() — Method in class FroalaOption

Allows text near an image when it is aligned to the left or to the right. Disabling this option will make the display button for image editor popup unavailable.

FroalaOption::imageUpload() — Method in class FroalaOption

Enable or disable image upload.

FroalaOption::imageAddNewLine() — Method in class FroalaOption

Add new line after inserting an image when enabled.

FroalaOption::imageUploadMethod() — Method in class FroalaOption

The HTTP image upload request type.

FroalaOption::imageUploadParam() — Method in class FroalaOption

Customize the name of the parameter that contains the image file in the upload request.

FroalaOption::imageUploadParams() — Method in class FroalaOption

Pass additional parameters to the upload request.

FroalaOption::imageUploadRemoteUrls() — Method in class FroalaOption

Upload images inserted by URL to custom server instead of linking them by URL.

FroalaOption::imageUploadToS3() — Method in class FroalaOption

Set the options for image upload to S3. All the fields from the example below are required. Also make sure that you have enabled <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html" title="CORS" target="_blank" rel="nofollow">CORS on Amazon.

Note: uploadURL property can be used instead of bucket and region properties to specify a custom URL from Amazon where to upload the image.

FroalaOption::imageUploadURL() — Method in class FroalaOption

The URL where the images uploaded by the user are saved. When an image is uploaded, the editor sends the file to the server through a HTTP request. The server should process the data from the file parameter of the request and return a JSON object containing a link field with the link to the uploaded image. More details can be found in the <a href="../docs/concepts/image-upload" title="Image Upload Concept" target="_blank">Image Upload concept article.
E.g. {link: 'path/to/image.jpg'}.

Note 1: By default, the images are stored on our servers, but if you want to have full control over them, you should consider implementing the upload on your server. The images stored on our servers, may be deleted at any time without any notice.
Note 2: If the domain where the image is saved is not the same with the one where the editor is running, you may need to enable requestWithCORS option and make specific customizations on the server. For more information please refer to Cross-origin resource sharing.

FroalaOption::imageManagerDeleteMethod() — Method in class FroalaOption

The HTTP image manager delete image request type.

FroalaOption::imageManagerDeleteParams() — Method in class FroalaOption

Additional parameters passed to the image manager image delete request.

FroalaOption::imageManagerDeleteURL() — Method in class FroalaOption

The URL where the HTTP request is done to delete the image. The request will contain the image source as src parameter.

FroalaOption::imageManagerLoadMethod() — Method in class FroalaOption

The HTTP image manager load images request type.

FroalaOption::imageManagerLoadParams() — Method in class FroalaOption

Additional parameters passed to the load images request from the image manager.

FroalaOption::imageManagerLoadURL() — Method in class FroalaOption

The URL where the HTTP request is done in order to load a page of images that appear in the image manager. The response should be an array with an Object for each image, similar to:

FroalaOption::imageManagerPageSize() — Method in class FroalaOption

The number of images loaded per page in the image manager.

FroalaOption::imageManagerPreloader() — Method in class FroalaOption

The path to a gif image to be displayed while loading the images from the server in the image manager. If no option is specified, "Loading.." text will appear.

FroalaOption::imageManagerScrollOffset() — Method in class FroalaOption

The distance in pixels from the bottom of the scrollable content at which to trigger the loading of the next page of images.

FroalaOption::imageManagerToggleTags() — Method in class FroalaOption

To enable/disable toggle of filter tags for image manager popup.

FroalaOption::inlineStyles() — Method in class FroalaOption

Set custom styles for the selected text. This option is an Object where the key is the name of the new style that appears in the dropdown and the value specifies the CSS properties for it.

FroalaOption::inlineClasses() — Method in class FroalaOption

Set custom classes for the selected text. This option is an Object where the key is the name of the new class that appears in the dropdown and the value specifies the class name for it.

$ HtmlUlList#item_class — Property in class HtmlUlList

Image — Class in namespace XELOS\Framework\XF\UI

Image::is_replacer_disabled() — Method in class Image

ImageEdit — Class in namespace XELOS\Framework\XF\UI

Class ImageEdit

Import — Class in namespace XELOS\Framework\XF\UI

InlineEditor — Class in namespace XELOS\Framework\XF\UI

Instance — Class in namespace XELOS\Framework\XF\UI

$ Instance#instance — Property in class Instance

ItemList — Class in namespace XELOS\Framework\XF\UI

Class ItemList

$ ItemList#items — Property in class ItemList

Item — Class in namespace XELOS\Framework\XF\UI\ItemList

Class Item

$ Item#id — Property in class Item

$ Item#info — Property in class Item

$ Item#icon_class — Property in class Item

ButtonOptions::isMuted() — Method in class ButtonOptions

MenuOptions::isHideIndicator() — Method in class MenuOptions

MenuOptions::isHideLabel() — Method in class MenuOptions

MenuOptions::isRounded() — Method in class MenuOptions

ModalDialog::isFullscreen() — Method in class ModalDialog

ModalDialog::isIframe() — Method in class ModalDialog

ModalDialog::isShowCloseConfirm() — Method in class ModalDialog

Paging::is_first_page() — Method in class Paging

Paging::is_last_page() — Method in class Paging

Paging::isInLoadMoreMode() — Method in class Paging

Returns true, if the pagination is in load more / load previous mode.

$ Portlet#instance — Property in class Portlet

Reactions::isCompactMode() — Method in class Reactions

TableEditor::init() — Method in class TableEditor

put your comment there.

TimeLine::init() — Method in class TimeLine

put your comment there.

$ Tree#id_field — Property in class Tree

$ UserImage#initial_status — Property in class UserImage

Set this false to display the status initially as unknown. The status will be refreshed via ajax.

UserImage::init() — Method in class UserImage

Load js files

UserImage::isShowStatus() — Method in class UserImage

VCard::init() — Method in class VCard

put your comment there.

$ Wizard#isNextEnabled — Property in class Wizard

$ Wizard#isPrevEnabled — Property in class Wizard

User::init() — Method in class User

User::is_urlaccess() — Method in class User

User::is_guest() — Method in class User

User::is_logged_in() — Method in class User

User::is_controlled_via_auth() — Method in class User

Can user change login, password, email? Or is this controlled via auth?

User::is_admin_auth_required() — Method in class User

Is additional authentication required for this user?

User::isApiAccess() — Method in class User

Checks if the user is logged in via OAuth in the view with a bearer token.

User::is_loaded() — Method in class User

Returns true when the user object has loaded the settings and the user object is usable

User::in_group() — Method in class User

Check if User is in a specific group

User::isUserModeEnabled() — Method in class User

User::isUserStatusEnabled() — Method in class User

Determines if the "Enable online status" setting in system_userprofile is activated or not

User::isUserLimitReached() — Method in class User

Checks if the user limit of the systems licence has been reached

$ View#instance — Property in class View

View::is_special_page() — Method in class View

View::is_special_instance() — Method in class View

Return true if the instance_id is considered special

View::is_valid_public_call() — Method in class View

Check wether this is a public page valid to be called

View::is_auth_method_available() — Method in class View

Check if Authentication Method is available

$ AdCache#id — Property in class AdCache

DirectoryServiceInterface::initService() — Method in class DirectoryServiceInterface

$ AdSyncTest#instance — Property in class AdSyncTest

DirectoryServiceConfigTrait::initService() — Method in class DirectoryServiceConfigTrait

LanguageSettingLanguageConfig::init() — Method in class LanguageSettingLanguageConfig

LanguageSettingLanguageConfig::isAvailable() — Method in class LanguageSettingLanguageConfig

Returns true if this hook is available otherwise false.

UserAccountUserConfig::init() — Method in class UserAccountUserConfig

UserAdvancedUserAdminConfig::init() — Method in class UserAdvancedUserAdminConfig

UserAuditLogUserAdminConfig::init() — Method in class UserAuditLogUserAdminConfig

UserDevicesUserConfig::init() — Method in class UserDevicesUserConfig

UserDevicesUserConfig::isAvailable() — Method in class UserDevicesUserConfig

Should tab be loaded and shown?

UserGroupsUserAdminConfig::init() — Method in class UserGroupsUserAdminConfig

UserLanguageUserConfig::init() — Method in class UserLanguageUserConfig

UserPolicyUserAdminConfig::init() — Method in class UserPolicyUserAdminConfig

UserSecurityUserConfig::init() — Method in class UserSecurityUserConfig

$ UserAdminConfig#iconClass — Property in class UserAdminConfig

Icon Class

UserAdminConfig::isAdminContext() — Method in class UserAdminConfig

Is tab called from administration?

UserAdminConfig::isAvailable() — Method in class UserAdminConfig

Should tab be loaded and shown?

UserExportBase::initialize() — Method in class UserExportBase

UserPage::importInitCb() — Method in class UserPage

UserPage::importUserCb() — Method in class UserPage

User Import Callback (used by xui_import above)

$ AdministrationControllerTest#instance — Property in class AdministrationControllerTest

$ BadgeTest#instance — Property in class BadgeTest

$ UserAdminHookTest#instance — Property in class UserAdminHookTest

UserList::init() — Method in class UserList

put your comment there.

UploadDocumentProcessor::init() — Method in class UploadDocumentProcessor

Adds new share action on init.

CloudDocumentBrowser::is_consented() — Method in class CloudDocumentBrowser

Checks whether this browser is consented.

StorageProvider::init_provider() — Method in class StorageProvider

This method is used to initialize the providers connection by oauth clients.

StorageProvider::is_connected() — Method in class StorageProvider

Returns true if the provider is connected.

OnedriveBusinessStorageProvider::init_provider() — Method in class OnedriveBusinessStorageProvider

OnedriveBusinessStorageProvider::isAvailable() — Method in class OnedriveBusinessStorageProvider

Returns true if this hook is available otherwise false.

OnedriveStorageProvider::init_provider() — Method in class OnedriveStorageProvider

OnedriveStorageProvider::is_connected() — Method in class OnedriveStorageProvider

Returns true if the provider is connected.

OnedriveStorageProvider::isAvailable() — Method in class OnedriveStorageProvider

Returns true if this hook is available otherwise false.

ApiMicrosoftNavigation::isAvailable() — Method in class ApiMicrosoftNavigation

Dynamic check for each derived hook, checking, whether the page (or the primary link) is available at all.

CoAuthorDocumentProcessor::init() — Method in class CoAuthorDocumentProcessor

Adds new share action on init.

SearchMessagesSearchIntegration::isAvailable() — Method in class SearchMessagesSearchIntegration

Returns true if this hook is available otherwise false.

AzureAuthentication::isAvailable() — Method in class AzureAuthentication

Show this authentication method if installed, even if its not configured yet

$ MicrosoftOauthClient#icon_class — Property in class MicrosoftOauthClient

MicrosoftOauthClient::isAllowedExplicitConnection() — Method in class MicrosoftOauthClient

MicrosoftOauthClient::isAvailable() — Method in class MicrosoftOauthClient

Returns true if this hook is available otherwise false.

$ OnedriveOauthClient#icon_class — Property in class OnedriveOauthClient

OnedriveOauthClient::isAvailable() — Method in class OnedriveOauthClient

OnedriveOauthClient::init_service() — Method in class OnedriveOauthClient

OpenidAuthentication::isAvailable() — Method in class OpenidAuthentication

Show this authentication method if installed, even if its not configured yet

$ OpenidOauthClient#icon_class — Property in class OpenidOauthClient

OpenidOauthClient::isAllowedExplicitConnection() — Method in class OpenidOauthClient

OpenidOauthClient::isAvailable() — Method in class OpenidOauthClient

Returns true if this hook is available otherwise false.

AuthSamlController::init() — Method in class AuthSamlController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

SamlAuthentication::isAvailable() — Method in class SamlAuthentication

Is hook available at all?

$ Calendar#id — Property in class Calendar

$ Calendar#ical_url — Property in class Calendar

$ Calendarset#id — Property in class Calendarset

$ Event#id — Property in class Event

$ Participant#id — Property in class Participant

$ Participant#invitation_sent: — Property in class Participant

stored in MySQL as tinyint

$ Reminder#id — Property in class Reminder

$ ReminderQueue#id — Property in class ReminderQueue

$ SyncData#id — Property in class SyncData

$ SyncSetting#id — Property in class SyncSetting

CalendarInterface::is_readable() — Method in class CalendarInterface

Can the user access the calendar?

CalendarInterface::is_writeable() — Method in class CalendarInterface

Is the calendar writeable?

$ Page#index — Property in class Page

Page::index() — Method in class Page

$ Component#id — Property in class Component

$ ComponentLive#id — Property in class ComponentLive

$ History#id — Property in class History

$ HistoryComponent#id — Property in class HistoryComponent

$ HistoryPage#id — Property in class HistoryPage

$ Page#id — Property in class Page

$ PageLive#id — Property in class PageLive

$ Partial#id — Property in class Partial

$ PartialLive#id — Property in class PartialLive

CommentCollection::init() — Method in class CommentCollection

Use init for default sort order of your collection

$ Comment#id — Property in class Comment

$ LinkInfo#id — Property in class LinkInfo

$ LinkInfo#image: — Property in class LinkInfo

stored in MySQL as varchar

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\Comments\Hook\System

Class IndexEventDocumentIndexEvent

$ ApiService#isInternal — Property in class ApiService

Comment::isEditAllowed() — Method in class Comment

Returns false if the time limit is expired.

Comment::isDeleteAllowed() — Method in class Comment

Returns false if the time limit is expired.

Comment::init() — Method in class Comment

Comment initialization

CrmSync::isAvailable() — Method in class CrmSync

Returns true if this hook is available otherwise false.

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\DMS\Hook\System

ImportCategoryPage — Class in namespace XELOS\Modules\DMS\Page

$ ChannelCollection#isDocumentModel — Property in class ChannelCollection

ChannelCollection::init() — Method in class ChannelCollection

$ ChannelSourceDocumentCollection#isDocumentModel — Property in class ChannelSourceDocumentCollection

ChannelSourceDocumentCollection::init() — Method in class ChannelSourceDocumentCollection

$ ChannelSubscriptionCollection#isDocumentModel — Property in class ChannelSubscriptionCollection

ChannelSubscriptionCollection::init() — Method in class ChannelSubscriptionCollection

DocviewProcessor::init() — Method in class DocviewProcessor

FollowedDocumentsShowPortlet::init() — Method in class FollowedDocumentsShowPortlet

GroupActivityCollector::isAvailable() — Method in class GroupActivityCollector

Returns true if this hook is available otherwise false.

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\Doclink\Hook\System

Is triggered when a document_index is created or modified.

InvitationsAction — Class in namespace XELOS\Modules\Eventplanner\Action

InvitationsAction::invitation_wizard() — Method in class InvitationsAction

add invitees for event $tpl prefilled in main

CategoryCollection::init() — Method in class CategoryCollection

Use init for default sort order of your collection

EventCollection::init() — Method in class EventCollection

Use init for default sort order of your collection

$ Action#invitations — Property in class Action

Action::invitations() — Method in class Action

$ Model#invitation_reply_log — Property in class Model

Model::invitation_reply_log() — Method in class Model

$ CategoryDocumentation#id — Property in class CategoryDocumentation

$ EventDocumentation#id — Property in class EventDocumentation

$ EventDocumentation#is_active: — Property in class EventDocumentation

stored in MySQL as tinyint

$ EventDocumentation#internal_info: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#invitation_subject: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#invitation_description: — Property in class EventDocumentation

stored in MySQL as text

$ EventDocumentation#invitation_api_id — Property in class EventDocumentation

InvitationReplyLogDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model InvitationReplyLog.

$ InvitationReplyLogDocumentation#id — Property in class InvitationReplyLogDocumentation

$ JobDocumentation#id — Property in class JobDocumentation

$ ParticipantDocumentation#id — Property in class ParticipantDocumentation

$ ParticipantDocumentation#invitation_sent: — Property in class ParticipantDocumentation

stored in MySQL as timestamp

$ ParticipantLogDocumentation#id — Property in class ParticipantLogDocumentation

$ RelatedEventsDocumentation#id — Property in class RelatedEventsDocumentation

$ EventplannerController#invitee_status — Property in class EventplannerController

EventplannerController::init() — Method in class EventplannerController

Cares about the presence of a category (if none is existing, this will create the category 'general').

EventplannerController::iCalForEvent() — Method in class EventplannerController

CRMParticipationShowPortlet::init() — Method in class CRMParticipationShowPortlet

CRMParticipationShowPortlet::init_portlet() — Method in class CRMParticipationShowPortlet

Category::init() — Method in class Category

Initializes the model

InvitationReplyLog — Class in namespace XELOS\Modules\Eventplanner\Model

SetupPage::is_setup_step_finished() — Method in class SetupPage

return true if given setup step is finished default: return false

Details::isDocumentPreview() — Method in class Details

CategoryCollection::init() — Method in class CategoryCollection

Use init for default sort order of your collection

PostCollection::init() — Method in class PostCollection

Use init for default sort order of your collection

ThreadCollection::init() — Method in class ThreadCollection

Use init for default sort order of your collection

$ CategoryDocumentation#id — Property in class CategoryDocumentation

$ CategoryDocumentation#is_root: — Property in class CategoryDocumentation

stored in MySQL as tinyint

$ PostDocumentation#id — Property in class PostDocumentation

$ ThreadDocumentation#id — Property in class ThreadDocumentation

$ VotesDocumentation#id — Property in class VotesDocumentation

$ VotesDocumentation#instance_id — Property in class VotesDocumentation

ForumController::init() — Method in class ForumController

RecentShowPortlet::init() — Method in class RecentShowPortlet

$ ApiService#isInternal — Property in class ApiService

InstallEvents — Class in namespace XELOS\Modules\Forum

InstallEvents::initializeAfterInstall() — Method in class InstallEvents

Category::isBlackBoard() — Method in class Category

Post::initialize_links() — Method in class Post

Post::isEditable() — Method in class Post

Post::isStub() — Method in class Post

Thread::is_sticky() — Method in class Thread

Is thread sticky?

Thread::is_closed() — Method in class Thread

Is thread closed?

Thread::isMyOwn() — Method in class Thread

SetupPage::is_setup_step_finished() — Method in class SetupPage

ThreadPreview::init() — Method in class ThreadPreview

VoteBox::initAllVoteValues() — Method in class VoteBox

$ GeoIpTest#instance — Property in class GeoIpTest

LocationCollection::init() — Method in class LocationCollection

Use init for default sort order of your collection

GeoIpAuthentication::isAvailable() — Method in class GeoIpAuthentication

Show this authentication method if installed, even if its not configured yet

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\Geodb\Hook\System

InstallEvents — Class in namespace XELOS\Modules\Geodb

$ Location#id — Property in class Location

$ TaskDocumentation#id — Property in class TaskDocumentation

GroupsTasksController::init() — Method in class GroupsTasksController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

InstallEvents — Class in namespace XELOS\Modules\GroupsTasks

CategoryCollection::init() — Method in class CategoryCollection

Use init for default sort order of your collection

GroupCollection::init() — Method in class GroupCollection

Use init for default sort order of your collection

MemberCollection::init() — Method in class MemberCollection

Use init for default sort order of your collection

$ Model#invitation — Property in class Model

Model::invitation() — Method in class Model

$ Page#invitation — Property in class Page

Page::invitation() — Method in class Page

$ Category#id — Property in class Category

$ Group#id — Property in class Group

$ Group#is_template: — Property in class Group

stored in MySQL as tinyint

$ Group#internal: — Property in class Group

stored in MySQL as tinyint

Invitation — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model invitation.

$ Invitation#id — Property in class Invitation

$ Invitation#invitee_id — Property in class Invitation

$ Invitation#invitation_text: — Property in class Invitation

stored in MySQL as text

$ Invitation#invited_at: — Property in class Invitation

stored in MySQL as timestamp

$ Member#id — Property in class Member

$ Member#is_contact: — Property in class Member

stored in MySQL as tinyint

$ Member#is_auto_added: — Property in class Member

stored in MySQL as tinyint

$ Module#id — Property in class Module

$ Newsletter#id — Property in class Newsletter

$ Pending#id — Property in class Pending

$ ApiModuleService#isInternal — Property in class ApiModuleService

$ ApiService#isInternal — Property in class ApiService

GroupsExtension::init() — Method in class GroupsExtension

InstallEvents — Class in namespace XELOS\Modules\Groups

Class InstallEvents

InstallEvents::initializeAfterInstall() — Method in class InstallEvents

LeaveApplicationCollection::init() — Method in class LeaveApplicationCollection

TravelCollection::init() — Method in class TravelCollection

Use init for default sort order of your collection

$ JobDocumentation#id — Property in class JobDocumentation

$ JobDocumentation#id_token: — Property in class JobDocumentation

stored in MySQL as varchar

$ JobHistoryDocumentation#id — Property in class JobHistoryDocumentation

$ JobHistoryDocumentation#id_token: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

JobQueueCheck::init() — Method in class JobQueueCheck

$ Page#imprint — Property in class Page

Page::imprint() — Method in class Page

$ PageDocumentation#id — Property in class PageDocumentation

PrivacyCentreUserConfig::init() — Method in class PrivacyCentreUserConfig

PrivacyCentreUserConfig::isAvailable() — Method in class PrivacyCentreUserConfig

InstallEvents — Class in namespace XELOS\Modules\Legal

LegalController::isDisclaimerDisplayed() — Method in class LegalController

Checks whether the disclaimer is displayed for the current user.

ImprintPage — Class in namespace XELOS\Modules\Legal\Page

Class Overview

CategoryCollection::init() — Method in class CategoryCollection

ListItemCollection::init() — Method in class ListItemCollection

Use init for default sort order of your collection

ListPropertiesCollection::init() — Method in class ListPropertiesCollection

Use init for default sort order of your collection

ListStatusCollection::init() — Method in class ListStatusCollection

Use init for default sort order of your collection

$ Page#item_overview — Property in class Page

Page::item_overview() — Method in class Page

$ Ui#item_editor — Property in class Ui

$ Ui#item_list — Property in class Ui

$ Ui#item_preview — Property in class Ui

$ CategoryDocumentation#id — Property in class CategoryDocumentation

$ ListDocumentation#id — Property in class ListDocumentation

$ ListDocumentation#item_count — Property in class ListDocumentation

$ ListItemDocumentation#id — Property in class ListItemDocumentation

$ ListStatusDocumentation#id — Property in class ListStatusDocumentation

Field::isSelectable() — Method in class Field

Adds the check for this field whether it is selectable or not.

Field::isMultipleDefaultFilter() — Method in class Field

Can the field be used with multiple values? Returning value is used as argument for FormChoice->setIsMultiple({$resultGoesHere}).

Checkbox::isSelectable() — Method in class Checkbox

Adds the check for this field whether it is selectable or not.

Multitext::isSelectable() — Method in class Multitext

Adds the check for this field whether it is selectable or not.

Select::isSelectable() — Method in class Select

Adds the check for this field whether it is selectable or not.

Select::isMultipleDefaultFilter() — Method in class Select

Slider::isMultipleDefaultFilter() — Method in class Slider

StaticText::isSelectable() — Method in class StaticText

Adds the check for this field whether it is selectable or not.

Textarea::isSelectable() — Method in class Textarea

Adds the check for this field whether it is selectable or not.

Textbox::isSelectable() — Method in class Textbox

Adds the check for this field whether it is selectable or not.

UserSelector::isSelectable() — Method in class UserSelector

Adds the check for this field whether it is selectable or not.

TimespanGetEvents::isAvailable() — Method in class TimespanGetEvents

Returns true if this hook is available otherwise false.

ListsGanttShowPortlet::init() — Method in class ListsGanttShowPortlet

ListsPortletShowPortlet::init() — Method in class ListsPortletShowPortlet

ListsSingleShowPortlet::init() — Method in class ListsSingleShowPortlet

InstallEvents — Class in namespace XELOS\Modules\Lists

ListsController::init() — Method in class ListsController

ListsController::isUseFolders() — Method in class ListsController

$ Category#id — Property in class Category

$ ListItem#id — Property in class ListItem

$ ListProperties#id — Property in class ListProperties

ID

$ ListProperties#item_count — Property in class ListProperties

Total items created for this list

ListProperties::isActive() — Method in class ListProperties

ListProperties::isActiveAndOpen() — Method in class ListProperties

ListProperties::isActiveAndClosed() — Method in class ListProperties

ListProperties::isWorkflowList() — Method in class ListProperties

Check, whether this list is a list whose items should be processed via workflows.

$ ListStatus#id — Property in class ListStatus

ItemOverviewPage — Class in namespace XELOS\Modules\Lists\Page

Class ItemOverviewPage

ListEditorPage::init() — Method in class ListEditorPage

ListEditorPage::importListFromFile() — Method in class ListEditorPage

Callback method for the list file XUI import.

CategorySelector::init() — Method in class CategorySelector

put your comment there.

ItemEditor — Class in namespace XELOS\Modules\Lists\UI

ItemEditor::init() — Method in class ItemEditor

put your comment there.

ItemList — Class in namespace XELOS\Modules\Lists\UI

Class ItemList

ItemList::initializeWorkflows() — Method in class ItemList

Initializes the workflows mod and all its components needed.

ItemPreview — Class in namespace XELOS\Modules\Lists\UI

Class ThreadPreview

ItemPreview::init() — Method in class ItemPreview

put your comment there.

ListPreview::init() — Method in class ListPreview

put your comment there.

ProfileCollection::init() — Method in class ProfileCollection

Use init for default sort order of your collection

ProfilePropertyCollection::init() — Method in class ProfilePropertyCollection

PropertyCollection::init() — Method in class PropertyCollection

PropertyGroupCollection::init() — Method in class PropertyGroupCollection

$ Profile#id — Property in class Profile

$ Property#id — Property in class Property

$ PropertyGroup#id — Property in class PropertyGroup

$ PropertyTab#id — Property in class PropertyTab

Image — Class in namespace XELOS\Modules\Lookbook\Fields

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\Lookbook\Hook\System

ArticleCollection::init() — Method in class ArticleCollection

Use init for default sort order of your collection

CategoryCollection::init() — Method in class CategoryCollection

Use init for default sort order of your collection

$ ArticleDocumentation#id — Property in class ArticleDocumentation

$ ArticleDocumentation#image_config: — Property in class ArticleDocumentation

enum large|small

$ ArticleDocumentation#image_direction: — Property in class ArticleDocumentation

enum left|center|right

$ CategoryDocumentation#id — Property in class CategoryDocumentation

$ RSSShowPortlet#is_initialized — Property in class RSSShowPortlet

RSSShowPortlet::init() — Method in class RSSShowPortlet

RSSShowPortlet::init_feed() — Method in class RSSShowPortlet

Article::init() — Method in class Article

Article::isEditor() — Method in class Article

checks if the current user has "editor" rights in the current category.

Article::isTeaserVideo() — Method in class Article

Checks if attachment1 is a video.

Article::isReadyForPublishing() — Method in class Article

Category::isFeatureEnabled() — Method in class Category

Returns TRUE if this feature is enabled/allowed in this category

NewsController::init() — Method in class NewsController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

SetupPage::is_setup_step_finished() — Method in class SetupPage

return true if given setup step is finished default: return false

Article::init() — Method in class Article

put your comment there.

Article::isVideo() — Method in class Article

ComponentCollection::init() — Method in class ComponentCollection

PageCollection::init() — Method in class PageCollection

PageVersionCollection::init() — Method in class PageVersionCollection

$ PageComponentDocumentation#id — Property in class PageComponentDocumentation

$ PageDocumentation#id — Property in class PageDocumentation

$ PageDocumentation#is_published: — Property in class PageDocumentation

stored in MySQL as tinyint

$ PageDocumentation#is_temp: — Property in class PageDocumentation

stored in MySQL as tinyint

$ PageDocumentation#is_custom_title: — Property in class PageDocumentation

stored in MySQL as tinyint

$ PageVersionDocumentation#id — Property in class PageVersionDocumentation

CommentsPortlet::isAvailable() — Method in class CommentsPortlet

InstallEvents — Class in namespace XELOS\Modules\Pages

Class InstallEvents

PageJsonMigrator::isLatestVersion() — Method in class PageJsonMigrator

$ Page#id — Property in class Page

$ Page#is_custom_title — Property in class Page

$ Page#is_published — Property in class Page

$ Page#is_temp — Property in class Page

Page::isAudience() — Method in class Page

$ PageVersion#id — Property in class PageVersion

PageVersion::isReferenceDuplicationAllowed() — Method in class PageVersion

$ Template#icon — Property in class Template

$ TemplateCategory#id — Property in class TemplateCategory

PagesController::initTemplates() — Method in class PagesController

Loads the templates from the SystemTemplates.json file in the setup folder and installs / updates them.

PagesController::import() — Method in class PagesController

Import Data for Pages, including binary data

$ PortletHookTest#instance — Property in class PortletHookTest

Page::init() — Method in class Page

put your comment there.

SelectorBrowser::is_consented() — Method in class SelectorBrowser

Checks whether this browser is consented.

WebdavService::init() — Method in class WebdavService

Initialization

Workspace::init() — Method in class Workspace

Called by object manager.

ConfirmationCollection::init() — Method in class ConfirmationCollection

DocumentCollection::init() — Method in class DocumentCollection

Use init for default sort order of your collection

$ ConfirmationDocumentation#id — Property in class ConfirmationDocumentation

$ DocumentDocumentation#id — Property in class DocumentDocumentation

AdminProcessor::init() — Method in class AdminProcessor

ReadConfirmationShowPortlet::init() — Method in class ReadConfirmationShowPortlet

IndexerAction — Class in namespace XELOS\Modules\Search\Action

Class IndexerAction

ElasticSearchAdapter::isSecurityPackAvailable() — Method in class ElasticSearchAdapter

Can we use xPackSecurity Features?

QueryBuilder::initSearchQuery() — Method in class QueryBuilder

Initialize minimal Search Query within builder

$ Action#indexer — Property in class Action

Action::indexer() — Method in class Action

$ Page#index — Property in class Page

Page::index() — Method in class Page

$ FacetedFilterDocumentation#id — Property in class FacetedFilterDocumentation

$ SearchHistoryDocumentation#id — Property in class SearchHistoryDocumentation

$ SearchagentDocumentation#id — Property in class SearchagentDocumentation

$ TermDocumentation#id — Property in class TermDocumentation

SearchIntegration::isAvailable() — Method in class SearchIntegration

We assume, that this hook is available per default.

SearchMetaData::isAvailable() — Method in class SearchMetaData

Field::isFacet() — Method in class Field

Field::isSortable() — Method in class Field

SearchPreprocessor::isAvailable() — Method in class SearchPreprocessor

Returns true if this hook is available otherwise false.

SearchSelectorBrowser::is_consented() — Method in class SearchSelectorBrowser

Checks whether this browser is consented.

InstallEvents — Class in namespace XELOS\Modules\Search

Class InstallEvents

DocumentElasticsearch::init() — Method in class DocumentElasticsearch

IndexPage — Class in namespace XELOS\Modules\Search\Page

SearchController::init() — Method in class SearchController

$ SearchIndexContentRecord#indexContent — Property in class SearchIndexContentRecord

$ SearchIndexContentRecord#isAutoTranslated — Property in class SearchIndexContentRecord

$ SearchIndexRecord#indexContent — Property in class SearchIndexRecord

$ AbstractBrowserItem#id — Property in class AbstractBrowserItem

AbstractBrowserItem::is_selectable() — Method in class AbstractBrowserItem

Returns whether this file can be selected in the browser or not. This method returns true by default (if not set).

$ AbstractDocumentBrowser#item_limit — Property in class AbstractDocumentBrowser

DocumentBrowserHookInterface::is_consented() — Method in class DocumentBrowserHookInterface

Checks whether this browser is consented.

UserSelectorProcessor::isAllowExternalInvites() — Method in class UserSelectorProcessor

UserSelectorProcessor::isAllowDisabledUsers() — Method in class UserSelectorProcessor

UserSelectorProcessor::isUsingGroupSelection() — Method in class UserSelectorProcessor

UserSelectorProcessor::isMultiple() — Method in class UserSelectorProcessor

$ Page#index — Property in class Page

$ Page#info — Property in class Page

Page::index() — Method in class Page

Page::info() — Method in class Page

$ PageDocumentation#id — Property in class PageDocumentation

$ PageDocumentation#is_template: — Property in class PageDocumentation

stored in MySQL as tinyint

$ PageHistoryDocumentation#id — Property in class PageHistoryDocumentation

$ PageLinkDocumentation#id — Property in class PageLinkDocumentation

InstallEvents — Class in namespace XELOS\Modules\SmartWiki

Class InstallEvents

$ Page#id — Property in class Page

$ Page#is_template — Property in class Page

$ Page#is_content_fixed — Property in class Page

Page::isRecentVersion() — Method in class Page

IndexPage — Class in namespace XELOS\Modules\SmartWiki\Page

InfoPage — Class in namespace XELOS\Modules\SmartWiki\Page

$ SmartWikiController#includeInstanceTemplates — Property in class SmartWikiController

SmartWikiController::init() — Method in class SmartWikiController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

Page::init() — Method in class Page

put your comment there.

ActivityCollection::init() — Method in class ActivityCollection

Use init for default sort order of your collection

EntryCollection::init() — Method in class EntryCollection

Use init for default sort order of your collection

$ DocumentWallItemDocumentation#id — Property in class DocumentWallItemDocumentation

$ EntryDocumentation#id — Property in class EntryDocumentation

$ EntryDocumentation#instance_id: — Property in class EntryDocumentation

stored in MySQL as varchar

$ EntryDocumentation#ip: — Property in class EntryDocumentation

stored in MySQL as varchar

$ HiddenInstanceDocumentation#id — Property in class HiddenInstanceDocumentation

$ HiddenInstanceDocumentation#instance_id: — Property in class HiddenInstanceDocumentation

stored in MySQL as varchar

WallPortlet::isAvailable() — Method in class WallPortlet

Entry::init() — Method in class Entry

Initializes the model

SystemActionlogController::init() — Method in class SystemActionlogController

$ BackupQueue#id — Property in class BackupQueue

$ BackupQueue#instance_id: — Property in class BackupQueue

stored in MySQL as varchar

$ EventTrigger#id — Property in class EventTrigger

$ EventTrigger#is_active: — Property in class EventTrigger

stored in MySQL as tinyint

InstallQueue — Class in namespace XELOS\Modules\SystemAdmin\Docs\ClassGenerated\Model

This file provides property and method documentation for the model InstallQueue.

$ InstallQueue#id — Property in class InstallQueue

CategoryCollection::init() — Method in class CategoryCollection

Use init for default sort order of your collection

DocumentCollection::init() — Method in class DocumentCollection

Use init for default sort order of your collection

CrmPortletShowTab::init() — Method in class CrmPortletShowTab

Executes immediately after construction

CrmPortletShowTab::init_portlet() — Method in class CrmPortletShowTab

Called within Tab Renderer

SelectorBrowser::is_consented() — Method in class SelectorBrowser

Checks whether this browser is consented.

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\SystemDMS\Hook\System

Class XELOS\Modules\SystemDMS\Hook\System\xm_system_dms_index_event

WebdavService::init() — Method in class WebdavService

Initialization

WebdavService::is_available() — Method in class WebdavService

WebdavService::id_to_path() — Method in class WebdavService

ApiService::initFileUpload() — Method in class ApiService

InstallEvents — Class in namespace XELOS\Modules\SystemDMS

Class InstallEvents

Category::is_name_in_category() — Method in class Category

Checks if the current category has a name-duplicate in its parent-category.

Category::is_parent_of() — Method in class Category

Category::is_personal() — Method in class Category

Returns whether this category is one of a personal workspace folder.

Category::is_personal_root() — Method in class Category

Category::is_share_root() — Method in class Category

Category::is_from_share() — Method in class Category

Category::increase_folder_size() — Method in class Category

Increases the size of this and all affected folders.

Document::init() — Method in class Document

Initialization

Document::is_name_in_category() — Method in class Document

Checks if the current document has a NAME-duplicate in its Category (Important for webDav-Listing) A Duplicate must have the same File-Extension, too.

Document::is_mime_type() — Method in class Document

Checks if the mime type of this document matches the given mime type.

Document::is_locked() — Method in class Document

Check if referenced document is locked

Document::isVideo() — Method in class Document

Document::isImage() — Method in class Document

Document::isPreviewReady() — Method in class Document

Checks if the previews are already available

DocumentTemplate::init() — Method in class DocumentTemplate

CategoryPage::init() — Method in class CategoryPage

Initialization

ImportCategoryPage — Class in namespace XELOS\Modules\SystemDMS\Page

Class ImportCategoryPage

ImportCategoryPage::init() — Method in class ImportCategoryPage

Initialization.

$ SystemDMSController#initialized — Property in class SystemDMSController

SystemDMSController::init() — Method in class SystemDMSController

Initializes object

Category::init() — Method in class Category

Initialization

Document::init() — Method in class Document

Initialization

DocumentPanel::init() — Method in class DocumentPanel

Initialization

$ Page#import_category — Property in class Page

Page::import_category() — Method in class Page

$ Category#id — Property in class Category

$ Category#is_root — Property in class Category

: stored in MySQL as tinyint

$ Document#id — Property in class Document

$ DocumentHistory#id — Property in class DocumentHistory

$ DocumentMetaData#id — Property in class DocumentMetaData

$ DocumentMetaField#id — Property in class DocumentMetaField

$ DocumentTemplate#id — Property in class DocumentTemplate

$ FileTemplate#id — Property in class FileTemplate

$ Preview#id — Property in class Preview

$ ZipImportJob#id — Property in class ZipImportJob

AdminSystemMailUserAdminConfig::init() — Method in class AdminSystemMailUserAdminConfig

UserSystemMailUserConfig::init() — Method in class UserSystemMailUserConfig

UserSystemMailUserConfig::isAvailable() — Method in class UserSystemMailUserConfig

Should tab be loaded and shown?

$ ChannelSettingDocumentation#id — Property in class ChannelSettingDocumentation

$ UserSettingDocumentation#id — Property in class UserSettingDocumentation

SettingsUserConfig::init() — Method in class SettingsUserConfig

SettingsUserConfig::isAvailable() — Method in class SettingsUserConfig

NotificationChannel::init() — Method in class NotificationChannel

Initialize

EmailNotificationChannel::isAvailable() — Method in class EmailNotificationChannel

TodoPortlet::isEmpty() — Method in class TodoPortlet

Returns true if the portlet returns an empty result (is used be the frontend to hide empty elements)

ActivityUpdateFrontendHook::isAvailable() — Method in class ActivityUpdateFrontendHook

Returns true if this hook is available otherwise false.

UpdateFrontendHook::isAvailable() — Method in class UpdateFrontendHook

Returns true if this hook is available otherwise false.

$ SystemNotificationTest#instance — Property in class SystemNotificationTest

$ PushSubscriptionDocumentation#id — Property in class PushSubscriptionDocumentation

PushNotificationChannel::isAvailable() — Method in class PushNotificationChannel

EventCollection::init() — Method in class EventCollection

Use init for default sort order of your collection

$ AggregateDimensionDocumentation#id — Property in class AggregateDimensionDocumentation

$ AggregateDimensionDocumentation#instance_id — Property in class AggregateDimensionDocumentation

$ EventDocumentation#id — Property in class EventDocumentation

$ EventDocumentation#ip: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#inserted_at: — Property in class EventDocumentation

stored in MySQL as datetime

Collector::isAvailable() — Method in class Collector

Returns true if this hook is available otherwise false.

WhoisonlineShowPortlet::init() — Method in class WhoisonlineShowPortlet

InstallEvents — Class in namespace XELOS\Modules\SystemStats

CollectorData::isValidAggregationLevel() — Method in class CollectorData

Checks if the provided aggregation level is valid.

$ AggregateDimension#instance_string — Property in class AggregateDimension

SystemStatsController::init() — Method in class SystemStatsController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

AggregationChart::init() — Method in class AggregationChart

put your comment there.

$ CheckDocumentation#id — Property in class CheckDocumentation

$ CheckDocumentation#instance_id: — Property in class CheckDocumentation

stored in MySQL as varchar

$ CheckDocumentation#icon: — Property in class CheckDocumentation

stored in MySQL as varchar

$ NodeDocumentation#id — Property in class NodeDocumentation

$ Check#icon — Property in class Check

Check::isAvailable() — Method in class Check

Returns true if this hook is available otherwise false.

$ Result#icon — Property in class Result

GlobalTaskCollection::init() — Method in class GlobalTaskCollection

GlobalTaskListCollection::init() — Method in class GlobalTaskListCollection

RecurringTaskCollection::init() — Method in class RecurringTaskCollection

Use init for default sort order of your collection

TaskCollection::init() — Method in class TaskCollection

Use init for default sort order of your collection

TaskListCollection::init() — Method in class TaskListCollection

Use init for default sort order of your collection

$ RecurringTaskDocumentation#id — Property in class RecurringTaskDocumentation

$ TaskDocumentation#id — Property in class TaskDocumentation

CalendarLinkGetEvents::isAvailable() — Method in class CalendarLinkGetEvents

Returns true if this hook is available otherwise false.

NewTaskProcessor::init() — Method in class NewTaskProcessor

ShowTasksShowPortlet::init() — Method in class ShowTasksShowPortlet

InstallEvents — Class in namespace XELOS\Modules\SystemTasks

$ Task#id — Property in class Task

$ TaskList#id — Property in class TaskList

$ TaskListColumn#id — Property in class TaskListColumn

SystemTasksController::isGroupsTasks() — Method in class SystemTasksController

Is the current instance used in groups?

Task::init() — Method in class Task

put your comment there.

TasksList::init() — Method in class TasksList

put your comment there.

SystemWorkerController::init() — Method in class SystemWorkerController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

BaseWorker::isWorkerAvailable() — Method in class BaseWorker

Can we connect to the worker service / container?

LibreofficeWorker::isDocumentConversionSupported() — Method in class LibreofficeWorker

Is the conversion of the document supported according to our knowledge? Todo: We might be able to retrieve / populate this list dynamically from the worker later.. Todo: Do we want to support the old configurations?

$ PushClient#id — Property in class PushClient

MobileNotificationChannel::isAvailable() — Method in class MobileNotificationChannel

$ Webservice#isInternal — Property in class Webservice

TagCollection::init() — Method in class TagCollection

Use init for default sort order of your collection

$ TagDocumentation#id — Property in class TagDocumentation

CloudShowPortlet::init() — Method in class CloudShowPortlet

InstallEvents — Class in namespace XELOS\Modules\Tagging

InstallEvents — Class in namespace XELOS\Modules\TemplateMaApp

Class InstallEvents

$ TranslationDocumentDocumentation#id — Property in class TranslationDocumentDocumentation

$ TranslationDocumentation#id — Property in class TranslationDocumentation

$ TranslationFeedbackDocumentation#id — Property in class TranslationFeedbackDocumentation

$ TranslationJobDocumentation#id — Property in class TranslationJobDocumentation

TranslationSettingsLanguageConfig::isAvailable() — Method in class TranslationSettingsLanguageConfig

Returns true if this hook is available otherwise false.

TranslateProcessor::init() — Method in class TranslateProcessor

TranslateDocumentSearchPreprocessor::isAvailable() — Method in class TranslateDocumentSearchPreprocessor

Determines if the translate search result config option is enabled

IndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\Translation\Hook\System

Is triggered when a document_index is created or modified. Check if the translation API has to be called.

TranslationInProgressFrontendHook::isAvailable() — Method in class TranslationInProgressFrontendHook

Returns true if this hook is available otherwise false.

InstallEvents — Class in namespace XELOS\Modules\Translation

$ BaseTranslationApi#ignoreTags — Property in class BaseTranslationApi

$ TranslationControllerTest#i18nMock — Property in class TranslationControllerTest

TranslationController::init() — Method in class TranslationController

Declare this method in a XELOS module if you require standard code to be executed after __construct with all members and references available

TranslationController::isInlineTranslationDisabled() — Method in class TranslationController

TranslationController::isBackgroundTranslationDisabled() — Method in class TranslationController

Returns the state of the disable_background_translations option

TranslationController::isTranslationDisabled() — Method in class TranslationController

Check if the translation for the given language is disabled

TranslationController::isValidTranslationModelName() — Method in class TranslationController

Is the $name a valid translation model name?

TranslationController::isValidLocale() — Method in class TranslationController

Checks, if the given $locale is in available_languages

ResultCollection::init() — Method in class ResultCollection

Use init for default sort order of your collection

TrendvoteCollection::init() — Method in class TrendvoteCollection

Use init for default sort order of your collection

$ Trendvote#id — Property in class Trendvote

$ Trendvote#icon: — Property in class Trendvote

stored in MySQL as varchar

$ ApiService#isInternal — Property in class ApiService

InstallEvents — Class in namespace XELOS\Modules\Trendvote

$ Trendvote#id — Property in class Trendvote

$ Trendvote#icon — Property in class Trendvote

$ FileDocumentation#id — Property in class FileDocumentation

$ ScanDocumentation#id — Property in class ScanDocumentation

VirusCheck::init() — Method in class VirusCheck

DigestAuthentication::isAvailable() — Method in class DigestAuthentication

Show this authentication method if installed, even if its not configured yet

OAuthServerAction::init() — Method in class OAuthServerAction

OAuthServerAction::is_authorization_code_valid() — Method in class OAuthServerAction

Returns true if the passed authorization code is still valid

$ Service#isInternal — Property in class Service

Service::init() — Method in class Service

Initialization after construction with access to $this->mod

Service::isAvailable() — Method in class Service

Returns true if this hook is available otherwise false.

Service::isInternal() — Method in class Service

$ OAuthClientHook#icon_class — Property in class OAuthClientHook

Client Icon for the OAuth Client Hook

OAuthClientHook::init() — Method in class OAuthClientHook

Webservice Mod will be initialized

OAuthClientHook::init_service() — Method in class OAuthClientHook

Called from init, use to setup your configuration settings within the hook (optional)

OAuthClientHook::isHiddenForUsers() — Method in class OAuthClientHook

Returns if this API should be connectable by users in their settings Default will evaluate max_user_connections Override this method to implement your own logic (e.g. policy based)

OAuthClientHook::isHiddenGlobal() — Method in class OAuthClientHook

Returns if this API should be connectable by by administrators in global mode Default will evaluate max_global_connections Override this method to implement your own logic (e.g. policy based)

OAuthClientHook::isAllowedMultipleGlobal() — Method in class OAuthClientHook

OAuthClientHook::isAllowedMultipleForUsers() — Method in class OAuthClientHook

OAuthClientHook::isSingleGlobal() — Method in class OAuthClientHook

OAuthClientHook::isSingleForUsers() — Method in class OAuthClientHook

OAuthClientHook::isAllowedExplicitConnection() — Method in class OAuthClientHook

Returns whether the client allows an explicit connection triggered by the user e.g. via button.

OAuthClientHook::isModelValid() — Method in class OAuthClientHook

OAuthClientHook::isBasicAuthorization() — Method in class OAuthClientHook

InstallEvents — Class in namespace XELOS\Modules\Webservice

Class InstallEvent

ServiceInterface::init() — Method in class ServiceInterface

Initialization after construction with access to $this->mod

$ OAuthClient#issuerUrl — Property in class OAuthClient

$ OAuthClient#isPersonal — Property in class OAuthClient

false = Admin has created account

OAuthClient::isConnected() — Method in class OAuthClient

Prove connection within xelos intranet to avoid to much request to an oauth server

OAuthClient::isPersonal() — Method in class OAuthClient

OAuthClient::isSendBasicAuthorization() — Method in class OAuthClient

$ OpenIDConfiguration#issuerUri — Property in class OpenIDConfiguration

OauthAccess::isExpired() — Method in class OauthAccess

JsonPage::invokeServiceMethod() — Method in class JsonPage

OAuthAccountsPage::init() — Method in class OAuthAccountsPage

OAuthAccountsPage::isShowUserAccounts() — Method in class OAuthAccountsPage

WebserviceController::init_server() — Method in class WebserviceController

$ CategoryDocumentation#id — Property in class CategoryDocumentation

$ WidgetDocumentation#id — Property in class WidgetDocumentation

$ WidgetDocumentation#icon: — Property in class WidgetDocumentation

stored in MySQL as varchar

ImportException — Class in namespace XELOS\Modules\Workflows\Exceptions

Class ImportException

$ ActionIntegrationTestBase#instance — Property in class ActionIntegrationTestBase

$ WorkflowItemProcessTest#instance — Property in class WorkflowItemProcessTest

IndexDaemonPerformance — Class in namespace XELOS\Tests\Codeception\Performance\Model

Class ModelSavePerformanceTest

$ AnswerDocumentation#id — Property in class AnswerDocumentation

$ ParticipantDocumentation#id — Property in class ParticipantDocumentation

$ SurveyDocumentation#id — Property in class SurveyDocumentation

CmsSimplePortletShowPortlet::init() — Method in class CmsSimplePortletShowPortlet

J

Core::jsonResponse() — Method in class Core

Returns the passed data object as JSON body response

ItemListTrait::jsonSerialize() — Method in class ItemListTrait

ItemTrait::jsonSerialize() — Method in class ItemTrait

Transforms the array structure of this option into a JSON string.

SerializableObjectTrait::jsonSerialize() — Method in class SerializableObjectTrait

Job — Class in namespace XELOS\Framework\Module\Infrastructure\Job

Collection::joinDocumentIndex() — Method in class Collection

Joins the system_document_index table

$ UIAjaxComponent#js_class — Property in class UIAjaxComponent

$ UIAjaxComponent#js_options — Property in class UIAjaxComponent

Query::joinInner() — Method in class Query

Add basic inner join based on simple condition

Query::joinLeft() — Method in class Query

Add basic inner join based on simple condition

Query::join() — Method in class Query

Add join based on simple condition.

Query::joinAddCondition() — Method in class Query

Adds a join condition to the previous defined join, e.g.: AND {$baseTable}.{$baseTableField} = {$joinTable}.{$joinTableField}

Query::joinsFromQuery() — Method in class Query

JsonParser — Class in namespace XELOS\Framework\XF\Lib\i18n\Parser

$ UI#js_blocks — Property in class UI

$ UI#js_files — Property in class UI

Option::jsonSerialize() — Method in class Option

Transforms the array structure of this option into a JSON string.

JavaScript — Class in namespace XELOS\Framework\XF\UI

Js — Class in namespace XELOS\Framework\XF\UI

ModalDialog::jsonSerialize() — Method in class ModalDialog

Options::jsonSerialize() — Method in class Options

$ VideoPlayer#js_class — Property in class VideoPlayer

$ ViewModeSwitcher#js_class — Property in class ViewModeSwitcher

$ PageLive#js_files: — Property in class PageLive

stored in MySQL as text

JobDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Job.

$ VoteBox#js_options — Property in class VoteBox

Marker::jsonSerialize() — Method in class Marker

JobQueueControllerDocumentation — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Model#job — Property in class Model

$ Model#job_history — Property in class Model

$ Model#job_status — Property in class Model

Model::job() — Method in class Model

Model::job_history() — Method in class Model

Model::job_status() — Method in class Model

$ Ui#job_ui_status — Property in class Ui

JobDocumentation — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Job.

$ JobDocumentation#job_class: — Property in class JobDocumentation

stored in MySQL as varchar

$ JobDocumentation#job_data: — Property in class JobDocumentation

stored in MySQL as mediumblob

$ JobDocumentation#job_uniqueness_hash: — Property in class JobDocumentation

stored in MySQL as varchar

JobHistoryDocumentation — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated\Model

This file provides property and method documentation for the model JobHistory.

$ JobHistoryDocumentation#job_class: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

$ JobHistoryDocumentation#job_data: — Property in class JobHistoryDocumentation

stored in MySQL as mediumblob

$ JobHistoryDocumentation#job_uniqueness_hash: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

JobQueueCheck — Class in namespace XELOS\Modules\JobQueue\Hook\SystemStatus

JobScheduler — Class in namespace XELOS\Modules\JobQueue\Infrastructure

JobStatus — Class in namespace XELOS\Modules\JobQueue\Infrastructure

$ BatchJob#jobs — Property in class BatchJob

$ BatchJob#jobTokens — Property in class BatchJob

JobQueueController — Class in namespace XELOS\Modules\JobQueue

Class JobQueueController

Job — Class in namespace XELOS\Modules\JobQueue\Model

JobHistory — Class in namespace XELOS\Modules\JobQueue\Model

Class JobHistory

JobStatus — Class in namespace XELOS\Modules\JobQueue\Model

Deprecated - use XELOS\Modules\JobQueue\Infrastructure\JobStatusEnum

JobUIStatus — Class in namespace XELOS\Modules\JobQueue\UI

JsonPathElement — Class in namespace XELOS\Modules\Pages\Lib

Simple JsonPath Reader/Writer Attention: This reader/writer only supports the basic parent/child syntax and is not intended to support more All existing PHP libraries for JSONPath are buggy, to not properly use object base json_decode (leading to errors) or do not support writing of elements

$ DocumentPage#js_class — Property in class DocumentPage

$ FilterPanel#js_class — Property in class FilterPanel

$ FolderTreePanel#js_class — Property in class FolderTreePanel

$ FolderTreePanel#js_options — Property in class FolderTreePanel

$ PreviewLoader#js_class — Property in class PreviewLoader

$ ReportSpecificationHelper#js_class — Property in class ReportSpecificationHelper

$ ZipImportStatusBar#js_options — Property in class ZipImportStatusBar

$ OAuthClient#jwksUrl — Property in class OAuthClient

$ OpenIDConfiguration#jwksUri — Property in class OpenIDConfiguration

JsonPage — Class in namespace XELOS\Modules\Webservice\Page

K

Shell::kill_process_id() — Method in class Shell

$ FroalaInsertGroup#key — Property in class FroalaInsertGroup

FroalaOption::keepFormatOnDelete() — Method in class FroalaOption

Keep format of the selected text when it is deleted.

$ HistoryPage#keyword_id: — Property in class HistoryPage

stored in MySQL as varchar

$ Page#keyword_id: — Property in class Page

stored in MySQL as varchar

$ PageLive#keyword_id: — Property in class PageLive

stored in MySQL as varchar

$ Page#kanban — Property in class Page

Page::kanban() — Method in class Page

KanbanPage — Class in namespace XELOS\Modules\GroupsTasks\Page

$ XfsDocument#keep_image_ratio — Property in class XfsDocument

$ Page#kanban — Property in class Page

Page::kanban() — Method in class Page

KanbanPage — Class in namespace XELOS\Modules\SystemTasks\Page

$ Deepl#key — Property in class Deepl

$ Transperfect#key — Property in class Transperfect

L

Autoloader::load_class() — Method in class Autoloader

Require Class File

Autoloader::load_class_file() — Method in class Autoloader

Loads the passed class file

Autoloader::lookup_classname_from_classmap() — Method in class Autoloader

Returns all Classmap Details for the given class name

Bootloader::loadConfiguration() — Method in class Bootloader

Define a configuration file which should be loaded instead

LdapAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

NtlmAuthentication::logout() — Method in class NtlmAuthentication

RemembermeAuthentication::logout() — Method in class RemembermeAuthentication

$ UserDetails#login — Property in class UserDetails

$ UserDetails#lastname — Property in class UserDetails

$ Console#logger — Property in class Console

Console::listCommands() — Method in class Console

Prints a list of all available commands with arguments and exit.

ConsoleLogger::log() — Method in class ConsoleLogger

Core::lpquery() — Method in class Core

LinkContextHelper — Class in namespace XELOS\Framework\Core\Helper

Class LinkContextHelper

LocalvarsInterface — Class in namespace XELOS\Framework\Core\Interfaces

Interface LocalvarsInterface

$ Template#last_xtag_if_value — Property in class Template

$ Template#last_parse_template — Property in class Template

Template::load_theme_set_config() — Method in class Template

Set the theme configuration (theme set config)

ItemListTrait::last() — Method in class ItemListTrait

Return the last element

LegacyTrait — Class in namespace XELOS\Framework\Core\Traits

Trait LegacyTrait

$ ObjectManager#lib_class_dir — Property in class ObjectManager

This property contains the path to the folder served as root for all requested classes. This folder can contains other folder or classes. All requested and registered classes will be searched in this folder by concating this path with the relative path defined in the registration of the requested class. If the class is not included it will be done on the fly.

$ ObjectManager#lib_class_prefix — Property in class ObjectManager

An optional possibility to pretend a prefix for all registered classes.

$ VarsTemplate#language: — Property in class VarsTemplate

stored in MySQL as char

$ VarsTemplate#loaded_from — Property in class VarsTemplate

string db|file or false if could not be loaded

LegacyController — Class in namespace XELOS\Framework\Module\Controller

Class LegacyController

AuthenticationHook::login() — Method in class AuthenticationHook

$ Model#loaded — Property in class Model

Model::load() — Method in class Model

Model::load_from_db() — Method in class Model

$ ModelCollection#loaded — Property in class ModelCollection

Boolean which indicates whether collection is loaded or not (not equal empty!)

ModelCollection::last() — Method in class ModelCollection

Return the last element of the collection, not popping

ModelCollection::limit() — Method in class ModelCollection

Limit the visible articles.

$ SystemCron#last_execution — Property in class SystemCron

When was this cron last executed/finished

$ SystemCron#last_start — Property in class SystemCron

When was this cron last started

SystemCron::load_module_instances() — Method in class SystemCron

$ SystemDaemon#lastRequestCacheClearingTime — Property in class SystemDaemon

SystemDaemon::load_module_instances() — Method in class SystemDaemon

$ Document#layout — Property in class Document

$ UIAjaxComponent#link — Property in class UIAjaxComponent

$ UIComponent#link_id — Property in class UIComponent

$ UIComponent#local_template_marker — Property in class UIComponent

$ XF#lib — Property in class XF

Config::leave_install_mode() — Method in class Config

Leaves the install mode by setting install mode property to false.

Config::load_global_settings() — Method in class Config

Config::load_user_settings() — Method in class Config

Config::load_group_settings() — Method in class Config

Config::load_instance_settings() — Method in class Config

Config::load_config_set() — Method in class Config

Config::load_domain_settings() — Method in class Config

$ DB#link — Property in class DB

$ MySQLAdapter#last_result — Property in class MySQLAdapter

$ MySQLAdapter#link — Property in class MySQLAdapter

MySQLAdapter::lquery() — Method in class MySQLAdapter

Execute Query Wrapper for Languages

MySQLAdapter::lpquery() — Method in class MySQLAdapter

Execute PQuery Wrapper for Languages

PartitionQuery::limit() — Method in class PartitionQuery

Query::limit() — Method in class Query

Set Limit on Query

Lib — Class in namespace XELOS\Framework\XF

Class Lib

$ Lib#link — Property in class Lib

$ Connect#last_error — Property in class Connect

Date::local_to_utc() — Method in class Date

Converts a LOCAL timestamp to a UTC timestamp

Debug::log() — Method in class Debug

$ Error#link — Property in class Error

$ Error#log_type — Property in class Error

$ Error#log_email — Property in class Error

$ Error#log_level — Property in class Error

Error::logException() — Method in class Error

Log Exception

Error::log() — Method in class Error

File::ll() — Method in class File

File::ll_r() — Method in class File

Returns an array with all files in the given directory (Recursive)

Format::limit_string() — Method in class Format

Checks if the last character is or isnt a space. (does it the normal way if it is) It explodes the string into an array of seperate words, the effect is... it chops off anything after and including the last space.

Format::link_parse() — Method in class Format

Parst einen Text

$ I18n#language — Property in class I18n

$ I18n#locale — Property in class I18n

$ I18n#locale_set — Property in class I18n

Last locale that has been set

$ I18n#last_template_loaded_from — Property in class I18n

after load_template is called, you can get the location, the template is loaded from via this property

$ I18n#last_template_is_custom — Property in class I18n

after load_template is called, you can get if the template is a custum template or not

I18n::list_timezones() — Method in class I18n

Generates an array of all timezones, using their identifier as the key and including their offset in the label

I18n::load_template() — Method in class I18n

Seeding::loadSeed() — Method in class Seeding

Starts the seeding of the passed instance with the passed seed (if existing)

Link — Class in namespace XELOS\Framework\XF\Lib

Link Helper

$ HandlerFactory#level — Property in class HandlerFactory

Logger — Class in namespace XELOS\Framework\XF\Lib\Logger

Class Logger

$ Logger#logger — Property in class Logger

$ Logger#lastLogEntry — Property in class Logger

Logger::log() — Method in class Logger

Modsetup::log() — Method in class Modsetup

Session::logout_user() — Method in class Session

Logout specific users(Destroys a specific Session)

SessionManagementInterface::logout_all_users() — Method in class SessionManagementInterface

Logsout all current user sessions (Destroys ALL sessions)

SessionManagementInterface::logout_user() — Method in class SessionManagementInterface

Logout specific users(Destroys a specific Session)

$ RedisSessionHandler#life_time — Property in class RedisSessionHandler

Life Time for this Session (Currently a Session specific Timeout is NOT SUPPORTED by REDIS)

RedisSessionHandler::logout_all_users() — Method in class RedisSessionHandler

RedisSessionHandler::logout_user() — Method in class RedisSessionHandler

$ SqlSessionHandler#life_time — Property in class SqlSessionHandler

SqlSessionHandler::logout_all_users() — Method in class SqlSessionHandler

Logsout all current user sessions (Destroys ALL sessions)

SqlSessionHandler::logout_user() — Method in class SqlSessionHandler

Logout specific users(Destroys a specific Session)

Text::limit_string() — Method in class Text

Checks if the last character is or isnt a space. (does it the normal way if it is) It explodes the string into an array of seperate words, the effect is... it chops off anything after and including the last space.

Yaml::load() — Method in class Yaml

Load YAML into a PHP array statically

Yaml::loadCachedYamlFile() — Method in class Yaml

Load YAML file and use cached version if possible

Yaml::loadYamlFile() — Method in class Yaml

$ Model#lib_country — Property in class Model

DocumentIndexLock::lockDocument() — Method in class DocumentIndexLock

Add/Update lock to document,

$ DocumentIndexReference#level — Property in class DocumentIndexReference

'read', 'owner', 'share'; default 'read'

$ I18nToken#language — Property in class I18nToken

Language

LibCountry — Class in namespace XELOS\Framework\XF\System\Model

$ Notification#link — Property in class Notification

$ Pages#level — Property in class Pages

$ Policy#level — Property in class Policy

User::load_meta() — Method in class User

User::load_unverified() — Method in class User

User::load_user_groups() — Method in class User

$ UserLink#label — Property in class UserLink

$ Breadcrumb#last_level_clickable — Property in class Breadcrumb

$ Doclink#link_label — Property in class Doclink

$ FacetedCategory#label — Property in class FacetedCategory

$ FormRowRenderer#label — Property in class FormRowRenderer

$ FormRowRenderer#layout — Property in class FormRowRenderer

$ FormRowRendererMultirowTable#labels — Property in class FormRowRendererMultirowTable

$ FroalaInsertGroup#label — Property in class FroalaInsertGroup

FroalaOption::language() — Method in class FroalaOption

Select the language to be used in the rich text editor's interface. The corresponding language file is required: /langs/es.js.

FroalaOption::lineBreakerHorizontalOffset() — Method in class FroalaOption

The distance in pixels from the left or right of an element at which to show the line-breaker.

FroalaOption::lineBreakerOffset() — Method in class FroalaOption

The distance in pixels from the top or bottom of an element at which to show the line-breaker.

FroalaOption::lineBreakerTags() — Method in class FroalaOption

The list of HTML tags between which the line-breaker should appear.

FroalaOption::linkAlwaysBlank() — Method in class FroalaOption

When enabled, all links open in a new tab and no option to set this action would be presented in the UI.

FroalaOption::linkAlwaysNoFollow() — Method in class FroalaOption

Specifies if the rel="nofollow" attribute should be added on all links.

FroalaOption::linkAttributes() — Method in class FroalaOption

An object with additional attributes that could be customized for a link.

FroalaOption::linkAutoPrefix() — Method in class FroalaOption

Sets the default URL prefix.

FroalaOption::linkConvertEmailAddress() — Method in class FroalaOption

Email addresses inserted as link are converted to mailto: links.

FroalaOption::linkEditButtons() — Method in class FroalaOption

The list of buttons that appear in the edit link popup, when clicking on an existing link from the editor.

FroalaOption::linkInsertButtons() — Method in class FroalaOption

The list of buttons that appear in the insert link popup, when inserting a new link into the WYSIWYG editor.

FroalaOption::linkList() — Method in class FroalaOption

Set a predefined list of links to select from when inserting or editing a link.

FroalaOption::linkMultipleStyles() — Method in class FroalaOption

Allows multiple link styles to be selected at a time.

FroalaOption::linkNoOpener() — Method in class FroalaOption

Disables adding the noopener attribute when link is set to open in a new tab.

FroalaOption::linkNoReferrer() — Method in class FroalaOption

Disables adding the noreferrer attribute when link is set to open in a new tab.

FroalaOption::linkStyles() — Method in class FroalaOption

Set custom styles for the selected link. The classes should be defined in CSS, otherwise no changes will be visible on the link's appearance.

FroalaOption::linkText() — Method in class FroalaOption

This option allows to edit the link text inside the edit link popup.

FroalaOption::lineHeights() — Method in class FroalaOption

Set the line height for the current selected paragraph.

FroalaOption::listAdvancedTypes() — Method in class FroalaOption

Enables list advanced types for the bullets.

OptionList::last() — Method in class OptionList

$ Instance#link_mode — Property in class Instance

Link — Class in namespace XELOS\Framework\XF\UI

Basic Link Helper

$ Link#link_id — Property in class Link

$ ProgressBar#label — Property in class ProgressBar

$ Table#limit — Property in class Table

$ Table#large_export — Property in class Table

$ Table#link_id — Property in class Table

$ TableEditor#links — Property in class TableEditor

$ TimeLineRow#label — Property in class TimeLineRow

$ Tree#link_field — Property in class Tree

Tree::load_tree_array() — Method in class Tree

UserLink::load_user_data() — Method in class UserLink

User::loginWithAuthMethod() — Method in class User

Login user with specific authMethod only

User::login() — Method in class User

Try to login the user/pass

User::logout() — Method in class User

Logout out the current user

User::load_settings() — Method in class User

Load user settings from database (user needs to be logged in)

User::load_user_groups() — Method in class User

Load User Security Groups from Session or DB, depending on availability or dirty session

User::load_user_policy() — Method in class User

lazy load policy for user

View::load_theme_template() — Method in class View

Load currently active template or set

LdapAction — Class in namespace XELOS\Modules\AdSync\Action

Action::Ldap() — Method in class Action

ListPage — Class in namespace XELOS\Modules\AdSync\Page

$ Page#license — Property in class Page

Page::license() — Method in class Page

LanguageSettingLanguageConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

LanguageConfigInterface — Class in namespace XELOS\Modules\Administration\Hook\Base

Interface ConfigUserInterface

ApiService::list_users() — Method in class ApiService

ApiService::list_security_groups() — Method in class ApiService

List all available security groups

ApiService::list_module_group_security() — Method in class ApiService

List all available security groups

LicensePage — Class in namespace XELOS\Modules\Administration\Page

Class Overview

ApiCloudstorageController::load_storage_providers() — Method in class ApiCloudstorageController

Loads all storage providers by hooks.

AzureAuthentication::login() — Method in class AzureAuthentication

AzureAuthentication::logout() — Method in class AzureAuthentication

OpenidAuthentication::login() — Method in class OpenidAuthentication

OpenidAuthentication::logout() — Method in class OpenidAuthentication

SamlAuthentication::login() — Method in class SamlAuthentication

Authenticate User

SamlAuthentication::logout() — Method in class SamlAuthentication

$ Event#location: — Property in class Event

stored in MySQL as varchar

$ Event#link: — Property in class Event

stored in MySQL as varchar

$ SyncData#last_event_change: — Property in class SyncData

stored in MySQL as timestamp

$ SyncData#last_sync_change: — Property in class SyncData

stored in MySQL as timestamp

$ SyncSetting#last_sync: — Property in class SyncSetting

stored in MySQL as timestamp

$ SyncSetting#last_error: — Property in class SyncSetting

stored in MySQL as text

$ CalendarInterface#loaded — Property in class CalendarInterface

Required to be true for access checks

$ History#language — Property in class History

$ HistoryPage#layout_class: — Property in class HistoryPage

stored in MySQL as varchar

$ HistoryPage#language — Property in class HistoryPage

$ Page#layout_class: — Property in class Page

stored in MySQL as varchar

$ Page#language — Property in class Page

$ PageLive#layout_class: — Property in class PageLive

stored in MySQL as varchar

$ PageLive#language — Property in class PageLive

$ Model#link_info — Property in class Model

Model::link_info() — Method in class Model

$ Comment#link_info_id — Property in class Comment

LinkInfo — Class in namespace XELOS\Modules\Comments\Docs\ClassGenerated\Model

This file provides property and method documentation for the model link_info.

LinkInfo — Class in namespace XELOS\Modules\Comments\Model

Class LinkInfo

$ EventDocumentation#location: — Property in class EventDocumentation

stored in MySQL as varchar

$ ParticipantDocumentation#lastname: — Property in class ParticipantDocumentation

stored in MySQL as varchar

$ EventplannerController#lookbook — Property in class EventplannerController

$ Event#layout — Property in class Event

CategoryCollection::loadCategoryInfo() — Method in class CategoryCollection

Fetches the amount of even deeper sub-categories and threads from all sub-categories of the current category.

$ CategoryDocumentation#left_id — Property in class CategoryDocumentation

$ ThreadDocumentation#last_reply_post_id — Property in class ThreadDocumentation

$ ThreadDocumentation#last_reply_created_by — Property in class ThreadDocumentation

$ ThreadDocumentation#last_reply_time: — Property in class ThreadDocumentation

stored in MySQL as timestamp

$ ThreadDocumentation#last_reply_title: — Property in class ThreadDocumentation

stored in MySQL as varchar

CreatorRole::login() — Method in class CreatorRole

ParticipantRole::login() — Method in class ParticipantRole

LocationCollection — Class in namespace XELOS\Modules\Geodb\Collection

GeoIpAuthentication::login() — Method in class GeoIpAuthentication

$ GeoFeature#latitude — Property in class GeoFeature

$ GeoFeature#longitude — Property in class GeoFeature

$ GeoFeature#label — Property in class GeoFeature

GeoSelectorProcessor::locationFromCombinedKey() — Method in class GeoSelectorProcessor

Looks up the corresponding geolocation feature upon saving the form model and triggering the afterSave event listener.

Location — Class in namespace XELOS\Modules\Geodb\Model

$ Location#longitude — Property in class Location

$ Location#latitude — Property in class Location

$ TaskDocumentation#list_id — Property in class TaskDocumentation

$ Category#left_id — Property in class Category

$ Group#lang: — Property in class Group

stored in MySQL as varchar

$ Group#listed: — Property in class Group

stored in MySQL as tinyint

$ Group#logo_img: — Property in class Group

stored in MySQL as varchar

$ Group#last_maintenance: — Property in class Group

stored in MySQL as timestamp

$ Group#last_activity_at: — Property in class Group

stored in MySQL as timestamp

$ Member#last_visit: — Property in class Member

stored in MySQL as timestamp

$ Newsletter#lists: — Property in class Newsletter

stored in MySQL as text

LeaveApplicationCollection — Class in namespace XELOS\Modules\HRM\Collection

LegalControllerDocumentation — Class in namespace XELOS\Modules\Legal\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

LegalController — Class in namespace XELOS\Modules\Legal

LegalControllerCest — Class in namespace XELOS\Modules\Legal\Tests\Codeception\Acceptance

LegalControllerTest — Class in namespace XELOS\Modules\Legal\Tests\Codeception\Unit

ListProperties — Class in namespace XELOS\Modules\Lists\CF

ListItemCollection — Class in namespace XELOS\Modules\Lists\Collection

ListPropertiesCollection — Class in namespace XELOS\Modules\Lists\Collection

ListStatusCollection — Class in namespace XELOS\Modules\Lists\Collection

ListsControllerDocumentation — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Model#listItem — Property in class Model

$ Model#ListItem — Property in class Model

$ Model#listProperties — Property in class Model

$ Model#ListProperties — Property in class Model

$ Model#listStatus — Property in class Model

$ Model#ListStatus — Property in class Model

Model::list_item() — Method in class Model

Model::list_properties() — Method in class Model

Model::list_status() — Method in class Model

$ Page#list_editor — Property in class Page

Page::list_editor() — Method in class Page

$ Ui#list_preview — Property in class Ui

ListDocumentation — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\Model

This file provides property and method documentation for the model list.

ListItemDocumentation — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\Model

This file provides property and method documentation for the model ListItem.

$ ListItemDocumentation#list_id — Property in class ListItemDocumentation

ListStatusDocumentation — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\Model

This file provides property and method documentation for the model ListStatus.

$ ListStatusDocumentation#list_id — Property in class ListStatusDocumentation

ListStatus — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

ListsNavigation — Class in namespace XELOS\Modules\Lists\Hook\Dashboard

ListsPagesPortlet — Class in namespace XELOS\Modules\Lists\Hook\Pages

ListsGanttShowPortlet — Class in namespace XELOS\Modules\Lists\Hook\Portal

ListsPortletShowPortlet — Class in namespace XELOS\Modules\Lists\Hook\Portal

ListsSingleShowPortlet — Class in namespace XELOS\Modules\Lists\Hook\Portal

ApiService::list_lists() — Method in class ApiService

Retrieve list of lists

ApiService::list_items() — Method in class ApiService

Get Accessible Items from a specific list

ListItemPayload — Class in namespace XELOS\Modules\Lists\Hook\Workflows

ListsController — Class in namespace XELOS\Modules\Lists

ListItem — Class in namespace XELOS\Modules\Lists\Model

Class XELOS\Modules\Lists\Model\ListProperties

$ ListItem#list_id — Property in class ListItem

ListProperties — Class in namespace XELOS\Modules\Lists\Model

Class XELOS\Modules\Lists\Model\ListProperties

$ ListProperties#list_type — Property in class ListProperties

standard, workflow, template

ListProperties::localReIndex() — Method in class ListProperties

Reindex local items to save items

ListStatus — Class in namespace XELOS\Modules\Lists\Model

Class XELOS\Modules\Lists\Model\ListProperties

$ ListStatus#list_id — Property in class ListStatus

ListEditorPage — Class in namespace XELOS\Modules\Lists\Page

Class ListEditorPage

ListsControllerCest — Class in namespace XELOS\Modules\Lists\Tests\Codeception\Acceptance

ListsControllerTest — Class in namespace XELOS\Modules\Lists\Tests\Codeception\Unit

ListPortlet — Class in namespace XELOS\Modules\Lists\UI

ListPreview — Class in namespace XELOS\Modules\Lists\UI

Class ThreadPreview

Webservice::list_properties() — Method in class Webservice

List Properties

LookbookControllerTest — Class in namespace XELOS\Modules\Lookbook\Tests\Codeception\Unit

Class LookbookControllerTest

LookbookFoafTest — Class in namespace XELOS\Modules\Lookbook\Tests\Codeception\Unit

Class LookbookProfileTest

LookbookProfileTest — Class in namespace XELOS\Modules\Lookbook\Tests\Codeception\Unit

Class LookbookProfileTest

LatestNewsPortlet — Class in namespace XELOS\Modules\News\Hook\Pages

$ PageComponentDocumentation#locale: — Property in class PageComponentDocumentation

stored in MySQL as varchar

$ PageVersionDocumentation#layout_i18n: — Property in class PageVersionDocumentation

stored in MySQL as mediumblob

$ PageVersionDocumentation#locales: — Property in class PageVersionDocumentation

stored in MySQL as varchar

$ PageVersion#layout_i18n — Property in class PageVersion

$ PageVersion#locales — Property in class PageVersion

$ PageVersion#languages — Property in class PageVersion

$ Template#layout — Property in class Template

$ PageRenderer#locales — Property in class PageRenderer

$ SearchagentDocumentation#last_notify: — Property in class SearchagentDocumentation

stored in MySQL as datetime

FacetedFilter::loadFacetedFilters() — Method in class FacetedFilter

$ SearchIndexContentRecord#locale — Property in class SearchIndexContentRecord

$ SearchIndexRecord#locale — Property in class SearchIndexRecord

$ DocumentWallItemDocumentation#last_activity_at: — Property in class DocumentWallItemDocumentation

stored in MySQL as timestamp

$ EntryDocumentation#link_params: — Property in class EntryDocumentation

stored in MySQL as varchar

Entry::load() — Method in class Entry

$ SystemActionlogController#log_events — Property in class SystemActionlogController

$ SystemActionlogController#last_entries — Property in class SystemActionlogController

$ InstallQueue#log: — Property in class InstallQueue

stored in MySQL as text

LicenseProblem — Class in namespace XELOS\Modules\SystemAdmin\Docs\ClassGenerated\Model

This file provides property and method documentation for the model LicenseProblem.

DocumentIndexDaemonLegacy::logThreadStatus() — Method in class DocumentIndexDaemonLegacy

$ WebdavService#last_document — Property in class WebdavService

Document::load() — Method in class Document

Loads the document.

Document::load_meta_data() — Method in class Document

Returns the meta data for this document Wrapped in a public method to allow forwarding that request to link targets in the future

Document::lock() — Method in class Document

Lock the referenced document

Document::loadReferenceDocument() — Method in class Document

Loads the reference document and saves internally as property.

$ Document#language — Property in class Document

: stored in MySQL as varchar

$ DocumentHistory#language — Property in class DocumentHistory

: stored in MySQL as varchar

$ DocumentMetaField#label_i18n — Property in class DocumentMetaField

: stored in MySQL as varchar

$ Ui#level_selector — Property in class Ui

$ AggregateNumericDocumentation#level: — Property in class AggregateNumericDocumentation

enum day|week|month

$ NodeDocumentation#last_deployment_at: — Property in class NodeDocumentation

stored in MySQL as timestamp

LicenseCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

GlobalTaskCollection::limit() — Method in class GlobalTaskCollection

GlobalTaskListCollection::limit() — Method in class GlobalTaskListCollection

$ TaskDocumentation#list_id — Property in class TaskDocumentation

$ TaskDocumentation#list_column_id — Property in class TaskDocumentation

$ Task#list_id — Property in class Task

$ Task#list_column_id — Property in class Task

$ Task#list — Property in class Task

Task

$ TaskListColumn#list_id — Property in class TaskListColumn

LibreofficeCheck — Class in namespace XELOS\Modules\SystemWorker\Hook\SystemStatus

LibreofficeWorker — Class in namespace XELOS\Modules\SystemWorker\Worker

$ Page#login — Property in class Page

Page::login() — Method in class Page

Webservice::login() — Method in class Webservice

DigestAuthentication::login() — Method in class DigestAuthentication

$ WidgetDocumentation#link: — Property in class WidgetDocumentation

stored in MySQL as text

M

$ Autoloader#modules_cache — Property in class Autoloader

Module Cache

MobileAccessAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

MultiFactorAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ UserDetails#meta — Property in class UserDetails

Maintenance — Class in namespace XELOS\Framework\Core\Console\Command

Class Maintenance

$ Input#module — Property in class Input

Output::message() — Method in class Output

$ Core#meta_info — Property in class Core

$ Core#model — Property in class Core

Access to models defined in the class sub-folder model

ModuleException — Class in namespace XELOS\Framework\Core\Exception

Class ModuleException

MagicDocumentHelper — Class in namespace XELOS\Framework\Core\Helper

Class MagicDocumentHelper

MagicDocumentHelperList — Class in namespace XELOS\Framework\Core\Helper

MagicMethodHelper — Class in namespace XELOS\Framework\Core\Helper

Class MagicMethodHelper

ModelActionHelper — Class in namespace XELOS\Framework\Core\Helper

Use this action for actions based on a single model

ModuleInterface — Class in namespace XELOS\Framework\Core\Interfaces

Interface ModuleInterface

$ Template#marker_sets — Property in class Template

$ Template#mod — Property in class Template

$ Template#markers — Property in class Template

Template::marker_is_cached() — Method in class Template

$ VarsTemplate#mod — Property in class VarsTemplate

if called via Controller::get_vars() current instance is referenced

$ VarsTemplate#marker_sets — Property in class VarsTemplate

$ VarsTemplate#module_name: — Property in class VarsTemplate

stored in MySQL as varchar

$ Controller#model — Property in class Controller

$ Controller#mod — Property in class Controller

ModulePageCollector — Class in namespace XELOS\Framework\Module\Controller

$ BaseHook#mod — Property in class BaseHook

Instance providing the hook

$ DocumentItem#mod — Property in class DocumentItem

$ DocumentItem#model_name — Property in class DocumentItem

ModulePortlet — Class in namespace XELOS\Framework\Module\Hook

$ ModulePortlet#mod — Property in class ModulePortlet

$ ModulePortlet#multi_group_context — Property in class ModulePortlet

$ ModulePortlet#meta_info — Property in class ModulePortlet

Used in CMS to show icon

$ InstallEvents#mod — Property in class InstallEvents

$ Collection#mod — Property in class Collection

$ DocumentModel#mod — Property in class DocumentModel

Model — Class in namespace XELOS\Framework\Module\Model

Database Model

$ Model#mod — Property in class Model

$ Model#model_name — Property in class Model

$ Model#markers — Property in class Model

$ Model#model_version — Property in class Model

Hint your model version, this parameter might affect certain outcomes and behaviours This version string is added for backwards compatibility

$ Model#model_default_render_xui — Property in class Model

Defines a XUI helper which can be used to display this model in the render() function e.g. use 'thread' to use this xui helper "XELOS\Modules\Forum\UI\Thread" of the models parent module

ModelCollection — Class in namespace XELOS\Framework\Module\Model

$ ModelCollection#model — Property in class ModelCollection

reference to model-type

$ ModelCollection#models — Property in class ModelCollection

Array of models in this collection

ModelCollection::merge() — Method in class ModelCollection

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

ModelWithThumbnail — Class in namespace XELOS\Framework\Module\Model

Interface ModelWithThumbnail

$ AuditableTrait#mod — Property in class AuditableTrait

$ SoftDeleteTrait#mod — Property in class SoftDeleteTrait

$ Page#mod — Property in class Page

$ SystemCron#messages — Property in class SystemCron

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

SystemCron::message() — Method in class SystemCron

Cron Status Information Messages Will be writte to LOG our used as output when executed via web administration

$ SystemDaemon#module_name — Property in class SystemDaemon

$ SystemDaemon#mod_registry — Property in class SystemDaemon

$ SystemDaemon#messages — Property in class SystemDaemon

SystemDaemon::message() — Method in class SystemDaemon

Daemon message

$ SystemDaemonThreaded#maxThreadCount — Property in class SystemDaemonThreaded

$ Document#model — Property in class Document

$ UIComponent#mod — Property in class UIComponent

$ UIComponent#marker_content — Property in class UIComponent

$ UIComponent#mod_object_manager — Property in class UIComponent

$ XF#mode — Property in class XF

$ XF#mode_tunneled — Property in class XF

$ XF#model_cache — Property in class XF

MySQLAdapter — Class in namespace XELOS\Framework\XF\DB

Class MySQLAdapter

MySQLAdapter::multiQuery() — Method in class MySQLAdapter

Executes multiple queries in one request -> Preferred way e.g. to mass insert data into database as this is much faster than many single queries If an error occures the execution stops and all remaining queries won't be executed.

IM::module_exists() — Method in class IM

$ Lib#mail — Property in class Lib

$ Lib#modsetup — Property in class Lib

MemcacheCacheHandler — Class in namespace XELOS\Framework\XF\Lib\Cache

Cache Handler to use MEMCACHE as caching backend

File::mkdir() — Method in class File

File::mkdir_r() — Method in class File

File::mv() — Method in class File

Format::multi_format_array() — Method in class Format

Format::multi_format() — Method in class Format

Universal formatting function uses option array for further parameters Can be used for providing flexible formatting options within other components

Format::multi_format_queue() — Method in class Format

Format::money_to_str() — Method in class Format

Converts a currency value to word representation (1.02 => one dollar two cents) If the number has not any fraction part, the "cents" number is omitted.

I18n::make_i18n_lookup_array() — Method in class I18n

Creates an i18n lookup array containing mappings from tokens to translations

Link::makeInternalURIRelative() — Method in class Link

If the passed URL is an internal URL this helper returns a relative URL. Otherwise the full url is returned

Mail — Class in namespace XELOS\Framework\XF\Lib

Mail::mass_send() — Method in class Mail

Same as send(), but sends the email to each recipient individually instead of all receivers in one mail

MarkdownExtraParser — Class in namespace XELOS\Framework\XF\Lib

Class MarkdownExtraParser

Mention — Class in namespace XELOS\Framework\XF\Lib

Class Mention

Modsetup — Class in namespace XELOS\Framework\XF\Lib

Module Setup Class Helper for module installation

$ Modsetup#module — Property in class Modsetup

$ Modsetup#messages — Property in class Modsetup

Notification::messenger() — Method in class Notification

Send Messenger-Message

Notification::markSeen() — Method in class Notification

Notification::markAllSeen() — Method in class Notification

mark seen notifications by user_id and typ

Notification::mark_read() — Method in class Notification

mark seen notifications by user_id and typ

Notification::markReadBy() — Method in class Notification

Notification::markSeenBy() — Method in class Notification

$ QueueableJob#maxRetries — Property in class QueueableJob

$ UserImport#mode — Property in class UserImport

Token::mergeToken() — Method in class Token

Merges the passed Token object into this token. This will add additional translations as well as occurences from merged token into this

TokenCollection::merge() — Method in class TokenCollection

Merges the passed TokenCollection into this collection. If the token already exists the tokens will be merged.

TokenCollection::mergeMany() — Method in class TokenCollection

Merges an array with multiple TokenCollections into this collection

$ System#model — Property in class System

$ DocumentIndexCollection#mod — Property in class DocumentIndexCollection

$ DocumentIndexReferenceCollection#mod — Property in class DocumentIndexReferenceCollection

$ GroupCollection#mod — Property in class GroupCollection

$ InstanceRegistryCollection#mod — Property in class InstanceRegistryCollection

ModuleGroupSecurityCollection — Class in namespace XELOS\Framework\XF\System\Collection

$ ModuleGroupSecurityCollection#mod — Property in class ModuleGroupSecurityCollection

ModuleGroupSecurityMemberCollection — Class in namespace XELOS\Framework\XF\System\Collection

$ ModuleGroupSecurityMemberCollection#mod — Property in class ModuleGroupSecurityMemberCollection

ModuleRegistryCollection — Class in namespace XELOS\Framework\XF\System\Collection

$ ModuleRegistryCollection#mod — Property in class ModuleRegistryCollection

$ NotificationCollection#mod — Property in class NotificationCollection

$ PagesCollection#mod — Property in class PagesCollection

$ PolicyCollection#mod — Property in class PolicyCollection

$ UserCollection#mod — Property in class UserCollection

$ UserMetaCollection#mod — Property in class UserMetaCollection

Model — Class in namespace XELOS\Framework\XF\System\Docs\MagicHelper

This file provides autocompletion for XELOS fake system module.

$ Model#module_group_security — Property in class Model

$ Model#module_group_security_member — Property in class Model

$ Model#module_registry — Property in class Model

$ AuditTrail#model_table — Property in class AuditTrail

$ AuditTrail#model_primary_id — Property in class AuditTrail

$ DocumentIndex#mod — Property in class DocumentIndex

$ DocumentIndex#max_cached_document_indexes — Property in class DocumentIndex

DocumentIndex::mark_document_recent() — Method in class DocumentIndex

DocumentIndexJobQueue::markJobsForProcessStep() — Method in class DocumentIndexJobQueue

Updates the job by mark it for the given process step.

DocumentIndexJobQueue::markClusterJobsForProcessStepHooks() — Method in class DocumentIndexJobQueue

Sets the process step of given jobs to hooks from cluster_eval, when there are no more pending policy clusters.

$ DocumentRegistry#module_name — Property in class DocumentRegistry

$ DocumentRegistry#model_name — Property in class DocumentRegistry

I18nLanguage::ModelCollection() — Method in class I18nLanguage

$ LibCountry#model_name — Property in class LibCountry

ModuleGroupSecurity — Class in namespace XELOS\Framework\XF\System\Model

Class ModuleGroupSecurity

$ ModuleGroupSecurity#model_version — Property in class ModuleGroupSecurity

$ ModuleGroupSecurity#module_name — Property in class ModuleGroupSecurity

ModuleGroupSecurityMember — Class in namespace XELOS\Framework\XF\System\Model

Class ModuleGroupSecurity

$ ModuleGroupSecurityMember#model_version — Property in class ModuleGroupSecurityMember

ModuleRegistry — Class in namespace XELOS\Framework\XF\System\Model

Class ModuleRegistry

$ Notification#model_version — Property in class Notification

Notification::markRead() — Method in class Notification

Notification::markSeen() — Method in class Notification

$ Pages#model_name — Property in class Pages

$ Pages#module_name — Property in class Pages

$ Policy#model_name — Property in class Policy

$ Policy#module_name — Property in class Policy

$ Policy2Group#model_name — Property in class Policy2Group

$ Policy2User#model_name — Property in class Policy2User

$ ThemeSet#model_name — Property in class ThemeSet

$ User#model_name — Property in class User

$ UserMeta#model_name — Property in class UserMeta

$ Calendar#month — Property in class Calendar

$ Callback#module — Property in class Callback

Name of the module

$ Css#media — Property in class Css

$ DocumentView#mod — Property in class DocumentView

$ DocumentView#model — Property in class DocumentView

$ FacetedCategoryChoice#modelProperty — Property in class FacetedCategoryChoice

$ Form#mime_ext — Property in class Form

$ Form#model — Property in class Form

$ FormEditor#mod — Property in class FormEditor

$ FormFile#mod — Property in class FormFile

$ FormMultifile#mod — Property in class FormMultifile

$ FroalaEditorBuilder#mod — Property in class FroalaEditorBuilder

FroalaOption::multiLine() — Method in class FroalaOption

Allows new line to be inserted when ENTER key is hit.

$ HtmlTree#max_recursion — Property in class HtmlTree

$ Instance#mod — Property in class Instance

$ ButtonOptions#muted — Property in class ButtonOptions

Button disabled and muted?

MenuList — Class in namespace XELOS\Framework\XF\UI\Link

MenuListItem — Class in namespace XELOS\Framework\XF\UI\Link

MenuOptions — Class in namespace XELOS\Framework\XF\UI\Link

Options for Context Menu WebComponent

ModalDialog — Class in namespace XELOS\Framework\XF\UI\Link

Modal Options

Math — Class in namespace XELOS\Framework\XF\UI

$ Portlet#mod — Property in class Portlet

$ ProgressBar#min — Property in class ProgressBar

$ ProgressBar#max — Property in class ProgressBar

$ Table#mod — Property in class Table

$ TableEditor#mod — Property in class TableEditor

$ Tabs#mod — Property in class Tabs

$ Wizard#mod — Property in class Wizard

$ ActiveDirectoryAction#mod — Property in class ActiveDirectoryAction

$ AzureActiveDirectoryAction#mod — Property in class AzureActiveDirectoryAction

$ LdapAction#mod — Property in class LdapAction

Model — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ AdCache#mail: — Property in class AdCache

stored in MySQL as varchar

$ AdCache#misc: — Property in class AdCache

stored in MySQL as mediumtext

$ AdCache#mod — Property in class AdCache

$ AdCache#model_version — Property in class AdCache

$ SynchStatus#model_version — Property in class SynchStatus

$ SynchStatus#mod — Property in class SynchStatus

$ ListPage#mod — Property in class ListPage

$ SystemCron#module_name — Property in class SystemCron

$ DirectoryServiceConfigTrait#mod — Property in class DirectoryServiceConfigTrait

$ PasswordAction#mod — Property in class PasswordAction

$ AdministrationControllerDocumentation#model — Property in class AdministrationControllerDocumentation

Model — Class in namespace XELOS\Modules\Administration\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ LanguageSettingLanguageConfig#mod — Property in class LanguageSettingLanguageConfig

$ UserAccountUserConfig#mod — Property in class UserAccountUserConfig

$ UserLanguageUserConfig#mod — Property in class UserLanguageUserConfig

$ UserSecurityUserConfig#mod — Property in class UserSecurityUserConfig

$ UserExportBase#mod — Property in class UserExportBase

$ ApiService#mod — Property in class ApiService

$ DesignPage#mod — Property in class DesignPage

$ HierarchyPage#mod — Property in class HierarchyPage

$ LicensePage#mod — Property in class LicensePage

$ SimpleGroupsPage#mod — Property in class SimpleGroupsPage

$ UserGroupsPage#mod — Property in class UserGroupsPage

$ UserPage#mod — Property in class UserPage

$ UserSessionsPage#mod — Property in class UserSessionsPage

$ SystemCron#module_name — Property in class SystemCron

$ UserList#mod — Property in class UserList

$ UploadDocumentProcessor#mod — Property in class UploadDocumentProcessor

$ CloudDocumentBrowser#mod — Property in class CloudDocumentBrowser

$ StorageProvider#mod — Property in class StorageProvider

$ ApiCloudstorageDocumentBrowser#mod — Property in class ApiCloudstorageDocumentBrowser

$ OnedriveStorageProvider#mod — Property in class OnedriveStorageProvider

$ OutlookPersonalCalenderGetEvents#mod — Property in class OutlookPersonalCalenderGetEvents

$ CoAuthorDocumentProcessor#mod — Property in class CoAuthorDocumentProcessor

$ PresenceUserLinks#mod — Property in class PresenceUserLinks

$ OutlookInboxShowPortlet#mod — Property in class OutlookInboxShowPortlet

$ SearchMessagesSearchIntegration#mod — Property in class SearchMessagesSearchIntegration

MicrosoftOauthClient — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Webservice

Class MicrosoftOauthClient

$ MicrosoftOauthClient#max_global_connections — Property in class MicrosoftOauthClient

$ MicrosoftOauthClient#max_user_connections — Property in class MicrosoftOauthClient

$ OnedriveOauthClient#max_global_connections — Property in class OnedriveOauthClient

$ OnedriveOauthClient#max_user_connections — Property in class OnedriveOauthClient

$ Subscription#mod — Property in class Subscription

$ Subscription#model_version — Property in class Subscription

$ ApiPage#mod — Property in class ApiPage

$ DirectoryPage#mod — Property in class DirectoryPage

$ OpenidOauthClient#max_global_connections — Property in class OpenidOauthClient

$ OpenidOauthClient#max_user_connections — Property in class OpenidOauthClient

Model — Class in namespace XELOS\Modules\AuthSaml\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#meta — Property in class Page

Page::meta() — Method in class Page

Main — Class in namespace XELOS\Modules\AuthSaml\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

Meta — Class in namespace XELOS\Modules\AuthSaml\Page

Class Overview

$ Meta#mod — Property in class Meta

$ SloPage#mod — Property in class SloPage

Model — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ Participant#mail: — Property in class Participant

stored in MySQL as varchar

$ Reminder#minutes — Property in class Reminder

$ Reminder#method: — Property in class Reminder

enum alert|email

$ ReminderQueue#method: — Property in class ReminderQueue

enum alert|email

$ SyncSetting#master_direction: — Property in class SyncSetting

enum from_sync|to_sync

$ AgendaPortlet#meta_info — Property in class AgendaPortlet

Model — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ ParserAction#mod — Property in class ParserAction

$ CommentCollection#mod — Property in class CommentCollection

$ CommentsController#model — Property in class CommentsController

Model — Class in namespace XELOS\Modules\Comments\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\Comments\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ IndexEventDocumentIndexEvent#mod — Property in class IndexEventDocumentIndexEvent

$ ApiService#mod — Property in class ApiService

$ Comment#mod — Property in class Comment

$ Comment#model_version — Property in class Comment

$ Comment#model_default_render_xui — Property in class Comment

$ LinkInfo#model_version — Property in class LinkInfo

$ Comment#mod — Property in class Comment

$ Comment#model — Property in class Comment

$ CrmDocumentBrowser#mod — Property in class CrmDocumentBrowser

$ DMSNavigation#mod — Property in class DMSNavigation

$ FilesPortlet#meta_info — Property in class FilesPortlet

$ FilesPortlet#mod — Property in class FilesPortlet

$ SystemCron#module_name — Property in class SystemCron

$ ChannelCollection#mod — Property in class ChannelCollection

$ ChannelSourceDocumentCollection#mod — Property in class ChannelSourceDocumentCollection

$ ChannelSubscriptionCollection#mod — Property in class ChannelSubscriptionCollection

$ DocviewProcessor#mod — Property in class DocviewProcessor

$ ChannelFollowsShowPortlet#mod — Property in class ChannelFollowsShowPortlet

$ FollowedDocumentsShowPortlet#mod — Property in class FollowedDocumentsShowPortlet

$ FollowedDocumentsShowPortlet#meta_info — Property in class FollowedDocumentsShowPortlet

$ ActivityIndexerSearchPreprocessor#mod — Property in class ActivityIndexerSearchPreprocessor

$ IndexEventDocumentIndexEvent#mod — Property in class IndexEventDocumentIndexEvent

$ ApiService#mod — Property in class ApiService

$ InvitationsAction#mod — Property in class InvitationsAction

$ PostAction#mod — Property in class PostAction

$ RegistrationAction#mod — Property in class RegistrationAction

$ CategoryCollection#mod — Property in class CategoryCollection

$ EventCollection#mod — Property in class EventCollection

$ EventplannerControllerDocumentation#model — Property in class EventplannerControllerDocumentation

Model — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ EventDocumentation#max_accompanying_persons — Property in class EventDocumentation

$ EventDocumentation#min_participants — Property in class EventDocumentation

$ EventDocumentation#max_participants — Property in class EventDocumentation

$ CRMParticipationShowPortlet#mod — Property in class CRMParticipationShowPortlet

$ CalendarLinkGetEvents#mod — Property in class CalendarLinkGetEvents

$ AgendaPortlet#meta_info — Property in class AgendaPortlet

$ AgendaPortlet#mod — Property in class AgendaPortlet

$ EventplannerUpcomingShowPortlet#meta_info — Property in class EventplannerUpcomingShowPortlet

$ PayloadParticipantPayload#mod — Property in class PayloadParticipantPayload

$ PayloadParticipantPayload#model_name — Property in class PayloadParticipantPayload

$ ProcessParticipantAction#mod — Property in class ProcessParticipantAction

$ Category#mod — Property in class Category

$ Event#mod — Property in class Event

$ Event#model_default_render_xui — Property in class Event

$ InvitationReplyLog#mod — Property in class InvitationReplyLog

$ Numberrange#mod — Property in class Numberrange

$ Participant#mod — Property in class Participant

$ ParticipantLog#mod — Property in class ParticipantLog

$ RelatedEvents#mod — Property in class RelatedEvents

$ AdminPage#mod — Property in class AdminPage

$ CategoriesPage#mod — Property in class CategoriesPage

Reference to mod

$ DetailPage#mod — Property in class DetailPage

Reference to mod

$ EventActionPage#mod — Property in class EventActionPage

Reference to mod

$ OverviewPage#mod — Property in class OverviewPage

Reference to mod

$ ParticipantsPage#mod — Property in class ParticipantsPage

Reference to mod

$ PostPage#mod — Property in class PostPage

Reference to mod

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ Details#mod — Property in class Details

$ Event#model — Property in class Event

$ Event#mod — Property in class Event

ModerateAction — Class in namespace XELOS\Modules\Forum\Action

$ ModerateAction#mod — Property in class ModerateAction

$ ThreadAction#mod — Property in class ThreadAction

$ CategoryCollection#mod — Property in class CategoryCollection

$ ThreadCollection#mod — Property in class ThreadCollection

$ ForumControllerDocumentation#model — Property in class ForumControllerDocumentation

$ Action#moderate — Property in class Action

Model — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ForumController#mod — Property in class ForumController

$ ForumController#model; — Property in class ForumController

$ GroupsTemplateInit#mod — Property in class GroupsTemplateInit

$ RecentShowPortlet#mod — Property in class RecentShowPortlet

$ RecentShowPortlet#meta_info — Property in class RecentShowPortlet

$ CreateThreadAction#mod — Property in class CreateThreadAction

$ ThreadPayload#mod — Property in class ThreadPayload

$ ThreadPayload#model_name — Property in class ThreadPayload

$ InstallEvents#mod — Property in class InstallEvents

$ Category#mod — Property in class Category

Category::move() — Method in class Category

Moves $this category to the target category with the given $targetId

Category::mark_read() — Method in class Category

Mark all Threads from this category as read

MovableInterface — Class in namespace XELOS\Modules\Forum\Model\Interfaces

Defines a model as moveable within its parent context

MovableInterface::move() — Method in class MovableInterface

Moves the element within its parent context

$ Post#mod — Property in class Post

$ Post#model_default_render_xui — Property in class Post

Post::move() — Method in class Post

Moves $this post to the target thread with the given $targetId

$ Thread#mod — Property in class Thread

$ Thread#model_default_render_xui — Property in class Thread

Thread::move() — Method in class Thread

Moves $this thread to the target category with the given $targetId

Thread::mark_read() — Method in class Thread

Mark thread as read

$ EditPage#mod — Property in class EditPage

$ FeedPage#mod — Property in class FeedPage

$ ShowPage#mod — Property in class ShowPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ ThreadPreview#model — Property in class ThreadPreview

$ VoteBox#mod — Property in class VoteBox

$ LocationCollection#mod — Property in class LocationCollection

$ GeoIpAuthentication#mod — Property in class GeoIpAuthentication

$ IndexEventDocumentIndexEvent#mod — Property in class IndexEventDocumentIndexEvent

$ InstallEvents#mod — Property in class InstallEvents

Marker — Class in namespace XELOS\Modules\Geodb\Lib

$ Location#mod — Property in class Location

$ TestPage#mod — Property in class TestPage

MapLocation — Class in namespace XELOS\Modules\Geodb\UI

$ RecurringTaskCollection#mod — Property in class RecurringTaskCollection

$ TaskCollection#mod — Property in class TaskCollection

$ TaskListCollection#mod — Property in class TaskListCollection

$ GroupsTasksControllerDocumentation#model — Property in class GroupsTasksControllerDocumentation

Model — Class in namespace XELOS\Modules\GroupsTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#main — Property in class Page

Page::main() — Method in class Page

$ CalendarLinkGetEvents#mod — Property in class CalendarLinkGetEvents

$ GroupsTemplateInit#mod — Property in class GroupsTemplateInit

$ TaskList#model_version — Property in class TaskList

$ KanbanPage#mod — Property in class KanbanPage

MainPage — Class in namespace XELOS\Modules\GroupsTasks\Page

$ RecurringPage#mod — Property in class RecurringPage

$ SystemCron#module_name — Property in class SystemCron

$ GroupCollection#mod — Property in class GroupCollection

MemberCollection — Class in namespace XELOS\Modules\Groups\Collection

$ MemberCollection#mod — Property in class MemberCollection

Model — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Model#member — Property in class Model

$ Model#module — Property in class Model

Model::member() — Method in class Model

Model::module() — Method in class Model

Main — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

Member — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model member.

Module — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model module.

$ Module#module_name: — Property in class Module

stored in MySQL as varchar

$ Newsletter#message: — Property in class Newsletter

stored in MySQL as text

$ Pending#message: — Property in class Pending

stored in MySQL as text

$ EventplannerPortlet#mod — Property in class EventplannerPortlet

$ FilesPortlet#mod — Property in class FilesPortlet

$ GroupsPortlet#meta_info — Property in class GroupsPortlet

$ GroupsPortlet#mod — Property in class GroupsPortlet

$ NewsPortlet#mod — Property in class NewsPortlet

$ ApiModuleService#mod — Property in class ApiModuleService

$ ApiService#mod — Property in class ApiService

$ GroupsExtension#mod — Property in class GroupsExtension

$ InstallEvents#mod — Property in class InstallEvents

$ GroupsDocumentBrowser#mod — Property in class GroupsDocumentBrowser

$ LeaveApplicationCollection#mod — Property in class LeaveApplicationCollection

$ TravelCollection#mod — Property in class TravelCollection

$ Webservice#mod — Property in class Webservice

$ JobQueueControllerDocumentation#model — Property in class JobQueueControllerDocumentation

Model — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ JobQueueCheck#mod — Property in class JobQueueCheck

$ TestJob#message — Property in class TestJob

$ Job#mod — Property in class Job

$ JobHistory#mod — Property in class JobHistory

$ CallbackPage#mod — Property in class CallbackPage

$ StatusPage#mod — Property in class StatusPage

$ TestPage#mod — Property in class TestPage

$ SystemDaemon#module_name — Property in class SystemDaemon

$ SystemDaemon#mod — Property in class SystemDaemon

$ SystemDaemon#maxThreadCount — Property in class SystemDaemon

$ SystemDaemon#maintenanceLastCheck — Property in class SystemDaemon

$ SystemDaemon#maintenanceKeepHistoryDays — Property in class SystemDaemon

$ JobUIStatus#mod — Property in class JobUIStatus

$ LegalControllerDocumentation#model — Property in class LegalControllerDocumentation

Model — Class in namespace XELOS\Modules\Legal\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PrivacyCentreUserConfig#mod — Property in class PrivacyCentreUserConfig

$ Page#mod — Property in class Page

$ AccessibilityPage#mod — Property in class AccessibilityPage

$ AdminPage#mod — Property in class AdminPage

$ DisclaimerPage#mod — Property in class DisclaimerPage

$ ImprintPage#mod — Property in class ImprintPage

$ PrivacyPage#mod — Property in class PrivacyPage

$ FormprocessorAction#mod — Property in class FormprocessorAction

Reference to XELOS\Modules\Lists\ListsController

$ ListProperties#mod — Property in class ListProperties

$ ListProperties#model_name — Property in class ListProperties

$ CategoryCollection#mod — Property in class CategoryCollection

$ ListItemCollection#mod — Property in class ListItemCollection

$ ListPropertiesCollection#mod — Property in class ListPropertiesCollection

$ ListsControllerDocumentation#model — Property in class ListsControllerDocumentation

Model — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Field::modifyFormFieldFdl() — Method in class Field

Modifies the form field fdl for custom fields in order to display them properly.

Field::modifyListFieldFdl() — Method in class Field

Modifies the list field fdl for custom fields.

AssignedUsers::modifyFormFieldFdl() — Method in class AssignedUsers

Modifies the form field fdl for custom fields in order to display them properly.

CategorySelector::modifyListFieldFdl() — Method in class CategorySelector

Modifies the list field fdl for custom fields.

Checkbox::modifyListFieldFdl() — Method in class Checkbox

Modifies the list field fdl for custom fields.

Checkbox::modifyFormFieldFdl() — Method in class Checkbox

Modifies the form field fdl for custom fields in order to display them properly.

Date::modifyListFieldFdl() — Method in class Date

Modifies the list field fdl for custom fields.

Datetime::modifyListFieldFdl() — Method in class Datetime

Modifies the list field fdl for custom fields.

Document::modifyListFieldFdl() — Method in class Document

Modifies the list field fdl for custom fields.

Fieldset::modifyFormFieldFdl() — Method in class Fieldset

Modifies the form field fdl for custom fields in order to display them properly.

FriendlyId::modifyListFieldFdl() — Method in class FriendlyId

Modifies the list field fdl for custom fields.

FriendlyId::modifyFormFieldFdl() — Method in class FriendlyId

Modifies the form field fdl for custom fields in order to display them properly.

ListStatus::modifyFormFieldFdl() — Method in class ListStatus

Modifies the form field fdl for custom fields in order to display them properly.

ListStatus::modifyListFieldFdl() — Method in class ListStatus

Modifies the list field fdl for custom fields.

Multitext — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Multitext::modifyFormFieldFdl() — Method in class Multitext

Modifies the form field fdl for custom fields in order to display them properly.

PrefilledField::modifyFormFieldFdl() — Method in class PrefilledField

Modifies the form field fdl for custom fields in order to display them properly.

PrefilledField::modifyListFieldFdl() — Method in class PrefilledField

Modifies the list field fdl for custom fields.

Radio::modifyListFieldFdl() — Method in class Radio

Modifies the list field fdl for custom fields.

Radio::modifyFormFieldFdl() — Method in class Radio

Modifies the form field fdl for custom fields in order to display them properly.

ResourceField::modifyListFieldFdl() — Method in class ResourceField

Asset::modifyFormFieldFdl() — Method in class Asset

Modifies the form field fdl for custom fields in order to display them properly.

Room::modifyFormFieldFdl() — Method in class Room

Modifies the form field fdl for custom fields in order to display them properly.

Service::modifyFormFieldFdl() — Method in class Service

Modifies the form field fdl for custom fields in order to display them properly.

Ticket::modifyFormFieldFdl() — Method in class Ticket

Modifies the form field fdl for custom fields in order to display them properly.

SectionBreak::modifyFormFieldFdl() — Method in class SectionBreak

Modifies the form field fdl for custom fields in order to display them properly.

Select::modifyFormFieldFdl() — Method in class Select

Modifies the form field fdl for custom fields in order to display them properly.

Select::modifyListFieldFdl() — Method in class Select

Modifies the list field fdl for custom fields.

Slider::modifyFormFieldFdl() — Method in class Slider

StaticText::modifyListFieldFdl() — Method in class StaticText

Tag::modifyListFieldFdl() — Method in class Tag

Modifies the list field fdl for custom fields.

Textarea::modifyFormFieldFdl() — Method in class Textarea

Modifies the form field fdl for custom fields in order to display them properly.

Textbox::modifyFormFieldFdl() — Method in class Textbox

Timespan::modifyFormFieldFdl() — Method in class Timespan

Modifies the form field fdl for custom fields in order to display them properly.

ToggleSwitch::modifyListFieldFdl() — Method in class ToggleSwitch

Modifies the list field fdl for custom fields.

UserSelector::modifyListFieldFdl() — Method in class UserSelector

Modifies the list field fdl for custom fields.

$ TimespanGetEvents#mod — Property in class TimespanGetEvents

$ ListsNavigation#mod — Property in class ListsNavigation

$ AbstractPortletContext#mod — Property in class AbstractPortletContext

$ ListsPagesPortlet#mod — Property in class ListsPagesPortlet

$ ListsPagesPortlet#meta_info — Property in class ListsPagesPortlet

$ ListsGanttShowPortlet#mod — Property in class ListsGanttShowPortlet

$ ListsGanttShowPortlet#meta_info — Property in class ListsGanttShowPortlet

$ ListsPortletShowPortlet#mod — Property in class ListsPortletShowPortlet

$ ListsPortletShowPortlet#meta_info — Property in class ListsPortletShowPortlet

$ ListsSingleShowPortlet#mod — Property in class ListsSingleShowPortlet

$ ListsSingleShowPortlet#meta_info — Property in class ListsSingleShowPortlet

$ ApiService#mod — Property in class ApiService

$ ListItemPayload#mod — Property in class ListItemPayload

$ ListItemPayload#model_name — Property in class ListItemPayload

$ SetFieldAction#mod — Property in class SetFieldAction

$ ShowFormAction#mod — Property in class ShowFormAction

$ WorkflowItemTrait#mod — Property in class WorkflowItemTrait

$ Category#mod — Property in class Category

$ Category#model_version — Property in class Category

$ ListItem#mod — Property in class ListItem

$ ListItem#model_version — Property in class ListItem

$ ListItem#model_default_render_xui — Property in class ListItem

$ ListProperties#mod — Property in class ListProperties

$ ListProperties#model_version — Property in class ListProperties

$ ListProperties#model_default_render_xui — Property in class ListProperties

$ ListStatus#mod — Property in class ListStatus

$ ListStatus#model_version — Property in class ListStatus

$ EditItemPage#mod — Property in class EditItemPage

$ ItemOverviewPage#mod — Property in class ItemOverviewPage

$ ListEditorPage#mod — Property in class ListEditorPage

$ OverviewPage#mod — Property in class OverviewPage

$ SettingsPage#mod — Property in class SettingsPage

$ CategorySelector#mod — Property in class CategorySelector

$ ItemEditor#mod — Property in class ItemEditor

$ ItemList#mod — Property in class ItemList

$ ItemPreview#model — Property in class ItemPreview

$ ListPortlet#mod — Property in class ListPortlet

$ ListPreview#model — Property in class ListPreview

$ ProfileCollection#mod — Property in class ProfileCollection

$ ProfilePropertyCollection#mod — Property in class ProfilePropertyCollection

$ PropertyCollection#mod — Property in class PropertyCollection

$ PropertyGroupCollection#mod — Property in class PropertyGroupCollection

$ Action#mycontacts — Property in class Action

Action::mycontacts() — Method in class Action

Model — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ Property#mobile_ready: — Property in class Property

stored in MySQL as tinyint

Memo — Class in namespace XELOS\Modules\Lookbook\Fields

$ EventCollector#mod — Property in class EventCollector

$ IndexEventDocumentIndexEvent#mod — Property in class IndexEventDocumentIndexEvent

$ Webservice#mod — Property in class Webservice

$ FollowersExtension#mod — Property in class FollowersExtension

$ FollowingExtension#mod — Property in class FollowingExtension

$ UserListPortlet#mod — Property in class UserListPortlet

$ UserListPortlet#meta_info — Property in class UserListPortlet

$ ArticleCollection#mod — Property in class ArticleCollection

ArticleCollection::moveToCategory() — Method in class ArticleCollection

Move all articles in this collection to the specified category

$ CategoryCollection#mod — Property in class CategoryCollection

Model — Class in namespace XELOS\Modules\News\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ NewsControllerDocumentation#model — Property in class NewsControllerDocumentation

$ RSSShowPortlet#meta_info — Property in class RSSShowPortlet

$ RecentShowPortlet#mod — Property in class RecentShowPortlet

$ RecentShowPortlet#meta_info — Property in class RecentShowPortlet

$ ApiService#mod — Property in class ApiService

$ ArticlePayload#mod — Property in class ArticlePayload

$ ArticlePayload#model_name — Property in class ArticlePayload

$ ArticlePublishAction#mod — Property in class ArticlePublishAction

$ Article#mod — Property in class Article

$ Article#model_default_render_xui — Property in class Article

$ Category#mod — Property in class Category

$ OverviewPage#mod — Property in class OverviewPage

$ PostPage#mod — Property in class PostPage

$ ReadPage#mod — Property in class ReadPage

$ SettingsPage#mod — Property in class SettingsPage

$ Article#model — Property in class Article

$ ViewArticleWrite#mod — Property in class ViewArticleWrite

$ PageApiAction#mod — Property in class PageApiAction

$ ComponentCollection#mod — Property in class ComponentCollection

$ PageCollection#mod — Property in class PageCollection

$ PageVersionCollection#mod — Property in class PageVersionCollection

Model — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PagesControllerDocumentation#model — Property in class PagesControllerDocumentation

$ CommentsPortlet#meta_info — Property in class CommentsPortlet

$ CommentsPortlet#mod — Property in class CommentsPortlet

$ ApiService#mod — Property in class ApiService

PageJsonProcessor::modifyComponents() — Method in class PageJsonProcessor

Allows to modify the component configuration by providing a callback which is called for each component and includes the JsonObject representation which can be modified

ModelWithPagesAttachmentTrait — Class in namespace XELOS\Modules\Pages\Model

$ Page#model_default_render_xui — Property in class Page

$ Page#mod — Property in class Page

Page::moveInNavigation() — Method in class Page

Move the current page within the navigation tree

$ PageVersion#mod — Property in class PageVersion

PageVersion::moveToHistory() — Method in class PageVersion

Move this page version to the history

$ Template#mod — Property in class Template

$ TemplateCategory#mod — Property in class TemplateCategory

$ EditorPage#mod — Property in class EditorPage

$ ExportPage#mod — Property in class ExportPage

$ ShowPage#mod — Property in class ShowPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ PersonalWorkspaceDocumentBrowser#mod — Property in class PersonalWorkspaceDocumentBrowser

$ SelectorBrowser#mod — Property in class SelectorBrowser

$ Workspace#mod — Property in class Workspace

$ AdminPage#mod — Property in class AdminPage

$ DocumentsPage#mod — Property in class DocumentsPage

$ RecentPage#mod — Property in class RecentPage

$ ConfirmationCollection#mod — Property in class ConfirmationCollection

$ DocumentCollection#mod — Property in class DocumentCollection

Model — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ DocumentDocumentation#message — Property in class DocumentDocumentation

stored in MySQL as mediumtext

$ ReadConfirmationControllerDocumentation#model — Property in class ReadConfirmationControllerDocumentation

$ AdminProcessor#mod — Property in class AdminProcessor

$ ReadConfirmationShowPortlet#mod — Property in class ReadConfirmationShowPortlet

$ ReadConfirmationShowPortlet#meta_info — Property in class ReadConfirmationShowPortlet

$ Confirmation#mod — Property in class Confirmation

$ Document#mod — Property in class Document

$ AdminPage#mod — Property in class AdminPage

$ OverviewPage#mod — Property in class OverviewPage

$ Report#mod — Property in class Report

$ HistoryAction#mod — Property in class HistoryAction

$ IndexerAction#mod — Property in class IndexerAction

$ ElasticSearchAdapter#mod — Property in class ElasticSearchAdapter

Model — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#maintenance — Property in class Page

Page::maintenance() — Method in class Page

$ SearchControllerDocumentation#model — Property in class SearchControllerDocumentation

$ PortletSearchShowPortlet#meta_info — Property in class PortletSearchShowPortlet

$ SearchDocumentBrowser#mod — Property in class SearchDocumentBrowser

$ SearchSelectorBrowser#mod — Property in class SearchSelectorBrowser

$ SearchCheck#mod — Property in class SearchCheck

$ UpdateSearchIndexDocumentIndexEvent#mod — Property in class UpdateSearchIndexDocumentIndexEvent

$ ApiService#mod — Property in class ApiService

$ InstallEvents#mod — Property in class InstallEvents

$ DocumentElasticsearch#mod — Property in class DocumentElasticsearch

$ FacetedFilter#mod — Property in class FacetedFilter

$ SearchHistory#mod — Property in class SearchHistory

$ IndexPage#mod — Property in class IndexPage

MaintenancePage — Class in namespace XELOS\Modules\Search\Page

$ MaintenancePage#mod — Property in class MaintenancePage

$ OverviewPage#mod — Property in class OverviewPage

$ SuggestPage#mod — Property in class SuggestPage

$ SearchIndexRecord#mod — Property in class SearchIndexRecord

$ SearchIndexRecord#metaData — Property in class SearchIndexRecord

Key-value array with meta data delivered by the modules for new faceted filters.

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ ResultPanel#mod — Property in class ResultPanel

$ SearchIntegrationResultPanel#mod — Property in class SearchIntegrationResultPanel

$ TabsTrait#mod — Property in class TabsTrait

$ AbstractBrowserItem#modified_at — Property in class AbstractBrowserItem

$ AbstractDocumentBrowser#mode — Property in class AbstractDocumentBrowser

$ AbstractDocumentBrowser#multiple — Property in class AbstractDocumentBrowser

$ ApiService#mod — Property in class ApiService

$ BrowserFile#media_type — Property in class BrowserFile

$ Page#mod — Property in class Page

Model — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ SmartWikiControllerDocumentation#model — Property in class SmartWikiControllerDocumentation

$ GroupsTemplateInit#mod — Property in class GroupsTemplateInit

$ InstallEvents#mod — Property in class InstallEvents

$ Page#mod — Property in class Page

$ Page#model_default_render_xui — Property in class Page

$ PageHistory#model_version — Property in class PageHistory

$ PageLink#model_version — Property in class PageLink

$ CommentsPage#mod — Property in class CommentsPage

$ EditPage#mod — Property in class EditPage

$ ExportPage#mod — Property in class ExportPage

$ HistoryPage#mod — Property in class HistoryPage

$ IndexPage#mod — Property in class IndexPage

$ InfoPage#mod — Property in class InfoPage

$ ShowPage#mod — Property in class ShowPage

$ SourcePage#mod — Property in class SourcePage

$ TemplatesPage#mod — Property in class TemplatesPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ Page#mod — Property in class Page

$ Page#model — Property in class Page

$ ViewWikiWrite#mod — Property in class ViewWikiWrite

$ NotificationAction#mod — Property in class NotificationAction

$ EntryCollection#model — Property in class EntryCollection

$ EntryCollection#mod — Property in class EntryCollection

Model — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ SystemActionlogControllerDocumentation#model — Property in class SystemActionlogControllerDocumentation

$ CmsWallContentPortlet#mod — Property in class CmsWallContentPortlet

$ CmsWallContentPortlet#meta_info — Property in class CmsWallContentPortlet

$ WallPortlet#mod — Property in class WallPortlet

$ WallPortlet#meta_info — Property in class WallPortlet

$ PortletActionlogShowPortlet#mod — Property in class PortletActionlogShowPortlet

$ WallIndexEventDocumentIndexEvent#mod — Property in class WallIndexEventDocumentIndexEvent

$ Webservice#mod — Property in class Webservice

$ DocumentWallItem#mod — Property in class DocumentWallItem

DocumentWallItem::make_dirty_by_document_index_id() — Method in class DocumentWallItem

$ Entry#message_cache — Property in class Entry

$ FeedPage#mod — Property in class FeedPage

$ HistoryPage#mod — Property in class HistoryPage

$ OverviewPage#mod — Property in class OverviewPage

$ SettingsPage#mod — Property in class SettingsPage

$ WallPage#mod — Property in class WallPage

$ SystemActionlogController#make_user_links — Property in class SystemActionlogController

$ SystemActionlogController#make_subject_links — Property in class SystemActionlogController

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

Main — Class in namespace XELOS\Modules\SystemAdmin\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ BackupQueue#module: — Property in class BackupQueue

stored in MySQL as varchar

$ DocumentIndexDaemonLegacy#mod — Property in class DocumentIndexDaemonLegacy

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod — Property in class SystemCron

$ SystemDaemon#module_name — Property in class SystemDaemon

$ SystemDaemon#mod — Property in class SystemDaemon

Reference to System Admin

$ TrashAction#mod — Property in class TrashAction

$ Document#mod — Property in class Document

$ CategoryCollection#model — Property in class CategoryCollection

$ CategoryCollection#mod — Property in class CategoryCollection

$ DocumentCollection#model — Property in class DocumentCollection

$ DocumentCollection#mod — Property in class DocumentCollection

$ CrmPortletShowTab#mod — Property in class CrmPortletShowTab

$ CFViewNoteCFView#mod — Property in class CFViewNoteCFView

$ GroupsTemplateInit#mod — Property in class GroupsTemplateInit

$ PortletActionShowPortlet#mod — Property in class PortletActionShowPortlet

$ PortletActionShowPortlet#meta_info — Property in class PortletActionShowPortlet

$ PortletFolderhierarchyShowPortlet#mod — Property in class PortletFolderhierarchyShowPortlet

$ PortletFolderhierarchyShowPortlet#meta_info — Property in class PortletFolderhierarchyShowPortlet

$ PortletFolderhierarchyShowPortlet#multi_group_context — Property in class PortletFolderhierarchyShowPortlet

Is this portlet called in grouped mode?

$ PortletFolderviewShowPortlet#mod — Property in class PortletFolderviewShowPortlet

$ PortletFolderviewShowPortlet#meta_info — Property in class PortletFolderviewShowPortlet

$ PortletNavigatorShowPortlet#mod — Property in class PortletNavigatorShowPortlet

$ PortletNavigatorShowPortlet#meta_info — Property in class PortletNavigatorShowPortlet

$ PortletReportShowPortlet#mod — Property in class PortletReportShowPortlet

$ PortletReportShowPortlet#meta_info — Property in class PortletReportShowPortlet

$ SystemDMSDocumentBrowser#mod — Property in class SystemDMSDocumentBrowser

$ SelectorBrowser#mod — Property in class SelectorBrowser

$ IndexEventDocumentIndexEvent#mod — Property in class IndexEventDocumentIndexEvent

$ WebdavService#mod — Property in class WebdavService

WebdavService::move() — Method in class WebdavService

Move File or Folder

$ ApiService#mod — Property in class ApiService

$ SavePayloadAction#mod — Property in class SavePayloadAction

$ PreviewJob#maxRetries — Property in class PreviewJob

$ InstallEvents#mod — Property in class InstallEvents

$ Category#mod — Property in class Category

$ Category#model_default_render_xui — Property in class Category

Category::mkcat() — Method in class Category

Recursively creates categories.

$ Document#mod — Property in class Document

$ Document#model_default_render_xui — Property in class Document

Document::match_mime_types() — Method in class Document

Checks if the mime type of this document matches one of the given mime types.

$ DocumentHistory#mod — Property in class DocumentHistory

$ DocumentMetaData#mod — Property in class DocumentMetaData

$ DocumentMetaData#model_version — Property in class DocumentMetaData

$ DocumentMetaField#mod — Property in class DocumentMetaField

$ DocumentMetaField#model_version — Property in class DocumentMetaField

$ DocumentTemplate#mod — Property in class DocumentTemplate

$ DocumentTemplate#model_version — Property in class DocumentTemplate

$ FileTemplate#mod — Property in class FileTemplate

$ Preview#mod — Property in class Preview

$ XfsDocument#mod — Property in class XfsDocument

$ ZipImportJob#mod — Property in class ZipImportJob

$ ZipImportJob#model_version — Property in class ZipImportJob

$ CategoryPage#mod — Property in class CategoryPage

$ DocumentPage#mod — Property in class DocumentPage

$ ImportCategoryPage#mod — Property in class ImportCategoryPage

$ TemplatesPage#mod — Property in class TemplatesPage

$ CategoryService#mod — Property in class CategoryService

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ Category#mod — Property in class Category

$ Category#model — Property in class Category

$ Document#mod — Property in class Document

$ Document#model — Property in class Document

$ DocumentGalleryPanel#mod — Property in class DocumentGalleryPanel

$ DocumentPage#mod — Property in class DocumentPage

$ DocumentPageSidebar#mod — Property in class DocumentPageSidebar

$ DocumentPageViews#mod — Property in class DocumentPageViews

$ DocumentPanel#mod — Property in class DocumentPanel

$ DocumentTablePanel#mod — Property in class DocumentTablePanel

$ FilterPanel#mod — Property in class FilterPanel

$ FolderTreePanel#mod — Property in class FolderTreePanel

$ FormFilterSpecification#mod — Property in class FormFilterSpecification

$ FormReportSpecification#mod — Property in class FormReportSpecification

$ PortletFolderview#mod — Property in class PortletFolderview

$ PreviewLoader#mod — Property in class PreviewLoader

$ ViewDocumentDetails#mod — Property in class ViewDocumentDetails

$ ViewDocumentLink#mod — Property in class ViewDocumentLink

$ ViewDocumentRead#mod — Property in class ViewDocumentRead

$ ViewDocumentTemplate#mod — Property in class ViewDocumentTemplate

$ ViewDocumentWrite#mod — Property in class ViewDocumentWrite

$ XfsDocument#mod — Property in class XfsDocument

$ XfsDocument#model — Property in class XfsDocument

$ ZipImportStatusBar#mod — Property in class ZipImportStatusBar

Model — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ DocumentMetaData#meta_field_id — Property in class DocumentMetaData

$ Preview#metadata — Property in class Preview

$ AdminSystemMailUserAdminConfig#mod — Property in class AdminSystemMailUserAdminConfig

$ UserSystemMailUserConfig#mod — Property in class UserSystemMailUserConfig

$ NotifyAction#mod — Property in class NotifyAction

Model — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ SystemNotificationControllerDocumentation#model — Property in class SystemNotificationControllerDocumentation

$ SettingsUserConfig#mod — Property in class SettingsUserConfig

NotificationChannelInterface::markRead() — Method in class NotificationChannelInterface

Mark Notification as read in channel

$ EmailNotificationChannel#mod — Property in class EmailNotificationChannel

EmailNotificationChannel::markRead() — Method in class EmailNotificationChannel

Mark Notification as read in channel

$ TodoPortlet#meta_info — Property in class TodoPortlet

$ TodoPortlet#mod — Property in class TodoPortlet

$ UserSetting#mod — Property in class UserSetting

$ NotifyPage#mod — Property in class NotifyPage

$ SettingsPage#mod — Property in class SettingsPage

$ NotificationAction#mod — Property in class NotificationAction

Model — Class in namespace XELOS\Modules\SystemPwa\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ SystemPwaControllerDocumentation#model — Property in class SystemPwaControllerDocumentation

$ PushNotificationChannel#mod — Property in class PushNotificationChannel

PushNotificationChannel::markRead() — Method in class PushNotificationChannel

Mark notification read in channel

$ PushSubscription#mod — Property in class PushSubscription

$ NotificationPage#mod — Property in class NotificationPage

$ ResPage#mod — Property in class ResPage

$ CronAction#mod — Property in class CronAction

$ EventCollection#mod — Property in class EventCollection

Model — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ EventDocumentation#message: — Property in class EventDocumentation

stored in MySQL as varchar

$ SystemStatsControllerDocumentation#model — Property in class SystemStatsControllerDocumentation

$ WhoisonlineShowPortlet#mod — Property in class WhoisonlineShowPortlet

$ WhoisonlineShowPortlet#meta_info — Property in class WhoisonlineShowPortlet

$ EventCollector#mod — Property in class EventCollector

$ AggregateDimension#mod — Property in class AggregateDimension

$ AggregateNumeric#mod — Property in class AggregateNumeric

$ Event#mod — Property in class Event

$ OverviewPage#mod — Property in class OverviewPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ AggregationChart#mod — Property in class AggregationChart

Model — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#minimal — Property in class Page

Page::minimal() — Method in class Page

$ CheckDocumentation#message — Property in class CheckDocumentation

$ SystemStatusControllerDocumentation#model — Property in class SystemStatusControllerDocumentation

$ Check#mod — Property in class Check

$ Result#message — Property in class Result

$ CacheCheck#mod — Property in class CacheCheck

$ ClamavCheck#mod — Property in class ClamavCheck

$ CronCheck#mod — Property in class CronCheck

$ RepoCheck#mod — Property in class RepoCheck

$ Check#mod — Property in class Check

$ Node#mod — Property in class Node

MinimalPage — Class in namespace XELOS\Modules\SystemStatus\Page

$ MinimalPage#mod — Property in class MinimalPage

$ OverviewPage#mod — Property in class OverviewPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ GlobalTaskCollection#mod — Property in class GlobalTaskCollection

$ GlobalTaskListCollection#mod — Property in class GlobalTaskListCollection

$ RecurringTaskCollection#mod — Property in class RecurringTaskCollection

$ TaskCollection#mod — Property in class TaskCollection

$ TaskListCollection#mod — Property in class TaskListCollection

Model — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#main — Property in class Page

Page::main() — Method in class Page

$ SystemTasksControllerDocumentation#model — Property in class SystemTasksControllerDocumentation

$ CalendarLinkGetEvents#mod — Property in class CalendarLinkGetEvents

$ ContactlogShowSidebar#mod — Property in class ContactlogShowSidebar

$ NewTaskProcessor#mod — Property in class NewTaskProcessor

$ TasksPortlet#meta_info — Property in class TasksPortlet

$ ShowTasksShowPortlet#mod — Property in class ShowTasksShowPortlet

$ ShowTasksShowPortlet#multi_group_context — Property in class ShowTasksShowPortlet

This portlet is Multi-Group Enabled, that means you can retrieve news from different-sub-groups to be displayed

$ ApiService#mod — Property in class ApiService

$ InstallEvents#mod — Property in class InstallEvents

$ RecurringTask#mod — Property in class RecurringTask

$ Task#model_version — Property in class Task

$ Task#model_default_render_xui — Property in class Task

$ Task#mod — Property in class Task

//todo this should be removed and model should implement DuplicatableModelInterface

$ TaskList#mod — Property in class TaskList

$ TaskList#model_version — Property in class TaskList

$ TaskList#model_default_render_xui — Property in class TaskList

$ TaskListColumn#mod — Property in class TaskListColumn

$ AdminPage#mod — Property in class AdminPage

MainPage — Class in namespace XELOS\Modules\SystemTasks\Page

$ MainPage#mod — Property in class MainPage

$ RecurringPage#mod — Property in class RecurringPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemTasksController#mod — Property in class SystemTasksController

$ SystemTasksController#model — Property in class SystemTasksController

$ Task#mod — Property in class Task

$ Task#model — Property in class Task

$ LibreofficeCheck#mod — Property in class LibreofficeCheck

$ VideoCheck#mod — Property in class VideoCheck

$ CheckCallbackPage#mod — Property in class CheckCallbackPage

$ OverviewPage#mod — Property in class OverviewPage

$ BaseWorker#mod — Property in class BaseWorker

Model — Class in namespace XELOS\Modules\SystemXelosApp\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Model#menu_item — Property in class Model

$ Page#main — Property in class Page

Page::main() — Method in class Page

Main — Class in namespace XELOS\Modules\SystemXelosApp\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

MobileNotificationChannel — Class in namespace XELOS\Modules\SystemXelosApp\Hook\Notification

Class MobileNotificationHook

$ MobileNotificationChannel#mod — Property in class MobileNotificationChannel

MobileNotificationChannel::markRead() — Method in class MobileNotificationChannel

$ Webservice#mod — Property in class Webservice

Model — Class in namespace XELOS\Modules\Tagging\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaggingControllerDocumentation#model — Property in class TaggingControllerDocumentation

$ CloudShowPortlet#mod — Property in class CloudShowPortlet

$ CloudShowPortlet#meta_info — Property in class CloudShowPortlet

$ InstallEvents#mod — Property in class InstallEvents

$ Tag#mod — Property in class Tag

$ TagDocument#mod — Property in class TagDocument

$ TagDocument#model_version — Property in class TagDocument

$ AdminPage#mod — Property in class AdminPage

$ SuggestPage#mod — Property in class SuggestPage

$ TagPage#mod — Property in class TagPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

TaggingController::mergeTags() — Method in class TaggingController

Merges multiple tags into one by reassigning the document index IDs at the tag_document table.

$ CommonOperationsTrait#mod — Property in class CommonOperationsTrait

Model — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TranslationControllerDocumentation#model — Property in class TranslationControllerDocumentation

$ TranslationSettingsLanguageConfig#mod — Property in class TranslationSettingsLanguageConfig

$ TranslateProcessor#mod — Property in class TranslateProcessor

$ TranslateDocumentSearchPreprocessor#mod — Property in class TranslateDocumentSearchPreprocessor

$ ApiCheck#mod — Property in class ApiCheck

$ IndexEventDocumentIndexEvent#mod — Property in class IndexEventDocumentIndexEvent

$ InstallEvents#mod — Property in class InstallEvents

$ BaseTranslationApi#mod — Property in class BaseTranslationApi

$ Translation#mod — Property in class Translation

$ TranslationDocument#mod — Property in class TranslationDocument

$ TranslationFeedback#mod — Property in class TranslationFeedback

$ TranslationJob#mod — Property in class TranslationJob

$ AjaxtranslatePage#mod — Property in class AjaxtranslatePage

$ FeedbackPage#mod — Property in class FeedbackPage

$ FormtranslatePage#mod — Property in class FormtranslatePage

$ SettingsPage#mod — Property in class SettingsPage

$ StatisticsPage#mod — Property in class StatisticsPage

$ TestPage#mod — Property in class TestPage

$ SystemDaemon#module_name — Property in class SystemDaemon

TranslationControllerHelper::mockTranslationApi() — Method in class TranslationControllerHelper

Mocks the translation API

$ ResultCollection#mod — Property in class ResultCollection

$ TrendvoteCollection#mod — Property in class TrendvoteCollection

Model — Class in namespace XELOS\Modules\Trendvote\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

Main — Class in namespace XELOS\Modules\Trendvote\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Main#model — Property in class Main

$ Trendvote#multivote: — Property in class Trendvote

stored in MySQL as tinyint

$ ApiService#mod — Property in class ApiService

$ InstallEvents#mod — Property in class InstallEvents

$ Trendvote#model_default_render_xui — Property in class Trendvote

$ Trendvote#multivote — Property in class Trendvote

$ ScanAction#mod — Property in class ScanAction

Model — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ VirusScanControllerDocumentation#model — Property in class VirusScanControllerDocumentation

$ VirusCheck#mod — Property in class VirusCheck

$ File#mod — Property in class File

$ Scan#mod — Property in class Scan

$ AdminPage#mod — Property in class AdminPage

$ SystemCron#module_name — Property in class SystemCron

$ SystemCron#mod_registry — Property in class SystemCron

$ OAuthClientAction#mod — Property in class OAuthClientAction

$ OAuthServerAction#mod — Property in class OAuthServerAction

ModuleService — Class in namespace XELOS\Modules\Webservice\Hook\Base

Module Service is implementing Services for ALL instances of the same module and should not be visible per instance The service will be available as soon as 1 instance of this module is installed, you need to check for access rights in methods! Core::userHasApiAccess() has no effect for this type of service

$ ModuleService#mod — Property in class ModuleService

Do not use $this->mod in a ModuleService !

Method — Class in namespace XELOS\Modules\Webservice\Hook\Base\Service

Helper class to define webservice methods.

ModelCRUD — Class in namespace XELOS\Modules\Webservice\Hook\Base\Service

Helper class to define webservice methods.

ModelMethod — Class in namespace XELOS\Modules\Webservice\Hook\Base\Service

Helper class to define webservice methods.

$ ModelMethod#model — Property in class ModelMethod

$ OAuthClientHook#max_user_connections — Property in class OAuthClientHook

How many client connections are allowed per user

$ OAuthClientHook#max_global_connections — Property in class OAuthClientHook

How many client connections are allowed on global level

$ OAuthClientCheck#mod — Property in class OAuthClientCheck

$ SoapService#mod — Property in class SoapService

$ OauthAccess#model_version — Property in class OauthAccess

$ AuthorizePage#mod — Property in class AuthorizePage

$ DocPage#mod — Property in class DocPage

$ JsonPage#mod — Property in class JsonPage

$ OAuthAccountsPage#mod — Property in class OAuthAccountsPage

$ RestPage#mod — Property in class RestPage

$ SystemCron#module_name — Property in class SystemCron

$ WebserviceController#model — Property in class WebserviceController

Model — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ WidgetsControllerDocumentation#model — Property in class WidgetsControllerDocumentation

$ WidgetsPortlet#meta_info — Property in class WidgetsPortlet

$ CategoryWidgetShowPortlet#mod — Property in class CategoryWidgetShowPortlet

$ PortletWidgetsShowPortlet#mod — Property in class PortletWidgetsShowPortlet

$ Category#mod — Property in class Category

$ Widget#mod — Property in class Widget

$ CategoriesPage#mod — Property in class CategoriesPage

$ OverviewPage#mod — Property in class OverviewPage

$ SettingsPage#mod — Property in class SettingsPage

$ WidgetList#mod — Property in class WidgetList

$ HeaderFieldsAction#mod — Property in class HeaderFieldsAction

$ ExampleSurveyControllerDocumentation#model — Property in class ExampleSurveyControllerDocumentation

Model — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CmsSimplePortletShowPortlet#mod — Property in class CmsSimplePortletShowPortlet

$ AdminPage#mod — Property in class AdminPage

$ OverviewPage#mod — Property in class OverviewPage

$ ReportPage#mod — Property in class ReportPage

N

$ Autoloader#ns_prefix — Property in class Autoloader

XELOS Namespace Prefix

NtlmAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ CommandDefinition#name — Property in class CommandDefinition

Output::newLine() — Method in class Output

Core::ngettext() — Method in class Core

Core::notify() — Method in class Core

Notification

Core::notification_info() — Method in class Core

Core::notification_mark_read() — Method in class Core

I18nTokenHelper::ngettext() — Method in class I18nTokenHelper

$ ObjectManager#ns_class_prefix — Property in class ObjectManager

An optional possibility to pretend a namespace prefix for classes have no namespace yet.

$ AuthenticationHook#name — Property in class AuthenticationHook

Name of authentication method

NavigationHook — Class in namespace XELOS\Framework\Module\Hook

Query::none() — Method in class Query

Always evaluates the scope to FALSE and can be used to force returning an empty collection in some filter conditions

$ Lib#navigation — Property in class Lib

$ Lib#notification — Property in class Lib

Lib::new_filehandler() — Method in class Lib

Lib::new_quota() — Method in class Lib

$ Date#NOW_LOCAL — Property in class Date

$ Date#NOW_LOCAL_SQL — Property in class Date

$ Date#NOW_UTC — Property in class Date

Format::number_to_str() — Method in class Format

Converts a number to its word representation

NativeMailHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger\HandlerFactory

Class NativeMailStreamHandlerFactory

Logger::namedSetup() — Method in class Logger

Setup the logger with static configuration defined at XELOS\Config\LOGGER.

Logger::notice() — Method in class Logger

$ MarkdownExtraParser#no_images — Property in class MarkdownExtraParser

If NO images are true, images are NOT embedded and will be shown as simple links opening in modal

Navigation — Class in namespace XELOS\Framework\XF\Lib

Notification — Class in namespace XELOS\Framework\XF\Lib

Class Notification

NotificationBuilder — Class in namespace XELOS\Framework\XF\Lib\Notification

Class NotificationBuilder

$ NotificationBuilder#notificationRegistryKey — Property in class NotificationBuilder

NotificationMessage — Class in namespace XELOS\Framework\XF\Lib\Notification

NotificationState — Class in namespace XELOS\Framework\XF\Lib\Notification

Class NotificationState

NotificationType — Class in namespace XELOS\Framework\XF\Lib\Notification

Class NotificationType

NonpersistentSessionHandler — Class in namespace XELOS\Framework\XF\Lib\Session

Class dummy_session_handler

NotificationCollection — Class in namespace XELOS\Framework\XF\System\Collection

$ Model#navigation — Property in class Model

$ Model#notification — Property in class Model

$ Model#notification_registry — Property in class Model

Model::new_audit_trail() — Method in class Model

Model::new_audit_policy() — Method in class Model

Model::new_global_config() — Method in class Model

Model::new_group() — Method in class Model

Model::new_i18n_token() — Method in class Model

Model::new_instance_config() — Method in class Model

Model::new_navigation() — Method in class Model

Model::new_notification() — Method in class Model

Model::new_policy2group() — Method in class Model

Model::new_policy2user() — Method in class Model

Model::new_document_index_policy_cluster() — Method in class Model

Model::new_document_index() — Method in class Model

Model::new_queue() — Method in class Model

Model::new_user_devices() — Method in class Model

Model::new_onboarding_code() — Method in class Model

Model::new_hierarchy_context() — Method in class Model

Model::new_hierarchy() — Method in class Model

Model::new_user_meta() — Method in class Model

$ AuditTrail#new_properties — Property in class AuditTrail

$ AuditTrail#new_sha256 — Property in class AuditTrail

: {type: binary, size: 32}

$ Hierarchy#name — Property in class Hierarchy

ShortName

Navigation — Class in namespace XELOS\Framework\XF\System\Model

Class Navigation

Notification — Class in namespace XELOS\Framework\XF\System\Model

$ Notification#new_at — Property in class Notification

Time when the notification was last considered "new"

NotificationRegistry — Class in namespace XELOS\Framework\XF\System\Model

$ Policy#name — Property in class Policy

$ UserLink#name — Property in class UserLink

UI::new_table() — Method in class UI

UI::new_ajax_container() — Method in class UI

UI::new_container() — Method in class UI

UI::new_image() — Method in class UI

UI::new_qrcode() — Method in class UI

UI::new_import() — Method in class UI

UI::new_breadcrumb() — Method in class UI

UI::new_calendar() — Method in class UI

UI::new_timeline() — Method in class UI

UI::new_userlink() — Method in class UI

UI::new_doclink() — Method in class UI

UI::new_progress_bar() — Method in class UI

UI::new_paging() — Method in class UI

UI::new_table_editor() — Method in class UI

UI::new_inline_editor() — Method in class UI

UI::new_form() — Method in class UI

UI::new_form_editor() — Method in class UI

UI::new_js() — Method in class UI

UI::new_tree() — Method in class UI

UI::new_tabs() — Method in class UI

UI::new_link() — Method in class UI

UI::new_faceted() — Method in class UI

UI::new_faceted_legacy() — Method in class UI

UI::new_faceted_filter() — Method in class UI

UI::new_wizard() — Method in class UI

UI::new_document_lock() — Method in class UI

UI::new_image_edit() — Method in class UI

UI::new_item_list() — Method in class UI

UI::new_carousel() — Method in class UI

UI::new_user_image() — Method in class UI

UI::new_v_card() — Method in class UI

UI::new_document_list() — Method in class UI

UI::new_reactions() — Method in class UI

$ FormComponent#name — Property in class FormComponent

$ FroalaOption#name — Property in class FroalaOption

$ Item#name — Property in class Item

$ Paging#numbers_before_and_after_dots — Property in class Paging

$ Table#new_order_field — Property in class Table

$ Table#new_order_by — Property in class Table

$ Table#new_start — Property in class Table

$ Table#no_record_message — Property in class Table

Wizard::next_step() — Method in class Wizard

put your comment there.

User::new_user_obj() — Method in class User

New User Object optional: Supply login to check for

$ View#ntlm_auth — Property in class View

Model::new_ad_cache() — Method in class Model

Model::new_synch_status() — Method in class Model

Ui::new_user_list() — Method in class Ui

$ UserAccountUserConfig#noSaveRedirect — Property in class UserAccountUserConfig

$ UserLanguageUserConfig#noSaveRedirect — Property in class UserLanguageUserConfig

$ OpenidAuthentication#name — Property in class OpenidAuthentication

$ SamlAuthentication#name — Property in class SamlAuthentication

Model::new_calendar() — Method in class Model

Model::new_calendarset() — Method in class Model

Model::new_event() — Method in class Model

Model::new_event_core() — Method in class Model

Model::new_event_instance() — Method in class Model

Model::new_participant() — Method in class Model

Model::new_reminder() — Method in class Model

Model::new_reminder_queue() — Method in class Model

Model::new_static_calendar() — Method in class Model

Model::new_sync_data() — Method in class Model

Model::new_sync_setting() — Method in class Model

Ui::new_detail() — Method in class Ui

Model::new_component() — Method in class Model

Model::new_component_live() — Method in class Model

Model::new_history() — Method in class Model

Model::new_history_component() — Method in class Model

Model::new_history_page() — Method in class Model

Model::new_page() — Method in class Model

Model::new_page_live() — Method in class Model

Model::new_partial() — Method in class Model

Model::new_partial_live() — Method in class Model

Model::new_comment() — Method in class Model

Model::new_link_info() — Method in class Model

$ Model#numberrange — Property in class Model

Model::new_category() — Method in class Model

Model::new_event() — Method in class Model

Model::new_invitation_reply_log() — Method in class Model

Model::new_numberrange() — Method in class Model

Model::new_participant() — Method in class Model

Model::new_participant_log() — Method in class Model

Model::new_related_events() — Method in class Model

Model::numberrange() — Method in class Model

Ui::new_details() — Method in class Ui

Ui::new_event() — Method in class Ui

$ EventDocumentation#number: — Property in class EventDocumentation

stored in MySQL as varchar

$ ParticipantLogDocumentation#new_status: — Property in class ParticipantLogDocumentation

stored in MySQL as varchar

$ ParticipantLogDocumentation#notify: — Property in class ParticipantLogDocumentation

stored in MySQL as varchar

$ ParticipantLogDocumentation#notify_type: — Property in class ParticipantLogDocumentation

stored in MySQL as varchar

Event::notify_organizer() — Method in class Event

notifies organizer about participant status change (if organizer_id is set)

Numberrange — Class in namespace XELOS\Modules\Eventplanner\Model

ThreadAction::notifyAboutExpiration() — Method in class ThreadAction

Model::new_category() — Method in class Model

Model::new_post() — Method in class Model

Model::new_thread() — Method in class Model

Model::new_votes() — Method in class Model

Ui::new_thread_preview() — Method in class Ui

Ui::new_vote_box() — Method in class Ui

$ ThreadDocumentation#notified_at: — Property in class ThreadDocumentation

stored in MySQL as timestamp

$ GeoFeature#name — Property in class GeoFeature

$ Location#name — Property in class Location

Model::new_task() — Method in class Model

Model::new_task_list() — Method in class Model

Model::new_task_list_column() — Method in class Model

Ui::new_task() — Method in class Ui

Ui::new_tasks_list() — Method in class Ui

$ Model#newsletter — Property in class Model

Model::new_category() — Method in class Model

Model::new_external_invitation() — Method in class Model

Model::new_group() — Method in class Model

Model::new_group_navigation() — Method in class Model

Model::new_invitation() — Method in class Model

Model::new_member() — Method in class Model

Model::new_module() — Method in class Model

Model::new_newsletter() — Method in class Model

Model::new_pending() — Method in class Model

Model::newsletter() — Method in class Model

$ Page#newsletter — Property in class Page

Page::newsletter() — Method in class Page

Ui::new_grouplist() — Method in class Ui

$ Member#newsletter: — Property in class Member

stored in MySQL as tinyint

Newsletter — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model newsletter.

$ Newsletter#newsletter_group_id — Property in class Newsletter

NewsPortlet — Class in namespace XELOS\Modules\Groups\Hook\Pages

Model::new_job() — Method in class Model

Model::new_job_history() — Method in class Model

Model::new_job_status() — Method in class Model

Ui::new_job_ui_status() — Method in class Ui

Model::new_page() — Method in class Model

Action::new_formprocessor() — Method in class Action

Action::new_formprocessor_email() — Method in class Action

Action::new_formprocessor_workflow() — Method in class Action

Model::new_category() — Method in class Model

Model::new_list_item() — Method in class Model

Model::new_list_properties() — Method in class Model

Model::new_list_status() — Method in class Model

Ui::new_category_selector() — Method in class Ui

Ui::new_item_editor() — Method in class Ui

Ui::new_item_list() — Method in class Ui

Ui::new_item_preview() — Method in class Ui

Ui::new_list_preview() — Method in class Ui

$ ListItemDocumentation#numeric_id — Property in class ListItemDocumentation

$ ListItem#numeric_id — Property in class ListItem

Model::new_profile() — Method in class Model

Model::new_profile_property() — Method in class Model

Model::new_property() — Method in class Model

Model::new_property_group() — Method in class Model

Model::new_property_tab() — Method in class Model

Model::new_property_tab_group() — Method in class Model

Model::new_tab() — Method in class Model

Ui::new_profile() — Method in class Ui

Ui::new_profile_list() — Method in class Ui

$ Property#name_i18n: — Property in class Property

stored in MySQL as varchar

$ PropertyGroup#name_i18n: — Property in class PropertyGroup

stored in MySQL as varchar

Number — Class in namespace XELOS\Modules\Lookbook\Fields

Model::new_article() — Method in class Model

Model::new_category() — Method in class Model

NewsControllerDocumentation — Class in namespace XELOS\Modules\News\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

NewsController — Class in namespace XELOS\Modules\News

Class NewsController

NewsCest — Class in namespace XELOS\Modules\News\Tests\Codeception\Acceptance

NewsControllerTest — Class in namespace XELOS\Modules\News\Tests\Codeception\Unit

Model::new_page() — Method in class Model

Model::new_page_version() — Method in class Model

Model::new_template() — Method in class Model

Model::new_template_category() — Method in class Model

$ PageVersion#navigation_title_i18n — Property in class PageVersion

PageVersion::notifyUser() — Method in class PageVersion

Model::new_confirmation() — Method in class Model

Model::new_document() — Method in class Model

Model::new_document_elasticsearch() — Method in class Model

Model::new_faceted_filter() — Method in class Model

Model::new_search_history() — Method in class Model

Model::new_searchagent() — Method in class Model

Model::new_term() — Method in class Model

$ AbstractBrowserItem#name — Property in class AbstractBrowserItem

Model::new_page() — Method in class Model

Model::new_page_history() — Method in class Model

Model::new_page_link() — Method in class Model

Ui::new_page() — Method in class Ui

Ui::new_view_wiki_read() — Method in class Ui

Ui::new_view_wiki_write() — Method in class Ui

SmartWikiController::newPageFromTemplate() — Method in class SmartWikiController

new Page from template with title, if it cant find the template, returns null

NotificationAction — Class in namespace XELOS\Modules\SystemActionlog\Action

$ Action#notification — Property in class Action

Action::notification() — Method in class Action

Model::new_document_wall_item() — Method in class Model

Model::new_entry() — Method in class Model

Model::new_hidden_instance() — Method in class Model

$ LicenseProblem#name: — Property in class LicenseProblem

enum user_limit_reached|license_about_to_expire|license_expired|unable_to_connect_to_repo

ContentFirst::new_document() — Method in class ContentFirst

Model::new_category() — Method in class Model

Model::new_document() — Method in class Model

Model::new_document_history() — Method in class Model

Model::new_document_meta_data() — Method in class Model

Model::new_document_meta_field() — Method in class Model

Model::new_document_template() — Method in class Model

Model::new_file_template() — Method in class Model

Model::new_preview() — Method in class Model

Model::new_xfs_document() — Method in class Model

Model::new_zip_import_job() — Method in class Model

Ui::new_document() — Method in class Ui

Ui::new_document_gallery_panel() — Method in class Ui

Ui::new_document_page() — Method in class Ui

Ui::new_document_page_sidebar() — Method in class Ui

Ui::new_document_page_views() — Method in class Ui

Ui::new_document_panel() — Method in class Ui

Ui::new_document_table_panel() — Method in class Ui

Ui::new_explorer() — Method in class Ui

Ui::new_filter_panel() — Method in class Ui

Ui::new_folder_tree_panel() — Method in class Ui

Ui::new_portlet_folderview() — Method in class Ui

Ui::new_preview_loader() — Method in class Ui

Ui::new_report_specification__helper() — Method in class Ui

Ui::new_view_document_details() — Method in class Ui

Ui::new_view_document_link() — Method in class Ui

Ui::new_view_document_read() — Method in class Ui

Ui::new_view_document_template() — Method in class Ui

Ui::new_view_document_write() — Method in class Ui

Ui::new_xfs_document() — Method in class Ui

Ui::new_zip_import_status_bar() — Method in class Ui

$ Category#name_i18n — Property in class Category

: stored in MySQL as varchar

$ Document#name — Property in class Document

: stored in MySQL as varchar

$ DocumentHistory#name — Property in class DocumentHistory

: stored in MySQL as varchar

NotifyAction — Class in namespace XELOS\Modules\SystemNotification\Action

$ Action#notify — Property in class Action

Model::new_user_setting() — Method in class Model

NotificationChannel — Class in namespace XELOS\Modules\SystemNotification\Hook\Base

Class NotificationChannel

NotificationChannelInterface — Class in namespace XELOS\Modules\SystemNotification\Hook\Base

Interface NotificationChannelInterface

$ CreateNotificationJob#notificationMessage — Property in class CreateNotificationJob

$ SendNotificationJob#notificationId — Property in class SendNotificationJob

NotifyPage — Class in namespace XELOS\Modules\SystemNotification\Page

NotificationAction — Class in namespace XELOS\Modules\SystemPwa\Action

Class NotificationAction

$ Action#notification — Property in class Action

Action::notification() — Method in class Action

Model::new_push_subscription() — Method in class Model

$ Page#notification — Property in class Page

Page::notification() — Method in class Page

NotificationPage — Class in namespace XELOS\Modules\SystemPwa\Page

Class Overview

Model::new_aggregate_dimension() — Method in class Model

Model::new_aggregate_numeric() — Method in class Model

Model::new_event() — Method in class Model

Ui::new_aggregation_chart() — Method in class Ui

Ui::new_level_selector() — Method in class Ui

$ Model#node — Property in class Model

Model::new_check() — Method in class Model

Model::new_node() — Method in class Model

Model::node() — Method in class Model

$ CheckDocumentation#node_id — Property in class CheckDocumentation

NodeDocumentation — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Node.

$ NodeDocumentation#node_name: — Property in class NodeDocumentation

stored in MySQL as varchar

Check::notify_user() — Method in class Check

Sends a notification about this check to the administrators of this system

Node — Class in namespace XELOS\Modules\SystemStatus\Model

Model::new_recurring_task() — Method in class Model

Model::new_task() — Method in class Model

Model::new_task_list() — Method in class Model

Model::new_task_list_column() — Method in class Model

Ui::new_task() — Method in class Ui

Ui::new_tasks_list() — Method in class Ui

$ RecurringTaskDocumentation#next_run: — Property in class RecurringTaskDocumentation

stored in MySQL as datetime

NewTaskProcessor — Class in namespace XELOS\Modules\SystemTasks\Hook\Doclink

NewTaskProcessor::new_task() — Method in class NewTaskProcessor

New Task

Model::new_menu_item() — Method in class Model

Model::new_push_client() — Method in class Model

Model::new_Tag() — Method in class Model

Model::new_TagDocument() — Method in class Model

Model::new_translation() — Method in class Model

Model::new_translation_document() — Method in class Model

Model::new_translation_feedback() — Method in class Model

Model::new_translation_job() — Method in class Model

Model::new_result() — Method in class Model

Model::new_trendvote() — Method in class Model

Model::new_file() — Method in class Model

Model::new_scan() — Method in class Model

xm_webservice_magic_action::new_oauth_client() — Method in class xm_webservice_magic_action

xm_webservice_magic_action::new_oauth_server() — Method in class xm_webservice_magic_action

xm_webservice_magic_model::new_oauth_access() — Method in class xm_webservice_magic_model

Model::new_category() — Method in class Model

Model::new_widget() — Method in class Model

Ui::new_widget_list() — Method in class Ui

$ CategoryDocumentation#name_i18n: — Property in class CategoryDocumentation

stored in MySQL as varchar

$ WidgetDocumentation#name_i18n: — Property in class WidgetDocumentation

stored in MySQL as varchar

$ WidgetDocumentation#new_tab — Property in class WidgetDocumentation

Model::new_answer() — Method in class Model

Model::new_participant() — Method in class Model

Model::new_survey() — Method in class Model

O

Bootloader::onError() — Method in class Bootloader

This method is used by the temporary error handling while booting the system and the main logging part is not available. After the process the main error handler and logging overwrite this part.

Bootloader::onException() — Method in class Bootloader

Handle Exception in case we have problem before Logger is setup

AuthenticationInterface::onBeforeExecute() — Method in class AuthenticationInterface

Function will be called before module/page execution within view controller Please note that this will affect every request (API, file requests, internal AJAX requests) You should avoid

BaseAuthentication::onBeforeExecute() — Method in class BaseAuthentication

Override in your auth method

$ AlternativeLoginAuthentication#options — Property in class AlternativeLoginAuthentication

AD-Auth Options (Set in Global Config and Read in __construct)

MultiFactorAuthentication::onAfterLogin() — Method in class MultiFactorAuthentication

$ CommandDefinition#options — Property in class CommandDefinition

$ Console#output — Property in class Console

$ Input#options — Property in class Input

Output — Class in namespace XELOS\Framework\Core\Console

Class Output

ActionHandlerHelper::offsetGet() — Method in class ActionHandlerHelper

ActionHelper::onExecuteCallback() — Method in class ActionHelper

CollectionActionHelper::onExecuteInvoke() — Method in class CollectionActionHelper

$ MagicMethodHelper#onCreateObject — Property in class MagicMethodHelper

MagicMethodHelper::onCreateObject() — Method in class MagicMethodHelper

Add Custom Object Create Callback

SerializableInterface::onSerialize() — Method in class SerializableInterface

Will be called on Serialize (like __sleep)

SerializableInterface::onUnserialize() — Method in class SerializableInterface

Will be called on unSerialize (like __wakeup)

$ Template#output_mode — Property in class Template

$ Template#option_template_debug — Property in class Template

Template::output_html() — Method in class Template

Output the final HTML

Template::output_login_form() — Method in class Template

Template::output_pw_change_form() — Method in class Template

ItemListTrait::offsetExists() — Method in class ItemListTrait

ItemListTrait::offsetGet() — Method in class ItemListTrait

ItemListTrait::offsetSet() — Method in class ItemListTrait

ItemListTrait::offsetUnset() — Method in class ItemListTrait

ObjectManager — Class in namespace XELOS\Framework\Core\Traits

Trait ObjectManager XELOS Framework

$ ObjectManager#object_cache — Property in class ObjectManager

Each object created by a success call of __call or __get will be saved into this property to avoid a multiple creation of same objects and minimize performance loss. If the multiple creation of objects is desirable e.g. in factory classes, the caching can be disabled by setting xf_trait::factory_mode to true.

SerializableObjectTrait::onSerialize() — Method in class SerializableObjectTrait

Optional: Called before serialization (e.g. to remember/convert an unserializable prop)

SerializableObjectTrait::onUnserialize() — Method in class SerializableObjectTrait

Optional: Called after unserialize (e.g. load from db / recover or connect resource)

AuthenticationHook::onBeforeExecute() — Method in class AuthenticationHook

Override in your auth method

ModulePortlet::onPublish() — Method in class ModulePortlet

Called when the staging page is published.

ModulePortlet::onDiscardChanges() — Method in class ModulePortlet

Called when the staging page is replaced with the live page.

Job::onSerialize() — Method in class Job

not used actively - tbd

Job::onScheduled() — Method in class Job

Note: This event may happen in the Frontend call

Job::onFinish() — Method in class Job

Note: This event always is being triggered by the job runner

Job::onRetry() — Method in class Job

Note: This event always is being triggered by the job runner

Job::onAbort() — Method in class Job

Note: This event always is being triggered by the job runner

Job::onCancel() — Method in class Job

Note: This event always is being triggered by the job runner

Collection::orderByViews() — Method in class Collection

Order Collection by views desc (popularity)

DocumentModel::onRestore() — Method in class DocumentModel

Automatically recover document index if document model is restored

SearchableDocumentInterface::onSearchIndexUpdate() — Method in class SearchableDocumentInterface

Update given Search Index Records during Document Indexing Requires documents to be registered and processed by index_event

SoftDeleteInterface::onRestore() — Method in class SoftDeleteInterface

Called when the model is restored.

SoftDeleteInterface::onSoftDelete() — Method in class SoftDeleteInterface

Called when softDelete is executed.

SoftDeleteInterface::onForceDelete() — Method in class SoftDeleteInterface

Called when forceDelete is executed.

ModelCollection::orderBy() — Method in class ModelCollection

ModelCollection::offsetSet() — Method in class ModelCollection

$collections[0] = $entry

ModelCollection::offsetExists() — Method in class ModelCollection

isset($collection[0])

ModelCollection::offsetUnset() — Method in class ModelCollection

unset($collection[0])

ModelCollection::offsetGet() — Method in class ModelCollection

$collection[0]

DuplicatableModelTrait::onDuplicateProperties() — Method in class DuplicatableModelTrait

DuplicatableModelTrait::onDuplicateSaved() — Method in class DuplicatableModelTrait

DuplicatableModelTrait::onReferencesDuplicated() — Method in class DuplicatableModelTrait

SoftDeleteTrait::onSoftDelete() — Method in class SoftDeleteTrait

Implement to process event

SoftDeleteTrait::onRestore() — Method in class SoftDeleteTrait

Implement to process event

SoftDeleteTrait::onForceDelete() — Method in class SoftDeleteTrait

SystemDaemon::onStartup() — Method in class SystemDaemon

Gets called once on daemon startup Use this place to prepare daemon

SystemDaemonThreaded::onThreadError() — Method in class SystemDaemonThreaded

Gets called if a thread exits with an error code It can be used e.g. to clean up unfinished work in case of an ABORTED exit status

PartitionQuery::orderBy() — Method in class PartitionQuery

Query::orderFromQuery() — Method in class Query

Applies all ORDER conditions of the passed Query object to the current query (Copy)

Query::orderBy() — Method in class Query

Adds a orderBy condition to the Query

Debug::onAfterGetPage() — Method in class Debug

Output data on page exit

SlimTimer::output_showtime_bar() — Method in class SlimTimer

Html::open_tag() — Method in class Html

Helper function to open a HTML tag (e.g.

)

NonpersistentSessionHandler::open() — Method in class NonpersistentSessionHandler

SqlSessionHandler::open() — Method in class SqlSessionHandler

DocumentIndexCollection::offsetGet() — Method in class DocumentIndexCollection

DocumentIndexReferenceCollection::offsetGet() — Method in class DocumentIndexReferenceCollection

GroupCollection::offsetGet() — Method in class GroupCollection

InstanceRegistryCollection::offsetGet() — Method in class InstanceRegistryCollection

ModuleGroupSecurityCollection::offsetGet() — Method in class ModuleGroupSecurityCollection

ModuleGroupSecurityMemberCollection::offsetGet() — Method in class ModuleGroupSecurityMemberCollection

ModuleRegistryCollection::offsetGet() — Method in class ModuleRegistryCollection

NotificationCollection::offsetGet() — Method in class NotificationCollection

UserCollection::offsetGet() — Method in class UserCollection

UserMetaCollection::offsetGet() — Method in class UserMetaCollection

$ Model#onboarding_code — Property in class Model

$ AuditTrail#old_properties — Property in class AuditTrail

$ AuditTrail#old_sha256 — Property in class AuditTrail

: {type: binary, size: 32}

DocumentIndex::onRestore() — Method in class DocumentIndex

Called when the model is restored.

DocumentIndex::onSoftDelete() — Method in class DocumentIndex

DocumentIndex::onForceDelete() — Method in class DocumentIndex

Force delete of document index should delete related document and references

DocumentIndex::onUnserialize() — Method in class DocumentIndex

Load document from DB on unserialize.

DocumentIndexReference::onForceDelete() — Method in class DocumentIndexReference

Called when forceDelete is executed.

DocumentIndexReference::onRestore() — Method in class DocumentIndexReference

Navigation::onSearchIndexUpdate() — Method in class Navigation

OnboardingCode — Class in namespace XELOS\Framework\XF\System\Model

$ Calendar#options — Property in class Calendar

Internal options

FacetedCategory::offsetGet() — Method in class FacetedCategory

FacetedCategoryList::offsetGet() — Method in class FacetedCategoryList

$ Form#open_fieldsets — Property in class Form

Form::onValidate() — Method in class Form

Set an additional validation callback, which is triggered during process()

Form::open_form() — Method in class Form

$ FroalaEditorBuilder#options — Property in class FroalaEditorBuilder

Option — Class in namespace XELOS\Framework\XF\UI\Form\Helper

OptionList — Class in namespace XELOS\Framework\XF\UI\Form\Helper

OptionList::offsetGet() — Method in class OptionList

OptionListCollectionInterface — Class in namespace XELOS\Framework\XF\UI\Form\Interfaces

OptionListProcessorInterface — Class in namespace XELOS\Framework\XF\UI\Form\Interfaces

OptionListCollectionTrait — Class in namespace XELOS\Framework\XF\UI\Form\Traits

$ Import#options — Property in class Import

Options — Class in namespace XELOS\Framework\XF\UI\Link

Generic Link Options

$ Math#operation — Property in class Math

$ Table#order_by — Property in class Table

$ Table#order_field — Property in class Table

$ Table#order_field_secondary — Property in class Table

$ Table#order_fields — Property in class Table

$ Table#order_array — Property in class Table

$ Tree#options — Property in class Tree

$ Tree#onDelete — Property in class Tree

$ Tree#onRename — Property in class Tree

$ Tree#onAdd — Property in class Tree

$ AdCache#objectsid: — Property in class AdCache

stored in MySQL as varchar

$ SynchStatus#objectsid: — Property in class SynchStatus

stored in MySQL as varchar

BadgeList::offsetGet() — Method in class BadgeList

UploadDocumentProcessor::on_trigger_action() — Method in class UploadDocumentProcessor

put your comment there.

StorageProvider::on_browse_tree() — Method in class StorageProvider

Returns an array which contains the content of the requested path. This array is used by xui_tree.

StorageProvider::on_upload() — Method in class StorageProvider

Executes the provider specific file upload from xelos to the remote storage space.

StorageProvider::on_download() — Method in class StorageProvider

Download the requested remote file and save the content to the destination path.

OnedriveBusinessStorageProvider — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\ApiCloudstorage

Class OnedriveBusinessStorageProvider

OnedriveStorageProvider — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\ApiCloudstorage

Class OnedriveStorageProvider

OnedriveStorageProvider::on_browse_tree() — Method in class OnedriveStorageProvider

Returns an array which contains the content of the requested path. This array is used by xui_tree.

OnedriveStorageProvider::on_upload() — Method in class OnedriveStorageProvider

Executes the provider specific file upload from xelos to the remote storage space.

OnedriveStorageProvider::on_download() — Method in class OnedriveStorageProvider

Download the requested remote file and save the content to the destination path.

OutlookPersonalCalenderGetEvents — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Calendar

Class OutlookPersonalCalenderGetEvents

$ CoAuthorDocumentProcessor#oneDriveStorageProvider — Property in class CoAuthorDocumentProcessor

CoAuthorDocumentProcessor::on_trigger_action() — Method in class CoAuthorDocumentProcessor

put your comment there.

OutlookInboxShowPortlet — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Portal

Class OutlookInboxShowPortlet

MicrosoftOauthClient::onBeforeSaveClient() — Method in class MicrosoftOauthClient

MicrosoftOauthClient::onBeforeDeleteClient() — Method in class MicrosoftOauthClient

OnedriveOauthClient — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Webservice

Class OnedriveOauthClient

OpenidAuthentication — Class in namespace XELOS\Modules\AuthOpenid\Hook\System

OpenidOauthClient — Class in namespace XELOS\Modules\AuthOpenid\Hook\Webservice

Class MicrosoftOauthClient

OpenidOauthClient::onBeforeSaveClient() — Method in class OpenidOauthClient

OpenidOauthClient::onBeforeDeleteClient() — Method in class OpenidOauthClient

$ SyncData#old_event_data: — Property in class SyncData

stored in MySQL as mediumblob

$ SyncData#old_sync_data: — Property in class SyncData

stored in MySQL as mediumblob

CommentCollection::offsetGet() — Method in class CommentCollection

Comment::onRestore() — Method in class Comment

Automatically recover document index if document model is restored

Comment::onSearchIndexUpdate() — Method in class Comment

ChannelCollection::offsetGet() — Method in class ChannelCollection

ChannelSourceDocumentCollection::offsetGet() — Method in class ChannelSourceDocumentCollection

ChannelSubscriptionCollection::offsetGet() — Method in class ChannelSubscriptionCollection

ActivityIndexerSearchPreprocessor::onBackgroundUpdate() — Method in class ActivityIndexerSearchPreprocessor

As likes/views change permanently we update these values on each background update operation for all documents

CategoryCollection::offsetGet() — Method in class CategoryCollection

EventCollection::offsetGet() — Method in class EventCollection

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

$ EventDocumentation#organizer_id — Property in class EventDocumentation

$ ParticipantLogDocumentation#old_status: — Property in class ParticipantLogDocumentation

stored in MySQL as varchar

Event::onDuplicateProperties() — Method in class Event

Called before save() and after the properties have been copied to the new $duplicate model

Event::onSearchIndexUpdate() — Method in class Event

OverviewPage — Class in namespace XELOS\Modules\Eventplanner\Page

CategoryCollection::offsetGet() — Method in class CategoryCollection

ThreadCollection::offsetGet() — Method in class ThreadCollection

$ ForumController#object_cache — Property in class ForumController

Category::onSearchIndexUpdate() — Method in class Category

Category::onRestore() — Method in class Category

Automatically recover document index if document model is restored

Post::onRestore() — Method in class Post

Automatically recover document index if document model is restored

Post::onSearchIndexUpdate() — Method in class Post

Thread::onRestore() — Method in class Thread

Automatically recover document index if document model is restored

Thread::onSearchIndexUpdate() — Method in class Thread

$ Step#operatableCategory — Property in class Step

$ Step#operatableThreadRoute — Property in class Step

$ Step#operatablePost — Property in class Step

Step::operatableThreadRoute() — Method in class Step

Step::operatableCategoryRoute() — Method in class Step

LocationCollection::offsetGet() — Method in class LocationCollection

GeoIpAuthentication::onBeforeExecute() — Method in class GeoIpAuthentication

Check every request for matching GeoIP Block

$ GeoFeature#osmId — Property in class GeoFeature

$ GeoFeature#osmType — Property in class GeoFeature

RecurringTaskCollection::offsetGet() — Method in class RecurringTaskCollection

TaskCollection::offsetGet() — Method in class TaskCollection

TaskListCollection::offsetGet() — Method in class TaskListCollection

GroupCollection::offsetGet() — Method in class GroupCollection

MemberCollection::offsetGet() — Method in class MemberCollection

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

$ Module#options: — Property in class Module

stored in MySQL as text

LeaveApplicationCollection::offsetGet() — Method in class LeaveApplicationCollection

TravelCollection::offsetGet() — Method in class TravelCollection

$ JobDocumentation#owner_thread: — Property in class JobDocumentation

stored in MySQL as varchar

$ JobHistoryDocumentation#owner_thread: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

TestJob::onAbort() — Method in class TestJob

Note: This event always is being triggered by the job runner

TestJob::onRetry() — Method in class TestJob

Note: This event always is being triggered by the job runner

TestJob::onScheduled() — Method in class TestJob

Note: This event may happen in the Frontend call

SystemDaemon::onStartup() — Method in class SystemDaemon

Startup of Daemon (Fail all aborted jobs on this node)

SystemDaemon::onThreadError() — Method in class SystemDaemon

Mark jobs as failed if a thread fails

ListItemCollection::offsetGet() — Method in class ListItemCollection

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

ListItem::onSearchIndexUpdate() — Method in class ListItem

Make list items searchable in central search

ListProperties::onSearchIndexUpdate() — Method in class ListProperties

OverviewPage — Class in namespace XELOS\Modules\Lists\Page

ProfileCollection::offsetGet() — Method in class ProfileCollection

$ Property#owner: — Property in class Property

enum user|component

ArticleCollection::orderByPublishedAt() — Method in class ArticleCollection

Top news are first sorted by the topnews_sort property then published_at.

ArticleCollection::offsetGet() — Method in class ArticleCollection

CategoryCollection::offsetGet() — Method in class CategoryCollection

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

Article::onSearchIndexUpdate() — Method in class Article

OverviewPage — Class in namespace XELOS\Modules\News\Page

Class xpage_news_overview

ComponentCollection::offsetGet() — Method in class ComponentCollection

PageCollection::offsetGet() — Method in class PageCollection

PageVersionCollection::offsetGet() — Method in class PageVersionCollection

Page::onSearchIndexUpdate() — Method in class Page

Page::onDuplicateProperties() — Method in class Page

Page::onForceDelete() — Method in class Page

Remove all orphaned page versions if page has been removed

Page::onRestore() — Method in class Page

Automatically recover document index if document model is restored

PageVersion::onReferencesDuplicated() — Method in class PageVersion

ConfirmationCollection::offsetGet() — Method in class ConfirmationCollection

DocumentCollection::offsetGet() — Method in class DocumentCollection

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

OverviewPage — Class in namespace XELOS\Modules\ReadConfirmation\Page

Class Overview

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

SearchPreprocessor::onBackgroundUpdate() — Method in class SearchPreprocessor

Maintenance Function which will be calls every time a scheduled Background Update should be run This function can be used to trigger mass-updates on the search

OverviewPage — Class in namespace XELOS\Modules\Search\Page

Page::onRestore() — Method in class Page

Restore the history and links.

Page::onForceDelete() — Method in class Page

Delete the history and links.

Page::onSearchIndexUpdate() — Method in class Page

$ Page#overview — Property in class Page

OverviewPage — Class in namespace XELOS\Modules\SystemActionlog\Page

Old activity feed / Rarely / not in use anymore? Maybe we convert this to some kind of Admin-History/Stats view at some point?

WebdavService::onUploadFinished() — Method in class WebdavService

PreviewJob::onRetry() — Method in class PreviewJob

PreviewJob::onAbort() — Method in class PreviewJob

Sets the previews as failed when the job aborts.

Category::onSearchIndexUpdate() — Method in class Category

Adds the Category to the search index

Document::onSearchIndexUpdate() — Method in class Document

Document::onDuplicateSaved() — Method in class Document

Called after the document was duplicated and saved.

DocumentTablePanel::onTablePopulate() — Method in class DocumentTablePanel

Returns an array contains a total count of items, documents and folders.

EventCollection::offsetGet() — Method in class EventCollection

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

OverviewPage — Class in namespace XELOS\Modules\SystemStats\Page

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

$ NodeDocumentation#operation: — Property in class NodeDocumentation

enum normal|maintenance|deploy_to|deploy_from

OverviewPage — Class in namespace XELOS\Modules\SystemStatus\Page

RecurringTaskCollection::offsetGet() — Method in class RecurringTaskCollection

TaskCollection::offsetGet() — Method in class TaskCollection

TaskListCollection::offsetGet() — Method in class TaskListCollection

Task::onSearchIndexUpdate() — Method in class Task

TaskList::onDuplicateSaved() — Method in class TaskList

OverviewPage — Class in namespace XELOS\Modules\SystemWorker\Page

TagPage::orderDocuments() — Method in class TagPage

Sorting function to determine the order of the documents to display.

$ TranslationDocumentDocumentation#original_content: — Property in class TranslationDocumentDocumentation

stored in MySQL as mediumtext

$ TranslationDocumentDocumentation#original_language: — Property in class TranslationDocumentDocumentation

stored in MySQL as varchar

$ TranslationDocumentation#original_content: — Property in class TranslationDocumentation

stored in MySQL as mediumtext

$ TranslationDocumentation#original_language: — Property in class TranslationDocumentation

stored in MySQL as varchar

ResultCollection::offsetGet() — Method in class ResultCollection

TrendvoteCollection::offsetGet() — Method in class TrendvoteCollection

Trendvote::onSearchIndexUpdate() — Method in class Trendvote

Update given Search Index Records during Document Indexing Requires documents to be registered and processed by index_event

OAuthClientAction — Class in namespace XELOS\Modules\Webservice\Action

Class xaction_webservice_oauth_client

OAuthServerAction — Class in namespace XELOS\Modules\Webservice\Action

Class OAuthServerAction

OAuthClientHook — Class in namespace XELOS\Modules\Webservice\Hook

Class OAuthClient

$ OAuthClientHook#oauthAccess — Property in class OAuthClientHook

OAuthClientHook::onBeforeSaveClient() — Method in class OAuthClientHook

Method will be called after successful authentication shortly before OAuth access is persisted to DB permamently

OAuthClientHook::onBeforeDeleteClient() — Method in class OAuthClientHook

Method will be called when user or admin disconnects/removes account within user settings

OAuthClientCheck — Class in namespace XELOS\Modules\Webservice\Hook\SystemStatus

OAuthClient — Class in namespace XELOS\Modules\Webservice\Lib

Class OAuthClient

OAuthProvider — Class in namespace XELOS\Modules\Webservice\Lib

Class OAuthProvider

OpenIDConfiguration — Class in namespace XELOS\Modules\Webservice\Lib

Class OpenIDConfiguration

OauthAccess — Class in namespace XELOS\Modules\Webservice\Model

Class xmodel_webservice_oauth_access

OAuthAccountsPage — Class in namespace XELOS\Modules\Webservice\Page

$ xm_webservice_magic_action#oauth_client — Property in class xm_webservice_magic_action

$ xm_webservice_magic_action#oauth_server — Property in class xm_webservice_magic_action

$ xm_webservice_magic_model#oauth_access — Property in class xm_webservice_magic_model

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

OverviewPage — Class in namespace XELOS\Modules\Widgets\Page

$ Page#overview — Property in class Page

Page::overview() — Method in class Page

OverviewPage — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Page

xelos page, is automatically called based on the page param: http://www.example.com/module/PAGE

P

$ UserDetails#password — Property in class UserDetails

Preview — Class in namespace XELOS\Framework\Core\Console\Command

Console::printDebugProfiling() — Method in class Console

Prints debug profiling information.

Table::print() — Method in class Table

Outputs the whole table

Input::parseArguments() — Method in class Input

Input::parseOption() — Method in class Input

Output::parseColorTags() — Method in class Output

$ Core#parent_context — Property in class Core

$ Core#page — Property in class Core

Access to pages defined in the class sub-folder page

Core::prepareQueryWithParams() — Method in class Core

Core::prepare_query() — Method in class Core

Core::prepare_lquery() — Method in class Core

Core::pquery() — Method in class Core

Core::print_context_menu() — Method in class Core

Core::print_context_menu_with_submenu() — Method in class Core

Core::print_preview_link() — Method in class Core

Core::print_file_link() — Method in class Core

Print File Link (Alias Function)

Core::page__feed() — Method in class Core

Core::page__file() — Method in class Core

Core::page__deeplink() — Method in class Core

DeepLink Page (will be called for unresolvable deeplinks, e.g. from hooks search or others

ActionHandlerHelper::push() — Method in class ActionHandlerHelper

$ XUILinkHelper#parent_context — Property in class XUILinkHelper

IndexEventInterface::process_document_index() — Method in class IndexEventInterface

Process Document Event

ItemListInterface::push() — Method in class ItemListInterface

$ Template#previous_render_mode — Property in class Template

Template::pre_render_action() — Method in class Template

Enables a template to execute certain tasks before page is fully rendered (e.g. AJAX navigation)

Template::parse_partial_template() — Method in class Template

Template::parse_template() — Method in class Template

Generic Template Loader

Template::parse_template_translate_cb() — Method in class Template

Callback used by template language replace

Template::parse_template_content() — Method in class Template

Template::parse_xtag() — Method in class Template

Evaluate the passed XML Source parse xTags

CoreLinkMethods::print_link() — Method in class CoreLinkMethods

Wrapper for XF->lib->link substituting modules with instance names etc.

CoreLinkMethods::print_current_link() — Method in class CoreLinkMethods

ItemListTrait::push() — Method in class ItemListTrait

LegacyTrait::parseLegacyDocuments() — Method in class LegacyTrait

$ Controller#page — Property in class Controller

PortletMigrationInterface — Class in namespace XELOS\Framework\Module\Hook\Interfaces

$ ModulePortlet#portlet_config — Property in class ModulePortlet

$ ModulePortlet#portlet_title — Property in class ModulePortlet

$ ModulePortlet#portlet_title_link — Property in class ModulePortlet

Collection::populateDocumentIndexes() — Method in class Collection

Preload Document Indexes for the Models in this collection Make sure to add this listener before using documentindexes in other populate functions

Collection::populateMagicDocumentHelperList() — Method in class Collection

Preload Document Indexes for the Models in this collection Make sure to add this listener before using documentindexes in other populate functions

Collection::populateDocumentStatistics() — Method in class Collection

Populate common document statistics: comments, likes, views

Collection::populateDocumentReactions() — Method in class Collection

Collection::populateDocumentTags() — Method in class Collection

Read tags associated with the current documents and attach the corresponding tags to the models

Collection::populateUsers() — Method in class Collection

Read associated users from property and attach the corresponding model

Collection::populateGroupSecurity() — Method in class Collection

Collection::populateApiProperties() — Method in class Collection

Map internal collection information to fulfill the promised ParameterObject

DocumentModel::parseIdRefProperty() — Method in class DocumentModel

Function to parse a property which is supposed to contain id references

$ Model#properties — Property in class Model

$ Model#properties_meta — Property in class Model

Model::populate_model_by_query() — Method in class Model

ModelCollection::pluck() — Method in class ModelCollection

Returns the passed property of all objects in an array

ModelCollection::pluck_unique() — Method in class ModelCollection

Returns the passed property of all objects in an array (unique and filtered)

ModelCollection::pluckWithScopeQuery() — Method in class ModelCollection

Returns the passed property. In contrast to pluck() this function does not use the loaded models but uses a SQL query to retrieve the values Attention: This returns the RAW database values

ModelCollection::pop() — Method in class ModelCollection

this function returns the last value of the models-array, shortening the models-array by one element.

ModelCollection::push() — Method in class ModelCollection

this function treats models-array as a stack, and pushes the passed variables onto the end of array.

$ AuditableTrait#properties — Property in class AuditableTrait

$ SoftDeleteTrait#properties — Property in class SoftDeleteTrait

XQLCollectionTrait::populateApiProperties() — Method in class XQLCollectionTrait

Map internal collection information to fulfill the promised ParameterObject

Page — Class in namespace XELOS\Framework\Module\Page

Class Page

SetupPage::page_overview() — Method in class SetupPage

Make an overview page, displaying all available setup steps and their completion state

SystemCron::process() — Method in class SystemCron

$ SystemDaemon#process_counter — Property in class SystemDaemon

SystemDaemon::process() — Method in class SystemDaemon

SystemDaemonThreaded::processThread() — Method in class SystemDaemonThreaded

SystemDaemonThreaded::process() — Method in class SystemDaemonThreaded

Main Daemon Process used to orchestrate all working threads Important: Must not contain any blocking operations

Document::process() — Method in class Document

Declared in Classes

Document::process_sidebar() — Method in class Document

UIAjaxComponent::process_xui() — Method in class UIAjaxComponent

Optional processing method.

UIAjaxComponent::process() — Method in class UIAjaxComponent

dummy process method - may be overwritten

UIAjaxComponent::printAjaxLink() — Method in class UIAjaxComponent

UIAjaxComponent::printCurrentAjaxLink() — Method in class UIAjaxComponent

UIComponent::parse_template() — Method in class UIComponent

UIComponent::parse_template_cb_wrapper() — Method in class UIComponent

UIComponent::parse_xtag() — Method in class UIComponent

UIComponent::process() — Method in class UIComponent

Declared in Classes

$ DB#password — Property in class DB

$ MySQLAdapter#password — Property in class MySQLAdapter

$ MySQLAdapter#port — Property in class MySQLAdapter

MySQLAdapter::pquery() — Method in class MySQLAdapter

Prepared Statement Query

MySQLAdapter::prepare_debug_profiling() — Method in class MySQLAdapter

Prepare Profiling Infos from Database if in DEVMODE

PartitionQuery — Class in namespace XELOS\Framework\XF\DB\QueryBuilder

PartitionQuery can be used to build a query with a window function See https://dev.mysql.com/doc/refman/8.0/en/window-functions.html for more details about window functions

$ Lib#privacy — Property in class Lib

$ Lib#policy — Property in class Lib

Convert::pdf_to_image() — Method in class Convert

Debug::print_a() — Method in class Debug

Debug::print_counts() — Method in class Debug

File::put_file_contents() — Method in class File

$ Filehandler#path_zip — Property in class Filehandler

Filehandler::process() — Method in class Filehandler

Filehandler::process_zip() — Method in class Filehandler

Seeding::prepareInstallation() — Method in class Seeding

Link::print_link() — Method in class Link

Print full HTML Link

Link::print_url() — Method in class Link

Print URL Link

Link::print_current_link() — Method in class Link

Print current full HTML Link

Link::print_current_url() — Method in class Link

Print current URL Link

Link::print_context_menu() — Method in class Link

Display Context Links

NativeMailHandlerFactory::prepareRecord() — Method in class NativeMailHandlerFactory

$ Mail#port — Property in class Mail

$ Mail#password — Property in class Mail

Mail::prepare_attachment() — Method in class Mail

Prepare Attachment for sending

$ NotificationBuilder#plaintextCallback — Property in class NotificationBuilder

$ NotificationBuilder#plainTextToken — Property in class NotificationBuilder

Policy — Class in namespace XELOS\Framework\XF\Lib

$ Policy#parity_ints — Property in class Policy

Policy::parse_policies() — Method in class Policy

Generates a filtered policy array using a policy centroid (which can also be a user_diff), an optional changes array and an optional set of prefixes the found policies should be filtered for. Returns an assoc array that holds the proper parity integer for each policy key found. This may include unset properties as them being unset is only saved in the changes column of the user_policy_diff table until the next user group calc run.

Privacy — Class in namespace XELOS\Framework\XF\Lib

$ Quota#percent — Property in class Quota

$ Request#post — Property in class Request

$ Request#put — Property in class Request

$ SecureEvalClass#parseErrors — Property in class SecureEvalClass

Parse Errors

SecureEvalClass::parse() — Method in class SecureEvalClass

Check for Parse Errors

Session::pollute_session() — Method in class Session

sets is_dirty flag for session(s) of given user_id (or array of ids) if user id is false, current user id is used

Session::pollute_session_for_groups() — Method in class Session

Sets is_dirty flag for all sessions assigned to users within $groups

SessionDirtyFlagStorageInterface::pollute_user_session() — Method in class SessionDirtyFlagStorageInterface

Marks the session for the given user_id as dirty

SqlSessionHandler::pollute_user_session() — Method in class SqlSessionHandler

Marks the session for the given user_id as dirty

JsonParser::parseFile() — Method in class JsonParser

Parses the passed JSON file and returns an TokenCollection

JsonParser::parseFolder() — Method in class JsonParser

Parses all locales/.json files within the passed folder including all subfolders

PoParser — Class in namespace XELOS\Framework\XF\Lib\i18n\Parser

PoParser::parseFile() — Method in class PoParser

SourcecodeParser::parseFolder() — Method in class SourcecodeParser

Parses all Sourcecode files (php,js) in the specified folder for sourcecode strings

TemplateParser::parseFolder() — Method in class TemplateParser

Parses .tpl files in the specified folders and returns a TokenCollection

VueFileParser::parseFolder() — Method in class VueFileParser

Parses .vue files in the specified folders and returns a TokenCollection

DocumentIndexCollection::populateApiProperties() — Method in class DocumentIndexCollection

Map internal collection information to fulfill the promised ParameterObject

DocumentIndexReferenceCollection::populateApiProperties() — Method in class DocumentIndexReferenceCollection

Map internal collection information to fulfill the promised ParameterObject

ModuleGroupSecurityCollection::populateMemberCount() — Method in class ModuleGroupSecurityCollection

Adds the property member_count to each model with the members count

ModuleGroupSecurityCollection::populateLocalGroupInfo() — Method in class ModuleGroupSecurityCollection

Populate local group information - this can be done as XQL or Model

NotificationCollection::populateApiProperties() — Method in class NotificationCollection

Map internal collection information to fulfill the promised ParameterObject

PagesCollection — Class in namespace XELOS\Framework\XF\System\Collection

PolicyCollection — Class in namespace XELOS\Framework\XF\System\Collection

UserCollection::populatePortraitURL() — Method in class UserCollection

UserCollection::populateAvailability() — Method in class UserCollection

UserCollection::populateApiProperties() — Method in class UserCollection

Map internal collection information to fulfill the promised ParameterObject

$ Model#pages — Property in class Model

$ Model#policy — Property in class Model

$ Model#policy2group — Property in class Model

$ Model#policy2user — Property in class Model

$ DocumentIndex#properties — Property in class DocumentIndex

$ DocumentIndex#parent_document — Property in class DocumentIndex

$ DocumentIndex#parent_group_document — Property in class DocumentIndex

$ DocumentIndex#post_id — Property in class DocumentIndex

$ DocumentIndex#post_type — Property in class DocumentIndex

$ DocumentIndex#post_created_at — Property in class DocumentIndex

Y-m-d H:i:s

$ DocumentIndex#post_updated_at — Property in class DocumentIndex

Y-m-d H:i:s

$ DocumentIndex#possible_rights_context — Property in class DocumentIndex

DocumentIndex::prefetch_document_indexes() — Method in class DocumentIndex

Prefetch document indexes in single batch for later usage via cache

$ DocumentIndexPolicyCluster#policy_result — Property in class DocumentIndexPolicyCluster

Enum: pending, processing, allow, deny

$ DocumentRegistry#primary_document — Property in class DocumentRegistry

$ DocumentRegistry#post_type — Property in class DocumentRegistry

$ Hierarchy#properties — Property in class Hierarchy

$ Hierarchy#pid — Property in class Hierarchy

HierarchyContext::populate_hierarchy() — Method in class HierarchyContext

Populate Hierarchy

$ I18nToken#plural_token — Property in class I18nToken

Plural token

$ InstanceSetup#properties — Property in class InstanceSetup

$ Navigation#properties — Property in class Navigation

$ Notification#properties — Property in class Notification

$ Notification#plaintext — Property in class Notification

$ Notification#processed_at — Property in class Notification

$ NotificationRegistry#priority — Property in class NotificationRegistry

low,medium,high

$ OnboardingCode#pin — Property in class OnboardingCode

The encrypted/hashed pin for the given code

Pages — Class in namespace XELOS\Framework\XF\System\Model

$ Pages#public — Property in class Pages

$ Pages#page_id — Property in class Pages

Policy — Class in namespace XELOS\Framework\XF\System\Model

Class xdummy_system_policy_model_collection

Policy2Group — Class in namespace XELOS\Framework\XF\System\Model

Class Policy2Group

Policy2User — Class in namespace XELOS\Framework\XF\System\Model

Class Policy2User

PrivacyRules — Class in namespace XELOS\Framework\XF\System\Model

$ RecentDocument#properties — Property in class RecentDocument

$ ThemeSet#properties — Property in class ThemeSet

ThemeSet::parse_css_file() — Method in class ThemeSet

Replaces Variables in the passed CSS file

ThemeSet::parse_css_color_cb() — Method in class ThemeSet

ThemeSet::parse_css_url_cb() — Method in class ThemeSet

ThemeSet::parse_css_var_cb() — Method in class ThemeSet

$ User#properties — Property in class User

ATTENTION: Custom save handler - consider on setting properties to this model

User::parse_template() — Method in class User

Parse Template for User Properties

User::parse_template_cb() — Method in class User

$ UserConfig#properties — Property in class UserConfig

$ UserGroup#properties — Property in class UserGroup

$ UserMeta#properties — Property in class UserMeta

$ UI#primary_admin_links — Property in class UI

AjaxContainer::process() — Method in class AjaxContainer

AmchartBar::process() — Method in class AmchartBar

Create Chart object and apply default settings

AmchartChart::process() — Method in class AmchartChart

Declared in Classes

AmchartGantt::process() — Method in class AmchartGantt

Create Chart object and apply default settings

AmchartPie::process() — Method in class AmchartPie

Declared in Classes

Browse::process_xui() — Method in class Browse

Process the input as preparation to the render process

$ Container#placeholderContent — Property in class Container

$ Css#position — Property in class Css

DocumentLock::process_xui() — Method in class DocumentLock

Process and prepare xui for rendering.

DocumentView::process_sidebar() — Method in class DocumentView

Process Siedbar

Faceted::process() — Method in class Faceted

Process all parameters

FacetedFilter::process() — Method in class FacetedFilter

Process all parameters

FacetedLegacy::process() — Method in class FacetedLegacy

Process all parameters

FacetedCategory::pushItem() — Method in class FacetedCategory

Adds an item to the ItemList

FacetedCategory::push() — Method in class FacetedCategory

Form::process() — Method in class Form

Form::process_fields() — Method in class Form

Form::post_processing() — Method in class Form

Form::parse_pop_query() — Method in class Form

Form::populate() — Method in class Form

FormChoice::process() — Method in class FormChoice

Process e.g. file upload, resize etc.

FormComponent::process() — Method in class FormComponent

Process e.g. file upload, resize etc.

FormComponent::post_process() — Method in class FormComponent

FormContentAttachment::process() — Method in class FormContentAttachment

Executed during validation (before form output and before saving)

FormContentAttachment::post_process() — Method in class FormContentAttachment

Executed after saving if form is considered valid

FormDocument::process() — Method in class FormDocument

Process the component, storing provided files in a temporary folder

FormDocument::post_process() — Method in class FormDocument

FormFile::process() — Method in class FormFile

FormFile::post_process() — Method in class FormFile

FormGeoSelector::process() — Method in class FormGeoSelector

Process e.g. file upload, resize etc.

FormMediaAttachment::process() — Method in class FormMediaAttachment

Executed during validation (before form output and before saving)

FormMediaAttachment::post_process() — Method in class FormMediaAttachment

Executed after saving if form is considered valid

FormMultifile::process() — Method in class FormMultifile

FormMultifile::post_process() — Method in class FormMultifile

FormPolicySelector::process() — Method in class FormPolicySelector

Process e.g. file upload, resize etc.

FormPolicySelector::post_process() — Method in class FormPolicySelector

$ FormRowRenderer#properties — Property in class FormRowRenderer

$ FormRowRendererMultifieldRow#properties — Property in class FormRowRendererMultifieldRow

$ FormRowRendererMultirowTable#properties — Property in class FormRowRendererMultirowTable

FormTag::process() — Method in class FormTag

Process e.g. file upload, resize etc.

FormTag::post_process() — Method in class FormTag

Save Tags of document

FormTextarea::process() — Method in class FormTextarea

Process e.g. file upload, resize etc.

FormTextboxList::process() — Method in class FormTextboxList

Render the proper JSON Object containing all autocomplete lookup values as well as their keys.

FormUserSelector::process() — Method in class FormUserSelector

Process e.g. file upload, resize etc.

$ FroalaEditorBuilder#previewInsertGroups — Property in class FroalaEditorBuilder

FroalaOption::pasteAllowedStyleProps() — Method in class FroalaOption

The list of allowed CSS attributes to be used for tags on paste.

FroalaOption::pasteAllowLocalImages() — Method in class FroalaOption

Removes images that have local path (file://) on paste. Enabling this option might result in having mixed content on HTTPS websites.

FroalaOption::pasteDeniedAttrs() — Method in class FroalaOption

Attributes that are removed when pasting something into the rich text editor.

FroalaOption::pasteDeniedTags() — Method in class FroalaOption

Tags that are removed together with their content when pasting something into the rich text editor.

FroalaOption::pastePlain() — Method in class FroalaOption

Removes text formatting when pasting content into the rich text editor, but keeps the content's structure.

FroalaOption::placeholderText() — Method in class FroalaOption

The placeholder used when the WYSIWYG editor body is empty.

FroalaOption::pluginsEnabled() — Method in class FroalaOption

The plugins that should be enabled in the current editor instance. By default, all plugins are enabled. Available plugins are: align, charCounter, codeBeautifier, codeView, colors, draggable, embedly, emoticons, entities, file, fontAwesome, fontFamily, fontSize, fullscreen, image, imageTUI, imageManager, inlineStyle, inlineClass, lineBreaker, lineHeight, link, lists, paragraphFormat, paragraphStyle, quickInsert, quote, save, table, url, video, wordPaste.

Note: Each plugin requires you to include the corresponding JS and CSS files. Here is the <a href="../docs/plugins/" class="f-link" title="Plugins" target="_blank">complete list of plugins and the files required by them.

FroalaOption::paragraphDefaultSelection() — Method in class FroalaOption

The default option to select for Paragraph Format.

FroalaOption::paragraphFormat() — Method in class FroalaOption

An Object with the options that will appear in the Paragraph Format dropdown from the toolbar. Where 'N' tag will be treated as a <p> when the enter option is set to FroalaEditor.ENTER_P and as a <div> when the <a href="#enter" title="enter" target="_blank">enter option is set to FroalaEditor.ENTER_DIV.

FroalaOption::paragraphFormatSelection() — Method in class FroalaOption

The Paragraph Format button from the WYSIWYG editor's toolbar is replaced with a dropdown showing the actual paragraph format name for the current text selection.

FroalaOption::paragraphMultipleStyles() — Method in class FroalaOption

Allows multiple paragraph styles to be selected at a time.

FroalaOption::paragraphStyles() — Method in class FroalaOption

Set custom styles for the selected paragraph. The classes should be defined in CSS, otherwise no changes will be visible on the paragraph's appearance.

OptionList::push() — Method in class OptionList

HtmlGeneric::prependContent() — Method in class HtmlGeneric

Prepend content to be surrounded by tags

$ HtmlTree#params — Property in class HtmlTree

ImageEdit::process_xui() — Method in class ImageEdit

Process XUI

$ Instance#page — Property in class Instance

$ ItemList#pagination — Property in class ItemList

ItemList::process_xui() — Method in class ItemList

Paging — Class in namespace XELOS\Framework\XF\UI

Paging::process() — Method in class Paging

Paging::prepare_query() — Method in class Paging

Portlet — Class in namespace XELOS\Framework\XF\UI

$ Portlet#portlet — Property in class Portlet

ProgressBar — Class in namespace XELOS\Framework\XF\UI

$ Table#process_priority — Property in class Table

$ Table#process_queue_id — Property in class Table

$ Table#process_queue — Property in class Table

$ Table#pre_ordered — Property in class Table

$ TableEditor#params — Property in class TableEditor

customizable by xTags

TableEditor::process() — Method in class TableEditor

$ Tree#pid_field — Property in class Tree

Tree::process() — Method in class Tree

VCard::process_xui() — Method in class VCard

Optional processing method.

VideoPlayer::process_xui() — Method in class VideoPlayer

Optional processing method.

$ ViewModeSwitcher#predefined_viewmodes — Property in class ViewModeSwitcher

Initialized in constructor

ViewModeSwitcher::process_xui() — Method in class ViewModeSwitcher

Optional processing method.

Wizard::prev_step() — Method in class Wizard

put your comment there.

Wizard::process_xui() — Method in class Wizard

put your comment there.

$ User#policy — Property in class User

Page — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#page — Property in class Main

$ SynchStatus#properties — Property in class SynchStatus

ListPage::page_overview() — Method in class ListPage

ListPage::page_sync_action() — Method in class ListPage

SystemCron::process() — Method in class SystemCron

PasswordAction — Class in namespace XELOS\Modules\Administration\Action

$ AdministrationControllerDocumentation#page — Property in class AdministrationControllerDocumentation

$ Action#password — Property in class Action

Page — Class in namespace XELOS\Modules\Administration\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

LanguageSettingLanguageConfig::process() — Method in class LanguageSettingLanguageConfig

UserAccountUserConfig::process() — Method in class UserAccountUserConfig

UserAdvancedUserAdminConfig::process() — Method in class UserAdvancedUserAdminConfig

UserAuditLogUserAdminConfig::process() — Method in class UserAuditLogUserAdminConfig

Can be used for saving/processing data, will be called before render()

UserDevicesUserConfig::process() — Method in class UserDevicesUserConfig

Can be used for saving/processing data, will be called before render()

UserDevicesUserConfig::processOnboardingModal() — Method in class UserDevicesUserConfig

UserGroupsUserAdminConfig::process() — Method in class UserGroupsUserAdminConfig

UserLanguageUserConfig::process() — Method in class UserLanguageUserConfig

UserPolicyUserAdminConfig::policyTableActionCb() — Method in class UserPolicyUserAdminConfig

UserPolicyUserAdminConfig::process() — Method in class UserPolicyUserAdminConfig

UserSecurityUserConfig::process() — Method in class UserSecurityUserConfig

Can be used for saving/processing data, will be called before render()

LanguageConfigInterface::process() — Method in class LanguageConfigInterface

Can be used for saving/processing data

$ UserAdminConfig#processResult — Property in class UserAdminConfig

$ UserAdminConfig#processMessage — Property in class UserAdminConfig

UserAdminConfigInterface::process() — Method in class UserAdminConfigInterface

Can be used for saving/processing data, will be called before render()

AuthenticationPage::page_overview() — Method in class AuthenticationPage

DesignPage::page_overview() — Method in class DesignPage

HierarchyPage::pageOverview() — Method in class HierarchyPage

HierarchyPage::populateHierarchyGroups() — Method in class HierarchyPage

Populate

LicensePage::page_overview() — Method in class LicensePage

SimpleGroupsPage::page_overview() — Method in class SimpleGroupsPage

Page Overview

SimpleGroupsPage::page_group() — Method in class SimpleGroupsPage

Show detail of a specific group

SimpleGroupsPage::page_edit_group() — Method in class SimpleGroupsPage

Modal Dialog for adding new groups and editing existing groups

SimpleGroupsPage::page_members() — Method in class SimpleGroupsPage

UserGroupsPage::pageOverview() — Method in class UserGroupsPage

UserGroupsPage::pageAccessInfo() — Method in class UserGroupsPage

Show Access Information for Security Group / Role

UserSessionsPage::pageOverview() — Method in class UserSessionsPage

SystemCron::process() — Method in class SystemCron

Process Block Routing

PasswordActionTest — Class in namespace XELOS\Modules\Administration\Tests\Codeception\Unit

PasswordActionTest::passwordProvider() — Method in class PasswordActionTest

UserList::process_xui() — Method in class UserList

PresenceUserLinks — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Doclink

ApiPage::page_bot() — Method in class ApiPage

Messaging Bot Extension for MS Teams https://docs.microsoft.com/de-de/microsoftteams/platform/messaging-extensions/what-are-messaging-extensions https://docs.microsoft.com/de-de/microsoftteams/platform/messaging-extensions/how-to/search-commands/respond-to-search?tabs=json

ApiPage::page_search() — Method in class ApiPage

Backwards Compatibility Method

ApiPage::page_personal() — Method in class ApiPage

Show personal tab using the TeamsJS SDK

ApiPage::page_channel() — Method in class ApiPage

This is a proof of concept page to understand how the configurable tabs work in general

DirectoryPage::page_overview() — Method in class DirectoryPage

DirectoryPage::page_users() — Method in class DirectoryPage

DirectoryPage::page_details() — Method in class DirectoryPage

DirectoryPage::page_aad() — Method in class DirectoryPage

Generate Teams App

DirectoryPage::page_teams() — Method in class DirectoryPage

Page — Class in namespace XELOS\Modules\AuthSaml\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#page — Property in class Main

Meta::page_overview() — Method in class Meta

SloPage::page_overview() — Method in class SloPage

SloPage::page_idp_logout() — Method in class SloPage

$ Model#participant — Property in class Model

Model::participant() — Method in class Model

Page — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#page — Property in class Main

$ Calendar#public: — Property in class Calendar

stored in MySQL as tinyint

$ Event#private: — Property in class Event

stored in MySQL as tinyint

Participant — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model participant.

$ Reminder#pid — Property in class Reminder

$ Reminder#ptype: — Property in class Reminder

enum event|task

$ ReminderQueue#pid — Property in class ReminderQueue

$ Model#page — Property in class Model

$ Model#page_live — Property in class Model

$ Model#partial — Property in class Model

$ Model#partial_live — Property in class Model

Model::page() — Method in class Model

Model::page_live() — Method in class Model

Model::partial() — Method in class Model

Model::partial_live() — Method in class Model

Page — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#page — Property in class Main

$ Component#partial_id — Property in class Component

$ Component#properties: — Property in class Component

stored in MySQL as longtext

$ ComponentLive#partial_id — Property in class ComponentLive

$ ComponentLive#properties: — Property in class ComponentLive

stored in MySQL as longtext

$ History#page_id — Property in class History

$ HistoryComponent#page_id — Property in class HistoryComponent

$ HistoryComponent#partial_id — Property in class HistoryComponent

$ HistoryComponent#properties: — Property in class HistoryComponent

stored in MySQL as longtext

Page — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model page.

PageLive — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model page_live.

$ PageLive#pid — Property in class PageLive

Partial — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model partial.

$ Partial#page_id — Property in class Partial

$ Partial#position — Property in class Partial

PartialLive — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model partial_live.

$ PartialLive#page_id — Property in class PartialLive

$ PartialLive#position — Property in class PartialLive

ParserAction — Class in namespace XELOS\Modules\Comments\Action

Class ParserAction

CommentsController::page_main() — Method in class CommentsController

This is the default page which is returned when the Controller is being rendered in a template

$ Action#parser — Property in class Action

Action::parser() — Method in class Action

$ Comment#pid — Property in class Comment

IndexEventDocumentIndexEvent::process_document_index() — Method in class IndexEventDocumentIndexEvent

Notify users that someone commented on their document

$ Comment#properties — Property in class Comment

$ LinkInfo#properties — Property in class LinkInfo

PortletActionShowPortlet — Class in namespace XELOS\Modules\DMS\Hook\Portal

PortletFolderhierarchyShowPortlet — Class in namespace XELOS\Modules\DMS\Hook\Portal

PortletFolderviewShowPortlet — Class in namespace XELOS\Modules\DMS\Hook\Portal

PortletNavigatorShowPortlet — Class in namespace XELOS\Modules\DMS\Hook\Portal

PortletReportShowPortlet — Class in namespace XELOS\Modules\DMS\Hook\Portal

Preview — Class in namespace XELOS\Modules\DMS\Model

Class Category

PortletFolderview — Class in namespace XELOS\Modules\DMS\UI

PreviewLoader — Class in namespace XELOS\Modules\DMS\UI

Class PreviewLoader

$ ChannelFollowsShowPortlet#portlet_title — Property in class ChannelFollowsShowPortlet

$ FollowedDocumentsShowPortlet#portlet_config — Property in class FollowedDocumentsShowPortlet

$ FollowedDocumentsShowPortlet#portlet_title — Property in class FollowedDocumentsShowPortlet

ActivityIndexerSearchPreprocessor::preProcessDocument() — Method in class ActivityIndexerSearchPreprocessor

Add like and view attribute to SearchIndexRecord

IndexEventDocumentIndexEvent::process_document_index() — Method in class IndexEventDocumentIndexEvent

PostAction — Class in namespace XELOS\Modules\Eventplanner\Action

Created by PhpStorm.

EventCollection::populateParticipantStatus() — Method in class EventCollection

Add participant status for current user

$ EventplannerControllerDocumentation#page — Property in class EventplannerControllerDocumentation

$ Action#post — Property in class Action

Action::post() — Method in class Action

$ Model#participant — Property in class Model

$ Model#participant_log — Property in class Model

Model::participant() — Method in class Model

Model::participant_log() — Method in class Model

Page — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#participants — Property in class Page

$ Page#post — Property in class Page

Page::participants() — Method in class Page

Page::post() — Method in class Page

$ CategoryDocumentation#pid — Property in class CategoryDocumentation

$ EventDocumentation#provider: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#participant_visibility: — Property in class EventDocumentation

stored in MySQL as tinyint

$ InvitationReplyLogDocumentation#participant_id — Property in class InvitationReplyLogDocumentation

ParticipantDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Participant.

ParticipantLogDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model ParticipantLog.

$ ParticipantLogDocumentation#participant_id — Property in class ParticipantLogDocumentation

$ EventplannerController#pages — Property in class EventplannerController

$ EventplannerController#participationDescription — Property in class EventplannerController

Each entry in callToActionTitles has a description text which might contain the response date as a %s placeholder.

$ CRMParticipationShowPortlet#portlet_config — Property in class CRMParticipationShowPortlet

$ CalendarLinkGetEvents#portlet_config — Property in class CalendarLinkGetEvents

$ CalendarLinkGetEvents#portlet_title — Property in class CalendarLinkGetEvents

PayloadParticipantPayload — Class in namespace XELOS\Modules\Eventplanner\Hook\Workflows

Created by PhpStorm.

$ PayloadParticipantPayload#page_model — Property in class PayloadParticipantPayload

ProcessParticipantAction — Class in namespace XELOS\Modules\Eventplanner\Hook\Workflows

Created by PhpStorm.

ProcessParticipantAction::process() — Method in class ProcessParticipantAction

$ Event#properties — Property in class Event

$ Numberrange#properties — Property in class Numberrange

Participant — Class in namespace XELOS\Modules\Eventplanner\Model

Class XELOS\Modules\Eventplanner\Model\Participant

$ Participant#properties — Property in class Participant

ParticipantLog — Class in namespace XELOS\Modules\Eventplanner\Model

AdminPage::page_overview() — Method in class AdminPage

CategoriesPage::page_overview() — Method in class CategoriesPage

Edit categories

DetailPage::page_overview() — Method in class DetailPage

View Event Details

EventActionPage::page_overview() — Method in class EventActionPage

public page to confirm,deny an event invitation (link from invitation mail)

EventActionPage::page_view() — Method in class EventActionPage

EventActionPage::page_register() — Method in class EventActionPage

OverviewPage::page_overview() — Method in class OverviewPage

List all events with appropriate filters

OverviewPage::page_ical() — Method in class OverviewPage

ParticipantsPage — Class in namespace XELOS\Modules\Eventplanner\Page

ParticipantsPage::page_overview() — Method in class ParticipantsPage

PostPage — Class in namespace XELOS\Modules\Eventplanner\Page

PostPage::page_overview() — Method in class PostPage

Edit Event (Tab 1)

PostPage::page_options() — Method in class PostPage

Page Options

PostPage::page_participants() — Method in class PostPage

Page Participants

PostPage::page_invitation_wizard() — Method in class PostPage

PostPage::page_hooks_invite() — Method in class PostPage

Called from XELOS\Modules\Eventplanner\Action\InvitationsAction

PostPage::page_related() — Method in class PostPage

PostPage::page_send() — Method in class PostPage

Page to send messages to event participants with attachments and iCal.

SystemCron::process() — Method in class SystemCron

Process configured cronjobs

PostCollection — Class in namespace XELOS\Modules\Forum\Collection

PostCollection::populateApiProperties() — Method in class PostCollection

Map internal collection information to fulfill the promised ParameterObject

ThreadCollection::populateLinkProperties() — Method in class ThreadCollection

ThreadCollection::populateApiProperties() — Method in class ThreadCollection

Map internal collection information to fulfill the promised ParameterObject

$ ForumControllerDocumentation#page — Property in class ForumControllerDocumentation

$ Model#post — Property in class Model

Model::post() — Method in class Model

Page — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CategoryDocumentation#p_id — Property in class CategoryDocumentation

PostDocumentation — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Post.

$ ForumController#paging — Property in class ForumController

$ ForumController#policy_default_access — Property in class ForumController

GroupsTemplateInit::process() — Method in class GroupsTemplateInit

CreateThreadAction::process() — Method in class CreateThreadAction

$ ThreadPayload#payload_type_reference — Property in class ThreadPayload

$ ThreadPayload#payload_convertible_to_pdf — Property in class ThreadPayload

UpdateThreadAction::process() — Method in class UpdateThreadAction

$ Category#properties — Property in class Category

Post — Class in namespace XELOS\Modules\Forum\Model

$ Post#properties — Property in class Post

$ Thread#properties — Property in class Thread

EditPage::page_edit_category() — Method in class EditPage

EditPage::page_edit_thread() — Method in class EditPage

EditPage::page_edit_post() — Method in class EditPage

FeedPage::page_feed() — Method in class FeedPage

SystemCron::process() — Method in class SystemCron

Process Block Routing

ParticipantRole — Class in namespace XELOS\Modules\Forum\Tests\Codeception\Support

Class ParticipantGuy

VoteBox::process_xui() — Method in class VoteBox

IndexEventDocumentIndexEvent::process_document_index() — Method in class IndexEventDocumentIndexEvent

$ GeoFeature#postalCode — Property in class GeoFeature

TestPage::page_overview() — Method in class TestPage

MapLocation::process_xui() — Method in class MapLocation

Optional processing method.

$ GroupsTasksControllerDocumentation#page — Property in class GroupsTasksControllerDocumentation

Page — Class in namespace XELOS\Modules\GroupsTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaskDocumentation#parent — Property in class TaskDocumentation

$ TaskDocumentation#priority: — Property in class TaskDocumentation

enum low|medium|high|auto

$ TaskDocumentation#personal_sort — Property in class TaskDocumentation

$ TaskDocumentation#personal_category_num — Property in class TaskDocumentation

GroupsTemplateInit::process() — Method in class GroupsTemplateInit

$ TaskList#properties — Property in class TaskList

GroupCollection::populateGroupSecurity() — Method in class GroupCollection

GroupCollection::populateApiProperties() — Method in class GroupCollection

Map internal collection information to fulfill the promised ParameterObject

$ Model#pending — Property in class Model

Model::pending() — Method in class Model

Page — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#page — Property in class Main

$ Category#pid — Property in class Category

$ Group#public: — Property in class Group

stored in MySQL as tinyint

Pending — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\Model

This file provides property and method documentation for the model pending.

GroupDocumentUpdateDocumentIndexEvent::process_document_index() — Method in class GroupDocumentUpdateDocumentIndexEvent

LeaveApplicationCollection::populateProperties() — Method in class LeaveApplicationCollection

$ JobQueueControllerDocumentation#page — Property in class JobQueueControllerDocumentation

Page — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

CallbackPage::page_worker() — Method in class CallbackPage

Provides an API the update job status information from external sources (e.g. worker container)

StatusPage::page_overview() — Method in class StatusPage

Provides an API the fetch job status information from the frontend

TestPage::page_overview() — Method in class TestPage

Provides an API the fetch job status information from the frontend

SystemDaemon::processThread() — Method in class SystemDaemon

Main Process Loop for each Thread to fetch and process each job. Called multiple times per thread.

$ LegalControllerDocumentation#page — Property in class LegalControllerDocumentation

$ Model#page — Property in class Model

Model::page() — Method in class Model

Page — Class in namespace XELOS\Modules\Legal\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

PageDocumentation — Class in namespace XELOS\Modules\Legal\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Page.

$ PageDocumentation#page_type: — Property in class PageDocumentation

enum disclaimer|imprint|accessibility

PrivacyCentreUserConfig — Class in namespace XELOS\Modules\Legal\Hook\Administration

PrivacyCentreUserConfig::process() — Method in class PrivacyCentreUserConfig

Can be used for saving/processing data, will be called before render()

Page — Class in namespace XELOS\Modules\Legal\Model

AccessibilityPage::page_overview() — Method in class AccessibilityPage

Displays the imprint on a public page.

AdminPage::page_overview() — Method in class AdminPage

Edit page for the disclaimer and the disclaimer settings.

AdminPage::page_imprint() — Method in class AdminPage

Edit page for the imprint.

AdminPage::page_accessibility() — Method in class AdminPage

Edit page for the imprint.

AdminPage::page_privacy() — Method in class AdminPage

Edit page for the privacy page information.

AdminPage::page_mail_footer() — Method in class AdminPage

Edit page for the mail footer for all mails sent from XELOS.

DisclaimerPage::page_overview() — Method in class DisclaimerPage

Displays the disclaimer. If the user has to agree to it, the confirm form will be displayed.

ImprintPage::page_overview() — Method in class ImprintPage

Displays the imprint on a public page.

PrivacyPage — Class in namespace XELOS\Modules\Legal\Page

PrivacyPage::page_overview() — Method in class PrivacyPage

PrivacyPage::page_reactions() — Method in class PrivacyPage

Show information/data processed related to reactions

PrivacyPage::page_comments() — Method in class PrivacyPage

Show information/data processed related to reactions

FormprocessorEmailAction::process() — Method in class FormprocessorEmailAction

Process

FormprocessorWorkflowAction::process() — Method in class FormprocessorWorkflowAction

Process

$ ListsControllerDocumentation#page — Property in class ListsControllerDocumentation

Page — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CategoryDocumentation#pid — Property in class CategoryDocumentation

$ ListDocumentation#process_email_subject: — Property in class ListDocumentation

stored in MySQL as varchar

$ ListDocumentation#process_email_recipients: — Property in class ListDocumentation

stored in MySQL as text

$ ListDocumentation#process_workflow_id — Property in class ListDocumentation

Field::processSavingInformation() — Method in class Field

Processes the information on saving the list item.

Field::prepareFilterValue() — Method in class Field

Before the faceted filters are updated, prepare the values to be storage friendly and useful.

AssignedUsers::processSavingInformation() — Method in class AssignedUsers

Processes the information on saving the list item.

Date::processSavingInformation() — Method in class Date

Processes the information on saving the list item.

Date::prepareFilterValue() — Method in class Date

Converts the formatted or the default value into a timestamp, that will be saved as filterable value.

Datetime::processSavingInformation() — Method in class Datetime

Processes the information on saving the list item.

Datetime::prepareFilterValue() — Method in class Datetime

Prepares the value for the date time field, so the array will be flattened into a string, which is friendlier to use as a filter.

Document::processSavingInformation() — Method in class Document

Processes the information on saving the list item.

PrefilledField — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Asset::processSavingInformation() — Method in class Asset

Ticket::processSavingInformation() — Method in class Ticket

StaticText::prepareFilterValue() — Method in class StaticText

A static text, which always contains the same (default) value, shouldn't be set as a filter.

Textarea::processSavingInformation() — Method in class Textarea

Processes the information on saving the list item.

Textbox::prepareFilterValue() — Method in class Textbox

Before the faceted filters are updated, prepare the values to be storage friendly and useful.

Timespan::processSavingInformation() — Method in class Timespan

Additionally writes the start_at timestamp into the form data, that - if needed - a faceted field can be created, which renders useful when it comes to sorting the table for timespan fields.

UserSelector::processSavingInformation() — Method in class UserSelector

ProgressContext — Class in namespace XELOS\Modules\Lists\Hook\Pages\Context

$ ListsGanttShowPortlet#portlet_config — Property in class ListsGanttShowPortlet

$ ListsGanttShowPortlet#portlet_title — Property in class ListsGanttShowPortlet

$ ListsPortletShowPortlet#portlet_config — Property in class ListsPortletShowPortlet

$ ListsPortletShowPortlet#portlet_title — Property in class ListsPortletShowPortlet

$ ListsSingleShowPortlet#portlet_config — Property in class ListsSingleShowPortlet

$ ListsSingleShowPortlet#portlet_title — Property in class ListsSingleShowPortlet

FilterListItemsAction::process() — Method in class FilterListItemsAction

$ ListItemPayload#payload_type_reference — Property in class ListItemPayload

$ ListItemPayload#payload_convertible_to_pdf — Property in class ListItemPayload

SetFieldAction::process() — Method in class SetFieldAction

Set the item field to the selected value

UpdateStatusAction::process() — Method in class UpdateStatusAction

Set the item field to the selected value

$ Category#pid — Property in class Category

$ ListItem#properties — Property in class ListItem

$ ListProperties#properties — Property in class ListProperties

$ ListProperties#process_email_subject — Property in class ListProperties

Subject of form email

$ ListProperties#process_email_recipients — Property in class ListProperties

Recipients of form email

$ ListProperties#process_db_storage_sql — Property in class ListProperties

Database storage SQL

$ ListProperties#process_workflow_id — Property in class ListProperties

Workflow ID

EditItemPage::page_overview() — Method in class EditItemPage

EditItemPage::page_preset() — Method in class EditItemPage

Passes the parameters given to the overview page in order to use alternative routing for presets.

EditItemPage::page_delete() — Method in class EditItemPage

ItemOverviewPage::page_overview() — Method in class ItemOverviewPage

Show all the accessible list entries of the selected list with the faceted search if it is activated.

ItemOverviewPage::page_admin() — Method in class ItemOverviewPage

ItemOverviewPage::page_view() — Method in class ItemOverviewPage

Shows the readonly form for a list item if the user has the following policies:

• read category
• read list
• if the user only has read list: status rights_check is read_all or read_assigned and the user is assigned.

ItemOverviewPage::page_html() — Method in class ItemOverviewPage

ItemOverviewPage::page_pdf() — Method in class ItemOverviewPage

OverviewPage::page_overview() — Method in class OverviewPage

Show all accessible lists with their category.

SettingsPage::page_overview() — Method in class SettingsPage

Show all lists per category

CategorySelector::process_xui() — Method in class CategorySelector

Optional processing method.

ItemEditor::process_xui() — Method in class ItemEditor

ItemList::process_xui() — Method in class ItemList

ListPortlet::process_xui() — Method in class ListPortlet

Optional processing method.

ProfileCollection — Class in namespace XELOS\Modules\Lookbook\Collection

ProfileCollection::populateMappedCompanyFields() — Method in class ProfileCollection

ProfileCollection::populateUserPortrait() — Method in class ProfileCollection

ProfilePropertyCollection — Class in namespace XELOS\Modules\Lookbook\Collection

PropertyCollection — Class in namespace XELOS\Modules\Lookbook\Collection

PropertyGroupCollection — Class in namespace XELOS\Modules\Lookbook\Collection

$ Model#profile — Property in class Model

$ Model#profile_property — Property in class Model

$ Model#property — Property in class Model

$ Model#property_group — Property in class Model

$ Model#property_tab — Property in class Model

$ Model#property_tab_group — Property in class Model

Model::profile() — Method in class Model

Model::profile_property() — Method in class Model

Model::property() — Method in class Model

Model::property_group() — Method in class Model

Model::property_tab() — Method in class Model

Model::property_tab_group() — Method in class Model

Page — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Ui#profile — Property in class Ui

$ Ui#profile_list — Property in class Ui

$ Main#page — Property in class Main

Profile — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\Model

This file provides property and method documentation for the model profile.

ProfileProperty — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\Model

This file provides property and method documentation for the model profile_property.

$ ProfileProperty#profile_id — Property in class ProfileProperty

$ ProfileProperty#property_id — Property in class ProfileProperty

Property — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\Model

This file provides property and method documentation for the model property.

$ Property#printable: — Property in class Property

stored in MySQL as tinyint

$ Property#peer_privacy: — Property in class Property

enum disabled|allow_default|deny_default

PropertyGroup — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\Model

This file provides property and method documentation for the model property_group.

PropertyTab — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\Model

This file provides property and method documentation for the model property_tab.

PropertyTabGroup — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\Model

This file provides property and method documentation for the model property_tab_group.

$ PropertyTabGroup#property_tab_id — Property in class PropertyTabGroup

$ PropertyTabGroup#position: — Property in class PropertyTabGroup

enum left|full|right

Checkbox::processSubmittedValue() — Method in class Checkbox

Country::preparePropertyDisplay() — Method in class Country

Country::processSubmittedValue() — Method in class Country

Processes the submitted value after a users profile has been saved.

Date::processConfigVariables() — Method in class Date

Date::preparePropertyDisplay() — Method in class Date

Before the properties are displayed, some fields need to prepare their values or other information, which will be covered here.

Followers::preparePropertyDisplay() — Method in class Followers

Follows::preparePropertyDisplay() — Method in class Follows

Image::preparePropertyDisplay() — Method in class Image

Image::processSubmittedValue() — Method in class Image

Number::processSubmittedValue() — Method in class Number

Number::processConfigVariables() — Method in class Number

Phoneno — Class in namespace XELOS\Modules\Lookbook\Fields

Phoneno::processSubmittedValue() — Method in class Phoneno

Select::processSubmittedValue() — Method in class Select

SystemUser::processConfigVariables() — Method in class SystemUser

SystemUserGroup::processSubmittedValue() — Method in class SystemUserGroup

SystemUserGroup::processConfigVariables() — Method in class SystemUserGroup

SystemUserGroup::preparePropertyDisplay() — Method in class SystemUserGroup

SystemUserMeta::processConfigVariables() — Method in class SystemUserMeta

Tagging::processSubmittedValue() — Method in class Tagging

Tagging::preparePropertyDisplay() — Method in class Tagging

Before the properties are displayed, some fields need to prepare their values or other information, which will be covered here.

UserSelector::processSubmittedValue() — Method in class UserSelector

Zip::processSubmittedValue() — Method in class Zip

IndexEventDocumentIndexEvent::process_document_index() — Method in class IndexEventDocumentIndexEvent

FieldInterface::processConfigVariables() — Method in class FieldInterface

Extracts the config from the corresponding fields and evaluates the field value.

FieldInterface::processSubmittedValue() — Method in class FieldInterface

Processes the submitted value after a users profile has been saved.

FieldInterface::preparePropertyDisplay() — Method in class FieldInterface

Before the properties are displayed, some fields need to prepare their values or other information, which will be covered here.

FieldTrait::processConfigVariables() — Method in class FieldTrait

FieldTrait::processSubmittedValue() — Method in class FieldTrait

FieldTrait::preparePropertyDisplay() — Method in class FieldTrait

HasLabelsInterface::parseLabeledValues() — Method in class HasLabelsInterface

Parse available field values into an array with key => value pairs.

HasLabelsTrait::parseLabeledValues() — Method in class HasLabelsTrait

Parses the property's values string into an array with key => value pairs, for example: "key1=label1;key2=label2" becomes ['key1' => 'label1', 'key2' => 'label2'].

PropertyGroupExtensionInterface — Class in namespace XELOS\Modules\Lookbook\Interfaces

LookbookProfileTest::propertySearchQueryProvider() — Method in class LookbookProfileTest

Property search query provider

ArticleCollection::populateCategoryTitle() — Method in class ArticleCollection

Populates the field category_title in the article collection.

ArticleCollection::populateArticleIsVideo() — Method in class ArticleCollection

ArticleCollection::populateDisplayname() — Method in class ArticleCollection

ArticleCollection::populateApiProperties() — Method in class ArticleCollection

Map internal collection information to fulfill the promised ParameterObject

CategoryCollection::populateIsWritable() — Method in class CategoryCollection

Page — Class in namespace XELOS\Modules\News\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Page#post — Property in class Page

Page::post() — Method in class Page

$ ArticleDocumentation#published_at: — Property in class ArticleDocumentation

stored in MySQL as datetime

$ NewsControllerDocumentation#page — Property in class NewsControllerDocumentation

GroupsTemplateInit::process() — Method in class GroupsTemplateInit

process

$ RecentShowPortlet#portlet_config — Property in class RecentShowPortlet

$ RecentShowPortlet#portlet_title — Property in class RecentShowPortlet

$ ArticlePayload#payload_type_reference — Property in class ArticlePayload

ArticlePublishAction::process() — Method in class ArticlePublishAction

Process action

PublishJob — Class in namespace XELOS\Modules\News\Infrastructure\Job

$ PublishJob#parentContext — Property in class PublishJob

$ Article#properties — Property in class Article

$ Article#publish_request_status — Property in class Article

Article::publishRequest() — Method in class Article

Set Article in "Publish Request" state -> waiting for an Editor to publish the article

Article::publish() — Method in class Article

Publish this article

$ Category#properties — Property in class Category

NewsController::page_feed() — Method in class NewsController

PostPage — Class in namespace XELOS\Modules\News\Page

Class xpage_news_post

PostPage::page_edit() — Method in class PostPage

Formular Page to post a new article The document or image upload action is set #49 set_download_handler which

PostPage::page_overview() — Method in class PostPage

Dashboard Overview

PostPage::page_readconfirmation() — Method in class PostPage

PageApiAction — Class in namespace XELOS\Modules\Pages\Action

PageCollection — Class in namespace XELOS\Modules\Pages\Collection

PageVersionCollection — Class in namespace XELOS\Modules\Pages\Collection

$ Action#page_api — Property in class Action

$ Action#PageApi — Property in class Action

Action::page_api() — Method in class Action

$ Model#page — Property in class Model

$ Model#page_version — Property in class Model

Model::page() — Method in class Model

Model::page_version() — Method in class Model

Page — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

PageComponentDocumentation — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\Model

This file provides property and method documentation for the model PageComponent.

$ PageComponentDocumentation#page_id — Property in class PageComponentDocumentation

$ PageComponentDocumentation#page_version_id — Property in class PageComponentDocumentation

PageDocumentation — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Page.

$ PageDocumentation#pid — Property in class PageDocumentation

PageVersionDocumentation — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\Model

This file provides property and method documentation for the model PageVersion.

$ PageVersionDocumentation#page_id — Property in class PageVersionDocumentation

PagesControllerDocumentation — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ PagesControllerDocumentation#page — Property in class PagesControllerDocumentation

PageJsonMigrator — Class in namespace XELOS\Modules\Pages\Lib

Helper for migrating JSON content in page versions, templates and components to a new version

PageJsonProcessor — Class in namespace XELOS\Modules\Pages\Lib

Helper for reading and interpreting the Frontend Page JSON Format We have two syntaxes for attachment:

• Syntax A: A fixed defined structure of components having a fixed documentId reference
• Syntax B: A new, more flexible way by allowing the frontend to define elements with a @type=attachment key

Page — Class in namespace XELOS\Modules\Pages\Model

$ Page#pid — Property in class Page

PageVersion — Class in namespace XELOS\Modules\Pages\Model

$ PageVersion#page_id — Property in class PageVersion

PageVersion::publishRequest() — Method in class PageVersion

Set Page in "Publish Request" state -> waiting for an Editor to publish the article

PageVersion::publish() — Method in class PageVersion

Publishes the current version and move existing published version to history

EditorPage::page_overview() — Method in class EditorPage

Editors Dashboard

EditorPage::page_preview() — Method in class EditorPage

Render Page Preview

EditorPage::page_edit() — Method in class EditorPage

VUE Page Editor

EditorPage::page_newbulk() — Method in class EditorPage

Small helper for creating many pages for testing

EditorPage::page_detail() — Method in class EditorPage

EditorPage::page_permissions() — Method in class EditorPage

Page Permissions Modal (Create/Edit Permissions)

ExportPage::page_overview() — Method in class ExportPage

Displays a table with the pages and enables a partial export.

ExportPage::page_export() — Method in class ExportPage

ExportPage::page_import() — Method in class ExportPage

Testing for import

ExportPage::page_template() — Method in class ExportPage

PagesController — Class in namespace XELOS\Modules\Pages

PagesController::page404() — Method in class PagesController

SystemCron::process() — Method in class SystemCron

PortletHookTest — Class in namespace XELOS\Modules\Pages\Tests\Codeception\Unit

Page — Class in namespace XELOS\Modules\Pages\Ui

PageRenderer — Class in namespace XELOS\Modules\Pages\Ui

$ PageRenderer#pageVersion — Property in class PageRenderer

$ PageRenderer#pageConfig — Property in class PageRenderer

PersonalWorkspaceDocumentBrowser — Class in namespace XELOS\Modules\PersonalWorkspace\Hook\Selector\Browser

Class PersonalWorkspaceDocumentBrowser

$ WebdavService#pw_mod — Property in class WebdavService

$ Workspace#properties — Property in class Workspace

AdminPage::page_overview() — Method in class AdminPage

show a list of users with the config_var quota_size set for this instance in system_user_config

AdminPage::page_edit_user() — Method in class AdminPage

PersonalWorkspaceController — Class in namespace XELOS\Modules\PersonalWorkspace

Class PersonalWorkspaceController

PersonalWorkspaceControllerTest — Class in namespace XELOS\Modules\PersonalWorkspace\Tests\Codeception\Unit

Class PersonalWorkspaceControllerTest

$ PersonalWorkspaceControllerTest#personalWorkspaceController — Property in class PersonalWorkspaceControllerTest

Page — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ReadConfirmationControllerDocumentation#page — Property in class ReadConfirmationControllerDocumentation

$ ReadConfirmationShowPortlet#portlet_config — Property in class ReadConfirmationShowPortlet

$ ReadConfirmationShowPortlet#portlet_title — Property in class ReadConfirmationShowPortlet

AdminPage::page_overview() — Method in class AdminPage

AdminPage::page_detail() — Method in class AdminPage

OverviewPage::page_overview() — Method in class OverviewPage

Overview for the user, is also used for access control who should be able to see the respective portlets

OverviewPage::page_redirect() — Method in class OverviewPage

Report::process_xui() — Method in class Report

Setup and prepare facet, table and actions for this UI

IndexerAction::process() — Method in class IndexerAction

Process all relevant things for this search index entry (attachments, tags, etc.)

IndexerAction::processPreProcessorHooks() — Method in class IndexerAction

Applies available search.search_preprocessor hooks on the SearchIndexRecord

Page — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TermDocumentation#phonetic: — Property in class TermDocumentation

stored in MySQL as varchar

$ SearchControllerDocumentation#page — Property in class SearchControllerDocumentation

SearchPreprocessor::preProcessDocument() — Method in class SearchPreprocessor

This function is called for each indexed document and gets an array with the SearchIndexRecords of this specific document.

PortletSearchShowPortlet — Class in namespace XELOS\Modules\Search\Hook\Portal

$ PortletSearchShowPortlet#portlet_config — Property in class PortletSearchShowPortlet

UpdateSearchIndexDocumentIndexEvent::process_document_index() — Method in class UpdateSearchIndexDocumentIndexEvent

Update / Delete Search Index corresponding to document index

$ DocumentElasticsearch#properties — Property in class DocumentElasticsearch

MaintenancePage::page_overview() — Method in class MaintenancePage

SettingsPage::page_overview() — Method in class SettingsPage

Search System Settings

SettingsPage::page_facets() — Method in class SettingsPage

$ SearchController#portlet_search — Property in class SearchController

Used in the themes to display the search bar

$ SearchIndexRecord#preProcessingData — Property in class SearchIndexRecord

SystemCron::process() — Method in class SystemCron

SearchIntegrationResultPanel::process_xui() — Method in class SearchIntegrationResultPanel

Optional processing method.

Page — Class in namespace XELOS\Modules\SmartWiki\CF

$ Model#page — Property in class Model

$ Model#page_history — Property in class Model

$ Model#page_link — Property in class Model

Model::page() — Method in class Model

Model::page_history() — Method in class Model

Model::page_link() — Method in class Model

Page — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Ui#page — Property in class Ui

PageDocumentation — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Page.

$ PageDocumentation#pid — Property in class PageDocumentation

$ PageDocumentation#published_at: — Property in class PageDocumentation

stored in MySQL as timestamp

PageHistoryDocumentation — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\Model

This file provides property and method documentation for the model PageHistory.

$ PageHistoryDocumentation#page_id — Property in class PageHistoryDocumentation

PageLinkDocumentation — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\Model

This file provides property and method documentation for the model PageLink.

$ SmartWikiControllerDocumentation#page — Property in class SmartWikiControllerDocumentation

GroupsTemplateInit::process() — Method in class GroupsTemplateInit

process

Page — Class in namespace XELOS\Modules\SmartWiki\Model

Class XELOS\Modules\SmartWiki\Model\Page

$ Page#properties — Property in class Page

$ Page#pid — Property in class Page

$ Page#published_at — Property in class Page

PageHistory — Class in namespace XELOS\Modules\SmartWiki\Model

Class PageHistory

$ PageHistory#properties — Property in class PageHistory

PageLink — Class in namespace XELOS\Modules\SmartWiki\Model

Class PageLink

$ PageLink#properties — Property in class PageLink

IndexPage::page_orphans() — Method in class IndexPage

diagnostic page to find orphan pages, which are pages that won't be displayed in the tree view but show on the alphabetical index page

TemplatesPage::page_overview() — Method in class TemplatesPage

TemplatesPage::page_edit() — Method in class TemplatesPage

SmartWikiController::parse_content_html() — Method in class SmartWikiController

SmartWikiController::parse_wiki_links() — Method in class SmartWikiController

SmartWikiController::parse_auto_toc() — Method in class SmartWikiController

SystemCron::process() — Method in class SystemCron

Page — Class in namespace XELOS\Modules\SmartWiki\UI

NotificationAction::process_cron() — Method in class NotificationAction

Trigger User Notifications for Wall

ActivityCollection::populateApiProperties() — Method in class ActivityCollection

Map internal collection information to fulfill the promised ParameterObject

EntryCollection::populateApiProperties() — Method in class EntryCollection

Map internal collection information to fulfill the promised ParameterObject

Page — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ EntryDocumentation#post_id — Property in class EntryDocumentation

$ EntryDocumentation#post_type — Property in class EntryDocumentation

$ SystemActionlogControllerDocumentation#page — Property in class SystemActionlogControllerDocumentation

$ CmsWallContentPortlet#portlet_title — Property in class CmsWallContentPortlet

PortletActionlogShowPortlet — Class in namespace XELOS\Modules\SystemActionlog\Hook\Portal

WallIndexEventDocumentIndexEvent::process_document_index() — Method in class WallIndexEventDocumentIndexEvent

Process Document Event

$ DocumentWallItem#properties — Property in class DocumentWallItem

$ Entry#properties — Property in class Entry

$ Entry#permit_system_notification — Property in class Entry

FeedPage::page_overview() — Method in class FeedPage

HistoryPage::page_overview() — Method in class HistoryPage

OverviewPage::page_overview() — Method in class OverviewPage

SettingsPage::page_overview() — Method in class SettingsPage

WallPage::page_overview() — Method in class WallPage

Page Overview

SystemCron::process() — Method in class SystemCron

SystemCron::process_cleanup() — Method in class SystemCron

SystemCron::process_activity_calculator() — Method in class SystemCron

SystemCron::process_wall_cleanup() — Method in class SystemCron

$ Main#page — Property in class Main

DaemonHelperTrait::processDocumentIndexByHooks() — Method in class DaemonHelperTrait

Loads all index hooks and executes them to process the document index.

DocumentIndexDaemonLegacy::prepare() — Method in class DocumentIndexDaemonLegacy

Initializes the index process.

DocumentIndexDaemonLegacy::process() — Method in class DocumentIndexDaemonLegacy

Starts the document index process.

DocumentIndexDaemonLegacy::processMaintenance() — Method in class DocumentIndexDaemonLegacy

Run various Maintenance Tasks

DocumentIndexDaemonLegacy::processIndex() — Method in class DocumentIndexDaemonLegacy

This step performs sorting for deletion and update on queued document indexes and jobs as preparation for the actual indexing.

DocumentIndexDaemonLegacy::processCluster() — Method in class DocumentIndexDaemonLegacy

Populate Cluster

DocumentIndexDaemonLegacy::processClusterEval() — Method in class DocumentIndexDaemonLegacy

Process Cluster Eval

DocumentIndexDaemonLegacy::processClusterEvalDocuments() — Method in class DocumentIndexDaemonLegacy

This method is the callback for a threaded process to evaluate document index policy cluster.

DocumentIndexDaemonLegacy::processHooks() — Method in class DocumentIndexDaemonLegacy

Process Hooks

DocumentIndexDaemonThreaded::prepare() — Method in class DocumentIndexDaemonThreaded

Initializes the index process.

DocumentIndexDaemonThreaded::process() — Method in class DocumentIndexDaemonThreaded

Main Daemon Process used to orchestrate all working threads Important: Must not contain any blocking operations

DocumentIndexDaemonThreaded::processThread() — Method in class DocumentIndexDaemonThreaded

Main Processing Function which is being called per Thread

DocumentIndexDaemonThreaded::processNextJob() — Method in class DocumentIndexDaemonThreaded

Processes a single job Fetches a single job and executes all relevant tasks. If finished it calls itself again until the jobs per thread limit is reached.

DocumentIndexDaemonThreaded::processMaintenance() — Method in class DocumentIndexDaemonThreaded

Run various Maintenance Tasks

SystemCron::process() — Method in class SystemCron

SystemCron::process_license_check() — Method in class SystemCron

SystemCron::process_instance_check() — Method in class SystemCron

SystemCron::process_install_worker() — Method in class SystemCron

SystemCron::process_create_backup() — Method in class SystemCron

SystemCron::process_log_cleanup() — Method in class SystemCron

Clean-UP of old LOG-Files and Log-Rotation

SystemCron::process_backup() — Method in class SystemCron

SystemCron::process_user_group_calc() — Method in class SystemCron

Calculate User Groups Associations

SystemCron::process_daemon_check() — Method in class SystemCron

Monitor Daemons (restart broken daemons)

SystemCron::process_file_cleanup() — Method in class SystemCron

SystemCron::process_follows_maintenance() — Method in class SystemCron

Cleanup of Follows and Calculation of Auto-Follows

SystemCron::process_foaf_refresh() — Method in class SystemCron

recalculates foaf connections of all users

SystemCron::process_orphan_cleanup() — Method in class SystemCron

deletes all orphaned items from db, e.g.

SystemCron::processHardDelete() — Method in class SystemCron

Delete softdeleted documents after system_maintenance_trash_ttl

SystemDaemon::process() — Method in class SystemDaemon

Process Loop

CategoryDocumentCollection::populateApiProperties() — Method in class CategoryDocumentCollection

Map internal collection information to fulfill the promised ParameterObject

DocumentCollection::populateApiProperties() — Method in class DocumentCollection

Map internal collection information to fulfill the promised ParameterObject

GroupsTemplateInit::process() — Method in class GroupsTemplateInit

PortletActionShowPortlet — Class in namespace XELOS\Modules\SystemDMS\Hook\Portal

Class XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_action_portlet

PortletFolderhierarchyShowPortlet — Class in namespace XELOS\Modules\SystemDMS\Hook\Portal

PortletFolderviewShowPortlet — Class in namespace XELOS\Modules\SystemDMS\Hook\Portal

Class XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_folderview_portlet

PortletNavigatorShowPortlet — Class in namespace XELOS\Modules\SystemDMS\Hook\Portal

Class XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_navigator_portlet

PortletReportShowPortlet — Class in namespace XELOS\Modules\SystemDMS\Hook\Portal

Portlet that allows creating report-like filters on the fly.

IndexEventDocumentIndexEvent::process_document_index() — Method in class IndexEventDocumentIndexEvent

WebdavService::path_to_id() — Method in class WebdavService

Path Traversal Function

WebdavService::path_to_document_index() — Method in class WebdavService

Convert path to document_index

SavePayloadAction::process() — Method in class SavePayloadAction

Process action save payload into DMS

PreviewJob — Class in namespace XELOS\Modules\SystemDMS\Infrastructure\Job

CategoryTabInterface::process() — Method in class CategoryTabInterface

$ Category#properties — Property in class Category

$ Document#properties — Property in class Document

Preview — Class in namespace XELOS\Modules\SystemDMS\Model

$ ZipImportJob#properties — Property in class ZipImportJob

CategoryPage::page_overview_new() — Method in class CategoryPage

Testing Stub to run new VUE components in proper context

CategoryPage::page_overview() — Method in class CategoryPage

Return a page with default view

CategoryPage::page_new() — Method in class CategoryPage

CategoryPage::page_delete() — Method in class CategoryPage

CategoryPage::page_edit() — Method in class CategoryPage

DocumentPage::page_unpack() — Method in class DocumentPage

Displays a modal page that can be used to select the target folder for a ZIP extract actions

DocumentPage::page_overview() — Method in class DocumentPage

Document Details

ImportCategoryPage::page_overview() — Method in class ImportCategoryPage

ImportCategoryPage::page_check() — Method in class ImportCategoryPage

This code is meant for helping in recovery or mass update operations The process is generic and you need to manually specify your operation code The code checked in should be "non functional" by design - please uncomment the required function

TemplatesPage::page_overview() — Method in class TemplatesPage

Displays a page listing all templates

TemplatesPage::page_edit_file() — Method in class TemplatesPage

TemplatesPage::page_edit() — Method in class TemplatesPage

TrashPage::page_overview() — Method in class TrashPage

Overview page

SystemCron::process() — Method in class SystemCron

Process Block Routing

SystemCron::process_maintenance() — Method in class SystemCron

Cleanup the trash folder

SystemCron::process_zip_import() — Method in class SystemCron

Process zip import.

Document::process() — Method in class Document

Declared in Classes

Document::process_sidebar() — Method in class Document

Process the sidebar of the document.

DocumentPage::process_xui() — Method in class DocumentPage

DocumentPanel::process_xui() — Method in class DocumentPanel

DocumentTablePanel::process_xui() — Method in class DocumentTablePanel

FilterPanel::process_xui() — Method in class FilterPanel

FolderTreePanel::process_xui() — Method in class FolderTreePanel

PortletFolderview — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_portlet_folderview

PreviewLoader — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_preview_loader

ReportSpecificationHelper::process_xui() — Method in class ReportSpecificationHelper

Process the component

ZipImportStatusBar::process_xui() — Method in class ZipImportStatusBar

$ Model#preview — Property in class Model

Page — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Ui#portlet_folderview — Property in class Ui

$ Ui#preview_loader — Property in class Ui

$ Main#page — Property in class Main

$ Category#pid — Property in class Category

Preview — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model report.

$ Preview#page_count — Property in class Preview

AdminSystemMailUserAdminConfig::process() — Method in class AdminSystemMailUserAdminConfig

UserSystemMailUserConfig::process() — Method in class UserSystemMailUserConfig

NotifyAction::process_email() — Method in class NotifyAction

Process Email from Notification

Page — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ChannelSettingDocumentation#priority — Property in class ChannelSettingDocumentation

$ UserSettingDocumentation#priority — Property in class UserSettingDocumentation

$ SystemNotificationControllerDocumentation#page — Property in class SystemNotificationControllerDocumentation

SettingsUserConfig::process() — Method in class SettingsUserConfig

NotifyPage::page_mark_read() — Method in class NotifyPage

SettingsPage::page_overview() — Method in class SettingsPage

SettingsPage::page_priority() — Method in class SettingsPage

SettingsPage::page_channels() — Method in class SettingsPage

Default Channel Settings

$ Model#push_subscription — Property in class Model

Model::push_subscription() — Method in class Model

Page — Class in namespace XELOS\Modules\SystemPwa\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

PushSubscriptionDocumentation — Class in namespace XELOS\Modules\SystemPwa\Docs\ClassGenerated\Model

This file provides property and method documentation for the model PushSubscription.

$ PushSubscriptionDocumentation#public_key: — Property in class PushSubscriptionDocumentation

stored in MySQL as varchar

$ SystemPwaControllerDocumentation#page — Property in class SystemPwaControllerDocumentation

PushNotificationChannel — Class in namespace XELOS\Modules\SystemPwa\Hook\Notification

Class PushNotificationHook

PushSubscription — Class in namespace XELOS\Modules\SystemPwa\Model

NotificationPage::page_overview() — Method in class NotificationPage

Handle Registration for Push Notifications, this could be opened in a modal?

ResPage::page_overview() — Method in class ResPage

ResPage::page_sw() — Method in class ResPage

Serve the serviceWorker.js with special header to apply the root scope

ResPage::page_manifest() — Method in class ResPage

Deliver a PWA Manifest

CronAction::processCollectors() — Method in class CronAction

Collect statistics from hooks

Page — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ EventDocumentation#param_1: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#param_2: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#param_3: — Property in class EventDocumentation

stored in MySQL as varchar

$ SystemStatsControllerDocumentation#page — Property in class SystemStatsControllerDocumentation

$ WhoisonlineShowPortlet#portlet_title — Property in class WhoisonlineShowPortlet

$ AggregateDimension#properties — Property in class AggregateDimension

OverviewPage::page_overview() — Method in class OverviewPage

SystemCron::process() — Method in class SystemCron

SystemCron::process_maintenance() — Method in class SystemCron

AggregationChart::process_xui() — Method in class AggregationChart

Initiates the aggregation level selector and fills the chart with data.

Page — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ SystemStatusControllerDocumentation#page — Property in class SystemStatusControllerDocumentation

$ Node#properties — Property in class Node

MinimalPage::page_overview() — Method in class MinimalPage

MinimalPage::page_run_checks() — Method in class MinimalPage

Accessor for URL /system_status/minimal/run_checks This allows to check a node without necessarily using a cron from a loadbalancer

MinimalPage::page_nodes() — Method in class MinimalPage

Accessor for Node Info to be used in monitoring software

SystemCron::process() — Method in class SystemCron

GlobalTaskCollection::populateDocumentStatistics() — Method in class GlobalTaskCollection

GlobalTaskCollection::populateAdditionalApiProperties() — Method in class GlobalTaskCollection

GlobalTaskListCollection::populateAdditionalApiProperties() — Method in class GlobalTaskListCollection

TaskCollection::populateListModelProperty() — Method in class TaskCollection

TaskCollection::populateAdditionalApiProperties() — Method in class TaskCollection

Populate Collection Models with optionList Attributes used in Kanban API

TaskListCollection::populateAdditionalApiProperties() — Method in class TaskListCollection

Populate Collection Models with optionList Attributes used in Kanban API

Page — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaskDocumentation#parent — Property in class TaskDocumentation

$ TaskDocumentation#priority: — Property in class TaskDocumentation

enum low|medium|high|auto

$ TaskDocumentation#personal_sort — Property in class TaskDocumentation

$ TaskDocumentation#personal_category_num — Property in class TaskDocumentation

$ SystemTasksControllerDocumentation#page — Property in class SystemTasksControllerDocumentation

$ ShowTasksShowPortlet#portlet_title — Property in class ShowTasksShowPortlet

$ Task#properties — Property in class Task

$ Task#parent — Property in class Task

$ Task#priority — Property in class Task

'low', 'medium', 'high'

$ Task#personal_sort — Property in class Task

$ Task#personal_category_num — Property in class Task

$ TaskList#properties — Property in class TaskList

AdminPage::page_overview() — Method in class AdminPage

MainPage::page_overview() — Method in class MainPage

MainPage::page_my_tasks() — Method in class MainPage

Simple wrapper to link my tasks in navigation

MainPage::page_repeat() — Method in class MainPage

Recurring Task Modal Endpoint

RecurringPage::page_overview() — Method in class RecurringPage

Show an overview of all recurring tasks

SystemCron::process() — Method in class SystemCron

CheckCallbackPage::page_overview() — Method in class CheckCallbackPage

Public page for checking and verifying the worker callbacks are working properly.

OverviewPage::page_overview() — Method in class OverviewPage

OverviewPage::page_callback_error_detail() — Method in class OverviewPage

$ Model#push_client — Property in class Model

Model::push_client() — Method in class Model

Page — Class in namespace XELOS\Modules\SystemXelosApp\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#page — Property in class Main

PushClient — Class in namespace XELOS\Modules\SystemXelosApp\Docs\ClassGenerated\Model

This file provides property and method documentation for the model push_client.

$ PushClient#pushid: — Property in class PushClient

stored in MySQL as varchar

Page — Class in namespace XELOS\Modules\Tagging\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaggingControllerDocumentation#page — Property in class TaggingControllerDocumentation

$ CloudShowPortlet#portlet_title — Property in class CloudShowPortlet

$ Tag#properties — Property in class Tag

AdminPage::page_overview() — Method in class AdminPage

AdminPage::page_new() — Method in class AdminPage

AdminPage::page_delete() — Method in class AdminPage

SuggestPage::page_overview() — Method in class SuggestPage

SystemCron::process() — Method in class SystemCron

SystemCron::process_cleanup() — Method in class SystemCron

FeedbackAction::processFeedbackJob() — Method in class FeedbackAction

TranslateAction::processTranslationJob() — Method in class TranslateAction

Processes the TranslationJob

Page — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TranslationJobDocumentation#priority: — Property in class TranslationJobDocumentation

stored in MySQL as tinyint

$ TranslationControllerDocumentation#page — Property in class TranslationControllerDocumentation

TranslationSettingsLanguageConfig::process() — Method in class TranslationSettingsLanguageConfig

TranslateProcessor::process_translation() — Method in class TranslateProcessor

Process translation

TranslateDocumentSearchPreprocessor::preProcessDocument() — Method in class TranslateDocumentSearchPreprocessor

Check for possible translations for the SearchIndexRecord. Create translation jobs, if there are translations missing

IndexEventDocumentIndexEvent::process_document_index() — Method in class IndexEventDocumentIndexEvent

AjaxtranslatePage::page_overview() — Method in class AjaxtranslatePage

FeedbackPage::page_overview() — Method in class FeedbackPage

The page to edit the improved translation

FormtranslatePage::page_overview() — Method in class FormtranslatePage

SettingsPage::page_overview() — Method in class SettingsPage

Set the auto translation of content to disabled(!). Auto translation is enabled, if no

SettingsPage::page_language() — Method in class SettingsPage

Page to set the disabled state to $setDisbaled for the specified $language

StatisticsPage::page_overview() — Method in class StatisticsPage

Shows statistics of the requested translations

TestPage::page_overview() — Method in class TestPage

TestPage::page_tokens() — Method in class TestPage

SystemDaemon::process() — Method in class SystemDaemon

Process Loop

TrendvoteCollection::populateApiProperties() — Method in class TrendvoteCollection

Map internal collection information to fulfill the promised ParameterObject

$ Main#page — Property in class Main

ScanAction::process() — Method in class ScanAction

Scans all folders and files in the XELOS root path.

Page — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ VirusScanControllerDocumentation#page — Property in class VirusScanControllerDocumentation

AdminPage::page_overview() — Method in class AdminPage

AdminPage::page_details() — Method in class AdminPage

SystemCron::process() — Method in class SystemCron

ModelMethod::processAttachmentProperties() — Method in class ModelMethod

Add / Remove attachments for model

ParameterObject — Class in namespace XELOS\Modules\Webservice\Hook\Base\Service

Helper class to define object for webservice methods (complex types).

OAuthClientHook::parseOpenIDConfigurationForDomain() — Method in class OAuthClientHook

Parse OpenID OpenIDConfiguration for OAuth Service Endpoints

OAuthClientHook::parseOpenIDConfigurationForURL() — Method in class OAuthClientHook

Parse OpenID OpenIDConfiguration for URL

OAuthClientHook::parseOpenIDConfiguration() — Method in class OAuthClientHook

Parse OpenID OpenIDConfiguration for OAuth Service Endpoints

OAuthClient::processOpenIDConfiguration() — Method in class OAuthClient

Use an OpenID Configuration to setup this OAuth client

OAuthClient::processAuthorizationCodeResponse() — Method in class OAuthClient

Process Authorization Code Grant

AuthorizePage::page_overview() — Method in class AuthorizePage

Wrapper for OAuth authentication flows which end on this public page XELOS is acting as OAuth server

AuthorizePage::page_revoke() — Method in class AuthorizePage

Endpoint for the revoke flow.

AuthorizePage::page_client() — Method in class AuthorizePage

Wrapper for OAuth authentication flows which end on this public page XELOS is acting as OAuth client (via oauth_client hook)

DocPage::page_overview() — Method in class DocPage

JsonPage::page_json_docs() — Method in class JsonPage

JSON Documentation based on SOAP Services

OAuthAccountsPage::page_overview() — Method in class OAuthAccountsPage

Overview table with accounts

OAuthAccountsPage::page_modal() — Method in class OAuthAccountsPage

SystemCron::process() — Method in class SystemCron

Process Block Routing

WebserviceController::page_wsdl() — Method in class WebserviceController

WebserviceController::page_invoke_service() — Method in class WebserviceController

Page — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CategoryDocumentation#pid — Property in class CategoryDocumentation

$ WidgetsControllerDocumentation#page — Property in class WidgetsControllerDocumentation

PortletWidgetsShowPortlet — Class in namespace XELOS\Modules\Widgets\Hook\Portal

Class PortletWidgetsShowPortlet

CategoriesPage::page_overview() — Method in class CategoriesPage

Page overview

OverviewPage::page_overview() — Method in class OverviewPage

SettingsPage::page_overview() — Method in class SettingsPage

Page overview

SettingsPage::page_edit() — Method in class SettingsPage

Page edit widget

SettingsPage::page_delete() — Method in class SettingsPage

Page delete widget todo this should be handled with a_action=delete

PayloadException — Class in namespace XELOS\Modules\Workflows\Exceptions

Class PayloadException

HeaderFieldsAction::process() — Method in class HeaderFieldsAction

$ ActionIntegrationTestBase#PROCESS_ID — Property in class ActionIntegrationTestBase

$ ActionIntegrationTestBase#process — Property in class ActionIntegrationTestBase

ActionIntegrationTestBase::performAction() — Method in class ActionIntegrationTestBase

Performs the workflow process like the daemon should with a new action on each run:

• Creates the action
• sets the config
• starts a workflow process and returns a new item
• sets the User with the ID 1 as the creator
• runs the daemon action.

ActionStartProcessIntegrationTest::processInfoProvider() — Method in class ActionStartProcessIntegrationTest

$ ExampleSurveyControllerDocumentation#page — Property in class ExampleSurveyControllerDocumentation

$ Model#participant — Property in class Model

Model::participant() — Method in class Model

Page — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

ParticipantDocumentation — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Participant.

Participant — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Model

AdminPage::page_overview() — Method in class AdminPage

By default the function page_overview is called, unless the CMD param is set http://www.example.com/module/page/CMD

OverviewPage::page_overview() — Method in class OverviewPage

Sub Page Overview will be called if no other route param is detected Route //overview/[overview]

OverviewPage::page_take() — Method in class OverviewPage

Take a survey

ReportPage::page_overview() — Method in class ReportPage

Q

$ DatabaseException#Query — Property in class DatabaseException

$ DatabaseException#QueryParams — Property in class DatabaseException

$ MySQLAdapter#query_count — Property in class MySQLAdapter

MySQLAdapter::query_with_params() — Method in class MySQLAdapter

Execute Query (Return Result Array/Count) with passing of parameters e.g. use "SELECT * FROM tbl WHERE id = :id" as query and pass the value for "id" as params array ['id'=>2] All passed values will be automatically escaped for security reasons

MySQLAdapter::query() — Method in class MySQLAdapter

Execute Query (Return Result Array/Count)

Query — Class in namespace XELOS\Framework\XF\DB\QueryBuilder

Date::query_timeserver() — Method in class Date

Query Time Server

QueueableJob — Class in namespace XELOS\Framework\XF\Lib\QueueableJob

Delayed Job

$ QueueableJob#queue — Property in class QueueableJob

QueueableJobBuilder — Class in namespace XELOS\Framework\XF\Lib\QueueableJob

Quota — Class in namespace XELOS\Framework\XF\Lib

Class Quota

DocumentIndex::queueExistingDocuments() — Method in class DocumentIndex

Create queue for existing documents for reindex.

Queue — Class in namespace XELOS\Framework\XF\System\Model

$ AmchartChart#quality — Property in class AmchartChart

Quality of the map: Low|High

Form::query() — Method in class Form

FroalaOption::quickInsertButtons() — Method in class FroalaOption

The buttons to display in quick insert.

FroalaOption::quickInsertEnabled() — Method in class FroalaOption

To enable quick insert functionality.

FroalaOption::quickInsertTags() — Method in class FroalaOption

The list of tags for which the quick insert button will appear when empty.

QRCode — Class in namespace XELOS\Framework\XF\UI

$ EventDocumentation#questions: — Property in class EventDocumentation

stored in MySQL as text

$ JobDocumentation#queue: — Property in class JobDocumentation

stored in MySQL as varchar

$ JobHistoryDocumentation#queue: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

$ SystemDaemon#queues — Property in class SystemDaemon

$ Workspace#quota_size — Property in class Workspace

QueryBuilder — Class in namespace XELOS\Modules\Search\Adapter\ElasticSearch

$ SearchagentDocumentation#query: — Property in class SearchagentDocumentation

stored in MySQL as text

$ SystemDMSController#quota — Property in class SystemDMSController

NotificationChannel::queueNotification() — Method in class NotificationChannel

Add notification for processing

NotificationChannelInterface::queueNotification() — Method in class NotificationChannelInterface

$ SendNotificationJob#queue — Property in class SendNotificationJob

$ Trendvote#question: — Property in class Trendvote

stored in MySQL as varchar

$ Trendvote#question — Property in class Trendvote

$ AnswerDocumentation#question_id: — Property in class AnswerDocumentation

stored in MySQL as varchar

$ SurveyDocumentation#question: — Property in class SurveyDocumentation

stored in MySQL as text

R

Autoloader::register() — Method in class Autoloader

Register Required Autoloaders

Autoloader::register_composer_loader() — Method in class Autoloader

Register COMPOSER Autoloader

RadiusAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ RadiusAuthentication#result — Property in class RadiusAuthentication

RemembermeAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

Class RemembermeAuthentication

$ UserDetails#remove_groups — Property in class UserDetails

CommandSet::runCommand() — Method in class CommandSet

CommandSet::registerCommandDefinition() — Method in class CommandSet

Registers the command definition by creating a new instance, saves as internal property and return it for further definition.

CommandSet::requireXF() — Method in class CommandSet

Build::runBuildClassmap() — Method in class Build

Build::runBuildApidocs() — Method in class Build

Creates the API Docs

Build::runBuildMkdocs() — Method in class Build

Bundles all docs from all modules into one mkdocs document

Cache::runCacheClear() — Method in class Cache

Check::runCheckFilestatus() — Method in class Check

Check::runCheckDatabase() — Method in class Check

Composer::runComposerUpdate() — Method in class Composer

Run Composer Update

Composer::runComposerRepair() — Method in class Composer

Repair Composer

Config::runConfigCustomSet() — Method in class Config

Config::runConfigInstanceSet() — Method in class Config

Config::runConfigCustomUnset() — Method in class Config

Config::runConfigGlobalSet() — Method in class Config

Config::runConfigEnvUpdate() — Method in class Config

Cron::runCronRun() — Method in class Cron

Runs the specified CRON in foreground

Cron::runCronList() — Method in class Cron

Lists all available cron jobs

Daemon::runDaemonRun() — Method in class Daemon

Daemon::runDaemonList() — Method in class Daemon

Lists all available cron jobs

Debug::runDebugOn() — Method in class Debug

Debug::runDebugOff() — Method in class Debug

Debug::runDebugToggle() — Method in class Debug

Docker::runDockerWaitfordb() — Method in class Docker

Docker::runDockerWaitForStartup() — Method in class Docker

Waits until nginx is reachable which means that the local startup procedure has finished

Help::runHelp() — Method in class Help

Prints a list of arguments and options for given command.

I18n::runI18nTokenMigrate() — Method in class I18n

Example:this.is.my.token@@Text

I18n::runI18nTokenCheck() — Method in class I18n

Checks the source for missing translations

I18n::runI18nTokenCompile() — Method in class I18n

Compiles all po Files of the system

I18n::runI18nTokenDownload() — Method in class I18n

I18n::runI18nTokenUpdate() — Method in class I18n

Updates the local token database from the sourcecode

Info::runInfo() — Method in class Info

Install::runInstallLicenseSet() — Method in class Install

Update License / Connect Token

Install::runInstall() — Method in class Install

Install::run_post_install() — Method in class Install

Runs various cleanups after XELOS has been installed On the VM this is called on the first end user boot

Maintenance::runMaintenanceOn() — Method in class Maintenance

Maintenance::runMaintenanceOff() — Method in class Maintenance

Preview::runPreviewRegenerate() — Method in class Preview

Repair — Class in namespace XELOS\Framework\Core\Console\Command

Class Repair

Repair::runRepairFilepermissions() — Method in class Repair

Repair::runRepairThumbnails() — Method in class Repair

Seed::runSeedInit() — Method in class Seed

Seed::runSeedInstance() — Method in class Seed

Shell::runShell() — Method in class Shell

Snapshot::runSnapshotList() — Method in class Snapshot

Snapshot::runSnapshotTake() — Method in class Snapshot

Snapshot::runSnapshotRestore() — Method in class Snapshot

Test::runTest() — Method in class Test

Test::runTestAll() — Method in class Test

Test::runTestCode() — Method in class Test

Test::runTestPerformance() — Method in class Test

Test::runTestUnit() — Method in class Test

Test::runTestIntegration() — Method in class Test

Test::runTestAcceptance() — Method in class Test

Test::runTestInit() — Method in class Test

Test::runTestBuild() — Method in class Test

Test::runTestYaml() — Method in class Test

Theme::runThemeCompile() — Method in class Theme

Uninstall::runUninstall() — Method in class Uninstall

Update::runUpdate() — Method in class Update

Update::runUpdateBranch() — Method in class Update

Update::runUpdateRevision() — Method in class Update

Update::runUpdateAbort() — Method in class Update

User::runUserList() — Method in class User

List/Search a user record Example php xf user:list admin

User::runUserPasswordSet() — Method in class User

User::runUserPasswordReset() — Method in class User

User::runUserStatusEnable() — Method in class User

User::runUserStatusDisable() — Method in class User

Console::run() — Method in class Console

Runs the console application.

Console::runCommand() — Method in class Console

Runs a command defined by input.

Console::runPreBoot() — Method in class Console

Core::render() — Method in class Core

Render Module Output, this will get the template of the default page and render the template

Core::resolve_dep_link() — Method in class Core

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

Core::resolve_doc_link() — Method in class Core

Return the URL info of the page representing your document

Core::resolveDocumentIndexPermaURL() — Method in class Core

Resolve URL like https://local.xelos-project.net/_doc/goto/FCF68648-A8CE-4362-9901-1CEA704515D6

Core::retrieve_document() — Method in class Core

Returns the xfs_document in the storage DMS to a ID.

RepoConnectionException — Class in namespace XELOS\Framework\Core\Exception

XELOS Repository Exception Thrown when the repository service connection failed.

$ Template#render_stage — Property in class Template

$ Template#render_stage_key — Property in class Template

$ Template#render_stage_block — Property in class Template

$ Template#render_stage_ttl — Property in class Template

$ Template#render_stage_force_render — Property in class Template

$ Template#render_mode — Property in class Template

$ Template#render_mode_block — Property in class Template

Template::register_xtag_parser() — Method in class Template

Register custom xtag parser

Template::render_meta_script_resources() — Method in class Template

Render Meta Script Resources

Template::render_meta_style_resources() — Method in class Template

Render CSS Resources

Template::render_action() — Method in class Template

Render Action Function on Template if exists

Template::render_prepare() — Method in class Template

Pre-Render Templates

Template::render_html() — Method in class Template

Template::removeRenderer() — Method in class Template

Remove a block which in turn will not be rendered

Template::render_array_block() — Method in class Template

Template::retrieve() — Method in class Template

Template::render_is_prepared() — Method in class Template

Check wether a render stage is already cached or not This allows controllers to save on processing time if certain fields are calculated for the template only You need to call this function AFTER getting a view

Template::render_xtag_element() — Method in class Template

Renders the passed XML Element to String and uses registered xTag Controllers if possible

Template::render_xtag() — Method in class Template

xTag Controller, regisitered for namespace xt (xelos template)

Template::render_content_marker() — Method in class Template

Template::render() — Method in class Template

Template::render_error() — Method in class Template

Template::render_system_flash_message() — Method in class Template

put your comment there.

Template::render_login() — Method in class Template

wrapper for beeing able to use the output_login_form as renderer

Template::renderMultiFactorAuthenticationForm() — Method in class Template

$ ObjectManager#registry — Property in class ObjectManager

The instantiation of a requested object can be processed only if the class of the object is registered with the class name as key and its information as array in this property. The element should have at least the class name or the relative path to "class" folder.

VarsTemplate::render() — Method in class VarsTemplate

Render Vars Template

VarsTemplate::replace_namespace() — Method in class VarsTemplate

VarsTemplate::replace_namespace_reverse() — Method in class VarsTemplate

ModulePortlet::render() — Method in class ModulePortlet

ModulePortlet::restoreReferences() — Method in class ModulePortlet

Copies the read references from the live page to the staging page and re-creates owner references for the staging page.

InstallEvents::revisionToXelosVersion() — Method in class InstallEvents

Return XELOS version for the supplied build number in PHP style notation e.g. 7.1.5 for use with version_compare()

$ DocumentModel#rights_context — Property in class DocumentModel

A document that can be used for accessing this document. Their must either be a reference between the rights_context and the document or the can_read of the document must actually evalute the rights context.

DocumentModel::remove_document_index() — Method in class DocumentModel

removes index-entry of this model (only marking to delete).

DocumentModel::remove_from_db() — Method in class DocumentModel

DocumentModel::resetRightsCache() — Method in class DocumentModel

DocumentModel::resolve_rights_context() — Method in class DocumentModel

Loads the rights context by checking all possible rights context and return it without apply on this model.

DocumentModel::render() — Method in class DocumentModel

Generic Renderer

SoftDeleteInterface::restore() — Method in class SoftDeleteInterface

$ Model#render_type — Property in class Model

$ Model#render_params — Property in class Model

Parameters that will be consigned to the XUI helper

Model::reload_schema() — Method in class Model

Reloads the schema of the model

Model::remove_from_db() — Method in class Model

Model::render() — Method in class Model

Generic Renderer

ModelCollection::require_loading() — Method in class ModelCollection

If the collection is not loaded yet the collection will use all() to be filled

ModelCollection::reverse() — Method in class ModelCollection

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

ModelCollection::reset() — Method in class ModelCollection

Resets the loaded collection by clearing all loaded models and marking the collection as not being loaded.

ScopesTrait::registerDefaultScope() — Method in class ScopesTrait

Registers the passed scope as default scope A default scope is present when the model is being loaded and can be removed using the unscope() function if required The passed scope must be defined in a scope[SCOPE_NAME] function e.g. scopeGroupId

ScopesTrait::resetScopeQuery() — Method in class ScopesTrait

Reset Scope to null

SoftDeleteTrait::restore() — Method in class SoftDeleteTrait

Recover soft deleted item

SystemCron::reschedule_cron() — Method in class SystemCron

This will re-run the cron, optionally with a given scheduled time

$ SystemDaemon#requestCacheClearingTime — Property in class SystemDaemon

SystemDaemon::restart_all() — Method in class SystemDaemon

Restart all Daemons

SystemDaemon::registerSignalHandler() — Method in class SystemDaemon

Document::render() — Method in class Document

Document::render_title_only() — Method in class Document

Render Title Only

Document::render_title_description_image() — Method in class Document

Render Title/Description/Image

Document::render_comment() — Method in class Document

Document::render_full_preview() — Method in class Document

Render full preview and return content as string This function will resolve all renderable objects

UIAjaxComponent::render_xui() — Method in class UIAjaxComponent

Actual rendering method - must be implemented by children.

UIAjaxComponent::render() — Method in class UIAjaxComponent

Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI

UIComponent::reset_marker_content() — Method in class UIComponent

restores original content of marker_content

UIComponent::render_xtag_element() — Method in class UIComponent

UIComponent::render() — Method in class UIComponent

Config::reload_user_specific_settings() — Method in class Config

reload only the settings different from user tot user

Config::reload_config() — Method in class Config

Config::reload_config_set() — Method in class Config

Config::register_dyn_config_order() — Method in class Config

register a several context->table pairs to be checked hierarchic for matching config settings in the same order as given in array

Config::register_dyn_variable() — Method in class Config

register a dynamic variable this is required for being able to generate generic form fields ()

MySQLAdapter::rquery() — Method in class MySQLAdapter

Execute Query (Return Ressource uses MYSQLI_USE_RESULT)

• no builtin Error Handling (ON PURPOSE)

MySQLAdapter::rclose() — Method in class MySQLAdapter

Free/Close Result Query (Use after rquery)

MySQLAdapter::replace_query_placeholder() — Method in class MySQLAdapter

Pass a query with placeholders and pass values for placeholders as keyed array. The function will replace all placeholder with their respective values from the array and escape them accordingly

MySQLAdapter::rollback() — Method in class MySQLAdapter

MySQLAdapter::removeSensitiveData() — Method in class MySQLAdapter

Helper to remove unwanted private and sensitive data from an SQL query

Query::removeSelectField() — Method in class Query

Removes a SELECT field from the query.

Query::resetSelectedFields() — Method in class Query

Reset Select Fields

Query::resetOrderBy() — Method in class Query

Resets orderBy condition of the Query

Query::resetLimit() — Method in class Query

Event::remove_listener() — Method in class Event

IM::resolve_instance_id() — Method in class IM

Resolve numeric instance_id to string representation or vice versa

IM::rename_instance() — Method in class IM

Renames the alphanumerical instance ID of an instance. Helper can only be renamed to the module name.

IM::reload() — Method in class IM

Resets the local cache and forces IM to reload instance data for the next call

$ Lib#request — Property in class Lib

Lib::render_xtag() — Method in class Lib

Used by Template System to publish certain functions to template usage

Ajax::response() — Method in class Ajax

Browser::removeCookie() — Method in class Browser

Remove a previously set cookie

Cache::remove() — Method in class Cache

Cache::remove_group() — Method in class Cache

APCUCacheHandler::remove() — Method in class APCUCacheHandler

APCUCacheHandler::remove_group() — Method in class APCUCacheHandler

CacheHandlerInterface::remove() — Method in class CacheHandlerInterface

CacheHandlerInterface::remove_group() — Method in class CacheHandlerInterface

MemcacheCacheHandler::remove() — Method in class MemcacheCacheHandler

MemcacheCacheHandler::remove_group() — Method in class MemcacheCacheHandler

RedisCacheHandler — Class in namespace XELOS\Framework\XF\Lib\Cache

Cache Handler to use REDIS as caching backend

RedisCacheHandler::remove() — Method in class RedisCacheHandler

RedisCacheHandler::remove_group() — Method in class RedisCacheHandler

RemoteFunctionMapper — Class in namespace XELOS\Framework\XF\Lib\Connect

Magic Helper to support ->connect->[lib]->[function] syntax

Debug::register_debug_function() — Method in class Debug

Register an additional debug function for this call. Use is_enabled() to check wether the function is enabled or not

Debug::resetSectionData() — Method in class Debug

Debug::runtime() — Method in class Debug

Measuring run time of: {$function} [of {$object}] is called {$runs} times with given {$params}.

File::rm() — Method in class File

File::rmdir() — Method in class File

File::rmdir_r() — Method in class File

File::rglob() — Method in class File

Returns all files for given path recursive. It is allowed to use glob pattern to restrict the result.

File::relativize_path() — Method in class File

File::rename() — Method in class File

File::replace_vars_in_file() — Method in class File

Replaces the passed vars in the given file The file must contain markers in the format {{VARNAME}} The engine currently supports DOCX and TXT formats for replacement

Foaf::remove_follow_user() — Method in class Foaf

Remove user as follower of an user

GroupSecurity::remove_global_group() — Method in class GroupSecurity

Remove security Group

GroupSecurity::remove_local_group() — Method in class GroupSecurity

Remove security Group

GroupSecurity::remove_groups() — Method in class GroupSecurity

Remove security Group

GroupSecurity::remove_follow_user() — Method in class GroupSecurity

Remove user as follower for this group

GroupSecurity::remove_group_member() — Method in class GroupSecurity

Remove Member from security Group

Import::remove_first_row() — Method in class Import

Removes the first row of an array and returns it.

Seeding::resetInstallation() — Method in class Seeding

Seeding::runSeedScript() — Method in class Seeding

Runs a Seed Script YML which contains a seeding plan The scripts must be available in the system's setup/seeds/ folder

Link::replace_link_vars() — Method in class Link

Link::replace_link_vars_cb() — Method in class Link

Callback used by replace_link_vars

Logger::reset() — Method in class Logger

Ends a log cycle and resets all handlers and processors to their initial state.

Modsetup::register_all_pages() — Method in class Modsetup

Modsetup::register_instance() — Method in class Modsetup

Modsetup::remove_language_marker() — Method in class Modsetup

Callback to remove language markers from passed text (e.g. +++....+++)

Modsetup::remove_instance_from_registry() — Method in class Modsetup

Modsetup::remove_instance_from_navigation() — Method in class Modsetup

Modsetup::remove_instance_from_pages() — Method in class Modsetup

Modsetup::remove_instance_from_config() — Method in class Modsetup

Modsetup::remove_instance_hook() — Method in class Modsetup

Modsetup::remove_document_registration() — Method in class Modsetup

Modsetup::remove_notification_registration() — Method in class Modsetup

Modsetup::remove_instance_datasource() — Method in class Modsetup

Modsetup::remove_instance_filesource() — Method in class Modsetup

Modsetup::remove_instance_daemon() — Method in class Modsetup

Modsetup::remove_instance_cron() — Method in class Modsetup

Modsetup::remove_instance_from_policy() — Method in class Modsetup

Modsetup::revisionToVersion() — Method in class Modsetup

Return XELOS version for the supplied build number in PHP style notation e.g. 7.1.5 for use with version_compare()

Navigation::rebuild_navigation_tree() — Method in class Navigation

rebuilds the navigation-tree and updates the left- and right- boundaries (see also: NestedSet SQL)

Notification::remove() — Method in class Notification

Remove an existing notification (by Instance ID and Token) for all users or specific users Using $this->mod->notify()

$ QueueableJob#retryDelay — Property in class QueueableJob

$ QueueableJob#referenceId — Property in class QueueableJob

$ QueueableJob#reScheduleDelay — Property in class QueueableJob

If not 0 the job will be re-scheduled after this delay

$ QueueableJob#reScheduledJobId — Property in class QueueableJob

QueueableJob::reSchedule() — Method in class QueueableJob

Reschedule the currently running task (can only be used in execute() function) The function will not reduce retry_count and could lead to a looped execution

Request — Class in namespace XELOS\Framework\XF\Lib

Handles all kind of stuff during one request

$ SecureEvalClass#return — Property in class SecureEvalClass

Access to all evaluated Variables in your script

NonpersistentSessionHandler::read() — Method in class NonpersistentSessionHandler

RedisSessionHandler — Class in namespace XELOS\Framework\XF\Lib\Session

A REDIS Session Session Adapter for XELOS To enable REDIS Session backend use the following config.custom options:

SqlSessionHandler::read() — Method in class SqlSessionHandler

Read the passed session and returns the stored data

Shell::restart_daemon_process() — Method in class Shell

Restarts the passed daemon

Shell::restart_all_daemons() — Method in class Shell

Restart all daemons

SqlNestedSet::rebuild_all() — Method in class SqlNestedSet

Rebuild all nested sets within the given Table by finding all root nodes

SqlNestedSet::rebuild_nested_set_tree() — Method in class SqlNestedSet

always rebuild the whole tree, beginning with the root-element

TyeDiff::render() — Method in class TyeDiff

System::resolveDocumentIndexPermaURL() — Method in class System

Resolve URL like https://local.xelos-project.net/_doc/goto/FCF68648-A8CE-4362-9901-1CEA704515D6

DocumentIndexCollection::require_loading() — Method in class DocumentIndexCollection

If the collection is not loaded yet the collection will use all() to be filled

DocumentIndexCollection::requireLoadingWithoutPreFetch() — Method in class DocumentIndexCollection

$ Model#recent_document — Property in class Model

FrontendBackgroundUpdateInterface::response() — Method in class FrontendBackgroundUpdateInterface

This method returns an array that contains information which will be processed on client side as json object. The optional first parameter can contain client side created data which can be used to process the request.

$ DocumentIndex#references — Property in class DocumentIndex

$ DocumentIndex#related_document — Property in class DocumentIndex

DocumentIndex::reset_related_document() — Method in class DocumentIndex

DocumentIndex::remove_follow_user() — Method in class DocumentIndex

Remove user as follower

DocumentIndex::removeReferences() — Method in class DocumentIndex

Remove given references, return the remaining references

DocumentIndex::remove_reference() — Method in class DocumentIndex

DocumentIndex::render() — Method in class DocumentIndex

Generic Renderer

DocumentIndex::renderPreview() — Method in class DocumentIndex

DocumentIndexJobQueue::requeueProcessingJobs() — Method in class DocumentIndexJobQueue

Requeue all jobs to initial process state and date.

DocumentIndexJobQueue::resetProcessingJobs() — Method in class DocumentIndexJobQueue

Resets all given jobs to initial process state.

DocumentIndexLock::releaseDocument() — Method in class DocumentIndexLock

$ DocumentIndexPolicyCluster#rights_context_id — Property in class DocumentIndexPolicyCluster

$ DocumentIndexReference#reference_index_id — Property in class DocumentIndexReference

$ DocumentIndexReference#reference_canonical — Property in class DocumentIndexReference

$ DocumentRegistry#reg_key — Property in class DocumentRegistry

$ Notification#read_at — Property in class Notification

RecentDocument — Class in namespace XELOS\Framework\XF\System\Model

User::remove_security_group() — Method in class User

User::render() — Method in class User

Generic Renderer

UI::reset() — Method in class UI

Resets all internal counters (e.g. DOM ID references)

UI::resetCacheSnapshot() — Method in class UI

Reset Snapshot to start "recording"

UI::restoreCacheSnaphot() — Method in class UI

Restore previously cached meta information about JS and CSS

AjaxContainer::render() — Method in class AjaxContainer

Render Container with Content

Amchart::render_xui() — Method in class Amchart

AmchartBar::rotate() — Method in class AmchartBar

Rotate the chart to horizontal

AmchartChart::render() — Method in class AmchartChart

Render Chart

Breadcrumb::render() — Method in class Breadcrumb

Browse::render_xui() — Method in class Browse

Render the actual browse content

Calendar::render() — Method in class Calendar

Callback::render() — Method in class Callback

Calls the method render_callback of an instance The interface CallbackRendererInterface has to be implemented by the module's main class.

Carousel::render_xui() — Method in class Carousel

Render XUI

Container::render_xui() — Method in class Container

Country::render() — Method in class Country

Render XUI Object

Css::render() — Method in class Css

Render XUI Object

Doclink::render() — Method in class Doclink

Render and Return a Doclink Detail Link

Doclink::render_ajax_link() — Method in class Doclink

Render Single Action

Doclink::render_singleaction() — Method in class Doclink

Render Single Action

Doclink::render_widget() — Method in class Doclink

Render Doclink Widget

DocumentList::render() — Method in class DocumentList

Render XUI Object

DocumentLock::render_xui() — Method in class DocumentLock

Rendering method for this xui component.

DocumentView::render() — Method in class DocumentView

Render Main Content

Faceted::render() — Method in class Faceted

Render XUI Object

FacetedFilter::render_xui() — Method in class FacetedFilter

Render XUI Object

FacetedLegacy::render_xui() — Method in class FacetedLegacy

Render XUI Object

$ Form#relatedi18nFields — Property in class Form

Form::redirect_back() — Method in class Form

Redirect Back (Uses previous page in form if available)

Form::reset() — Method in class Form

Form::render() — Method in class Form

Form::render_field() — Method in class Form

Returns the rendered field as defined by the parameters

Form::render_form() — Method in class Form

FormEditor::render() — Method in class FormEditor

FormColor::render() — Method in class FormColor

$ FormComponent#REQUEST_VARS — Property in class FormComponent

FormComponent::render() — Method in class FormComponent

FormDocument::renderThumb() — Method in class FormDocument

Returns the THUMB HTML. The iconClass is the fallback if no thumbURL is provided

FormDocument::render_selected_documents() — Method in class FormDocument

Generates a list of selection items, as provided in the argument

FormFieldset::render() — Method in class FormFieldset

FormFieldsetClose::render() — Method in class FormFieldsetClose

$ FormRowRenderer#render_position — Property in class FormRowRenderer

FormRowRenderer::render() — Method in class FormRowRenderer

Generate row HTML and return as string

FormRowRendererMultifieldRow::render() — Method in class FormRowRendererMultifieldRow

Generate row HTML and return as string

$ FormRowRendererMultirowTable#rows — Property in class FormRowRendererMultirowTable

FormRowRendererMultirowTable::render() — Method in class FormRowRendererMultirowTable

FroalaOption::readonly() — Method in class FroalaOption

FroalaOption::requestHeaders() — Method in class FroalaOption

An Object with additional header key/value pairs to send along with requests using the XMLHttpRequest transport.

FroalaOption::requestWithCredentials() — Method in class FroalaOption

A that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. For more information refer to <a rel="nofollow" target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials" title="XMLHttpRequest.withCredentials">XMLHttpRequest.withCredentials.

FroalaOption::requestWithCORS() — Method in class FroalaOption

Make AJAX requests using CORS. For more information refer to <a rel="nofollow" target="_blank" href="http://en.wikipedia.org/wiki/Cross-origin_resource_sharing" title="Cross-origin Resource Sharing">Cross-origin resource sharing.

Option::renderIconHtml() — Method in class Option

HtmlGeneric::render() — Method in class HtmlGeneric

Render XUI Object

$ HtmlTree#root — Property in class HtmlTree

HtmlTree::render() — Method in class HtmlTree

HtmlUlList::render() — Method in class HtmlUlList

Image::render() — Method in class Image

Render XUI Object

ImageEdit::render_xui() — Method in class ImageEdit

Actual rendering method - must be implemented by children.

Import::render() — Method in class Import

InlineEditor::render() — Method in class InlineEditor

Render XUI Object

Instance::render() — Method in class Instance

CallbackRendererInterface::render_callback() — Method in class CallbackRendererInterface

Called by xui:callback

ItemList::render_xui() — Method in class ItemList

Actual rendering method - must be implemented by children.

JavaScript::render() — Method in class JavaScript

Render XUI Object

$ Link#render_mode — Property in class Link

Link::render() — Method in class Link

Render XUI Object

MenuList::renderForCodeception() — Method in class MenuList

$ Math#round — Property in class Math

Math::render() — Method in class Math

Paging::render_xui() — Method in class Paging

Portlet::render() — Method in class Portlet

ProgressBar::render() — Method in class ProgressBar

QRCode::render() — Method in class QRCode

Render XUI Object

Reactions — Class in namespace XELOS\Framework\XF\UI

Reactions::render() — Method in class Reactions

Render XUI Object

$ Table#rows — Property in class Table

$ Table#rows_total — Property in class Table

Table::render() — Method in class Table

TableEditor::render() — Method in class TableEditor

Tabs::render() — Method in class Tabs

$ TimeLine#rows — Property in class TimeLine

TimeLine::render() — Method in class TimeLine

Translation::render() — Method in class Translation

Renders the xui:translation tag

Tree::render_as_ul_list() — Method in class Tree

Render Tree as UL List

Tree::render() — Method in class Tree

UserImage::render() — Method in class UserImage

UserLink::render() — Method in class UserLink

Returns all userlink templates rendered with user information.

VCard::render_xui() — Method in class VCard

VideoPlayer::render_xui() — Method in class VideoPlayer

Actual rendering method - must be implemented by children.

ViewModeSwitcher::render_xui() — Method in class ViewModeSwitcher

Render the xui component, adding each available viewmode as an option

Wizard::remove_control() — Method in class Wizard

put your comment there.

Wizard::remove_data() — Method in class Wizard

Wizard::render_xui() — Method in class Wizard

Render the Wizard template and assign marker to template. If the wizard has the step control, a control form will be assigned to template, in other case the callback method is responsible for step controlling.

User::refresh() — Method in class User

User::resolve_group_id() — Method in class User

Returns the numeric id for the passed group short id (verbose group id)

User::reload() — Method in class User

this function will reload all user-relevant data e.g. very important, if this user has joined a certain rights-group and needs to obtain this group's rights without re-login

View::redirect() — Method in class View

Redirect user to the passed URL

View::redirectJS() — Method in class View

Redirect with JS output

View::redirect_404() — Method in class View

Show 404 Error Page

View::redirect_back() — Method in class View

View::redirect_to_login() — Method in class View

View::redirect_with_delay() — Method in class View

Redirects the user to the passed URL after the passed delay. Shows a loader and the passed message.

AdSyncController::rebuildDirectoryCache() — Method in class AdSyncController

Rebuilds the AD Cache Tables

UserAccountUserConfig::render() — Method in class UserAccountUserConfig

UserAdvancedUserAdminConfig::render() — Method in class UserAdvancedUserAdminConfig

UserAuditLogUserAdminConfig::render() — Method in class UserAuditLogUserAdminConfig

UserDevicesUserConfig::render() — Method in class UserDevicesUserConfig

UserGroupsUserAdminConfig::render() — Method in class UserGroupsUserAdminConfig

Return Content for Settings Tab

UserLanguageUserConfig::render() — Method in class UserLanguageUserConfig

UserPolicyUserAdminConfig::render() — Method in class UserPolicyUserAdminConfig

UserSecurityUserConfig::render() — Method in class UserSecurityUserConfig

UserAdminConfigInterface::render() — Method in class UserAdminConfigInterface

Return Content for Settings Tab

Badge::render() — Method in class Badge

UserList::render_xui() — Method in class UserList

$ Model#reminder — Property in class Model

$ Model#reminder_queue — Property in class Model

Model::reminder() — Method in class Model

Model::reminder_queue() — Method in class Model

$ Event#rrule: — Property in class Event

stored in MySQL as text

$ Event#remote_uid: — Property in class Event

stored in MySQL as varchar

$ Participant#response: — Property in class Participant

stored in MySQL as text

$ Participant#responded_at: — Property in class Participant

stored in MySQL as timestamp

Reminder — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model reminder.

$ Reminder#rrule: — Property in class Reminder

stored in MySQL as text

ReminderQueue — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model reminder_queue.

CommentsController::remove_comments() — Method in class CommentsController

CommentsController::resolveDocumentIndexPermaURL() — Method in class CommentsController

Resolve URL like https://local.xelos-project.net/_doc/goto/FCF68648-A8CE-4362-9901-1CEA704515D6

Comment::removeAttachments() — Method in class Comment

Remove attachment and remove reference

Comment::render_comment() — Method in class Comment

DocumentPageSidebar::render_xui() — Method in class DocumentPageSidebar

ReportSpecificationHelper — Class in namespace XELOS\Modules\DMS\UI

RegistrationAction — Class in namespace XELOS\Modules\Eventplanner\Action

RegistrationAction::register_for_event() — Method in class RegistrationAction

put your comment there.

EventCollection::resetFilterStartEnd() — Method in class EventCollection

Remove existing conditions previously applied to start and end

$ Action#registration — Property in class Action

Action::registration() — Method in class Action

$ Model#related_events — Property in class Model

Model::related_events() — Method in class Model

$ EventDocumentation#require_review: — Property in class EventDocumentation

stored in MySQL as tinyint

$ EventDocumentation#review_subject: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#review_description: — Property in class EventDocumentation

stored in MySQL as text

$ InvitationReplyLogDocumentation#reply: — Property in class InvitationReplyLogDocumentation

stored in MySQL as varchar

$ ParticipantDocumentation#response_received: — Property in class ParticipantDocumentation

stored in MySQL as timestamp

RelatedEventsDocumentation — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\Model

This file provides property and method documentation for the model RelatedEvents.

EventplannerController::register_for_event() — Method in class EventplannerController

EventplannerController::resolve_doc_link() — Method in class EventplannerController

Return the URL info of the page representing your document

EventplannerController::register_invitee_for_event() — Method in class EventplannerController

EventplannerController::resolve_dep_link() — Method in class EventplannerController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

CRMParticipationShowPortlet::render() — Method in class CRMParticipationShowPortlet

Event::renderHTMLEmail() — Method in class Event

Participant::replace_with_value() — Method in class Participant

RelatedEvents — Class in namespace XELOS\Modules\Eventplanner\Model

Created by PhpStorm.

RelatedEvents::remove_event() — Method in class RelatedEvents

Details::render_xui() — Method in class Details

$ CategoryDocumentation#right_id — Property in class CategoryDocumentation

$ PostDocumentation#reply_to_id — Property in class PostDocumentation

ForumController::resolve_doc_link() — Method in class ForumController

RecentShowPortlet — Class in namespace XELOS\Modules\Forum\Hook\Portal

Post::removeAttachments() — Method in class Post

Remove attachments and reference Stolen from Comment::removeAttachments()

Thread::removeAttachments() — Method in class Thread

Remove attachments and reference Stolen from Comment::removeAttachments()

VoteBox::render_value() — Method in class VoteBox

Set rendering to value only and return the rendered content by parent class.

VoteBox::render_xui() — Method in class VoteBox

GeoSelectorProcessor::reverseLookup() — Method in class GeoSelectorProcessor

Looks up the address by reverse processing the latitude and the longitude of the API endpoint.

MapLocation::render_xui() — Method in class MapLocation

Actual rendering method - must be implemented by children.

RecurringTaskCollection — Class in namespace XELOS\Modules\GroupsTasks\Collection

$ Page#recurring — Property in class Page

Page::recurring() — Method in class Page

$ TaskDocumentation#responsible — Property in class TaskDocumentation

RecurringTask — Class in namespace XELOS\Modules\GroupsTasks\Model

RecurringPage — Class in namespace XELOS\Modules\GroupsTasks\Page

Class Overview

Template::runTemplateReapply() — Method in class Template

$ Category#right_id — Property in class Category

$ Invitation#response_received: — Property in class Invitation

stored in MySQL as timestamp

$ Invitation#response_status: — Property in class Invitation

enum no response|accepted|denied|left group

$ Invitation#role_id — Property in class Invitation

$ Newsletter#recipient_cnt — Property in class Newsletter

$ FilesPortlet#requireMultiGroupContext — Property in class FilesPortlet

$ FilesPortlet#requireSingleGroupContext — Property in class FilesPortlet

$ GroupsPortlet#requireMultiGroupContext — Property in class GroupsPortlet

$ JobDocumentation#reference_id: — Property in class JobDocumentation

stored in MySQL as varchar

$ JobDocumentation#retry_count — Property in class JobDocumentation

$ JobHistoryDocumentation#reference_id: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

$ JobHistoryDocumentation#retry_count — Property in class JobHistoryDocumentation

JobQueueCheck::run_check() — Method in class JobQueueCheck

Run this Check and return Result

JobUIStatus::render() — Method in class JobUIStatus

XUI Render Function

PrivacyCentreUserConfig::render() — Method in class PrivacyCentreUserConfig

FormprocessorAction::replace_placeholders() — Method in class FormprocessorAction

Replace Placeholders in String

FormprocessorAction::replace_placeholders_cb() — Method in class FormprocessorAction

$ ListItemDocumentation#rights_check: — Property in class ListItemDocumentation

enum hidden|read_assigned|read_all|edit_assigned|edit_all

$ ListStatusDocumentation#rights_check: — Property in class ListStatusDocumentation

enum hidden|read_assigned|read_all|edit_assigned|edit_all

Field::replacePlaceholdersWithValues() — Method in class Field

Replaces the placeholders with the values of their fields.

Field::requiredValueFits() — Method in class Field

When list items will be created or updated through the webservice API, this gets interesting as this determines whether a field has predefined values (like select-, and checkbox-fields, as these contain 'pop_data[]').

AssignedUsers::replacePlaceholdersWithValues() — Method in class AssignedUsers

Replaces the placeholders with the values of their fields.

Checkbox::requiredValueFits() — Method in class Checkbox

Radio — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

ResourceField — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Asset::requiredValueFits() — Method in class Asset

Room — Class in namespace XELOS\Modules\Lists\Hook\Base\Field\Resource

Ticket::requiredValueFits() — Method in class Ticket

RowRendererMultifieldRow — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Select::requiredValueFits() — Method in class Select

Slider::requiredValueFits() — Method in class Slider

ReindexJob — Class in namespace XELOS\Modules\Lists\Infrastructure\Job

ListsController::resolve_doc_link() — Method in class ListsController

$ ListItem#rights_check — Property in class ListItem

enum hidden|read_assigned|read_all|edit_assigned|edit_all

$ ListItem#resource_status — Property in class ListItem

'free', 'booked'

$ ListItem#record_status — Property in class ListItem

Contains 3 status(es): 'record' for common list records, 'preset_active' for presets that are active and ready to use and 'preset_inactive' for presets that have been created once, but are not (temporarily) available for usage.

$ ListProperties#resources — Property in class ListProperties

Structure JSON encoded array of resource fields

$ ListProperties#rights_check — Property in class ListProperties

enum: hidden|read_assigned|read_all|edit_assigned|edit_all

ListProperties::runsWorkflowProcesses() — Method in class ListProperties

Is this list a workflow list and are there workflow items running, that depend on this list?

$ ListStatus#rights_check: — Property in class ListStatus

enum hidden|read_assigned|read_all|edit_assigned|edit_all

CategorySelector::render_xui() — Method in class CategorySelector

Actual rendering method - must be implemented by children.

ItemEditor::render_xui() — Method in class ItemEditor

Actual rendering method - must be implemented by children.

ItemList::render_xui() — Method in class ItemList

Actual rendering method - must be implemented by children.

ListPortlet::render_xui() — Method in class ListPortlet

Actual rendering method - must be implemented by children.

ProfileCollection::reverseStoredCondition() — Method in class ProfileCollection

To reverse the stored condition, the entire scope has to be reset in order to apply all conditions but the stored one, since there is no 'set all conditions at once' method.

$ Property#required: — Property in class Property

stored in MySQL as tinyint

$ Page#read — Property in class Page

Page::read() — Method in class Page

RSSShowPortlet — Class in namespace XELOS\Modules\News\Hook\Portal

RecentShowPortlet — Class in namespace XELOS\Modules\News\Hook\Portal

This portlet is Multi-Group Enabled, that means you can retrieve news from different-sub-groups to be displayed

NewsController::resolve_doc_link() — Method in class NewsController

NewsController::resolve_dep_link() — Method in class NewsController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

ReadPage — Class in namespace XELOS\Modules\News\Page

NewsCest::readArticle() — Method in class NewsCest

ArticleList::render_xui() — Method in class ArticleList

ViewArticleRead::render_xui() — Method in class ViewArticleRead

Actual rendering method - must be implemented by children.

ViewArticleWrite::render_xui() — Method in class ViewArticleWrite

Actual rendering method - must be implemented by children.

$ PageComponentDocumentation#ref_key: — Property in class PageComponentDocumentation

stored in MySQL as varchar

$ PageDocumentation#restricted_pid — Property in class PageDocumentation

JsonPathElement::remove() — Method in class JsonPathElement

JsonPathElement::replaceJsonObject() — Method in class JsonPathElement

Replace the full element

PageJsonMigrator::run() — Method in class PageJsonMigrator

Runs all migrations if necessary and saves the passed page version if changes have been made.

$ Page#restricted_pid — Property in class Page

Page::removePermissions() — Method in class Page

Remove permissions of this page and its children

PageVersion::replaceAttachmentsFromFilesystem() — Method in class PageVersion

Replaces all files based on the replacement array adding the passed attachments

PagesController::resolveDocumentIndexPermaURL() — Method in class PagesController

Resolve URL like https://local.xelos-project.net/_doc/goto/FCF68648-A8CE-4362-9901-1CEA704515D6

PagesController::resolve_dep_link() — Method in class PagesController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

PageRenderer::render() — Method in class PageRenderer

RecentPage — Class in namespace XELOS\Modules\PersonalWorkspace\Page

Class Recent

PersonalWorkspaceController::resolve_dep_link() — Method in class PersonalWorkspaceController

ReadConfirmationControllerDocumentation — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

ReadConfirmationNavigation — Class in namespace XELOS\Modules\ReadConfirmation\Hook\Dashboard

AdminProcessor::request_confirmation() — Method in class AdminProcessor

ReadConfirmationShowPortlet — Class in namespace XELOS\Modules\ReadConfirmation\Hook\Portal

ReadConfirmationController — Class in namespace XELOS\Modules\ReadConfirmation

Report — Class in namespace XELOS\Modules\ReadConfirmation\UI

Report UI to see who confirmed a document and who did not with actions to remind users

Report::render_xui() — Method in class Report

IndexerAction::removeFromIndex() — Method in class IndexerAction

Removed the passed Document from the search index

$ ElasticSearchAdapter#recommendedESVersion — Property in class ElasticSearchAdapter

What is the expected/recommended elasticsearch version for this code?

ElasticSearchAdapter::removeFromIndex() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::restoreSnapshot() — Method in class ElasticSearchAdapter

Restore a Snapshot, this function is not

QueryBuilder::resetQuery() — Method in class QueryBuilder

$ SearchagentDocumentation#result_count — Property in class SearchagentDocumentation

SearchCheck::run_check() — Method in class SearchCheck

Run this Check and return Result

SearchAdapterInterface::removeFromIndex() — Method in class SearchAdapterInterface

SearchController::remove_document() — Method in class SearchController

$ SearchIndexRecord#relatedPostId — Property in class SearchIndexRecord

$ SearchIndexRecord#removeFromIndex — Property in class SearchIndexRecord

ResultPanel — Class in namespace XELOS\Modules\Search\UI

Search Results XUI Panel

ResultPanel::render_xui() — Method in class ResultPanel

SearchIntegrationResultPanel::render_xui() — Method in class SearchIntegrationResultPanel

Renders the result panel without additional options like the advanced search and the faceted search.

$ BrowserFile#revision — Property in class BrowserFile

$ Page#recent_version — Property in class Page

Page::revertToVersion() — Method in class Page

Load version from history archive

SmartWikiController::resolve_doc_link() — Method in class SmartWikiController

SmartWikiController::resolve_dep_link() — Method in class SmartWikiController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

ViewWikiRead::render_xui() — Method in class ViewWikiRead

Actual rendering method - must be implemented by children.

ViewWikiWrite::render_xui() — Method in class ViewWikiWrite

ActivityCollection::require_loading() — Method in class ActivityCollection

Overriding standard model loading to use join query

$ DocumentWallItemDocumentation#rights_context_id — Property in class DocumentWallItemDocumentation

SystemActionlogController::resolve_dep_link() — Method in class SystemActionlogController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

$ BackupQueue#restore_file: — Property in class BackupQueue

stored in MySQL as varchar

CrmPortletShowTab::render() — Method in class CrmPortletShowTab

Show the Frontend Output of this Portlet

WebdavService::read() — Method in class WebdavService

Read File / Folder

ApiService::readDocumentInfo() — Method in class ApiService

Read information about a file attachment (dms document)

ApiService::readFileUploadStatus() — Method in class ApiService

ApiService::readCategoryDocumentCollection() — Method in class ApiService

ApiService::readDocumentIndexCollectionSetup() — Method in class ApiService

CategoryTabInterface::render() — Method in class CategoryTabInterface

$ Category#rights_context_categories — Property in class Category

Category::refresh_policy_info() — Method in class Category

Checks the policies of the current folder and saves the information as bit in has_policy property

Category::resolve_link() — Method in class Category

Resolve the link of a category Return the category itself if it isn't a link

Category::resolve_category_id() — Method in class Category

Resolves the category id, taking into consideration potential rights context prefixes.

$ Document#reference_document_index — Property in class Document

$ Document#reference_document — Property in class Document

$ Document#reference_object — Property in class Document

Document::render() — Method in class Document

Document::rename() — Method in class Document

Rename Filename Do not currently update the file_path

Document::resolve_document_id() — Method in class Document

Resolve Combined IDs to a single document

SystemDMSController::resolve_doc_link() — Method in class SystemDMSController

Needed for Index Search

SystemDMSController::resolve_dep_link() — Method in class SystemDMSController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

SystemDMSController::resolveGroupId() — Method in class SystemDMSController

Resolve group ID

DocumentGalleryPanel::render_xui() — Method in class DocumentGalleryPanel

DocumentPage::render_xui() — Method in class DocumentPage

DocumentPageSidebar::render_xui() — Method in class DocumentPageSidebar

DocumentPageViews::render_xui() — Method in class DocumentPageViews

DocumentPanel::render_xui() — Method in class DocumentPanel

DocumentTablePanel::render_xui() — Method in class DocumentTablePanel

FilterPanel::render_xui() — Method in class FilterPanel

FolderTreePanel::render_xui() — Method in class FolderTreePanel

PortletFolderview::render_xui() — Method in class PortletFolderview

PreviewLoader::render_xui() — Method in class PreviewLoader

ReportSpecificationHelper — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_report_specification__helper

ReportSpecificationHelper::render_xui() — Method in class ReportSpecificationHelper

Render the component: this will be all fields of the form but not the form header and footer

ViewDocumentDetails::render_xui() — Method in class ViewDocumentDetails

ViewDocumentLink::render_xui() — Method in class ViewDocumentLink

ViewDocumentRead::render_xui() — Method in class ViewDocumentRead

ViewDocumentTemplate::render_xui() — Method in class ViewDocumentTemplate

ViewDocumentWrite::render_xui() — Method in class ViewDocumentWrite

XfsDocument::render() — Method in class XfsDocument

Renders the document with an image/icon and document name.

ZipImportStatusBar::render_xui() — Method in class ZipImportStatusBar

Render the component

$ Ui#report_specification__helper — Property in class Ui

$ Category#reference_id — Property in class Category

$ Document#reference_id — Property in class Document

$ Preview#resolution — Property in class Preview

AdminSystemMailUserAdminConfig::render() — Method in class AdminSystemMailUserAdminConfig

UserSystemMailUserConfig::render() — Method in class UserSystemMailUserConfig

$ ChannelSettingDocumentation#registry_instance_id — Property in class ChannelSettingDocumentation

$ ChannelSettingDocumentation#registry_name — Property in class ChannelSettingDocumentation

SettingsUserConfig::render() — Method in class SettingsUserConfig

ActivityUpdateFrontendHook::response() — Method in class ActivityUpdateFrontendHook

This method returns an array that contains information which will be processed on client side as json object. The optional first parameter can contain client side created data which can be used to process the request.

UpdateFrontendHook::response() — Method in class UpdateFrontendHook

This method returns an array that contains information which will be processed on client side as json object. The optional first parameter can contain client side created data which can be used to process the request.

$ CreateNotificationJob#recipientIds — Property in class CreateNotificationJob

$ Page#res — Property in class Page

Page::res() — Method in class Page

ResPage — Class in namespace XELOS\Modules\SystemPwa\Page

Class Overview

AggregationChart::render_xui() — Method in class AggregationChart

Render this UI Chart

Check::run_check() — Method in class Check

Run this Check and return Result

Result — Class in namespace XELOS\Modules\SystemStatus\Hook\Base\Check

CacheCheck::run_check() — Method in class CacheCheck

Run this Check and return Result

ClamavCheck::run_check() — Method in class ClamavCheck

Run this Check and return Result

ConnectionCheck::run_check() — Method in class ConnectionCheck

Run this Check and return Result

CronCheck::run_check() — Method in class CronCheck

Checks if the CronJob system is working and if there are any CronJobs with errors

DaemonCheck::run_check() — Method in class DaemonCheck

Checks if all active daemons are working properly

DatabaseCheck::run_check() — Method in class DatabaseCheck

Run this Check and return Result

DiskCheck::run_check() — Method in class DiskCheck

Run this Check and return Result

DocumentIndexCheck::run_check() — Method in class DocumentIndexCheck

Run this Check and return Result

LicenseCheck::run_check() — Method in class LicenseCheck

Run this Check and return Result

RepoCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

Class RepoCheck

RepoCheck::run_check() — Method in class RepoCheck

Run this Check and return Result

TimeCheck::run_check() — Method in class TimeCheck

Run this Check and return Result

Check::run() — Method in class Check

Runs this check

SystemStatusController::run_all_checks() — Method in class SystemStatusController

Runs all available checks and stores the results in the database

SystemStatusController::run_check() — Method in class SystemStatusController

RecurringTaskCollection — Class in namespace XELOS\Modules\SystemTasks\Collection

$ Model#recurring_task — Property in class Model

Model::recurring_task() — Method in class Model

$ Page#recurring — Property in class Page

Page::recurring() — Method in class Page

RecurringTaskDocumentation — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated\Model

This file provides property and method documentation for the model RecurringTask.

$ RecurringTaskDocumentation#rrule: — Property in class RecurringTaskDocumentation

stored in MySQL as varchar

$ TaskDocumentation#responsible — Property in class TaskDocumentation

ContactlogShowSidebar::render() — Method in class ContactlogShowSidebar

RecurringTask — Class in namespace XELOS\Modules\SystemTasks\Model

$ Task#responsible — Property in class Task

Responsible User

Task::removeAttachments() — Method in class Task

Remove attachment and remove reference

TaskList::remove_from_user() — Method in class TaskList

RecurringPage — Class in namespace XELOS\Modules\SystemTasks\Page

Class Overview

SystemTasksController::resolve_doc_link() — Method in class SystemTasksController

Needed for Index Search

SystemTasksController::resolve_dep_link() — Method in class SystemTasksController

Resolve a Link for a local dependency (a - by returning a valid template or b - by sending a http-redirect)

LibreofficeCheck::run_check() — Method in class LibreofficeCheck

Run this Check and return Result

VideoCheck::run_check() — Method in class VideoCheck

Run this Check and return Result

Webservice::register() — Method in class Webservice

Register push client

TaggingController::remove_post() — Method in class TaggingController

Remove all Tags for a certain post

ApiCheck::run_check() — Method in class ApiCheck

Run this Check and return Result

TranslationInProgressFrontendHook::response() — Method in class TranslationInProgressFrontendHook

This method returns an array that contains information which will be processed on client side as json object. The optional first parameter can contain client side created data which can be used to process the request.

CommonOperationsTrait::resetContent() — Method in class CommonOperationsTrait

Resets/Emptys all content related to the translation

ResultCollection — Class in namespace XELOS\Modules\Trendvote\Collection

$ Model#result — Property in class Model

Model::result() — Method in class Model

Result — Class in namespace XELOS\Modules\Trendvote\Docs\ClassGenerated\Model

This file provides property and method documentation for the model result.

$ Trendvote#report_display — Property in class Trendvote

$ Trendvote#report_type: — Property in class Trendvote

enum CHART_PIE|LIST

Result — Class in namespace XELOS\Modules\Trendvote\Model

Class xmodel_trendvote_result

$ Trendvote#report_display — Property in class Trendvote

$ Trendvote#report_type — Property in class Trendvote

TrendvoteController::resolveDocumentIndexPermaURL() — Method in class TrendvoteController

Resolve URL like https://local.xelos-project.net/_doc/goto/FCF68648-A8CE-4362-9901-1CEA704515D6

$ ScanDocumentation#run_status: — Property in class ScanDocumentation

enum running|finished

VirusCheck::run_check() — Method in class VirusCheck

Run this Check and return Result

DigestAuthentication::removeDigestPasswordForUser() — Method in class DigestAuthentication

OAuthServerAction::revoke() — Method in class OAuthServerAction

Revokes a given token by deleting the corresponding OAuth Access model.

ParameterObject::removeMember() — Method in class ParameterObject

ParameterObject::removeFilter() — Method in class ParameterObject

OAuthClientCheck::run_check() — Method in class OAuthClientCheck

Run this Check and return Result

$ OAuthClient#redirectUrl — Property in class OAuthClient

The URL to which Auth will redirect the browser after authorization has been granted by the user.

$ OAuthClient#refreshToken — Property in class OAuthClient

Refresh tokens are issued to the client by the authorization server and are used to obtain a new access token when the current access token becomes invalid or expires

$ OAuthClient#resourceOwner — Property in class OAuthClient

OAuthClient::refreshAccessToken() — Method in class OAuthClient

Returns the access token or null if there is no token yet.

RestPage — Class in namespace XELOS\Modules\Webservice\Page

WebserviceController::register_service_hooks() — Method in class WebserviceController

Register all available modules to be displayed and processed

WebserviceController::register_service_hook() — Method in class WebserviceController

WidgetList::render_xui() — Method in class WidgetList

Actual rendering method - must be implemented by children.

$ Page#report_page — Property in class Page

Page::report_page() — Method in class Page

ReportPage — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Page

xelos page, is automatically called based on the page param: http://www.example.com/module/PAGE

S

Bootloader::setMode() — Method in class Bootloader

Sets the XF_MODE for the following boot sequence

NtlmAuthentication::save_ntlm_hash() — Method in class NtlmAuthentication

Save the NTLM Hashes for a later SSO

RemembermeAuthentication::set_cookie() — Method in class RemembermeAuthentication

Set Auth Cookie

SuperuserAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ UserDetails#status — Property in class UserDetails

$ UserDetails#settings — Property in class UserDetails

UserDetails::setUserIdentity() — Method in class UserDetails

UserDetails::setUserDisplayname() — Method in class UserDetails

UserDetails::setOptionalAttributes() — Method in class UserDetails

Optional Set/Update the following attributes for the user as effect of this login

UserDetails::setIsNotValidated() — Method in class UserDetails

Set true if user should reauthenticate against other methods to access sensitive data

UserDetails::setIsGuest() — Method in class UserDetails

User is considered a guest (anonymous access and no access to profile)

UserDetails::setGroups() — Method in class UserDetails

Set security groups the user should be a member of (this will NOT delete other groups)

UserDetails::setRevokeGroups() — Method in class UserDetails

Set security groups the user should NOT be a member of

UserDetails::setStatus() — Method in class UserDetails

Set current status of user

UserDetails::setOptionalConfigSettings() — Method in class UserDetails

Set User Config Settings as Key => Value pairs

UserDetails::setOptionalMetaSettings() — Method in class UserDetails

Set User Meta Settings as Key => Value pairs

UserDetails::setPictureURL() — Method in class UserDetails

CommandSet::setupCommandDefinitions() — Method in class CommandSet

Returns an array of CommandDefinitions which describe all available commands of this CommandSet

Build::setupCommandDefinitions() — Method in class Build

Cache::setupCommandDefinitions() — Method in class Cache

Check::setupCommandDefinitions() — Method in class Check

Composer::setupCommandDefinitions() — Method in class Composer

Config::setupCommandDefinitions() — Method in class Config

Config::set_custom_config_value() — Method in class Config

Cron::setupCommandDefinitions() — Method in class Cron

Daemon::setupCommandDefinitions() — Method in class Daemon

Debug::setupCommandDefinitions() — Method in class Debug

Docker::setupCommandDefinitions() — Method in class Docker

Help::setupCommandDefinitions() — Method in class Help

I18n::setupCommandDefinitions() — Method in class I18n

Info::setupCommandDefinitions() — Method in class Info

Install::setupCommandDefinitions() — Method in class Install

Maintenance::setupCommandDefinitions() — Method in class Maintenance

Preview::setupCommandDefinitions() — Method in class Preview

Repair::setupCommandDefinitions() — Method in class Repair

Seed — Class in namespace XELOS\Framework\Core\Console\Command

Class Seed

Seed::setupCommandDefinitions() — Method in class Seed

Shell — Class in namespace XELOS\Framework\Core\Console\Command

Class Shell

Shell::setupCommandDefinitions() — Method in class Shell

Snapshot — Class in namespace XELOS\Framework\Core\Console\Command

Class Snapshot

Snapshot::setupCommandDefinitions() — Method in class Snapshot

Test::setupCommandDefinitions() — Method in class Test

Theme::setupCommandDefinitions() — Method in class Theme

Uninstall::setupCommandDefinitions() — Method in class Uninstall

Update::setupCommandDefinitions() — Method in class Update

User::setupCommandDefinitions() — Method in class User

Console::showWarnings() — Method in class Console

Shows importent information of current system state to the user

Output::success() — Method in class Output

Outputs a Success Message

$ Core#storage_path — Property in class Core

Core::set_parent_context() — Method in class Core

Core::setDepLinkContext() — Method in class Core

Enforce Link Context based on Current Parent Instance for the local Page and CMD

Core::set_dep_link_context() — Method in class Core

Set Dep Link Context - generated URLs will be considered relative to the given parent instance

Core::set_group() — Method in class Core

Core::setGroupContext() — Method in class Core

Core::set_config() — Method in class Core

Core::set_config_for_session() — Method in class Core

Core::setup_check() — Method in class Core

Check/Get Setup Page

Core::set_xf_link() — Method in class Core

Core::send_file() — Method in class Core

Get the data... $args = array('download','myfile.txt')

Core::set_context_id() — Method in class Core

sets the numerical Context-ID (PrimaryKey in Instance_Registry)

Core::store_file() — Method in class Core

Stores the file in the system DMS

DatabaseException::setQuery() — Method in class DatabaseException

Sets the Query connected to this Exception

ActionHandlerHelper::sendFeedbackAsFlashMessages() — Method in class ActionHandlerHelper

Send Feedback Messages

ActionHandlerHelper::setCollection() — Method in class ActionHandlerHelper

Set collection for CollectionActionHelper

ActionHandlerHelper::setActionHandlerEndpoint() — Method in class ActionHandlerHelper

ActionHelper::setConfirmationQuestion() — Method in class ActionHelper

ActionHelper::setFeedbackMessage() — Method in class ActionHelper

ActionHelper::setIsDownload() — Method in class ActionHelper

CollectionActionHelper::setCollection() — Method in class CollectionActionHelper

Pass the collection for the actions to be based upon.

FormActionHelper::setForm() — Method in class FormActionHelper

I18nTokenHelper::setExplicitTranslations() — Method in class I18nTokenHelper

Set explicit translation strings to use when evaluating token

I18nTokenHelper::setTokenDomain() — Method in class I18nTokenHelper

Set explicit domain for this translation token

LinkContextHelper::set_xf_link() — Method in class LinkContextHelper

ModelActionHelper::setModel() — Method in class ModelActionHelper

Pass the collection for the actions to be based upon.

SerializedObjectHelper — Class in namespace XELOS\Framework\Core\Helper

CollectionActionHandlerInterface::setCollection() — Method in class CollectionActionHandlerInterface

SerializableInterface — Class in namespace XELOS\Framework\Core\Interfaces

SerializableInterface::serializeObject() — Method in class SerializableInterface

Template::set_render_mode() — Method in class Template

Template::set_output_mode() — Method in class Template

Set Output Mode

Template::set_marker_content() — Method in class Template

Set Marker

Template::set_block_id() — Method in class Template

Template::setFileCacheContent() — Method in class Template

ItemListTrait::setItems() — Method in class ItemListTrait

ObjectManager::set_injection_objects() — Method in class ObjectManager

Add given objects to injection object list that will be inject into object by magic call. The array should consists of property name as key and object as value.

ObjectManager::set_lib_class_dir() — Method in class ObjectManager

Sets the directory where classes are stored.

ObjectManager::set_lib_class_prefix() — Method in class ObjectManager

Sets the class name prefix.

SerializableObjectTrait — Class in namespace XELOS\Framework\Core\Traits

SerializableObjectTrait::serializeObject() — Method in class SerializableObjectTrait

SerializableObjectTrait::serializePropertiesInclude() — Method in class SerializableObjectTrait

Optional: Override this method and specify the properties to include during serialize null = All Properties will be serialized (default) [] = No Properties will be serialized ['id'] = $this->id will be serialized

StaticCacheTrait — Class in namespace XELOS\Framework\Core\Traits

Static Cache Trait Adds a static (per request) cache to the object which can hold data for the time of the request (in the frontend) or a certain duration during long running processes. It works together with the global caching system and enforces a static cache clearing in case of global cache clearings as well.

StaticCacheTrait::staticCacheIsEnabled() — Method in class StaticCacheTrait

StaticCacheTrait::staticCacheSet() — Method in class StaticCacheTrait

Store a value in the static cache

StaticCacheTrait::staticCacheGet() — Method in class StaticCacheTrait

Retrieves a value from the static cache

StaticCacheTrait::staticCacheRemove() — Method in class StaticCacheTrait

Removes the passed key

StaticCacheTrait::staticCacheIsSet() — Method in class StaticCacheTrait

Checks if the passed is key has a value set

StaticCacheTrait::staticCacheGetKeys() — Method in class StaticCacheTrait

Returns an array of all cache keys which have been set

StaticCacheTrait::staticCacheGetPool() — Method in class StaticCacheTrait

Returns an key/value array with all cached values from the passed pool

StaticCacheTrait::staticCacheClearCachePool() — Method in class StaticCacheTrait

Clears the specified cache pool from the static cache

StaticCacheTrait::staticCacheClearAllCachePools() — Method in class StaticCacheTrait

VarsTemplate::set_mod() — Method in class VarsTemplate

Set Instance Reference

VarsTemplate::set_block_xml() — Method in class VarsTemplate

Will set the content of an in the vars template. Creates a new block with type text when it doesn't exist.

Controller::set_message_vars() — Method in class Controller

AuthenticationHook::setName() — Method in class AuthenticationHook

DocumentItem::supports_copy_to_another_instance() — Method in class DocumentItem

Returns true if this cf type has the technical means of being copied to another instance.

$ ModulePortlet#storage_path — Property in class ModulePortlet

$ ModulePortlet#skip_auto_init — Property in class ModulePortlet

ModulePortlet::setCmsComponent() — Method in class ModulePortlet

Setter for the cms component

ModulePortlet::set_download_handler() — Method in class ModulePortlet

ModulePortlet::set_storage_path() — Method in class ModulePortlet

ModulePortlet::set_options() — Method in class ModulePortlet

ModulePortlet::set_config() — Method in class ModulePortlet

ModulePortlet::set_mod() — Method in class ModulePortlet

ModulePortlet::set_caller_reference() — Method in class ModulePortlet

Set Caller Reference This function is automatically called from get_hooks

ModulePortlet::setIsEmpty() — Method in class ModulePortlet

Mark portlet as empty (is used be the frontend to hide empty elements) Should be set to true if portlet is empty or shows no content template

ModulePortlet::setCallingContext() — Method in class ModulePortlet

ModulePortlet::setPageContext() — Method in class ModulePortlet

ModulePortlet::swapOwnerReference() — Method in class ModulePortlet

Moves the staging page owner reference to the live page to prevent deletion of the documents.

$ Job#statusUpdateCallback — Property in class Job

Callback tor status updates

Job::setStatusUpdateCallback() — Method in class Job

Sets the callback which should be called if the job needs to update its status As the QueueableJob has no context of the job itself this function is only available from within the execution context (daemon)

$ DocumentModel#silent_mode — Property in class DocumentModel

DocumentModel::save() — Method in class DocumentModel

DocumentModel::setDocumentIndex() — Method in class DocumentModel

Sets the related document index.

SearchableDocumentInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

SoftDeleteInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

Interface SoftDeleteInterface

SoftDeleteInterface::softDelete() — Method in class SoftDeleteInterface

SoftDeleteInterface::scopeNotDeleted() — Method in class SoftDeleteInterface

$ Model#saved — Property in class Model

Model::save() — Method in class Model

Model::set_property() — Method in class Model

Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.

Model::set_properties_from_array() — Method in class Model

Model::save_to_db() — Method in class Model

Model::schema_values() — Method in class Model

Provides a list of all values allowed for enumerations.

Model::stop_temporary_group_id_overwrite() — Method in class Model

Stops the temporary overwrite of the table_group_id

Model::set_render_params() — Method in class Model

Sets parameter that will be passed to the XUI helpers

Model::set_request_cache() — Method in class Model

Set Request Cache Entry

Model::scope_by_TABLE_COL_and_TABLE_COL2() — Method in class Model

Returns unloaded ModelCollection

Model::self() — Method in class Model

ModelCollection::setModels() — Method in class ModelCollection

Setting model manually in a collection will set the collection prefilled/not scopable

ModelCollection::setEmpty() — Method in class ModelCollection

Set this ModelCollection as loaded and empty collection

ModelCollection::setProperty() — Method in class ModelCollection

ModelCollection::save() — Method in class ModelCollection

ModelCollection::sum() — Method in class ModelCollection

Returns the sum of the passed property across all models

ModelCollection::shift() — Method in class ModelCollection

This function shifts the first value of the models-array off and returns it, shortening the array by one element and moving everything down.

ModelCollection::slice() — Method in class ModelCollection

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

ModelCollection::sort_by() — Method in class ModelCollection

Sorts the current Collection by given Property-Name

ModelCollection::sortByQuery() — Method in class ModelCollection

Mimics the SQL sorting on the ModelCollection

ModelCollection::setCanBeScoped() — Method in class ModelCollection

ModelCollection::search_by_id() — Method in class ModelCollection

ModelCollection::search_all_by_id() — Method in class ModelCollection

ModelCollection::scope_by_COL() — Method in class ModelCollection

ScopesTrait — Class in namespace XELOS\Framework\Module\Model\Traits\Base

ScopesTrait::scope() — Method in class ScopesTrait

ScopesTrait::setModelCollectionReference() — Method in class ScopesTrait

ScopesTrait::scopeAll() — Method in class ScopesTrait

ScopesTrait::scope_by_id() — Method in class ScopesTrait

SortTrait — Class in namespace XELOS\Framework\Module\Model\Traits\Base

SortTrait::sort_up() — Method in class SortTrait

Increase Sort Priority (Decreases SORT value)

SortTrait::sort_down() — Method in class SortTrait

Decrease Sort Priority (Increases SORT value)

SortTrait::sortMoveTo() — Method in class SortTrait

Sort this element to a specific position

SoftDeleteTrait — Class in namespace XELOS\Framework\Module\Model\Traits

Trait SoftDeleteTrait to be used in Models, requires deleted_at column in database table

SoftDeleteTrait::softDelete() — Method in class SoftDeleteTrait

Mark this model as deleted by setting deleted_at to current time

SoftDeleteTrait::scopeNotDeleted() — Method in class SoftDeleteTrait

Default active scope.

SoftDeleteTrait::scopeSoftDeleted() — Method in class SoftDeleteTrait

Scope to return only soft deleted records.

StateMachineTrait — Class in namespace XELOS\Framework\Module\Model\Traits

SetupPage — Class in namespace XELOS\Framework\Module\Page

SystemCron — Class in namespace XELOS\Framework\Module

Class Cron

SystemCron::start_cron() — Method in class SystemCron

SystemCron::set_last_times() — Method in class SystemCron

Set Last Times

SystemCron::setErrorCount() — Method in class SystemCron

SystemDaemon — Class in namespace XELOS\Framework\Module

Class SystemDaemon

$ SystemDaemon#sleep_between_process — Property in class SystemDaemon

$ SystemDaemon#shutdown — Property in class SystemDaemon

$ SystemDaemon#sleeping — Property in class SystemDaemon

SystemDaemon::start_all() — Method in class SystemDaemon

Start all Daemons

SystemDaemon::stop_all() — Method in class SystemDaemon

Stop all Daemons

SystemDaemon::start() — Method in class SystemDaemon

SystemDaemon::signalHandler() — Method in class SystemDaemon

SystemDaemonThreaded — Class in namespace XELOS\Framework\Module

Base Class for a Threaded System Daemon

$ Document#sidebar — Property in class Document

Document::set_model() — Method in class Document

Set Model this UI Render will be based upon

Document::set_force_layout() — Method in class Document

Set preferred layout type

UIAjaxComponent::set_url_parameters() — Method in class UIAjaxComponent

Sets the url parameter that is used for component loading.

UIAjaxComponent::setLoadURL() — Method in class UIAjaxComponent

UIAjaxComponent::setDeferredLoading() — Method in class UIAjaxComponent

Set true to load the content deferred. Displays a placeholder while loading the content. Optional you can pass a message which will replace the default loading message.

UIAjaxComponent::set_uid() — Method in class UIAjaxComponent

UIAjaxComponent::set_option() — Method in class UIAjaxComponent

Sets options. This options will be used in the JS element of this XUI class.

UIComponent::set_mod() — Method in class UIComponent

Set link to owning module

UIComponent::set() — Method in class UIComponent

Set Variable / Option

UIComponent::set_array() — Method in class UIComponent

Set Variable / Option for an array

UIComponent::set_render_params() — Method in class UIComponent

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

UIComponent::set_marker_content() — Method in class UIComponent

sets marker_content to passed data -> restore original content with reset_marker_content()

$ XF#system — Property in class XF

XF::shutdown() — Method in class XF

Global Shutdown Function being called on finishing Page Call

XF::set_instantiation_closure() — Method in class XF

XF::skip_init() — Method in class XF

$ Config#session — Property in class Config

Config::set() — Method in class Config

Config::set_for_request() — Method in class Config

Set flag only for the current request

Config::set_instance_setting() — Method in class Config

Config::set_setting() — Method in class Config

Config::set_dyn_value() — Method in class Config

$ DB#server — Property in class DB

$ MySQLAdapter#server — Property in class MySQLAdapter

$ MySQLAdapter#smartTimestampFields — Property in class MySQLAdapter

MySQLAdapter::set_timezone() — Method in class MySQLAdapter

Set the TimeZone for the current mySQL Connection

MySQLAdapter::secure_query() — Method in class MySQLAdapter

Check Query to avoid SQL Injections

MySQLAdapter::set_autocommit() — Method in class MySQLAdapter

ConditionGroup::setOperator() — Method in class ConditionGroup

PartitionQuery::setPartitionColumn() — Method in class PartitionQuery

Query::setOnChangeCallback() — Method in class Query

Registeres a Callback which is executed if the Query is being changed

Query::setDefaultStringReturn() — Method in class Query

Sets the default return if Object is converted to a STRING

Query::select() — Method in class Query

Adds a SELECT field to the query

Query::selectFromTable() — Method in class Query

Adds a SELECT field from a specific table to the query

Query::selectRaw() — Method in class Query

Adds a custom SELECT SQL to the query

Query::selectFromQuery() — Method in class Query

IM::set_global_group_context() — Method in class IM

Set the global parent context which will be used for each new instance (e.g. get_instance())

IM::set_global_group_context_exclude() — Method in class IM

Set Instances which should be ignored when applying global group context

IM::set_instance_reference() — Method in class IM

Set Instance Reference

IM::shellplugin_is_installed() — Method in class IM

Checks if a certain shellplugin is available on this system

$ Lib#session — Property in class Lib

$ Lib#shell — Property in class Lib

$ Lib#sec — Property in class Lib

$ Lib#scripting — Property in class Lib

$ Lib#ssl — Property in class Lib

$ Lib#stats — Property in class Lib

$ Lib#sort — Property in class Lib

$ Lib#sql_nested_set — Property in class Lib

Lib::session() — Method in class Lib

Browser::send_canonical_header() — Method in class Browser

Send Canonical HTTP Header

Browser::setCookie() — Method in class Browser

Set cookie using the correct global options (secure, httponly, samesite, domain)

Browser::sendXAccelRedirect() — Method in class Browser

Send X-Accel-Redirect Header for NGINX

Cache::set() — Method in class Cache

APCUCacheHandler::set() — Method in class APCUCacheHandler

CacheHandlerInterface::set() — Method in class CacheHandlerInterface

MemcacheCacheHandler::set() — Method in class MemcacheCacheHandler

RedisCacheHandler::set() — Method in class RedisCacheHandler

Connect::set_connection_config_value() — Method in class Connect

Sets an config value for the connection.

Convert::stream_to_text() — Method in class Convert

Convert::stream_to_html() — Method in class Convert

Date::set_time_constants() — Method in class Date

Set Time Vars

Date::sqltime_to_seconds() — Method in class Date

Converts a SQL Time Format to seconds (e.g. '10:00:00' to 606010)

Date::sqltime_local_to_timestamp_utc() — Method in class Date

Converts a LOCAL SQL Time Format to a UTC timestamp

Date::sqltime_utc_to_timestamp_utc() — Method in class Date

Converts a UTC SQL Time Format to a UTC timestamp

Date::seconds_to_hours() — Method in class Date

Converts a time in seconds to its corresponding hour format

$ Debug#starttime — Property in class Debug

Debug::startQueryProfiler() — Method in class Debug

Debug::stopQueryProfiler() — Method in class Debug

Debug::start_timer() — Method in class Debug

Debug::startSection() — Method in class Debug

Debug::show_debug_toolbar() — Method in class Debug

Debug::setBreakpoint() — Method in class Debug

Sets a breakpoint where the execution will be halted in case of a prior haltOnNextBreakpoint() activation This can be used if you need to debug code which is being executed from various paths but you need to debug it in a specific run path. Simply call haltOnNextBreakpoint() and the next time the setBreakpoint() is reached your debug output will be shown

SlimTimer — Class in namespace XELOS\Framework\XF\Lib\Debug

Debug class to display times in the frontend.

SlimTimer::start() — Method in class SlimTimer

SlimTimer::setSlowRequestExpected() — Method in class SlimTimer

Allows for disabling the performance header to indicate a request which should be skipped in standard monitoring (e.g. for large exports which are expeced to be slow)

Error::set_log_file() — Method in class Error

Error::set_log_level() — Method in class Error

Set Log Level

File::send_file() — Method in class File

Send file to client/browser

File::setPermissionsWeb() — Method in class File

Set permissions for files writable to the web user and system user Should be applied to files in _log, _files, etc -> readable and writable to system AND web \XF_SYSTEM_UID and \XF_WEBSERVER_UID

File::setPermissionsSystem() — Method in class File

Set permissions for files writable system user only Should be applied to files in class, modules, etc -> readable for web and writable to system only \XF_SYSTEM_UID and \XF_WEBSERVER_UID

Filehandler::save() — Method in class Filehandler

Filehandler::save_image() — Method in class Filehandler

Saves the passed GD image ressource to the specified file

Format::str_to_number() — Method in class Format

Converts a string to the corresponding number using the local number settings

I18n::set_language() — Method in class I18n

I18n::set_timezone() — Method in class I18n

I18n::string_to_number() — Method in class I18n

I18n::set_message_vars() — Method in class I18n

I18n::save_template() — Method in class I18n

saves a template to db different language and kulture has to be set by i18n->set_languag and i18n->set_culture custom is as default false

CsvImport::set_source() — Method in class CsvImport

Sets the CSV File which should be loaded

CsvImport::set_before_model_save() — Method in class CsvImport

Executed for each generated model BEFORE saving it

CsvImport::set_after_model_save() — Method in class CsvImport

Executed for each generated model AFTER saving it

FakeData::set_before_model_save() — Method in class FakeData

FakeData::set_after_model_save() — Method in class FakeData

Seeding — Class in namespace XELOS\Framework\XF\Lib\Installer\Traits

Link::set_defaults() — Method in class Link

Declare Default Settings

Link::set_instance_context() — Method in class Link

Link::setCurlProxyOptions() — Method in class Link

Sets the proxy parameters for a cURL resource if they are set in the config custom.

Link::setOverwriteGPVars() — Method in class Link

GPVars that should be overwiritten, when building links from GPVars

ThreadedStreamHandlerFactory::setOutputLineFormat() — Method in class ThreadedStreamHandlerFactory

$ Logger#stats — Property in class Logger

Logger::setup() — Method in class Logger

Setup the Logger by invoke each stream handler factory and adds the created handler as active stream to this logger.

StreamHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger

Class StreamResourceHandlerFactory

$ StreamHandlerFactory#streamResource — Property in class StreamHandlerFactory

Mail::send() — Method in class Mail

Send mail via SMTP (replacing old Sendmail)

Mail::send_mail() — Method in class Mail

Send the mail via the proper relay and do logging

Mention::sendNotification() — Method in class Mention

Send a notification to the users mentioned in the text.

$ Modsetup#sql_fieldtypes — Property in class Modsetup

$ Modsetup#silent — Property in class Modsetup

$ Modsetup#sql_queue — Property in class Modsetup

Modsetup::set_module() — Method in class Modsetup

Set currently active module

Modsetup::save_configuration() — Method in class Modsetup

Modsetup::start_install_transaction() — Method in class Modsetup

check if there is still a transaction open - if so return false if no transaction is open, open one and return true

Modsetup::set_path_rights() — Method in class Modsetup

Set path rights in XELOS

Modsetup::set_initial_version_check() — Method in class Modsetup

Modsetup::set_system_maintenance() — Method in class Modsetup

Set the system to maintenance mode -> Maintenance Page is being shown, Daemons stopping automaticaly and Crons are no longer executed

Navigation::set_current_nav_id() — Method in class Navigation

Sets the current Navigation ID Will be internally used as default if no further parameters are specified. The ID is being set during the XF->view init

Navigation::set_current_guess_context() — Method in class Navigation

Sets the current Guess Context Will be used to determine the current navid where requested

Notification::send_vars() — Method in class Notification

Send with Vars Object

Notification::send() — Method in class Notification

$ NotificationBuilder#status — Property in class NotificationBuilder

$ NotificationBuilder#subjectCallback — Property in class NotificationBuilder

$ NotificationBuilder#subjectToken — Property in class NotificationBuilder

NotificationBuilder::setToken() — Method in class NotificationBuilder

Set the token which identifies your notification within your context A preferred syntax would be 'TYPE:'

NotificationBuilder::setIconCSSClass() — Method in class NotificationBuilder

NotificationBuilder::setCTAUrl() — Method in class NotificationBuilder

Provide a CallToAction URL for this user to be redirected to the source of the event.

NotificationBuilder::setDocumentIndex() — Method in class NotificationBuilder

Is this notification related to a document? You can provide the DocumentIndex, which will automatically set CTAUrl, Default Title and Token for your Notification

NotificationBuilder::setSubjectAndBodyAsVarsTemplate() — Method in class NotificationBuilder

You can use a varsTemplate to provide Subject, Plaintext and HTML as Template Object

NotificationBuilder::setSubjectAndBodyAsVarsTemplateAsCallback() — Method in class NotificationBuilder

You can use a varsTemplate to provide Subject, Plaintext and HTML as Template Object

NotificationBuilder::setSubjectAsString() — Method in class NotificationBuilder

Provide the subject as translateable string Example: ->setSubjectAsString("New like", _("New like"))

NotificationBuilder::setSubjectAsCallback() — Method in class NotificationBuilder

Provide a callback/closure which is providing the subject for your notification

NotificationBuilder::setSubjectI18nToken() — Method in class NotificationBuilder

Provide a I18nTokenHelper

NotificationBuilder::setHtmlI18nToken() — Method in class NotificationBuilder

Provide a I18nTokenHelper

NotificationBuilder::setPlaintext() — Method in class NotificationBuilder

Set Plaintext Body Message for your notification. Please provide an untranslated string which is translateable during build If no plaintext is given, but html is available, the builder will automatically convert the html version to plaintext

NotificationBuilder::setPlaintextByCallback() — Method in class NotificationBuilder

Provide a callback/closure which is providing the plaintext body for your notification

NotificationBuilder::setPlaintextI18nToken() — Method in class NotificationBuilder

Provide a I18nTokenHelper

NotificationBuilder::setStatus() — Method in class NotificationBuilder

NotificationBuilder::setType() — Method in class NotificationBuilder

todo doc, defaults

NotificationBuilder::setRecipientUserId() — Method in class NotificationBuilder

Who should receive this notification?

NotificationBuilder::setSourceInstance() — Method in class NotificationBuilder

Set instance reference as string or int

NotificationBuilder::setNotificationRegistryKey() — Method in class NotificationBuilder

Set the config key of your notification. If you are not setting this key, the first configured notifcation will be selected.

NotificationMessage::setRecipientUserID() — Method in class NotificationMessage

NotificationMessage::setStatus() — Method in class NotificationMessage

NotificationMessage::setType() — Method in class NotificationMessage

NotificationMessage::setToken() — Method in class NotificationMessage

The Notification Token can be used to update this notification later or to revoke it Existing notifications with the same token from the same sourceInstanceId will automatically updated to reduce redundant messages for the user

NotificationMessage::setSourceInstanceId() — Method in class NotificationMessage

We expect the ID of the instance not the STRING

NotificationMessage::setSubject() — Method in class NotificationMessage

NotificationMessage::setSubjectToken() — Method in class NotificationMessage

NotificationMessage::setHtml() — Method in class NotificationMessage

NotificationMessage::setHtmlToken() — Method in class NotificationMessage

NotificationMessage::setText() — Method in class NotificationMessage

NotificationMessage::setTextToken() — Method in class NotificationMessage

NotificationMessage::setIconCSSClass() — Method in class NotificationMessage

NotificationMessage::setCTAUrl() — Method in class NotificationMessage

Call To Action URL - when the user clicks the notifcation - where should he go to ? Please provide a relative URL if you are linking to the current system!

NotificationMessage::setSourceRegistryId() — Method in class NotificationMessage

Optional: If your module is providing multiple notifications of different type this will identify the correct registered type and its priority

NotificationMessage::setDocumentIndexId() — Method in class NotificationMessage

Policy::set_instance_policies_to_level() — Method in class Policy

Sets all static policies and page access rights for all provided users and groups based on the access level.

$ QueueableJob#scheduledDateTime — Property in class QueueableJob

Should the scheduling be delayed

QueueableJob::setUniqueId() — Method in class QueueableJob

Can be implemented on the Job to avoid running the same task multiple times at once If the task already exists in the queue and is waiting or in process the next tasks won't be scheduled

QueueableJob::setReferenceKey() — Method in class QueueableJob

Define a reference ID which can later be used to lookup this job

QueueableJob::setRetryDelay() — Method in class QueueableJob

QueueableJob::setIdToken() — Method in class QueueableJob

QueueableJob::setReScheduledJobId() — Method in class QueueableJob

QueueableJob::setQueue() — Method in class QueueableJob

QueueableJob::setMaxRetries() — Method in class QueueableJob

How may times should a job be retried when it failed.

QueueableJob::schedule() — Method in class QueueableJob

QueueableJob::setScheduledDateTime() — Method in class QueueableJob

QueueableJobBuilder::setReplaceJobIfExists() — Method in class QueueableJobBuilder

QueueableJobBuilder::setReferenceKey() — Method in class QueueableJobBuilder

Define a reference ID which can later be used to lookup this job

QueueableJobBuilder::setUniqueId() — Method in class QueueableJobBuilder

Define a unique ID which can later be used to lookup this job The ID will checked against your specific job class (no need to pass module name in id)

QueueableJobBuilder::setQueue() — Method in class QueueableJobBuilder

QueueableJobBuilder::setDelay() — Method in class QueueableJobBuilder

Set delay for job execution

QueueableJobBuilder::setScheduledDateTime() — Method in class QueueableJobBuilder

QueueableJobBuilder::setMaxRetries() — Method in class QueueableJobBuilder

How may times should a job be retried when it failed.

$ Quota#size — Property in class Quota

Request::set_var() — Method in class Request

Scripting — Class in namespace XELOS\Framework\XF\Lib

Scripting::secure_eval() — Method in class Scripting

Secure EVAL to allow user scripting within applications. Retuns an object which allows more customization

Sec — Class in namespace XELOS\Framework\XF\Lib

Class Sec

Sec::sanitizeHtmlToMarkdown() — Method in class Sec

Sanitize/Convert HTML to Markdown

Sec::sendContentSecurityPolicyHeaderForUserUpload() — Method in class Sec

Send CSP Headers for files that are user uploads to prevent persistent XSS attacks when users upload files Function will send headers based on filetype and system configuration

Sec::sendCommonSecurityHeaders() — Method in class Sec

This function will automatically send common security headers which are applicable based on configuration and currently known environmnet

Sec::sendContentSecurityPolicyHeader() — Method in class Sec

Send CSP Header

Sec::sendStrictTransportSecurityHeader() — Method in class Sec

Strict Transport Security Header tell the browser to always access this site via https

SecureEvalClass — Class in namespace XELOS\Framework\XF\Lib

Session — Class in namespace XELOS\Framework\XF\Lib

Class Session

Session::start() — Method in class Session

Register as session handler and start session Session can only be started ONCE per request

Session::set_lifetime() — Method in class Session

Modify the session lifetime for the current session if possible It is currently NOT possible to set lifetime for REDIS Session Handler with this method as REDIS requires setting the

Session::set() — Method in class Session

Set and save a key-value in the current users session. This value is stored until the session is destroyed (end of user session)

Session::session_valid_id() — Method in class Session

Validate session id

SessionDirtyFlagStorageInterface — Class in namespace XELOS\Framework\XF\Lib\Session\Interfaces

Interface for XELOS Specific Session Handlers

SessionManagementInterface — Class in namespace XELOS\Framework\XF\Lib\Session\Interfaces

Interface for XELOS Specific Session Handlers

SqlSessionHandler — Class in namespace XELOS\Framework\XF\Lib\Session

Class sql_session_handler

Shell — Class in namespace XELOS\Framework\XF\Lib

Shell::start_cron() — Method in class Shell

Shell::schedule_cron() — Method in class Shell

Schedules the cron to be started within the next three minutes, regardless of its regular execution time

Shell::start_daemon_process() — Method in class Shell

Shell::stop_daemon_process() — Method in class Shell

Shell::secure_shell_input() — Method in class Shell

Shell::search() — Method in class Shell

Search for a token in the passed file and return the corresponding lines

Shell::stdOut() — Method in class Shell

Shell::setProcessOwner() — Method in class Shell

Set UID and GID according to configured WEBSERVER process owner This function will only work if the current process owner is root

Sort — Class in namespace XELOS\Framework\XF\Lib

$ Sort#search_params — Property in class Sort

Sort::search_callback() — Method in class Sort

Search Callback

SqlNestedSet — Class in namespace XELOS\Framework\XF\Lib

SqlNestedSet::set_params() — Method in class SqlNestedSet

Change default params

Ssl — Class in namespace XELOS\Framework\XF\Lib

Ssl::ssl_check() — Method in class Ssl

Stats — Class in namespace XELOS\Framework\XF\Lib

Stats Helper

Threading::sendSignalToRunningChildren() — Method in class Threading

Stops all running child processes

Thumbnail::set_thumbsize() — Method in class Thumbnail

Set Thumb Size

UserImport::setMode() — Method in class UserImport

Set the import mode. Use class constants: UserImport::MODE_*

UserImport::setAutoGeneratePassword() — Method in class UserImport

If set to true a password will be autogenerated, if a NEW user has been created and $userData['password'] is empty.

UserImport::setAllowPasswordChange() — Method in class UserImport

If set to true the password of an EXISTING user will be changed if $userData['password'] is set

UserImport::setGeneratedPasswordLength() — Method in class UserImport

Only relevant if autoGeneratePassword is active. See parameters: $XF->lib->sec->generate_pronouncable_password()

UserImport::setGeneratedPasswordStrength() — Method in class UserImport

Only relevant if autoGeneratePassword is active. See parameters: $XF->lib->sec->generate_pronouncable_password()

UserImport::setAutoGenerateLogin() — Method in class UserImport

If set and $userData['login'] is empty, a value for 'login' will be generated.

UserImport::setAutoGenerateDisplayname() — Method in class UserImport

If set and $userData['displayname'] is empty, a value for 'displayname' is generated. ("FIRSTNAME LASTANME")

UserImport::setUniqueIdentifierField() — Method in class UserImport

Set the unique identifier field for the default findExistingUserCallback. ['id' || 'email' || 'login' || 'meta_*']

UserImport::setAfterPrepareCallback() — Method in class UserImport

Callback to further prepare the $userData. USE: function($userData, $userObj); return $userData;

UserImport::setFindExistingUserCallback() — Method in class UserImport

Callback to find a user object. USE: function($userData); return \XELOS\Framework\XF\System\Model\User

SourcecodeParser — Class in namespace XELOS\Framework\XF\Lib\i18n\Parser

Token::setDomain() — Method in class Token

Sets the domain for this token

Token::setPluralToken() — Method in class Token

Adds a connected plural token

TokenCollection::setDomain() — Method in class TokenCollection

Sets the passed domain for all Tokens in this collection

System — Class in namespace XELOS\Framework\XF

System "Fake" Module

DocumentIndexCollection::scope_by_active() — Method in class DocumentIndexCollection

DocumentIndexCollection::search_all_by_instance_id_and_post_type() — Method in class DocumentIndexCollection

DocumentIndexCollection::search_by_id() — Method in class DocumentIndexCollection

DocumentIndexCollection::search_by_uuid() — Method in class DocumentIndexCollection

DocumentIndexReferenceCollection::search_all_by_reference_index_id() — Method in class DocumentIndexReferenceCollection

GroupCollection::scope_by_active() — Method in class GroupCollection

InstanceRegistryCollection::search_all_by_module_name() — Method in class InstanceRegistryCollection

InstanceRegistryCollection::search_by_instance_id() — Method in class InstanceRegistryCollection

ModuleGroupSecurityCollection::scope_by_active() — Method in class ModuleGroupSecurityCollection

ModuleRegistryCollection::search_all_by_module_name() — Method in class ModuleRegistryCollection

ModuleRegistryCollection::search_by_module_name() — Method in class ModuleRegistryCollection

UserCollection::setAdminSearchMode() — Method in class UserCollection

If Admin Search Mode is enabled, the search query will include login + email, otherwise search will only use firstname, lastname, displayname

UserCollection::search_all_by_id() — Method in class UserCollection

AuditPolicy::save() — Method in class AuditPolicy

AuditPolicy::set_property() — Method in class AuditPolicy

Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.

AuditPolicy::scope_by_policy_id_and_value() — Method in class AuditPolicy

AuditTrail::save() — Method in class AuditTrail

AuditTrail::set_property() — Method in class AuditTrail

Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.

$ DocumentIndex#scheduled_removal_at — Property in class DocumentIndex

Y-m-d H:i:s

DocumentIndex::setPrefetchRightsContexts() — Method in class DocumentIndex

DocumentIndex::set_post_type() — Method in class DocumentIndex

type-safe setter

DocumentIndex::set_related_document() — Method in class DocumentIndex

DocumentIndex::set_hidden() — Method in class DocumentIndex

Updates the hidden flag for this document index and all children if so desired

DocumentIndex::serializePropertiesInclude() — Method in class DocumentIndex

DocumentIndex::save() — Method in class DocumentIndex

$ DocumentIndexJobQueue#scheduled_at — Property in class DocumentIndexJobQueue

$ DocumentIndexJobQueue#status — Property in class DocumentIndexJobQueue

DocumentIndexJobQueue::set_status() — Method in class DocumentIndexJobQueue

sets the index-status (only enum-values possible, regarding db-definition)

$ DocumentIndexPolicyCluster#sample_user_id — Property in class DocumentIndexPolicyCluster

DocumentIndexReference::save() — Method in class DocumentIndexReference

$ DocumentRegistry#supports_cf — Property in class DocumentRegistry

GlobalConfig::set_config_value() — Method in class GlobalConfig

Group::save() — Method in class Group

$ Hierarchy#secondary_explicit_users — Property in class Hierarchy

Set of User IDs

Hierarchy::save() — Method in class Hierarchy

Save Model Changes to Database

$ I18nToken#sources — Property in class I18nToken

Sources

InstanceConfig::set_config_value() — Method in class InstanceConfig

$ ModuleGroupSecurity#security_type — Property in class ModuleGroupSecurity

[public, closed, inactive]

Navigation::save() — Method in class Navigation

$ Notification#status — Property in class Notification

['new','processed','seen','read'], default: 'new'

$ Notification#subject — Property in class Notification

$ Notification#seen_at — Property in class Notification

$ Notification#system_notification_registry_id — Property in class Notification

Notification::save() — Method in class Notification

A timestamp is created when checked as empty before

$ OnboardingCode#state — Property in class OnboardingCode

Policy::search_by_id() — Method in class Policy

Policy::search_by_name_and_instance_id() — Method in class Policy

ThemeSet::set_config_property() — Method in class ThemeSet

put your comment there.

ThemeSet::set_config() — Method in class ThemeSet

Return Config Array

ThemeSet::set_color() — Method in class ThemeSet

Return Config Array

User::set_property() — Method in class User

Set user property

User::save_meta() — Method in class User

User::save_unverified() — Method in class User

Save properties which require verification

User::set_security_group() — Method in class User

User::set() — Method in class User

User::save() — Method in class User

User::set_user_setting() — Method in class User

Set a Userconfig Setting

User::set_current_password_check() — Method in class User

If old_password_check propert is filled the new_password() change will only be triggered if the passed value matches the old password and the model will not validate

User::set_new_password() — Method in class User

UserDevices::save() — Method in class UserDevices

If it is a new device, the device_id is generated and the user_id is set.

UserDevices::send_device_cookie() — Method in class UserDevices

Send Device Cookie

UserGroup::save() — Method in class UserGroup

$ UserLink#sort — Property in class UserLink

UserSeedImport::set_new_password() — Method in class UserSeedImport

UserSeedImport::save() — Method in class UserSeedImport

UI::set_associated_content() — Method in class UI

Set Associated Content (for SPDY Push)

UI::storeCacheSnapshot() — Method in class UI

Store Snapshot to Cache by a given cache key

AjaxContainer::set_content() — Method in class AjaxContainer

Set the content of the container to a static content (e.g. Template Object or HTML Output)

AjaxContainer::set_url() — Method in class AjaxContainer

set url to call - if not set, it will be set by get_current_url

AjaxContainer::set_content_callback() — Method in class AjaxContainer

Set the content of the container by using a callback function

AmchartBar::set_ballontext() — Method in class AmchartBar

$ AmchartChart#selected_map — Property in class AmchartChart

Name of the country or area which map is loaded.

AmchartChart::set_uid_prefix() — Method in class AmchartChart

AmchartChart::set_size() — Method in class AmchartChart

Set Size

AmchartChart::setDataDateFormat() — Method in class AmchartChart

Sets the data format of dates so that AmChart knows how to parse date strings https://www.amcharts.com/docs/v3/reference/amstockchart/#dataDateFormat_property

AmchartChart::set_3d_depth() — Method in class AmchartChart

Enable 3D and set the depth

AmchartChart::set_angle() — Method in class AmchartChart

If 3D is enabled set the angle of the chart

AmchartChart::set_listener() — Method in class AmchartChart

https://docs.amcharts.com/3/javascriptcharts/AmChart#events

AmchartChart::set_theme() — Method in class AmchartChart

Set chart theme

AmchartChart::set_colors() — Method in class AmchartChart

Set chart colors, if you don't want the system colors

AmchartChart::set_animation_time() — Method in class AmchartChart

Set chart animation time in seconds

AmchartChart::set_map_quality() — Method in class AmchartChart

Set the map quality

AmchartChart::set_height() — Method in class AmchartChart

Set Chart height

AmchartChart::set_percent_format() — Method in class AmchartChart

Set percent format for numeric values

AmchartChart::set_number_format() — Method in class AmchartChart

Set number format for numeric values

AmchartChart::set_balloon_text() — Method in class AmchartChart

Set balloon text

AmchartChart::set_balloon_text_format() — Method in class AmchartChart

Set balloon text

AmchartChart::set_label_text() — Method in class AmchartChart

Set label text

AmchartGantt::set_data() — Method in class AmchartGantt

AmchartGantt::set_start_date() — Method in class AmchartGantt

Set the start date

AmchartGantt::set_end_date() — Method in class AmchartGantt

Set the end date

AmchartGantt::set_initial_zoom() — Method in class AmchartGantt

AmchartGantt::set_height() — Method in class AmchartGantt

AmchartPie::set_inner_radius() — Method in class AmchartPie

Show pie chart as doughnut

Browse::set_enable_ajax() — Method in class Browse

Enable or disable ajax loading for pagination and letter access.

Browse::set_column_count() — Method in class Browse

Set the number of columns to be displayed

Browse::set_group_column() — Method in class Browse

The column by which to group and order the found entries

Browse::set_show_letters() — Method in class Browse

Should a letter filter be displayed? All letters that have entries will be marked accordingly

Browse::set_show_filter() — Method in class Browse

Should a text filter be displayed?

Browse::set_entries_per_page() — Method in class Browse

Set the number of entries displayed per pagination page.

Browse::set_item_link_cb() — Method in class Browse

Defines a link callback that will be used to create the link in the list viewmode.

Browse::set_data_query() — Method in class Browse

The prepared statement to retrieve the content to be browsed through.

Calendar::setDefaultTimestamp() — Method in class Calendar

Set the default month/year to show

Calendar::set_month() — Method in class Calendar

Set the default month/year to show

Calendar::set_default_link() — Method in class Calendar

Set default link params, all params will be parsed by strftime.

Calendar::set_selection() — Method in class Calendar

Set the days to be selected (display style) Only ONE selection possible. Use marks instead for visuals

Calendar::set_day_info() — Method in class Calendar

Set info for a specific date

Calendar::setShowDaySelectTable() — Method in class Calendar

Show day table selection

Calendar::setShowMonthSelect() — Method in class Calendar

Enables the user to select months/years via dropdown

Calendar::setShowMonthPagination() — Method in class Calendar

Calendar::setXUITarget() — Method in class Calendar

Calendar::set_options() — Method in class Calendar

Set Options

Container::set_content() — Method in class Container

Container::setPlaceholderContent() — Method in class Container

Setting Placeholder Content will automatically enable deferred loading

$ Css#src — Property in class Css

$ Doclink#show — Property in class Doclink

Doclink::set_exclude_actions() — Method in class Doclink

Doclink::set_include_actions() — Method in class Doclink

Doclink::set_single_action() — Method in class Doclink

Set a single action to be shown

DocumentList::setViewStyle() — Method in class DocumentList

Set View Style of XUI, self::VIEWSTYLE_AUTO will mix GRID and LIST depending on the given documents

DocumentList::setLimitLoadMore() — Method in class DocumentList

DocumentList::setDocumentIndexCollection() — Method in class DocumentList

Adds document indexes to a DocumentIndex ModelCollection. Will merge with already existing ModelCollection or will create/search a new one

DocumentList::setModelCollection() — Method in class DocumentList

Alternative to setDocumentIndexCollection is to give a generic (Document)ModelCollection which will be transformed during rendering

DocumentList::setLegacyDocuments() — Method in class DocumentList

Only supported with VIEWSTYLE_LIST or VIEWSTYLE_GALLERY

DocumentLock::set_document_index_id() — Method in class DocumentLock

Sets the id of the target document index.

DocumentLock::set_document_index() — Method in class DocumentLock

Sets the id of the target document index.

$ DocumentView#sidebar — Property in class DocumentView

Faceted::set_xui_target() — Method in class Faceted

Faceted::set_title() — Method in class Faceted

title displayed before the first category

Faceted::set_additional_class() — Method in class Faceted

this class will be added to the outer wrapping div

Faceted::set_render_mode() — Method in class Faceted

this class will be added to the outer wrapping div

Faceted::set_get_parameter_name() — Method in class Faceted

name of the get parameter - default is uid_filter

Faceted::set_active() — Method in class Faceted

Set Active Item

FacetedFilter::setCollection() — Method in class FacetedFilter

Sets the main collection

FacetedFilter::setMaxFacetElements() — Method in class FacetedFilter

Sets the maximum amount of facet elements.

FacetedFilter::setRenderModeChips() — Method in class FacetedFilter

Set Display to horizontal mode (aka "chips")

FacetedFilter::setRenderModeSidebar() — Method in class FacetedFilter

Set Display to classic mode (aka "sidebar")

FacetedFilter::setCategories() — Method in class FacetedFilter

FacetedLegacy::setModelCollection() — Method in class FacetedLegacy

FacetedLegacy::setMaxFacetElements() — Method in class FacetedLegacy

Set the max amount aof facet elements per category

FacetedLegacy::set_xui_target() — Method in class FacetedLegacy

FacetedLegacy::setTargetContainer() — Method in class FacetedLegacy

Set the target container for this facet element

FacetedLegacy::set_title() — Method in class FacetedLegacy

title displayed before the first category

FacetedLegacy::set_additional_class() — Method in class FacetedLegacy

this class will be added to the outer wrapping div

FacetedLegacy::set_render_mode() — Method in class FacetedLegacy

this class will be added to the outer wrapping div

FacetedLegacy::set_get_parameter_name() — Method in class FacetedLegacy

name of the get parameter - default is uid_filter

FacetedLegacy::setHorizontalMode() — Method in class FacetedLegacy

Set Display to horizontal mode

FacetedLegacy::setCustomValue() — Method in class FacetedLegacy

Sets a custom value

FacetedLegacy::set_active() — Method in class FacetedLegacy

Set Active Item

FacetedLegacy::setCategoryResultClosure() — Method in class FacetedLegacy

Set a closure to process queried results CLosure signature: function($row) returns modified $row

FacetedLegacy::setCategoryPropertySubselect() — Method in class FacetedLegacy

Set subselect query to join foreign table id with title

FacetedLegacy::setCategoryDisplayType() — Method in class FacetedLegacy

Set display type of facet (Faceted::DISPLAYTYPE[*])

FacetedLegacy::setCategoryIconClass() — Method in class FacetedLegacy

Set icon class

FacetedLegacy::setCategoryOptions() — Method in class FacetedLegacy

Set options for the category

FacetedLegacy::setCategoryIsRequired() — Method in class FacetedLegacy

At least one facet element has to be selected.

FacetedLegacy::setCategoryDefaultValue() — Method in class FacetedLegacy

The default value(s) for a category. Use item value(s) for checkbox and ['start'=>$X,'end'=>$Y] for date.

FacetedLegacy::setItems() — Method in class FacetedLegacy

Set the items of a category manually (e.g. Start/End Date for a date filter)

$ FacetedCategory#showEmptyItems — Property in class FacetedCategory

$ FacetedCategory#showInMoreOnly — Property in class FacetedCategory

$ FacetedCategory#showItemCount — Property in class FacetedCategory

FacetedCategory::setIconClass() — Method in class FacetedCategory

FacetedCategory::setRequired() — Method in class FacetedCategory

FacetedCategory::setShowEmptyItems() — Method in class FacetedCategory

If enabled, the category will also show items with a hit count of 0

FacetedCategory::setShowInMoreOnly() — Method in class FacetedCategory

If enabled, the category will only be shown in the "more filters" section

FacetedCategory::setDefaultValues() — Method in class FacetedCategory

Set the default value(s) for this category

FacetedCategory::setActive() — Method in class FacetedCategory

Sets items to active based on the given $values

FacetedCategory::setDefaults() — Method in class FacetedCategory

Use setDefaultValues() to set the default values.

FacetedCategory::sortItems() — Method in class FacetedCategory

Sorts the category items by hit count (descending)

FacetedCategory::setKey() — Method in class FacetedCategory

FacetedCategory::setCallback() — Method in class FacetedCategory

Sets the callback to filter the $collection

FacetedCategory::setShowItemCount() — Method in class FacetedCategory

FacetedCategoryChoice::setFilterProperty() — Method in class FacetedCategoryChoice

The property name of the model to filter

FacetedCategoryChoice::setLabelList() — Method in class FacetedCategoryChoice

The option list to use as label map for the values of the $property

FacetedCategoryDate::setActive() — Method in class FacetedCategoryDate

FacetedCategoryDate::setCallback() — Method in class FacetedCategoryDate

Sets the callback to use for filtering the $collection

FacetedCategoryDate::setFutureSelectable() — Method in class FacetedCategoryDate

Is it possible to select dates in the future?

FacetedCategoryItem::setActive() — Method in class FacetedCategoryItem

FacetedCategoryItem::setDefault() — Method in class FacetedCategoryItem

FacetedCategoryItem::setDisabled() — Method in class FacetedCategoryItem

Disable this item, so it will not be displayed

FacetedCategoryItem::setCount() — Method in class FacetedCategoryItem

Sets the count

FacetedCategoryMultipleChoice::setSelectionCondition() — Method in class FacetedCategoryMultipleChoice

Set the condition selected items should be connected.

FacetedCategoryTextSearch::setActive() — Method in class FacetedCategoryTextSearch

FacetedCategoryTextSearch::setText() — Method in class FacetedCategoryTextSearch

Sets the search query text

FacetedCategoryToggle::setActive() — Method in class FacetedCategoryToggle

Form::set_enable_auto_lock() — Method in class Form

If true, this form uses the DocumentLock to lock this form and show lock/view information.

Form::set_mod() — Method in class Form

Form::set_focus() — Method in class Form

Specify the field which should get the focus by default Use TRUE to set focus to first field

Form::set_db_handler() — Method in class Form

Form::set_model() — Method in class Form

Form::set_download_handler() — Method in class Form

Form::set_request_var() — Method in class Form

Form::set_edit_var() — Method in class Form

Form::set_form_property() — Method in class Form

Form::set_field_property() — Method in class Form

Form::sendAjaxResponseJsonHeader() — Method in class Form

Adds the JSON response into the header.

Form::set_request_vars() — Method in class Form

Form::save_data() — Method in class Form

Form::set_feedback() — Method in class Form

Set Form Feedback

Form::set_error() — Method in class Form

mark field as Error and return custom Error-Message

Form::setIsModalClosedOnAjaxSubmit() — Method in class Form

If you know that your form is used in context of an AJAX modal dialog, set this option for automatically closing the modal dialog Default: false Old Param: ajax_close

Form::setIsAjaxForm() — Method in class Form

Submit and Process this form via AJAX Default: false Old Param: ajax_form

Form::setUITarget() — Method in class Form

Sets an ui component as target. Uses the dom unique id of the component as data entry in the form payload to trigger the ui component on submit.

Form::setRedirectURL() — Method in class Form

Redirect user after successful form submission to the specified URL Using back as special param, will automatically use the referer to send the user back to the previous url before opening the form Default: none Old Param: redirect

Form::setLoadingMessage() — Method in class Form

Display Loading spinner and message when user submits form Default: none Old Param: loading_message

Form::setIsReadonly() — Method in class Form

Set complete form to be readonly Default: false

Form::setIsHiddenLabel() — Method in class Form

Set all labels to be hidden Default: false

Form::setFormName() — Method in class Form

Set Form Name Default: Autogenerated unique id

Form::setFormActionURL() — Method in class Form

Set Form Action URL Default: none

Form::setRequestMethod() — Method in class Form

Set Form Name - Default is an autogenerated unique id Default: POST Old param: request_method

Form::setIsSecureForm() — Method in class Form

Apply security measures available to this form (CSFR Check),

Form::setTitle() — Method in class Form

Set Form Title, Title use automatically used in feedback messages

FormEditor::set_workbench_title() — Method in class FormEditor

FormEditor::set_component_title() — Method in class FormEditor

FormEditor::set_show_preview_link() — Method in class FormEditor

FormEditor::set_show_export_link() — Method in class FormEditor

FormEditor::set_form() — Method in class FormEditor

FormEditor::set_allowed_field_types() — Method in class FormEditor

Set the allowed (selectable) field types

FormEditor::set_excluded_field_types() — Method in class FormEditor

Set the excluded (not selectable) field types

$ FormBase#save_requires_edit_var — Property in class FormBase

FormBase::set() — Method in class FormBase

FormBase::set_properties() — Method in class FormBase

FormCatSelector::set_request_vars() — Method in class FormCatSelector

FormCatSelector::save() — Method in class FormCatSelector

FormCatSelector::setIDField() — Method in class FormCatSelector

Set ID Field of your datasource

FormCatSelector::setPIDField() — Method in class FormCatSelector

Set PID Field of your datasource

FormCatSelector::setLabelField() — Method in class FormCatSelector

Set Label Field of your datasource

FormCatSelector::setGroupIDField() — Method in class FormCatSelector

Set GroupID Field of your datasource Array Syntax: group_field

FormCatSelector::setGroupID() — Method in class FormCatSelector

Set GroupID to query on the datasource

FormCatSelector::setIsMultiple() — Method in class FormCatSelector

Can user select multiple categories?

FormCatSelector::setDelimiter() — Method in class FormCatSelector

Set delimiter of internally saved values Array Syntax: implode

FormCatSelector::setValuesAsDatasource() — Method in class FormCatSelector

Set Array as Datasource

FormCheckbox::save() — Method in class FormCheckbox

FormCheckbox::setValuesAsDatasource() — Method in class FormCheckbox

Set Values to choose from Array Syntax: pop_data

FormCheckbox::setDisabledValues() — Method in class FormCheckbox

The value keys given will be displayed as disabled.

FormCheckbox::setDelimiter() — Method in class FormCheckbox

Set delimiter of internally saved values Array Syntax: implode

FormCheckbox::setLayoutStacked() — Method in class FormCheckbox

Display options stacked? Array Syntax: layout=>stack

FormChoice::setAdditionalUrlParams() — Method in class FormChoice

FormChoice::save() — Method in class FormChoice

FormChoice::setOptionListAsDatasource() — Method in class FormChoice

Sets the options for this field via the option list, that may contain several option objects.

FormChoice::setOptionListPresetIcons() — Method in class FormChoice

FormChoice::setOptionListProcessor() — Method in class FormChoice

FormChoice::setIsMultiple() — Method in class FormChoice

Can user select multiple entries?

FormChoice::setNoValue() — Method in class FormChoice

Set a value which should be shown when no item is selected

FormChoice::setNoValueIcon() — Method in class FormChoice

Set an icon class if no value is being selected (displayed with novalue message)

FormChoice::setHideDescription() — Method in class FormChoice

FormChoice::setIsCompact() — Method in class FormChoice

Enable COMPACT Mode which displays the values in a tag like format with multiple values per line

FormChoice::setSerializeFormat() — Method in class FormChoice

Set format expected value format

FormColor::setColorPalette() — Method in class FormColor

Set Color Palette for user to choose from. Please provide only Hex Format without opacity

FormComponent::set_request_vars() — Method in class FormComponent

FormComponent::save() — Method in class FormComponent

FormComponent::set_display_value() — Method in class FormComponent

set the displayed value

FormComponent::setLabel() — Method in class FormComponent

Set Field label

FormComponent::setLabelIconClass() — Method in class FormComponent

Set label icon class

FormComponent::setIsRequired() — Method in class FormComponent

Consider Field as required

FormComponent::setIsDBField() — Method in class FormComponent

Field is to be loaded from and saved to database.

FormComponent::setIsI18NField() — Method in class FormComponent

Field is considered to be translatable. This is usually determined automatically reading the instance configuration of the calling instance

FormComponent::setIsReadonly() — Method in class FormComponent

Consider Field as readonly

FormComponent::setDefaultValue() — Method in class FormComponent

Set Field default value

FormComponent::setCSSClassName() — Method in class FormComponent

Set Field Row CSS class name

FormComponent::setHelpText() — Method in class FormComponent

Set Field Help Text

FormComponent::setDescriptionText() — Method in class FormComponent

Set Field Help Text

FormComponent::setPrefixHTML() — Method in class FormComponent

Add Custom HTML before the field element

FormComponent::setSuffixHTML() — Method in class FormComponent

Add Custom HTML after the field element

FormComponent::setPopulateField() — Method in class FormComponent

Manipulate another fields data when the value of the current field changes.

FormComponent::setVisibilityDependsOn() — Method in class FormComponent

Set Visibility Dependency if you want your field only to be shown if another field has a specify value Array Syntax: tag, tag_source

FormComponent::setVisibilityIsSource() — Method in class FormComponent

Set field to be the event source for another dependent field. Changes of this fields values will trigger events to their dependent fields and change their visibility in the frontend

FormComponent::setCustomErrorText() — Method in class FormComponent

Show Custom Error Message for this field

FormComponent::setGridClass() — Method in class FormComponent

Set Flexbox Grid Class

FormConfig::set_request_vars() — Method in class FormConfig

FormConfig::save_config() — Method in class FormConfig

FormConfig::save() — Method in class FormConfig

FormContentAttachment::save() — Method in class FormContentAttachment

Return the property value which will be saved to db (or processed further by the model)

FormContentAttachment::setAllowReordering() — Method in class FormContentAttachment

Enable filter of input to accept image types

FormDate::setDefaultValueNOW() — Method in class FormDate

Set Default Value to reflect current time

FormDate::setIsDateSpanEndField() — Method in class FormDate

Set Field to be a DateSpan End Field. Given field will automatically be marked as start field.

FormDate::setMinDate() — Method in class FormDate

Set min date for selection

FormDate::setMaxDate() — Method in class FormDate

Set min date for selection

FormDatetime::setSliderOptions() — Method in class FormDatetime

Set Options for Time Slider

FormDatetime::setIsDateHidden() — Method in class FormDatetime

Display only Time and Hide Date part? Array Syntax: hide_date

FormDatetime::setIsDateSpanEndField() — Method in class FormDatetime

FormDatetime::setIsTimestampField() — Method in class FormDatetime

Value / Return is expected to be a unix-timestamp

FormDocument::setAutoStore() — Method in class FormDocument

Set TRUE to let this class handle the attached / uploaded documents. The handling will be triggered on save.

FormDocument::setSerialize() — Method in class FormDocument

If TRUE, field values will be saved serialized.

FormDocument::setDelimiter() — Method in class FormDocument

Sets the separator for multiple values.

FormDocument::setImageCropperSettings() — Method in class FormDocument

Sets the image edit settings for cropping function.

FormDocument::setImageEditorSettings() — Method in class FormDocument

Sets the configuration for image editing.

FormDocument::setImagePreviewSize() — Method in class FormDocument

Sets a fixed image preview size which will be used for single image selects

FormDocument::setMultiple() — Method in class FormDocument

Sets whether this component supports multiple documents.

FormDocument::setOwnerDocument() — Method in class FormDocument

Sets a document model.

FormDocument::setNoDocumentMessage() — Method in class FormDocument

Sets a message which is displayed when no document is selected.

FormDocument::setUploadLabel() — Method in class FormDocument

Sets a custom label name for upload field.

FormDocument::setNoUpload() — Method in class FormDocument

Sets whether client side upload listener should be attached or not.

FormDocument::setFormSubmitOnChange() — Method in class FormDocument

Sets whether changes to attachments should trigger a form submit.

FormDocument::setPasteSource() — Method in class FormDocument

Set the source element which should be checked for File Uploads by Copy&Paste Events

FormDocument::setPasteSourceDomSelector() — Method in class FormDocument

Sets a DOM selector which is used to pasting clip board content.

FormDocument::setOnChange() — Method in class FormDocument

Sets a js callback function name.

FormDocument::setLocation() — Method in class FormDocument

Sets a relative location path.

FormDocument::setWebDir() — Method in class FormDocument

Sets the path to the storage where to save files on upload.

FormDocument::setSaveInCascadedFolder() — Method in class FormDocument

Set TRUE to use cascaded folder.

FormDocument::setSelectorAutoSubmit() — Method in class FormDocument

Sets whether a submit should be triggered after a document selection.

FormDocument::setMinReferenceLevel() — Method in class FormDocument

FormDocument::setAllowImage() — Method in class FormDocument

Enable filter of input to accept image types

FormDocument::setAllowVideo() — Method in class FormDocument

Enable filter of input to accept video types

FormDocument::setAllowFileExtension() — Method in class FormDocument

Set the allow file extensions which can be uploaded.

FormDocument::setDisableLinks() — Method in class FormDocument

Disable the selector to allow the user to select existing documents / links

FormDocument::save() — Method in class FormDocument

Serializes the selection, saving temporary files in the xfs file system

FormDynConfig::save_config() — Method in class FormDynConfig

FormFieldset::setCSSFieldsetClassName() — Method in class FormFieldset

Set Fieldset CSS class name

FormFieldset::setCSSFieldsetIconClassName() — Method in class FormFieldset

Set Fieldset CSS icon class name

FormFieldset::setCSSFieldsetStyle() — Method in class FormFieldset

Set Fieldset CSS style

FormFieldset::setFieldsetID() — Method in class FormFieldset

Set Fieldset ID HTML attribute

FormFieldset::setIsCollapsible() — Method in class FormFieldset

Is Fieldset collapsible?

FormFieldset::setGridClassParameter() — Method in class FormFieldset

Set Grid Class Parameter Will render fields within the fieldset as flexbox grid with optional specifed columns per device

FormFile::setLocation() — Method in class FormFile

Sets a relative location path.

FormFile::setMime() — Method in class FormFile

Sets mime type.

FormFile::setAcceptedExtensions() — Method in class FormFile

The accepted file extensions.

FormFile::setUseSystemDMS() — Method in class FormFile

Sets whether the system dms will be used for storing or not.

FormFile::setWebDir() — Method in class FormFile

Sets the path to the storage where to save files on upload.

FormFile::setMaxUploadSize() — Method in class FormFile

Sets the maximum upload size.

FormFile::setThumbnail() — Method in class FormFile

Sets whether a thumbnail should be displayed or not.

FormFile::setHideOptions() — Method in class FormFile

Sets whether to display upload options or not.

FormFile::setDownloadHandler() — Method in class FormFile

Sets a download handler.

FormFile::setContentType() — Method in class FormFile

Sets the content type.

FormFile::setUploadCallback() — Method in class FormFile

Sets a upload callback.

FormFile::setMaxWidth() — Method in class FormFile

Sets a maximum width for images.

FormFile::setMaxHeight() — Method in class FormFile

Sets a maximum height for images.

FormFile::setSaveInCascadedFolder() — Method in class FormFile

Set TRUE to use cascaded folder.

FormFile::save() — Method in class FormFile

Move File to Final Location and return the filename

FormGeoSelector::setDocumentIndexId() — Method in class FormGeoSelector

FormGroupSelector::setHideSystemGroups() — Method in class FormGroupSelector

Hide System Groups in Selector?

FormGroupSelector::setMaxGroupsLimit() — Method in class FormGroupSelector

How many groups can be selected?

FormHidden::setValue() — Method in class FormHidden

Set Value of Hidden field. The value may contain replacable params refering to other fields in the form.

FormMediaAttachment::save() — Method in class FormMediaAttachment

Return the property value which will be saved to db (or processed further by the model)

FormMediaAttachment::setAllowImage() — Method in class FormMediaAttachment

Enable filter of input to accept image types

FormMediaAttachment::setAllowVideo() — Method in class FormMediaAttachment

Enable filter of input to accept video types

FormMediaAttachment::setImageRoundShape() — Method in class FormMediaAttachment

Set to true if the image cropper should use a round mask (e.g. for avatars)

FormMediaAttachment::setImageAspectRatio() — Method in class FormMediaAttachment

Sets a fixed image aspect ratio

FormMediaAttachment::setImageMinimumSize() — Method in class FormMediaAttachment

Sets a minimum image cropping size in px

FormMultifile::save() — Method in class FormMultifile

FormMultitext::save() — Method in class FormMultitext

FormMultitext::setDelimiter() — Method in class FormMultitext

Set delimiter of internally saved values, only used if not using serialization

FormMultitext::setSerializeFormat() — Method in class FormMultitext

Set delimiter of internally saved values Array Syntax: serialize

FormMultitext::setMaxlength() — Method in class FormMultitext

Set max chars for this field Array Syntax: maxlength

FormMultitext::setPlaceholder() — Method in class FormMultitext

Set the placeholder text for the value input

FormMultitext::setKeyPlaceholder() — Method in class FormMultitext

Set the placeholder text for the value input

FormMultitext::setKeyValueMode() — Method in class FormMultitext

If enabled each entry will consist of a key and a value (two inputs). These are returnes as assoc array in the json format or with a = sign in delimiter mode

FormMultitext::setSortable() — Method in class FormMultitext

If enabled the user is allowed to drag the items in a different order

FormPassword::save() — Method in class FormPassword

Save

FormPassword::setIsHashedOnSave() — Method in class FormPassword

Hash password on save using \XELOS\Framework\XF\User::hash_password

FormPassword::setPasswordField() — Method in class FormPassword

If this field is used to check a password which is repeated, you can use this method.

FormPassword::setCheckPasswordStrength() — Method in class FormPassword

FormPolicySelector::setSinglePolicyOnly() — Method in class FormPolicySelector

If enabled, only one policy can be chosen for each row

FormPolicySelector::setAllowOnly() — Method in class FormPolicySelector

If enabled, only the allow policy can be chosen.

FormPolicySelector::setDefaultUsersParity() — Method in class FormPolicySelector

Sets the class property $defaultUsersParity.

FormPolicySelector::setDefaultGroupsParity() — Method in class FormPolicySelector

Sets the class property $defaultGroupsParity.

FormPolicySelector::setDefaultRolesParity() — Method in class FormPolicySelector

Sets the class property $defaultRolesParity.

FormPolicySelector::setDefaultParities() — Method in class FormPolicySelector

A wrapper method that takes a single string and sets the default parities of all types to this string type value.

FormRadio::save() — Method in class FormRadio

FormRowRenderer::set_fields() — Method in class FormRowRenderer

Set fields which shall be handled by this renderer. These fields will NOT be rendered by the default render engine

FormRowRenderer::set_field_data() — Method in class FormRowRenderer

Sets the field data for each field. Called by render_form() function of Form during render process

FormRowRendererMultifieldRow::setLayout() — Method in class FormRowRendererMultifieldRow

Defines the layout of the elements

FormRrule::set_request_vars() — Method in class FormRrule

FormRrule::save() — Method in class FormRrule

FormRrule::setHideUntil() — Method in class FormRrule

Hide UNITL

FormSelect::save() — Method in class FormSelect

FormSelect::setDelimiter() — Method in class FormSelect

Set delimiter of internally saved values Array Syntax: implode

FormSelect::setValuesAsDatasource() — Method in class FormSelect

Set Values to choose from Array Syntax: pop_data

FormSelect::setCallbackAsDatasource() — Method in class FormSelect

Set ID Field of your datasource Array Syntax: pop_callback

FormSelect::setOnChangeJS() — Method in class FormSelect

Set the onchange HTML attribute

FormSelect::setIsMultiple() — Method in class FormSelect

Can user select multiple entries?

FormSelect::setHideNoValue() — Method in class FormSelect

Can user select multiple categories?

FormSelect::setSize() — Method in class FormSelect

Set HTML attribute size

FormSlider::setMinValue() — Method in class FormSlider

Set Slider MIN Value

FormSlider::setMaxValue() — Method in class FormSlider

Set Slider MAX Value

FormSlider::setMinLabel() — Method in class FormSlider

Set Label for MIN Value

FormSlider::setMaxLabel() — Method in class FormSlider

Set Label for MAX Value

FormSlider::setCSSWidth() — Method in class FormSlider

Set Slider width in px

FormSlider::setValuesAsDatasource() — Method in class FormSlider

Set Values to choose from Array Syntax: values

FormStaticText::setStaticText() — Method in class FormStaticText

Set Static Text, if not set the default value will be used

FormStaticValue::save() — Method in class FormStaticValue

FormStaticValue::setStaticValue() — Method in class FormStaticValue

FormStaticValue::setDefaultValue() — Method in class FormStaticValue

FormTag::setTaggingParameters() — Method in class FormTag

Set Tagging Parameters, this is usually NOT required when using a model in your form

FormTag::setDocumentIndex() — Method in class FormTag

Set Tagging Parameters automatically for a given documentIndex, this is usually NOT required when using a model in your form

FormTextarea::save() — Method in class FormTextarea

FormTextarea::savePreProcess() — Method in class FormTextarea

FormTextarea::setUseMention() — Method in class FormTextarea

FormTextarea::setUseTag() — Method in class FormTextarea

FormTextarea::setSubmitOnCtrlEnter() — Method in class FormTextarea

Enables submission of the Form if the user presses CTRL+ENTER in the textarea

FormTextarea::setCols() — Method in class FormTextarea

Set HTML Cols attribute

FormTextarea::setRows() — Method in class FormTextarea

Set HTML Rows attribute

FormTextarea::setMaxlength() — Method in class FormTextarea

Set max chars for this field Array Syntax: maxlength

FormTextarea::setCSSStyle() — Method in class FormTextarea

Set Custom CSS Style

FormTextarea::setPlaceholder() — Method in class FormTextarea

Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field

FormTextarea::setIsWYSIWYG() — Method in class FormTextarea

Display Textarea as WYSIWYG Editor

FormTextarea::setIsMarkdown() — Method in class FormTextarea

Should content be saved as markdown?

FormTextarea::setRenderField() — Method in class FormTextarea

Sets the render field property, covers i18n mode

FormTextarea::setIsCodeEditor() — Method in class FormTextarea

Display Textarea as codeeditor (CodeMirror)

FormTextarea::setCodeEditorTemplateMarkers() — Method in class FormTextarea

Use markers to enable users refer to variables when writing text. Markers will automatically be written in ###marker### Syntax Using Template Markers can break highlighting or validation on Editor Modes

FormTextarea::setWYSIWYGInserts() — Method in class FormTextarea

Add Document Index Entries which should be available as insert in editor.

FormTextarea::setWYSIWYGCustomInserts() — Method in class FormTextarea

FormTextarea::setDocumentSelector() — Method in class FormTextarea

FormTextbox::save() — Method in class FormTextbox

Save

FormTextbox::setMaxlength() — Method in class FormTextbox

Set max chars for this field Array Syntax: maxlength

FormTextbox::setShowCopyToClipboard() — Method in class FormTextbox

Show Copy to Clipboard function next to this field?

FormTextbox::setTitle() — Method in class FormTextbox

Set Title attribute, title is shown on hovering over the field

FormTextbox::setAutoTitle() — Method in class FormTextbox

Set Auto Title attribute, usually visible when no data has been entered into the field This attribute is very similar to the placeholder attribute an may conflict if both are set.

FormTextbox::setPlaceholder() — Method in class FormTextbox

Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field

FormTextbox::setCSSStyle() — Method in class FormTextbox

Set Custom CSS Style

FormTextbox::setValidationPattern() — Method in class FormTextbox

Set HTML5 REGEX Pattern Attribute, which will be used by browsers to validate user input

FormTextbox::setInputFilter() — Method in class FormTextbox

Set input filter - a javascript input check. This may conflict with a HTML5 pattern attribute.

FormTextbox::setDisplayFilterNumeric() — Method in class FormTextbox

Format output to show as formatted numeric value.

FormTextbox::setFormat() — Method in class FormTextbox

Automatically format the default value using an call to the XELOS Format Helper

FormTextbox::setOnClickJS() — Method in class FormTextbox

Set the onclick HTML attribute

FormTextbox::setOnChangeJS() — Method in class FormTextbox

Set the onchange HTML attribute

FormTextbox::setSubmitOnEnter() — Method in class FormTextbox

Submit the form when the user presses enter? (Standard for POST forms, but not standard for GET forms) Useful if you are implementing a search form using GET request method

FormTextbox::setAutocomplete() — Method in class FormTextbox

Set value for autocomplete attribute, e.g. email, username, new-password, current-password, one-time-code

FormTextboxList::save() — Method in class FormTextboxList

FormTextboxList::setCallbackAsDatasource() — Method in class FormTextboxList

Set ID Field of your datasource Array Syntax: pop_callback

FormTileSelection::save() — Method in class FormTileSelection

FormToggleSwitch::setToggleLabels() — Method in class FormToggleSwitch

Set Switch Labels, Use short words to accomodate style Array Syntax: on_label, off_label

FormToggleSwitch::setToggleValues() — Method in class FormToggleSwitch

Set Switch Values Array Syntax: on_value, off_value

FormToggleSwitch::setIsYesNo() — Method in class FormToggleSwitch

Set Switch Labels to Yes/No instead of On/Off

FormUserSelector::setGroupSecurityId() — Method in class FormUserSelector

Restrict the visible users by providing an optional group_security_id context

FormUserSelector::setAllowGroupSelection() — Method in class FormUserSelector

FormUserSelector::save() — Method in class FormUserSelector

FroalaEditorBuilder::setPluginInsertData() — Method in class FroalaEditorBuilder

Sichtweise: Froala / Insert Plugin Aufgabe:Konvertierung von Daten in Plugin spezifische Formatierung (JSON, JS, API?).

FroalaOption::scrollableContainer() — Method in class FroalaOption

Sets the container in which the editor popups are added.

FroalaOption::shortcutsEnabled() — Method in class FroalaOption

Granular control for enabling or disabling specific shortcuts.

FroalaOption::shortcutsHint() — Method in class FroalaOption

When enabled, the shortcut is displayed in the button tooltip.

FroalaOption::spellcheck() — Method in class FroalaOption

Enables browser spellcheck for the text inside the editing box.

FroalaOption::specialCharButtons() — Method in class FroalaOption

The list of special characters buttons for popup.

FroalaOption::specialCharactersSets() — Method in class FroalaOption

The list of special characters to show.

FroalaOption::saveInterval() — Method in class FroalaOption

Time in milliseconds that defines when the autosave should be triggered. Setting a higher interval helps preventing request overload on the server. The autosave will be triggered only if the content was changed from the last interval. Setting the value to 0 will disable autosave.
Note: It is not recommended to use values lower than 2000ms in order to prevent overload.

FroalaOption::saveMethod() — Method in class FroalaOption

The HTTP save request type.

FroalaOption::saveParam() — Method in class FroalaOption

The name of the parameter which contains the rich text editor's content on the save request.

FroalaOption::saveParams() — Method in class FroalaOption

Additional parameters passed to the save request.

FroalaOption::saveURL() — Method in class FroalaOption

The URL where the save request is being made. The editor will initialize a HTTP request to the specified URL passing the editor's content in the body parameter of the HTTP request.

Option::setKey() — Method in class Option

Option::setTitle() — Method in class Option

Option::setDescription() — Method in class Option

Option::setIconClass() — Method in class Option

Option::setImgURL() — Method in class Option

Option::setIsSeparator() — Method in class Option

Option::setIconFgColor() — Method in class Option

Sets an Icon Foreground Color (HEX String)

Option::setIconBgColor() — Method in class Option

Sets an Icon Background Color (HEX String)

Option::setIconShape() — Method in class Option

Sets an Icon Shape (self::ICON_SHAPE_CIRCLE, self::ICON_SHAPE_ROUNDED_BOX)

Option::setDisabled() — Method in class Option

Mark this entry as disalbed (can not be selected by user)

HtmlGeneric::setTag() — Method in class HtmlGeneric

Declare tag for element

HtmlGeneric::setContent() — Method in class HtmlGeneric

Set content to be surrounded by tags

$ HtmlUlList#style — Property in class HtmlUlList

$ HtmlUlList#separator — Property in class HtmlUlList

$ Image#style — Property in class Image

Image::set_url() — Method in class Image

Image::set_folder_prefix() — Method in class Image

Image::set_label() — Method in class Image

Image::set_alt() — Method in class Image

Image::set_appearance_mode() — Method in class Image

Image::set_resize() — Method in class Image

Image::set_crop() — Method in class Image

Image::set_height() — Method in class Image

Image::set_width() — Method in class Image

Image::set_content_type() — Method in class Image

Image::set_disable_replacer() — Method in class Image

Image::set_public_file_link() — Method in class Image

ImageEdit::set_image_paths() — Method in class ImageEdit

Sets the source image file. The target file can be set optionally.

ImageEdit::set_document_index() — Method in class ImageEdit

Sets the document index of a system dms image file.

ImageEdit::set_settings() — Method in class ImageEdit

Sets settings for this image edit component.

ImageEdit::set_crop_options() — Method in class ImageEdit

Sets the option values for the cropper JS class.

ImageEdit::set_crop_view_mode() — Method in class ImageEdit

Define the view mode of the cropper.

ImageEdit::set_crop_drag_mode() — Method in class ImageEdit

Define the dragging mode of the cropper.

ImageEdit::set_crop_aspect_ratio() — Method in class ImageEdit

Set the aspect ratio of the crop box.

ImageEdit::set_crop_responsive() — Method in class ImageEdit

Re-render the cropper when resize the window.

ImageEdit::set_crop_restore() — Method in class ImageEdit

Restore the cropped area after resize the window.

ImageEdit::set_crop_check_cross_origin() — Method in class ImageEdit

Check if the current image is a cross-origin image.

ImageEdit::set_crop_check_orientation() — Method in class ImageEdit

Check the current image's Exif Orientation information.

ImageEdit::set_crop_modal() — Method in class ImageEdit

Show the black modal above the image and under the crop box.

ImageEdit::set_crop_guides() — Method in class ImageEdit

Show the dashed lines above the crop box.

ImageEdit::set_crop_center() — Method in class ImageEdit

Show the center indicator above the crop box.

ImageEdit::set_crop_highlight() — Method in class ImageEdit

Show the white modal above the crop box (highlight the crop box).

ImageEdit::set_crop_background() — Method in class ImageEdit

Show the grid background of the container.

ImageEdit::set_crop_auto_crop() — Method in class ImageEdit

Enable to crop the image automatically when initialize.

ImageEdit::set_crop_auto_crop_area() — Method in class ImageEdit

Define the automatic cropping area size (percentage).

ImageEdit::set_crop_moveable() — Method in class ImageEdit

Enable to move the image.

ImageEdit::set_crop_rotateable() — Method in class ImageEdit

Enable to rotate the image.

ImageEdit::set_crop_scalable() — Method in class ImageEdit

Enable to scale the image.

ImageEdit::set_crop_zoomable() — Method in class ImageEdit

Enable to zoom the image.

ImageEdit::set_crop_zoom_on_touch() — Method in class ImageEdit

Enable to zoom the image by dragging touch.

ImageEdit::set_crop_zoom_on_wheel() — Method in class ImageEdit

Enable to zoom the image by wheeling mouse.

ImageEdit::set_crop_wheel_zoom_ratio() — Method in class ImageEdit

Define zoom ratio when zoom the image by wheeling mouse.

ImageEdit::set_crop_box_movable() — Method in class ImageEdit

Enable to move the crop box by dragging.

ImageEdit::set_crop_box_resizable() — Method in class ImageEdit

Enable to resize the crop box by dragging.

ImageEdit::set_crop_toggle_drag_mode_on_dblclick() — Method in class ImageEdit

Enable to toggle drag mode between "crop" and "move" when click twice on the cropper.

ImageEdit::set_crop_min_container_size() — Method in class ImageEdit

The minimum width and height of the container.

ImageEdit::set_crop_min_canvas_size() — Method in class ImageEdit

The minimum width and height of the canvas (image wrapper).

ImageEdit::set_crop_min_box_size() — Method in class ImageEdit

The minimum width and height of the crop box.

Import::set_incremental() — Method in class Import

If $this->incremental is set to true, $this->stepping rows will be handled before each redirect to prevent timeouts in time-intensive imports

Import::set_stepping() — Method in class Import

Import::set_init_handler() — Method in class Import

This callback is before step 1 is executed.

Import::set_fdl() — Method in class Import

Additional FDL (Additional Form for step1)

Import::set_save_handler() — Method in class Import

Import::set_import_mode() — Method in class Import

Import::set_key_field() — Method in class Import

Import::store_tmp_data() — Method in class Import

Store temporary to session

ItemList::set_items() — Method in class ItemList

ItemList::set_pagination() — Method in class ItemList

$ Item#source — Property in class Item

Item::set_id() — Method in class Item

Item::set_di_id() — Method in class Item

Item::set_name() — Method in class Item

Item::set_info() — Method in class Item

Item::set_type() — Method in class Item

Item::set_document_model() — Method in class Item

Item::set_icon_class() — Method in class Item

Item::set_created_at() — Method in class Item

Item::set_updated_at() — Method in class Item

Item::set_thumbnail_url() — Method in class Item

Item::set_doclink() — Method in class Item

Sets the html block for doclink link

Item::set_source() — Method in class Item

ButtonOptions::setMuted() — Method in class ButtonOptions

MenuList::setRemoteURL() — Method in class MenuList

MenuListItem::setUrlFromOptions() — Method in class MenuListItem

MenuListItem::setUrl() — Method in class MenuListItem

MenuListItem::setExecJS() — Method in class MenuListItem

MenuListItem::setConfirmDialog() — Method in class MenuListItem

MenuListItem::setModalDialog() — Method in class MenuListItem

Set the ModalDialog for this list item.

MenuOptions::setHideIndicator() — Method in class MenuOptions

MenuOptions::setHideLabel() — Method in class MenuOptions

MenuOptions::setPriority() — Method in class MenuOptions

MenuOptions::setRounded() — Method in class MenuOptions

ModalDialog::setTitle() — Method in class ModalDialog

ModalDialog::setIsFullscreen() — Method in class ModalDialog

ModalDialog::setWidth() — Method in class ModalDialog

ModalDialog::setMaxWidth() — Method in class ModalDialog

ModalDialog::setHeight() — Method in class ModalDialog

ModalDialog::setMaxHeight() — Method in class ModalDialog

ModalDialog::setId() — Method in class ModalDialog

ModalDialog::setXuiTarget() — Method in class ModalDialog

ModalDialog::setIsIframe() — Method in class ModalDialog

ModalDialog::setTitleIconCssClass() — Method in class ModalDialog

ModalDialog::setIsShowCloseConfirm() — Method in class ModalDialog

ModalDialog::setYesButtonLabel() — Method in class ModalDialog

ModalDialog::setNoButtonLabel() — Method in class ModalDialog

ModalDialog::setCssClasses() — Method in class ModalDialog

ModalDialog::setHasForm() — Method in class ModalDialog

ModalDialog::setFormNoAjax() — Method in class ModalDialog

ModalDialog::setFormReload() — Method in class ModalDialog

ModalDialog::setFormReloadTable() — Method in class ModalDialog

ModalDialog::setFormReloadXui() — Method in class ModalDialog

Options::setLabel() — Method in class Options

Options::setId() — Method in class Options

Options::setClass() — Method in class Options

Options::setIconClass() — Method in class Options

Options::setUrl() — Method in class Options

Options::setTitle() — Method in class Options

Paging::setButtonLabelMore() — Method in class Paging

Paging::setButtonLabelPrevious() — Method in class Paging

Paging::setSmallButtonSize() — Method in class Paging

Paging::set_params() — Method in class Paging

Paging::set_default_page() — Method in class Paging

Paging::set_uid() — Method in class Paging

Paging::set_render_mode() — Method in class Paging

Paging::setRenderModeLoadMore() — Method in class Paging

Set the render mode to load more.

Paging::setRenderModeLoadPrevious() — Method in class Paging

Set the render mode to load previous.

Paging::setRenderModeDefault() — Method in class Paging

Paging::setRenderModeNumbers() — Method in class Paging

Paging::setTargetContainer() — Method in class Paging

UIAjaxComponent where the pagination ajax request will refresh the contents.

Paging::set_link_params() — Method in class Paging

ProgressBar::set_value() — Method in class ProgressBar

Set progress bar current value

ProgressBar::set_min_max() — Method in class ProgressBar

Set progress bar range

ProgressBar::set_label() — Method in class ProgressBar

Sets the label which shall be shown on progress bar (sprintf format, default: '%s %%')

ProgressBar::set_compact() — Method in class ProgressBar

Enable compact mode for smaller rendering

QRCode::set_margin() — Method in class QRCode

Set the margin of a qrcode.

QRCode::set_pixelsize() — Method in class QRCode

Set the pixelsize of a qrcode multiplier for each 'virtual' pixel

QRCode::set_with_domain() — Method in class QRCode

Set the value if an image link should have an absolute path witch domain and protocol

QRCode::set_mode() — Method in class QRCode

Set the mode for rendering an image (inline|external) inline rendering src=data:image/png;base64 external create link relative or with domain

QRCode::set_error_level() — Method in class QRCode

Set the QR_ECLEVEL default is QR_ECLEVEL_M Constants speciffy ECC level from lowest L to the highest H Higher levels are recomended for Outdoor-presented codes, but generates bigger codes.

Reactions::set() — Method in class Reactions

Set Variable / Option

Reactions::setCompactMode() — Method in class Reactions

Reactions::setDocumentIndexId() — Method in class Reactions

$ Table#start — Property in class Table

$ Table#sql_order_fields — Property in class Table

$ Table#show_table_options — Property in class Table

$ Table#show_optional_fields — Property in class Table

$ Table#show_record_count — Property in class Table

Table::set_params() — Method in class Table

Table::set_grouping() — Method in class Table

Table::setVisibleFields() — Method in class Table

Set cols to be visible in output

Table::setHiddenFields() — Method in class Table

Set cols to be hidden in output

Table::set_order() — Method in class Table

Table::set_cache() — Method in class Table

Allow use of Caches (e.g. Query Cache)

Table::set_limit() — Method in class Table

Table::set_column_format() — Method in class Table

Set formatting parameters for each column

Table::set_column_attributes() — Method in class Table

Table::set_column_responsive() — Method in class Table

Set Responsive COLs (Other cols wil be hidden if given responsive level is reached)

Table::set_column_class() — Method in class Table

Table::set_column_tooltips() — Method in class Table

Table::set_additional_data_callback() — Method in class Table

Registered a callback that will be called after the rows have been limited, passing the resulting row array as it's only parameter. The return of the callback can be used in any low-prio callback using the field 'field:_additional_data'. You should use this callback to load additional information required in the table that for some reason cannot be loaded in the fillby* Method, for example because you are using models and the data is from a foreign table.

Table::setExportFieldManipulatorCallback() — Method in class Table

Sets a callback or closure to manipulate the $this->filter_field array after the array has been initially build during an export action ($this->>action = "export").

Table::set_export_filter() — Method in class Table

set all fields that shall be exported

TableEditor::setFieldsFromModel() — Method in class TableEditor

Use a model to automatically setup an CRUD Editor for this model

TableEditor::setParam() — Method in class TableEditor

Set/overwrite a single param

TableEditor::set_params() — Method in class TableEditor

TableEditor::set_field_params() — Method in class TableEditor

Adds/Changes a field definition

TableEditor::set_action() — Method in class TableEditor

TableEditor::set_primary_key() — Method in class TableEditor

TableEditor::set_primary_key_column() — Method in class TableEditor

set primary key column

TableEditor::set_no_add_link() — Method in class TableEditor

hide add link

TableEditor::set_no_delete_link() — Method in class TableEditor

hide delete link

TableEditor::set_no_edit_link() — Method in class TableEditor

hide edit link

TableEditor::set_grouping() — Method in class TableEditor

set grouping

TableEditor::set_order_field() — Method in class TableEditor

set order field

TableEditor::set_limit() — Method in class TableEditor

set limit for Pagination

TableEditor::set_order_fields() — Method in class TableEditor

set order field

TableEditor::set_join() — Method in class TableEditor

set join statement

TableEditor::set_where() — Method in class TableEditor

set where statement

TableEditor::set_filter_fields() — Method in class TableEditor

You can add a simple filter to allow the user to filter the overview table by a certain keyword.

TableEditor::set_callbacks() — Method in class TableEditor

set callbacks

TableEditor::set_web_dir() — Method in class TableEditor

set web directory location (storage path)

TableEditor::set_download_handler() — Method in class TableEditor

set download handler (Where to download a file)

TableEditor::set_record_label() — Method in class TableEditor

TableRow::set_fieldformat() — Method in class TableRow

TableRow::set_field() — Method in class TableRow

TableRow::set_field_attributes() — Method in class TableRow

TableRow::set_row_attributes() — Method in class TableRow

TableActionHandler::setSelectField() — Method in class TableActionHandler

Which table field contains your selection context? (e.g. id for standard model collection)

TableActionHandler::setSelectedIds() — Method in class TableActionHandler

Set the ids which are currently selected in table, this is usually done automatically in the table during action processing

Tabs::set_uid() — Method in class Tabs

Tabs::set_tabstyle() — Method in class Tabs

Set Tabs to be positioned differently

Tabs::select_tab() — Method in class Tabs

Tabs::setHideHeading() — Method in class Tabs

Tabs::setIsCollapsible() — Method in class Tabs

Tabs::setStartCollapsed() — Method in class Tabs

TimeLine::set_year() — Method in class TimeLine

Set the default year to show

TimeLine::set_start_date() — Method in class TimeLine

TimeLine::set_end_date() — Method in class TimeLine

TimeLine::set_height() — Method in class TimeLine

Set Timeline height

TimeLine::set_initial_zoom() — Method in class TimeLine

$ Tree#sort_field — Property in class Tree

Table field used for sorting of items, set to e.g. 'sort' to enable sorting of items

Tree::setCurrentId() — Method in class Tree

Tree::set_option() — Method in class Tree

Set a Tree Option

Tree::set_selected() — Method in class Tree

Declare already selected nodes

Tree::set_table() — Method in class Tree

Tree::set_model() — Method in class Tree

Define the model to get tree information from

Tree::set_max_levels() — Method in class Tree

Tree::set_start_levels() — Method in class Tree

Tree::setRootPid() — Method in class Tree

Setter for the root id

Tree::set_caption_i18n() — Method in class Tree

Set Caption Label (i18n Mode)

Tree::set_caption() — Method in class Tree

Set Caption Label

$ UserImage#show_status — Property in class UserImage

Whether to show the user online status or not.

$ UserImage#show_menu — Property in class UserImage

Whether to show the user shortprofile menu when clicking image

$ UserImage#size — Property in class UserImage

UserImage::setUserId() — Method in class UserImage

UserImage::setShowStatus() — Method in class UserImage

UserImage::setHeight() — Method in class UserImage

UserImage::setWidth() — Method in class UserImage

VCard::setShowOnlineStatus() — Method in class VCard

VCard::setShowStatusProperties() — Method in class VCard

Allows to show/hide all advanced status properties in the vcard

VCard::setColumns() — Method in class VCard

VCard::setUserAdditionalProperties() — Method in class VCard

$ ViewModeSwitcher#selected_viewmode — Property in class ViewModeSwitcher

Set to overwrite the selected user setting.

ViewModeSwitcher::setSelectedViewmode() — Method in class ViewModeSwitcher

ViewModeSwitcher::setViewModes() — Method in class ViewModeSwitcher

Which viewmodes should be selectable by the user?

ViewModeSwitcher::setTargetContainer() — Method in class ViewModeSwitcher

Define the dom elements which should be affected by class changes when user switches viewmodes

$ Wizard#stepContentCallbacks — Property in class Wizard

Wizard::set_final_callback() — Method in class Wizard

put your comment there.

Wizard::set_ajax_update_interval() — Method in class Wizard

Sets the interval for periodical update of ajax container.

Wizard::set_model() — Method in class Wizard

put your comment there.

User::salt_password() — Method in class User

Salt a password

User::set_session_auth_method() — Method in class User

Get the current Auth Method for this session

User::set() — Method in class User

Save a user setting (Duration: Session Lifetime) return void

User::set_setting() — Method in class User

Save a user setting (Duration: User Lifetime) return void

User::set_message() — Method in class User

Sets a user message

User::set_group_policy() — Method in class User

User::set_policy() — Method in class User

User::set_user_policy() — Method in class User

User::set_xf_user_mode() — Method in class User

this function sets the XF mode to USER and sets the used user to given id

User::switchUser() — Method in class User

Switches the currently logged in user to the selected user.

User::setTempSecurityGroupId() — Method in class User

With this method you can set a temporary user group for this user This will automatically invalidate existing policy cache

View::show_update_page() — Method in class View

View::show_login() — Method in class View

Show Login Dialog

View::show_pw_change() — Method in class View

Show Password Change Dialog

View::set_current_module() — Method in class View

Force currently executed main module

AdSyncController::synchronizeUsers() — Method in class AdSyncController

Synchronize AD User Information with XELOS system users

$ Model#synch_status — Property in class Model

Model::synch_status() — Method in class Model

$ AdCache#samaccountname: — Property in class AdCache

stored in MySQL as varchar

SynchStatus — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated\Model

This file provides property and method documentation for the model synch_status.

$ SynchStatus#samaccountname: — Property in class SynchStatus

stored in MySQL as varchar

AdCache::set_groups() — Method in class AdCache

SynchStatus — Class in namespace XELOS\Modules\AdSync\Model

SystemCron — Class in namespace XELOS\Modules\AdSync

$ Page#simple_groups — Property in class Page

Page::simple_groups() — Method in class Page

LanguageSettingLanguageConfig::setUserId() — Method in class LanguageSettingLanguageConfig

Indicates the user_id, to which these language settings will be applied

UserGroupsUserAdminConfig::setLimitToTenant() — Method in class UserGroupsUserAdminConfig

$ UserSecurityUserConfig#showInAdminContext — Property in class UserSecurityUserConfig

LanguageConfigInterface::setUserId() — Method in class LanguageConfigInterface

Indicates the user_id, to which these language settings will be applied

$ UserAdminConfig#showInAdminContext — Property in class UserAdminConfig

UserAdminConfig::setAdminContext() — Method in class UserAdminConfig

Set if tab called from admin

UserAdminConfig::setUserId() — Method in class UserAdminConfig

UserAdminConfig::setTabId() — Method in class UserAdminConfig

UserAdminConfig::saveData() — Method in class UserAdminConfig

Can be used for saving/processing data. Wraps process for additional flash messages

UserAdminConfig::showInSidebar() — Method in class UserAdminConfig

UserExportBase::setUserScope() — Method in class UserExportBase

UserExportBase::setPropertyIdentifierScope() — Method in class UserExportBase

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

SimpleGroupsPage — Class in namespace XELOS\Modules\Administration\Page

SystemCron — Class in namespace XELOS\Modules\Administration

Class SystemCron

SystemCronTest — Class in namespace XELOS\Modules\Administration\Tests\Codeception\Unit

UserList::setUserCollection() — Method in class UserList

Set UserCollection for this UI List

UserList::setAdditionalActionLinksTop() — Method in class UserList

The handlers to the links.

UserList::setAdditionalActionLinksBottom() — Method in class UserList

The handlers to the links.

UserList::setDefaultFacetGroupId() — Method in class UserList

UploadDocumentProcessor::show_upload() — Method in class UploadDocumentProcessor

StorageProvider — Class in namespace XELOS\Modules\ApiCloudstorage\Hook

Class StorageProvider

StorageContent — Class in namespace XELOS\Modules\ApiCloudstorage\Lib

Class StorageContent

SearchMessagesSearchIntegration — Class in namespace XELOS\Modules\ApiMicrosoft\Hook\Search

$ MicrosoftOauthClient#scope — Property in class MicrosoftOauthClient

$ OnedriveOauthClient#scope — Property in class OnedriveOauthClient

Subscription — Class in namespace XELOS\Modules\ApiMicrosoft\Model

OpenidAuthentication::setOAuthInfo() — Method in class OpenidAuthentication

OpenidAuthentication::setUserInfo() — Method in class OpenidAuthentication

$ OpenidOauthClient#scope — Property in class OpenidOauthClient

$ Page#slo — Property in class Page

Page::slo() — Method in class Page

SamlAuthentication — Class in namespace XELOS\Modules\AuthSaml\Hook\System

SloPage — Class in namespace XELOS\Modules\AuthSaml\Page

Class Single Logout Service

$ Action#settings — Property in class Action

$ Action#sync_events — Property in class Action

Action::settings() — Method in class Action

Action::sync_events() — Method in class Action

$ Model#static_calendar — Property in class Model

$ Model#sync_data — Property in class Model

$ Model#sync_setting — Property in class Model

Model::static_calendar() — Method in class Model

Model::sync_data() — Method in class Model

Model::sync_setting() — Method in class Model

$ Calendar#shared: — Property in class Calendar

stored in MySQL as tinyint

$ Calendarset#subscribed_calendars: — Property in class Calendarset

stored in MySQL as text

$ Event#start_date: — Property in class Event

stored in MySQL as date

$ Event#start: — Property in class Event

stored in MySQL as timestamp

$ Event#sync_id: — Property in class Event

stored in MySQL as text

$ Reminder#start: — Property in class Reminder

stored in MySQL as timestamp

SyncData — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model sync_data.

$ SyncData#sync_setting_id — Property in class SyncData

$ SyncData#sync_data: — Property in class SyncData

stored in MySQL as mediumblob

SyncSetting — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\Model

This file provides property and method documentation for the model sync_setting.

$ SyncSetting#sync_status: — Property in class SyncSetting

enum initial|running|idle

$ Page#show — Property in class Page

$ Page#staging — Property in class Page

Page::show() — Method in class Page

Page::staging() — Method in class Page

$ Component#sort — Property in class Component

$ ComponentLive#sort — Property in class ComponentLive

$ HistoryComponent#sort — Property in class HistoryComponent

$ PageLive#sort — Property in class PageLive

CommentsController::set_current_post() — Method in class CommentsController

CommentsController::set_current_document_index() — Method in class CommentsController

Set Document Index ID of Referring Document This is required for can_read_comments() checks when there is no comment yet

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

Comment::save() — Method in class Comment

Comment::setCommentFromHTML() — Method in class Comment

Set comment coming from WYSIWYG

Comment::set_render_attachments() — Method in class Comment

Sets whether the attachments should be rendered or not.

LinkInfo::save() — Method in class LinkInfo

CrmSync::set_field_values() — Method in class CrmSync

Set the values in source

SelectorBrowser — Class in namespace XELOS\Modules\DMS\Hook\Selector

Class XELOS\Modules\DMS\Hook\Selector\xm_dms_selector_browser

SavePayloadAction — Class in namespace XELOS\Modules\DMS\Hook\Workflows

Class SavePayloadAction

SystemCron — Class in namespace XELOS\Modules\DMS

SearchMetaData — Class in namespace XELOS\Modules\Doclink\Hook\Search

SocialActivityCollector — Class in namespace XELOS\Modules\Doclink\Hook\SystemStats

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

CategoryCollection::search_all_by_pid() — Method in class CategoryCollection

$ Page#setup — Property in class Page

Page::setup() — Method in class Page

$ EventDocumentation#street: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#start: — Property in class EventDocumentation

stored in MySQL as timestamp

$ EventDocumentation#send_attachment2: — Property in class EventDocumentation

stored in MySQL as tinyint

$ EventDocumentation#send_attachment3: — Property in class EventDocumentation

stored in MySQL as tinyint

$ JobDocumentation#status: — Property in class JobDocumentation

enum waiting|running|finished|error

$ ParticipantDocumentation#status: — Property in class ParticipantDocumentation

stored in MySQL as tinyint

$ ParticipantDocumentation#status_text: — Property in class ParticipantDocumentation

stored in MySQL as varchar

PayloadParticipantPayload::show_payload() — Method in class PayloadParticipantPayload

Event::save() — Method in class Event

Event::startApiMailJobProcessing() — Method in class Event

Tells system_api_mail to start sending invites

Participant::save() — Method in class Participant

Participant::send_invite() — Method in class Participant

sends invitation for event to invitee.

Participant::sendMessage() — Method in class Participant

Sends a message to all participants in the given statuses.

Participant::set_new_status() — Method in class Participant

Sets status of participant and send notification if status has changed

Participant::send_confirmation() — Method in class Participant

Participant::start_workflow() — Method in class Participant

SetupPage — Class in namespace XELOS\Modules\Eventplanner\Page

SystemCron — Class in namespace XELOS\Modules\Eventplanner

Class SystemCron

Details::setIsDocumentPreview() — Method in class Details

Details::setParticipant() — Method in class Details

CategoryCollection::search_all_by_p_id() — Method in class CategoryCollection

$ Page#setup — Property in class Page

$ Page#show — Property in class Page

Page::setup() — Method in class Page

Page::show() — Method in class Page

$ CategoryDocumentation#sort — Property in class CategoryDocumentation

$ ThreadDocumentation#state: — Property in class ThreadDocumentation

enum open|closed|sticky|sticky_closed

ForumController::send_file() — Method in class ForumController

ForumController::setParentDocumentIndex() — Method in class ForumController

Set Document Index ID of Referring Document.

ForumController::sanitizeContent() — Method in class ForumController

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

ThreadPayload::show_payload() — Method in class ThreadPayload

Show form

Category::save() — Method in class Category

Post::save() — Method in class Post

Save post

Post::set_parent() — Method in class Post

Post::set_content_html() — Method in class Post

Post::setSanitizedContent() — Method in class Post

Sanitizes and sets the Post content_html (with sanitized HTML) and content_plain (converted to Markdown).

Thread::save() — Method in class Thread

Save thread

Thread::set_parent() — Method in class Thread

Thread::setSanitizedContent() — Method in class Thread

Sanitizes and sets the Post content_html (with sanitized HTML) and content_plain (converted to Markdown).

SetupPage — Class in namespace XELOS\Modules\Forum\Page

Class SetupPage

ShowPage — Class in namespace XELOS\Modules\Forum\Page

ShowPage::show_category() — Method in class ShowPage

ShowPage::show_thread() — Method in class ShowPage

SystemCron — Class in namespace XELOS\Modules\Forum

Class SystemCron

ForumCest::startDiscussionAsCreator() — Method in class ForumCest

ParticipantRole::shouldSee() — Method in class ParticipantRole

Step — Class in namespace XELOS\Modules\Forum\Tests\Codeception\Support

Class Step

$ Step#startRoute — Property in class Step

$ Step#showCategoryRoute — Property in class Step

Step::switchToStartPage() — Method in class Step

Step::switchCategory() — Method in class Step

Step::switchToDiscussion() — Method in class Step

VoteBox::set_thread_id() — Method in class VoteBox

VoteBox::set_vote_value() — Method in class VoteBox

VoteBox::set_render_value_only() — Method in class VoteBox

If this method is called, it will only render the vote value without the control elements.

VoteBox::set_thread() — Method in class VoteBox

Set Thread the vote is referecing

GeodbController::setGeoFeatureLocationForDocumentIndex() — Method in class GeodbController

$ GeoFeature#street — Property in class GeoFeature

$ Location#specifications — Property in class Location

MapLocation::setLocationCollection() — Method in class MapLocation

MapLocation::setCustomDataCallback() — Method in class MapLocation

Setter for the custom callback.

MapLocation::setInitialZoom() — Method in class MapLocation

TaskListCollection::search_all_by_group_id() — Method in class TaskListCollection

$ TaskDocumentation#status: — Property in class TaskDocumentation

stored in MySQL as varchar

$ TaskDocumentation#sort — Property in class TaskDocumentation

ShowTasksShowPortlet — Class in namespace XELOS\Modules\GroupsTasks\Hook\Portal

SystemCron — Class in namespace XELOS\Modules\GroupsTasks

Template::setupCommandDefinitions() — Method in class Template

$ Page#search — Property in class Page

Page::search() — Method in class Page

$ Invitation#sender_id — Property in class Invitation

$ Module#sort — Property in class Module

$ Newsletter#status: — Property in class Newsletter

stored in MySQL as varchar

$ Newsletter#sender_name: — Property in class Newsletter

stored in MySQL as varchar

$ Newsletter#sender_email: — Property in class Newsletter

stored in MySQL as varchar

$ Newsletter#subject: — Property in class Newsletter

stored in MySQL as varchar

$ Newsletter#scheduled_at: — Property in class Newsletter

stored in MySQL as datetime

ApiModuleService::setupMethods() — Method in class ApiModuleService

Define and return your webservice methods.

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

SetInactiveAndNotifyJob — Class in namespace XELOS\Modules\Groups\Infrastructure\Job

Webservice::setupMethods() — Method in class Webservice

$ Page#status — Property in class Page

Page::status() — Method in class Page

$ JobDocumentation#status: — Property in class JobDocumentation

enum new|processing|finished|canceled|error

$ JobDocumentation#status_message: — Property in class JobDocumentation

stored in MySQL as varchar

$ JobDocumentation#status_progress — Property in class JobDocumentation

$ JobDocumentation#scheduled_at: — Property in class JobDocumentation

stored in MySQL as datetime

$ JobDocumentation#started_at: — Property in class JobDocumentation

stored in MySQL as datetime

$ JobHistoryDocumentation#status: — Property in class JobHistoryDocumentation

enum new|processing|finished|canceled|error

$ JobHistoryDocumentation#status_message: — Property in class JobHistoryDocumentation

stored in MySQL as varchar

$ JobHistoryDocumentation#status_progress — Property in class JobHistoryDocumentation

$ JobHistoryDocumentation#scheduled_at: — Property in class JobHistoryDocumentation

stored in MySQL as datetime

$ JobHistoryDocumentation#started_at: — Property in class JobHistoryDocumentation

stored in MySQL as datetime

JobScheduler::scheduleRetry() — Method in class JobScheduler

JobScheduler::scheduleJob() — Method in class JobScheduler

Schedules the passed job in the queue

JobStatus::setStatus() — Method in class JobStatus

JobStatus::setStatusMessage() — Method in class JobStatus

JobStatus::setProgress() — Method in class JobStatus

JobStatus::setErrorMessage() — Method in class JobStatus

$ TestJob#subject — Property in class TestJob

JobQueueController::scheduler() — Method in class JobQueueController

Schedules a Background object for execution

Job::save() — Method in class Job

Saves if no unique id collision exists.

StatusPage — Class in namespace XELOS\Modules\JobQueue\Page

SystemDaemon — Class in namespace XELOS\Modules\JobQueue

$ SystemDaemon#sleep_between_process — Property in class SystemDaemon

JobUIStatus::setOnFinishMessage() — Method in class JobUIStatus

Sets a message which is being shown when the job has finished instead of the default message Can be used to display a custom link or action

JobUIStatus::setOnFinishJavascript() — Method in class JobUIStatus

Sets a javascript which is being executed when the job has finished Can be used to reload a view or container

$ PageDocumentation#summary_i18n: — Property in class PageDocumentation

stored in MySQL as text

FormprocessorAction::set_fdl() — Method in class FormprocessorAction

FormprocessorEmailAction::setList() — Method in class FormprocessorEmailAction

CategoryCollection::search_by_id() — Method in class CategoryCollection

$ Page#settings — Property in class Page

Page::settings() — Method in class Page

$ CategoryDocumentation#sort — Property in class CategoryDocumentation

$ ListDocumentation#start_status_id — Property in class ListDocumentation

$ ListDocumentation#show_workflow_status: — Property in class ListDocumentation

stored in MySQL as tinyint

$ ListItemDocumentation#status_id — Property in class ListItemDocumentation

$ ListStatusDocumentation#sort: — Property in class ListStatusDocumentation

stored in MySQL as tinyint

Service — Class in namespace XELOS\Modules\Lists\Hook\Base\Field\Resource

SectionBreak — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Select — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Slider — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

StaticText — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

AbstractPortletContext::setMod() — Method in class AbstractPortletContext

AbstractPortletContext::setConfig() — Method in class AbstractPortletContext

DateContext::setConfig() — Method in class DateContext

ProgressContext::setConfig() — Method in class ProgressContext

TemplateContext::setConfig() — Method in class TemplateContext

ApiService::setupMethods() — Method in class ApiService

ListItemPayload::storage_path() — Method in class ListItemPayload

return _files storage path for payload

ListItemPayload::show_payload() — Method in class ListItemPayload

Show form

ListItemPayload::set_payload_property() — Method in class ListItemPayload

Set payload property

SetFieldAction — Class in namespace XELOS\Modules\Lists\Hook\Workflows

Workflow action hook to change the value of a field in the list item payload.

ShowFormAction — Class in namespace XELOS\Modules\Lists\Hook\Workflows

ListsController::setUseFolders() — Method in class ListsController

Category::save() — Method in class Category

Category::scope_by_id() — Method in class Category

$ ListItem#status_id — Property in class ListItem

$ ListItem#start_at — Property in class ListItem

Timespan value to start at

ListItem::setListProperties() — Method in class ListItem

The list can be set to prevent an additional call to the database to access the list.

ListItem::save() — Method in class ListItem

Loops through all form fields and sets:

• the status_id of the list item if a list_status form element is in the form definition
• the assigned_user_ids of the list item if assigned_users form elements are defined in the form definition.

$ ListProperties#show_workflow_status — Property in class ListProperties

Shows the workflow status instead of the list status

ListProperties::set_status_pop_data() — Method in class ListProperties

The status pop data can be set to prevent an additional call to the database to access the statuses multiple times.

ListProperties::set_default_status() — Method in class ListProperties

ListProperties::save() — Method in class ListProperties

$ ListStatus#sort — Property in class ListStatus

: stored in MySQL as tinyint

ListStatus::save() — Method in class ListStatus

Makes sure that the currently saved status is the only with default=1.

SettingsPage — Class in namespace XELOS\Modules\Lists\Page

CategorySelector::setCategories() — Method in class CategorySelector

CategorySelector::setRenderMode() — Method in class CategorySelector

CategorySelector::setListInteractivityLevel() — Method in class CategorySelector

Set XUI to act as readonly, hiding all list actions and hide inactive lists

ItemEditor::setList() — Method in class ItemEditor

ItemEditor::setIsReadOnly() — Method in class ItemEditor

Set XUI to act as readonly, hiding all actions

ItemEditor::setItem() — Method in class ItemEditor

ItemEditor::setPreset() — Method in class ItemEditor

ItemEditor::setIsAdminViewMode() — Method in class ItemEditor

ItemList::setList() — Method in class ItemList

ItemList::setTable() — Method in class ItemList

ItemList::setViewMode() — Method in class ItemList

ItemList::setIsReadOnly() — Method in class ItemList

Set XUI to act as readonly, hiding all actions

ItemList::setShowFacetedFilters() — Method in class ItemList

ItemList::setListItems() — Method in class ItemList

ListPortlet::setPortletTitle() — Method in class ListPortlet

ListPortlet::setSelectedCategory() — Method in class ListPortlet

ListPortlet::setMaxParentCategory() — Method in class ListPortlet

ListPortlet::setListActionMode() — Method in class ListPortlet

ProfileCollection::storeCondition() — Method in class ProfileCollection

This method is purely optional and stores a condition that can be applied and reversed whenever needed.

ProfileCollection::search_all_by_pid() — Method in class ProfileCollection

ProfileCollection::search_by_id() — Method in class ProfileCollection

$ Profile#sort — Property in class Profile

$ Property#shortname: — Property in class Property

stored in MySQL as varchar

$ Property#sort: — Property in class Property

stored in MySQL as tinyint

$ Property#searchable: — Property in class Property

stored in MySQL as tinyint

$ Property#showstatus: — Property in class Property

stored in MySQL as tinyint

$ Property#searchinfo: — Property in class Property

stored in MySQL as tinyint

$ PropertyGroup#shortname: — Property in class PropertyGroup

stored in MySQL as varchar

$ PropertyTab#sort — Property in class PropertyTab

$ PropertyTabGroup#sort — Property in class PropertyTabGroup

Checkbox::shapeFieldSearchParams() — Method in class Checkbox

Select — Class in namespace XELOS\Modules\Lookbook\Fields

Select::shapeFieldSearchParams() — Method in class Select

SystemHierarchy — Class in namespace XELOS\Modules\Lookbook\Fields

SystemUser — Class in namespace XELOS\Modules\Lookbook\Fields

SystemUserGroup — Class in namespace XELOS\Modules\Lookbook\Fields

The system User Group field allows users to select security groups to be a member of.

SystemUserMeta — Class in namespace XELOS\Modules\Lookbook\Fields

Tagging::shapeFieldSearchParams() — Method in class Tagging

UserSelector::shapeFieldSearchParams() — Method in class UserSelector

Webservice::setupMethods() — Method in class Webservice

Define and return your webservice methods.

FieldInterface::shapeFieldSearchParams() — Method in class FieldInterface

Brings the user input into proper shape after entering them in the advanced search form.

FieldTrait::shapeFieldSearchParams() — Method in class FieldTrait

ArticleCollection::scope_by_category_id() — Method in class ArticleCollection

CategoryCollection::scope_by_id() — Method in class CategoryCollection

$ Page#setup — Property in class Page

Page::setup() — Method in class Page

$ ArticleDocumentation#status: — Property in class ArticleDocumentation

enum draft|published

$ ArticleDocumentation#summary_i18n: — Property in class ArticleDocumentation

stored in MySQL as text

$ ArticleDocumentation#show_attachments: — Property in class ArticleDocumentation

enum do not show|gallery|all attachments|files only

$ ArticleDocumentation#show_carousel: — Property in class ArticleDocumentation

stored in MySQL as tinyint

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

ArticlePayload::show_payload() — Method in class ArticlePayload

Show article

Article::set_property() — Method in class Article

Overwrite default setproperty to allow storing of fs properties

Article::save() — Method in class Article

SettingsPage — Class in namespace XELOS\Modules\News\Page

SetupPage — Class in namespace XELOS\Modules\News\Page

ArticleList::setArticleCollection() — Method in class ArticleList

The articles that should be displayed

ArticleList::setViewMode() — Method in class ArticleList

The view mode (VIEW_MODE_BOX | VIEW_MODE_LIST)

ArticleList::setCurrentPage() — Method in class ArticleList

Sets the current page of the external paginantion.

ArticleList::setIsFiltered() — Method in class ArticleList

Sets, if the current model collection is "filtered".

ViewArticleRead::set_document() — Method in class ViewArticleRead

ViewArticleWrite::set_document() — Method in class ViewArticleWrite

PageCollection::search_all_by_type() — Method in class PageCollection

PageCollection::search_all_by_pid() — Method in class PageCollection

$ Page#show — Property in class Page

Page::show() — Method in class Page

$ PageDocumentation#summary_i18n: — Property in class PageDocumentation

stored in MySQL as text

$ PageDocumentation#sort — Property in class PageDocumentation

$ PageVersionDocumentation#status: — Property in class PageVersionDocumentation

enum draft|review|published|history

ApiService::setupMethods() — Method in class ApiService

JsonPathElement::setValue() — Method in class JsonPathElement

Set a JSON element value to the specified value {a: {b: 'Test'}} --> setValue('$.a', 'b', 'Test')

PageJsonProcessor::setJsonObject() — Method in class PageJsonProcessor

PageJsonProcessor::signConfiguration() — Method in class PageJsonProcessor

Adds a cryptographic signature to all component configurations which require it for a secure backend options transport

Component::save() — Method in class Component

$ Page#summary_i18n — Property in class Page

$ Page#sort — Property in class Page

Page::setPermissionsForChildren() — Method in class Page

Page::save() — Method in class Page

Page::saveRaw() — Method in class Page

Save without checks - used for import

$ PageVersion#status — Property in class PageVersion

PageVersion::saveRaw() — Method in class PageVersion

Executes the save without updating attachment links during the pages import.

PageVersion::save() — Method in class PageVersion

ShowPage — Class in namespace XELOS\Modules\Pages\Page

Class Overview

SystemCron — Class in namespace XELOS\Modules\Pages

$ PageRenderer#selectedLocale — Property in class PageRenderer

PageRenderer::setPageVersion() — Method in class PageRenderer

Sets the page version model which should be rendered

PageRenderer::setPropertiesForPreview() — Method in class PageRenderer

Set to TRUE to allow overwriting the page config and title via POST (used for realtime page preview) We only allow overwrite on editor page to avoid XSS / Injections on public pages

PageRenderer::setLocales() — Method in class PageRenderer

Sets the locale(s) for this page. If multiple locales are passed the first matching will be displayed

SelectorBrowser — Class in namespace XELOS\Modules\PersonalWorkspace\Hook\Selector

Class SelectorBrowser

Workspace::set_quota_size() — Method in class Workspace

Sets the quota size in megabytes.

ReadConfirmationController::sendReadConfirmation() — Method in class ReadConfirmationController

Report::setDocumentIndex() — Method in class Report

Which document you like the report for?

Report::setConfirmationRequest() — Method in class Report

Have this model already loaded?.. pass it to the ui to avoid another load

ElasticSearchAdapter::search() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::setMod() — Method in class ElasticSearchAdapter

Used during Module Transition to allow a partial move to new Adapter Design

$ Model#search_history — Property in class Model

$ Model#searchagent — Property in class Model

Model::search_history() — Method in class Model

Model::searchagent() — Method in class Model

$ Page#searchagent — Property in class Page

$ Page#settings — Property in class Page

$ Page#suggest — Property in class Page

Page::searchagent() — Method in class Page

Page::settings() — Method in class Page

Page::suggest() — Method in class Page

$ FacetedFilterDocumentation#short_id: — Property in class FacetedFilterDocumentation

stored in MySQL as varchar

$ FacetedFilterDocumentation#sort — Property in class FacetedFilterDocumentation

$ FacetedFilterDocumentation#sticky: — Property in class FacetedFilterDocumentation

stored in MySQL as tinyint

SearchHistoryDocumentation — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\Model

This file provides property and method documentation for the model SearchHistory.

SearchagentDocumentation — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Searchagent.

SearchControllerDocumentation — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

SearchIntegrationException — Class in namespace XELOS\Modules\Search\Exception

SearchIntegration — Class in namespace XELOS\Modules\Search\Hook\Base

Abstract Class for Search Adapters

SearchMetaData — Class in namespace XELOS\Modules\Search\Hook\Base

Field::setIsFacet() — Method in class Field

Field::setIsSortable() — Method in class Field

Field::setLabel() — Method in class Field

Field::setKey() — Method in class Field

SearchPreprocessor — Class in namespace XELOS\Modules\Search\Hook\Base

SearchDocumentBrowser — Class in namespace XELOS\Modules\Search\Hook\Selector\Component

Class SearchDocumentBrowser

SearchSelectorBrowser — Class in namespace XELOS\Modules\Search\Hook\Selector

Class SearchSelectorBrowser

SearchCheck — Class in namespace XELOS\Modules\Search\Hook\SystemStatus

ApiService::setupMethods() — Method in class ApiService

ApiService::search() — Method in class ApiService

Searches for the given query.

SearchAdapterInterface — Class in namespace XELOS\Modules\Search\Interfaces

Interface Class for Search Adapters

SearchDocumentInterface — Class in namespace XELOS\Modules\Search\Interfaces

Interface SearchDocumentInterface

SearchMetaDataInterface — Class in namespace XELOS\Modules\Search\Interfaces

Interface SearchMetaDataInterface

DocumentElasticsearch::save() — Method in class DocumentElasticsearch

SearchHistory — Class in namespace XELOS\Modules\Search\Model

Class SearchHistory

SearchHistory::save() — Method in class SearchHistory

Updates the search history entry for the user and the search term.

Searchagent — Class in namespace XELOS\Modules\Search\Model

SearchagentPage — Class in namespace XELOS\Modules\Search\Page

SearchagentPage::searchagent_table_cb_result_count() — Method in class SearchagentPage

SearchagentPage::searchagent_table_cb() — Method in class SearchagentPage

SettingsPage — Class in namespace XELOS\Modules\Search\Page

SuggestPage — Class in namespace XELOS\Modules\Search\Page

SearchController — Class in namespace XELOS\Modules\Search

Class SearchController This module uses an index to show search results. The index is based on Lucene or mySQL

$ SearchController#searchAdapter — Property in class SearchController

$ SearchController#search_engine — Property in class SearchController

SearchIndexContentRecord — Class in namespace XELOS\Modules\Search

$ SearchIndexContentRecord#summary — Property in class SearchIndexContentRecord

SearchIndexContentRecord::setTitle() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::setSummary() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::setIndexContent() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::setLocale() — Method in class SearchIndexContentRecord

SearchIndexContentRecord::setIsAutoTranslated() — Method in class SearchIndexContentRecord

Set to true if this Content has not been translated by humans

SearchIndexRecord — Class in namespace XELOS\Modules\Search

$ SearchIndexRecord#summary — Property in class SearchIndexRecord

SearchIndexRecord::setTitle() — Method in class SearchIndexRecord

SearchIndexRecord::setUrl() — Method in class SearchIndexRecord

SearchIndexRecord::setSummary() — Method in class SearchIndexRecord

SearchIndexRecord::setIndexContent() — Method in class SearchIndexRecord

SearchIndexRecord::setLocale() — Method in class SearchIndexRecord

SearchIndexRecord::setAttachments() — Method in class SearchIndexRecord

SearchIndexRecord::setNormalizedAttachments() — Method in class SearchIndexRecord

SearchIndexRecord::setNormalizedAttachment() — Method in class SearchIndexRecord

SearchIndexRecord::setRelatedPostId() — Method in class SearchIndexRecord

SearchIndexRecord::setTags() — Method in class SearchIndexRecord

SearchIndexRecord::setPreProcessingData() — Method in class SearchIndexRecord

Used by Pre-Processing Logic to store / get additional data during indexing

SearchIndexRecord::setRemoveFromIndex() — Method in class SearchIndexRecord

Mark this Index Record for deletion during indexing process

SearchIndexRecord::setMetaData() — Method in class SearchIndexRecord

Set additional meta data which allows to filter the search results by additional faceted filters.

SearchUpdateRecord — Class in namespace XELOS\Modules\Search

SearchUpdateRecord::setMetaData() — Method in class SearchUpdateRecord

Set additional meta data which allows to filter the search results by additional faceted filters.

SearchUpdateRecord::setProperty() — Method in class SearchUpdateRecord

Set an additional property in the index.

SystemCron — Class in namespace XELOS\Modules\Search

SystemCron::search_agent_notifications() — Method in class SystemCron

ResultPanel::setSearchterm() — Method in class ResultPanel

SearchIntegrationResultPanel — Class in namespace XELOS\Modules\Search\UI

SearchIntegrationResultPanel::setSearchTerm() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::setSearchIndexRecords() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::setSearchIndexCount() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::setPaging() — Method in class SearchIntegrationResultPanel

SearchIntegrationResultPanel::setIntegrationHook() — Method in class SearchIntegrationResultPanel

TabsTrait::setTabs() — Method in class TabsTrait

$ AbstractBrowserItem#size — Property in class AbstractBrowserItem

$ AbstractBrowserItem#source — Property in class AbstractBrowserItem

$ AbstractBrowserItem#selectable — Property in class AbstractBrowserItem

AbstractBrowserItem::set_size() — Method in class AbstractBrowserItem

Sets the site of this file in bytes.

AbstractBrowserItem::set_author() — Method in class AbstractBrowserItem

Sets the author for this item.

AbstractBrowserItem::set_source() — Method in class AbstractBrowserItem

Sets the source location of this item.

AbstractBrowserItem::set_id() — Method in class AbstractBrowserItem

Sets the identifier for this item.

AbstractBrowserItem::set_name() — Method in class AbstractBrowserItem

Sets the name of this item.

AbstractBrowserItem::set_thumbnail_url() — Method in class AbstractBrowserItem

Sets the thumbnail url of this item.

AbstractBrowserItem::set_selectable() — Method in class AbstractBrowserItem

Sets the selectable status for this item.

AbstractBrowserItem::set_created_at() — Method in class AbstractBrowserItem

Sets the creation time.

AbstractBrowserItem::set_modified_at() — Method in class AbstractBrowserItem

Sets the modification time.

$ AbstractDocumentBrowser#show_operation_options — Property in class AbstractDocumentBrowser

AbstractDocumentBrowser::setConfirmMessageForPassiveLink() — Method in class AbstractDocumentBrowser

AbstractDocumentBrowser::setConfirmMessageForReferenceLink() — Method in class AbstractDocumentBrowser

AbstractDocumentBrowser::setConfirmMessageForCopy() — Method in class AbstractDocumentBrowser

AbstractDocumentBrowser::set_mode() — Method in class AbstractDocumentBrowser

Sets the mode for display and selection of browser items. Allowed modes are folders and files.

AbstractDocumentBrowser::set_item_limit() — Method in class AbstractDocumentBrowser

Sets the limit how many items should be loaded per one call.

AbstractDocumentBrowser::set_multiple_selection() — Method in class AbstractDocumentBrowser

Sets whether multiple items can be selected or not.

AbstractDocumentBrowser::set_show_operation_options() — Method in class AbstractDocumentBrowser

Sets whether to show the option to set the operation for selecting item (link, move, copy).

AbstractDocumentBrowser::set_allowed_file_types() — Method in class AbstractDocumentBrowser

ApiService::setupMethods() — Method in class ApiService

SearchableDocumentBrowserInterface — Class in namespace XELOS\Modules\Selector\Interfaces

Interface SearchableDocumentBrowserInterface

BrowserFile::set_ext() — Method in class BrowserFile

Sets the extension name.

BrowserFile::set_media_type() — Method in class BrowserFile

Sets the media type.

BrowserFile::set_revision() — Method in class BrowserFile

Sets the revision for this file.

BrowserFile::set_user_id() — Method in class BrowserFile

Sets the user id who created this file.

BrowserFile::setAllowedOperations() — Method in class BrowserFile

BrowserFile::setAllowedCopy() — Method in class BrowserFile

BrowserFile::setAllowedReferenceLink() — Method in class BrowserFile

BrowserFile::setAllowedPassiveLink() — Method in class BrowserFile

BrowserFolder::set_has_children() — Method in class BrowserFolder

Sets whether this folder has dub folders or not.

UserSelectorProcessor::setUserList() — Method in class UserSelectorProcessor

UserSelectorProcessor::setAllowExternalInvites() — Method in class UserSelectorProcessor

UserSelectorProcessor::setAllowDisabledUsers() — Method in class UserSelectorProcessor

UserSelectorProcessor::setAllowGroupSelection() — Method in class UserSelectorProcessor

UserSelectorProcessor::setIsMultiple() — Method in class UserSelectorProcessor

$ Page#show — Property in class Page

$ Page#source — Property in class Page

Page::show() — Method in class Page

Page::source() — Method in class Page

$ PageDocumentation#slug: — Property in class PageDocumentation

stored in MySQL as varchar

$ PageDocumentation#sort — Property in class PageDocumentation

SmartWikiControllerDocumentation — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Page#slug — Property in class Page

$ Page#sort — Property in class Page

Page::saveToHistory() — Method in class Page

Makes a snapshot of the page and saves it to the history

Page::set_documents() — Method in class Page

Set documents - try accepting multiple

Page::save() — Method in class Page

ShowPage — Class in namespace XELOS\Modules\SmartWiki\Page

SourcePage — Class in namespace XELOS\Modules\SmartWiki\Page

SmartWikiController — Class in namespace XELOS\Modules\SmartWiki

Class SmartWikiController

SystemCron — Class in namespace XELOS\Modules\SmartWiki

WikiCest::seeEmpty() — Method in class WikiCest

ViewWikiRead::set_document() — Method in class ViewWikiRead

ViewWikiWrite::set_document() — Method in class ViewWikiWrite

$ Page#settings — Property in class Page

$ DocumentWallItemDocumentation#status: — Property in class DocumentWallItemDocumentation

enum new|update|delete

$ DocumentWallItemDocumentation#shared — Property in class DocumentWallItemDocumentation

$ DocumentWallItemDocumentation#shared_document_index_id — Property in class DocumentWallItemDocumentation

SystemActionlogControllerDocumentation — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

WallIndexEventDocumentIndexEvent::set_debug() — Method in class WallIndexEventDocumentIndexEvent

Webservice::setupMethods() — Method in class Webservice

Define and return your webservice methods.

SendWallDigestJob — Class in namespace XELOS\Modules\SystemActionlog\Infrastructure\Job

Class SendNotificationJob

Entry::save() — Method in class Entry

SettingsPage — Class in namespace XELOS\Modules\SystemActionlog\Page

This page has settings and code with regard to activity score / gamifaction Code is old, but still working and could be useful to revive "gamifaction" at some point

SystemActionlogController — Class in namespace XELOS\Modules\SystemActionlog

$ SystemActionlogController#show_events — Property in class SystemActionlogController

SystemCron — Class in namespace XELOS\Modules\SystemActionlog

$ BackupQueue#status: — Property in class BackupQueue

enum waiting|running|finished

$ EventTrigger#source: — Property in class EventTrigger

stored in MySQL as varchar

$ InstallQueue#settings: — Property in class InstallQueue

stored in MySQL as text

$ InstallQueue#status: — Property in class InstallQueue

enum waiting|downloading|updating|installing|error|done

DocumentIndexDaemonThreaded::setMaxThreads() — Method in class DocumentIndexDaemonThreaded

SystemCron — Class in namespace XELOS\Modules\SystemAdmin

SystemDaemon — Class in namespace XELOS\Modules\SystemAdmin

$ SystemDaemon#sleep_between_process — Property in class SystemDaemon

SearchMetaData — Class in namespace XELOS\Modules\SystemDMS\Hook\Search

SystemDMSBrowserFile — Class in namespace XELOS\Modules\SystemDMS\Hook\Selector\Browser

Class SystemDMSBrowserFile

SystemDMSBrowserFolder — Class in namespace XELOS\Modules\SystemDMS\Hook\Selector\Browser

Class SystemDMSBrowserFolder

SystemDMSDocumentBrowser — Class in namespace XELOS\Modules\SystemDMS\Hook\Selector\Browser

Class SystemDMSDocumentBrowser

SelectorBrowser — Class in namespace XELOS\Modules\SystemDMS\Hook\Selector

Class XELOS\Modules\SystemDMS\Hook\Selector\xm_system_dms_selector_browser

ApiService::setupMethods() — Method in class ApiService

SavePayloadAction — Class in namespace XELOS\Modules\SystemDMS\Hook\Workflows

Class XELOS\Modules\SystemDMS\Hook\Workflow\xwf_action_system_dms_save_payload

PreviewJob::setForceGenerate() — Method in class PreviewJob

If set to true existing previews will be regenerated in all cases

Category::save() — Method in class Category

Save Changes

Category::search_category_id_by_name() — Method in class Category

Lookup Category ID

Category::set_name_i18n() — Method in class Category

$ Document#save_as_new_version — Property in class Document

Document::set_model_default_render_xui() — Method in class Document

Document::save() — Method in class Document

Save document to database

Document::start_new_version() — Method in class Document

Starts a new version (will be saved when save() is called)

Document::set_property() — Method in class Document

Document::save_meta_data() — Method in class Document

Writes the meta data to the database Wrapped in a public method to allow forwarding this request to link targets in the future

Document::set_uploaded_file() — Method in class Document

Handler for uploading files (should be attached as upload_callback to the corresponding form)

Document::set_filename() — Method in class Document

Will set the filename url-friendly and without any path-information IMPORTANT: do not use the current model-set-methods it will not rename the files proper

Document::setCustomThumbnail() — Method in class Document

Sets a custom thumbnail for this document. Set to FALSE to unset.

DocumentTemplate::save() — Method in class DocumentTemplate

Stores the template.

Preview::setDocument() — Method in class Preview

XfsDocument::send_file() — Method in class XfsDocument

XfsDocument::save() — Method in class XfsDocument

$ CategoryPage#service — Property in class CategoryPage

SystemCron — Class in namespace XELOS\Modules\SystemDMS

Class XELOS\Modules\SystemDMS\xsc_system_dms

SystemDMSController — Class in namespace XELOS\Modules\SystemDMS

Class SystemDMSController

SystemDMSController::show_file_options() — Method in class SystemDMSController

show any file options such as edit, delete, lock, download as zip etc.

SystemDMSController::showNavBar() — Method in class SystemDMSController

SystemDMSController::set_default_document_page() — Method in class SystemDMSController

show download link in file table instead of the detail link

SystemDMSController::set_quota_size() — Method in class SystemDMSController

Sets the quota as the given unit.

SystemDMSController::setNestedPath() — Method in class SystemDMSController

Nested Path is used for resolving referenced documents and is special to SystemDMS

SystemDMSController::send_file() — Method in class SystemDMSController

Allows access to different versions DMS documents.

SystemDMSController::store_file_raw() — Method in class SystemDMSController

Stores a file of an instance

CategoryCest::showCategory() — Method in class CategoryCest

SystemDMSControllerHelper — Class in namespace XELOS\Modules\SystemDMS\Tests\Codeception\Support\Helper

Class SystemDMSControllerHelper

SystemDMSControllerTest — Class in namespace XELOS\Modules\SystemDMS\Tests\Codeception\Unit

Class SystemDMSControllerTest

$ SystemDMSControllerTest#systemDMSHelper — Property in class SystemDMSControllerTest

$ SystemDMSControllerTest#systemDMSController — Property in class SystemDMSControllerTest

DocumentGalleryPanel::set_category() — Method in class DocumentGalleryPanel

DocumentGalleryPanel::set_category_id() — Method in class DocumentGalleryPanel

DocumentPage::set_document() — Method in class DocumentPage

DocumentPage::set_allow_edit_category() — Method in class DocumentPage

DocumentPageSidebar::set_document() — Method in class DocumentPageSidebar

DocumentPageSidebar::set_content_document() — Method in class DocumentPageSidebar

DocumentPageSidebar::set_locked() — Method in class DocumentPageSidebar

DocumentPageSidebar::set_can_write() — Method in class DocumentPageSidebar

DocumentPageViews::set_document() — Method in class DocumentPageViews

DocumentPageViews::set_content_document() — Method in class DocumentPageViews

DocumentPageViews::set_locked() — Method in class DocumentPageViews

DocumentPageViews::set_can_write() — Method in class DocumentPageViews

DocumentPageViews::set_allow_edit_category() — Method in class DocumentPageViews

DocumentPanel::set_category() — Method in class DocumentPanel

DocumentPanel::set_category_id() — Method in class DocumentPanel

DocumentTablePanel::set_category() — Method in class DocumentTablePanel

DocumentTablePanel::set_category_id() — Method in class DocumentTablePanel

DocumentTablePanel::set_mode() — Method in class DocumentTablePanel

FilterPanel::set_current_filter() — Method in class FilterPanel

FolderTreePanel::set_category() — Method in class FolderTreePanel

FolderTreePanel::set_category_id() — Method in class FolderTreePanel

FolderTreePanel::set_root() — Method in class FolderTreePanel

FormFilterSpecification::save() — Method in class FormFilterSpecification

Returns the value of this component in a way it can be saved

FormReportSpecification::save() — Method in class FormReportSpecification

Returns the value of this component in a way it can be saved

PortletFolderview::set_display_mode() — Method in class PortletFolderview

PortletFolderview::set_link_mode() — Method in class PortletFolderview

PortletFolderview::set_show_pagination() — Method in class PortletFolderview

PortletFolderview::set_thumb_width() — Method in class PortletFolderview

PortletFolderview::set_thumb_height() — Method in class PortletFolderview

Set thumb height

PortletFolderview::setThumbFormat() — Method in class PortletFolderview

Set thumb format

PortletFolderview::set_limit() — Method in class PortletFolderview

PortletFolderview::set_order_by() — Method in class PortletFolderview

PortletFolderview::set_where() — Method in class PortletFolderview

PreviewLoader::set_document() — Method in class PreviewLoader

ReportSpecificationHelper::set_specification() — Method in class ReportSpecificationHelper

Define the initial specification that shall be rendered as long as no newer specification was found in the cache

ReportSpecificationHelper::set_fieldname() — Method in class ReportSpecificationHelper

Define the fieldname to be used by the form editors

ReportSpecificationHelper::set_form_name() — Method in class ReportSpecificationHelper

Define the name of the form that shall be used for rendering. This is important to ensure proper JS execution by the form editors

ViewDocumentDetails::set_document() — Method in class ViewDocumentDetails

ViewDocumentLink::set_document() — Method in class ViewDocumentLink

ViewDocumentRead::set_document() — Method in class ViewDocumentRead

ViewDocumentTemplate::set_document() — Method in class ViewDocumentTemplate

ViewDocumentWrite::set_document() — Method in class ViewDocumentWrite

ViewDocumentWrite::set_allow_edit_category() — Method in class ViewDocumentWrite

ViewDocumentWrite::set_is_locked() — Method in class ViewDocumentWrite

If document is locked, the form will be set readonly

XfsDocument::set_keep_image_ratio() — Method in class XfsDocument

XfsDocument::set_xfs_render_type() — Method in class XfsDocument

Sets the render type. Available types are "tile", "compact", "default".

$ Category#size — Property in class Category

$ Category#share_id — Property in class Category

$ Category#system_folder — Property in class Category

: stored in MySQL as tinyint

$ Category#structure — Property in class Category

: stored in MySQL as varchar

$ Document#summary — Property in class Document

: stored in MySQL as text

$ DocumentHistory#summary — Property in class DocumentHistory

: stored in MySQL as text

$ DocumentMetaField#show_as_hierarchy: — Property in class DocumentMetaField

stored in MySQL as tinyint

$ DocumentMetaField#show_as_filter — Property in class DocumentMetaField

: stored in MySQL as tinyint

$ DocumentMetaField#sort — Property in class DocumentMetaField

$ Preview#status: — Property in class Preview

in progress|done|failed

$ ZipImportJob#status — Property in class ZipImportJob

: enum waiting|running|prepared|done|error

AdminSystemMailUserAdminConfig::set() — Method in class AdminSystemMailUserAdminConfig

UserSystemMailUserConfig::set() — Method in class UserSystemMailUserConfig

SystemNotificationControllerDocumentation — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

SettingsUserConfig — Class in namespace XELOS\Modules\SystemNotification\Hook\Administration

Class SettingsHook

NotificationChannelInterface::send() — Method in class NotificationChannelInterface

EmailNotificationChannel::send() — Method in class EmailNotificationChannel

SendNotificationJob — Class in namespace XELOS\Modules\SystemNotification\Infrastructure\Job

Class SendNotificationJob

UserSetting::save() — Method in class UserSetting

SettingsPage — Class in namespace XELOS\Modules\SystemNotification\Page

SystemNotificationController — Class in namespace XELOS\Modules\SystemNotification

Class xm_system_notification

SystemNotificationTest — Class in namespace XELOS\Modules\SystemNotification\Tests\Codeception\Unit

NotificationAction::sendWebPushNotification() — Method in class NotificationAction

Send Web Push Notification to users Very well supported by Chrome and Firefox.

NotificationAction::sendWebPush() — Method in class NotificationAction

Send Web Push Notification to users Very well supported by Chrome and Firefox.

$ PushSubscriptionDocumentation#subscription: — Property in class PushSubscriptionDocumentation

stored in MySQL as blob

SystemPwaControllerDocumentation — Class in namespace XELOS\Modules\SystemPwa\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

PushNotificationChannel::send() — Method in class PushNotificationChannel

$ PushSubscription#subscription — Property in class PushSubscription

BLOB, json_encoded

SystemPwaController — Class in namespace XELOS\Modules\SystemPwa

$ AggregateDimensionDocumentation#sort — Property in class AggregateDimensionDocumentation

$ EventDocumentation#session_id — Property in class EventDocumentation

SystemStatsControllerDocumentation — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

CollectorData::setAggregatedData() — Method in class CollectorData

CollectorDimension::setTitle() — Method in class CollectorDimension

CollectorDimension::setTitleShort() — Method in class CollectorDimension

CollectorDimension::setDescription() — Method in class CollectorDimension

CollectorDimension::setStyle() — Method in class CollectorDimension

CollectorDimension::setType() — Method in class CollectorDimension

Set data type

AggregateDimension::setCollector() — Method in class AggregateDimension

AggregateDimension::setCollectorDimension() — Method in class AggregateDimension

AggregateNumeric::saveCollectorData() — Method in class AggregateNumeric

SystemCron — Class in namespace XELOS\Modules\SystemStats

System Stats maintenance

SystemStatsController — Class in namespace XELOS\Modules\SystemStats

Class SystemStatsController

AggregationChart::setTimeRange() — Method in class AggregationChart

AggregationChart::setTimerangeIsHadledExternal() — Method in class AggregationChart

AggregationChart::setDimensions() — Method in class AggregationChart

AggregationChart::setChartTitle() — Method in class AggregationChart

AggregationChart::setAggregationLevel() — Method in class AggregationChart

$ CheckDocumentation#state: — Property in class CheckDocumentation

enum green|orange|red

$ NodeDocumentation#state: — Property in class NodeDocumentation

enum green|orange|red

SystemStatusControllerDocumentation — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

$ Check#scope — Property in class Check

$ Check#skip_check — Property in class Check

Check::skip_check() — Method in class Check

Returns true if this check should be skipped

$ Result#state — Property in class Result

Status of the Check. The signal light can have three states: red -> CRITICAL, orange -> NEEDS ATTENTION, green -> ALL SYSTEMS OK

$ Result#STATE_GREEN — Property in class Result

$ Result#STATE_ORANGE — Property in class Result

$ Result#STATE_RED — Property in class Result

$ Result#severity — Property in class Result

Importance of this check for the overall system stability

$ Result#SEVERITY_LOW — Property in class Result

$ Result#SEVERITY_MEDIUM — Property in class Result

$ Result#SEVERITY_CRITICAL — Property in class Result

ServiceCheck — Class in namespace XELOS\Modules\SystemStatus\Interfaces

ServiceCheckResult — Class in namespace XELOS\Modules\SystemStatus\Interfaces

SystemCron — Class in namespace XELOS\Modules\SystemStatus

SystemStatusController — Class in namespace XELOS\Modules\SystemStatus

Class Main

GlobalTaskCollection::setEmpty() — Method in class GlobalTaskCollection

RecurringTaskCollection::search_by_task_id() — Method in class RecurringTaskCollection

TaskCollection::search_all_by_list_id() — Method in class TaskCollection

$ RecurringTaskDocumentation#start_time: — Property in class RecurringTaskDocumentation

stored in MySQL as datetime

$ RecurringTaskDocumentation#set_deadline: — Property in class RecurringTaskDocumentation

stored in MySQL as tinyint

$ TaskDocumentation#status: — Property in class TaskDocumentation

stored in MySQL as varchar

$ TaskDocumentation#sort — Property in class TaskDocumentation

SystemTasksControllerDocumentation — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

ShowTasksShowPortlet — Class in namespace XELOS\Modules\SystemTasks\Hook\Portal

Class XELOS\Modules\SystemTasks\Hook\Portal\ShowTasksShowPortlet

ApiService::setupMethods() — Method in class ApiService

ApiService::syncChanged() — Method in class ApiService

Sync task and column changes -- more added later

RecurringTask::save() — Method in class RecurringTask

$ Task#sort — Property in class Task

Task::save() — Method in class Task

Task::setTaskListModel() — Method in class Task

Manually pass TaskList to prevent additional lazy loading

Task::setIsArchived() — Method in class Task

Set this task as archived or unarchived

Task::set_checklist() — Method in class Task

Store Checklist Array as JSON

Task::setTaskSort() — Method in class Task

Sort Taks in List Column

Task::set_description_html() — Method in class Task

Set description, assumes input is HTML and needs converting/sanitizing

$ TaskList#shared_user — Property in class TaskList

TaskList::save() — Method in class TaskList

$ TaskListColumn#sort — Property in class TaskListColumn

TaskListColumn::setColumnSort() — Method in class TaskListColumn

Sort Taks in List Column

SystemCron — Class in namespace XELOS\Modules\SystemTasks

SystemTasksController — Class in namespace XELOS\Modules\SystemTasks

SystemTasksControllerHelper — Class in namespace XELOS\Modules\SystemTasks\Tests\Codeception\Support\Helper

Class SystemTasksControllerHelper

$ TaskTest#systemTasksController — Property in class TaskTest

SystemWorkerController — Class in namespace XELOS\Modules\SystemWorker

VideoWorker::savePreviewImage() — Method in class VideoWorker

VideoWorker::setCallbackParams() — Method in class VideoWorker

MobileNotificationChannel::send() — Method in class MobileNotificationChannel

Webservice::setupMethods() — Method in class Webservice

Return your defined methods.

$ Page#suggest — Property in class Page

Page::suggest() — Method in class Page

SuggestPage — Class in namespace XELOS\Modules\Tagging\Page

Display Tag-Suggestion Page (Used for AJAX Tag Auto-Suggest Calls)

SystemCron — Class in namespace XELOS\Modules\Tagging

$ Page#settings — Property in class Page

Page::settings() — Method in class Page

$ TranslationFeedbackDocumentation#source_model: — Property in class TranslationFeedbackDocumentation

enum translation_document|translation

$ TranslationFeedbackDocumentation#source_id — Property in class TranslationFeedbackDocumentation

TranslationSettingsLanguageConfig::setUserId() — Method in class TranslationSettingsLanguageConfig

Indicates the user_id, to which these language settings will be applied

$ BaseTranslationApi#source_language — Property in class BaseTranslationApi

BaseTranslationApi::setUrl() — Method in class BaseTranslationApi

BaseTranslationApi::setSourceLanguage() — Method in class BaseTranslationApi

BaseTranslationApi::setContent() — Method in class BaseTranslationApi

BaseTranslationApi::setTargetLanguage() — Method in class BaseTranslationApi

BaseTranslationApi::setTranslatedContent() — Method in class BaseTranslationApi

BaseTranslationApi::sendFeedback() — Method in class BaseTranslationApi

Send feedback aka improved human translation to the API

BaseTranslationApi::setParameters() — Method in class BaseTranslationApi

Sets possible content and target language

BaseTranslationApi::setBackgroundTranslationToDisabled() — Method in class BaseTranslationApi

Sets the config var 'translation_enabled' to false to disable automatic translations.

Deepl::setKey() — Method in class Deepl

Deepl::setSourceLanguage() — Method in class Deepl

Transperfect::setKey() — Method in class Transperfect

Transperfect::setSourceLanguage() — Method in class Transperfect

Transperfect::sendFormRequest() — Method in class Transperfect

Returns the response from the endpoint. Form post.

Transperfect::sendFeedback() — Method in class Transperfect

$ TranslationFeedback#sourceModel — Property in class TranslationFeedback

SettingsPage — Class in namespace XELOS\Modules\Translation\Page

Pages for the GECKO registration process.

StatisticsPage — Class in namespace XELOS\Modules\Translation\Page

Pages for the GECKO registration process.

SystemDaemon — Class in namespace XELOS\Modules\Translation

Daemon to process the TranslationJob queue

$ SystemDaemon#sleep_between_process — Property in class SystemDaemon

TranslationController::setTranslationApi() — Method in class TranslationController

Setter for the translation Api

TranslationController::setDisableTranslationForLanguage() — Method in class TranslationController

Sets the config to disable the translation for the given $language based on $disable flag.

$ Trendvote#status: — Property in class Trendvote

enum draft|active','closed

$ Trendvote#start_at: — Property in class Trendvote

stored in MySQL as timestamp

ApiService::setupMethods() — Method in class ApiService

Define and return your webservice methods.

$ Trendvote#status — Property in class Trendvote

$ Trendvote#start_at — Property in class Trendvote

ScanAction — Class in namespace XELOS\Modules\VirusScan\Action

Class ScanAction

$ Model#scan — Property in class Model

Model::scan() — Method in class Model

$ FileDocumentation#scan_id — Property in class FileDocumentation

ScanDocumentation — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Scan.

$ ScanDocumentation#scan_status: — Property in class ScanDocumentation

enum ok|found_virus

$ FileDeleteJob#scanId — Property in class FileDeleteJob

Scan — Class in namespace XELOS\Modules\VirusScan\Model

SystemCron — Class in namespace XELOS\Modules\VirusScan

DigestAuthentication::sendAuthenticateHeader() — Method in class DigestAuthentication

$ OAuthServerAction#scopeSeparator — Property in class OAuthServerAction

Service — Class in namespace XELOS\Modules\Webservice\Hook\Base

Base class for Webservice Hooks.

Service::setupMethods() — Method in class Service

Define and return your webservice methods.

Method::setName() — Method in class Method

Method::setVersion() — Method in class Method

Method::setCallback() — Method in class Method

Instead of a defining a separate function in the service hook,

Method::setDescription() — Method in class Method

Method::setRestApiInfo() — Method in class Method

Method::setIsInternal() — Method in class Method

ModelCRUD::sanitizeInputArrayByType() — Method in class ModelCRUD

Cleans/Sanitizes $value based in the datatype in the schema definition

ModelCRUD::sanitizeInputByType() — Method in class ModelCRUD

Cleans/Sanitizes value based in the datatype in the schemaType

ModelMethod::setAttachmentProperties() — Method in class ModelMethod

ParameterObject::setName() — Method in class ParameterObject

ParameterObject::setMemberXQL() — Method in class ParameterObject

XQL::setPaginationLimit() — Method in class XQL

OAuthClientHook::setModelValid() — Method in class OAuthClientHook

OAuthClientHook::setModelInvalid() — Method in class OAuthClientHook

OAuthClientHook::saveOAuthAccess() — Method in class OAuthClientHook

Save and encrypt oauth data to database

OAuthClientHook::setIsBasicAuthorization() — Method in class OAuthClientHook

SoapService — Class in namespace XELOS\Modules\Webservice\Hook\Webservice

SoapService::setupMethods() — Method in class SoapService

ServiceInterface — Class in namespace XELOS\Modules\Webservice\Interfaces

Interface for webservice hooks to provide own functionality.

$ OAuthClient#scope — Property in class OAuthClient

The scopes which you want to request authorization for.

$ OAuthClient#state — Property in class OAuthClient

An opaque value the application adds to the initial request that Auth includes when redirecting back to the application.

OAuthClient::setClientId() — Method in class OAuthClient

Set application's Client ID.

OAuthClient::setClientSecret() — Method in class OAuthClient

Set application's Client Secret

OAuthClient::setRedirectUrl() — Method in class OAuthClient

OAuthClient::setAuthorizeUrl() — Method in class OAuthClient

OAuthClient::setAccessTokenUrl() — Method in class OAuthClient

OAuthClient::setScope() — Method in class OAuthClient

Set scopes which you want to request authorization for.

OAuthClient::setOptionalAuthParams() — Method in class OAuthClient

OAuthClient::setState() — Method in class OAuthClient

OAuthClient::setRefreshToken() — Method in class OAuthClient

OAuthClient::setEndSessionUrl() — Method in class OAuthClient

OAuthClient::setJwksUrl() — Method in class OAuthClient

OAuthClient::setIssuerUrl() — Method in class OAuthClient

OAuthClient::setUserinfoEndpointUrl() — Method in class OAuthClient

OAuthClient::setAccessToken() — Method in class OAuthClient

OAuthClient::setPersonal() — Method in class OAuthClient

Defines whether the client is for personal or global usage.

OAuthClient::startAuthorisationCodeFlow() — Method in class OAuthClient

Start Authorization Code Grant flow (redirect to authorizeUrl)

OAuthClient::setResource() — Method in class OAuthClient

Set additional resource param when requesting access code

OAuthClient::setSendBasicAuthorization() — Method in class OAuthClient

Should client_id and client_secret be sent as Basic Auth Header during code exchange?

OAuthClient::setPKCEParams() — Method in class OAuthClient

Set Code Verifier and Code Challenge Method for RFC 7636: Proof Key for Code Exchange (PKCE) which is an alternative to client_secret or may be used in hybrid flows

SoapServer — Class in namespace XELOS\Modules\Webservice\Lib

SoapServer::set_xf_module() — Method in class SoapServer

OauthAccess::save() — Method in class OauthAccess

OauthAccess::setSecureAccessToken() — Method in class OauthAccess

Convert plaintext token to secure hash and set as acces_token property

OauthAccess::setSecureRefreshToken() — Method in class OauthAccess

OAuthAccountsPage::setShowUserAccounts() — Method in class OAuthAccountsPage

SystemCron — Class in namespace XELOS\Modules\Webservice

WebserviceController::set_oauth_info() — Method in class WebserviceController

Set OAuth Info for current Session

$ Page#settings — Property in class Page

Page::settings() — Method in class Page

$ CategoryDocumentation#sort — Property in class CategoryDocumentation

$ WidgetDocumentation#sort — Property in class WidgetDocumentation

SettingsPage — Class in namespace XELOS\Modules\Widgets\Page

Class XELOS\Modules\Widgets\Page\SettingsPage

WidgetList::setDisplayMode() — Method in class WidgetList

Set the display mode to show all accessible widgets sorted by name or displays them group by category.

WidgetList::setSortMode() — Method in class WidgetList

Sets the sorting mode of this list

WidgetList::setVisibleWidgetIds() — Method in class WidgetList

Can be set to show only specific Widgets.

WidgetList::setStrictMode() — Method in class WidgetList

If visibleWidgetIds is empty, the accessible widgets will be displayed when strict mode is off.

$ Model#survey — Property in class Model

Model::survey() — Method in class Model

$ AnswerDocumentation#survey_id — Property in class AnswerDocumentation

$ ParticipantDocumentation#survey_id — Property in class ParticipantDocumentation

SurveyDocumentation — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Survey.

$ SurveyDocumentation#start_date: — Property in class SurveyDocumentation

stored in MySQL as timestamp

Survey — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Model

T

Autoloader::to_camel_case() — Method in class Autoloader

Returns the passed name from underscore writing to CamelCase (test_class --> TestClass) Warning: Converting back to CamelCase is not unique in all cases! e.g. SystemDMS can not be regenerated from system_dms

$ BaseAuthentication#ttl — Property in class BaseAuthentication

$ ActivedirectoryAuthentication#ttl — Property in class ActivedirectoryAuthentication

$ AlternativeLoginAuthentication#ttl — Property in class AlternativeLoginAuthentication

$ GuestAuthentication#ttl — Property in class GuestAuthentication

$ IpAuthentication#ttl — Property in class IpAuthentication

$ LdapAuthentication#ttl — Property in class LdapAuthentication

$ MobileAccessAuthentication#ttl — Property in class MobileAccessAuthentication

$ NtlmAuthentication#ttl — Property in class NtlmAuthentication

$ RadiusAuthentication#ttl — Property in class RadiusAuthentication

$ RemembermeAuthentication#ttl — Property in class RemembermeAuthentication

$ SuperuserAuthentication#ttl — Property in class SuperuserAuthentication

$ XelosAuthentication#ttl — Property in class XelosAuthentication

Test — Class in namespace XELOS\Framework\Core\Console\Command

Class StartDaemon

Theme — Class in namespace XELOS\Framework\Core\Console\Command

Class Themes

Table — Class in namespace XELOS\Framework\Core\Console\Helper

Class Table Simple table helper for CLI output which allows the display of tabular data

Output::table() — Method in class Output

Print Table in CLI, Example: ┌────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ Module │ Installed │ Repository │ Package │ ┝━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┥ │ Directory Sync │ 8.2.4 │ 9.0.5 │ Active Directory and SSO Authentication │ └────────────────────────────────────────────────────────────────────────────────────────────────────────┘

$ Core#template — Property in class Core

$ ContentException#template — Property in class ContentException

ActionHandlerHelper::triggerAction() — Method in class ActionHandlerHelper

Trigger and Execute all actions or Execute specific action for specific trigger

ActionHelper::toArray() — Method in class ActionHelper

MagicDocumentHelper::toArray() — Method in class MagicDocumentHelper

ItemInterface::toArray() — Method in class ItemInterface

ItemListInterface::toArray() — Method in class ItemListInterface

Template — Class in namespace XELOS\Framework\Core

Class Template

$ Template#theme_set_config — Property in class Template

Stores Theme configuration information

$ Template#template_includes — Property in class Template

ItemListTrait::toArray() — Method in class ItemListTrait

Transforms the option into an array.

$ VarsTemplate#template_file: — Property in class VarsTemplate

stored in MySQL as varchar

$ VarsTemplate#template: — Property in class VarsTemplate

stored in MySQL as mediumtext

$ VarsTemplate#title — Property in class VarsTemplate

Extract from the XML template

Controller::templateResponse() — Method in class Controller

$ AuthenticationHook#ttl — Property in class AuthenticationHook

$ Model#table_name — Property in class Model

$ Model#table_use_group_id — Property in class Model

$ Model#table_auto_properties — Property in class Model

$ Model#table_primary_key — Property in class Model

$ Model#table_primary_compound_key — Property in class Model

Model::to_xml() — Method in class Model

Returns an XML of all model properties

Model::to_json() — Method in class Model

Returns the model as JSON array

Model::to_string() — Method in class Model

Returns the model as STRING

Model::temporarily_disable_table_group_id() — Method in class Model

Temporarily disable the use of the group ID in all queries made

Model::touchProperty() — Method in class Model

ModelCollection::to_string() — Method in class ModelCollection

Returns collection as string

ModelCollection::to_array() — Method in class ModelCollection

Returns collection as array of models

ModelCollection::to_json() — Method in class ModelCollection

Returns collection as json of models

ModelCollection::to_xml() — Method in class ModelCollection

Returns an XML of all model properties

$ AuditableTrait#table_name — Property in class AuditableTrait

AuditableTrait::triggerAuditEvent() — Method in class AuditableTrait

TBD: Move this method to the audit model? and keep things slim in trait?

$ SoftDeleteTrait#table_name — Property in class SoftDeleteTrait

Provides the methods:

$ SystemDaemonThreaded#threadLifetimeCycles — Property in class SystemDaemonThreaded

$ XF#theme — Property in class XF

MySQLAdapter::table_exists() — Method in class MySQLAdapter

MySQLAdapter::table_field_exists() — Method in class MySQLAdapter

Query::triggerOnChange() — Method in class Query

Trigger onChange event callbacks

Query::table() — Method in class Query

Syntax-Helper to start a query with for a table. Use as Query::table('myTable')->where('field1','=','val');

Event::trigger() — Method in class Event

$ Lib#thumbnail — Property in class Lib

$ Lib#text — Property in class Lib

$ Lib#threading — Property in class Lib

Convert::to_text() — Method in class Convert

Convert::to_html() — Method in class Convert

$ Debug#timer_section_start — Property in class Debug

$ Debug#timer_section_items — Property in class Debug

Export::table_as_file() — Method in class Export

Export::table() — Method in class Export

$ File#trash_folder — Property in class File

File::tail() — Method in class File

Slightly modified version of http://www.geekality.net/2011/05/28/php-tail-tackling-large-files/

Format::text_parse() — Method in class Format

Parst einen Text

Format::text_pre_parse() — Method in class Format

Parses the passed text

Html::tag() — Method in class Html

Helper function to create HTML tags without content (e.g. <input ... />)

$ I18n#timezone — Property in class I18n

$ I18n#template_vars — Property in class I18n

Import::table() — Method in class Import

ThreadedStreamHandlerFactory — Class in namespace XELOS\Framework\XF\Lib\Logger\HandlerFactory

Class ThreadedStreamHandlerFactory

Logger::translateLevel() — Method in class Logger

Translates default PHP log levels into PSR / Monolog levels.

Mention::transformToLink() — Method in class Mention

Transform mentions, defined in HTML or JSON notation to XELOS specific output (user and group links)

Mention::transformHTMLToJSON() — Method in class Mention

Transform HTML mentions generated in WYSIWYG (defining name and id in the data attribute) into @JSON representation, e.g. @{1:UserName} or @{gid_1:Group} .

Mention::transformJSONToHTML() — Method in class Mention

Transform JSON mentions int HTML format which is suitable for the WYSIWYG Editor

Mention::transformToNameText() — Method in class Mention

Transform HTML or JSON mentions in string to text only, e.g. ATname.

$ Modsetup#testrun — Property in class Modsetup

Modsetup::trigger_event() — Method in class Modsetup

$ NotificationBuilder#token — Property in class NotificationBuilder

$ NotificationBuilder#type — Property in class NotificationBuilder

Shell::tail() — Method in class Shell

Text — Class in namespace XELOS\Framework\XF\Lib

Threading — Class in namespace XELOS\Framework\XF\Lib

Thumbnail — Class in namespace XELOS\Framework\XF\Lib

Thumbnail Creation Class

TyeDiff — Class in namespace XELOS\Framework\XF\Lib

TemplateParser — Class in namespace XELOS\Framework\XF\Lib\i18n\Parser

Token — Class in namespace XELOS\Framework\XF\Lib\i18n

TokenCollection — Class in namespace XELOS\Framework\XF\Lib\i18n

UserCollection::transformToOptionList() — Method in class UserCollection

$ Model#theme_set — Property in class Model

$ AuditPolicy#table_name — Property in class AuditPolicy

$ AuditPolicy#table_auto_properties — Property in class AuditPolicy

$ AuditPolicy#table_use_group_id — Property in class AuditPolicy

$ AuditTrail#table_name — Property in class AuditTrail

$ AuditTrail#table_auto_properties — Property in class AuditTrail

$ AuditTrail#table_use_group_id — Property in class AuditTrail

$ Cron#table_name — Property in class Cron

$ Cron#table_auto_properties — Property in class Cron

$ Cron#table_use_group_id — Property in class Cron

$ Daemon#table_name — Property in class Daemon

$ Daemon#table_auto_properties — Property in class Daemon

$ Daemon#table_use_group_id — Property in class Daemon

$ DocumentIndex#table_name — Property in class DocumentIndex

$ DocumentIndex#table_auto_properties — Property in class DocumentIndex

$ DocumentIndex#table_use_group_id — Property in class DocumentIndex

$ DocumentIndex#title — Property in class DocumentIndex

$ DocumentIndex#thumb_doc — Property in class DocumentIndex

$ DocumentIndexJobQueue#table_name — Property in class DocumentIndexJobQueue

$ DocumentIndexJobQueue#table_auto_properties — Property in class DocumentIndexJobQueue

$ DocumentIndexJobQueue#table_use_group_id — Property in class DocumentIndexJobQueue

$ DocumentIndexJobQueueHistory#table_name — Property in class DocumentIndexJobQueueHistory

$ DocumentIndexJobQueueHistory#table_auto_properties — Property in class DocumentIndexJobQueueHistory

$ DocumentIndexJobQueueHistory#table_use_group_id — Property in class DocumentIndexJobQueueHistory

$ DocumentIndexLock#table_name — Property in class DocumentIndexLock

$ DocumentIndexLock#table_auto_properties — Property in class DocumentIndexLock

$ DocumentIndexLock#table_use_group_id — Property in class DocumentIndexLock

$ DocumentIndexPolicyCluster#table_name — Property in class DocumentIndexPolicyCluster

$ DocumentIndexPolicyCluster#table_auto_properties — Property in class DocumentIndexPolicyCluster

$ DocumentIndexPolicyCluster#table_use_group_id — Property in class DocumentIndexPolicyCluster

$ DocumentIndexReference#table_name — Property in class DocumentIndexReference

$ DocumentIndexReference#table_auto_properties — Property in class DocumentIndexReference

$ DocumentIndexReference#table_use_group_id — Property in class DocumentIndexReference

$ DocumentIndexReference#type — Property in class DocumentIndexReference

default 0

$ DocumentRegistry#table_name — Property in class DocumentRegistry

$ DocumentRegistry#table_auto_properties — Property in class DocumentRegistry

$ DocumentRegistry#table_use_group_id — Property in class DocumentRegistry

$ DocumentRegistry#table_key — Property in class DocumentRegistry

$ DocumentRegistry#table_parentkey — Property in class DocumentRegistry

$ DocumentRegistry#title — Property in class DocumentRegistry

$ DocumentRelations#table_name — Property in class DocumentRelations

$ DocumentRelations#table_auto_properties — Property in class DocumentRelations

$ DocumentRelations#table_use_group_id — Property in class DocumentRelations

$ DocumentRelations#table_primary_key — Property in class DocumentRelations

$ ErrorLog#table_name — Property in class ErrorLog

$ ErrorLog#table_auto_properties — Property in class ErrorLog

$ ErrorLog#table_use_group_id — Property in class ErrorLog

$ Follows#table_name — Property in class Follows

$ Follows#table_auto_properties — Property in class Follows

$ Follows#table_use_group_id — Property in class Follows

$ GlobalConfig#table_name — Property in class GlobalConfig

$ GlobalConfig#table_auto_properties — Property in class GlobalConfig

$ GlobalConfig#table_use_group_id — Property in class GlobalConfig

$ Group#table_name — Property in class Group

$ Group#table_auto_properties — Property in class Group

$ Group#table_use_group_id — Property in class Group

$ Hierarchy#table_name — Property in class Hierarchy

$ Hierarchy#table_auto_properties — Property in class Hierarchy

$ Hierarchy#table_use_group_id — Property in class Hierarchy

$ Hierarchy#title — Property in class Hierarchy

Title

$ HierarchyContext#table_name — Property in class HierarchyContext

$ HierarchyContext#table_auto_properties — Property in class HierarchyContext

$ HierarchyContext#table_use_group_id — Property in class HierarchyContext

$ HierarchyUser#table_name — Property in class HierarchyUser

$ HierarchyUser#table_auto_properties — Property in class HierarchyUser

$ HierarchyUser#table_use_group_id — Property in class HierarchyUser

$ HookRegistry#table_name — Property in class HookRegistry

$ HookRegistry#table_auto_properties — Property in class HookRegistry

$ HookRegistry#table_use_group_id — Property in class HookRegistry

$ I18nLanguage#table_name — Property in class I18nLanguage

$ I18nLanguage#table_auto_properties — Property in class I18nLanguage

$ I18nToken#table_name — Property in class I18nToken

$ I18nToken#table_auto_properties — Property in class I18nToken

$ I18nToken#token_key — Property in class I18nToken

Token key

$ I18nToken#token — Property in class I18nToken

Token

$ InstanceConfig#table_name — Property in class InstanceConfig

$ InstanceConfig#table_auto_properties — Property in class InstanceConfig

$ InstanceConfig#table_use_group_id — Property in class InstanceConfig

$ InstanceRegistry#table_name — Property in class InstanceRegistry

$ InstanceRegistry#table_auto_properties — Property in class InstanceRegistry

$ InstanceRegistry#table_use_group_id — Property in class InstanceRegistry

$ InstanceSetup#table_name — Property in class InstanceSetup

$ InstanceSetup#table_auto_properties — Property in class InstanceSetup

$ InstanceSetup#table_use_group_id — Property in class InstanceSetup

$ LibCountry#table_name — Property in class LibCountry

$ LibCountry#table_auto_properties — Property in class LibCountry

$ LibCountry#table_use_group_id — Property in class LibCountry

$ LibCountry#table_primary_key — Property in class LibCountry

$ ModuleGroupSecurity#table_name — Property in class ModuleGroupSecurity

$ ModuleGroupSecurity#table_auto_properties — Property in class ModuleGroupSecurity

$ ModuleGroupSecurity#table_use_group_id — Property in class ModuleGroupSecurity

$ ModuleGroupSecurity#title — Property in class ModuleGroupSecurity

$ ModuleGroupSecurityMember#table_name — Property in class ModuleGroupSecurityMember

$ ModuleGroupSecurityMember#table_auto_properties — Property in class ModuleGroupSecurityMember

$ ModuleGroupSecurityMember#table_use_group_id — Property in class ModuleGroupSecurityMember

$ ModuleGroupSecurityMember#table_primary_compound_key — Property in class ModuleGroupSecurityMember

$ ModuleRegistry#table_name — Property in class ModuleRegistry

$ ModuleRegistry#table_auto_properties — Property in class ModuleRegistry

$ ModuleRegistry#table_use_group_id — Property in class ModuleRegistry

$ Navigation#table_name — Property in class Navigation

$ Navigation#table_auto_properties — Property in class Navigation

$ Notification#table_name — Property in class Notification

Notification-Messages

$ Notification#table_auto_properties — Property in class Notification

$ Notification#table_use_group_id — Property in class Notification

$ Notification#token — Property in class Notification

$ Notification#type — Property in class Notification

['message', 'todo', 'activity', 'admin'], default: 'activity'

$ NotificationRegistry#table_name — Property in class NotificationRegistry

$ NotificationRegistry#table_auto_properties — Property in class NotificationRegistry

$ NotificationRegistry#table_use_group_id — Property in class NotificationRegistry

$ OnboardingCode#table_name — Property in class OnboardingCode

$ OnboardingCode#table_auto_properties — Property in class OnboardingCode

$ Pages#table_name — Property in class Pages

$ Pages#table_auto_properties — Property in class Pages

$ Pages#table_use_group_id — Property in class Pages

$ Pages#title — Property in class Pages

$ Policy#table_name — Property in class Policy

$ Policy#table_auto_properties — Property in class Policy

$ Policy#table_use_group_id — Property in class Policy

$ Policy#type — Property in class Policy

$ Policy2Group#table_name — Property in class Policy2Group

$ Policy2Group#table_auto_properties — Property in class Policy2Group

$ Policy2Group#table_use_group_id — Property in class Policy2Group

$ Policy2User#table_name — Property in class Policy2User

$ Policy2User#table_auto_properties — Property in class Policy2User

$ Policy2User#table_use_group_id — Property in class Policy2User

$ PrivacyRules#table_name — Property in class PrivacyRules

$ PrivacyRules#table_auto_properties — Property in class PrivacyRules

$ PrivacyRules#table_use_group_id — Property in class PrivacyRules

$ Queue#table_name — Property in class Queue

$ Queue#table_auto_properties — Property in class Queue

$ RecentDocument#table_name — Property in class RecentDocument

$ RecentDocument#table_auto_properties — Property in class RecentDocument

$ RecentDocument#table_use_group_id — Property in class RecentDocument

ThemeSet — Class in namespace XELOS\Framework\XF\System\Model

$ ThemeSet#table_name — Property in class ThemeSet

$ ThemeSet#table_auto_properties — Property in class ThemeSet

$ ThemeSet#table_use_group_id — Property in class ThemeSet

$ User#table_name — Property in class User

$ User#table_auto_properties — Property in class User

$ User#table_use_group_id — Property in class User

$ UserConfig#table_name — Property in class UserConfig

$ UserConfig#table_auto_properties — Property in class UserConfig

$ UserConfig#table_use_group_id — Property in class UserConfig

$ UserDevices#table_name — Property in class UserDevices

$ UserDevices#table_auto_properties — Property in class UserDevices

$ UserGroup#table_name — Property in class UserGroup

$ UserGroup#table_auto_properties — Property in class UserGroup

$ UserGroup#table_use_group_id — Property in class UserGroup

$ UserLink#table_name — Property in class UserLink

$ UserLink#table_auto_properties — Property in class UserLink

$ UserLink#table_use_group_id — Property in class UserLink

$ UserLink#template — Property in class UserLink

$ UserLog#table_name — Property in class UserLog

$ UserLog#table_auto_properties — Property in class UserLog

$ UserMeta#table_name — Property in class UserMeta

$ UserMeta#table_auto_properties — Property in class UserMeta

$ UserMeta#table_use_group_id — Property in class UserMeta

$ UserPropertyLog#table_name — Property in class UserPropertyLog

$ UserPropertyLog#table_auto_properties — Property in class UserPropertyLog

$ UserSeedImport#table_name — Property in class UserSeedImport

$ UserSeedImport#table_auto_properties — Property in class UserSeedImport

$ Wizard#table_name — Property in class Wizard

$ Wizard#table_auto_properties — Property in class Wizard

$ UI#template_links — Property in class UI

FacetedCategoryItem::toArray() — Method in class FacetedCategoryItem

$ Form#tag_sources — Property in class Form

$ FormRowRenderer#tags — Property in class FormRowRenderer

$ FroalaEditorBuilder#toolbarSet — Property in class FroalaEditorBuilder

$ FroalaEditorBuilder#toolbarAttached — Property in class FroalaEditorBuilder

Uses standard toolbar or inline toolbar?

FroalaInsertGroup::toArray() — Method in class FroalaInsertGroup

FroalaOption::tabIndex() — Method in class FroalaOption

The tabIndex to set on the editor element.

FroalaOption::tabSpaces() — Method in class FroalaOption

When TAB key is hit, the editor will add the specified number of space. If set to 0 the TAB key allows default navigation through the page.

FroalaOption::theme() — Method in class FroalaOption

Specify the theme name to use in the editor. The theme should be included as CSS. For more details please read the color themes example.

FroalaOption::toolbarBottom() — Method in class FroalaOption

Enable or disable positioning the toolbar at the bottom of the editor. This option is not available on mobile devices.

FroalaOption::toolbarButtons() — Method in class FroalaOption

The list of buttons that appear in the rich text editor's toolbar on large devices (≥ 1200px).

Note: | will insert a vertical separator line in the toolbar, and - a horizontal one.

Some of the buttons above require a specific plugin. Here is the <a href="../docs/plugins/" class="f-link" title="Plugins" target="_blank">complete list of plugins and the files required by each them.

• align button requires align plugin;
• color button requires colors plugin;
• embedly button requires embedly plugin;
• emoticons button requires emoticons plugin;
• fontFamily button requires fontFamily plugin;
• fontSize button requires fontSize plugin;
• formatOL and formatUL buttons require lists plugin;
• fullscreen button requires fullscreen plugin;
• getPDF button requires print plugin;
• html button requires codeView plugin;
• inlineStyle button requires inlineStyle plugin;
• inlineClass button requires inlineClass plugin;
• insertFile button requires file plugin;
• insertImage button requires image plugin;
• insertLink button requires link plugin;
• insertTable button requires table plugin;
• insertVideo button requires video plugin;
• paragraphFormat button requires paragraphFormat plugin;
• paragraphStyle button requires paragraphStyle plugin;
• print button requires print plugin;
• quote button requires quote plugin;
• specialCharacters button requires specialCharacters plugin;

FroalaOption::toolbarButtonsMD() — Method in class FroalaOption

The list of buttons that appear in the rich text editor's toolbar on medium devices (≥ 992px). By default on MD screens, the editor uses the same buttons as for toolbarButtons.

Note: Some of the buttons above require a specific plugin. See toolbarButtons option for more details.

FroalaOption::toolbarButtonsSM() — Method in class FroalaOption

The list of buttons that appear in the rich text editor's toolbar on small devices (≥ 768px).

Note: Some of the buttons above require a specific plugin. See <a href="#toolbarButtons" title="toolbarButtons option">toolbarButtons option for more details.

FroalaOption::toolbarButtonsXS() — Method in class FroalaOption

The list of buttons that appear in the rich text editor's toolbar on extra small devices (< 768px).

Note: Some of the buttons above require a specific plugin. See <a href="#toolbarButtons" title="toolbarButtons option">toolbarButtons option for more details.

FroalaOption::toolbarContainer() — Method in class FroalaOption

A custom HTML selector placing the toolbar inside.

FroalaOption::toolbarInline() — Method in class FroalaOption

Enable or disable inline mode.

FroalaOption::toolbarSticky() — Method in class FroalaOption

Keeps the toolbar at the top of the editing box in basic mode. Disabling this option, will keep the toolbar at the top of the page when scrolling down.

FroalaOption::toolbarStickyOffset() — Method in class FroalaOption

The offset of the sticky toolbar from top of the page. If <a href="#toolbarBottom" target="_blank" title="toolbarBottom">toolbarBottom option is used, then this option will define the offset of the toolbar from the bottom of the page.

FroalaOption::toolbarVisibleWithoutSelection() — Method in class FroalaOption

Keeps the editor visible next to the cursor even when there is no selection.
Note: This option is available only when the toolbarInline option is set to true.

FroalaOption::tooltips() — Method in class FroalaOption

Control if tooltips are shown when getting with mouse over the buttons from the toolbar.

FroalaOption::typingTimer() — Method in class FroalaOption

Time in milliseconds to define how long the typing pause may be without the change to be saved in the undo stack.

FroalaOption::tableCellMultipleStyles() — Method in class FroalaOption

Allows multiple table cell styles to be selected at a time.

FroalaOption::tableCellStyles() — Method in class FroalaOption

Set custom styles for the selected table cells. The classes should be defined in CSS, otherwise no changes will be visible.

FroalaOption::tableColors() — Method in class FroalaOption

The list of colors used in the edit table colors popup for the background of a table cell. Passing REMOVE as a value in the array will display the Clear Formatting button for the cell background color.

FroalaOption::tableColorsButtons() — Method in class FroalaOption

The list of buttons that appear in the edit table colors popup.

FroalaOption::tableColorsStep() — Method in class FroalaOption

The number of colors displayed on a line in the edit table colors popup.

FroalaOption::tableDefaultWidth() — Method in class FroalaOption

The size of the table when it is inserted in the editor.

FroalaOption::tableEditButtons() — Method in class FroalaOption

The list of buttons that appear in the edit table popup, when one or many cells are selected.

FroalaOption::tableInsertButtons() — Method in class FroalaOption

The list of buttons that appear in the insert table popup, when the <a href="#toolbarInline" title="toolbarInline" target="_blank">toolbarInline option is set to true.

FroalaOption::tableInsertHelper() — Method in class FroalaOption

Insert rows and columns easier by going to the edge of the table.

FroalaOption::tableInsertHelperOffset() — Method in class FroalaOption

The offset for showing the table insert helper.

FroalaOption::tableInsertMaxSize() — Method in class FroalaOption

The maximum number of lines and columns when inserting a table into the rich text editor.

FroalaOption::tableMultipleStyles() — Method in class FroalaOption

Allows multiple table styles to be selected at a time.

FroalaOption::tableResizer() — Method in class FroalaOption

Enables resizing table cells.

FroalaOption::tableResizerOffset() — Method in class FroalaOption

The distance in pixels from the table cell's left or right border at which to show the resizer.

FroalaOption::tableResizingLimit() — Method in class FroalaOption

The minimum width in pixels of a table cell allowed while resizing. The resizer cannot be dragged over this limit.

FroalaOption::tableStyles() — Method in class FroalaOption

Set custom styles for the selected table. The classes should be defined in CSS, otherwise no changes will be visible on the table's appearance.

Option::toArray() — Method in class Option

OptionList::toArray() — Method in class OptionList

Transforms the option into an array.

OptionListProcessorInterface::transformToOptionList() — Method in class OptionListProcessorInterface

OptionListCollectionTrait::transformToOptionList() — Method in class OptionListCollectionTrait

$ Item#type — Property in class Item

$ Item#thumbnail_url — Property in class Item

MenuListItem::toArray() — Method in class MenuListItem

ModalDialog::toArray() — Method in class ModalDialog

Options::toArray() — Method in class Options

Convert options to old link params array

Table — Class in namespace XELOS\Framework\XF\UI

TableEditor — Class in namespace XELOS\Framework\XF\UI

TableEditor::table_editor_cb() — Method in class TableEditor

TableEditor::table_model_sort_cb() — Method in class TableEditor

TableRow — Class in namespace XELOS\Framework\XF\UI

Class TableRow

TableActionHandler — Class in namespace XELOS\Framework\XF\UI\Table

TableActionHandler::triggerAction() — Method in class TableActionHandler

Execute Actions

Tabs — Class in namespace XELOS\Framework\XF\UI

TimeLine — Class in namespace XELOS\Framework\XF\UI

TimeLineRow — Class in namespace XELOS\Framework\XF\UI

Class TimeLineRow

$ TimeLineRow#time_ranges — Property in class TimeLineRow

Translation — Class in namespace XELOS\Framework\XF\UI

xtag to provide a translation service via the Translation module.

Tree — Class in namespace XELOS\Framework\XF\UI

$ Tree#table_query — Property in class Tree

$ ViewModeSwitcher#target_container — Property in class ViewModeSwitcher

Target Container is a CSS Query Selector of DOM Nodes which will be changed when user switches viewmodes

Wizard::take_control() — Method in class Wizard

put your comment there.

$ View#template — Property in class View

$ AdCache#table_name — Property in class AdCache

$ AdCache#table_auto_properties — Property in class AdCache

AdCache::truncate_cache() — Method in class AdCache

$ SynchStatus#table_name — Property in class SynchStatus

$ SynchStatus#table_primary_key — Property in class SynchStatus

$ SynchStatus#table_auto_properties — Property in class SynchStatus

SynchStatus::truncate_status() — Method in class SynchStatus

AdSyncTest::testInstanceIsAvailable() — Method in class AdSyncTest

AdSyncTest::testUserAccountExpires() — Method in class AdSyncTest

$ UserAdminConfig#title — Property in class UserAdminConfig

Title of the tab

$ UserAdminConfig#tabId — Property in class UserAdminConfig

Tab ID

Badge::toArray() — Method in class Badge

AdministrationControllerTest::testGetUserStatusBadgeProviders() — Method in class AdministrationControllerTest

AdministrationControllerTest::testUserExists() — Method in class AdministrationControllerTest

BadgeTest::testBadgeCreate() — Method in class BadgeTest

BadgeTest::testBadgeRender() — Method in class BadgeTest

BadgeTest::testBadgeToArray() — Method in class BadgeTest

PasswordActionTest::testInstanceIsAvailable() — Method in class PasswordActionTest

PasswordActionTest::testPasswordComplexity() — Method in class PasswordActionTest

SystemCronTest::testInstanceIsAvailable() — Method in class SystemCronTest

SystemCronTest::testCronIsAvailable() — Method in class SystemCronTest

SystemCronTest::testCleanTempFolders() — Method in class SystemCronTest

UserAdminHookTest::testHookLoading() — Method in class UserAdminHookTest

$ MicrosoftOauthClient#title — Property in class MicrosoftOauthClient

$ OnedriveOauthClient#title — Property in class OnedriveOauthClient

$ Subscription#table_name — Property in class Subscription

$ Subscription#table_auto_properties — Property in class Subscription

$ Subscription#table_use_group_id — Property in class Subscription

$ OpenidOauthClient#title — Property in class OpenidOauthClient

$ SamlAuthentication#ttl — Property in class SamlAuthentication

$ Calendar#type: — Property in class Calendar

default|remote_cal

$ Calendar#title: — Property in class Calendar

stored in MySQL as varchar

$ Event#title: — Property in class Event

stored in MySQL as varchar

$ ReminderQueue#trigger_date: — Property in class ReminderQueue

stored in MySQL as timestamp

$ ReminderQueue#triggered_at: — Property in class ReminderQueue

stored in MySQL as timestamp

$ Page#tree — Property in class Page

Page::tree() — Method in class Page

$ HistoryPage#title: — Property in class HistoryPage

stored in MySQL as varchar

$ Page#title: — Property in class Page

stored in MySQL as varchar

$ PageLive#title: — Property in class PageLive

stored in MySQL as varchar

$ Partial#title: — Property in class Partial

stored in MySQL as varchar

$ PartialLive#title: — Property in class PartialLive

stored in MySQL as varchar

$ LinkInfo#title: — Property in class LinkInfo

stored in MySQL as varchar

$ LinkInfo#type: — Property in class LinkInfo

stored in MySQL as varchar

$ Comment#table_name — Property in class Comment

$ Comment#table_use_group_id — Property in class Comment

$ LinkInfo#table_name — Property in class LinkInfo

$ LinkInfo#table_use_group_id — Property in class LinkInfo

$ LinkInfo#table_auto_properties — Property in class LinkInfo

$ CrmControllerTest#tester — Property in class CrmControllerTest

CrmControllerTest::testInstanceIsAvailable() — Method in class CrmControllerTest

CrmControllerTest::testAlternativeSubstitution() — Method in class CrmControllerTest

CrmControllerTest::testStaticTextReplacement() — Method in class CrmControllerTest

Simple test to ensure the replace_contact_vars and render_static_field methods properly replace contact variables and static-text-templates.

TrashAction — Class in namespace XELOS\Modules\DMS\Action

TemplatesPage — Class in namespace XELOS\Modules\DMS\Page

Class TemplatesPage

TrashPage — Class in namespace XELOS\Modules\DMS\Page

Class TrashPage

$ CategoryDocumentation#title_i18n: — Property in class CategoryDocumentation

stored in MySQL as varchar

$ EventDocumentation#title: — Property in class EventDocumentation

stored in MySQL as varchar

$ RelatedEventsDocumentation#title: — Property in class RelatedEventsDocumentation

stored in MySQL as varchar

$ EventplannerController#title — Property in class EventplannerController

$ CRMParticipationShowPortlet#title — Property in class CRMParticipationShowPortlet

$ Category#table_name — Property in class Category

$ Category#table_auto_properties — Property in class Category

$ Category#table_use_group_id — Property in class Category

$ Event#table_name — Property in class Event

$ Event#table_auto_properties — Property in class Event

$ Event#table_use_group_id — Property in class Event

$ Event#tags — Property in class Event

$ InvitationReplyLog#table_name — Property in class InvitationReplyLog

$ InvitationReplyLog#table_auto_properties — Property in class InvitationReplyLog

$ Numberrange#table_auto_properties — Property in class Numberrange

$ Numberrange#table_name — Property in class Numberrange

$ Participant#table_name — Property in class Participant

$ Participant#table_auto_properties — Property in class Participant

$ ParticipantLog#table_name — Property in class ParticipantLog

$ ParticipantLog#table_auto_properties — Property in class ParticipantLog

$ RelatedEvents#table_name — Property in class RelatedEvents

$ RelatedEvents#table_auto_properties — Property in class RelatedEvents

ParticipantsPage::table_question_cb() — Method in class ParticipantsPage

ParticipantsPage::table_unknown_response_cb() — Method in class ParticipantsPage

ParticipantsPage::table_action_cb() — Method in class ParticipantsPage

ParticipantsPage::table_unknown_action_cb() — Method in class ParticipantsPage

ThreadAction — Class in namespace XELOS\Modules\Forum\Action

Class ThreadAction

ThreadCollection — Class in namespace XELOS\Modules\Forum\Collection

$ Action#thread — Property in class Action

$ Model#thread — Property in class Model

Model::thread() — Method in class Model

$ Ui#thread_preview — Property in class Ui

$ CategoryDocumentation#tree_id — Property in class CategoryDocumentation

$ CategoryDocumentation#title: — Property in class CategoryDocumentation

stored in MySQL as varchar

$ CategoryDocumentation#type: — Property in class CategoryDocumentation

enum discussion|voting|question

$ PostDocumentation#thread_id — Property in class PostDocumentation

$ PostDocumentation#title: — Property in class PostDocumentation

stored in MySQL as varchar

ThreadDocumentation — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Thread.

$ ThreadDocumentation#title: — Property in class ThreadDocumentation

stored in MySQL as varchar

$ ThreadDocumentation#type: — Property in class ThreadDocumentation

enum default','question

$ VotesDocumentation#thread_id — Property in class VotesDocumentation

ThreadActionTrait — Class in namespace XELOS\Modules\Forum\Hook\Workflows

ThreadPayload — Class in namespace XELOS\Modules\Forum\Hook\Workflows

$ Category#table_name — Property in class Category

$ Category#table_use_group_id — Property in class Category

$ Category#table_auto_properties — Property in class Category

$ Post#table_name — Property in class Post

$ Post#table_use_group_id — Property in class Post

$ Post#table_auto_properties — Property in class Post

Thread — Class in namespace XELOS\Modules\Forum\Model

$ Thread#table_name — Property in class Thread

$ Thread#table_use_group_id — Property in class Thread

$ Thread#table_auto_properties — Property in class Thread

ThreadState — Class in namespace XELOS\Modules\Forum\Model

Class ThreadState

$ Votes#table_name — Property in class Votes

$ Votes#table_auto_properties — Property in class Votes

ForumTest::testInitializationComplete() — Method in class ForumTest

ForumTest::testFillVars() — Method in class ForumTest

ThreadPreview — Class in namespace XELOS\Modules\Forum\UI

Class ThreadPreview

GeoIpTest::testInstanceIsAvailable() — Method in class GeoIpTest

GeoIpTest::testGeoIPCountryWhoisFile() — Method in class GeoIpTest

Test for presence and format of GeoIPCountryWhois.csv.zip

GeoIpTest::testGeoIpAuthentication() — Method in class GeoIpTest

$ GeoFeature#type — Property in class GeoFeature

GeoSelectorProcessor::transformToOptionList() — Method in class GeoSelectorProcessor

Takes all fetched geolocation features and puts them into an OptionList to be able to provide it as selectable items for the FormChoice component.

$ Location#table_name — Property in class Location

$ Location#table_auto_properties — Property in class Location

$ Location#type_key — Property in class Location

TestPage — Class in namespace XELOS\Modules\Geodb\Page

TaskCollection — Class in namespace XELOS\Modules\GroupsTasks\Collection

TaskListCollection — Class in namespace XELOS\Modules\GroupsTasks\Collection

$ Model#task — Property in class Model

$ Model#task_list — Property in class Model

$ Model#task_list_column — Property in class Model

Model::task() — Method in class Model

Model::task_list() — Method in class Model

Model::task_list_column() — Method in class Model

$ Ui#task — Property in class Ui

$ Ui#tasks_list — Property in class Ui

TaskDocumentation — Class in namespace XELOS\Modules\GroupsTasks\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Task.

$ TaskDocumentation#type: — Property in class TaskDocumentation

enum open|closed

$ TaskDocumentation#title: — Property in class TaskDocumentation

stored in MySQL as varchar

Task — Class in namespace XELOS\Modules\GroupsTasks\Model

$ Task#table_use_group_id — Property in class Task

TaskList — Class in namespace XELOS\Modules\GroupsTasks\Model

Class TaskList

$ TaskList#table_name — Property in class TaskList

$ TaskList#table_use_group_id — Property in class TaskList

TaskListColumn — Class in namespace XELOS\Modules\GroupsTasks\Model

Task — Class in namespace XELOS\Modules\GroupsTasks\UI

TasksList — Class in namespace XELOS\Modules\GroupsTasks\UI

Template — Class in namespace XELOS\Modules\Groups\Console

Class Group

$ Category#tree_id — Property in class Category

$ Category#title_i18n — Property in class Category

$ Group#title_i18n: — Property in class Group

stored in MySQL as varchar

$ Group#teaser_i18n: — Property in class Group

stored in MySQL as varchar

$ Group#todelete: — Property in class Group

stored in MySQL as tinyint

$ Group#template_group_id — Property in class Group

$ Module#template_init: — Property in class Module

enum finished

$ GroupsExtension#title — Property in class GroupsExtension

TravelCollection — Class in namespace XELOS\Modules\HRM\Collection

TimesheetState — Class in namespace XELOS\Modules\Hrm\Model

Class TimesheetState

$ Page#test — Property in class Page

Page::test() — Method in class Page

TestJob — Class in namespace XELOS\Modules\JobQueue\Infrastructure\Job

Class TestJob (FOR INTERNAL TESTS ONLY)

$ Job#table_name — Property in class Job

$ Job#table_auto_properties — Property in class Job

$ JobHistory#table_name — Property in class JobHistory

$ JobHistory#table_auto_properties — Property in class JobHistory

TestPage — Class in namespace XELOS\Modules\JobQueue\Page

Class TestPage (FOR INTERNAL TESTS ONLY)

$ PageDocumentation#title_i18n: — Property in class PageDocumentation

stored in MySQL as varchar

$ Page#table_name — Property in class Page

$ Page#table_auto_properties — Property in class Page

LegalControllerTest::testInstanceIsAvailable() — Method in class LegalControllerTest

$ CategoryDocumentation#title: — Property in class CategoryDocumentation

stored in MySQL as varchar

$ ListDocumentation#title: — Property in class ListDocumentation

stored in MySQL as varchar

$ ListDocumentation#template_id — Property in class ListDocumentation

$ ListStatusDocumentation#title: — Property in class ListStatusDocumentation

stored in MySQL as varchar

Ticket — Class in namespace XELOS\Modules\Lists\Hook\Base\Field\Resource

Tag — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Textarea — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Textbox — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

Timespan — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

ToggleSwitch — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

TimespanGetEvents — Class in namespace XELOS\Modules\Lists\Hook\Calendar

Class TimespanGetEvents

TemplateContext — Class in namespace XELOS\Modules\Lists\Hook\Pages\Context

ListItemPayload::to_html() — Method in class ListItemPayload

Get payload as HTML

$ Category#table_name — Property in class Category

$ Category#table_auto_properties — Property in class Category

$ Category#table_use_group_id — Property in class Category

$ Category#title — Property in class Category

: stored in MySQL as varchar

$ ListItem#table_name — Property in class ListItem

$ ListItem#table_auto_properties — Property in class ListItem

$ ListItem#table_use_group_id — Property in class ListItem

$ ListProperties#table_name — Property in class ListProperties

$ ListProperties#table_auto_properties — Property in class ListProperties

$ ListProperties#table_use_group_id — Property in class ListProperties

$ ListProperties#title — Property in class ListProperties

Title

$ ListProperties#timespan_label — Property in class ListProperties

The field name of the label used for the calendar hook.

$ ListProperties#timespan_location — Property in class ListProperties

The field name of the location used for the calendar hook.

$ ListProperties#timespan_user — Property in class ListProperties

The field name of the user used for the calendar hook.

$ ListStatus#table_name — Property in class ListStatus

$ ListStatus#table_auto_properties — Property in class ListStatus

$ ListStatus#table_use_group_id — Property in class ListStatus

$ ListStatus#title — Property in class ListStatus

: stored in MySQL as varchar

ListsControllerTest::testInstanceIsAvailable() — Method in class ListsControllerTest

ListsControllerTest::testListItemValidation() — Method in class ListsControllerTest

$ Model#tab — Property in class Model

Model::tab() — Method in class Model

$ Property#type: — Property in class Property

stored in MySQL as varchar

$ PropertyGroup#type: — Property in class PropertyGroup

stored in MySQL as varchar

$ PropertyTab#title_i18n: — Property in class PropertyTab

stored in MySQL as varchar

Tagging — Class in namespace XELOS\Modules\Lookbook\Fields

Text — Class in namespace XELOS\Modules\Lookbook\Fields

$ LookbookControllerTest#tester — Property in class LookbookControllerTest

LookbookControllerTest::testInstanceIsAvailable() — Method in class LookbookControllerTest

Basic instance existence test

LookbookControllerTest::testUmlautSubstitution() — Method in class LookbookControllerTest

$ LookbookFoafTest#tester — Property in class LookbookFoafTest

LookbookFoafTest::testFoafGetAllContacts() — Method in class LookbookFoafTest

LookbookFoafTest::testFoafGetConnectionPath() — Method in class LookbookFoafTest

$ LookbookProfileTest#tester — Property in class LookbookProfileTest

LookbookProfileTest::testPropertySearchQuery() — Method in class LookbookProfileTest

Test property search query

LookbookProfileTest::testShortProfileMethodCompatibility() — Method in class LookbookProfileTest

Test wether the mimic function is behaving backwards compatible to the original function

$ ArticleDocumentation#title_i18n: — Property in class ArticleDocumentation

stored in MySQL as varchar

$ ArticleDocumentation#topnews_enabled: — Property in class ArticleDocumentation

stored in MySQL as tinyint

$ CategoryDocumentation#title_i18n: — Property in class CategoryDocumentation

stored in MySQL as varchar

$ Article#table_auto_properties — Property in class Article

$ Article#table_name — Property in class Article

$ Article#tmppath — Property in class Article

$ Article#tmplocation — Property in class Article

$ Category#table_auto_properties — Property in class Category

$ Category#table_name — Property in class Category

$ Category#table_use_group_id — Property in class Category

$ Category#tmppath — Property in class Category

$ Category#tmplocation — Property in class Category

$ NewsController#teaser_img_threshold — Property in class NewsController

NewsControllerTest::testInstanceIsAvailable() — Method in class NewsControllerTest

$ Model#template — Property in class Model

$ Model#template_category — Property in class Model

Model::template() — Method in class Model

Model::template_category() — Method in class Model

$ PageDocumentation#title_i18n: — Property in class PageDocumentation

stored in MySQL as varchar

$ PageDocumentation#type: — Property in class PageDocumentation

enum page|folder|separator

$ PageVersionDocumentation#title_i18n: — Property in class PageVersionDocumentation

stored in MySQL as varchar

JsonPathElement::test() — Method in class JsonPathElement

$ Component#table_name — Property in class Component

$ Component#table_auto_properties — Property in class Component

$ Component#table_use_group_id — Property in class Component

$ Page#table_name — Property in class Page

$ Page#table_auto_properties — Property in class Page

$ Page#table_use_group_id — Property in class Page

$ Page#title_i18n — Property in class Page

$ Page#type — Property in class Page

$ PageVersion#table_name — Property in class PageVersion

$ PageVersion#table_auto_properties — Property in class PageVersion

$ PageVersion#table_use_group_id — Property in class PageVersion

$ PageVersion#title_i18n — Property in class PageVersion

Template — Class in namespace XELOS\Modules\Pages\Model

$ Template#table_name — Property in class Template

$ Template#table_auto_properties — Property in class Template

$ Template#title_i18n — Property in class Template

$ Template#template_category_id — Property in class Template

TemplateCategory — Class in namespace XELOS\Modules\Pages\Model

$ TemplateCategory#table_name — Property in class TemplateCategory

$ TemplateCategory#table_auto_properties — Property in class TemplateCategory

$ TemplateCategory#title_i18n — Property in class TemplateCategory

PortletHookTest::testHookLoading() — Method in class PortletHookTest

Test if Portlet Hooks are working as expected (Basic Test)

$ Workspace#table_name — Property in class Workspace

$ Workspace#table_auto_properties — Property in class Workspace

$ PersonalWorkspaceControllerTest#tester — Property in class PersonalWorkspaceControllerTest

PersonalWorkspaceControllerTest::testInstanceIsAvailable() — Method in class PersonalWorkspaceControllerTest

Basic instance test

PersonalWorkspaceControllerTest::testGetWorkspace() — Method in class PersonalWorkspaceControllerTest

Basic instance test

$ Confirmation#table_name — Property in class Confirmation

$ Confirmation#table_auto_properties — Property in class Confirmation

$ Confirmation#table_use_group_id — Property in class Confirmation

$ Document#table_name — Property in class Document

$ Document#table_auto_properties — Property in class Document

$ Document#table_use_group_id — Property in class Document

$ Model#term — Property in class Model

Model::term() — Method in class Model

$ FacetedFilterDocumentation#type: — Property in class FacetedFilterDocumentation

enum global|hook

$ SearchHistoryDocumentation#term — Property in class SearchHistoryDocumentation

$ SearchagentDocumentation#title — Property in class SearchagentDocumentation

TermDocumentation — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Term.

$ TermDocumentation#term: — Property in class TermDocumentation

stored in MySQL as varchar

$ FacetedFilter#table_name — Property in class FacetedFilter

$ FacetedFilter#table_auto_properties — Property in class FacetedFilter

$ SearchHistory#table_name — Property in class SearchHistory

$ SearchHistory#table_auto_properties — Property in class SearchHistory

$ Searchagent#table_auto_properties — Property in class Searchagent

$ Searchagent#table_name — Property in class Searchagent

Term — Class in namespace XELOS\Modules\Search\Model

$ Term#table_name — Property in class Term

$ Term#table_auto_properties — Property in class Term

$ SearchIndexContentRecord#title — Property in class SearchIndexContentRecord

$ SearchIndexRecord#title — Property in class SearchIndexRecord

$ SearchIndexRecord#tags — Property in class SearchIndexRecord

TabsTrait — Class in namespace XELOS\Modules\Search\UI\Traits

$ TabsTrait#tabs — Property in class TabsTrait

$ AbstractBrowserItem#thumbnail_url — Property in class AbstractBrowserItem

UserSelectorProcessor::transformToOptionList() — Method in class UserSelectorProcessor

$ Page#templates — Property in class Page

Page::templates() — Method in class Page

$ PageDocumentation#title: — Property in class PageDocumentation

stored in MySQL as varchar

$ PageHistoryDocumentation#title: — Property in class PageHistoryDocumentation

stored in MySQL as varchar

$ PageLinkDocumentation#to_page_id — Property in class PageLinkDocumentation

$ PageLinkDocumentation#to_page_slug: — Property in class PageLinkDocumentation

stored in MySQL as varchar

$ PageLinkDocumentation#to_version_id — Property in class PageLinkDocumentation

$ Page#table_use_group_id — Property in class Page

$ Page#table_name — Property in class Page

$ Page#table_auto_properties — Property in class Page

$ Page#title — Property in class Page

$ PageHistory#table_name — Property in class PageHistory

$ PageHistory#table_use_group_id — Property in class PageHistory

$ PageHistory#table_auto_properties — Property in class PageHistory

$ PageLink#table_name — Property in class PageLink

$ PageLink#table_use_group_id — Property in class PageLink

$ PageLink#table_auto_properties — Property in class PageLink

TemplatesPage — Class in namespace XELOS\Modules\SmartWiki\Page

Class TemplatesPage

$ EntryDocumentation#target_user_id — Property in class EntryDocumentation

$ DocumentWallItem#table_auto_properties — Property in class DocumentWallItem

$ DocumentWallItem#table_name — Property in class DocumentWallItem

$ Entry#table_name — Property in class Entry

$ HiddenInstance#table_auto_properties — Property in class HiddenInstance

$ HiddenInstance#table_name — Property in class HiddenInstance

$ EventTrigger#trigger_config: — Property in class EventTrigger

stored in MySQL as text

$ LicenseProblem#time: — Property in class LicenseProblem

stored in MySQL as timestamp

TrashAction — Class in namespace XELOS\Modules\SystemDMS\Action

$ CrmPortletShowTab#title — Property in class CrmPortletShowTab

$ CrmPortletShowTab#tab_id — Property in class CrmPortletShowTab

$ WebdavService#tmp_file_name — Property in class WebdavService

$ Category#tree — Property in class Category

$ Category#table_name — Property in class Category

$ Category#table_auto_properties — Property in class Category

$ Category#table_use_group_id — Property in class Category

$ Document#table_name — Property in class Document

$ Document#table_use_group_id — Property in class Document

$ Document#table_auto_properties — Property in class Document

$ DocumentHistory#table_auto_properties — Property in class DocumentHistory

$ DocumentHistory#table_name — Property in class DocumentHistory

$ DocumentHistory#table_primary_compound_key — Property in class DocumentHistory

$ DocumentMetaData#table_name — Property in class DocumentMetaData

$ DocumentMetaData#table_use_group_id — Property in class DocumentMetaData

$ DocumentMetaData#table_auto_properties — Property in class DocumentMetaData

$ DocumentMetaField#table_name — Property in class DocumentMetaField

$ DocumentMetaField#table_use_group_id — Property in class DocumentMetaField

$ DocumentMetaField#table_auto_properties — Property in class DocumentMetaField

DocumentMetaField::transformValueFromField() — Method in class DocumentMetaField

The fields from the FormEditor seem to behave a little different than these from ordinary forms, which is why this method exists.

$ DocumentTemplate#table_name — Property in class DocumentTemplate

$ DocumentTemplate#table_auto_properties — Property in class DocumentTemplate

$ DocumentTemplate#table_use_group_id — Property in class DocumentTemplate

$ FileTemplate#table_name — Property in class FileTemplate

$ FileTemplate#table_auto_properties — Property in class FileTemplate

$ FileTemplate#table_use_group_id — Property in class FileTemplate

$ FileTemplate#templates_location — Property in class FileTemplate

$ Preview#table_name — Property in class Preview

$ Preview#table_auto_properties — Property in class Preview

$ Preview#table_use_group_id — Property in class Preview

$ ZipImportJob#table_name — Property in class ZipImportJob

$ ZipImportJob#table_use_group_id — Property in class ZipImportJob

$ ZipImportJob#table_auto_properties — Property in class ZipImportJob

TemplatesPage — Class in namespace XELOS\Modules\SystemDMS\Page

Class xpage_system_dms_templates

TemplatesPage::template_table_cb() — Method in class TemplatesPage

Callback function returning the action links in the template list.

TrashPage — Class in namespace XELOS\Modules\SystemDMS\Page

Class TrashPage

$ SystemDMSController#table_show_export — Property in class SystemDMSController

$ SystemDMSController#table_show_version — Property in class SystemDMSController

$ SystemDMSController#table_show_summary — Property in class SystemDMSController

$ SystemDMSController#table_show_size — Property in class SystemDMSController

$ SystemDMSController#table_show_owner — Property in class SystemDMSController

$ SystemDMSController#table_show_date — Property in class SystemDMSController

$ SystemDMSController#table_show_select_column — Property in class SystemDMSController

$ CategoryCest#tester — Property in class CategoryCest

$ SystemDMSControllerTest#tester — Property in class SystemDMSControllerTest

SystemDMSControllerTest::testInstanceIsAvailable() — Method in class SystemDMSControllerTest

Basic instance test

SystemDMSControllerTest::testEnsureInitialization() — Method in class SystemDMSControllerTest

$ Action#trash — Property in class Action

$ Page#templates — Property in class Page

$ Page#trash — Property in class Page

Page::templates() — Method in class Page

Page::trash() — Method in class Page

$ Category#template_id — Property in class Category

$ Document#template_id — Property in class Document

$ Document#tag — Property in class Document

$ DocumentHistory#template_id — Property in class DocumentHistory

$ DocumentMetaField#template_id — Property in class DocumentMetaField

$ DocumentMetaField#type — Property in class DocumentMetaField

: stored in MySQL as varchar

$ DocumentTemplate#title — Property in class DocumentTemplate

: stored in MySQL as varchar

$ FileTemplate#title — Property in class FileTemplate

: stored in MySQL as varchar

$ FileTemplate#type — Property in class FileTemplate

: stored in MySQL as varchar

$ FileTemplate#template_file: — Property in class FileTemplate

stored in MySQL as varchar

$ Preview#type — Property in class Preview

$ ZipImportJob#tmp_folder — Property in class ZipImportJob

: stored in MySQL as varchar

$ ZipImportJob#total_count — Property in class ZipImportJob

TodoPortlet — Class in namespace XELOS\Modules\SystemNotification\Hook\Pages

$ UserSetting#table_name — Property in class UserSetting

$ UserSetting#table_auto_properties — Property in class UserSetting

SystemNotificationTest::testInstanceIsAvailable() — Method in class SystemNotificationTest

SystemNotificationTest::testNotificationBuilder() — Method in class SystemNotificationTest

SystemNotificationTest::testPriority() — Method in class SystemNotificationTest

$ PushSubscription#table_name — Property in class PushSubscription

$ PushSubscription#table_auto_properties — Property in class PushSubscription

$ EventDocumentation#type: — Property in class EventDocumentation

enum login|login_failed|logout|download|page call

$ AggregateDimension#table_name — Property in class AggregateDimension

$ AggregateDimension#table_auto_properties — Property in class AggregateDimension

$ AggregateNumeric#table_name — Property in class AggregateNumeric

$ AggregateNumeric#table_auto_properties — Property in class AggregateNumeric

$ Event#table_name — Property in class Event

$ Event#table_auto_properties — Property in class Event

$ CheckDocumentation#title: — Property in class CheckDocumentation

stored in MySQL as varchar

$ NodeDocumentation#title: — Property in class NodeDocumentation

stored in MySQL as varchar

$ Check#title — Property in class Check

$ Result#type — Property in class Result

Type of influence on system -> Performance, Stability

$ Result#TYPE_STABILITY — Property in class Result

$ Result#TYPE_PERFORMANCE — Property in class Result

$ Result#title — Property in class Result

TimeCheck — Class in namespace XELOS\Modules\SystemStatus\Hook\SystemStatus

$ Check#table_name — Property in class Check

$ Check#table_auto_properties — Property in class Check

$ Node#table_name — Property in class Node

$ Node#table_auto_properties — Property in class Node

TaskCollection — Class in namespace XELOS\Modules\SystemTasks\Collection

TaskListCollection — Class in namespace XELOS\Modules\SystemTasks\Collection

$ Model#task — Property in class Model

$ Model#task_list — Property in class Model

$ Model#task_list_column — Property in class Model

Model::task() — Method in class Model

Model::task_list() — Method in class Model

Model::task_list_column() — Method in class Model

$ Ui#task — Property in class Ui

$ Ui#tasks_list — Property in class Ui

$ RecurringTaskDocumentation#task_id — Property in class RecurringTaskDocumentation

$ RecurringTaskDocumentation#target_list_id — Property in class RecurringTaskDocumentation

$ RecurringTaskDocumentation#target_list_column_id — Property in class RecurringTaskDocumentation

TaskDocumentation — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Task.

$ TaskDocumentation#type: — Property in class TaskDocumentation

enum open|closed

$ TaskDocumentation#title: — Property in class TaskDocumentation

stored in MySQL as varchar

TaskManagementNavigation — Class in namespace XELOS\Modules\SystemTasks\Hook\Dashboard

TasksPortlet — Class in namespace XELOS\Modules\SystemTasks\Hook\Pages

$ RecurringTask#table_name — Property in class RecurringTask

$ RecurringTask#table_auto_properties — Property in class RecurringTask

$ RecurringTask#table_use_group_id — Property in class RecurringTask

Task — Class in namespace XELOS\Modules\SystemTasks\Model

$ Task#table_name — Property in class Task

$ Task#table_use_group_id — Property in class Task

$ Task#table_auto_properties — Property in class Task

$ Task#type — Property in class Task

'open', 'closed'

$ Task#title — Property in class Task

TaskList — Class in namespace XELOS\Modules\SystemTasks\Model

$ TaskList#table_name — Property in class TaskList

$ TaskList#table_use_group_id — Property in class TaskList

$ TaskList#table_auto_properties — Property in class TaskList

$ TaskList#title — Property in class TaskList

$ TaskList#type — Property in class TaskList

$ TaskList#task_labels — Property in class TaskList

TaskListColumn — Class in namespace XELOS\Modules\SystemTasks\Model

$ TaskListColumn#table_name — Property in class TaskListColumn

$ TaskListColumn#table_use_group_id — Property in class TaskListColumn

$ TaskListColumn#table_auto_properties — Property in class TaskListColumn

$ TaskListColumn#title — Property in class TaskListColumn

TaskTest — Class in namespace XELOS\Modules\SystemTasks\Tests\Codeception\Unit

Class CategoryTest

$ TaskTest#tester — Property in class TaskTest

TaskTest::testInstanceIsAvailable() — Method in class TaskTest

Basic instance existence test

TaskTest::taskPropertiesProvider() — Method in class TaskTest

Task — Class in namespace XELOS\Modules\SystemTasks\UI

TasksList — Class in namespace XELOS\Modules\SystemTasks\UI

$ PushClient#type: — Property in class PushClient

enum ios|android|winphone|blackberry|unknown

TagCollection — Class in namespace XELOS\Modules\Tagging\Collection

$ Model#Tag — Property in class Model

$ Model#TagDocument — Property in class Model

Model::Tag() — Method in class Model

Model::TagDocument() — Method in class Model

$ Page#tag — Property in class Page

Page::tag() — Method in class Page

TagDocumentation — Class in namespace XELOS\Modules\Tagging\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Tag.

$ TagDocumentation#tag_text: — Property in class TagDocumentation

stored in MySQL as varchar

$ TagDocumentation#tag_count: — Property in class TagDocumentation

stored in MySQL as varchar

$ TagDocumentation#type: — Property in class TagDocumentation

'user', 'curated', 'deprecated'

TaggingControllerDocumentation — Class in namespace XELOS\Modules\Tagging\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

TaggingNavigation — Class in namespace XELOS\Modules\Tagging\Hook\Dashboard

Tag — Class in namespace XELOS\Modules\Tagging\Model

$ Tag#table_name — Property in class Tag

var string Table name for this model

$ Tag#table_use_group_id — Property in class Tag

$ Tag#table_auto_properties — Property in class Tag

TagDocument — Class in namespace XELOS\Modules\Tagging\Model

$ TagDocument#table_name — Property in class TagDocument

var string Table name for this model

$ TagDocument#table_use_group_id — Property in class TagDocument

$ TagDocument#table_auto_properties — Property in class TagDocument

$ TagDocument#tag_id — Property in class TagDocument

TagPage — Class in namespace XELOS\Modules\Tagging\Page

Display Tag-Suggestion Page (Used for AJAX Tag Auto-Suggest Calls)

TaggingController — Class in namespace XELOS\Modules\Tagging

Tagging Helper provides system-wide tagging capabilities

TemplateMaAppController — Class in namespace XELOS\Modules\TemplateMaApp

TranslateAction — Class in namespace XELOS\Modules\Translation\Action

TranslateAction::translate() — Method in class TranslateAction

$ Action#translate — Property in class Action

Action::translate() — Method in class Action

$ Model#translation — Property in class Model

$ Model#translation_document — Property in class Model

$ Model#translation_feedback — Property in class Model

$ Model#translation_job — Property in class Model

Model::translation() — Method in class Model

Model::translation_document() — Method in class Model

Model::translation_feedback() — Method in class Model

Model::translation_job() — Method in class Model

$ Page#test — Property in class Page

Page::test() — Method in class Page

TranslationDocumentDocumentation — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\Model

This file provides property and method documentation for the model TranslationDocument.

TranslationDocumentation — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Translation.

TranslationFeedbackDocumentation — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\Model

This file provides property and method documentation for the model TranslationFeedback.

$ TranslationFeedbackDocumentation#target_language: — Property in class TranslationFeedbackDocumentation

stored in MySQL as varchar

TranslationJobDocumentation — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\Model

This file provides property and method documentation for the model TranslationJob.

$ TranslationJobDocumentation#target_model: — Property in class TranslationJobDocumentation

enum translation_document|translation|translation_feedback

$ TranslationJobDocumentation#target_id — Property in class TranslationJobDocumentation

$ TranslationJobDocumentation#target_language: — Property in class TranslationJobDocumentation

stored in MySQL as varchar

TranslationControllerDocumentation — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

TranslationException — Class in namespace XELOS\Modules\Translation\Exception

TranslationSettingsLanguageConfig — Class in namespace XELOS\Modules\Translation\Hook\Administration

TranslateProcessor — Class in namespace XELOS\Modules\Translation\Hook\Doclink

Class TranslateProcessor

TranslateProcessor::translate() — Method in class TranslateProcessor

TranslateDocumentSearchPreprocessor — Class in namespace XELOS\Modules\Translation\Hook\Search

Is triggered when a document_index is created or modified. Check if the translation API has to be called.

TranslationInProgressFrontendHook — Class in namespace XELOS\Modules\Translation\Hook\System

Class TranslationInProgressMultiplex

$ BaseTranslationApi#target_language — Property in class BaseTranslationApi

$ BaseTranslationApi#translated_content — Property in class BaseTranslationApi

BaseTranslationApi::translate() — Method in class BaseTranslationApi

Translates content to target language. Possible errors should be added to the error array.

Deepl::translate() — Method in class Deepl

Transperfect — Class in namespace XELOS\Modules\Translation\Lib\Api

Transperfect::translate() — Method in class Transperfect

$ CommonOperationsTrait#TRANSLATED_CONTENT_PROPERTY_START — Property in class CommonOperationsTrait

Translation — Class in namespace XELOS\Modules\Translation\Model

Class Translation

$ Translation#table_name — Property in class Translation

$ Translation#table_auto_properties — Property in class Translation

TranslationDocument — Class in namespace XELOS\Modules\Translation\Model

Class TranslationDocument

$ TranslationDocument#table_name — Property in class TranslationDocument

$ TranslationDocument#table_auto_properties — Property in class TranslationDocument

TranslationFeedback — Class in namespace XELOS\Modules\Translation\Model

Class Translation

$ TranslationFeedback#table_name — Property in class TranslationFeedback

$ TranslationFeedback#table_auto_properties — Property in class TranslationFeedback

TranslationJob — Class in namespace XELOS\Modules\Translation\Model

Class Translation

$ TranslationJob#table_name — Property in class TranslationJob

$ TranslationJob#table_auto_properties — Property in class TranslationJob

TestPage — Class in namespace XELOS\Modules\Translation\Page

Pages for the GECKO registration process.

TranslationControllerHelper — Class in namespace XELOS\Modules\Translation\Tests\Codeception\Support\Helper

TranslationControllerTest — Class in namespace XELOS\Modules\Translation\Tests\Codeception\Unit

Class TranslationControllerTest

$ TranslationControllerTest#tester — Property in class TranslationControllerTest

$ TranslationControllerTest#translationHelper — Property in class TranslationControllerTest

TranslationControllerTest::testInstanceIsAvailable() — Method in class TranslationControllerTest

Basic instance test

TranslationControllerTest::testIsValidTranslationModelName() — Method in class TranslationControllerTest

Basic function test

TranslationControllerTest::testIsValidLocale() — Method in class TranslationControllerTest

TranslationControllerTest::translationModelnameProvider() — Method in class TranslationControllerTest

TranslationControllerTest::testProcessDaemonOndemand() — Method in class TranslationControllerTest

Complex test of main translation functionality and mocked API (instance setting: ondemand = true)

TranslationControllerTest::testProcessDaemonDefault() — Method in class TranslationControllerTest

Complex test of main translation functionality and mocked API (instance setting: ondemand = false)

TranslationControllerTest::testGetTranslated() — Method in class TranslationControllerTest

Test to run through the core functionality of the translation Module.

TranslationController — Class in namespace XELOS\Modules\Translation

TranslationController::translate() — Method in class TranslationController

Get one-time translation without caching and immediate translation response

TrendvoteCollection — Class in namespace XELOS\Modules\Trendvote\Collection

$ Model#trendvote — Property in class Model

Model::trendvote() — Method in class Model

$ Result#trendvote_id — Property in class Result

Trendvote — Class in namespace XELOS\Modules\Trendvote\Docs\ClassGenerated\Model

This file provides property and method documentation for the model trendvote.

$ Trendvote#title: — Property in class Trendvote

stored in MySQL as varchar

$ Trendvote#timing: — Property in class Trendvote

stored in MySQL as tinyint

$ Result#table_auto_properties — Property in class Result

$ Result#table_name — Property in class Result

Trendvote — Class in namespace XELOS\Modules\Trendvote\Model

Class xmodel_trendvote_trendvote

$ Trendvote#table_auto_properties — Property in class Trendvote

$ Trendvote#table_name — Property in class Trendvote

$ Trendvote#title — Property in class Trendvote

$ Trendvote#timing — Property in class Trendvote

TrendvoteController — Class in namespace XELOS\Modules\Trendvote

Trendvote — Class in namespace XELOS\Modules\Trendvote\ui

$ File#table_name — Property in class File

$ File#table_auto_properties — Property in class File

$ Scan#table_name — Property in class Scan

$ Scan#table_auto_properties — Property in class Scan

ModelCRUD::translatePropertyType() — Method in class ModelCRUD

Translates between webservice and database types

Types — Class in namespace XELOS\Modules\Webservice\Hook\Base\Service

XSD Types for service method parameters.

$ OAuthClientHook#title — Property in class OAuthClientHook

Title for this OAuth Client Hook will be used in create modal client

OAuthClient::toArray() — Method in class OAuthClient

$ OpenIDConfiguration#tokenEndpoint — Property in class OpenIDConfiguration

$ OauthAccess#table_name — Property in class OauthAccess

$ OauthAccess#table_use_group_id — Property in class OauthAccess

$ OauthAccess#table_auto_properties — Property in class OauthAccess

$ Category#table_name — Property in class Category

$ Category#table_auto_properties — Property in class Category

$ Widget#table_name — Property in class Widget

$ Widget#table_auto_properties — Property in class Widget

$ ActionIntegrationTestBase#TRANSITION_IDENTIFIER — Property in class ActionIntegrationTestBase

$ ActionIntegrationTestBase#transition — Property in class ActionIntegrationTestBase

ActionMappingIntegrationTest::testMapFixedValues() — Method in class ActionMappingIntegrationTest

ActionStartProcessIntegrationTest::testStartProcesses() — Method in class ActionStartProcessIntegrationTest

Uses the data provider to tests if the corrects process is started exactly once.

WorkflowItemProcessTest::testInstanceIsAvailable() — Method in class WorkflowItemProcessTest

Make sure the instance is installed and available.

WorkflowItemProcessTest::testProcessIsAvailable() — Method in class WorkflowItemProcessTest

WorkflowItemProcessTest::testRunWorkflowProcess() — Method in class WorkflowItemProcessTest

A workflow process is run from start to end with an additional state between the start and the end states.

ActionHeaderFieldsIntegrationTest::testHeaderFields() — Method in class ActionHeaderFieldsIntegrationTest

ActionHeaderFieldsIntegrationTest::testSetTitle() — Method in class ActionHeaderFieldsIntegrationTest

ActionHeaderFieldsIntegrationTest::testSetTitleAndHeaderFields() — Method in class ActionHeaderFieldsIntegrationTest

$ HeaderFieldsActionTest#tester — Property in class HeaderFieldsActionTest

HeaderFieldsActionTest::testProcess() — Method in class HeaderFieldsActionTest

This tests whether the process method sets the rights fields in the

HeaderFieldsActionTest::testGetFieldLabels() — Method in class HeaderFieldsActionTest

$ IndexDaemonPerformance#tester — Property in class IndexDaemonPerformance

IndexDaemonPerformance::testDaemonRun() — Method in class IndexDaemonPerformance

TODO: Some local caches still cause "overlapping" queries TODO: Do a cached and uncached run per step to show effectiveness of caching for this call

$ SurveyDocumentation#title: — Property in class SurveyDocumentation

stored in MySQL as varchar

$ Answer#table_auto_properties — Property in class Answer

$ Answer#table_name — Property in class Answer

$ Participant#table_auto_properties — Property in class Participant

$ Participant#table_name — Property in class Participant

$ Survey#table_auto_properties — Property in class Survey

$ Survey#table_name — Property in class Survey

U

$ ActivedirectoryAuthentication#user_details — Property in class ActivedirectoryAuthentication

$ AlternativeLoginAuthentication#user_details — Property in class AlternativeLoginAuthentication

$ GuestAuthentication#user_id — Property in class GuestAuthentication

$ GuestAuthentication#user_login — Property in class GuestAuthentication

$ IpAuthentication#user_id — Property in class IpAuthentication

$ LdapAuthentication#user_details — Property in class LdapAuthentication

$ MobileAccessAuthentication#user_id — Property in class MobileAccessAuthentication

$ NtlmAuthentication#user_id — Property in class NtlmAuthentication

$ NtlmAuthentication#user_login — Property in class NtlmAuthentication

$ RadiusAuthentication#user_login — Property in class RadiusAuthentication

UserDetails — Class in namespace XELOS\Framework\Core\Authentication

$ UserDetails#url_access — Property in class UserDetails

Uninstall — Class in namespace XELOS\Framework\Core\Console\Command

Class Uninstall

Update — Class in namespace XELOS\Framework\Core\Console\Command

Class Update

User — Class in namespace XELOS\Framework\Core\Console\Command

Class User

$ Core#ui — Property in class Core

Access to ui components defined in the class sub-folder ui

Core::user_has_policy() — Method in class Core

Core::user_has_policy_in_groups() — Method in class Core

Return the group_security ids the user has the policy in

Core::user_has_policy_values() — Method in class Core

User has policy values

Core::user_has_access() — Method in class Core

Check if user has PAGE access to the instance

Core::userHasApiAccess() — Method in class Core

Does the user have API access to this instance?

Core::user_has_access_in_groups() — Method in class Core

Return the group_security ids the user has access to

UserCreationException — Class in namespace XELOS\Framework\Core\Exception

Class UserImportException

UserImportException — Class in namespace XELOS\Framework\Core\Exception

Class UserImportException

ItemListTrait::unshift() — Method in class ItemListTrait

SerializableObjectTrait::unserializeObject() — Method in class SerializableObjectTrait

SerializableObjectTrait::unserializeObjectFromJSON() — Method in class SerializableObjectTrait

$ VarsTemplate#updated_at: — Property in class VarsTemplate

stored in MySQL as timestamp

$ Controller#ui — Property in class Controller

ModulePortlet::update() — Method in class ModulePortlet

is called during update() method of cms component. Can be overwritten in portlet, if there is an action required after a form submit.

Job::updateStatusMessage() — Method in class Job

Updates the status message for this job which is being shown in user output (can only be used in execute() function)

Collection::updateField() — Method in class Collection

Creates an update statement for the scoped collection and executes it.

DocumentModel::update_document_index() — Method in class DocumentModel

updates the related index-item for itself (not global, only for this model!)

ModelCollection::updateDocumentIndexes() — Method in class ModelCollection

ModelCollection::unshift() — Method in class ModelCollection

This function prepends passed elements to the front of the array.

ModelCollection::usort() — Method in class ModelCollection

DESTRUCTIVE This will manipulate the models-list and doesn't return anything!

ScopesTrait::unscope() — Method in class ScopesTrait

Returns an unscoped Collection

SortTrait::update_sort() — Method in class SortTrait

Update the sort property for a given table (Move a record up/down)

SetupPage::user_has_access() — Method in class SetupPage

return true if user has access to the setup page and return false if user is denied default: return true

UIAjaxComponent — Class in namespace XELOS\Framework\Module\UI

Class UIAjaxComponent

UIComponent — Class in namespace XELOS\Framework\Module\UI

Class UIComponent Parent class for all User Interface Helpers (XUI)

$ UIComponent#unique_dom_id — Property in class UIComponent

$ UIComponent#uid — Property in class UIComponent

$ XF#ui — Property in class XF

$ XF#user — Property in class XF

$ DB#username — Property in class DB

$ MySQLAdapter#username — Property in class MySQLAdapter

MySQLAdapter::update() — Method in class MySQLAdapter

Updates the table using the passed values

Query::unscope() — Method in class Query

Unscope Function to remove specific scopes of the query

Query::unscopeWhere() — Method in class Query

Removes all Where Conditions or the Conditions for a specific field

Query::unscopeFromQuery() — Method in class Query

Removes all scope conditions which are set in the passed Query object (similar to boolean subtract)

$ Lib#user_import — Property in class Lib

$ Date#UTC_TO_LOCAL — Property in class Date

$ Date#UTC_TO_LOCAL_HOURS — Property in class Date

Date::utc_to_local() — Method in class Date

Converts a UTC timestamp to a LOCAL timestamp

File::unzip() — Method in class File

Unzip and extract files from given source to target path.

GroupSecurity::update_global_group() — Method in class GroupSecurity

GroupSecurity::update_group_member() — Method in class GroupSecurity

Add Member to security Group

$ Mail#user — Property in class Mail

$ Mail#use_tls — Property in class Mail

Modsetup::update_datasource() — Method in class Modsetup

Modsetup::update_shellplugin_dependencies() — Method in class Modsetup

Updates the ShellPlugin registry with the information provided by the module and adds missing integration data

Modsetup::update_tokens() — Method in class Modsetup

Updates all tokens of the specified module in the database

Modsetup::uninstall_instance() — Method in class Modsetup

Modsetup::update_module() — Method in class Modsetup

Update module

Modsetup::update_composer_dependencies() — Method in class Modsetup

Run Composer Shell Command to update dependencies

Modsetup::unset_system_maintenance() — Method in class Modsetup

Return to normal execution. Pages are deleiverd normaly, Crons are executed, Daemons have to be started manually or by cron!

$ NotificationBuilder#userId — Property in class NotificationBuilder

NotificationState::userHasReacted() — Method in class NotificationState

Policy::users_that_have_policy() — Method in class Policy

Returns all users that have a certain policy parity.

$ QueueableJob#uniquenessKey — Property in class QueueableJob

$ Quota#unit — Property in class Quota

$ Quota#used — Property in class Quota

UserImport — Class in namespace XELOS\Framework\XF\Lib

This class handels the import and update of user data

$ UserImport#uniqueIdentifierField — Property in class UserImport

Validate::url_id() — Method in class Validate

UserCollection — Class in namespace XELOS\Framework\XF\System\Collection

UserMetaCollection — Class in namespace XELOS\Framework\XF\System\Collection

$ Model#user — Property in class Model

$ Model#user_meta — Property in class Model

$ Model#user_devices — Property in class Model

$ Model#user_group — Property in class Model

$ Model#user_link — Property in class Model

$ Model#user_log — Property in class Model

$ Model#user_property_log — Property in class Model

$ AuditTrail#user_id — Property in class AuditTrail

User associated with this trail

$ DocumentIndex#uuid — Property in class DocumentIndex

$ DocumentIndex#user_id — Property in class DocumentIndex

DocumentIndex::updateIndexCache() — Method in class DocumentIndex

DocumentIndex::update_details() — Method in class DocumentIndex

Update the document index with the details from the referenced document model

DocumentIndex::updateReferences() — Method in class DocumentIndex

$ DocumentIndexJobQueue#user_id — Property in class DocumentIndexJobQueue

DocumentIndexJobQueue::updateProcessState() — Method in class DocumentIndexJobQueue

Updates the process state for the given job queue ids.

$ DocumentIndexLock#user_id — Property in class DocumentIndexLock

$ DocumentIndexLock#updated_at — Property in class DocumentIndexLock

DocumentIndexLock::update_visitor() — Method in class DocumentIndexLock

Updates or create entries in the document index lock table. If an entry is already exist the update_at field will be set to actual time.

$ DocumentIndexPolicyCluster#updated_at — Property in class DocumentIndexPolicyCluster

$ DocumentRegistry#use_group — Property in class DocumentRegistry

'true', 'false', default 'false'

GlobalConfig::updateConfigVar() — Method in class GlobalConfig

Update Config Variable if it does not exist or value is not correct

$ Group#updated_at — Property in class Group

$ I18nToken#updated_at — Property in class I18nToken

Updated at

InstanceConfig::updateConfigVar() — Method in class InstanceConfig

Update Config Variable if it does not exist or value is not correct

$ Notification#user_id — Property in class Notification

$ Notification#updated_at — Property in class Notification

Time of last update in DB

$ OnboardingCode#user_id — Property in class OnboardingCode

$ OnboardingCode#updated_at — Property in class OnboardingCode

$ Pages#urlaccess — Property in class Pages

ThemeSet::update() — Method in class ThemeSet

Set all dynamic properties

User — Class in namespace XELOS\Framework\XF\System\Model

XELOS System User Model

UserConfig — Class in namespace XELOS\Framework\XF\System\Model

UserDevices — Class in namespace XELOS\Framework\XF\System\Model

$ UserDevices#user_id — Property in class UserDevices

$ UserDevices#updated_at — Property in class UserDevices

: stored in MySQL as timestamp

UserGroup — Class in namespace XELOS\Framework\XF\System\Model

UserLink — Class in namespace XELOS\Framework\XF\System\Model

Class UserLink

$ UserLink#url — Property in class UserLink

$ UserLink#updated_at — Property in class UserLink

UserLog — Class in namespace XELOS\Framework\XF\System\Model

UserMeta — Class in namespace XELOS\Framework\XF\System\Model

UserPropertyLog — Class in namespace XELOS\Framework\XF\System\Model

UserSeedImport — Class in namespace XELOS\Framework\XF\System\Model

UI — Class in namespace XELOS\Framework\XF

Class UI

$ UI#use_js — Property in class UI

$ UI#used_uids — Property in class UI

UI::unshift_js_block() — Method in class UI

$ AmchartChart#uid_prefix — Property in class AmchartChart

$ AmchartChart#unique_id — Property in class AmchartChart

FacetedFilter::unsetCategory() — Method in class FacetedFilter

Form::unset_request_var() — Method in class Form

Removes a certain field from the request array

$ FroalaEditorBuilder#useMentions — Property in class FroalaEditorBuilder

$ FroalaEditorBuilder#useSubmitOnCtrlEnter — Property in class FroalaEditorBuilder

$ FroalaEditorBuilder#useTags — Property in class FroalaEditorBuilder

FroalaOption::useClasses() — Method in class FroalaOption

When this options is disabled the edited content will have the external CSS properties converted to inline style.

FroalaOption::username() — Method in class FroalaOption

The name of the user joining the co-editing session. For a content management service, this should be set for each logged-in user based on their credentials. This name will be displayed during real-time co-editing sessions.

OptionList::unshift() — Method in class OptionList

Html::ul_list() — Method in class Html

$ Item#updated_at — Property in class Item

$ Tabs#uid — Property in class Tabs

$ Tree#uid_field — Property in class Tree

UserImage — Class in namespace XELOS\Framework\XF\UI

Class UserImage

$ UserImage#user_id — Property in class UserImage

The user id as integer or the string "current" for the current user as target.

UserLink — Class in namespace XELOS\Framework\XF\UI

Class UserLink

$ UserLink#user_id — Property in class UserLink

Wizard::updateWizardData() — Method in class Wizard

put your comment there.

User — Class in namespace XELOS\Framework\XF

User Object This object stores almost everything you associate with the user it also provides core functions associated with the user such as login,logout

User::user_init() — Method in class User

User::user_exists() — Method in class User

Checks wether a specific user already exists in the user db

User::update_displayname() — Method in class User

Update Displayname

$ View#user — Property in class View

Ui — Class in namespace XELOS\Modules\AdSync\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ AdCache#updated_at: — Property in class AdCache

stored in MySQL as timestamp

$ SynchStatus#user_id — Property in class SynchStatus

$ SynchStatus#updated_at: — Property in class SynchStatus

stored in MySQL as timestamp

AdministrationController::userExists() — Method in class AdministrationController

check if login name is unique

AdministrationController::userHasApiAccess() — Method in class AdministrationController

Does the user have API access to this instance?

$ AdministrationControllerDocumentation#ui — Property in class AdministrationControllerDocumentation

$ Page#user_groups — Property in class Page

$ Page#user — Property in class Page

$ Page#user_sessions — Property in class Page

Page::user_groups() — Method in class Page

Page::user() — Method in class Page

Page::user_sessions() — Method in class Page

Ui — Class in namespace XELOS\Modules\Administration\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Ui#userList — Property in class Ui

UserAccountUserConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserAdvancedUserAdminConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserAuditLogUserAdminConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserDevicesUserConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserGroupsUserAdminConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserLanguageUserConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserPolicyUserAdminConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserSecurityUserConfig — Class in namespace XELOS\Modules\Administration\Hook\Administration

UserAdminConfig — Class in namespace XELOS\Modules\Administration\Hook\Base

Class UserAdminConfig

$ UserAdminConfig#userId — Property in class UserAdminConfig

User ID

UserAdminConfigInterface — Class in namespace XELOS\Modules\Administration\Hook\Base

Interface ConfigUserInterface

UserExportBase — Class in namespace XELOS\Modules\Administration\Hook\Base

UserStatusBadgeProviderInterface — Class in namespace XELOS\Modules\Administration\Hook\Base

ApiService::update_user() — Method in class ApiService

Update User

UserGroupsPage — Class in namespace XELOS\Modules\Administration\Page

UserPage — Class in namespace XELOS\Modules\Administration\Page

UserSessionsPage — Class in namespace XELOS\Modules\Administration\Page

AdministrationControllerTest::userProvider() — Method in class AdministrationControllerTest

UserAdminHookTest — Class in namespace XELOS\Modules\Administration\Tests\Codeception\Unit

UserList — Class in namespace XELOS\Modules\Administration\UI

$ UserList#usersPerPage — Property in class UserList

UserList::userTableCb() — Method in class UserList

UserList::userTableGroupCb() — Method in class UserList

UploadDocumentProcessor — Class in namespace XELOS\Modules\ApiCloudstorage\Hook\Doclink

Class UploadDocumentProcessor

OnedriveStorageProvider::uploadAndCreateLink() — Method in class OnedriveStorageProvider

Executes the provider specific file upload from xelos to the remote storage space.

Ui — Class in namespace XELOS\Modules\AuthSaml\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

Ui — Class in namespace XELOS\Modules\Calendar\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ Calendar#user_id — Property in class Calendar

$ Calendar#updated_at: — Property in class Calendar

stored in MySQL as timestamp

$ Event#user_id — Property in class Event

$ Event#updated_at: — Property in class Event

stored in MySQL as timestamp

$ Participant#user_id — Property in class Participant

$ Participant#uid: — Property in class Participant

stored in MySQL as varchar

$ SyncData#updated_at: — Property in class SyncData

stored in MySQL as timestamp

$ SyncSetting#user_id — Property in class SyncSetting

$ SyncSetting#updated_at: — Property in class SyncSetting

stored in MySQL as timestamp

Ui — Class in namespace XELOS\Modules\Cms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ Component#updated_at: — Property in class Component

stored in MySQL as timestamp

$ History#user_id — Property in class History

$ HistoryComponent#updated_at: — Property in class HistoryComponent

stored in MySQL as timestamp

$ HistoryPage#updated_at: — Property in class HistoryPage

stored in MySQL as timestamp

$ Page#updated_at: — Property in class Page

stored in MySQL as timestamp

$ PageLive#updated_at: — Property in class PageLive

stored in MySQL as timestamp

$ CommentsController#ui — Property in class CommentsController

CommentsController::usedResources() — Method in class CommentsController

Fetches all comments from this instance and returns the amount of them in an array format, containing the value and the raw value.

$ Comment#user_id — Property in class Comment

$ Comment#updated_at: — Property in class Comment

stored in MySQL as timestamp

$ LinkInfo#url: — Property in class LinkInfo

stored in MySQL as varchar

$ LinkInfo#updated_at: — Property in class LinkInfo

stored in MySQL as timestamp

Comment::updateContentReferences() — Method in class Comment

CrmSync::updateContactPropertyValues() — Method in class CrmSync

Update the properties of the specified contact

UnzipAction — Class in namespace XELOS\Modules\DMS\Action

Class UnzipAction

$ EventplannerControllerDocumentation#ui — Property in class EventplannerControllerDocumentation

Ui — Class in namespace XELOS\Modules\Eventplanner\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CategoryDocumentation#updated_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

$ EventDocumentation#user_id — Property in class EventDocumentation

$ EventDocumentation#url: — Property in class EventDocumentation

stored in MySQL as varchar

$ EventDocumentation#use_workflow: — Property in class EventDocumentation

stored in MySQL as tinyint

$ EventDocumentation#updated_at: — Property in class EventDocumentation

stored in MySQL as timestamp

$ JobDocumentation#updated_at: — Property in class JobDocumentation

stored in MySQL as timestamp

$ ParticipantDocumentation#user_id — Property in class ParticipantDocumentation

$ ParticipantDocumentation#unknown: — Property in class ParticipantDocumentation

stored in MySQL as tinyint

$ ParticipantLogDocumentation#user_id — Property in class ParticipantLogDocumentation

$ RelatedEventsDocumentation#updated_at: — Property in class RelatedEventsDocumentation

stored in MySQL as timestamp

$ EventplannerController#user_status — Property in class EventplannerController

$ EventplannerController#user_status_class — Property in class EventplannerController

$ EventplannerController#user_status_icon — Property in class EventplannerController

EventplannerController::usedResources() — Method in class EventplannerController

Returns the amount of events, that exist in this instance.

Event::userIsOrganizer() — Method in class Event

SetupPage::user_has_access() — Method in class SetupPage

return true if user has access to the setup page and return false if user is denied default: return true

$ ForumControllerDocumentation#ui — Property in class ForumControllerDocumentation

Ui — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CategoryDocumentation#updated_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

$ PostDocumentation#updated_by — Property in class PostDocumentation

$ PostDocumentation#updated_at: — Property in class PostDocumentation

stored in MySQL as timestamp

$ ThreadDocumentation#user_id — Property in class ThreadDocumentation

$ ThreadDocumentation#updated_at: — Property in class ThreadDocumentation

stored in MySQL as timestamp

$ VotesDocumentation#user_id — Property in class VotesDocumentation

ForumController::usedResources() — Method in class ForumController

Calculate used resources of this instance (by group_id if given) used in Groups Module

UpdateThreadAction — Class in namespace XELOS\Modules\Forum\Hook\Workflows

Category::update() — Method in class Category

SetupPage::user_has_access() — Method in class SetupPage

ForumCest::userShouldNotEditCategory() — Method in class ForumCest

ForumCest::userReplyToDiscussionStartedByCreator() — Method in class ForumCest

$ Location#updated_at — Property in class Location

$ GroupsTasksControllerDocumentation#ui — Property in class GroupsTasksControllerDocumentation

Ui — Class in namespace XELOS\Modules\GroupsTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaskDocumentation#user_id — Property in class TaskDocumentation

$ TaskDocumentation#updated_at: — Property in class TaskDocumentation

stored in MySQL as timestamp

GroupsTasksController::usedResources() — Method in class GroupsTasksController

$ Page#urlaccess — Property in class Page

Page::urlaccess() — Method in class Page

Ui — Class in namespace XELOS\Modules\Groups\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ Group#user_id — Property in class Group

$ Group#url_id: — Property in class Group

stored in MySQL as varchar

$ Group#use_template_settings: — Property in class Group

stored in MySQL as tinyint

$ Group#updated_at: — Property in class Group

stored in MySQL as timestamp

$ Invitation#updated_at: — Property in class Invitation

stored in MySQL as timestamp

$ Member#user_id — Property in class Member

$ Newsletter#updated_at: — Property in class Newsletter

stored in MySQL as timestamp

$ Pending#user_id — Property in class Pending

$ Pending#updated_at: — Property in class Pending

stored in MySQL as timestamp

$ JobQueueControllerDocumentation#ui — Property in class JobQueueControllerDocumentation

Ui — Class in namespace XELOS\Modules\JobQueue\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ JobDocumentation#user_id — Property in class JobDocumentation

$ JobHistoryDocumentation#user_id — Property in class JobHistoryDocumentation

Job::updateStatus() — Method in class Job

$ LegalControllerDocumentation#ui — Property in class LegalControllerDocumentation

Ui — Class in namespace XELOS\Modules\Legal\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PageDocumentation#updated_at: — Property in class PageDocumentation

stored in MySQL as timestamp

$ FormprocessorAction#upload_dir — Property in class FormprocessorAction

$ ListsControllerDocumentation#ui — Property in class ListsControllerDocumentation

Ui — Class in namespace XELOS\Modules\Lists\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ListDocumentation#user_id — Property in class ListDocumentation

$ ListDocumentation#updated_at: — Property in class ListDocumentation

stored in MySQL as timestamp

$ ListItemDocumentation#user_id — Property in class ListItemDocumentation

$ ListItemDocumentation#updated_at: — Property in class ListItemDocumentation

stored in MySQL as timestamp

$ ListStatusDocumentation#updated_at: — Property in class ListStatusDocumentation

stored in MySQL as timestamp

UserSelector — Class in namespace XELOS\Modules\Lists\Hook\Base\Field

ApiService::update_list_item() — Method in class ApiService

UpdateStatusAction — Class in namespace XELOS\Modules\Lists\Hook\Workflows

Workflow action hook to change the value of a field in the list item payload.

ListsController::usedResources() — Method in class ListsController

Represents the amount (as value and raw value, stored in an array) of list items in this instance.

$ ListItem#unique_value — Property in class ListItem

$ ListItem#user_id — Property in class ListItem

$ ListItem#updated_at — Property in class ListItem

: stored in MySQL as timestamp

$ ListProperties#user_id — Property in class ListProperties

User ID

$ ListProperties#updated_at — Property in class ListProperties

Last update date

$ ListStatus#updated_at — Property in class ListStatus

: stored in MySQL as timestamp

Ui — Class in namespace XELOS\Modules\Lookbook\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ Profile#user_id — Property in class Profile

$ Profile#updated_at: — Property in class Profile

stored in MySQL as timestamp

$ ProfileProperty#updated_at: — Property in class ProfileProperty

stored in MySQL as timestamp

$ Property#unique: — Property in class Property

stored in MySQL as tinyint

$ Property#updated_at: — Property in class Property

stored in MySQL as timestamp

Url — Class in namespace XELOS\Modules\Lookbook\Fields

UserSelector — Class in namespace XELOS\Modules\Lookbook\Fields

Webservice::update_profile() — Method in class Webservice

Create User

UserListPortlet — Class in namespace XELOS\Modules\Lookbook\Hooks\Pages

Show contacts / vcards

LookbookControllerTest::umlautProvider() — Method in class LookbookControllerTest

Ui — Class in namespace XELOS\Modules\News\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ArticleDocumentation#user_id — Property in class ArticleDocumentation

$ ArticleDocumentation#updated_at: — Property in class ArticleDocumentation

stored in MySQL as timestamp

$ CategoryDocumentation#updated_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

$ NewsControllerDocumentation#ui — Property in class NewsControllerDocumentation

$ PublishJob#userId — Property in class PublishJob

Article::unpublish() — Method in class Article

Unpublish this article -> Set it back to DRAFT state

NewsController::usedResources() — Method in class NewsController

SetupPage::user_has_access() — Method in class SetupPage

return true if user has access to the setup page and return false if user is denied default: return true

Ui — Class in namespace XELOS\Modules\Pages\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PageComponentDocumentation#user_id — Property in class PageComponentDocumentation

$ PageComponentDocumentation#updated_at: — Property in class PageComponentDocumentation

stored in MySQL as timestamp

$ PageDocumentation#url_key: — Property in class PageDocumentation

stored in MySQL as varchar

$ PageDocumentation#user_id — Property in class PageDocumentation

$ PageDocumentation#updated_at: — Property in class PageDocumentation

stored in MySQL as timestamp

$ PageDocumentation#updated_user_id — Property in class PageDocumentation

$ PageVersionDocumentation#updated_at: — Property in class PageVersionDocumentation

stored in MySQL as timestamp

$ PageVersionDocumentation#updated_user_id — Property in class PageVersionDocumentation

$ PagesControllerDocumentation#ui — Property in class PagesControllerDocumentation

PageJsonProcessor::updateAttachments() — Method in class PageJsonProcessor

Replaces the attachments based on the passed replaceArray which assigns a new document info for existing documentIds

PageJsonProcessor::updateContentReferencess() — Method in class PageJsonProcessor

Replaces the references based on the passed replaceArray which assigns a new reference info for existing references

$ Page#url_key — Property in class Page

$ Page#user_id — Property in class Page

$ Page#updated_at — Property in class Page

$ PageVersion#user_id — Property in class PageVersion

$ PageVersion#updated_at — Property in class PageVersion

PageVersion::updateLocales() — Method in class PageVersion

Reads all available layouts and fills the locales property with all visible language versions We update this information during save to be able to pickup this information in queries

PageVersion::unpublish() — Method in class PageVersion

Unpublishes this page version (If an draft exists we keep the current draft, otherwise live version will be the new draft)

PersonalWorkspaceController::user_has_access() — Method in class PersonalWorkspaceController

Ui — Class in namespace XELOS\Modules\ReadConfirmation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ConfirmationDocumentation#user_id — Property in class ConfirmationDocumentation

$ ConfirmationDocumentation#updated_at — Property in class ConfirmationDocumentation

stored in MySQL as timestamp

$ DocumentDocumentation#user_id — Property in class DocumentDocumentation

$ DocumentDocumentation#updated_at — Property in class DocumentDocumentation

stored in MySQL as timestamp

$ ReadConfirmationControllerDocumentation#ui — Property in class ReadConfirmationControllerDocumentation

IndexerAction::updateDocumentsByCallback() — Method in class IndexerAction

Mass Update to update a few search index attributes for many documents at once This command will not create new Index entries but only update existing ones

Ui — Class in namespace XELOS\Modules\Search\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ FacetedFilterDocumentation#updated_at: — Property in class FacetedFilterDocumentation

stored in MySQL as timestamp

$ SearchHistoryDocumentation#user_id — Property in class SearchHistoryDocumentation

$ SearchHistoryDocumentation#updated_at: — Property in class SearchHistoryDocumentation

stored in MySQL as timestamp

$ SearchagentDocumentation#user_id — Property in class SearchagentDocumentation

$ SearchagentDocumentation#updated_at: — Property in class SearchagentDocumentation

stored in MySQL as timestamp

$ SearchControllerDocumentation#ui — Property in class SearchControllerDocumentation

UpdateSearchIndexDocumentIndexEvent — Class in namespace XELOS\Modules\Search\Hook\System

Searchagent::update_agent() — Method in class Searchagent

$ BrowserFile#user_id — Property in class BrowserFile

UserSelectorProcessor — Class in namespace XELOS\Modules\Selector\Lib

Ui — Class in namespace XELOS\Modules\SmartWiki\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PageDocumentation#updated_user_id — Property in class PageDocumentation

$ PageDocumentation#updated_at: — Property in class PageDocumentation

stored in MySQL as timestamp

$ SmartWikiControllerDocumentation#ui — Property in class SmartWikiControllerDocumentation

$ Page#updated_user_id — Property in class Page

$ Page#updated_at — Property in class Page

Page::updateSlug() — Method in class Page

Generates and sets the slug from the title remeber to save the model

Page::update_link_references() — Method in class Page

Updates the page link reference table for all links starting from the current page

SmartWikiController::usedResources() — Method in class SmartWikiController

calculate used resources of this instance (by group_id if given)

Ui — Class in namespace XELOS\Modules\SystemActionlog\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ DocumentWallItemDocumentation#user_id — Property in class DocumentWallItemDocumentation

$ DocumentWallItemDocumentation#updated_at: — Property in class DocumentWallItemDocumentation

stored in MySQL as timestamp

$ EntryDocumentation#user_id — Property in class EntryDocumentation

$ HiddenInstanceDocumentation#user_id — Property in class HiddenInstanceDocumentation

$ SystemActionlogControllerDocumentation#ui — Property in class SystemActionlogControllerDocumentation

$ SendWallDigestJob#userId — Property in class SendWallDigestJob

$ Main#ui — Property in class Main

$ BackupQueue#updated_at: — Property in class BackupQueue

stored in MySQL as timestamp

$ EventTrigger#updated_at: — Property in class EventTrigger

stored in MySQL as timestamp

$ InstallQueue#updated_at: — Property in class InstallQueue

stored in MySQL as timestamp

UnzipAction — Class in namespace XELOS\Modules\SystemDMS\Action

Class UnzipAction

$ WebdavService#unsupported_methods — Property in class WebdavService

ApiService::updateFile() — Method in class ApiService

Category::user_has_tree_policy() — Method in class Category

checks for a policy in this category-context

Document::update() — Method in class Document

Updates properties.

Document::unlock() — Method in class Document

Remove all locks from the referenced document

SystemDMSController::usedResources() — Method in class SystemDMSController

Calculates used resources of this instance.

SystemDMSController::userHasApiAccess() — Method in class SystemDMSController

Does the user have API access to this instance?

$ Action#unzip — Property in class Action

Ui — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ Category#updated_at — Property in class Category

: stored in MySQL as timestamp

$ Document#user_id — Property in class Document

$ Document#updated_at: — Property in class Document

stored in MySQL as timestamp

$ DocumentHistory#user_id — Property in class DocumentHistory

$ DocumentHistory#updated_at — Property in class DocumentHistory

: stored in MySQL as timestamp

$ DocumentMetaData#updated_at: — Property in class DocumentMetaData

stored in MySQL as timestamp

$ DocumentMetaField#updated_at — Property in class DocumentMetaField

: stored in MySQL as timestamp

$ DocumentTemplate#user_id — Property in class DocumentTemplate

$ DocumentTemplate#updated_at — Property in class DocumentTemplate

: stored in MySQL as timestamp

$ FileTemplate#updated_at — Property in class FileTemplate

: stored in MySQL as timestamp

$ Preview#updated_at: — Property in class Preview

stored in MySQL as timestamp

$ ZipImportJob#user_id — Property in class ZipImportJob

$ ZipImportJob#updated_at — Property in class ZipImportJob

: stored in MySQL as timestamp

UserSystemMailUserConfig — Class in namespace XELOS\Modules\SystemMail\Hook\Administration

$ Model#user_setting — Property in class Model

Model::user_setting() — Method in class Model

Ui — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ ChannelSettingDocumentation#user_id — Property in class ChannelSettingDocumentation

$ ChannelSettingDocumentation#updated_at — Property in class ChannelSettingDocumentation

UserSettingDocumentation — Class in namespace XELOS\Modules\SystemNotification\Docs\ClassGenerated\Model

This file provides property and method documentation for the model UserSetting.

$ UserSettingDocumentation#user_id — Property in class UserSettingDocumentation

$ UserSettingDocumentation#updated_at — Property in class UserSettingDocumentation

$ SystemNotificationControllerDocumentation#ui — Property in class SystemNotificationControllerDocumentation

UpdateFrontendHook — Class in namespace XELOS\Modules\SystemNotification\Hooks\System

Class xm_messenger_update_frontend_hook

UserSetting — Class in namespace XELOS\Modules\SystemNotification\Model

Ui — Class in namespace XELOS\Modules\SystemPwa\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ PushSubscriptionDocumentation#user_id — Property in class PushSubscriptionDocumentation

$ PushSubscriptionDocumentation#updated_at: — Property in class PushSubscriptionDocumentation

stored in MySQL as timestamp

$ SystemPwaControllerDocumentation#ui — Property in class SystemPwaControllerDocumentation

$ PushSubscription#user_id — Property in class PushSubscription

Ui — Class in namespace XELOS\Modules\SystemStats\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ AggregateDimensionDocumentation#updated_at: — Property in class AggregateDimensionDocumentation

stored in MySQL as timestamp

$ EventDocumentation#user — Property in class EventDocumentation

$ SystemStatsControllerDocumentation#ui — Property in class SystemStatsControllerDocumentation

Ui — Class in namespace XELOS\Modules\SystemStatus\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CheckDocumentation#updated_at: — Property in class CheckDocumentation

stored in MySQL as timestamp

$ NodeDocumentation#updated_at: — Property in class NodeDocumentation

stored in MySQL as timestamp

$ SystemStatusControllerDocumentation#ui — Property in class SystemStatusControllerDocumentation

Ui — Class in namespace XELOS\Modules\SystemTasks\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ RecurringTaskDocumentation#updated_at: — Property in class RecurringTaskDocumentation

stored in MySQL as timestamp

$ TaskDocumentation#user_id — Property in class TaskDocumentation

$ TaskDocumentation#updated_at: — Property in class TaskDocumentation

stored in MySQL as timestamp

$ SystemTasksControllerDocumentation#ui — Property in class SystemTasksControllerDocumentation

$ Task#user_id — Property in class Task

Last User action by

$ Task#updated_at — Property in class Task

Access via get_* methods

Task::user_displayname() — Method in class Task

Task::updateRecurringTask() — Method in class Task

Update Recurring Task in case task was moved and information is not correct anymore

$ TaskList#user_id — Property in class TaskList

TaskList::user_can_read() — Method in class TaskList

Checks if the given user has the policy to read the task list.

SystemTasksController::usedResources() — Method in class SystemTasksController

Counts the tasks in this instance and gives back the information as array containing the value (string) and the raw_value (double).

VideoWorker::uploadVideoFile() — Method in class VideoWorker

Ui — Class in namespace XELOS\Modules\SystemXelosApp\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ Main#ui — Property in class Main

$ PushClient#user_id — Property in class PushClient

$ PushClient#uuid: — Property in class PushClient

stored in MySQL as varchar

$ PushClient#updated_at: — Property in class PushClient

stored in MySQL as timestamp

Webservice::unregister() — Method in class Webservice

Unregister push client

Ui — Class in namespace XELOS\Modules\Tagging\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TaggingControllerDocumentation#ui — Property in class TaggingControllerDocumentation

TaggingController::updateTagsForDocument() — Method in class TaggingController

Update Tags associated with a document in XELOS

TranslateAction::updateTranslationCounter() — Method in class TranslateAction

Updates the translation_counter table with info about the translated content

Ui — Class in namespace XELOS\Modules\Translation\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ TranslationDocumentDocumentation#user_id — Property in class TranslationDocumentDocumentation

$ TranslationDocumentDocumentation#updated_at: — Property in class TranslationDocumentDocumentation

stored in MySQL as timestamp

$ TranslationDocumentation#user_id — Property in class TranslationDocumentation

$ TranslationDocumentation#updated_at: — Property in class TranslationDocumentation

stored in MySQL as timestamp

$ TranslationFeedbackDocumentation#user_id — Property in class TranslationFeedbackDocumentation

$ TranslationFeedbackDocumentation#updated_at: — Property in class TranslationFeedbackDocumentation

stored in MySQL as timestamp

$ TranslationJobDocumentation#updated_at: — Property in class TranslationJobDocumentation

stored in MySQL as timestamp

$ TranslationControllerDocumentation#ui — Property in class TranslationControllerDocumentation

$ BaseTranslationApi#url — Property in class BaseTranslationApi

$ Deepl#url — Property in class Deepl

$ Main#ui — Property in class Main

$ Result#user_id — Property in class Result

$ Result#updated_at: — Property in class Result

stored in MySQL as timestamp

$ Trendvote#user_id — Property in class Trendvote

$ Trendvote#updated_at: — Property in class Trendvote

stored in MySQL as timestamp

$ Trendvote#user_id — Property in class Trendvote

$ Trendvote#updated_at — Property in class Trendvote

TrendvoteController::userHasApiAccess() — Method in class TrendvoteController

Does the user have API access to this instance?

Ui — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ FileDocumentation#updated_at: — Property in class FileDocumentation

stored in MySQL as timestamp

$ ScanDocumentation#updated_at: — Property in class ScanDocumentation

stored in MySQL as timestamp

$ VirusScanControllerDocumentation#ui — Property in class VirusScanControllerDocumentation

$ OAuthClient#userinfoEndpointUrl — Property in class OAuthClient

$ OpenIDConfiguration#userinfoEndpoint — Property in class OpenIDConfiguration

Ui — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ CategoryDocumentation#updated_at: — Property in class CategoryDocumentation

stored in MySQL as timestamp

$ WidgetDocumentation#updated_at: — Property in class WidgetDocumentation

stored in MySQL as timestamp

$ WidgetsControllerDocumentation#ui — Property in class WidgetsControllerDocumentation

$ ExampleSurveyControllerDocumentation#ui — Property in class ExampleSurveyControllerDocumentation

Ui — Class in namespace XELOS\Vendor\Blueend\Modules\ExampleSurvey\Docs\ClassGenerated\MagicHelper

This file provides autocompletion for XELOS modules.

$ AnswerDocumentation#user_id — Property in class AnswerDocumentation

$ ParticipantDocumentation#user_id — Property in class ParticipantDocumentation

$ SurveyDocumentation#user_id — Property in class SurveyDocumentation

$ SurveyDocumentation#updated_at: — Property in class SurveyDocumentation

stored in MySQL as timestamp

V

$ Input#vendor — Property in class Input

$ Output#verbosity — Property in class Output

VarsTemplate — Class in namespace XELOS\Framework\Core

Job::validate() — Method in class Job

If the return is false, the job will not be executed.

Model::validate() — Method in class Model

$ SystemDaemon#view — Property in class SystemDaemon

$ XF#view — Property in class XF

$ Lib#validate — Property in class Lib

Date::verbose_dayscount() — Method in class Date

Date::verbose_datediff() — Method in class Date

$ Mail#verify_ssl — Property in class Mail

$ NotificationBuilder#varsTemplate — Property in class NotificationBuilder

Validate — Class in namespace XELOS\Framework\XF\Lib

VueFileParser — Class in namespace XELOS\Framework\XF\Lib\i18n\Parser

DocumentIndexReference::validate() — Method in class DocumentIndexReference

Does this reference fulfill the minimum requirement and does target/attachment allow this level?

Hierarchy::validate() — Method in class Hierarchy

HierarchyUser::validate() — Method in class HierarchyUser

Generic validate Ensures that no user will be assigned as a primary user to two different levels in the same hierarchy context

$ I18nToken#value — Property in class I18nToken

Value

User::validate() — Method in class User

Validate User Model Changes

UserDevices::validate_auth_token() — Method in class UserDevices

Compares a given auth token with the device auth token.

Form::validate() — Method in class Form

Form::validateFormFields() — Method in class Form

FormCaptcha::validate() — Method in class FormCaptcha

FormColor::validate() — Method in class FormColor

Validate if input is HEX Format

FormComponent::validate() — Method in class FormComponent

FormComponent::validateInRequestAsRequired() — Method in class FormComponent

Should this field be treated as required during request validation?

FormComponent::validateInFrontendAsRequired() — Method in class FormComponent

Should this field be marked with HTML5 required attribute? HTML5 required should not be used when field may be hidden, as it might still be required frontend-wise, even if hidden!

FormContentAttachment::validate() — Method in class FormContentAttachment

Executed before saving

FormDate::validate() — Method in class FormDate

Validate

FormDatetime::validate() — Method in class FormDatetime

FormDocument::validate() — Method in class FormDocument

Validate Attachments

FormFile::validate() — Method in class FormFile

Validate, Check MimeTypes

FormMediaAttachment::validate() — Method in class FormMediaAttachment

Executed before saving

FormMultifile::validate() — Method in class FormMultifile

FormPolicySelector::validate() — Method in class FormPolicySelector

FormRrule::validate() — Method in class FormRrule

FormTextarea::validate() — Method in class FormTextarea

FormTextbox::validate() — Method in class FormTextbox

FormTextboxList::validate() — Method in class FormTextboxList

FormTileSelection::validate() — Method in class FormTileSelection

FormToggleSwitch::validate() — Method in class FormToggleSwitch

$ FroalaOption#value — Property in class FroalaOption

FroalaOption::videoAllowedProviders() — Method in class FroalaOption

The list of video providers allowed to be inserted as URL.

FroalaOption::videoAllowedTypes() — Method in class FroalaOption

The list of video types that are allowed to be uploaded. Although this will restrict uploading other types of files, we strongly recommend you to check the file type on the server too.

FroalaOption::videoDefaultAlign() — Method in class FroalaOption

Sets the default video alignment when it is inserted into the WYSIWYG editor. Possible values are left, center and right.

FroalaOption::videoDefaultDisplay() — Method in class FroalaOption

Sets the default display for videos when they are inserted into the WYSIWYG editor. Possible options are: "inline" and "block".

FroalaOption::videoDefaultWidth() — Method in class FroalaOption

Sets the default width of the video when it is inserted in the rich text editor. Setting it to 0 will not set any width.

FroalaOption::videoEditButtons() — Method in class FroalaOption

The buttons that appear in the edit video popup, when a video is selected.

FroalaOption::videoInsertButtons() — Method in class FroalaOption

The buttons that appear in the insert video popup, when a video is inserted into the WYSIWYG editor.

FroalaOption::videoMaxSize() — Method in class FroalaOption

The maximum video size allowed on upload in bytes. The default value is 30MB. Although this makes an additional check before uploading the video, it is highly recommended to check image size on your server too.

FroalaOption::videoMove() — Method in class FroalaOption

Allows changing the position of the videos by dragging them.

FroalaOption::videoResize() — Method in class FroalaOption

Enable or disable resizing the videos inside the editor.

FroalaOption::videoResponsive() — Method in class FroalaOption

Enable or disable inserting responsive videos in the Froala Editor.

FroalaOption::videoSizeButtons() — Method in class FroalaOption

The buttons that appear in the edit video size popup, when changing the size of a selected video.

FroalaOption::videoSplitHTML() — Method in class FroalaOption

Enables splitting the HTML when inserting a new view.

FroalaOption::videoTextNear() — Method in class FroalaOption

Allows text near a video when it is aligned to the left or to the right. Disabling this option will make the display button for image editor popup unavailable.

FroalaOption::videoUpload() — Method in class FroalaOption

Enable or disable video upload.

FroalaOption::videoUploadMethod() — Method in class FroalaOption

The HTTP video upload request type.

FroalaOption::videoUploadParam() — Method in class FroalaOption

Customize the name of the parameter that contains the video file in the upload request.

FroalaOption::videoUploadParams() — Method in class FroalaOption

Pass additional parameters to the upload request.

FroalaOption::videoUploadToS3() — Method in class FroalaOption

Set the options for video upload to S3. All the fields from the example below are required. Also make sure that you have enabled <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html" title="CORS" target="_blank" rel="nofollow">CORS on Amazon.

Note: uploadURL property can be used instead of bucket and region properties to specify a custom URL from Amazon where to upload the video.

FroalaOption::videoUploadURL() — Method in class FroalaOption

The URL where the videos uploaded by the user are saved. When a video is uploaded, the editor sends the file to the server through a HTTP request. The server should process the data from the file parameter of the request and return a JSON object containing a link field with the link to the uploaded video.

FormValidationTrait::validate() — Method in class FormValidationTrait

$ HtmlTree#values — Property in class HtmlTree

$ HtmlUlList#values — Property in class HtmlUlList

$ ProgressBar#value — Property in class ProgressBar

VCard — Class in namespace XELOS\Framework\XF\UI

VideoPlayer — Class in namespace XELOS\Framework\XF\UI

ViewModeSwitcher — Class in namespace XELOS\Framework\XF\UI

$ ViewModeSwitcher#viewmodes — Property in class ViewModeSwitcher

Viewmodes can be passed via template syntax

View — Class in namespace XELOS\Framework\XF

View determines what page-(sub)class (or combinations of) needs to be called

PasswordAction::validatePasswordStrength() — Method in class PasswordAction

Checks the password strength for the give passwords based on config settings

$ Action#view — Property in class Action

Action::view() — Method in class Action

$ Calendarset#visible_calendars: — Property in class Calendarset

stored in MySQL as text

ViewDocumentDetails — Class in namespace XELOS\Modules\DMS\UI

Class ViewDocumentDetails

ViewDocumentLink — Class in namespace XELOS\Modules\DMS\UI

Class ViewDocumentLink

ViewDocumentRead — Class in namespace XELOS\Modules\DMS\UI

Class ViewDocumentRead

ViewDocumentTemplate — Class in namespace XELOS\Modules\DMS\UI

Class ViewDocumentTemplate

ViewDocumentWrite — Class in namespace XELOS\Modules\DMS\UI

Class ViewDocumentWrite

DocviewProcessor::view_count() — Method in class DocviewProcessor

PostPage::validate_end_date() — Method in class PostPage

$ Model#votes — Property in class Model

Model::votes() — Method in class Model

$ Ui#vote_box — Property in class Ui

VotesDocumentation — Class in namespace XELOS\Modules\Forum\Docs\ClassGenerated\Model

This file provides property and method documentation for the model Votes.

$ VotesDocumentation#vote: — Property in class VotesDocumentation

enum up|down

Votes — Class in namespace XELOS\Modules\Forum\Model

Class XELOS\Modules\Forum\Model\Votes

$ Step#visibleCategoryId — Property in class Step

VoteBox — Class in namespace XELOS\Modules\Forum\UI

Class XELOS\Modules\Forum\UI\VoteBox

$ Page#view — Property in class Page

Page::view() — Method in class Page

$ PageDocumentation#version — Property in class PageDocumentation

LegalControllerCest::viewDisclaimer() — Method in class LegalControllerCest

Login and test the disclaimer

LegalControllerCest::viewImprint() — Method in class LegalControllerCest

Field::validateResource() — Method in class Field

Validates the resources and their bookings.

ResourceField::validateResource() — Method in class ResourceField

Validates the resources and their bookings.

Room::validateResource() — Method in class Room

Validates the resources and their bookings.

Ticket::validateResource() — Method in class Ticket

Validates the resources and their bookings.

ListItemPayload::validate() — Method in class ListItemPayload

ListItem::validate() — Method in class ListItem

Tests if the form_identifier is unique and if only 5 facetted fields are selected.

ListProperties::validate() — Method in class ListProperties

Tests if the form_identifier is unique and if only 5 facetted fields are selected.

$ Action#vcard_export — Property in class Action

Action::vcard_export() — Method in class Action

$ Profile#visible: — Property in class Profile

stored in MySQL as tinyint

$ ProfileProperty#value: — Property in class ProfileProperty

stored in MySQL as text

$ Property#values: — Property in class Property

stored in MySQL as text

ViewArticleRead — Class in namespace XELOS\Modules\News\UI

ViewArticleWrite — Class in namespace XELOS\Modules\News\UI

Page::validate() — Method in class Page

$ FacetedFilterDocumentation#visible: — Property in class FacetedFilterDocumentation

stored in MySQL as tinyint

$ Ui#view_wiki_read — Property in class Ui

$ Ui#view_wiki_write — Property in class Ui

$ PageDocumentation#version_id — Property in class PageDocumentation

$ PageHistoryDocumentation#version_id — Property in class PageHistoryDocumentation

$ Page#version_id — Property in class Page

Page::validate() — Method in class Page

ViewWikiRead — Class in namespace XELOS\Modules\SmartWiki\UI

Class XELOS\Modules\SmartWiki\UI\ViewWikiRead

ViewWikiWrite — Class in namespace XELOS\Modules\SmartWiki\UI

Class XELOS\Modules\SmartWiki\UI\ViewWikiWrite

$ PreviewJob#versionId — Property in class PreviewJob

Category::validate() — Method in class Category

Document::validate() — Method in class Document

Validate Function for Forms with Document-Models as Target

FormReportSpecification::validate() — Method in class FormReportSpecification

Validate the element Right now, there is no real validation done in this routine, as no scenario comes to mind where a user could accidentally provide invalid input. However, the validate function usually also prepares the REQUEST_VARS value.

ViewDocumentDetails — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_view_document_details

ViewDocumentLink — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_view_document_link

ViewDocumentRead — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_view_document_read

ViewDocumentTemplate — Class in namespace XELOS\Modules\SystemDMS\UI

This view allows to use document templates in document links, e.g. a News article can get a template

ViewDocumentWrite — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_view_document_write

$ Ui#view_document_details — Property in class Ui

$ Ui#view_document_link — Property in class Ui

$ Ui#view_document_read — Property in class Ui

$ Ui#view_document_template — Property in class Ui

$ Ui#view_document_write — Property in class Ui

$ Document#version_id — Property in class Document

$ DocumentHistory#version_id — Property in class DocumentHistory

$ DocumentMetaData#version_id — Property in class DocumentMetaData

$ DocumentMetaData#value — Property in class DocumentMetaData

: stored in MySQL as text

$ Preview#version_id — Property in class Preview

$ AggregateNumericDocumentation#value: — Property in class AggregateNumericDocumentation

stored in MySQL as decimal

Task::validate() — Method in class Task

Validate Form Input

VideoCheck — Class in namespace XELOS\Modules\SystemWorker\Hook\SystemStatus

VideoWorker — Class in namespace XELOS\Modules\SystemWorker\Worker

TranslationControllerTest::validLocaleProvider() — Method in class TranslationControllerTest

VirusScanControllerDocumentation — Class in namespace XELOS\Modules\VirusScan\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

VirusCheck — Class in namespace XELOS\Modules\VirusScan\Hook\SystemStatus

Class VirusCheck

VirusScanController — Class in namespace XELOS\Modules\VirusScan

$ OAuthServerAction#validScopes — Property in class OAuthServerAction

$ AnswerDocumentation#value: — Property in class AnswerDocumentation

stored in MySQL as text

W

Input::withCommand() — Method in class Input

Returns a new instance of Input with the given command.

Output::warning() — Method in class Output

Outputs a Success Message

CollectionActionHelper::when() — Method in class CollectionActionHelper

Conditions can only be applied to Collections which are scopable

SoftDeleteInterface::withDeleted() — Method in class SoftDeleteInterface

SoftDeleteTrait::withDeleted() — Method in class SoftDeleteTrait

Condition::whereGroup() — Method in class Condition

Condition::whereEqual() — Method in class Condition

Condition::whereNotEqual() — Method in class Condition

Condition::whereLike() — Method in class Condition

Condition::where() — Method in class Condition

Condition::whereNot() — Method in class Condition

Condition::whereBetween() — Method in class Condition

Create between condition for string or int values BETWEEN is a shorthand for >= AND <= - begin and end values are included

Condition::whereNotBetween() — Method in class Condition

Condition::whereRaw() — Method in class Condition

Condition::whereBinary() — Method in class Condition

Condition::whereInSubselect() — Method in class Condition

Condition::whereNotInSubselect() — Method in class Condition

Condition::whereIsNull() — Method in class Condition

Condition::whereIsNotNull() — Method in class Condition

Condition::whereJSONContains() — Method in class Condition

ConditionGroup::whereFromQuery() — Method in class ConditionGroup

Query::where() — Method in class Query

Adds a custom WHERE Condition to the query

Query::whereNot() — Method in class Query

Adds a custom NEGATED WHERE Condition to the query

Query::whereEqual() — Method in class Query

Adds a EQUAL WHERE Condition to the query

Query::whereNotEqual() — Method in class Query

Adds a NEGATED EQUAL WHERE Condition to the query

Query::whereLike() — Method in class Query

Adds a LIKE Condition to the query

Query::whereRaw() — Method in class Query

Adds a RAW WHERE Condition to the query

Query::whereCondition() — Method in class Query

Adds a Condition object as condition

Query::whereConditionGroup() — Method in class Query

Adds a Condition object as condition

Query::whereFromQuery() — Method in class Query

Applies all WHERE conditions of the passed Query object to the current query (Copy)

Query::withAutoSelects() — Method in class Query

Use automatic field conversion of timestamp and binary fields, requires tableSchema

Query::withDistinctSelect() — Method in class Query

Html::webComponentTag() — Method in class Html

Creates a WebComponent Tag and casts all properties as required

DatabaseHandler::write() — Method in class DatabaseHandler

DisplayHandler::write() — Method in class DisplayHandler

InMemoryHandler::write() — Method in class InMemoryHandler

Logger::warning() — Method in class Logger

NonpersistentSessionHandler::write() — Method in class NonpersistentSessionHandler

SqlSessionHandler::write() — Method in class SqlSessionHandler

Threading::waitForRunningChildren() — Method in class Threading

Wait's until all child processes have been finished

Yaml::writeYamlFile() — Method in class Yaml

$ Model#wizard — Property in class Model

Wizard — Class in namespace XELOS\Framework\XF\System\Model

$ FormRowRendererMultifieldRow#width — Property in class FormRowRendererMultifieldRow

FroalaEditorBuilder::withOptions() — Method in class FroalaEditorBuilder

Adds a new option to froala editor.

FroalaEditorBuilder::withMod() — Method in class FroalaEditorBuilder

FroalaEditorBuilder::withDocumentIndex() — Method in class FroalaEditorBuilder

FroalaEditorBuilder::withDocumentSelector() — Method in class FroalaEditorBuilder

FroalaEditorBuilder::withMentions() — Method in class FroalaEditorBuilder

FroalaEditorBuilder::withTags() — Method in class FroalaEditorBuilder

Enables inline #tag Tags incl. autosuggest

FroalaEditorBuilder::withColorsText() — Method in class FroalaEditorBuilder

Add to or replace the color picker colors for text and background color

FroalaEditorBuilder::withSubmitOnCtrlEnter() — Method in class FroalaEditorBuilder

If enabled pressing CTRL+ENTER in the textarea will submit the form

FroalaEditorBuilder::withAllowHTML() — Method in class FroalaEditorBuilder

The Input mode can be full, image-only, none

FroalaEditorBuilder::withToolbarSet() — Method in class FroalaEditorBuilder

Sets the set of toolbar buttons used for editor.

FroalaOption::width() — Method in class FroalaOption

Sets the width of the editing box.

FroalaOption::wordAllowedStyleProps() — Method in class FroalaOption

The list of allowed CSS attributes to be used for tags when pasting from Word.

FroalaOption::wordDeniedAttrs() — Method in class FroalaOption

Attributes that are removed when pasting something into the rich text editor from Word.

FroalaOption::wordDeniedTags() — Method in class FroalaOption

Tags that are removed together with their content when pasting something into the rich text editor from Word.

FroalaOption::wordPasteModal() — Method in class FroalaOption

Show modal to choose if to keep or not styles pasted from Word. If set to false, the default action is to keep the formatting.

FroalaOption::wordPasteKeepFormatting() — Method in class FroalaOption

Choose the default action when wordPasteModal option is enabled.

$ ProgressBar#width_style — Property in class ProgressBar

$ UserImage#width — Property in class UserImage

The width of the image in pixel.

Wizard — Class in namespace XELOS\Framework\XF\UI

$ Wizard#wizardData — Property in class Wizard

WebdavService — Class in namespace XELOS\Modules\DMS\Hook\Webdav

$ EventDocumentation#workflow_id — Property in class EventDocumentation

$ ParticipantDocumentation#wf_item_id — Property in class ParticipantDocumentation

Webservice — Class in namespace XELOS\Modules\Hrm\Hook\Webservice

$ ListItemDocumentation#workflow_status: — Property in class ListItemDocumentation

stored in MySQL as varchar

WorkflowItemTrait — Class in namespace XELOS\Modules\Lists\Hook\Workflows

$ ListItem#workflow_status — Property in class ListItem

$ ItemList#workflowsMod — Property in class ItemList

Webservice — Class in namespace XELOS\Modules\Lookbook\Hook\Webservice

$ Article#weblocation — Property in class Article

$ Category#weblocation — Property in class Category

WebdavService — Class in namespace XELOS\Modules\PersonalWorkspace\Hook\Webdav

Class WebdavService

Workspace — Class in namespace XELOS\Modules\PersonalWorkspace\Model

Class XELOS\Modules\PersonalWorkspace\Model\xmodel_personal_workspace_workspace

$ PersonalWorkspaceController#workspace — Property in class PersonalWorkspaceController

$ PageHistoryDocumentation#was_active: — Property in class PageHistoryDocumentation

stored in MySQL as tinyint

WikiCest — Class in namespace XELOS\Modules\SmartWiki\Tests\Codeception\Acceptance

$ Page#wall — Property in class Page

Page::wall() — Method in class Page

$ EntryDocumentation#what: — Property in class EntryDocumentation

stored in MySQL as varchar

$ EntryDocumentation#what_params: — Property in class EntryDocumentation

stored in MySQL as text

WallPortlet — Class in namespace XELOS\Modules\SystemActionlog\Hook\Pages

WallIndexEventDocumentIndexEvent — Class in namespace XELOS\Modules\SystemActionlog\Hook\System

Class XELOS\Modules\SystemActionlog\Hook\System\xhook_system_actionlog_index_event

Webservice — Class in namespace XELOS\Modules\SystemActionlog\Hook\Webservice

WallPage — Class in namespace XELOS\Modules\SystemActionlog\Page

$ SystemActionlogController#wall_filter_instances — Property in class SystemActionlogController

SystemCron::wall_as_email() — Method in class SystemCron

Notify Users about new wall entries

WebdavService — Class in namespace XELOS\Modules\SystemDMS\Hook\Webdav

Class XELOS\Modules\SystemDMS\Hook\Webdav\xm_system_dms_webdav

WebdavService::write() — Method in class WebdavService

Write File

$ FormReportSpecification#was_validated — Property in class FormReportSpecification

WhoisonlineShowPortlet — Class in namespace XELOS\Modules\SystemStats\Hook\Portal

WorkerException — Class in namespace XELOS\Modules\SystemWorker\Exceptions

Webservice — Class in namespace XELOS\Modules\SystemXelosApp\Hook\Webservice

WebserviceController — Class in namespace XELOS\Modules\Webservice

Class xm_webservice

$ Model#widget — Property in class Model

Model::widget() — Method in class Model

$ Ui#widgets — Property in class Ui

WidgetDocumentation — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated\Model

This file provides property and method documentation for the model widget.

WidgetsControllerDocumentation — Class in namespace XELOS\Modules\Widgets\Docs\ClassGenerated

This file provides autocompletion for XELOS modules.

WidgetsPortlet — Class in namespace XELOS\Modules\Widgets\Hook\Pages

Widget — Class in namespace XELOS\Modules\Widgets\Model

Class XELOS\Modules\Widgets\Model\Widget

WidgetList — Class in namespace XELOS\Modules\Widgets\UI

Class XELOS\Modules\Widgets\UI\WidgetList

WidgetsController — Class in namespace XELOS\Modules\Widgets

Class XELOS\Modules\Widgets\WidgetController

WorkflowItemProcessTest — Class in namespace XELOS\Modules\Workflows\Tests\Codeception\Integration

Integration test to make sure the workflow process performs the required steps on the item via the transitions.

X

XelosAuthentication — Class in namespace XELOS\Framework\Core\Authentication\Method

$ Core#xf_link — Property in class Core

XUILinkHelper — Class in namespace XELOS\Framework\Core\Helper

Class XUILinkHelper

ObjectManager::xelos_object_manager_init() — Method in class ObjectManager

trait constructor This method have to be called from constructor of each class that uses this trait.

$ ModulePortlet#XF — Property in class ModulePortlet

XQLApiInterface — Class in namespace XELOS\Framework\Module\Model\Interfaces

XQLCollectionTrait — Class in namespace XELOS\Framework\Module\Model\Traits

$ UIAjaxComponent#xui_payload — Property in class UIAjaxComponent

$ UIAjaxComponent#xuiLinkedContainers — Property in class UIAjaxComponent

$ UIComponent#xf_link — Property in class UIComponent

XF — Class in namespace XELOS\Framework

Class xf Singleton Fabric The xf class is used to get access to helpers and instantiate other objects.

$ ExtendedSoapClient#xf_options — Property in class ExtendedSoapClient

$ Breadcrumb#xtag_params — Property in class Breadcrumb

$ Callback#xtag_params — Property in class Callback

$ Carousel#xtag_params — Property in class Carousel

Default parameters

$ Link#xf_link_array — Property in class Link

$ Table#xtag_params — Property in class Table

$ Tabs#xtag_params — Property in class Tabs

$ Translation#xtag_params — Property in class Translation

$ Comment#xui_target — Property in class Comment

XfsDocument — Class in namespace XELOS\Modules\DMS\UI

Class XELOS\Modules\DMS\UI\xui_dms_xfs_document

XfsDocument — Class in namespace XELOS\Modules\SystemDMS\Model

Class XELOS\Modules\SystemDMS\Model\xm_system_dms_xfs_document

$ DocumentTablePanel#xui_table — Property in class DocumentTablePanel

XfsDocument — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_xfs_document

$ XfsDocument#xfs_render_type — Property in class XfsDocument

$ Model#xfs_document — Property in class Model

Model::xfs_document() — Method in class Model

$ Ui#xfs_document — Property in class Ui

$ Category#xfs_source — Property in class Category

: stored in MySQL as varchar

$ Document#xfs_path — Property in class Document

: stored in MySQL as varchar

$ DocumentHistory#xfs_path — Property in class DocumentHistory

: stored in MySQL as varchar

XQL — Class in namespace XELOS\Modules\Webservice\Hook\Base\Service

xm_webservice_magic_action — Class in namespace XELOS\Modules\Webservice

xm_webservice_magic_model — Class in namespace XELOS\Modules\Webservice

Y

$ Lib#yaml — Property in class Lib

Yaml — Class in namespace XELOS\Framework\XF\Lib

Class Yaml

$ Calendar#year — Property in class Calendar

Z

File::zip() — Method in class File

Zip all files to

FroalaOption::zIndex() — Method in class FroalaOption

The zIndex to set on the editor toolbars and popups.

ZipImportJob — Class in namespace XELOS\Modules\DMS\Model

Class ZipImportJob

ZipImportStatusBar — Class in namespace XELOS\Modules\DMS\UI

Class ZipImportStatusBar

$ EventDocumentation#zip: — Property in class EventDocumentation

stored in MySQL as varchar

Zip — Class in namespace XELOS\Modules\Lookbook\Fields

ZipImportJob — Class in namespace XELOS\Modules\SystemDMS\Model

Class XELOS\Modules\SystemDMS\Model\xm_system_dms_zip_import_job

ZipImportStatusBar — Class in namespace XELOS\Modules\SystemDMS\UI

Class XELOS\Modules\SystemDMS\UI\xui_system_dms_zip_import_status_bar

$ Model#zip_import_job — Property in class Model

Model::zip_import_job() — Method in class Model

$ Ui#zip_import_status_bar — Property in class Ui

ZipImportJob — Class in namespace XELOS\Modules\SystemDms\Docs\ClassGenerated\Model

This file provides property and method documentation for the model zip_import_job.

_

ActivedirectoryAuthentication::__construct() — Method in class ActivedirectoryAuthentication

AlternativeLoginAuthentication::__construct() — Method in class AlternativeLoginAuthentication

LdapAuthentication::__construct() — Method in class LdapAuthentication

NtlmAuthentication::__construct() — Method in class NtlmAuthentication

UserDetails::__construct() — Method in class UserDetails

UserDetails constructor.

CommandDefinition::__construct() — Method in class CommandDefinition

CommandDefinition constructor.

CommandSet::__construct() — Method in class CommandSet

CommandSet constructor.

Console::__construct() — Method in class Console

Setup minimal constraints for Console Output and Logging

ConsoleLogger::__construct() — Method in class ConsoleLogger

ConsoleLogger constructor.

CommandNotFoundException::__construct() — Method in class CommandNotFoundException

CommandNotFoundException constructor.

ConsoleException::__construct() — Method in class ConsoleException

ConsoleException constructor.

InvalidArgumentException::__construct() — Method in class InvalidArgumentException

InvalidParameterException constructor.

Table::__construct() — Method in class Table

Table constructor.

Input::__construct() — Method in class Input

Input constructor.

Output::__construct() — Method in class Output

Output constructor.

Output::_parseCLITagsCallback() — Method in class Output

Core::__construct() — Method in class Core

Core::_() — Method in class Core

Gettext Wrapper using current module context for module specific translations

Core::__toString() — Method in class Core

AuthenticationException::__construct() — Method in class AuthenticationException

AuthenticationException constructor.

ContentException::__construct() — Method in class ContentException

InvalidClassException::__construct() — Method in class InvalidClassException

ActionHelper::__toString() — Method in class ActionHelper

I18nTokenHelper::_() — Method in class I18nTokenHelper

I18nTokenHelper::__toString() — Method in class I18nTokenHelper

LinkContextHelper::__construct() — Method in class LinkContextHelper

LinkContextHelper::__call() — Method in class LinkContextHelper

LinkContextHelper::__get() — Method in class LinkContextHelper

MagicDocumentHelper::__toString() — Method in class MagicDocumentHelper

$ MagicMethodHelper#_skip_errors — Property in class MagicMethodHelper

MagicMethodHelper::__construct() — Method in class MagicMethodHelper

SerializedObjectHelper::__construct() — Method in class SerializedObjectHelper

SerializedObjectHelper::__toString() — Method in class SerializedObjectHelper

Show Object as JSON String

XUILinkHelper::__construct() — Method in class XUILinkHelper

ItemInterface::__toString() — Method in class ItemInterface

$ Template#_prerendered — Property in class Template

$ Template#_raw_markers — Property in class Template

Template::__construct() — Method in class Template

Template constructor.

Template::_render_array_block() — Method in class Template

Internal Render Function

Template::_parse_template_content() — Method in class Template

Template::_parse_template_content_markers() — Method in class Template

Parse for ###Markers###

Template::_parse_template_content_xtags() — Method in class Template

Parse the passed HTML source for xTags and render these xTags

Template::__toString() — Method in class Template

ObjectManager::__isset() — Method in class ObjectManager

Magic method.

ObjectManager::__set() — Method in class ObjectManager

Magic method.

ObjectManager::__get() — Method in class ObjectManager

Magic method.

ObjectManager::__call() — Method in class ObjectManager

Magic method.

VarsTemplate::__construct() — Method in class VarsTemplate

Vars constructor

VarsTemplate::__get() — Method in class VarsTemplate

VarsTemplate::__toString() — Method in class VarsTemplate

Controller::__construct() — Method in class Controller

$ BaseHook#_hook_info — Property in class BaseHook

Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => ""

$ ModulePortlet#_hook_info — Property in class ModulePortlet

Information is populated when called via get_hook (default)

ModulePortlet::__construct() — Method in class ModulePortlet

put your comment there.

$ Job#_constructArgs — Property in class Job

todo private, then reflection in create

InstallEvents::__construct() — Method in class InstallEvents

InstallEvents constructor.

$ DocumentModel#_update_document_index — Property in class DocumentModel

$ Model#_request_cache — Property in class Model

Model::__construct() — Method in class Model

Model::__get() — Method in class Model

Model::__set() — Method in class Model

Model::__call() — Method in class Model

Model::_call_cached_function() — Method in class Model

Calls the passed function only if it is not cached yet, otherwise the previous cached result will be returned

Model::_scopeGroupId() — Method in class Model

Applies Group ID Filtering

Model::__clone() — Method in class Model

Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference

Model::__toString() — Method in class Model

String Representation of this object (calls for render method)

Model::__isset() — Method in class Model

ModelCollection::__construct() — Method in class ModelCollection

Create new Model Array

ModelCollection::__call() — Method in class ModelCollection

Handle find functions

ModelCollection::_search_by() — Method in class ModelCollection

returns model found by property => value

ModelCollection::__toString() — Method in class ModelCollection

ModelCollection::__clone() — Method in class ModelCollection

Called after cloning a collection and makes sure that model reference is cloned as well

ScopesTrait::_scopeAll() — Method in class ScopesTrait

Global named scope scopeAll to use on models to return an unscoped unloaded collection

ScopesTrait::_scopeDefault() — Method in class ScopesTrait

Load default scopes

ScopesTrait::_scope_by() — Method in class ScopesTrait

Called for scopeby Magic Function Creates a new ModelCollection and applies the passed scope

ScopesTrait::_scope_custom() — Method in class ScopesTrait

Called for scope_ Magic Function Creates a new ModelCollection and applies the passed custom scope function

SoftDeleteTrait::_scopeNotDeleted() — Method in class SoftDeleteTrait

SoftDeleteTrait::_scopeSoftDeleted() — Method in class SoftDeleteTrait

Function is triggered on scopeSoftDeleted()

$ StateMachineTrait#_state_machine_field_transitions — Property in class StateMachineTrait

Array of all fields and their values which have been changed during the last save() call

$ StateMachineTrait#_state_machine_active — Property in class StateMachineTrait

Has State Machine beein initialized yet (registered event listeners)

$ StateMachineTrait#_state_machine_registered_transitions — Property in class StateMachineTrait

List of registered transitions which will be checked on field changes

StateMachineTrait::_state_machine_before_save() — Method in class StateMachineTrait

beforeSave Event Handler Identify all properties which will be modified with this call

StateMachineTrait::_state_machine_after_save() — Method in class StateMachineTrait

afterSave Event Handler Process State Machine after Save

SystemDaemon::__construct() — Method in class SystemDaemon

put your comment there.

SystemDaemon::__destruct() — Method in class SystemDaemon

$ UIComponent#_overwrite_param_array — Property in class UIComponent

$ UIComponent#_orig_marker_content — Property in class UIComponent

$ UIComponent#_allowed_params_filter — Property in class UIComponent

$ UIComponent#_content — Property in class UIComponent

When used in template this property will contain the XML/HTML within the XUI Nodes

UIComponent::__construct() — Method in class UIComponent

UIComponent constructor.

UIComponent::__toString() — Method in class UIComponent

XF::__sleep() — Method in class XF

This object is not intended to be serialized

XF::__wakeup() — Method in class XF

If object is unserialized log error, but try not to end fatal

Config::__construct() — Method in class Config

MySQLAdapter::__construct() — Method in class MySQLAdapter

Constructur for Database Wrapper

MySQLAdapter::__sleep() — Method in class MySQLAdapter

PHP __sleep -> Disconnect Server in case of object serialization

MySQLAdapter::__destruct() — Method in class MySQLAdapter

Disconnect Server in case of object destruction

MySQLAdapter::__wakeup() — Method in class MySQLAdapter

PHP __wakeup ->Re-Connect Server in case of object unserialize

Condition::__construct() — Method in class Condition

Condition constructor

Condition::__toString() — Method in class Condition

ConditionGroup::__toString() — Method in class ConditionGroup

Query::__construct() — Method in class Query

Query constructor.

Query::__toString() — Method in class Query

Returns a String representation (SQL Query String) - depending on the defaultStringReturn setting this may be the whole SQL or only the WHERE condition SQL

Query::_getScopeOrderBy() — Method in class Query

Internal use function to copy ScopeOrder to other Query

Lib::__construct() — Method in class Lib

Lib constructor.

Ajax::__construct() — Method in class Ajax

Browser::__construct() — Method in class Browser

Constructor

Cache::__construct() — Method in class Cache

Connect::__get() — Method in class Connect

Magic Function to initialize object on first access of magic properties

Connect::__call() — Method in class Connect

Magic Function If started with underscore the call is handled by the connect call dispatcher, e.g. call Connect Function like ->lib->connect->_send_sms($param1, $param2); Otherwise a standard WebServices call is initiated

ExtendedSoapClient::__construct() — Method in class ExtendedSoapClient

CustomSOAPClient Constructor

ExtendedSoapClient::__doRequest() — Method in class ExtendedSoapClient

Executes a curl request with given params.

RemoteFunctionMapper::__construct() — Method in class RemoteFunctionMapper

Store available functions and full function references

RemoteFunctionMapper::__call() — Method in class RemoteFunctionMapper

Call function using parent connect object

Convert::__construct() — Method in class Convert

Debug::__construct() — Method in class Debug

SlimTimer::_slimtime() — Method in class SlimTimer

Error::__construct() — Method in class Error

Constructur for Error Log/Helper

Export::__construct() — Method in class Export

File::__construct() — Method in class File

File::__destruct() — Method in class File

Filehandler::__construct() — Method in class Filehandler

Filehandler constructor.

Format::_text_pre_parse_links() — Method in class Format

Format::_link_parse_markdown() — Method in class Format

Format::_link_parse() — Method in class Format

Parse links

GroupSecurity::__construct() — Method in class GroupSecurity

CsvImport::__construct() — Method in class CsvImport

CsvImport constructor.

FakeData::__construct() — Method in class FakeData

$ Link#_view — Property in class Link

$ Link#_page — Property in class Link

$ Link#_cmd — Property in class Link

$ Link#_navid — Property in class Link

$ Link#_params — Property in class Link

Link::__construct() — Method in class Link

Link constructor.

DefaultFormatter::__construct() — Method in class DefaultFormatter

DefaultFormatter constructor.

HandlerFactory::__construct() — Method in class HandlerFactory

StreamHandlerFactory constructor.

InMemoryHandler::__construct() — Method in class InMemoryHandler

InMemoryStreamHandler constructor.

GlobalContext::__invoke() — Method in class GlobalContext

StreamHandlerFactory::__construct() — Method in class StreamHandlerFactory

StreamHandlerFactory constructor.

Mail::__construct() — Method in class Mail

MarkdownExtraParser::_doImages_reference_callback() — Method in class MarkdownExtraParser

MarkdownExtraParser::_doImages_inline_callback() — Method in class MarkdownExtraParser

MarkdownExtraParser::_doAnchors_reference_callback() — Method in class MarkdownExtraParser

MarkdownExtraParser::_doAnchors_inline_callback() — Method in class MarkdownExtraParser

Policy::_cb_sort_policy_clusters_by_row_count_desc() — Method in class Policy

Helper callback for the create_policy_clusters Method, sorting the found clusters based on the number of rows (policies) they contain.

Privacy::__construct() — Method in class Privacy

QueueableJob::__construct() — Method in class QueueableJob

Quota::__construct() — Method in class Quota

Quota constructor.

Quota::__toString() — Method in class Quota

Request::__construct() — Method in class Request

Request constructor.

SecureEvalClass::__construct() — Method in class SecureEvalClass

Session::__construct() — Method in class Session

Session constructor.

NonpersistentSessionHandler::__construct() — Method in class NonpersistentSessionHandler

RedisSessionHandler::__construct() — Method in class RedisSessionHandler

redis_session_handler constructor.

SqlSessionHandler::__construct() — Method in class SqlSessionHandler

sql_session_handler constructor.

Sort::__construct() — Method in class Sort

Constructor

SqlNestedSet::__construct() — Method in class SqlNestedSet

SqlNestedSet constructor.

Ssl::__construct() — Method in class Ssl

Text::__construct() — Method in class Text

TyeDiff::__construct() — Method in class TyeDiff

Token::__construct() — Method in class Token

Token constructor

TokenCollection::__construct() — Method in class TokenCollection

System::__construct() — Method in class System

System constructor.

DocumentIndex::__construct() — Method in class DocumentIndex

DocumentIndex::__sleep() — Method in class DocumentIndex

DocumentIndex::__wakeup() — Method in class DocumentIndex

User::_scopeActive() — Method in class User

Scope to only active Users

User::__construct() — Method in class User

UserMeta::__construct() — Method in class UserMeta

UI::__construct() — Method in class UI

UI constructor.

AjaxContainer::__construct() — Method in class AjaxContainer

AjaxContainer constructor.

$ AmchartBar#_graphs — Property in class AmchartBar

$ AmchartBar#_format_category_as_date — Property in class AmchartBar

$ AmchartChart#_chart — Property in class AmchartChart

$ AmchartChart#_data — Property in class AmchartChart

$ AmchartChart#_lib_path — Property in class AmchartChart

$ AmchartChart#_processed — Property in class AmchartChart

$ AmchartChart#_height — Property in class AmchartChart

AmchartChart::__construct() — Method in class AmchartChart

UIComponent constructor.

AmchartChart::_add_system_colors() — Method in class AmchartChart

AmchartChart::_add_theme() — Method in class AmchartChart

AmchartChart::_add_animation_time() — Method in class AmchartChart

AmchartChart::_apply_chart_options() — Method in class AmchartChart

Applies all set chart options to the chart before rendering

$ Breadcrumb#_overwrite_param_array — Property in class Breadcrumb

Calendar::__construct() — Method in class Calendar

UIComponent constructor.

Calendar::__set() — Method in class Calendar

Magic setter. Enables call of setter functions via

$ Callback#_overwrite_param_array — Property in class Callback

All parameters of the xtag are written into $xtag_params, so they can be passed to the called instance

$ Carousel#_overwrite_param_array — Property in class Carousel

Default parameters array name

$ Css#_content — Property in class Css

Doclink::__construct() — Method in class Doclink

DocLink constructor.

Doclink::__toString() — Method in class Doclink

FacetedFilter::__construct() — Method in class FacetedFilter

UIComponent constructor.

FacetedCategory::__construct() — Method in class FacetedCategory

Constructor

FacetedCategory::__toString() — Method in class FacetedCategory

FacetedCategoryItem::__toString() — Method in class FacetedCategoryItem

Form::__construct() — Method in class Form

FormEditor::__construct() — Method in class FormEditor

FormBase::__construct() — Method in class FormBase

FormBase constructor.

FormChoice::_serialize() — Method in class FormChoice

FormChoice::_unSerialize() — Method in class FormChoice

FormDocument::_cb_handle_new_document() — Method in class FormDocument

FormFile::__construct() — Method in class FormFile

FormFile constructor.

FormMediaAttachment::__construct() — Method in class FormMediaAttachment

FormBase constructor.

FormMultifile::__construct() — Method in class FormMultifile

FormBase constructor.

FormPolicySelector::_cb_sort_user_id_by_displayname() — Method in class FormPolicySelector

Helper Method that sorts the user array alphabetically after the users displayname

FormPolicySelector::_cb_sort_group_id_by_label() — Method in class FormPolicySelector

Helper Method that sorts the user array alphabetically after the users displayname

FormRowRenderer::__construct() — Method in class FormRowRenderer

FormBase constructor.

FormRowRenderer::__set() — Method in class FormRowRenderer

FormRowRenderer::__get() — Method in class FormRowRenderer

FormStaticValue::__construct() — Method in class FormStaticValue

FormBase constructor.

FroalaEditorBuilder::__construct() — Method in class FroalaEditorBuilder

FroalaEditorBuilder constructor.

FroalaInsertGroup::__construct() — Method in class FroalaInsertGroup

FroalaInsertGroup constructor.

FroalaOption::__construct() — Method in class FroalaOption

FroalaOption constructor.

Option::__construct() — Method in class Option

Option::__toString() — Method in class Option

Prints the title of this option.

HtmlGeneric::__construct() — Method in class HtmlGeneric

Constructor

HtmlGeneric::__set() — Method in class HtmlGeneric

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

HtmlTree::__set() — Method in class HtmlTree

HtmlUlList::__set() — Method in class HtmlUlList

Image::__construct() — Method in class Image

Constructor

Image::__set() — Method in class Image

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

ImageEdit::__construct() — Method in class ImageEdit

UIComponent constructor.

Import::__construct() — Method in class Import

Instance::__construct() — Method in class Instance

UIComponent constructor.

Instance::__set() — Method in class Instance

option setter, only valid options will be catched

Item::__get() — Method in class Item

Link::__construct() — Method in class Link

Constructor

Link::__set() — Method in class Link

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

Paging::__construct() — Method in class Paging

Portlet::__construct() — Method in class Portlet

UIComponent constructor.

Portlet::__set() — Method in class Portlet

option setter, only valid options will be set.

QRCode::__construct() — Method in class QRCode

QRCode::__set() — Method in class QRCode

Setter for beeing able to collect all params setted by xTag for transfering to link object in render function

$ Table#_overwrite_param_array — Property in class Table

Table::__construct() — Method in class Table

Table::_add_col_callback_to_q() — Method in class Table

Schedule Add Callback to Table Col (Will transform an existing col)

$ TableEditor#_overwrite_param_array — Property in class TableEditor

TableEditor::__construct() — Method in class TableEditor

TableRow::__construct() — Method in class TableRow

$ Tabs#_overwrite_param_array — Property in class Tabs

Tabs::__construct() — Method in class Tabs

UIComponent constructor.

$ TimeLine#_chart — Property in class TimeLine

TimeLine::__construct() — Method in class TimeLine

Construct

TimeLineRow::__construct() — Method in class TimeLineRow

TimeLineRow constructor.

$ Translation#_overwrite_param_array — Property in class Translation

All parameters of the xtag are written into $xtag_params, so they can be passed to the called instance

Tree::__construct() — Method in class Tree

UserImage::__set() — Method in class UserImage

Support for xui template usage.

$ UserLink#_content — Property in class UserLink

UserLink::__construct() — Method in class UserLink

UserLink constructor.

VCard::__construct() — Method in class VCard

UIComponent constructor.

ViewModeSwitcher::__construct() — Method in class ViewModeSwitcher

Wizard::__construct() — Method in class Wizard

UIComponent constructor.

User::__destruct() — Method in class User

MAGIC Destructor is called when script execution ends

User::__sleep() — Method in class User

Called upon serialize

User::__wakeup() — Method in class User

Called upon deserialize

LdapAction::__construct() — Method in class LdapAction

SystemCron::__construct() — Method in class SystemCron

AdSyncTest::_before() — Method in class AdSyncTest

AdSyncTest::_after() — Method in class AdSyncTest

AdministrationController::__construct() — Method in class AdministrationController

Badge::__toString() — Method in class Badge

SystemCron::__construct() — Method in class SystemCron

AdministrationControllerTest::_before() — Method in class AdministrationControllerTest

BadgeTest::_before() — Method in class BadgeTest

UserAdminHookTest::_before() — Method in class UserAdminHookTest

ApiCloudstorageDocumentBrowser::__construct() — Method in class ApiCloudstorageDocumentBrowser

PersonalWorkspaceDocumentBrowser constructor.

AgendaPortlet::__construct() — Method in class AgendaPortlet

$ CrmSync#_crm_contact_id — Property in class CrmSync

$ CrmSync#_crm2src_map — Property in class CrmSync

CrmDocumentBrowser::__construct() — Method in class CrmDocumentBrowser

CrmDocumentBrowser constructor.

CrmControllerTest::_before() — Method in class CrmControllerTest

Executed before every test method

DMSController::__construct() — Method in class DMSController

XELOS\Modules\DMS\xm_dms constructor.

FilesPortlet::__construct() — Method in class FilesPortlet

put your comment there.

EventplannerController::__construct() — Method in class EventplannerController

AgendaPortlet::__construct() — Method in class AgendaPortlet

put your comment there.

SystemCron::__construct() — Method in class SystemCron

Details::__construct() — Method in class Details

UIComponent constructor.

RecentShowPortlet::__construct() — Method in class RecentShowPortlet

put your comment there.

Category::__construct() — Method in class Category

SystemCron::__construct() — Method in class SystemCron

CreatorRole::__construct() — Method in class CreatorRole

GeoIpTest::_before() — Method in class GeoIpTest

GeoIpTest::_after() — Method in class GeoIpTest

GeoFeature::__construct() — Method in class GeoFeature

This class represents a single record of the OpenStreetMap API (geocodejson format).

GeoSelectorProcessor::__construct() — Method in class GeoSelectorProcessor

Marker::__construct() — Method in class Marker

CalendarLinkGetEvents::__construct() — Method in class CalendarLinkGetEvents

GroupsPortlet::__construct() — Method in class GroupsPortlet

ArchiveGroupJob::__construct() — Method in class ArchiveGroupJob

DeleteGroupJob::__construct() — Method in class DeleteGroupJob

GroupUserContentJob::__construct() — Method in class GroupUserContentJob

SetInactiveAndNotifyJob::__construct() — Method in class SetInactiveAndNotifyJob

GroupsDocumentBrowser::__construct() — Method in class GroupsDocumentBrowser

GroupsDocumentBrowser constructor.

JobScheduler::__construct() — Method in class JobScheduler

JobScheduler constructor.

TestJob::__construct() — Method in class TestJob

SystemDaemon::__construct() — Method in class SystemDaemon

Initialize Instances

SystemDaemon::_threadShutdown() — Method in class SystemDaemon

Handle Logging of Fatal Errors and add Log-Entry to Job

JobUIStatus::__construct() — Method in class JobUIStatus

LegalControllerTest::_before() — Method in class LegalControllerTest

ListsGanttShowPortlet::__construct() — Method in class ListsGanttShowPortlet

put your comment there.

ListsPortletShowPortlet::__construct() — Method in class ListsPortletShowPortlet

put your comment there.

ReindexJob::__construct() — Method in class ReindexJob

$ ListItem#_assignedUsers — Property in class ListItem

Temp array used to assign multiple assigned_user fields to a single list item

ListProperties::__toString() — Method in class ListProperties

String Representation of this object (calls for render method)

ListProperties::__construct() — Method in class ListProperties

ItemOverviewPage::_page_overview() — Method in class ItemOverviewPage

ListsControllerTest::_before() — Method in class ListsControllerTest

UserListPortlet::__construct() — Method in class UserListPortlet

put your comment there.

LookbookControllerTest::_before() — Method in class LookbookControllerTest

Executed before every test method

LatestNewsPortlet::__construct() — Method in class LatestNewsPortlet

put your comment there.

RSSShowPortlet::__construct() — Method in class RSSShowPortlet

put your comment there.

RecentShowPortlet::__construct() — Method in class RecentShowPortlet

put your comment there.

PublishJob::__construct() — Method in class PublishJob

Article::__construct() — Method in class Article

Article::__get() — Method in class Article

Custom Magic Getter to allow retrieval of fs_ properties

Article::__set() — Method in class Article

Custom Magic Setter to allow setting of fs_ properties

Category::__construct() — Method in class Category

NewsController::__call() — Method in class NewsController

Magic method.

NewsController::__get() — Method in class NewsController

Magic method.

SettingsPage::_cb_table_title() — Method in class SettingsPage

SettingsPage::_cb_table_features() — Method in class SettingsPage

Indicates in tabel view which feature is enabled and its default value

SettingsPage::_cb_table_action() — Method in class SettingsPage

NewsControllerTest::_before() — Method in class NewsControllerTest

JsonPathElement::__construct() — Method in class JsonPathElement

Create a JsonPathElement Object

PageJsonMigrator::__construct() — Method in class PageJsonMigrator

PageJsonProcessor::__construct() — Method in class PageJsonProcessor

Page::_scopeNotTemporary() — Method in class Page

Names Scope: Filter Temporary Pages

PageVersion::__construct() — Method in class PageVersion

SystemCron::__construct() — Method in class SystemCron

PortletHookTest::_before() — Method in class PortletHookTest

PersonalWorkspaceDocumentBrowser::__construct() — Method in class PersonalWorkspaceDocumentBrowser

PersonalWorkspaceDocumentBrowser constructor.

PersonalWorkspaceControllerTest::_before() — Method in class PersonalWorkspaceControllerTest

ReadConfirmationShowPortlet::__construct() — Method in class ReadConfirmationShowPortlet

put your comment there.

ReadConfirmationController::__construct() — Method in class ReadConfirmationController

ElasticSearchAdapter::__construct() — Method in class ElasticSearchAdapter

ElasticSearchAdapter::_reindex() — Method in class ElasticSearchAdapter

https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html

Field::__construct() — Method in class Field

AgentPortletShowPortlet::__construct() — Method in class AgentPortletShowPortlet

PortletSearchShowPortlet::__construct() — Method in class PortletSearchShowPortlet

SearchDocumentBrowser::__construct() — Method in class SearchDocumentBrowser

SearchDocumentBrowser constructor.

SearchCheck::__construct() — Method in class SearchCheck

DocumentElasticsearch::__construct() — Method in class DocumentElasticsearch

DocumentElasticsearch constructor.

SearchagentPage::_cb_searchagent_get_result_count() — Method in class SearchagentPage

SearchIndexContentRecord::__construct() — Method in class SearchIndexContentRecord

SearchIndexRecord is always based on the respective document_index

SearchIndexRecord::__construct() — Method in class SearchIndexRecord

SearchIndexRecord is always based on the respective document_index

SearchUpdateRecord::__construct() — Method in class SearchUpdateRecord

SystemCron::__construct() — Method in class SystemCron

AbstractBrowserItem::__get() — Method in class AbstractBrowserItem

Template property via method access support

UserSelectorProcessor::__construct() — Method in class UserSelectorProcessor

SystemCron::__construct() — Method in class SystemCron

WikiCest::_before() — Method in class WikiCest

PortletActionlogShowPortlet::__construct() — Method in class PortletActionlogShowPortlet

WallIndexEventDocumentIndexEvent::__construct() — Method in class WallIndexEventDocumentIndexEvent

Webservice::__construct() — Method in class Webservice

SendWallDigestJob::__construct() — Method in class SendWallDigestJob

Entry::__construct() — Method in class Entry

SystemActionlogController::__construct() — Method in class SystemActionlogController

SystemCron::__construct() — Method in class SystemCron

DocumentIndexDaemonLegacy::__construct() — Method in class DocumentIndexDaemonLegacy

DocumentIndexDaemonLegacy constructor.

DocumentIndexDaemonThreaded::__construct() — Method in class DocumentIndexDaemonThreaded

DocumentIndexDaemonThreaded constructor.

SystemCron::__construct() — Method in class SystemCron

SystemDaemon::__construct() — Method in class SystemDaemon

Initialize Instances

PortletActionShowPortlet::__construct() — Method in class PortletActionShowPortlet

XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_action_portlet constructor.

PortletFolderhierarchyShowPortlet::__construct() — Method in class PortletFolderhierarchyShowPortlet

XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_folderhierarchy_portlet constructor.

PortletFolderviewShowPortlet::__construct() — Method in class PortletFolderviewShowPortlet

XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_folderview_portlet constructor.

PortletNavigatorShowPortlet::__construct() — Method in class PortletNavigatorShowPortlet

XELOS\Modules\SystemDMS\Hook\Portal\xm_system_dms_navigator_portlet constructor.

SystemDMSBrowserFile::__construct() — Method in class SystemDMSBrowserFile

SystemDMSBrowserFile constructor.

SystemDMSBrowserFolder::__construct() — Method in class SystemDMSBrowserFolder

SystemDMSBrowserFolder constructor.

SystemDMSDocumentBrowser::__construct() — Method in class SystemDMSDocumentBrowser

SystemDMSDocumentBrowser constructor.

PreviewJob::__construct() — Method in class PreviewJob

$ Document#_load — Property in class Document

Document::__construct() — Method in class Document

Constructor

XfsDocument::__construct() — Method in class XfsDocument

Construct

XfsDocument::_cb_retrieve_doc() — Method in class XfsDocument

CategoryService::__construct() — Method in class CategoryService

CategoryService constructor.

SystemCron::__construct() — Method in class SystemCron

XELOS\Modules\SystemDMS\xsc_system_dms constructor.

CategoryCest::_before() — Method in class CategoryCest

SystemDMSControllerTest::_inject() — Method in class SystemDMSControllerTest

SystemDMSControllerTest::_before() — Method in class SystemDMSControllerTest

DocumentPage::_cb_document_lock_status() — Method in class DocumentPage

DocumentTablePanel::_cb_document_table_template_value() — Method in class DocumentTablePanel

DocumentTablePanel::_cb_document_table_thumb() — Method in class DocumentTablePanel

Create a thumbnail of a given document Used as a callback by the table

DocumentTablePanel::_cb_document_trash_table_title_link() — Method in class DocumentTablePanel

DocumentTablePanel::_cb_document_table_title_link() — Method in class DocumentTablePanel

Format the Name of a document in a table, adding a link to it

DocumentTablePanel::_cb_document_table_actions() — Method in class DocumentTablePanel

Add additional actions for a document to the document table

DocumentTablePanel::_cb_document_table_trash_actions() — Method in class DocumentTablePanel

ViewDocumentDetails::_cb_get_file_data() — Method in class ViewDocumentDetails

$ DocumentHistory#_index — Property in class DocumentHistory

AdminSystemMailUserAdminConfig::__construct() — Method in class AdminSystemMailUserAdminConfig

UserSystemMailUserConfig::__construct() — Method in class UserSystemMailUserConfig

CreateNotificationJob::__construct() — Method in class CreateNotificationJob

CreateNotificationJob constructor.

SendNotificationJob::__construct() — Method in class SendNotificationJob

SendNotificationJob constructor.

SystemNotificationTest::_before() — Method in class SystemNotificationTest

SystemNotificationTest::_after() — Method in class SystemNotificationTest

$ AggregateNumericDocumentation#_primary — Property in class AggregateNumericDocumentation

WhoisonlineShowPortlet::__construct() — Method in class WhoisonlineShowPortlet

put your comment there.

CollectorData::__construct() — Method in class CollectorData

CollectorDimension::__construct() — Method in class CollectorDimension

CollectorDimension constructor.

SystemCron::__construct() — Method in class SystemCron

Result::__construct() — Method in class Result

CacheCheck::__construct() — Method in class CacheCheck

ClamavCheck::__construct() — Method in class ClamavCheck

ConnectionCheck::__construct() — Method in class ConnectionCheck

CronCheck::__construct() — Method in class CronCheck

DaemonCheck::__construct() — Method in class DaemonCheck

DatabaseCheck::__construct() — Method in class DatabaseCheck

DiskCheck::__construct() — Method in class DiskCheck

DocumentIndexCheck::__construct() — Method in class DocumentIndexCheck

LicenseCheck::__construct() — Method in class LicenseCheck

RepoCheck::__construct() — Method in class RepoCheck

TimeCheck::__construct() — Method in class TimeCheck

Check::__construct() — Method in class Check

$ MinimalPage#_core_checks — Property in class MinimalPage

SystemCron::__construct() — Method in class SystemCron

ShowTasksShowPortlet::__construct() — Method in class ShowTasksShowPortlet

XELOS\Modules\SystemTasks\Hook\Portal\ShowTasksShowPortlet constructor.

SystemCron::__construct() — Method in class SystemCron

Initialize Instances

TaskTest::_before() — Method in class TaskTest

WorkerException::__construct() — Method in class WorkerException

LibreofficeCheck::__construct() — Method in class LibreofficeCheck

VideoCheck::__construct() — Method in class VideoCheck

BaseWorker::__construct() — Method in class BaseWorker

CloudShowPortlet::__construct() — Method in class CloudShowPortlet

put your comment there.

SystemCron::__construct() — Method in class SystemCron

ApiCheck::__construct() — Method in class ApiCheck

SystemDaemon::__construct() — Method in class SystemDaemon

Initialize Instances

TranslationControllerTest::_inject() — Method in class TranslationControllerTest

TranslationControllerTest::_before() — Method in class TranslationControllerTest

FileDeleteJob::__construct() — Method in class FileDeleteJob

SystemCron::__construct() — Method in class SystemCron

VirusScanController::__construct() — Method in class VirusScanController

Service::__call() — Method in class Service

Checks if a callback is defined on the Method and calls it.

Method::__construct() — Method in class Method

Method constructor.

ModelMethod::__construct() — Method in class ModelMethod

Method constructor.

ParameterObject::__construct() — Method in class ParameterObject

OAuthClientCheck::__construct() — Method in class OAuthClientCheck

OAuthClient::__construct() — Method in class OAuthClient

OAuthClient constructor.

OpenIDConfiguration::__construct() — Method in class OpenIDConfiguration

OpenIDConfiguration constructor.

SystemCron::__construct() — Method in class SystemCron

XELOS\Modules\SystemDMS\xsc_system_dms constructor.

WidgetsPortlet::__construct() — Method in class WidgetsPortlet

put your comment there.

ActionIntegrationTestBase::_before() — Method in class ActionIntegrationTestBase

Clears the cache and the IM cache, deletes all workflow items and sets the instance variables.

WorkflowItemProcessTest::_before() — Method in class WorkflowItemProcessTest

HeaderFieldsActionTest::_before() — Method in class HeaderFieldsActionTest

HeaderFieldsActionTest::_after() — Method in class HeaderFieldsActionTest

IndexDaemonPerformance::_before() — Method in class IndexDaemonPerformance

CmsSimplePortletShowPortlet::__construct() — Method in class CmsSimplePortletShowPortlet

put your comment there.