feliraii 3.3.2 constructor & destructor documentation. . . . . . . . . . . . . . . . . . . . . ....
TRANSCRIPT
Felira
Generated by Doxygen 1.8.18
i
1 Hierarchical Index 1
1.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2 Data Structure Index 5
2.1 Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Data Structure Documentation 11
3.1 ArchiveManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.2.1 createZip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1.2.2 extractZip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.1.2.3 getArchiveComment() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.2 Article Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.3.1 activateArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.2.3.2 createConfigurationView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.2.3.3 createEditView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.2.3.4 createListView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.2.3.5 createMenuItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2.3.6 createPreview() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2.3.7 createRichSnippetsEditor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2.3.8 deleteArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.2.3.9 duplicateArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.2.3.10 getArticleByAlias() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2.3.11 getArticleById() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2.3.12 getArticleNameOptionsArray() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2.3.13 getArticles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2.3.14 getArticlesByCategory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2.3.15 getArticlesForMenu() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2.3.16 getCategoryForArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.2.3.17 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.2.3.18 loadSingleContentElementData() . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.2.3.19 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.2.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.2.4.1 $contentElementManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.2.4.2 $elementDataManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.2.4.3 $richSnippetManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.3 Article Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Generated by Doxygen
ii
3.3.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.3.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.3.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.3.3.1 afterRender() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.3.3.2 renderArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.3.3.3 renderArticles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.3.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.3.4.1 $contentElementRenderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.4 ArticleLink Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.3.2 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.5 BackEnd Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.5.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.5.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.5.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.5.3.1 render() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.6 BackEnd Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.6.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.6.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.6.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.6.3.1 addBreadcrumb() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.6.3.2 addCssFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.6.3.3 addJsFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.6.3.4 addTile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.6.3.5 addVariable() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.6.3.6 getAction() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.6.3.7 getCssFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.6.3.8 getJsFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.6.3.9 getModule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.6.3.10 getObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.6.3.11 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.6.3.12 setRequestInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.6.3.13 setTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.6.3.14 setTitle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.6.3.15 setTitleToken() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.6.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Generated by Doxygen
iii
3.6.4.1 $action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.2 $breadcrumbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.3 $cssFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.4 $jsFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.5 $module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.6 $object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.7 $template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.4.8 $tiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.6.4.9 $title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.6.4.10 $variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.7 BackEnd Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.7.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
3.7.2.1 process() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.8 BackEndMenu Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.8.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.8.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.8.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.8.3.1 addTopMenu() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.8.3.2 createBackEndMenuItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.8.3.3 isMenuItemVisible() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3.8.3.4 sortMenuArray() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3.8.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3.8.4.1 $menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3.9 Binary Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.9.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.9.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.9.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.9.3.1 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.9.3.2 setBinaryData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.9.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.9.4.1 $data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.10 BrowserDetector Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.10.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.10.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.10.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.10.3.1 extractBrowserInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.10.3.2 extractVersionNumber() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.10.3.3 getBrowserInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Generated by Doxygen
iv
3.10.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.10.4.1 $browserInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.11 Category Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.11.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.11.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.11.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.11.3.1 createEditView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.11.3.2 deleteCategory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.11.3.3 getCategories() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.11.3.4 getCategoriesWithArticleCount() . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.11.3.5 getCategoryByAlias() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.11.3.6 getCategoryByArticleAlias() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.11.3.7 getCategoryById() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.11.3.8 getCategoryNameOptions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.3.9 getCategoryTypeOptions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.3.10 getMainPageCategory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.3.11 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.3.12 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.11.3.13 sortCategory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
3.11.3.14 verboseCategoryType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
3.12 ClassLoader Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.12.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.12.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.12.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.12.3.1 addIncludePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.12.3.2 loadClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
3.13 Module\ContactForm Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
3.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
3.13.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.13.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.13.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.13.3.1 processFrontEndAjaxRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.14 ContentElement Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.14.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.14.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.14.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.14.3.1 afterRender() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.14.3.2 renderContentElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.14.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Generated by Doxygen
v
3.14.4.1 $renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.15 ContentElement Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.15.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.15.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.15.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.15.3.1 deleteContentElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
3.15.3.2 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.15.3.3 loadContentElementAssignments() . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.15.3.4 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.15.3.5 saveContentElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.15.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.15.4.1 $contentElementCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
3.16 ContentElement Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.16.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.16.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.16.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.16.3.1 countUse() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.16.3.2 getNameToken() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.16.3.3 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
3.16.3.4 onAfterRender() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
3.16.3.5 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
3.16.3.6 render() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.16.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.16.4.1 $nameToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.16.4.2 $usageCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.17 Module\Dashboard Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.17.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.17.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.17.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.17.3.1 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
3.18 Database Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
3.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.18.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.18.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.18.2.2 __destruct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.18.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.18.3.1 connect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.18.3.2 disconnect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.18.3.3 escapeColumn() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Generated by Doxygen
vi
3.18.3.4 executeCommand() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
3.18.3.5 executeCommandExtendedParam() . . . . . . . . . . . . . . . . . . . . . . . . 66
3.18.3.6 executeQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
3.18.3.7 getDatabaseType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.18.3.8 getLastInsertId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.18.3.9 isConnected() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.18.3.10 listColumns() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.18.3.11 listConstraints() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.18.3.12 listDatabases() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.18.3.13 listTables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.18.3.14 logQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
3.18.3.15 transactionCommit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
3.18.3.16 transactionRollBack() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
3.18.3.17 transactionStart() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
3.18.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.18.4.1 $connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.18.4.2 $handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.18.4.3 $isConnected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.19 DatabaseManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
3.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.19.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.19.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.19.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.19.3.1 checkColumns() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
3.19.3.2 checkConstraints() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
3.19.3.3 checkTables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
3.19.3.4 createScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
3.19.3.5 getColumnDataType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
3.19.3.6 getCreateColumnStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
3.19.3.7 getCreateConstraintStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
3.19.3.8 getCreateTableStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
3.19.3.9 getDropColumnStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.19.3.10 getDropConstraintStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.19.3.11 getDropTableStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
3.19.3.12 getModifyColumnStatement() . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
3.19.3.13 getNotifications() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
3.19.3.14 getQueuedCommands() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.19.3.15 performDatabaseUpdate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.19.3.16 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.20 DataObject Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
3.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
3.20.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Generated by Doxygen
vii
3.20.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
3.20.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
3.20.3.1 addFieldDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
3.20.3.2 createAlias() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
3.20.3.3 createNewObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
3.20.3.4 deleteObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
3.20.3.5 escapeObjectStrings() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
3.20.3.6 getDefinedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
3.20.3.7 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
3.20.3.8 getTableName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
3.20.3.9 hideFieldDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
3.20.3.10 loadObjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
3.20.3.11 loadSingleObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
3.20.3.12 performInsert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
3.20.3.13 performUpdate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
3.20.3.14 processObjectData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
3.20.3.15 saveObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
3.20.3.16 setFieldOptions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
3.20.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.20.4.1 $defaultSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.20.4.2 $fieldDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.20.4.3 $table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.21 Module\DistributionManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
3.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
3.21.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
3.21.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
3.21.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
3.21.3.1 checkAddFileToArchive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
3.21.3.2 createDistributionArchive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
3.21.3.3 createDistributionItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
3.21.3.4 getDistributionItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
3.21.3.5 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
3.22 ElementData Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
3.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.22.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.22.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.22.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.22.3.1 duplicateElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.22.3.2 getAllElementsWithImages() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
3.22.3.3 getElementsForArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
3.22.3.4 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
3.22.3.5 loadOrCreateElementData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Generated by Doxygen
viii
3.22.3.6 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
3.22.3.7 processElementField() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
3.22.3.8 saveElementData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
3.22.3.9 saveMultipleElementData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
3.23 Environment Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
3.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.23.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.23.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.23.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.23.3.1 compareMemory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.23.3.2 get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.23.3.3 getDocumentRoot() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
3.23.3.4 getGDVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
3.23.3.5 getMaxScriptExecutionTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
3.23.3.6 getMaxScriptInputTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
3.23.3.7 getMemoryLimit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
3.23.3.8 getOperatingSystem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
3.23.3.9 getPeakMemoryUsage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
3.23.3.10 getPHPIniFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
3.23.3.11 getPHPInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
3.23.3.12 getPHPVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
3.23.3.13 getPOSTLimit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
3.23.3.14 getServerSoftware() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
3.23.3.15 getSessionCookieLifetime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
3.23.3.16 getSessionDataLifetime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
3.23.3.17 getSizeInBytes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
3.23.3.18 getSystemIdentifier() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
3.23.3.19 getTempDir() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
3.23.3.20 getTotalUploadLimit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
3.23.3.21 getUploadLimit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
3.23.3.22 getZendVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
3.23.3.23 isModHeadersInstalled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3.23.3.24 isModRewriteInstalled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3.23.3.25 isWindows() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3.23.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3.23.4.1 $instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
3.24 EventLog Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
3.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
3.24.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
3.24.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
3.24.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
3.24.3.1 getNotifications() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Generated by Doxygen
ix
3.24.3.2 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
3.25 ExportableObject Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
3.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
3.25.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
3.25.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
3.25.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
3.25.3.1 generateDefaultCSV() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
3.25.3.2 generateExportList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
3.26 Extension Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
3.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
3.26.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
3.26.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
3.26.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.26.3.1 tagFeliraArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.26.3.2 tagFeliraImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.26.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.26.4.1 $renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.27 Felira Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
3.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
3.27.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
3.27.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
3.27.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
3.27.3.1 getClassLoader() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
3.27.3.2 getDatabase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
3.27.3.3 getMessageHandler() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
3.27.3.4 getMyPagePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
3.27.3.5 getMyPageUrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.27.3.6 getPluginManager() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.27.3.7 getSession() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.27.3.8 getSettingsManager() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
3.27.3.9 getTranslator() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
3.27.3.10 getURLBuilder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
3.27.3.11 renderBackEnd() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
3.27.3.12 renderFrontEnd() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
3.27.3.13 renderPreview() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4.1 $classLoader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4.2 $database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4.3 $messageHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4.4 $pluginManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4.5 $session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
3.27.4.6 $settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Generated by Doxygen
x
3.27.4.7 $translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
3.27.4.8 $urlBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
3.28 File Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
3.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
3.28.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
3.28.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
3.28.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
3.28.3.1 delete() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
3.28.3.2 getAccessTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
3.28.3.3 getCreationTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
3.28.3.4 getDisplayName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
3.28.3.5 getExtension() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
3.28.3.6 getModificationTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
3.28.3.7 getName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
3.28.3.8 getObjectName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
3.28.3.9 getPermissions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
3.28.3.10 getSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
3.28.3.11 getSystemName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
3.28.3.12 getType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
3.28.3.13 getUrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
3.28.3.14 isDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
3.28.3.15 isReadable() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
3.28.3.16 read() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
3.28.3.17 setDisplayName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
3.28.3.18 setUrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
3.28.3.19 verbosePermission() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
3.28.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
3.28.4.1 $displayName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
3.28.4.2 $fileContentTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
3.28.4.3 $fileTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
3.28.4.4 $name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
3.28.4.5 $objectName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
3.28.4.6 $systemName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
3.28.4.7 $url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.29 FileBrowser Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.29.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.29.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.29.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.29.3.1 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
3.30 FileManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
3.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Generated by Doxygen
xi
3.30.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
3.30.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
3.30.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
3.30.3.1 convertFileListToOptionList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
3.30.3.2 copyFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
3.30.3.3 deleteFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
3.30.3.4 deletePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
3.30.3.5 getDirectoryList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
3.30.3.6 getFileList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
3.30.3.7 getSystemName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
3.30.3.8 isDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
3.30.3.9 processFileUpload() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
3.30.3.10 touchFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3.30.3.11 writeFileWithBackup() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3.30.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
3.30.4.1 $isWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
3.31 Module\FileManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
3.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
3.31.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
3.31.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.31.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.31.3.1 getFileList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.31.3.2 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
3.31.3.3 processFileManagerRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
3.32 FileStorage Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
3.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.32.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.32.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.32.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.32.3.1 deleteFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
3.32.3.2 getFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
3.32.3.3 getFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
3.32.3.4 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
3.32.3.5 getStorageTypes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.32.3.6 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.32.3.7 retrieveFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
3.32.3.8 storeFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.32.3.9 verboseFileStorageType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.33 FrontEnd Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
3.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.33.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.33.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Generated by Doxygen
xii
3.33.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.33.3.1 render() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
3.33.3.2 renderSinglePager() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.33.3.3 renderWebsite() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
3.34 FrontEnd Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
3.34.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.34.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.34.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.34.3.1 addCssFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.34.3.2 addJsFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
3.34.3.3 getCssFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.34.3.4 getJsFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.34.3.5 getRenderer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.34.3.6 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
3.34.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.34.4.1 $cssFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.34.4.2 $jsFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.34.4.3 $renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.35 FrontEnd Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
3.35.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
3.35.2.1 createResponse() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
3.35.2.2 process() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
3.35.2.3 processAjaxRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
3.35.2.4 processRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.36 Generic Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
3.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.36.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.36.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.36.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
3.36.3.1 escapeColumn() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
3.36.3.2 getDatabase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
3.36.3.3 getListColumnsQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
3.36.3.4 getListConstraintsQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
3.36.3.5 getListDatabasesQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
3.36.3.6 getListTablesQuery() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
3.36.3.7 getPDOInstance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
3.36.3.8 getType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
3.36.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.36.4.1 $db . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.36.4.2 $leftColumnDelimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Generated by Doxygen
xiii
3.36.4.3 $listColumnsQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.36.4.4 $listConstraintsQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.36.4.5 $listDatabasesQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.36.4.6 $listTablesQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
3.36.4.7 $rightColumnDelimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
3.37 GoogleMaps Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
3.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
3.37.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
3.37.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.37.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.37.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.37.3.2 onAfterRender() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.37.3.3 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
3.38 HTML Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
3.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
3.38.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
3.38.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
3.38.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
3.38.3.1 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
3.38.3.2 setHTML() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
3.38.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
3.38.4.1 $htmlData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
3.39 HtmlText Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
3.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
3.39.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
3.39.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
3.39.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
3.39.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
3.39.3.2 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
3.40 Image Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.40.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.40.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.40.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
3.40.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
3.40.3.2 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
3.41 ImageFilter Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
3.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.41.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.41.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.41.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
3.41.3.1 createEditView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Generated by Doxygen
xiv
3.41.3.2 createListView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
3.41.3.3 getFilterTypes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
3.41.3.4 getImageFilterById() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
3.41.3.5 getImageFilterByName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
3.41.3.6 getImageFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
3.41.3.7 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
3.41.3.8 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
3.41.3.9 verboseFilterType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
3.42 ImageProcessor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
3.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.42.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.42.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.42.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.42.3.1 applyFilter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
3.42.3.2 cropImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
3.42.3.3 greyscaleImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
3.42.3.4 loadImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
3.42.3.5 resizeImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
3.42.3.6 saveImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
3.42.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
3.42.4.1 $gdInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
3.43 JSON Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
3.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
3.43.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.43.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.43.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.43.3.1 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.43.3.2 setJsonData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.43.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
3.43.4.1 $jsonData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
3.44 Module\LessManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
3.44.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
3.44.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
3.44.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.44.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.44.3.1 onAfterSave() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.44.3.2 parsePrivateVariables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
3.44.3.3 registerCssAndJsFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
3.45 Link Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
3.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
3.45.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
3.45.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Generated by Doxygen
xv
3.45.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
3.45.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
3.45.3.2 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
3.46 Login Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
3.46.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
3.46.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
3.46.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.46.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.46.3.1 getDefaultPage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.46.3.2 getLoginPageCode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.46.3.3 process() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.47 Mailer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
3.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
3.47.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
3.47.2.1 sendHtmlMail() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
3.47.2.2 sendMail() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
3.47.2.3 validateMailSettings() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
3.48 MailTemplate Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
3.48.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
3.48.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.48.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.48.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.48.3.1 createEditView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.48.3.2 createListView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.48.3.3 getMailTemplateById() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
3.48.3.4 getMailTemplateList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
3.48.3.5 getMailTemplates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
3.48.3.6 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
3.48.3.7 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
3.49 Maintenance Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
3.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
3.49.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
3.49.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.49.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.49.3.1 render() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.50 Maintenance Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
3.50.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.50.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.50.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.50.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.50.3.1 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
3.51 MessageHandler Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Generated by Doxygen
xvi
3.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.51.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.51.2.1 addDetailedErrorMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
3.51.2.2 addErrorMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
3.51.2.3 addInfoMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
3.51.2.4 addMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
3.51.2.5 addSuccessMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
3.51.2.6 addWarningMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
3.51.2.7 getLastMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
3.51.2.8 getMessageCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
3.51.2.9 getMessages() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
3.51.3 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
3.51.3.1 $messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.51.3.2 FELIRA_MESSAGE_ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.51.3.3 FELIRA_MESSAGE_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.51.3.4 FELIRA_MESSAGE_SUCCESS . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.51.3.5 FELIRA_MESSAGE_WARNING . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.52 Module Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
3.52.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
3.52.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.52.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.52.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.52.3.1 addAction() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.52.3.2 addDirectAction() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
3.52.3.3 addDummyAction() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
3.52.3.4 addMenuItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
3.52.3.5 addPopupMenu() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
3.52.3.6 getFirstAllowedAction() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
3.52.3.7 getMenuItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
3.52.3.8 getModuleActions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
3.52.3.9 getModuleName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
3.52.3.10 getNotifications() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
3.52.3.11 getPluginDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
3.52.3.12 getPluginPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
3.52.3.13 getPluginTemplatePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
3.52.3.14 getPluginUrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
3.52.3.15 getVendorPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
3.52.3.16 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
3.52.3.17 processFrontEndAjaxRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . 191
3.52.3.18 processFrontEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
3.52.3.19 setPluginDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
3.52.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Generated by Doxygen
xvii
3.52.4.1 $actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
3.52.4.2 $menuItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
3.52.4.3 $moduleName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
3.52.4.4 $pluginDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
3.53 MSSQL Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
3.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
3.53.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
3.53.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
3.53.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
3.53.3.1 getPDOInstance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
3.54 MySQL Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
3.54.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
3.54.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
3.54.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
3.54.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
3.54.3.1 getPDOInstance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
3.55 ObjectList Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
3.55.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
3.55.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
3.55.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
3.55.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
3.55.3.1 addColumn() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
3.55.3.2 addItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
3.55.3.3 addMenuItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
3.55.3.4 addTopButton() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
3.55.3.5 createAction() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
3.55.3.6 getList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.55.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.55.4.1 $columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.55.4.2 $items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.55.4.3 $menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.55.4.4 $topLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.56 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
3.56.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.56.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.56.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.56.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.56.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.57 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
3.57.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
3.57.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
3.57.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Generated by Doxygen
xviii
3.57.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
3.57.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
3.58 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.58.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.58.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.58.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.58.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.58.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
3.59 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.59.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.59.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.59.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.59.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.59.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
3.60 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
3.60.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
3.60.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
3.60.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
3.60.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
3.60.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
3.61 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
3.61.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
3.61.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
3.61.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
3.61.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
3.61.3.1 addComponentInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
3.61.3.2 getComponentInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
3.61.3.3 getNameToken() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
3.61.3.4 getPluginDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
3.61.3.5 getPluginId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
3.61.3.6 getPluginLogo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
3.61.3.7 getPluginUrl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
3.61.3.8 getTranslationPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
3.61.3.9 getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.61.3.10 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.61.3.11 setPluginDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.61.3.12 setPluginLogo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
3.61.3.13 usedInFrontEnd() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
3.61.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
3.61.4.1 $componentData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
3.61.4.2 $frontEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
3.61.4.3 $imageUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Generated by Doxygen
xix
3.61.4.4 $nameToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
3.61.4.5 $pluginDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
3.61.4.6 $version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
3.62 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
3.62.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
3.62.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
3.62.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
3.62.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
3.62.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
3.63 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
3.63.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
3.63.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
3.63.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
3.63.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
3.63.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
3.64 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
3.64.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.64.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.64.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.64.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.64.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.65 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
3.65.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.65.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.65.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.65.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.65.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.66 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
3.66.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
3.66.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
3.66.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
3.66.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
3.66.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
3.67 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.67.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.67.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.67.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.67.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.67.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
3.68 Plugin Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
3.68.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
3.68.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Generated by Doxygen
xx
3.68.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
3.68.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
3.68.3.1 init() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
3.69 PluginManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
3.69.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
3.69.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
3.69.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
3.69.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
3.69.3.1 getContentElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
3.69.3.2 getContentElementOptionsArray() . . . . . . . . . . . . . . . . . . . . . . . . . 221
3.69.3.3 getContentElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
3.69.3.4 getDefaultTypeName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
3.69.3.5 getModule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
3.69.3.6 getModules() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
3.69.3.7 getObjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
3.69.3.8 getPluginClasses() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
3.69.3.9 loadPlugin() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
3.69.3.10 loadPlugins() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
3.69.3.11 registerContentElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
3.69.3.12 registerModule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
3.69.3.13 registerSystemModule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
3.69.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.69.4.1 $elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.69.4.2 $modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.69.4.3 $plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.70 Preview Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
3.70.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.70.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.70.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.70.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.70.3.1 render() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.71 Relation Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
3.71.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
3.71.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
3.71.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
3.71.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
3.71.3.1 addRelation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
3.71.3.2 deleteRelation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
3.71.3.3 getDefinedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
3.71.3.4 getTableName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
3.71.3.5 setRelation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
3.71.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Generated by Doxygen
xxi
3.71.4.1 $relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.71.4.2 $table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.72 Renderer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
3.72.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.72.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.72.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.72.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.72.3.1 cleanupHtml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
3.72.3.2 getTemplateDir() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
3.72.3.3 getTemplateVars() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
3.72.3.4 prepareTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
3.72.3.5 renderErrorTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
3.72.3.6 renderExplicitTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.72.3.7 renderTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.72.3.8 setHTTPStatusCode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
3.72.3.9 setTemplateDir() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.72.3.10 setTemplateVar() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.72.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.72.4.1 $browserInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.72.4.2 $smarty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3.73 Request Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
3.73.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
3.73.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
3.73.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.73.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.73.3.1 backEndRedirect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.73.3.2 calculateSecurityHash() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.73.3.3 frontEndRedirect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
3.73.3.4 get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
3.73.3.5 getGetVariable() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
3.73.3.6 getJSONData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
3.73.3.7 getPostVariable() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
3.73.3.8 getPostVariables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
3.73.3.9 getRemoteIp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
3.73.3.10 isAjaxRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
3.73.3.11 isPostVariableSet() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
3.73.3.12 redirect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
3.73.3.13 setPostVariable() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
3.73.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
3.73.4.1 $instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
3.74 Response Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
3.74.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Generated by Doxygen
xxii
3.74.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
3.74.2.1 getCharacterSet() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.74.2.2 getContentType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.74.2.3 getFileName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.74.2.4 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
3.74.2.5 sendResponse() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
3.74.2.6 setContentType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
3.74.2.7 setFileName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
3.74.2.8 setStatusCode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
3.74.3 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.74.3.1 $charset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.74.3.2 $contentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.74.3.3 $fileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.74.3.4 $inline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.74.3.5 $statusCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
3.75 RichSnippet Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
3.75.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.75.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.75.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.75.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.75.3.1 createItemProp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
3.75.3.2 createItemType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.75.3.3 getItemByItemtype() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.75.3.4 getItemProp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
3.75.3.5 getItemtypeNameToken() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
3.75.3.6 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
3.75.3.7 getRichSnippetData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
3.75.3.8 getSnippetDataForArticle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
3.75.3.9 getSnippetItempropOptionArray() . . . . . . . . . . . . . . . . . . . . . . . . . . 248
3.75.3.10 getSnippetItemtypeOptionArray() . . . . . . . . . . . . . . . . . . . . . . . . . 249
3.75.3.11 inheritItemType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
3.75.3.12 initSnippetData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
3.75.3.13 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.75.3.14 saveRichSnippetsData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.75.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.75.4.1 $itemPropData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
3.75.4.2 $itemTypeData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
3.76 Session Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
3.76.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
3.76.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
3.76.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
3.76.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Generated by Doxygen
xxiii
3.76.3.1 deleteCustomData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
3.76.3.2 getCurrentPageData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
3.76.3.3 getCustomData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
3.76.3.4 getDataArray() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
3.76.3.5 getSecurityHash() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
3.76.3.6 getUserId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
3.76.3.7 getUserLocale() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
3.76.3.8 getUserName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
3.76.3.9 getUserPermissions() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
3.76.3.10 isAllowed() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
3.76.3.11 isUserLoggedIn() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
3.76.3.12 login() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
3.76.3.13 logout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
3.76.3.14 setCurrentPageData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
3.76.3.15 setCustomData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
3.77 Settings Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
3.77.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
3.77.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
3.77.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
3.77.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
3.77.3.1 disableSetting() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
3.77.3.2 getNotifications() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
3.77.3.3 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
3.77.3.4 getSetting() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
3.77.3.5 getSettingsForTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
3.77.3.6 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
3.77.3.7 registerDefaultSettings() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
3.77.3.8 registerSetting() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
3.77.3.9 saveObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
3.77.3.10 setSetting() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
3.77.3.11 verifyMaintenanceModeIp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
3.77.3.12 verifyXDebug() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.77.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.77.4.1 $sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.77.4.2 $settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.77.4.3 $settingsData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.78 SimpleSlider Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
3.78.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.78.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.78.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.78.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.78.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Generated by Doxygen
xxiv
3.78.3.2 onAfterRender() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
3.78.3.3 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
3.79 SimpleText Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
3.79.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
3.79.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
3.79.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
3.79.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
3.79.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
3.79.3.2 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
3.80 Module\Sitemap Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
3.80.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
3.80.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
3.80.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
3.80.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
3.80.3.1 processFrontEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
3.81 Sitemap Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
3.81.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.81.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.81.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.81.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.81.3.1 createSitemapLinks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
3.81.3.2 renderSitemap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
3.82 Module\StyleManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
3.82.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
3.82.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.82.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.82.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.82.3.1 registerCssAndJsFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.83 SvgFile Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
3.83.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
3.83.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
3.83.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
3.83.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
3.83.3.1 addCircle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
3.83.3.2 addLine() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
3.83.3.3 addRect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
3.83.3.4 addText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3.83.3.5 clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3.83.3.6 render() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3.83.3.7 setBrushColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3.83.3.8 setFont() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
3.83.3.9 setPenColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Generated by Doxygen
xxv
3.83.3.10 setPenSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
3.83.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.1 $brushColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.2 $canvasHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.3 $canvasWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.4 $elementList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.5 $fontFamily . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.6 $fontSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.7 $penColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
3.83.4.8 $penSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
3.84 Syslog Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
3.84.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.84.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.84.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.84.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.84.3.1 clearLog() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.84.3.2 get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
3.84.3.3 getEventMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
3.84.3.4 getLastErrorMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
3.84.3.5 getLog() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
3.84.3.6 logDebug() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
3.84.3.7 logError() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
3.84.3.8 logErrorWithoutTrace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
3.84.3.9 logEvent() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
3.84.3.10 logInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
3.84.3.11 logPostVariables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
3.84.3.12 logWarning() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
3.84.3.13 setEventMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.84.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.84.4.1 $fileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.84.4.2 $instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.84.4.3 $lastEventMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
3.84.4.4 $logTypeMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
3.85 SystemEditor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
3.85.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
3.85.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
3.85.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
3.85.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
3.85.3.1 getFileList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
3.85.3.2 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
3.85.3.3 registerCssAndJsFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
3.85.3.4 saveFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Generated by Doxygen
xxvi
3.85.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
3.85.4.1 $folderName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
3.86 Module\SystemInformation Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
3.86.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
3.86.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
3.86.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
3.86.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
3.86.3.1 createDataItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
3.86.3.2 getPHPInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
3.86.3.3 getSystemInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
3.86.3.4 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
3.87 Template Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
3.87.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
3.87.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
3.87.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.87.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.87.3.1 createConfigView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.87.3.2 createEditView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.87.3.3 createListView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
3.87.3.4 deleteTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.87.3.5 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.87.3.6 getTemplateOptionsArray() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.87.3.7 getTemplates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.87.3.8 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
3.88 TemplateCache Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
3.88.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
3.88.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
3.88.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.88.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.88.3.1 clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.88.3.2 getCacheInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.88.3.3 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
3.89 Module\TemplateManager Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
3.89.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
3.89.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
3.89.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
3.89.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
3.89.3.1 registerCssAndJsFiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
3.90 Tile Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
3.90.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.90.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.90.2.1 setDeleteLink() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Generated by Doxygen
xxvii
3.90.2.2 setIcon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.90.2.3 setObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
3.90.2.4 setTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.90.2.5 setTitle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.90.3 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.90.3.1 $deleteLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.90.3.2 $iconUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
3.90.3.3 $object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.90.3.4 $template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.90.3.5 $title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.91 Tile Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.91.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
3.91.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
3.91.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
3.91.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
3.91.3.1 renderTiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
3.92 Timer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
3.92.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.92.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.92.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.92.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.92.3.1 getDuration() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
3.92.3.2 getTimestamp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.92.3.3 start() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.92.3.4 stop() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.92.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.92.4.1 $endTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.92.4.2 $startTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.92.4.3 $useMicrotime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
3.93 Translator Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
3.93.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
3.93.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
3.93.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
3.93.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.93.3.1 addBackEndTranslations() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.93.3.2 addFrontEndTranslations() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.93.3.3 addTranslations() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.93.3.4 getTranslations() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.93.3.5 translate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
3.93.3.6 translateParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
3.93.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
3.93.4.1 $languageCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Generated by Doxygen
xxviii
3.93.4.2 $translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
3.94 Module\UpdateClient Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
3.94.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
3.94.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
3.94.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
3.94.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.94.3.1 getUpdateFileList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.94.3.2 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.94.3.3 updateFromServer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
3.94.3.4 updateFromUpload() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.95 Updater Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.95.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.95.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
3.95.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
3.95.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
3.95.3.1 cleanupDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
3.95.3.2 getUpdatePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
3.95.3.3 updateDirectory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
3.95.3.4 updateFromArchive() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
3.95.3.5 updateFromPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
3.95.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
3.95.4.1 $fileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
3.96 Module\UpdateServer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
3.96.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
3.96.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
3.96.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
3.96.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
3.96.3.1 extractVersionHistory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
3.96.3.2 processFrontEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
3.97 UrlBuilder Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.97.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.97.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.97.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.97.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.97.3.1 createBackEndLink() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
3.97.3.2 createBackEndURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
3.97.3.3 createFrontEndURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
3.98 User Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
3.98.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
3.98.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
3.98.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
3.98.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Generated by Doxygen
xxix
3.98.3.1 authenticate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
3.98.3.2 createEditView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
3.98.3.3 createListView() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
3.98.3.4 createRightsEditor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
3.98.3.5 deleteUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
3.98.3.6 getLocales() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
3.98.3.7 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
3.98.3.8 getRightsFromUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
3.98.3.9 getUserById() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
3.98.3.10 getUserNameOptionsArray() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
3.98.3.11 getUsers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
3.98.3.12 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
3.98.3.13 saveUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
3.98.3.14 saveUserRights() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
3.98.3.15 validateMailAddress() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
3.99 UserEvent Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
3.99.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
3.99.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
3.99.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
3.99.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
3.99.3.1 clearEvents() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
3.99.3.2 getObjectDefinition() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
3.99.3.3 getUserEvents() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
3.99.3.4 logUserEvent() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
3.99.3.5 processBackEndRequest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.99.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.99.4.1 UET_ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.99.4.2 UET_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.99.4.3 UET_SUCCESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
3.99.4.4 UET_WARNING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
3.100 Video Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
3.100.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
3.100.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 323
3.100.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
3.100.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
3.100.3.1 getUsedFields() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
3.100.3.2 prepareElementTemplate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
3.101 XML Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
3.101.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
3.101.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 325
3.101.2.1 __construct() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
3.101.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Generated by Doxygen
xxx
3.101.3.1 getResponseData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
3.101.3.2 setXML() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
3.101.4 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
3.101.4.1 $xmlData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Index 327
Generated by Doxygen
Chapter 1
Hierarchical Index
1.1 Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
ArchiveManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11BackEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36BackEndMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37BrowserDetector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41ClassLoader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49ContentElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Felira . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114FileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123FrontEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Generic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
MSSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
ImageProcessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Mailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170MessageHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Module\ContactForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50ContentElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
ArticleLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25GoogleMaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148HtmlText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167SimpleSlider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262SimpleText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264Video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Module\Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62DatabaseManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71DataObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Article . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
2 Hierarchical Index
ContentElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53ElementData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90FileStorage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131ImageFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155MailTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173RichSnippet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313UserEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319ExportableObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Module\DistributionManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87EventLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103FileBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Module\FileManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Module\Sitemap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266SystemEditor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Module\LessManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Module\StyleManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Module\TemplateManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Module\SystemInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285TemplateCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291Module\UpdateClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304Module\UpdateServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
ObjectList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
PluginManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Article . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22BackEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27FrontEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Sitemap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Tile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
BackEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40FrontEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Generated by Doxygen
1.1 Class Hierarchy 3
XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251SvgFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276Tile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298Translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Updater . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306UrlBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Generated by Doxygen
4 Hierarchical Index
Generated by Doxygen
Chapter 2
Data Structure Index
2.1 Data Structures
Here are the data structures with brief descriptions:
ArchiveManagerThe archive manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ArticleThe article manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ArticleThe article renderer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
ArticleLinkThe content element for an article link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
BackEndThe back-end renderer for the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
BackEndThe back-end response object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . 28
BackEndThe back-end class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
BackEndMenuThe main menu of the Felira back-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
BinaryThe binary response object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 40
BrowserDetectorThe Felira browser detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
CategoryThe category manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
ClassLoaderThe class loader of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Module\ContactFormThe contact form module of the Felira system. It is used to process the data of a contact formthat was submitted from the front-end (via Ajax) . . . . . . . . . . . . . . . . . . . . . . . . . 50
ContentElementThe content element renderer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . 51
ContentElementThe content element manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . 53
ContentElementThe base class for a Felira content elements . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Module\DashboardThe Dashboard of the Felira system. It is used in the back-end to provide information to the useron the dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
6 Data Structure Index
DatabaseThe Felira database (connection) class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
DatabaseManagerThe database manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
DataObjectThe basic data object class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 79
Module\DistributionManagerThe distribution manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ElementDataThe element data manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 90
EnvironmentThe environment of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
EventLogThe event log module of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ExportableObjectThe basic exportable object class of the Felira system . . . . . . . . . . . . . . . . . . . . . . 105
ExtensionThe extension renderer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
FeliraThe main class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
FileThe file object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
FileBrowserThe file browser that is used from TinyMCE for selecting files . . . . . . . . . . . . . . . . . . 122
FileManagerThe file manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Module\FileManagerThe file manager module of the Felira system. It is used to upload and manage additional filesfor the page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
FileStorageThe file storage of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
FrontEndThe front-end renderer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
FrontEndThe front-end response object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . 138
FrontEndThe front-end request class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 141
GenericThe generic database connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
GoogleMapsThe content element for a Google Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
HTMLThe HTML response object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 150
HtmlTextThe content element for simple html text content . . . . . . . . . . . . . . . . . . . . . . . . . 152
ImageThe content element for an image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
ImageFilterThe image filter manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . 155
ImageProcessorThe image processor of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
JSONThe JSON response object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 163
Module\LessManagerThe Less manager module of the Felira system. It provides online less file editing & compiling . 165
LinkThe content element for a link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Generated by Doxygen
2.1 Data Structures 7
LoginThe log-in manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
MailerThe mailer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
MailTemplateThe mail template manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 173
MaintenanceThe "maintenance mode" renderer for the Felira system . . . . . . . . . . . . . . . . . . . . . 176
MaintenanceThe maintenance response object of the Felira system . . . . . . . . . . . . . . . . . . . . . 177
MessageHandlerThe message handler class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 178
ModuleThe base class for all types of Felira modules . . . . . . . . . . . . . . . . . . . . . . . . . . 183
MSSQLThe database connector for Microsoft SQL Server databases . . . . . . . . . . . . . . . . . . 193
MySQLThe database connector for MySQL or MariaDB databases . . . . . . . . . . . . . . . . . . . 195
ObjectListThe object list class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
PluginThe style manager plugin of the Felira system. It provides online css file editing . . . . . . . . 200
PluginThe system information plugin of the Felira system. It is used to provide and evaluate systeminformation in the back-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
PluginThe template editor plugin of the Felira system. It provides online template file editing . . . . . 203
PluginThe updater plugin of the Felira system. It provides the back-end interface for the updater . . . 204
PluginThe update server plugin of the Felira system. It provides an interface to query the availableupdates for Felira . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
PluginThe base class for a Felira plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
PluginThe default contact form plugin of the Felira system . . . . . . . . . . . . . . . . . . . . . . . 212
PluginThe dashboard plugin of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
PluginThe distribution tool plugin of the Felira system. It is used to create zip archives for Felira distri-bution and update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
PluginThe file manager plugin of the Felira system. It is used to upload and manage additional files forthe page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
PluginThe Less manager plugin of the Felira system. It provides online less file editing & compiling . 216
PluginThe Sitemap plugin of the Felira system. It provides the Sitemap for Felira . . . . . . . . . . . 218
PluginThe content element plug-in of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . 219
PluginManagerThe plug-in manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PreviewThe renderer for the article wysiwyg preview in the back-end of the Felira system . . . . . . . 225
RelationThe basic relation class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
RendererThe base renderer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Generated by Doxygen
8 Data Structure Index
RequestThe Request object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
ResponseThe generic response object for the Felira system . . . . . . . . . . . . . . . . . . . . . . . . 240
RichSnippetThe Rich Snippet manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . 244
SessionThe session class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
SettingsThe settings manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
SimpleSliderThe content element for a simple slider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
SimpleTextThe content element for simple non-html text content . . . . . . . . . . . . . . . . . . . . . . 264
Module\SitemapThe sitemap class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
SitemapThe Sitemap renderer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Module\StyleManagerThe style manager module of the Felira system. It provides online css file editing . . . . . . . 269
SvgFileThe Scalable Vector Graphics file encapsulation of the Felira system . . . . . . . . . . . . . . 270
SyslogThe system log class of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
SystemEditorThe base class for a Felira system editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Module\SystemInformationThe system information module of the Felira system. It is used to provide and evaluate systeminformation in the back-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
TemplateThe template manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
TemplateCacheThe template cache manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . 291
Module\TemplateManagerThe template file manager module of the Felira system. It provides online template file editing . 293
TileThe tile class for the back-end tile system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
TileThe tile renderer for the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
TimerThe timer of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
TranslatorThe translator of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Module\UpdateClientThe update client of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
UpdaterThe Felira updater . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Module\UpdateServerThe update server of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
UrlBuilderThe Felira URL builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
UserThe user manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
UserEventThe user event manager of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . 319
VideoThe content element for a video . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Generated by Doxygen
2.1 Data Structures 9
XMLThe XML response object of the Felira system . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Generated by Doxygen
10 Data Structure Index
Generated by Doxygen
Chapter 3
Data Structure Documentation
3.1 ArchiveManager Class Reference
The archive manager of the Felira system.
Public Member Functions
• createZip ($archive, $files, $comment=null)• extractZip ($archive, $path)• getArchiveComment ($fileName)
3.1.1 Detailed Description
The archive manager of the Felira system.
It can be used to pack and unpack files from archive files (like zip).
Copyright
Copyright © Miscalis ®
3.1.2 Member Function Documentation
3.1.2.1 createZip()
createZip (
$archive,
$files,
$comment = null )
Creates a new zip archive. If the archive already exists, it is deleted.
12 Data Structure Documentation
Parameters
string $archive The file name of the archive to create.
array $files An array with File objects to include in the zip archive, as returned by the file manager'sGetFileList() function.
string $comment An optional comment to be added to the archive.
Returns
bool true on success, false otherwise.
3.1.2.2 extractZip()
extractZip (
$archive,
$path )
Extracts the specified archive to the specified path.
Parameters
string $archive The archive to extract.
string $path The path to extract to.
Returns
bool true on success, false otherwise.
3.1.2.3 getArchiveComment()
getArchiveComment (
$fileName )
Returns the archive comment stored in the specified zip file.
Parameters
string $fileName The full path and file name of the archive to get the comment from.
Returns
string|bool The archive comment as string or false on error.
Generated by Doxygen
3.2 Article Class Reference 13
3.2 Article Class Reference
The article manager of the Felira system.
Inheritance diagram for Article:
Article
DataObject
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getArticles ($categoryId, $maxCount=0)• getArticleNameOptionsArray ()• getCategoryForArticle ($id)• getArticlesForMenu ()• getArticleById ($articleId)• getArticlesByCategory ($categoryId)• getArticleByAlias ($articleAlias)• createMenuItems ($category, $activeArticle=null)• deleteArticle ($id)• duplicateArticle ($id)• activateArticle ($id)
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• createListView ($categoryId)• createConfigurationView ($action, $articleId)• createEditView ($articleId)• createPreview ($articleId)• createRichSnippetsEditor ($articleId)• loadSingleContentElementData ($article, $useElementCache)
Private Attributes
• $richSnippetManager = null• $contentElementManager = null• $elementDataManager = null
Generated by Doxygen
14 Data Structure Documentation
Additional Inherited Members
3.2.1 Detailed Description
The article manager of the Felira system.
It is used to manage all articles in the system, create the menu items and the sitemap.
Copyright
Copyright © Miscalis ®
3.2.2 Constructor & Destructor Documentation
3.2.2.1 __construct()
__construct ( )
Creates a new instance of the Felira article manager.
3.2.3 Member Function Documentation
3.2.3.1 activateArticle()
activateArticle (
$id )
Activates or deactivates the specified article.
Parameters
int $id The id of the article to activate or deactivate.
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The database id of the category of the article or 0 if article not found.
Generated by Doxygen
3.2 Article Class Reference 15
3.2.3.2 createConfigurationView()
createConfigurationView (
$action,
$articleId ) [private]
Creates the article configuration view and returns a back-end response for it.
Parameters
string $action The action ("configure" or "new").
int $article←↩
IdThe database id of the article to create the editor view for (or the id of the category, for"new" action).
Returns
Felira::Response|bool A response object or false on error.
3.2.3.3 createEditView()
createEditView (
$articleId ) [private]
Creates the article editor view and returns a back-end response for it.
Parameters
int $article←↩
IdThe database id of the article to edit.
Returns
Felira::Response|bool A response object or false on error.
3.2.3.4 createListView()
createListView (
$categoryId ) [private]
Creates the article list view and returns a back-end response for it.
Parameters
int $category←↩
IdThe database id of the category to create the list view for.
Generated by Doxygen
16 Data Structure Documentation
Returns
Felira::Response|bool A response object or false on error.
3.2.3.5 createMenuItems()
createMenuItems (
$category,
$activeArticle = null )
Creates an array of menu items from the loaded page articles.
Parameters
array $category The category object of the category that is currently displayed.
array | null $activeArticle The active article or null to use the first menu item.
Returns
array An array with all menu items or an empty array on error.
3.2.3.6 createPreview()
createPreview (
$articleId ) [private]
Creates the article preview and returns a back-end response for it.
Parameters
int $article←↩
IdThe database id of the article to peview.
Returns
Felira::Response|bool A response object or false on error.
3.2.3.7 createRichSnippetsEditor()
createRichSnippetsEditor (
$articleId ) [private]
Creates the "rich snippets" editor and returns a back-end response for it.
Generated by Doxygen
3.2 Article Class Reference 17
Parameters
int $article←↩
IdThe database id of the article to edit the rich snippets for.
Returns
Felira::Response|bool A response object or false on error.
3.2.3.8 deleteArticle()
deleteArticle (
$id )
Deletes the specified article and all assigned data.
Parameters
int $id The id of the article to delete.
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The database id of the category of the article to delete or 0 if article not found.
3.2.3.9 duplicateArticle()
duplicateArticle (
$id )
Duplicates the specified article and all assigned data.
Parameters
int $id The id of the article to duplicate.
Returns
array An array with:
Generated by Doxygen
18 Data Structure Documentation
1. true if the operation was successful, false otherwise.
2. The database id of the category of the article to duplicate or 0 if article not found.
3.2.3.10 getArticleByAlias()
getArticleByAlias (
$articleAlias )
Reads a single article (and its assigned content elements) specified by its alias from the database.
Parameters
string $articleAlias The alias of the article to load.
Returns
array|null The array of with the article data on success, null otherwise.
3.2.3.11 getArticleById()
getArticleById (
$articleId )
Reads a single article (and its assigned content elements) specified by its id from the database.
Parameters
int $article←↩
IdThe database id of the article to load.
Returns
array|null The array of with the article data on success, null otherwise.
3.2.3.12 getArticleNameOptionsArray()
getArticleNameOptionsArray ( )
Reads all active articles for a selection field.
Generated by Doxygen
3.2 Article Class Reference 19
Returns
array The array of articles on success, an empty array otherwise.
3.2.3.13 getArticles()
getArticles (
$categoryId,
$maxCount = 0 )
Reads all active articles (and their assigned content elements) that are assigned to the specified category from thedatabase.
Parameters
int $category←↩
IdThe database id of the category to load the assigned articles for.
int $maxCount The maximum number of articles to load (Optional, 0 = all).
Returns
array The array of articles on success, null otherwise.
3.2.3.14 getArticlesByCategory()
getArticlesByCategory (
$categoryId )
Reads all article (and the assigned template name) specified by for a specified category id from the database.
Parameters
int $category←↩
IdThe database id of the category to load the articles for.
Returns
array The array of with the article data on success, an empty array otherwise.
3.2.3.15 getArticlesForMenu()
getArticlesForMenu ( )
Reads all active articles (without their assigned content elements) from the database. The article data can be usedfor creating the page menu or a sitemap.
Generated by Doxygen
20 Data Structure Documentation
Returns
array The array of articles on success, an empty array otherwise.
3.2.3.16 getCategoryForArticle()
getCategoryForArticle (
$id )
Returns the database id of the category the specified article is assigned to.
Parameters
int $id The database id of the article to get the category for.
Returns
int The database id of the category or 0 on error.
3.2.3.17 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.2.3.18 loadSingleContentElementData()
loadSingleContentElementData (
$article,
$useElementCache ) [private]
Loads the content elements data for a single article.
Parameters
array $article The article object to get the content elements and their data for.
bool $useElementCache true to use the internal cache for the content elements, false otherwise.
Generated by Doxygen
3.2 Article Class Reference 21
Returns
array|bool The modified article object with the content element data or false on error.
3.2.3.19 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Article section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.2.4 Field Documentation
3.2.4.1 $contentElementManager
Felira DataObject ContentElement $contentElementManager = null [private]
The content element manager used to access the content elements assigned to the used template of the article.
3.2.4.2 $elementDataManager
Felira DataObject ElementData $elementDataManager = null [private]
The content element data manager to read the actual field data for the article.
3.2.4.3 $richSnippetManager
Felira DataObject RichSnippet $richSnippetManager = null [private]
The Rich Snippet manager.
Generated by Doxygen
22 Data Structure Documentation
3.3 Article Class Reference
The article renderer of the Felira system.
Inheritance diagram for Article:
Article
Renderer
Public Member Functions
• __construct (\Felira\Renderer $renderer)• renderArticles ($articles, $inEditor)• renderArticle ($article, $inEditor)• afterRender (\Felira\Response $response)
Private Attributes
• $contentElementRenderer = null
Additional Inherited Members
3.3.1 Detailed Description
The article renderer of the Felira system.
It is used to render articles (for front-end and back-end wysiwyg editor / preview) that are part of a page.
Copyright
Copyright © Miscalis ®
3.3.2 Constructor & Destructor Documentation
3.3.2.1 __construct()
__construct (
\Felira\Renderer $renderer )
Creates a new instance of the Felira article renderer.
Generated by Doxygen
3.3 Article Class Reference 23
Parameters
\Felira\Renderer $renderer The renderer used to renderer the page.
3.3.3 Member Function Documentation
3.3.3.1 afterRender()
afterRender (
\Felira\Response $response )
The function that is called after rendering the articles. It invokes the after-render callback on the content elements.
Parameters
\Felira\Response $response The response object.
3.3.3.2 renderArticle()
renderArticle (
$article,
$inEditor )
Renders the specified article and returns the resulting HTML code as string.
Parameters
array $article The article object to render.
bool $inEditor The flag that specifies if the content element is rendered for use in the web site (false) or inthe editor (true).
Returns
string|bool The article HTML code as string or false on error.
3.3.3.3 renderArticles()
renderArticles (
$articles,
$inEditor )
Generated by Doxygen
24 Data Structure Documentation
Process all articles in the specified array, renders each article and assigns the rendered data as article field "html".If a single article cannot be rendered, an empty string is assigned for this article's html data.
Generated by Doxygen
3.4 ArticleLink Class Reference 25
Parameters
array $articles The array with the articles to render.
bool $inEditor The flag that specifies if the content element is rendered for use in the web site (false) or inthe editor (true).
Returns
array The array with all articles with the rendered data.
3.3.4 Field Documentation
3.3.4.1 $contentElementRenderer
Felira Renderer ContentElement $contentElementRenderer = null [private]
The content element renderer, used to render the content elements within an article.
3.4 ArticleLink Class Reference
The content element for an article link.
Inheritance diagram for ArticleLink:
ArticleLink
ContentElement
Module
Public Member Functions
• __construct ()• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Generated by Doxygen
26 Data Structure Documentation
Additional Inherited Members
3.4.1 Detailed Description
The content element for an article link.
Copyright
Copyright © Miscalis ®
3.4.2 Constructor & Destructor Documentation
3.4.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.4.3 Member Function Documentation
3.4.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.4.3.2 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Generated by Doxygen
3.5 BackEnd Class Reference 27
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
3.5 BackEnd Class Reference
The back-end renderer for the Felira system.
Inheritance diagram for BackEnd:
BackEnd
Renderer
Public Member Functions
• __construct ()• render ($template)
Additional Inherited Members
3.5.1 Detailed Description
The back-end renderer for the Felira system.
. It is used to render all back-end pages.
Copyright
Copyright © Miscalis ®
3.5.2 Constructor & Destructor Documentation
Generated by Doxygen
28 Data Structure Documentation
3.5.2.1 __construct()
__construct ( )
Creates a new instance of the Felira back-end page renderer.
Reimplemented from Renderer.
3.5.3 Member Function Documentation
3.5.3.1 render()
render (
$template )
Renders the back-end page and returns the result as string.
Parameters
string $template The file name (relative to the "templates" folder) of the back-end page template.
Returns
string|bool The page data as string or false on error.
3.6 BackEnd Class Reference
The back-end response object of the Felira system.
Inheritance diagram for BackEnd:
BackEnd
Response
Public Member Functions
• __construct ()• setTitle ($title)• setTitleToken ($title)• addTile (\Felira\Tile $tile)• addVariable ($name, $value)• setTemplate ($template)
Generated by Doxygen
3.6 BackEnd Class Reference 29
• setRequestInfo ($module, $action, $object)• addJsFile ($fileUrl, $position='top', $async=false)• addCssFile ($fileUrl, $position='top')• getJsFiles ()• getCssFiles ()• getModule ()• getAction ()• getObject ()• addBreadcrumb ($title, $link=null)
Protected Member Functions
• getResponseData ()
Protected Attributes
• $title = ''• $template = null• $tiles = array()• $variables = array()• $module = null• $action = null• $object = null• $jsFiles = array()• $cssFiles = array()• $breadcrumbs = array()
3.6.1 Detailed Description
The back-end response object of the Felira system.
It is used deliver a back-end page to the client.
Copyright
Copyright © Miscalis ®
3.6.2 Constructor & Destructor Documentation
3.6.2.1 __construct()
__construct ( )
Creates a new instance of a back-end response.
Generated by Doxygen
30 Data Structure Documentation
3.6.3 Member Function Documentation
3.6.3.1 addBreadcrumb()
addBreadcrumb (
$title,
$link = null )
Adds a new stage to the breadcrumb for the back-end page.
Generated by Doxygen
3.6 BackEnd Class Reference 31
Parameters
string $title The title for the breadcrumb.
string $link The link for the breadcrumb (optional, none by default)
3.6.3.2 addCssFile()
addCssFile (
$fileUrl,
$position = 'top' )
Adds a new CSS file to include on the page.
Parameters
string $fileUrl The full URL of the file to include.
string $position The position where to include the file (top or bottom, top by default).
3.6.3.3 addJsFile()
addJsFile (
$fileUrl,
$position = 'top',
$async = false )
Adds a new JavaScript file to include on the page.
Parameters
string $fileUrl The full URL of the file to include.
string $position The position where to include the file (top or bottom, top by default).
bool $async The flag that specifies if the script should be loaded asynchronous (true) or not (false,default).
3.6.3.4 addTile()
addTile (
\Felira\Tile $tile )
Adds a back-end tile.
Generated by Doxygen
32 Data Structure Documentation
Parameters
\Felira\Tile $tile The tile to add.
3.6.3.5 addVariable()
addVariable (
$name,
$value )
Adds a template variable. This is a variable that is passed to the template.
Parameters
string $name The name of the variable.
object $value The value of the variable.
3.6.3.6 getAction()
getAction ( )
Returns the action that created the response.
Returns
string|null The action as string or null if none.
3.6.3.7 getCssFiles()
getCssFiles ( )
Returns the css files of the response.
Returns
array An array with the css files.
Generated by Doxygen
3.6 BackEnd Class Reference 33
3.6.3.8 getJsFiles()
getJsFiles ( )
Returns the js files of the response.
Returns
array An array with the JavaScript files.
3.6.3.9 getModule()
getModule ( )
Returns the module that created the response.
Returns
string|null The module as string or null if none.
3.6.3.10 getObject()
getObject ( )
Returns the object that created the response.
Returns
string|int|null The object or null if none.
3.6.3.11 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
3.6.3.12 setRequestInfo()
setRequestInfo (
$module,
$action,
$object )
Sets the request information (for use in the template and displaying the active menu item). Each value is only set, ifnot yet done.
Generated by Doxygen
34 Data Structure Documentation
Parameters
string $module The module name.
string $action The action name
string | int $object The object.
3.6.3.13 setTemplate()
setTemplate (
$template )
Sets the template file name for the back-end page. The file name is relative to the "templates" folder in either the"assets" or the "mypage" folder.
Parameters
string $template The template file name as string.
3.6.3.14 setTitle()
setTitle (
$title )
Sets the title of the page. This value is not translated.
Parameters
string $title The title as string.
3.6.3.15 setTitleToken()
setTitleToken (
$title )
Sets the title of the page from a translation token.
Parameters
string $title The translation token of the title as string.
Generated by Doxygen
3.6 BackEnd Class Reference 35
3.6.4 Field Documentation
3.6.4.1 $action
string $action = null [protected]
The action that produced the response.
3.6.4.2 $breadcrumbs
$breadcrumbs = array() [protected]
The array with the breadcrumbs.
3.6.4.3 $cssFiles
$cssFiles = array() [protected]
The array with the css files to include on the page.
3.6.4.4 $jsFiles
$jsFiles = array() [protected]
The array with the js files to include on the page.
3.6.4.5 $module
string $module = null [protected]
The module that created the response.
3.6.4.6 $object
$object = null [protected]
The object that produced the response.
3.6.4.7 $template
string $template = null [protected]
The template file name (relative to the "templates" folder in either the "assets" or the "mypage" folder). May be nullif no page template should be used.
Generated by Doxygen
36 Data Structure Documentation
3.6.4.8 $tiles
$tiles = array() [protected]
The array with the tiles for the back-end page.
3.6.4.9 $title
string $title = '' [protected]
The title of the back-end page. This is the text after the "Felira® - " prefix.
3.6.4.10 $variables
$variables = array() [protected]
The array with the key-value pairs of the template variables.
3.7 BackEnd Class Reference
The back-end class of the Felira system.
Public Member Functions
• process ()
3.7.1 Detailed Description
The back-end class of the Felira system.
It provides the processing for the Felira back-end.
Copyright
Copyright © Miscalis ®
3.7.2 Member Function Documentation
Generated by Doxygen
3.8 BackEndMenu Class Reference 37
3.7.2.1 process()
process ( )
Processes a back-end request and uses the available manager classes to fulfill the request.
Returns
string The data to deliver to the client (as string).
3.8 BackEndMenu Class Reference
The main menu of the Felira back-end.
Public Member Functions
• __construct ()• addTopMenu ($name, $pos='left', $module=null, $action=null, $toFront=false)• createBackEndMenuItems ($module, $action)• sortMenuArray ($a, $b)
Private Member Functions
• isMenuItemVisible ($permissions, $module, $action)
Private Attributes
• $menu = array()
3.8.1 Detailed Description
The main menu of the Felira back-end.
The Felira main menu is used to create the menu items for the main menu in the back-end.
Copyright
Copyright © Miscalis ®
3.8.2 Constructor & Destructor Documentation
Generated by Doxygen
38 Data Structure Documentation
3.8.2.1 __construct()
__construct ( )
Creates a new back-end menu.
3.8.3 Member Function Documentation
3.8.3.1 addTopMenu()
addTopMenu (
$name,
$pos = 'left',
$module = null,
$action = null,
$toFront = false )
Adds a new top menu item.
Parameters
string $name The name of the menu item (translation token).
string $pos The position of the top menu item ('left' or 'right').
string $module The module to perform the action on (optional, no sub-items are created if set).
string $action The action to perform (optional, no sub-items are created if set).
bool $toFront true to add the menu item to the front of the menu, false (default) otherwise.
3.8.3.2 createBackEndMenuItems()
createBackEndMenuItems (
$module,
$action )
Creates all menu items for the back-end.
Parameters
string $module The current module (used to identify the active menu item, may be null).
string $action The current action (used to identify the active menu item, may be null).
Returns
array The array with the menu items of all managers.
Generated by Doxygen
3.8 BackEndMenu Class Reference 39
3.8.3.3 isMenuItemVisible()
isMenuItemVisible (
$permissions,
$module,
$action ) [private]
Checks if the menu items for the specified module should be visible.
Parameters
array $permissions The array with the user permissions.
string $module The module to check.
string $action The action to check.
Returns
bool true if the menu item should be visible, false otherwise.
3.8.3.4 sortMenuArray()
sortMenuArray (
$a,
$b )
Sorts an array of menu items by the menu item index.
Parameters
array $a The first item to compare.
array $b The second item to compare.
Returns
< 0 if the first item should appear before the second, > 0 if the first item should appear after the second, 0 ifthe items are equal.
3.8.4 Field Documentation
3.8.4.1 $menu
$menu = array() [private]
The structure for the menu data.
Generated by Doxygen
40 Data Structure Documentation
3.9 Binary Class Reference
The binary response object of the Felira system.
Inheritance diagram for Binary:
Binary
Response
Public Member Functions
• __construct ()• setBinaryData ($data)
Protected Member Functions
• getResponseData ()
Private Attributes
• $data = ''
Additional Inherited Members
3.9.1 Detailed Description
The binary response object of the Felira system.
It is used deliver any binary data to the client.
Copyright
Copyright © Miscalis ®
3.9.2 Constructor & Destructor Documentation
3.9.2.1 __construct()
__construct ( )
Creates a new instance of a binary response.
Generated by Doxygen
3.10 BrowserDetector Class Reference 41
3.9.3 Member Function Documentation
3.9.3.1 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
3.9.3.2 setBinaryData()
setBinaryData (
$data )
Sets the binary data.
Parameters
string $data The data to send to the client.
3.9.4 Field Documentation
3.9.4.1 $data
string $data = '' [private]
The (binary) data.
3.10 BrowserDetector Class Reference
The Felira browser detector.
Generated by Doxygen
42 Data Structure Documentation
Public Member Functions
• __construct ()• getBrowserInformation ()
Private Member Functions
• extractBrowserInformation ()• extractVersionNumber ($string, $token, $offset)
Private Attributes
• $browserInformation = array()
3.10.1 Detailed Description
The Felira browser detector.
The Felira browser detector can be used to extract the browser information from the HTTP request.
Copyright
Copyright © Miscalis ®
3.10.2 Constructor & Destructor Documentation
3.10.2.1 __construct()
__construct ( )
Creates a new instance of the Felira browser detector.
3.10.3 Member Function Documentation
3.10.3.1 extractBrowserInformation()
extractBrowserInformation ( ) [private]
Extracts the browser information from the request header and stores it in an internal array.
3.10.3.2 extractVersionNumber()
extractVersionNumber (
$string,
$token,
$offset ) [private]
Extracts a version number in the format x.y from the specified string. The version numbers as well as the combinedversion string are stored in the browser information array.
Generated by Doxygen
3.11 Category Class Reference 43
Parameters
string $string The string to extract the version number from.
string $token The token to find the version number near.
int $offset The offset to add to the token position.
Returns
bool true on success, false otherwise.
3.10.3.3 getBrowserInformation()
getBrowserInformation ( )
Returns the browser information as array.
Returns
array The browser information as array.
3.10.4 Field Documentation
3.10.4.1 $browserInformation
$browserInformation = array() [private]
The array that holds the browser information.
3.11 Category Class Reference
The category manager of the Felira system.
Inheritance diagram for Category:
Category
DataObject
Module
Generated by Doxygen
44 Data Structure Documentation
Public Member Functions• __construct ()• processBackEndRequest ($action, $object)• getCategories ()• getCategoriesWithArticleCount ()• getMainPageCategory ()• getCategoryById ($categoryId)• getCategoryByAlias ($categoryAlias)• getCategoryByArticleAlias ($alias)• getCategoryNameOptions ()• getCategoryTypeOptions ()• sortCategory ($source, $target)• deleteCategory ($id)• verboseCategoryType ($type)
Protected Member Functions• getObjectDefinition ()
Private Member Functions• createEditView ($action, $id)
Additional Inherited Members
3.11.1 Detailed Description
The category manager of the Felira system.
It is used to provide access to and manage all categories (of all types) in the system.
Copyright
Copyright © Miscalis ®
3.11.2 Constructor & Destructor Documentation
3.11.2.1 __construct()
__construct ( )
Creates a new instance of the Felira category manager.
3.11.3 Member Function Documentation
3.11.3.1 createEditView()
createEditView (
$action,
$id ) [private]
Creates the category editor view and returns a back-end response for it.
Generated by Doxygen
3.11 Category Class Reference 45
Parameters
string $action The action ("edit" or "new").
int $id The database id of the category to edit (or 0 for new categories).
Returns
Felira::Response|bool A response object or false on error.
3.11.3.2 deleteCategory()
deleteCategory (
$id )
Deletes the specified category.
Parameters
int $id The database id of the category to delete.
Returns
bool true if the operation was successful, false otherwise.
3.11.3.3 getCategories()
getCategories ( )
Reads all categories from the database, sorted by their sort order.
Returns
array The array of categories on success, an empty array otherwise.
3.11.3.4 getCategoriesWithArticleCount()
getCategoriesWithArticleCount ( )
Reads all categories from the database, sorted by their sort order, with the number of article in this category.
Returns
array The array of categories on success, an empty array otherwise.
Generated by Doxygen
46 Data Structure Documentation
3.11.3.5 getCategoryByAlias()
getCategoryByAlias (
$categoryAlias )
Returns the specified category.
Parameters
string $categoryAlias The alias of the category to return.
Returns
array|null The specified category or null if the category is not found.
3.11.3.6 getCategoryByArticleAlias()
getCategoryByArticleAlias (
$alias )
Returns the category the article with the specified (SEO) alias belongs to, if the category is of type "single-pager"or "website".
Parameters
string $alias The alias of the category to return.
Returns
array|null The specified category or null if the category is not found.
3.11.3.7 getCategoryById()
getCategoryById (
$categoryId )
Returns the specified category.
Parameters
int $category←↩
IdThe database id of the category to return.
Generated by Doxygen
3.11 Category Class Reference 47
Returns
array|null The specified category or null if the category is not found.
3.11.3.8 getCategoryNameOptions()
getCategoryNameOptions ( )
Returns a list of all categories in the format that is used to create combo box options lists.
Returns
array The array with the list of category names.
3.11.3.9 getCategoryTypeOptions()
getCategoryTypeOptions ( )
Returns a list of all category types in the format that is used to create combo box options lists.
Returns
array The array with the list of category types.
3.11.3.10 getMainPageCategory()
getMainPageCategory ( )
Returns the first category of the type "single-pager web site" or "normal web site" that is active.
Returns
array|null The first category for the main page or null if no category is found.
3.11.3.11 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.11.3.12 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Category section.
Generated by Doxygen
48 Data Structure Documentation
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.11.3.13 sortCategory()
sortCategory (
$source,
$target )
Moves the source category to the target category (sort order) and increments the sort order of all other categories.
Parameters
int $source The database id of the source category.
int $target The database id of the target category.
Returns
bool true if the operation was successful, false otherwise.
3.11.3.14 verboseCategoryType()
verboseCategoryType (
$type )
Verboses the category type, i.e. returns the translation token.
Parameters
int $type The category type.
Returns
string A string with the translation token for the category type.
Generated by Doxygen
3.12 ClassLoader Class Reference 49
3.12 ClassLoader Class Reference
The class loader of the Felira system.
Public Member Functions
• __construct ()• loadClass ($class)• addIncludePath ($path)
3.12.1 Detailed Description
The class loader of the Felira system.
The class loader is used to dynamically load all used classes. It is therefore registered as system class loader withthe Standard PHP Library (via spl_autoload_register). New classes can then be created by using the new operatorwithout including the php file that contains the class.
Copyright
Copyright © Miscalis ®
3.12.2 Constructor & Destructor Documentation
3.12.2.1 __construct()
__construct ( )
Creates a new instance of the Felira class loader.
3.12.3 Member Function Documentation
3.12.3.1 addIncludePath()
addIncludePath (
$path )
Adds a new include path to the class loader.
Generated by Doxygen
50 Data Structure Documentation
Parameters
string $path The include path to add.
3.12.3.2 loadClass()
loadClass (
$class )
Loads the class file for the specified class name.
Parameters
string $class The class name to load the .php file for.
3.13 Module\ContactForm Class Reference
The contact form module of the Felira system. It is used to process the data of a contact form that was submittedfrom the front-end (via Ajax).
Inheritance diagram for Module\ContactForm:
ModuleContactForm
Module
Public Member Functions
• __construct ()• processFrontEndAjaxRequest ($action, $object)
Additional Inherited Members
3.13.1 Detailed Description
The contact form module of the Felira system. It is used to process the data of a contact form that was submittedfrom the front-end (via Ajax).
Copyright
Copyright © Miscalis ®
Generated by Doxygen
3.14 ContentElement Class Reference 51
3.13.2 Constructor & Destructor Documentation
3.13.2.1 __construct()
__construct ( )
Creates a new instance of the Felira contact form manager.
3.13.3 Member Function Documentation
3.13.3.1 processFrontEndAjaxRequest()
processFrontEndAjaxRequest (
$action,
$object )
Evaluates the data fields from the contact form and sends a mail to the user specified in the settings.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null A Felira::Response object on success, null if the request was not processed,false if there was an error.
Reimplemented from Module.
3.14 ContentElement Class Reference
The content element renderer of the Felira system.
Public Member Functions
• __construct (\Felira\Renderer $renderer)• renderContentElement ($contentElement, $inEditor)• afterRender (\Felira\Response $response)
Generated by Doxygen
52 Data Structure Documentation
Private Attributes
• $renderer = null
3.14.1 Detailed Description
The content element renderer of the Felira system.
It is used to render content elements data of content elements within articles that are part of a page.
Copyright
Copyright © Miscalis ®
3.14.2 Constructor & Destructor Documentation
3.14.2.1 __construct()
__construct (
\Felira\Renderer $renderer )
Creates a new instance of the Felira content element renderer.
Parameters
\Felira\Renderer $renderer The renderer used to renderer the page.
3.14.3 Member Function Documentation
3.14.3.1 afterRender()
afterRender (
\Felira\Response $response )
The function that is called after rendering the articles. It invokes the after-render callback on the content elements.
Parameters
\Felira\Response $response The response object.
Generated by Doxygen
3.15 ContentElement Class Reference 53
3.14.3.2 renderContentElement()
renderContentElement (
$contentElement,
$inEditor )
Renders the content element and returns the resulting HTML code as string.
Parameters
array $contentElement The content element object to render.
bool $inEditor The flag that specifies if the content element is rendered for use in the web site(false) or in the editor (true).
Returns
string|bool The content element data as string or false on error.
3.14.4 Field Documentation
3.14.4.1 $renderer
Felira Renderer $renderer = null [private]
The renderer (front-end, back-end or setup).
3.15 ContentElement Class Reference
The content element manager of the Felira system.
Inheritance diagram for ContentElement:
ContentElement
DataObject
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• loadContentElementAssignments ($templateId, $useElementCache)• deleteContentElement ($id)
Generated by Doxygen
54 Data Structure Documentation
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• saveContentElements ()
Static Private Attributes
• static $contentElementCache = array()
Additional Inherited Members
3.15.1 Detailed Description
The content element manager of the Felira system.
It is used to manage the content element types and all content elements that are assigned to a template.
Copyright
Copyright © Miscalis ®
3.15.2 Constructor & Destructor Documentation
3.15.2.1 __construct()
__construct ( )
Creates a new instance of the Felira content element manager.
3.15.3 Member Function Documentation
3.15.3.1 deleteContentElement()
deleteContentElement (
$id )
Deletes the specified content element and all assigned data.
Generated by Doxygen
3.15 ContentElement Class Reference 55
Parameters
int $id The database id of the content element to delete.
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The id of the template whose content element should be deleted or 0 if the template was not found.
3.15.3.2 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.15.3.3 loadContentElementAssignments()
loadContentElementAssignments (
$templateId,
$useElementCache )
Reads the content elements assignments of a specified template from the database.
Parameters
int $templateId The database id of the template to read the content elements for.
bool $useElementCache true to use the internal cache for the content elements, false otherwise.
Returns
array The array of content elements on success, an empty array otherwise.
3.15.3.4 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Generated by Doxygen
56 Data Structure Documentation
Processes a request in the Content Element section.
Generated by Doxygen
3.15 ContentElement Class Reference 57
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.15.3.5 saveContentElements()
saveContentElements ( ) [private]
Saves the content element data for all content elements in a single template from the data specified in the request.
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The id of the template whose content elements were to be saved.
3.15.4 Field Documentation
3.15.4.1 $contentElementCache
$contentElementCache = array() [static], [private]
The array that holds the internal content element cache.
Generated by Doxygen
58 Data Structure Documentation
3.16 ContentElement Class Reference
The base class for a Felira content elements.
Inheritance diagram for ContentElement:
ContentElement
Module
ArticleLink
GoogleMaps
HtmlText
Image
Link
SimpleSlider
SimpleText
Video
Public Member Functions
• __construct ($moduleName, $moduleNameToken)• render (\Felira\Renderer $renderer, $contentElement, $inEditor)• getNameToken ()• countUse ()• onAfterRender (\Felira\Response $response)• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Protected Attributes
• $usageCount = 0
Private Attributes
• $nameToken = null
Generated by Doxygen
3.16 ContentElement Class Reference 59
Additional Inherited Members
3.16.1 Detailed Description
The base class for a Felira content elements.
All content elements must be derived from this class.
Copyright
Copyright © Miscalis ®
3.16.2 Constructor & Destructor Documentation
3.16.2.1 __construct()
__construct (
$moduleName,
$moduleNameToken )
Creates a new instance of a Felira content element.
Parameters
string $moduleName The internal name of the module (used as type name for the content element).
string $moduleNameToken The translation token of the name of the module as displayed to the user.
3.16.3 Member Function Documentation
3.16.3.1 countUse()
countUse ( )
Counts the use of the content element.
3.16.3.2 getNameToken()
getNameToken ( )
Returns the translation token of the name of the plug-in.
Returns
string The translation token of the name of the plug-in.
Generated by Doxygen
60 Data Structure Documentation
3.16.3.3 getUsedFields()
getUsedFields ( ) [abstract]
Returns the field names of the content data fields that are used by this content element.
Returns
array|null An array with the field names or null on error.
Reimplemented in SimpleSlider, Video, ArticleLink, GoogleMaps, Image, Link, HtmlText, and SimpleText.
3.16.3.4 onAfterRender()
onAfterRender (
\Felira\Response $response )
The after-render handler. This handler is invoked once, after all instances of a content element have been rendered.It is invoked even if the content element was not rendered on the page. It can be used to load element-specific css/jsfiles etc.
Parameters
\Felira\Response $response The response object.
Reimplemented in SimpleSlider, and GoogleMaps.
3.16.3.5 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [abstract], [protected]
The internal content element template preparation function that a derived content element must implement. It isused to prepare the template and the variables for rendering.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Generated by Doxygen
3.16 ContentElement Class Reference 61
Returns
bool true on success, false on error.
Reimplemented in ArticleLink, GoogleMaps, HtmlText, Image, Link, SimpleSlider, SimpleText, and Video.
3.16.3.6 render()
render (
\Felira\Renderer $renderer,
$contentElement,
$inEditor )
Renders the content element and returns the HTML code as string.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The content element object to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
string|bool A string that contains the rendered template or false on error.
3.16.4 Field Documentation
3.16.4.1 $nameToken
$nameToken = null [private]
The translation token of the name of the plugin that can be displayed to the user.
3.16.4.2 $usageCount
$usageCount = 0 [protected]
The usage count for the content element. Every time the element is used on the page (i.e. the element is rendered)the counter is incremented.
Generated by Doxygen
62 Data Structure Documentation
3.17 Module\Dashboard Class Reference
The Dashboard of the Felira system. It is used in the back-end to provide information to the user on the dashboard.
Inheritance diagram for Module\Dashboard:
ModuleDashboard
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)
Additional Inherited Members
3.17.1 Detailed Description
The Dashboard of the Felira system. It is used in the back-end to provide information to the user on the dashboard.
Copyright
Copyright © Miscalis ®
3.17.2 Constructor & Destructor Documentation
3.17.2.1 __construct()
__construct ( )
Creates a new instance of the Felira Dashboard.
3.17.3 Member Function Documentation
3.17.3.1 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Dashboard section.
Generated by Doxygen
3.18 Database Class Reference 63
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.18 Database Class Reference
The Felira database (connection) class.
Public Member Functions
• __construct ($databaseSettings)• __destruct ()• connect ()• disconnect ()• getDatabaseType ()• escapeColumn ($column)• listDatabases ()• listTables ()• listColumns ($table)• listConstraints ($table)• executeCommand ($command, array $param=array())• executeCommandExtendedParam ($command, array $param=array())• executeQuery ($query, array $param=null)• getLastInsertId ()• transactionStart ()• transactionCommit ()• transactionRollBack ()• isConnected ()
Private Member Functions
• logQuery ($text, $args=null)
Private Attributes
• $handle = false• $connector = null• $isConnected = false
Generated by Doxygen
64 Data Structure Documentation
3.18.1 Detailed Description
The Felira database (connection) class.
It is used to access the database that contains the data for the Felira system. It uses the PHP Data Objects (PDO)database extension for all database access, using the credentials from the felira.config.php file. The specifiedcharacter set is used to create the database connection.
Copyright
Copyright © Miscalis ®
3.18.2 Constructor & Destructor Documentation
3.18.2.1 __construct()
__construct (
$databaseSettings )
Creates a new instance of the Felira database connection. The actual connection to the database is not yet estab-lished, the connect() function must be called to establish the connection to the database server.
Parameters
array $databaseSettings The settings to connect to the database. An array with the following fields:
1. "connector": The connector used to connect to the database. Must be oneof the database type names supported by PDO.
2. "server": The server name or IP address of the database server.
3. "database": The database name.
4. "username": The user name used to connect to the database.
5. "password": The password used to connect to the database.
6. "charset": The character set used for the database connection.
3.18.2.2 __destruct()
__destruct ( )
Generated by Doxygen
3.18 Database Class Reference 65
Closes the database connection if open.
3.18.3 Member Function Documentation
3.18.3.1 connect()
connect ( )
Tries to establish a connection to a database. Error messages are written to the event log.
Returns
true on success, false otherwise.
3.18.3.2 disconnect()
disconnect ( )
Closes the database connection.
3.18.3.3 escapeColumn()
escapeColumn (
$column )
Escapes the specified column.
Parameters
string $column The column name.
Returns
string A string with the escaped column name.
3.18.3.4 executeCommand()
executeCommand (
$command,
array $param = array() )
Generated by Doxygen
66 Data Structure Documentation
Executes a database command that does not expect a result set, typically an INSERT or UPDATE statement.Every entry in the parameter array must have a corresponding placeholder in the query string and vice versa. Thedatabase connection must be opened by calling the Connect() function.
Parameters
string $command The SQL command string.
array $param An array with the query parameters (optional, only if the statement contains placeholders).
Exceptions
Exception if an error occured.
3.18.3.5 executeCommandExtendedParam()
executeCommandExtendedParam (
$command,
array $param = array() )
Executes a database command that does not expect a result set, typically an INSERT or UPDATE statement.Every entry in the parameter array must have a corresponding placeholder in the query string and vice versa. Theparameter array contains the values and the type of the parameter (as sub-array with value and type). The databaseconnection must be opened by calling the Connect() function.
Parameters
string $command The SQL command string.
array $param An array with the query parameters (optional, only if the statement containsplaceholders) in the following format:
1. "type": The parameter type.
2. "value": The value to user.
3. "size": The size of the data (optional).
Exceptions
Exception if an error occured.
3.18.3.6 executeQuery()
executeQuery (
Generated by Doxygen
3.18 Database Class Reference 67
$query,
array $param = null )
Executes a prepared query that expects a result set, typically a SELECT. Every entry in the parameter array musthave a corresponding placeholder in the query string and vice versa. If a result set is produced, the entire resultset is read and returned as associative array. The database connection must be opened by calling the Connect()function.
Parameters
string $query The query string.
array $param An array with the query parameters (optional, if no parameters are specified an unpreparedquery is used).
Returns
array|null The result array or null on error.
3.18.3.7 getDatabaseType()
getDatabaseType ( )
Returns the database type, i.e. the PDO connector.
Returns
string The database type as string or an empty string if none.
3.18.3.8 getLastInsertId()
getLastInsertId ( )
Returns the last id that was created after an INSERT statement. The database connection must be opened bycalling the Connect() function.
Returns
int The last id that was created after an INSERT statement or false on failure.
Generated by Doxygen
68 Data Structure Documentation
3.18.3.9 isConnected()
isConnected ( )
Checks if the database connection is active.
Returns
true if connected, false otherwise.
3.18.3.10 listColumns()
listColumns (
$table )
Returns a list of all columns for the specified table.
Generated by Doxygen
3.18 Database Class Reference 69
Parameters
string $table The table to list the columns for.
Returns
array|bool An array with the column data or false on error.
3.18.3.11 listConstraints()
listConstraints (
$table )
Returns a list of all constraints for the specified table.
Parameters
string $table The table to list the constraints for.
Returns
array|bool An array with the constraints data or false on error.
3.18.3.12 listDatabases()
listDatabases ( )
Reads all databases from the specified database server. This function is used in the Felira setup to allow theselection of a previously created database.
Returns
array|bool An array with the list of databases or false on failure.
3.18.3.13 listTables()
listTables ( )
Returns a list of all tables in the current database.
Returns
array|bool An array with a list of tables or false on error.
Generated by Doxygen
70 Data Structure Documentation
3.18.3.14 logQuery()
logQuery (
$text,
$args = null ) [private]
Writes the specified query to the event log.
Parameters
string $text The query text. Every question mark (?) is replaced by the corresponding entry in theargument array.
array $args An array with arguments that are inserted into the query string.
3.18.3.15 transactionCommit()
transactionCommit ( )
Commits a transaction for this database connection.
Returns
true on success, false otherwise.
3.18.3.16 transactionRollBack()
transactionRollBack ( )
Rolls back a transaction for this database connection.
Returns
true on success, false otherwise.
3.18.3.17 transactionStart()
transactionStart ( )
Starts a new transaction for this database connection.
Returns
true on success, false otherwise.
Generated by Doxygen
3.19 DatabaseManager Class Reference 71
3.18.4 Field Documentation
3.18.4.1 $connector
$connector = null [private]
The database-specific database connector object.
3.18.4.2 $handle
$handle = false [private]
The database connection handle. Contains false if no database connection has been established.
3.18.4.3 $isConnected
$isConnected = false [private]
The flag that specifies if a database connection has been established.
3.19 DatabaseManager Class Reference
The database manager of the Felira system.
Inheritance diagram for DatabaseManager:
DatabaseManager
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getNotifications ()• getQueuedCommands ()• createScript ($commands)• performDatabaseUpdate ($commands)
Generated by Doxygen
72 Data Structure Documentation
Private Member Functions
• checkTables ($managers, &$commands)• checkColumns ($managers, &$commands)• checkConstraints ($managers, &$commands)• getCreateTableStatement ($table, $isRelation)• getDropTableStatement ($table)• getCreateColumnStatement ($table, $column)• getCreateConstraintStatement ($table, $column)• getModifyColumnStatement ($table, $column)• getDropColumnStatement ($table, $column)• getDropConstraintStatement ($table, $constraint)• getColumnDataType ($column, $withSize=true)
Additional Inherited Members
3.19.1 Detailed Description
The database manager of the Felira system.
The database manager is used to create and modify database tables according to the object definitions provided bythe object manager classes.
See also
Felira::Module::DataObject
Copyright
Copyright © Miscalis ®
3.19.2 Constructor & Destructor Documentation
3.19.2.1 __construct()
__construct ( )
Creates a new instance of the Felira database manager.
3.19.3 Member Function Documentation
3.19.3.1 checkColumns()
checkColumns (
$managers,
& $commands ) [private]
Checks the table columns that are managed by the each manager in the specified manager list and creates "ALTERTABLE" statements, if the columns don't exist or have wrong properties.
Generated by Doxygen
3.19 DatabaseManager Class Reference 73
Parameters
array $managers An array of object managers.
array $commands The array that receives the database statements to be executed.
Returns
bool true on success, false otherwise.
3.19.3.2 checkConstraints()
checkConstraints (
$managers,
& $commands ) [private]
Checks the constraints that are managed by the each manager in the specified manager list and creates "ALTERTABLE" statements, if the constraints don't exist.
Parameters
array $managers An array of object managers.
array $commands The array that receives the database statements to be executed.
Returns
bool true on success, false otherwise.
3.19.3.3 checkTables()
checkTables (
$managers,
& $commands ) [private]
Checks the tables that are managed by the specified manager list and creates "CREATE TABLE" statements, if thetables don't exist.
Parameters
array $managers An array of object managers.
array $commands The array that receives the database statements to be executed.
Returns
bool true on success, false otherwise.
Generated by Doxygen
74 Data Structure Documentation
3.19.3.4 createScript()
createScript (
$commands )
Creates and returns a script file with all queued database commands.
Parameters
array $commands The array of commands as returned from getQueuedCommands().
Returns
string|bool The script as string or false on error.
3.19.3.5 getColumnDataType()
getColumnDataType (
$column,
$withSize = true ) [private]
Returns the database-specific data type of the column.
Parameters
array $column The data of the column. This is an entry of the object manager's field definition array.
bool $withSize true to return the data type with size in brackets, false otherwise.
Returns
string|bool The data type of the column as string or false on error.
3.19.3.6 getCreateColumnStatement()
getCreateColumnStatement (
$table,
$column ) [private]
Creates the "ALTER TABLE ... ADD" statement for creating the specified column.
Generated by Doxygen
3.19 DatabaseManager Class Reference 75
Parameters
string $table The name of the table to create the column in.
array $column The data of the column. This is an entry of the object manager's field definition array.
Returns
string The create command or an error string on error.
3.19.3.7 getCreateConstraintStatement()
getCreateConstraintStatement (
$table,
$column ) [private]
Creates the "ALTER TABLE ... ADD CONSTRAINT" statement for creating the specified constraint.
Parameters
string $table The name of the table to create the constraint in.
array $column The data of the column. This is an entry of the object manager's field definition array.
Returns
string The create command or an error string on error.
3.19.3.8 getCreateTableStatement()
getCreateTableStatement (
$table,
$isRelation ) [private]
Creates the "CREATE TABLE" statement for the specified table name.
Parameters
string $table The name of the table.
bool $isRelation The flag that specified if the table is a relation table.
Returns
string The create command or an error string on error.
Generated by Doxygen
76 Data Structure Documentation
3.19.3.9 getDropColumnStatement()
getDropColumnStatement (
$table,
$column ) [private]
Creates the "ALTER TABLE ... DROP" statement for creating the specified column.
Parameters
string $table The name of the table to create the column in.
array $column The data of the column. This is an entry of the object manager's field definition array.
Returns
string The create command or an error string on error.
3.19.3.10 getDropConstraintStatement()
getDropConstraintStatement (
$table,
$constraint ) [private]
Creates the "ALTER TABLE ... DROP CONSTRAINT" statement for removing the specified constraint.
Parameters
string $table The name of the table to create the column in.
array $constraint The data of the constraint.
Returns
string The create command or an error string on error.
3.19.3.11 getDropTableStatement()
getDropTableStatement (
$table ) [private]
Creates the "DROP TABLE" statement for the specified table name.
Parameters
string $table The name of the table.
Generated by Doxygen
3.19 DatabaseManager Class Reference 77
Returns
string The create command or an error string on error.
3.19.3.12 getModifyColumnStatement()
getModifyColumnStatement (
$table,
$column ) [private]
Creates the "ALTER TABLE ... MODIFY" statement for creating the specified column.
Parameters
string $table The name of the table to create the column in.
array $column The data of the column. This is an entry of the object manager's field definition array.
Returns
string The create command or an error string on error.
3.19.3.13 getNotifications()
getNotifications ( )
Returns a list of notifications (warnings, problems) for this module.
Returns
array The list of notifications as array. Each entry is an array with the following fields:
1. "type": The type of the message (one of the FELIRA_MESSAGE_∗ constants).
2. "token": The translation token of the message to display.
3. "args": An array of options (optional, null by default).
4. "details": Additional information (optional, null by default).
5. "link": The link to a page that can be used to fix the problem (optional, may be false).
6. "link_token": The translation token of the text to display as link (only needed, if the link is valid).
See also
Felira::MessageHandler
Reimplemented from Module.
Generated by Doxygen
78 Data Structure Documentation
3.19.3.14 getQueuedCommands()
getQueuedCommands ( )
Returns an array with SQL statements that need to be executed to make the database compatible to this version ofFelira. These statements are created by evaluating all registered object managers.
Returns
false on error or an array of entries with the following fields:
1. "statement": The statements to be executed. This may be a comment.
2. "comment": The comment that describes the statement.
3. "module": The translated name of the module that owns the table.
3.19.3.15 performDatabaseUpdate()
performDatabaseUpdate (
$commands )
Performs all commands in the array on the current database.
Parameters
array $commands The array of commands as returned from getQueuedCommands().
Returns
bool true on success or false on error.
3.19.3.16 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Database Manager section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Generated by Doxygen
3.20 DataObject Class Reference 79
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.20 DataObject Class Reference
The basic data object class of the Felira system.
Inheritance diagram for DataObject:
DataObject
Module
Article
Category
ContentElement
ElementData
FileStorage
ImageFilter
MailTemplate
RichSnippet
Settings
Template
User
UserEvent
ExportableObject
Public Member Functions
• __construct ($identifier, $table)• getDefinedFields ()• loadObjects ($sql, $params=null)• loadSingleObject ($sql, $params=null)• createNewObject ()• deleteObject ($id, $successText='MESSAGE_DELETE_SUCCESS', $failureText='MESSAGE_DELETE_F←↩
AILED')• saveObject ($successText='MESSAGE_SAVE_SUCCESS', $failureText='MESSAGE_SAVE_FAILED')• performInsert (array $keys, array $values)• performUpdate ($id, array $keys, array $values)• processObjectData (array $objectData)• getTableName ()
Generated by Doxygen
80 Data Structure Documentation
Protected Member Functions
• addFieldDefinition ($name, $type, $size, $required, $editor, $label='', $editText='', $constraint=null, $op-tions=null, $readonly=false)
• hideFieldDefinition ($name)• escapeObjectStrings ($object)• createAlias ($string)• setFieldOptions ($fieldName, $options)• getObjectDefinition ()
Protected Attributes
• $table = null• $fieldDefinitions = array()• $defaultSelect = null
Additional Inherited Members
3.20.1 Detailed Description
The basic data object class of the Felira system.
It is the base class for most Felira objects and provides methods for storing and manipulating object data.
Copyright
Copyright © Miscalis ®
3.20.2 Constructor & Destructor Documentation
3.20.2.1 __construct()
__construct (
$identifier,
$table )
Creates a new instance of the Felira data object manager.
Parameters
string $identifier The identifier of the managed object. It is used to create the menu items, pages andrequest variables. Stored as module name.
string $table The name of the database table that is managed by this data object manager.
Reimplemented in ExportableObject.
Generated by Doxygen
3.20 DataObject Class Reference 81
3.20.3 Member Function Documentation
3.20.3.1 addFieldDefinition()
addFieldDefinition (
$name,
$type,
$size,
$required,
$editor,
$label = '',
$editText = '',
$constraint = null,
$options = null,
$readonly = false ) [protected]
Adds a field definition to the internal object field definition
Parameters
string $name The name of the field in the database.
string $type The data type of the field in the database (one of: "int", "string", "bool", "date","datetime", "longblob", "json").
int $size The size of the field (if type is "string", ignored otherwise).
bool $required true if the field is required, false otherwise. This is used for input validation onlyand does not affect the NULL / NOT NULL database field property.
string $editor The type of editor that is used to edit this field (one of: "identity", "textfield","textarea", "number", "checkbox", "combobox", "filebrowser", "password").
string $label The translation token of the label of the editor for the field.
string $editText The translation token of the placeholder text or description of the edit field (optional,no token by default).
array | null $constraint A database constraint. This is an array with 'table' and 'column' fields of theconstraint target set.
array | null $options An array with selection options, if $editType is "combobox" or "filebrowser".
bool | null $readonly A flag that specifies if the field is read-only. false by default.
3.20.3.2 createAlias()
createAlias (
$string ) [protected]
Creates an alias of a string that can safely be used within an URL.
Parameters
string $string The string to alias.
Generated by Doxygen
82 Data Structure Documentation
Returns
string The alias.
3.20.3.3 createNewObject()
createNewObject ( )
Creates a new object from the internal field definitions.
Returns
array The array with the new (empty) object.
3.20.3.4 deleteObject()
deleteObject (
$id,
$successText = 'MESSAGE_DELETE_SUCCESS',
$failureText = 'MESSAGE_DELETE_FAILED' )
Deletes the specified object.
Parameters
int $id The database id of the object to delete.
string $successText The text message that is issued on success (optional).
string $failureText The text message that is issued on failure (optional).
Returns
array An array with:
1. true if the object was successfully deleted, false otherwise.
2. The id of the object that should be deleted on failure or 0 if the object was deleted.
3.20.3.5 escapeObjectStrings()
escapeObjectStrings (
$object ) [protected]
Escapes all object fields that are string so they can be output to a html form.
Generated by Doxygen
3.20 DataObject Class Reference 83
Parameters
array $object The object to escape.
Returns
array The object with escaped fields.
3.20.3.6 getDefinedFields()
getDefinedFields ( )
Returns the field definitions for the object managed by this manager.
Returns
array An array with the field definitions (may be empty).
3.20.3.7 getObjectDefinition()
getObjectDefinition ( ) [abstract], [protected]
The function must be implemented by all descending classes and add all database fields to the object definition, ifa database table for object storage is used.
Reimplemented in Article, Settings, RichSnippet, FileStorage, Category, ImageFilter, User, Template, MailTemplate,UserEvent, ContentElement, and ElementData.
3.20.3.8 getTableName()
getTableName ( )
Returns the name of the database table that stores the objects.
Returns
string The table name as string.
3.20.3.9 hideFieldDefinition()
hideFieldDefinition (
$name ) [protected]
Hides the specified field from the object editor (in the back-end).
Generated by Doxygen
84 Data Structure Documentation
Parameters
string $name The name of the field in the database.
3.20.3.10 loadObjects()
loadObjects (
$sql,
$params = null )
Loads all objects specified by the SQL statement.
Parameters
string $sql The SQL statement that specifies what to read from the database.
array | null $params An array with the parameters to be mapped to the prepared statement (optional, if noparameters are specified an unprepared query is used).
Returns
array The array with the data rows or an empty array on error.
3.20.3.11 loadSingleObject()
loadSingleObject (
$sql,
$params = null )
Reads and returns the first object of the result set created by the SQL statement.
Parameters
string $sql The SQL statement that specifies what to read from the database.
array | null $params An array with the parameters to be mapped to the prepared statement (optional, if noparameters are specified an unprepared query is used).
Returns
array|null An array with the object data or null on error.
Generated by Doxygen
3.20 DataObject Class Reference 85
3.20.3.12 performInsert()
performInsert (
array $keys,
array $values )
Inserts the specified values as new row into the database.
Parameters
array $keys An array with the keys to insert with the specified values.
array $values An array with the values to insert the keys with.
Returns
array An array with the following fields:
1. true on success, false on error.
2. The id of the row that was inserted.
3.20.3.13 performUpdate()
performUpdate (
$id,
array $keys,
array $values )
Updates the specified values for the specified keys in the row with the specified id in the database.
Parameters
int $id The id of the row to modify.
array $keys An array with the keys to update with the specified values.
array $values An array with the values to update the keys with.
Returns
true on success, false otherwise.
3.20.3.14 processObjectData()
processObjectData (
array $objectData )
Processes the specified object data according to the object field definitions.
Generated by Doxygen
86 Data Structure Documentation
Parameters
array $objectData An array with key-value pairs with the data to be processed and checked against theobject definition.
Returns
array An array with the following fields:
1. true on success, false on error.
2. An array with the keys.
3. An array with values for the keys.
3.20.3.15 saveObject()
saveObject (
$successText = 'MESSAGE_SAVE_SUCCESS',
$failureText = 'MESSAGE_SAVE_FAILED' )
Saves the object from the data specified in the request.
Parameters
string $successText The text message that is issued on success (optional).
string $failureText The text message that is issued on failure (optional).
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The id of the object whose data was to be saved (or 0 if no id was specified).
3.20.3.16 setFieldOptions()
setFieldOptions (
$fieldName,
$options ) [protected]
Set the selectable options for a field with editor type "combobox" or "filebrowser".
Generated by Doxygen
3.21 Module\DistributionManager Class Reference 87
Parameters
string $fieldName The name of the field to set the options for.
array $options The array with the field options.
3.20.4 Field Documentation
3.20.4.1 $defaultSelect
$defaultSelect = null [protected]
The default SQL select statement, used to read default object data. It can be set in derived classes.
3.20.4.2 $fieldDefinitions
$fieldDefinitions = array() [protected]
The database field definitions for the data object (may be empty).
3.20.4.3 $table
$table = null [protected]
The name of the database table that is managed by this data object manager.
3.21 Module\DistributionManager Class Reference
The distribution manager of the Felira system.
Inheritance diagram for Module\DistributionManager:
ModuleDistributionManager
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)
Generated by Doxygen
88 Data Structure Documentation
Private Member Functions
• createDistributionItems ($distributionType)• getDistributionItems ($distributionType)• createDistributionArchive ($distributionType)• checkAddFileToArchive ($file, $items)
Additional Inherited Members
3.21.1 Detailed Description
The distribution manager of the Felira system.
The distribution manager is used to create zip archives with Felira distributions for development, production use orupdates.
Copyright
Copyright © Miscalis ®
3.21.2 Constructor & Destructor Documentation
3.21.2.1 __construct()
__construct ( )
Creates a new instance of the Felira distribution manager.
3.21.3 Member Function Documentation
3.21.3.1 checkAddFileToArchive()
checkAddFileToArchive (
$file,
$items ) [private]
Check if the specified file object should be added to the file.
Parameters
string $file The file object to check.
array $items The list of items to add to the archive.
Generated by Doxygen
3.21 Module\DistributionManager Class Reference 89
Returns
bool true if the file should be added, false otherwise.
3.21.3.2 createDistributionArchive()
createDistributionArchive (
$distributionType ) [private]
Creates a distribution archive, depending on the specified distribution type and the selected options.
Parameters
string $distributionType The distribution type ('update' or 'production').
Returns
array An array with the following fields:
1. A flag that specifies if the creation was successfull (true) or not (false).
2. The file name (no path!) of the archive file to return on success, null otherwise.
3. The binary data of the archive file on success, null otherwise.
3.21.3.3 createDistributionItems()
createDistributionItems (
$distributionType ) [private]
Creates an array of selectable options for the creation of a distribution archive.
Parameters
string $distributionType The distribution type.
Returns
array The array with the items or an empty array on error.
Generated by Doxygen
90 Data Structure Documentation
3.21.3.4 getDistributionItems()
getDistributionItems (
$distributionType ) [private]
Creates an array of selectable options for the creation of a distribution archive.
Parameters
string $distributionType The distribution type.
Returns
array The array with the items or an empty array on error.
3.21.3.5 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Distribution Tool section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.22 ElementData Class Reference
The element data manager of the Felira system.
Inheritance diagram for ElementData:
ElementData
DataObject
Module
Generated by Doxygen
3.22 ElementData Class Reference 91
Public Member Functions
• __construct ()• loadOrCreateElementData ($articleId, $contentElementId, &$elementData)• getElementsForArticle ($articleId)• getAllElementsWithImages ()• duplicateElements ($fromArticle, $toArticle)• processBackEndRequest ($action, $object)
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• saveMultipleElementData ()• saveElementData ($id, $useIdForVariableName)• processElementField ($type, $value)
Additional Inherited Members
3.22.1 Detailed Description
The element data manager of the Felira system.
It is used to manage the content data of article / content element combinations, i. e. the actual data of a contentelement within an article.
Copyright
Copyright © Miscalis ®
3.22.2 Constructor & Destructor Documentation
3.22.2.1 __construct()
__construct ( )
Creates a new instance of the Felira element data manager.
3.22.3 Member Function Documentation
3.22.3.1 duplicateElements()
duplicateElements (
$fromArticle,
$toArticle )
Copies all content element data from one article to another.
Generated by Doxygen
92 Data Structure Documentation
Parameters
int $fromArticle The source article to copy the element data from.
int $toArticle The target article to copy the element data to.
Returns
bool true on success, false otherwise.
3.22.3.2 getAllElementsWithImages()
getAllElementsWithImages ( )
Returns a list of all content element data with images.
Returns
array An array with all assigned content elements with images or an empty array on error.
3.22.3.3 getElementsForArticle()
getElementsForArticle (
$articleId )
Returns a list of content element data that is assigned to the current article.
Parameters
int $article←↩
IdThe database id of the article whose content elements are to be listed.
Returns
array An array with all assigned content elements or an empty array on error.
3.22.3.4 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition (no required fields since single values may be updated via AJAX).
Reimplemented from DataObject.
Generated by Doxygen
3.22 ElementData Class Reference 93
3.22.3.5 loadOrCreateElementData()
loadOrCreateElementData (
$articleId,
$contentElementId,
& $elementData )
Reads the element data of a specified article with a specified template from the database.
Parameters
int $articleId The database id of the article to read the elements data for.
int $content←↩
ElementIdThe database id of the content element to read the elements data for.
array $elementData The array of the element data for the processed article.
Returns
array|bool The array with the element data on success, false otherwise.
3.22.3.6 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Element Data section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.22.3.7 processElementField()
processElementField (
$type,
$value ) [private]
Process the specified value depending on the specified type.
Generated by Doxygen
94 Data Structure Documentation
Parameters
string $type
string | int | bool $value
Returns
string|int|bool The processed value.
3.22.3.8 saveElementData()
saveElementData (
$id,
$useIdForVariableName ) [private]
Saves the data of the element data from the specified POST request.
Parameters
int $id The database id of the content element data item to save.
bool $useIdForVariableName true to append the id to the data item field name (used if multiple contentelements should be saved), false otherwise.
Returns
bool true on success, false otherwise.
3.22.3.9 saveMultipleElementData()
saveMultipleElementData ( ) [private]
Saves the data of multiple content element data items (from the back-end list editor).
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The id of the article whose content element data was to be saved.
Generated by Doxygen
3.23 Environment Class Reference 95
3.23 Environment Class Reference
The environment of the Felira system.
Public Member Functions
• getPHPVersion ()• getMemoryLimit ()• getUploadLimit ()• getPOSTLimit ()• getTotalUploadLimit ()• isModRewriteInstalled ()• isModHeadersInstalled ()• getZendVersion ()• getPHPInterface ()• getPHPIniFile ()• getTempDir ()• getSystemIdentifier ()• getOperatingSystem ()• isWindows ()• getGDVersion ()• getPeakMemoryUsage ()• getDocumentRoot ()• getServerSoftware ()• getMaxScriptInputTime ()• getMaxScriptExecutionTime ()• getSessionCookieLifetime ()• getSessionDataLifetime ()• getSizeInBytes ($size)
Static Public Member Functions
• static get ()
Protected Member Functions
• compareMemory ($value1, $value2)
Private Member Functions
• __construct ()
Static Private Attributes
• static $instance = null
Generated by Doxygen
96 Data Structure Documentation
3.23.1 Detailed Description
The environment of the Felira system.
The Felira environment provides information about the system environment, the PHP version and installed modules.
Copyright
Copyright © Miscalis ®
3.23.2 Constructor & Destructor Documentation
3.23.2.1 __construct()
__construct ( ) [private]
No instance of the class can be created.
3.23.3 Member Function Documentation
3.23.3.1 compareMemory()
compareMemory (
$value1,
$value2 ) [protected]
Compares two PHP-style memory values, considering the K, M and G suffixes.
Parameters
string $value1 The first memory value.
string $value2 The second memory value.
Returns
int -1 if value 1 < value 2, 0 if value 1 = value 2, 1 if value 1 > value 2.
3.23.3.2 get()
static get ( ) [static]
Returns the current environment.
Generated by Doxygen
3.23 Environment Class Reference 97
Returns
Felira::Environment The current environment.
3.23.3.3 getDocumentRoot()
getDocumentRoot ( )
Return the full path to the document root.
Returns
string The full path to the document root.
3.23.3.4 getGDVersion()
getGDVersion ( )
Returns the version of the installed GD library or 'n/a', if GD is not installed.
Returns
string The GD version as string.
3.23.3.5 getMaxScriptExecutionTime()
getMaxScriptExecutionTime ( )
The maximum execution time of a script, as configured in the php.ini file.
Returns
string The maximum execution time.
3.23.3.6 getMaxScriptInputTime()
getMaxScriptInputTime ( )
The maximum input time of a script, as configured in the php.ini file.
Returns
string The maximum input time.
Generated by Doxygen
98 Data Structure Documentation
3.23.3.7 getMemoryLimit()
getMemoryLimit ( )
Returns the memory limit, as configured in the php.ini file.
Returns
string The memory limit.
3.23.3.8 getOperatingSystem()
getOperatingSystem ( )
Returns the operating system PHP is running on.
Returns
string The name of the operating system.
3.23.3.9 getPeakMemoryUsage()
getPeakMemoryUsage ( )
Returns the peak memory usage in bytes.
Returns
number The peak memory usage.
3.23.3.10 getPHPIniFile()
getPHPIniFile ( )
Returns the loaded PHP ini file name as string.
Returns
string The PHP ini file name.
Generated by Doxygen
3.23 Environment Class Reference 99
3.23.3.11 getPHPInterface()
getPHPInterface ( )
Returns the PHP interface as string.
Returns
string The PHP interface.
3.23.3.12 getPHPVersion()
getPHPVersion ( )
Returns the current PHP version as string.
Returns
string The current PHP version.
3.23.3.13 getPOSTLimit()
getPOSTLimit ( )
Returns the memory limit for POST requests (POST size limit), as configured in the php.ini file.
Returns
string The memory limit for POST requests.
3.23.3.14 getServerSoftware()
getServerSoftware ( )
Returns the server software identification string. This is the value of $_SERVER['SERVER_SOFTWARE'].
Returns
string The server software identification string.
Generated by Doxygen
100 Data Structure Documentation
3.23.3.15 getSessionCookieLifetime()
getSessionCookieLifetime ( )
The lifetime of session cookies, as configured in the php.ini file.
Returns
string The session cookie lifetime.
3.23.3.16 getSessionDataLifetime()
getSessionDataLifetime ( )
The lifetime of session (data), as configured in the php.ini file. This is the minimum time period before the garbagecollector may run and clean up session data.
Returns
string The session (data) lifetime.
3.23.3.17 getSizeInBytes()
getSizeInBytes (
$size )
Returns the value of the specified memory in bytes.
Parameters
string $size The size as string (with possible suffix K, M, G).
Returns
int The value as integer in bytes.
3.23.3.18 getSystemIdentifier()
getSystemIdentifier ( )
Returns the system identifier of the current system. This is value that is returned by a call to "uname".
Returns
string The system identifier of the current system.
Generated by Doxygen
3.23 Environment Class Reference 101
3.23.3.19 getTempDir()
getTempDir ( )
Returns the directory for temporary files.
Returns
string The temp directory with a trailing directory separator.
3.23.3.20 getTotalUploadLimit()
getTotalUploadLimit ( )
Returns the actual upload limit that results from the POST limit and the upload limit.
Returns
string The actual file size limit for uploads.
3.23.3.21 getUploadLimit()
getUploadLimit ( )
Returns the file size limit for uploads, as configured in the php.ini file.
Returns
string The file size limit for uploads.
3.23.3.22 getZendVersion()
getZendVersion ( )
Returns the zend engine version as string.
Returns
string The zend engine version.
Generated by Doxygen
102 Data Structure Documentation
3.23.3.23 isModHeadersInstalled()
isModHeadersInstalled ( )
Checks if the Apache module "mod_headers" is installed.
Returns
bool true if "mod_headers" is installed, false otherwise.
3.23.3.24 isModRewriteInstalled()
isModRewriteInstalled ( )
Checks if the Apache module "mod_rewrite" is installed.
Returns
bool true if "mod_rewrite" is installed, false otherwise.
3.23.3.25 isWindows()
isWindows ( )
Checks if PHP is running on a Windows system.
Returns
bool true if PHP is running on Windows, false otherwise.
3.23.4 Field Documentation
3.23.4.1 $instance
Felira Environment $instance = null [static], [private]
The current (and only) instance of the Environment object.
Generated by Doxygen
3.24 EventLog Class Reference 103
3.24 EventLog Class Reference
The event log module of the Felira system.
Inheritance diagram for EventLog:
EventLog
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getNotifications ()
Additional Inherited Members
3.24.1 Detailed Description
The event log module of the Felira system.
It can be used to display and manage the event log in the back end.
Copyright
Copyright © Miscalis ®
3.24.2 Constructor & Destructor Documentation
3.24.2.1 __construct()
__construct ( )
Creates a new instance of the Felira event log.
3.24.3 Member Function Documentation
Generated by Doxygen
104 Data Structure Documentation
3.24.3.1 getNotifications()
getNotifications ( )
Returns a list of notifications (warnings, problems) for this module.
Returns
array The list of notifications as array. Each entry is an array with the following fields:
1. "type": The type of the message (one of the FELIRA_MESSAGE_∗ constants).
2. "token": The translation token of the message to display.
3. "args": An array of options (optional, null by default).
4. "details": Additional information (optional, null by default).
5. "link": The link to a page that can be used to fix the problem (optional, may be false).
6. "link_token": The translation token of the text to display as link (only needed, if the link is valid).
See also
Felira::MessageHandler
Reimplemented from Module.
3.24.3.2 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Event Log section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
Generated by Doxygen
3.25 ExportableObject Class Reference 105
3.25 ExportableObject Class Reference
The basic exportable object class of the Felira system.
Inheritance diagram for ExportableObject:
ExportableObject
DataObject
Module
Public Member Functions
• __construct ($identifier, $table)• generateExportList ($fields, $data, $divider=",", $onlyVisible=true)• generateDefaultCSV ($data)
Additional Inherited Members
3.25.1 Detailed Description
The basic exportable object class of the Felira system.
Exportable objects provide methods of creating a csv (Excel) representation of the object.
Copyright
Copyright © Miscalis ®
3.25.2 Constructor & Destructor Documentation
3.25.2.1 __construct()
__construct (
$identifier,
$table )
Creates a new instance of an exportable object.
Generated by Doxygen
106 Data Structure Documentation
Parameters
string $identifier The identifier of the managed object that is used to create the menu items, pages andrequest variables. Stored as module name.
string $table The table that is managed by this object manager.
Reimplemented from DataObject.
3.25.3 Member Function Documentation
3.25.3.1 generateDefaultCSV()
generateDefaultCSV (
$data )
Generates a default CSV export.
Parameters
array $data The data array with the items to export.
Returns
string The CSV data as text (ISO-8859-1).
3.25.3.2 generateExportList()
generateExportList (
$fields,
$data,
$divider = ",",
$onlyVisible = true )
Exports the specified fields of the specified data array.
Parameters
array $fields The array of fields to include in the export.
array $data The array with the data to export.
string $divider The field divider (optional, ',' by default)
bool $onlyVisible Specifies if only visible fields are exported (default: true)
Generated by Doxygen
3.26 Extension Class Reference 107
Returns
array An array of csv lines with the data.
3.26 Extension Class Reference
The extension renderer of the Felira system.
Public Member Functions
• __construct (\Felira\Renderer $renderer, $smarty)• tagFeliraArticle ($params, &$smarty)• tagFeliraImage ($params, &$smarty)
Private Attributes
• $renderer = null
3.26.1 Detailed Description
The extension renderer of the Felira system.
This is the renderer that provides the template tag extensions for the Smarty engine.
Copyright
Copyright © Miscalis ®
3.26.2 Constructor & Destructor Documentation
3.26.2.1 __construct()
__construct (
\Felira\Renderer $renderer,
$smarty )
Creates a new instance of the Felira extension renderer .
Parameters
\Felira\Renderer $renderer The Felira renderer instance.
object $smarty The Smarty instance.
Generated by Doxygen
108 Data Structure Documentation
3.26.3 Member Function Documentation
3.26.3.1 tagFeliraArticle()
tagFeliraArticle (
$params,
& $smarty )
The plug-in function for Smarty to use article includes.
Parameters
array $params The array with the parameters
object $smarty The Smarty instance.
3.26.3.2 tagFeliraImage()
tagFeliraImage (
$params,
& $smarty )
The plug-in function for Smarty to use image includes with various filters.
Parameters
array $params The array with the parameters
object $smarty The Smarty instance.
3.26.4 Field Documentation
3.26.4.1 $renderer
Felira Renderer $renderer = null [private]
The Felira renderer.
3.27 Felira Class Reference
The main class of the Felira system.
Generated by Doxygen
3.27 Felira Class Reference 109
Public Member Functions
• __construct ()• renderFrontEnd ()• renderBackEnd ()• renderPreview ()
Static Public Member Functions
• static getSession ()• static getTranslator ()• static getURLBuilder ()• static getPluginManager ()• static getMessageHandler ()• static getSettingsManager ()• static getDatabase ()• static getClassLoader ()• static getMyPagePath ()• static getMyPageUrl ()
Static Protected Attributes
• static $session = null• static $translator = null• static $urlBuilder = null• static $pluginManager = null• static $messageHandler = null• static $settings = null• static $database = null• static $classLoader = null
3.27.1 Detailed Description
The main class of the Felira system.
Only this class needs to be instantiated for creating a Felira web site. It creates all classes needed to operate a website. It provides static function to allow access to all important system classes.
Copyright
Copyright © Miscalis ®
3.27.2 Constructor & Destructor Documentation
3.27.2.1 __construct()
__construct ( )
Creates a new instance of the Felira system.
Generated by Doxygen
110 Data Structure Documentation
3.27.3 Member Function Documentation
3.27.3.1 getClassLoader()
static getClassLoader ( ) [static]
Returns the class loader of the Felira system.
Returns
Felira::ClassLoader The class loader.
3.27.3.2 getDatabase()
static getDatabase ( ) [static]
Returns the global database (connection) instance.
Returns
Felira::Database The database (connection).
3.27.3.3 getMessageHandler()
static getMessageHandler ( ) [static]
Returns the global message handler instance.
Returns
Felira::MessageHandler The message handler.
3.27.3.4 getMyPagePath()
static getMyPagePath ( ) [static]
Returns the absolute path to the "mypage" folder.The path ends with a slash.
Returns
string The "mypage" path as string.
Generated by Doxygen
3.27 Felira Class Reference 111
3.27.3.5 getMyPageUrl()
static getMyPageUrl ( ) [static]
Returns the full url to the "mypage" folder.The url ends with a slash.
Returns
string The "mypage" url as string.
3.27.3.6 getPluginManager()
static getPluginManager ( ) [static]
Returns the global plug-in manager instance. It can be used to access the system plug-ins.
Returns
Felira::PluginManager The plug-in manager.
3.27.3.7 getSession()
static getSession ( ) [static]
Returns the session object of the Felira system.
Returns
Felira::Session The session object.
3.27.3.8 getSettingsManager()
static getSettingsManager ( ) [static]
Returns the global settings manager instance. It can be used to access the system settings.
Returns
Felira::DataObject::Settings The settings manager.
Generated by Doxygen
112 Data Structure Documentation
3.27.3.9 getTranslator()
static getTranslator ( ) [static]
Returns the translator of the Felira system.
Returns
Felira::Translator The translator.
3.27.3.10 getURLBuilder()
static getURLBuilder ( ) [static]
Returns the URL builder of the Felira system.
Returns
Felira::UrlBuilder The URL builder.
3.27.3.11 renderBackEnd()
renderBackEnd ( )
Renders the back-end and returns the HTML code of the rendered page as string. If a fatal error occurs, the browseris redirected to the error page.
Returns
string The HTML code of the back-end page as string.
3.27.3.12 renderFrontEnd()
renderFrontEnd ( )
Renders the front-end and returns the HTML code of the rendered page as string. If a fatal error occurs, the browseris redirected to the error page.
Returns
string The HTML code of the front-end page as string.
Generated by Doxygen
3.27 Felira Class Reference 113
3.27.3.13 renderPreview()
renderPreview ( )
Renders the article preview and returns the HTML code of the rendered page as string. If a fatal error occurs, thebrowser is redirected to the error page.
Returns
string The HTML code of the editor page as string.
3.27.4 Field Documentation
3.27.4.1 $classLoader
Felira ClassLoader $classLoader = null [static], [protected]
The class loader for Felira
3.27.4.2 $database
Felira Database $database = null [static], [protected]
The static database connection object for use in Felira.
3.27.4.3 $messageHandler
Felira MessageHandler $messageHandler = null [static], [protected]
The message handler, used to send text messages to the website (front-end and back-end).
3.27.4.4 $pluginManager
Felira PluginManager $pluginManager = null [static], [protected]
The plug-in manager, used to load and manage all system plug-ins.
3.27.4.5 $session
Felira Session $session = null [static], [protected]
The Felira session object, it encapsulates all session-related functions. Depending on the requested rendering, thismay be the front-end or the back-end session.
Generated by Doxygen
114 Data Structure Documentation
3.27.4.6 $settings
Felira DataObject Settings $settings = null [static], [protected]
The settings manager, used to access the settings and for providing the settings in the templates.
3.27.4.7 $translator
Felira Translator $translator = null [static], [protected]
The Felira translator, used to translate text tokens into the currently used language.
3.27.4.8 $urlBuilder
Felira UrlBuilder $urlBuilder = null [static], [protected]
The Felira URL builder, used to create all URLs in the system.
3.28 File Class Reference
The file object of the Felira system.
Public Member Functions
• __construct ($name)• setUrl ($url)• getUrl ()• setDisplayName ($name)• getDisplayName ()• getObjectName ()• getSystemName ()• getName ()• getSize ()• isReadable ()• isDirectory ()• getCreationTime ()• getModificationTime ()• getAccessTime ()• getExtension ()• getPermissions ()• getType ()• read ()• delete ()
Private Member Functions
• verbosePermission ($permissions, $val1, $val2)
Generated by Doxygen
3.28 File Class Reference 115
Private Attributes
• $name = null• $systemName = null• $url = null• $displayName = null• $objectName = ''
Static Private Attributes
• static $fileContentTypes• static $fileTypes
3.28.1 Detailed Description
The file object of the Felira system.
It is used to access and modify a single file in the file system. A file name is expected to be in utf-8 character set.
Copyright
Copyright © Miscalis ®
3.28.2 Constructor & Destructor Documentation
3.28.2.1 __construct()
__construct (
$name )
Creates a new instance of a Felira file object.
Parameters
string $name The fully qualified file name in utf-8 character set.
3.28.3 Member Function Documentation
3.28.3.1 delete()
delete ( )
Deletes the file if it exists.
Generated by Doxygen
116 Data Structure Documentation
Returns
bool true on success (or if the file does not exist), false otherwise.
3.28.3.2 getAccessTime()
getAccessTime ( )
Returns the access time of the file in ISO 8601 format.
Returns
string A string with the access time in ISO 8601 format.
3.28.3.3 getCreationTime()
getCreationTime ( )
Returns the creation time of the file in ISO 8601 format.
Returns
string A string with the creation time in ISO 8601 format.
3.28.3.4 getDisplayName()
getDisplayName ( )
Returns the display name of the file.
Returns
string The display name.
3.28.3.5 getExtension()
getExtension ( )
Returns the file extension.
Returns
string The file extension.
Generated by Doxygen
3.28 File Class Reference 117
3.28.3.6 getModificationTime()
getModificationTime ( )
Returns the modification time of the file in ISO 8601 format.
Returns
string A string with the modification time in ISO 8601 format.
3.28.3.7 getName()
getName ( )
Returns the full qualified name of the file.
Returns
string The full qualified name.
3.28.3.8 getObjectName()
getObjectName ( )
Returns the object name of the file. Only available, if the display name is set.
Returns
string The object name.
3.28.3.9 getPermissions()
getPermissions ( )
Returns a string that specifies the permissions for the file in Unix format (trwxrwxrwx).
Returns
string A string with the file permissions in Unix format (trwxrwxrwx).
Generated by Doxygen
118 Data Structure Documentation
3.28.3.10 getSize()
getSize ( )
Returns the size of the file in bytes.
Returns
int The file size in bytes.
3.28.3.11 getSystemName()
getSystemName ( )
Returns the system name of the file. This is the name of the file in the file system's character set.
Returns
string The system name.
3.28.3.12 getType()
getType ( )
Returns the file type, determined from the file extension.
Returns
string A string describing the file type.
3.28.3.13 getUrl()
getUrl ( )
Returns the url of the file.
Returns
string The url of the file.
Generated by Doxygen
3.28 File Class Reference 119
3.28.3.14 isDirectory()
isDirectory ( )
Check if the file is a directory.
Returns
bool true if the file is a directory, false otherwise.
3.28.3.15 isReadable()
isReadable ( )
Check if the file is readable.
Returns
bool true if the file is readable, false otherwise.
3.28.3.16 read()
read ( )
Reads the file into a string.
Returns
string|false The file contents as string or false on error.
3.28.3.17 setDisplayName()
setDisplayName (
$name )
Sets the display name for the file.
Parameters
string $name The display name for the file.
Generated by Doxygen
120 Data Structure Documentation
3.28.3.18 setUrl()
setUrl (
$url )
Sets the url for the file.
Parameters
string $url The URL for the file.
3.28.3.19 verbosePermission()
verbosePermission (
$permissions,
$val1,
$val2 ) [private]
Verboses a single permission.
Parameters
integer $permissions The permission data (int16)
integer $val1 The first value to verbose the permission.
integer $val2 The second value to verbose the permission.
Returns
string The string with the verbosed permission.
3.28.4 Field Documentation
3.28.4.1 $displayName
string $displayName = null [private]
The display name in utf-8 character set.
Generated by Doxygen
3.28 File Class Reference 121
3.28.4.2 $fileContentTypes
array $fileContentTypes [static], [private]
Initial value:= array(
’svg’=>’image’,’jpg’=>’image’,’jpeg’=>’image’,’gif’=>’image’,’png’=>’image’,’ico’=>’image’,’avi’=>’video’,’mp4’=>’video’,’webm’=>’video’,’ogv’=>’video’,’flv’=>’video’,’wav’=>’audio’,’mp3’=>’audio’,’ogg’=>’audio’,’m4a’=>’audio’,’tpl’=>’template’,’php’=>’code’,’js’=>’code’,’css’=>’stylesheet’
)
The array that contains a mapping from file extensions to file content types.
3.28.4.3 $fileTypes
array $fileTypes [static], [private]
Initial value:= array(
0xC000=>’s’,0xA000=>’l’,0x8000=>’-’,0x6000=>’b’,0x4000=>’d’,0x2000=>’c’,0x1000=>’p’
)
The array that contains a mapping from file extensions to file types.
3.28.4.4 $name
string $name = null [private]
The fully qualified file name in utf-8 character set.
3.28.4.5 $objectName
string $objectName = '' [private]
The object name of the file. Create only, if the display name is set.
3.28.4.6 $systemName
string $systemName = null [private]
The fully qualified file name in the system's file system character set.
Generated by Doxygen
122 Data Structure Documentation
3.28.4.7 $url
string $url = null [private]
The fully qualified file URL in utf-8 character set.
3.29 FileBrowser Class Reference
The file browser that is used from TinyMCE for selecting files.
Inheritance diagram for FileBrowser:
FileBrowser
Module
Public Member Functions• __construct ()• processBackEndRequest ($action, $object)
Additional Inherited Members
3.29.1 Detailed Description
The file browser that is used from TinyMCE for selecting files.
TinyMCE uses this module to provide a file selection.
Copyright
Copyright © Miscalis ®
3.29.2 Constructor & Destructor Documentation
3.29.2.1 __construct()
__construct ( )
Creates a new instance of the Felira file browser.
3.29.3 Member Function Documentation
3.29.3.1 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Element Data section.
Generated by Doxygen
3.30 FileManager Class Reference 123
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.30 FileManager Class Reference
The file manager of the Felira system.
Public Member Functions
• __construct ()• getFileList ($path, $urlPrefix='', $recurse=false, $rootPath=null, $replaceBackslash=false, $addHtAccess←↩
Files=false)• getDirectoryList ($path, $urlPrefix='', $recurse=false, $rootPath=null, $includeRoot=false)• convertFileListToOptionList ($fileList, $addEmpty, $limitType=null)• writeFileWithBackup ($filename, $data)• deleteFile ($filename)• touchFiles ($fileList, $time)• processFileUpload ($upload, $targetPath, $targetName=null)• deletePath ($path)• copyFile ($sourceFile, $targetFile)
Private Member Functions
• getSystemName ($fileName)• isDirectory ($filename)
Private Attributes
• $isWindows = false
3.30.1 Detailed Description
The file manager of the Felira system.
It is used to access, modify and list files in the file system. All file and path names expected and returned are inutf-8 character set.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
124 Data Structure Documentation
3.30.2 Constructor & Destructor Documentation
3.30.2.1 __construct()
__construct ( )
Creates a new instance of the Felira file manager.
3.30.3 Member Function Documentation
3.30.3.1 convertFileListToOptionList()
convertFileListToOptionList (
$fileList,
$addEmpty,
$limitType = null )
Converts a file list as returned from the GetFileList() function into the format that is used for option lists.
Parameters
array $fileList An array of File objects.
bool $addEmpty true to add the selection of an empty file name ("no file"), false otherwise.
string | null $limitType The file type to limit the list to (image, video, audio, template) or null if no limitation.
Returns
array The options list as array with the following fields:
1. "name": The name of the file.
2. "value": The name of the file.
3. "disabled": false if the file can be accessed, true otherwise.
4. "translate": Always false.
Generated by Doxygen
3.30 FileManager Class Reference 125
3.30.3.2 copyFile()
copyFile (
$sourceFile,
$targetFile )
Copies the specified file.
Parameters
string $sourceFile The source file.
string $targetFile The target file.
Returns
bool true on success, false otherwise.
3.30.3.3 deleteFile()
deleteFile (
$filename )
Deletes the specified file if it exists.
Parameters
string $filename The full name of the file to delete.
Returns
bool true on success (or if the file does not exist), false otherwise.
3.30.3.4 deletePath()
deletePath (
$path )
Deletes the specified path with all files in it.
Parameters
string $path The path to delete (native OS encoding).
Generated by Doxygen
126 Data Structure Documentation
Returns
bool true on success, false otherwise.
3.30.3.5 getDirectoryList()
getDirectoryList (
$path,
$urlPrefix = '',
$recurse = false,
$rootPath = null,
$includeRoot = false )
Returns a list of all directories in the specified path. The slash (/) is used as separator.
Parameters
string $path The path to list the directories in.
string $urlPrefix The prefix to create the URL of the directory.
bool $recurse true to recurse through sub-directories, false otherwise (optional, false by default)
string | null $rootPath The root path that is stripped from the full path to get the file name (optional).
bool $includeRoot true to include the root directory (/.) in the list, false otherwise.
Returns
array An array with all the directories or an empty array on error. Each file entry contains a File object.
3.30.3.6 getFileList()
getFileList (
$path,
$urlPrefix = '',
$recurse = false,
$rootPath = null,
$replaceBackslash = false,
$addHtAccessFiles = false )
Returns a list of all files in the specified path.
Parameters
string $path The path to list the files in.
string $urlPrefix The prefix to create the URL of the file.
bool $recurse true to recurse through sub-directories, false otherwise (optional, false bydefault)
string | null $rootPath The root path that is stripped from the full path to get the file name(optional).
bool $replaceBackslash true to replace backslash characters in the file name by a slash (to createURL-compatible file names), false otherwise (optional, false by default).
bool $addHtAccessFiles true to add .htaccess files to the list, false otherwise (optional, false bydefault).
Generated by Doxygen
3.30 FileManager Class Reference 127
Returns
array An array with all the files or an empty array on error. Each entry contains a file object.
3.30.3.7 getSystemName()
getSystemName (
$fileName ) [private]
Returns the specified file name adjusted for the current operating system.
Parameters
$fileName The name of the file (or path) in utf-8.
Returns
The file name in the OS-specific character set.
3.30.3.8 isDirectory()
isDirectory (
$filename ) [private]
Check if the specified file is a directory.
Parameters
string $filename The full name of the file to check.
Returns
bool true if the file is a directory, false otherwise.
3.30.3.9 processFileUpload()
processFileUpload (
$upload,
$targetPath,
$targetName = null )
Processes an uploaded file.
Generated by Doxygen
128 Data Structure Documentation
Parameters
array $upload The file structure with the upload data (a single $_FILES entry).
string $targetPath The target path for the uploaded file.
string $targetName The name of the target file, if specified or null to use uploaded file name.
Returns
bool true on success, false otherwise.
3.30.3.10 touchFiles()
touchFiles (
$fileList,
$time )
Changes the modification and access time of the files in the specified list to the specified time.
Parameters
array $fileList An array with Felira::File objects.
int $time The time (epoch) to set.
3.30.3.11 writeFileWithBackup()
writeFileWithBackup (
$filename,
$data )
Creates (or overwrites) the specified file with the specified data. A backup of the file is created and restored if thewrite operation fails. The backup is deleted upon success. Errors are written to the event log.
Parameters
string $filename The full file name of the file to write.
string $data The data to write to the file.
Returns
bool true on success, false otherwise.
3.30.4 Field Documentation
Generated by Doxygen
3.31 Module\FileManager Class Reference 129
3.30.4.1 $isWindows
bool $isWindows = false [private]
Specifies if the system is running Windows.
3.31 Module\FileManager Class Reference
The file manager module of the Felira system. It is used to upload and manage additional files for the page.
Inheritance diagram for Module\FileManager:
ModuleFileManager
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)
Protected Member Functions
• processFileManagerRequest ($action, $folderName, $rootPath, $rootUrl)
Private Member Functions
• getFileList (\Felira\FileManager $fileManager, $currentFolder)
Additional Inherited Members
3.31.1 Detailed Description
The file manager module of the Felira system. It is used to upload and manage additional files for the page.
Copyright
Copyright © Miscalis ®
3.31.2 Constructor & Destructor Documentation
Generated by Doxygen
130 Data Structure Documentation
3.31.2.1 __construct()
__construct ( )
Creates a new instance of the Felira file manager module.
3.31.3 Member Function Documentation
3.31.3.1 getFileList()
getFileList (
\Felira\FileManager $fileManager,
$currentFolder ) [private]
Creates a list of all files in the "mypage" folder and all descendant folders.
Parameters
\Felira\FileManager $fileManager The file manager.
\Felira\File $currentFolder The File object that represents the current folder.
Returns
array An array with the file list.
3.31.3.2 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the File manager section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
Generated by Doxygen
3.32 FileStorage Class Reference 131
3.31.3.3 processFileManagerRequest()
processFileManagerRequest (
$action,
$folderName,
$rootPath,
$rootUrl ) [protected]
Processes a request in the File manager section. The root path for the file management can be specified.
Parameters
string $action The action to perform (only "delete" and "upload" supported).
string | int $folderName The name of the selected folder (may be empty, the root path is used then).
string $rootPath The root path to display the files for.
string $rootUrl The root url that matches the root path.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
3.32 FileStorage Class Reference
The file storage of the Felira system.
Inheritance diagram for FileStorage:
FileStorage
DataObject
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getFiles ()• getFile ($fileId)• deleteFile ($id)• storeFile ($fileData, $fileName=null, $mimeType=null)• retrieveFile ($fileHash)
Generated by Doxygen
132 Data Structure Documentation
Static Public Member Functions
• static verboseFileStorageType ($type)• static getStorageTypes ()
Protected Member Functions
• getObjectDefinition ()
Additional Inherited Members
3.32.1 Detailed Description
The file storage of the Felira system.
It is used to manage (uploaded) files and to store them in database or on disk.
Copyright
Copyright © Miscalis ®
3.32.2 Constructor & Destructor Documentation
3.32.2.1 __construct()
__construct ( )
Creates a new instance of the Felira file storage.
3.32.3 Member Function Documentation
3.32.3.1 deleteFile()
deleteFile (
$id )
Deletes the specified file.
Parameters
int $id The database id of the file to delete.
Generated by Doxygen
3.32 FileStorage Class Reference 133
Returns
bool true if the operation was successful, false otherwise.
3.32.3.2 getFile()
getFile (
$fileId )
Returns the specified file.
Parameters
int $file←↩
IdThe database id of the file to return.
Returns
array|null The specified file or null if the file is not found.
3.32.3.3 getFiles()
getFiles ( )
Reads all files from the database.
Returns
array The array of files on success, an empty array otherwise.
3.32.3.4 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
Generated by Doxygen
134 Data Structure Documentation
3.32.3.5 getStorageTypes()
static getStorageTypes ( ) [static]
Returns an array of storage types that can be used for option lists.
Returns
array The array of storage types.
3.32.3.6 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the File Storage section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.32.3.7 retrieveFile()
retrieveFile (
$fileHash )
Returns the file data by the specified hash.
Parameters
string $fileHash The file hash to get the file for.
Returns
array An array with the following fields (or null if the file was not found):"file_name": The file name
Generated by Doxygen
3.33 FrontEnd Class Reference 135
"mime_type": The mime type of the file"file_data": The file dataOther fields may be filled in!
3.32.3.8 storeFile()
storeFile (
$fileData,
$fileName = null,
$mimeType = null )
Stores a file in the file storage.
Parameters
string $fileData The file data to store.
string $fileName The original name of the file to store.
string $mimeType The mime type of the file to store.
Returns
string|bool The identifier (hash) of the file storage or false if the file was not stored.
3.32.3.9 verboseFileStorageType()
static verboseFileStorageType (
$type ) [static]
Verboses the file storage type, i.e. returns the translation token.
Parameters
int $type The file storage type
Returns
string A string with the translation token for the file storage type.
3.33 FrontEnd Class Reference
The front-end renderer of the Felira system.
Generated by Doxygen
136 Data Structure Documentation
Inheritance diagram for FrontEnd:
FrontEnd
Renderer
Public Member Functions
• __construct ()• render (\Felira\Response $response, $category, $alias)
Private Member Functions
• renderSinglePager (\Felira\Response $response, $category)• renderWebsite (\Felira\Response $response, $category, $alias)
Additional Inherited Members
3.33.1 Detailed Description
The front-end renderer of the Felira system.
It is used to render a single page (all articles assigned to category) for the front-end.
Copyright
Copyright © Miscalis ®
3.33.2 Constructor & Destructor Documentation
3.33.2.1 __construct()
__construct ( )
Creates a new instance of the Felira front-end renderer.
Reimplemented from Renderer.
3.33.3 Member Function Documentation
3.33.3.1 render()
render (
\Felira\Response $response,
$category,
$alias )
Performs the actual rendering of the page and returns the resulting HTML code as string.
Generated by Doxygen
3.33 FrontEnd Class Reference 137
Parameters
Felira::Response $response The response object.
Felira::Category $category The category object.
string $alias The article or category alias (that was specified via GET parameter).
Returns
string The HTML code of the page.
3.33.3.2 renderSinglePager()
renderSinglePager (
\Felira\Response $response,
$category ) [private]
Renders the specified category as single-pager web site.
Parameters
Felira::Response $response The response object.
Felira::Category $category The category object to be rendered.
Returns
string|bool The HTML code of the page string or false on error.
3.33.3.3 renderWebsite()
renderWebsite (
\Felira\Response $response,
$category,
$alias ) [private]
Renders the specified category as normal web site. The requested article is extracted here.
Parameters
Felira::Response $response The response object.
Felira::Category $category The category object to be rendered.
string | null $alias The alias of the article (or category) to render (may be null).
Generated by Doxygen
138 Data Structure Documentation
Returns
string|bool The HTML code of the page string or false on error.
3.34 FrontEnd Class Reference
The front-end response object of the Felira system.
Inheritance diagram for FrontEnd:
FrontEnd
Response
Public Member Functions
• __construct ()• addJsFile ($fileUrl, $position='top', $async=false)• addCssFile ($fileUrl, $position='top')• getJsFiles ()• getCssFiles ()• getRenderer ()
Protected Member Functions
• getResponseData ()
Protected Attributes
• $jsFiles = array()• $cssFiles = array()
Private Attributes
• $renderer = null
3.34.1 Detailed Description
The front-end response object of the Felira system.
It is used deliver a front-end page to the client.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
3.34 FrontEnd Class Reference 139
3.34.2 Constructor & Destructor Documentation
3.34.2.1 __construct()
__construct ( )
Creates a new instance of a front-end response.
3.34.3 Member Function Documentation
3.34.3.1 addCssFile()
addCssFile (
$fileUrl,
$position = 'top' )
Adds a new CSS file to include on the page.
Parameters
string $fileUrl The full URL of the file to include.
string $position The position where to include the file (top or bottom, top by default).
3.34.3.2 addJsFile()
addJsFile (
$fileUrl,
$position = 'top',
$async = false )
Adds a new JavaScript file to include on the page.
Parameters
string $fileUrl The full URL of the file to include.
string $position The position where to include the file (top or bottom, top by default).
bool $async The flag that specifies if the script should be loaded asynchronous (true) or not (false,default).
Generated by Doxygen
140 Data Structure Documentation
3.34.3.3 getCssFiles()
getCssFiles ( )
Returns the css files of the response.
Returns
array An array with the css files.
3.34.3.4 getJsFiles()
getJsFiles ( )
Returns the js files of the response.
Returns
array An array with the JavaScript files.
3.34.3.5 getRenderer()
getRenderer ( )
Returns the front-end renderer.
Returns
Felira::Renderer::FrontEnd The front-end renderer.
3.34.3.6 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
Generated by Doxygen
3.35 FrontEnd Class Reference 141
3.34.4 Field Documentation
3.34.4.1 $cssFiles
$cssFiles = array() [protected]
The array with the css files to include on the page.
3.34.4.2 $jsFiles
$jsFiles = array() [protected]
The array with the js files to include on the page.
3.34.4.3 $renderer
$renderer = null [private]
The front-end renderer.
3.35 FrontEnd Class Reference
The front-end request class of the Felira system.
Public Member Functions
• process ()
Protected Member Functions
• createResponse ()• processRequest ($class)• processAjaxRequest ($class)
3.35.1 Detailed Description
The front-end request class of the Felira system.
It provides the processing for the Felira front-end (regular and ajax).
Copyright
Copyright © Miscalis ®
Generated by Doxygen
142 Data Structure Documentation
3.35.2 Member Function Documentation
3.35.2.1 createResponse()
createResponse ( ) [protected]
Creates the front-end response.
Returns
Felira::Response The front-end response.
3.35.2.2 process()
process ( )
Processes a front-end request and returns the resulting code as string.
Returns
string|bool The data to deliver to the client or false on error.
3.35.2.3 processAjaxRequest()
processAjaxRequest (
$class ) [protected]
Processes an AJAX request from the front-end.
Parameters
Felira::Module | null $class The module that should process the request.
Returns
Felira::Response A Felira::Response object to return.
Generated by Doxygen
3.36 Generic Class Reference 143
3.35.2.4 processRequest()
processRequest (
$class ) [protected]
Processes a front-end request.
Parameters
Felira::Module | null $class The module that should process the request.
Returns
Felira::Response A Felira::Response object on success or null if the request was not processed.
3.36 Generic Class Reference
The generic database connector.
Inheritance diagram for Generic:
Generic
MSSQL MySQL
Public Member Functions
• __construct ($databaseSettings)• getPDOInstance ()• getType ()• getDatabase ()• getListDatabasesQuery ()• getListTablesQuery ()• getListColumnsQuery ()• getListConstraintsQuery ()• escapeColumn ($column)
Protected Attributes
• $db = null• $listDatabasesQuery = ''• $listTablesQuery = ''• $listColumnsQuery = ''• $listConstraintsQuery = ''• $leftColumnDelimiter = ''• $rightColumnDelimiter = ''
Generated by Doxygen
144 Data Structure Documentation
3.36.1 Detailed Description
The generic database connector.
This is the base class for all database connectors.
Copyright
Copyright © Miscalis ®
3.36.2 Constructor & Destructor Documentation
3.36.2.1 __construct()
__construct (
$databaseSettings )
Creates a new generic database connector.
Parameters
array $databaseSettings The settings to connect to the database. An array with the following fields:
1. "connector": The connector used to connect to the database. Must be oneof the database type names supported by PDO.
2. "server": The server name or IP address of the database server.
3. "database": The database name.
4. "username": The user name used to connect to the database.
5. "password": The password used to connect to the database.
6. "charset": The character set used for the database connection.
Reimplemented in MSSQL, and MySQL.
3.36.3 Member Function Documentation
Generated by Doxygen
3.36 Generic Class Reference 145
3.36.3.1 escapeColumn()
escapeColumn (
$column )
Escapes the specified column.
Parameters
string $column The column name.
Returns
string A string with the escaped column name.
3.36.3.2 getDatabase()
getDatabase ( )
Returns the name of the current database on the database server.
Returns
string The database name as string.
3.36.3.3 getListColumnsQuery()
getListColumnsQuery ( )
Returns the query string for listing all columns in table.
Returns
string The query string.
3.36.3.4 getListConstraintsQuery()
getListConstraintsQuery ( )
Returns the query string for listing all constraints in table.
Returns
string The query string.
Generated by Doxygen
146 Data Structure Documentation
3.36.3.5 getListDatabasesQuery()
getListDatabasesQuery ( )
Returns the query string for listing all databases on the database server.
Returns
string The query string.
3.36.3.6 getListTablesQuery()
getListTablesQuery ( )
Returns the query string for listing all tables in a database on the database server.
Returns
string The query string.
3.36.3.7 getPDOInstance()
getPDOInstance ( )
Returns a PDO instance for the database.
Returns
object|null A PDO instance or null.
Reimplemented in MSSQL, and MySQL.
3.36.3.8 getType()
getType ( )
Returns the database type aka. the database connector name.
Returns
string The connector name.
Generated by Doxygen
3.36 Generic Class Reference 147
3.36.4 Field Documentation
3.36.4.1 $db
$db = null [protected]
The array with the database settings.
3.36.4.2 $leftColumnDelimiter
$leftColumnDelimiter = '' [protected]
The left delimiter for column names.
3.36.4.3 $listColumnsQuery
$listColumnsQuery = '' [protected]
The query string for listing all columns in a table. The query string contains two questionmarks as placeholder forthe database name and the table name.
3.36.4.4 $listConstraintsQuery
$listConstraintsQuery = '' [protected]
The query string for listing all constraints in a table. The query string contains two questionmarks as placeholder forthe database name and the table name.
3.36.4.5 $listDatabasesQuery
$listDatabasesQuery = '' [protected]
The query string for listing all database on the database server.
3.36.4.6 $listTablesQuery
$listTablesQuery = '' [protected]
The query string for listing all tables in a database. The query string contains a questionmark as placeholder for thedatabase name.
Generated by Doxygen
148 Data Structure Documentation
3.36.4.7 $rightColumnDelimiter
$rightColumnDelimiter = '' [protected]
The right delimiter for column names.
3.37 GoogleMaps Class Reference
The content element for a Google Maps.
Inheritance diagram for GoogleMaps:
GoogleMaps
ContentElement
Module
Public Member Functions
• __construct ()• onAfterRender (\Felira\Response $response)• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.37.1 Detailed Description
The content element for a Google Maps.
Copyright
Copyright © Miscalis ®
3.37.2 Constructor & Destructor Documentation
Generated by Doxygen
3.37 GoogleMaps Class Reference 149
3.37.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.37.3 Member Function Documentation
3.37.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.37.3.2 onAfterRender()
onAfterRender (
\Felira\Response $response )
Loads the css and js files for the content element.
Parameters
\Felira\Response $response The response object.
Reimplemented from ContentElement.
3.37.3.3 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Generated by Doxygen
150 Data Structure Documentation
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
3.38 HTML Class Reference
The HTML response object of the Felira system.
Inheritance diagram for HTML:
HTML
Response
Public Member Functions
• __construct ()• setHTML ($html)
Protected Member Functions
• getResponseData ()
Private Attributes
• $htmlData = ''
Additional Inherited Members
3.38.1 Detailed Description
The HTML response object of the Felira system.
It is used deliver an HTML document to the client.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
3.38 HTML Class Reference 151
3.38.2 Constructor & Destructor Documentation
3.38.2.1 __construct()
__construct ( )
Creates a new instance of an HTML response.
3.38.3 Member Function Documentation
3.38.3.1 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
3.38.3.2 setHTML()
setHTML (
$html )
Sets the HTML data.
Parameters
string $html The HTML data as string.
3.38.4 Field Documentation
Generated by Doxygen
152 Data Structure Documentation
3.38.4.1 $htmlData
string $htmlData = '' [private]
The HTML document data.
3.39 HtmlText Class Reference
The content element for simple html text content.
Inheritance diagram for HtmlText:
HtmlText
ContentElement
Module
Public Member Functions
• __construct ()• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.39.1 Detailed Description
The content element for simple html text content.
Copyright
Copyright © Miscalis ®
3.39.2 Constructor & Destructor Documentation
Generated by Doxygen
3.39 HtmlText Class Reference 153
3.39.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.39.3 Member Function Documentation
3.39.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.39.3.2 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in thewebsite (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
Generated by Doxygen
154 Data Structure Documentation
3.40 Image Class Reference
The content element for an image.
Inheritance diagram for Image:
Image
ContentElement
Module
Public Member Functions
• __construct ()• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.40.1 Detailed Description
The content element for an image.
Copyright
Copyright © Miscalis ®
3.40.2 Constructor & Destructor Documentation
3.40.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.40.3 Member Function Documentation
Generated by Doxygen
3.41 ImageFilter Class Reference 155
3.40.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.40.3.2 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
3.41 ImageFilter Class Reference
The image filter manager of the Felira system.
Inheritance diagram for ImageFilter:
ImageFilter
DataObject
Module
Generated by Doxygen
156 Data Structure Documentation
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getImageFilters ()• getImageFilterById ($id)• getImageFilterByName ($imageFilterName)
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• createListView ()• createEditView ($action, $object)• getFilterTypes ()• verboseFilterType ($type)
Additional Inherited Members
3.41.1 Detailed Description
The image filter manager of the Felira system.
It is used to provide access to and manage all image filters in the system.
Copyright
Copyright © Miscalis ®
3.41.2 Constructor & Destructor Documentation
3.41.2.1 __construct()
__construct ( )
Creates a new instance of the Felira image filter manager.
3.41.3 Member Function Documentation
3.41.3.1 createEditView()
createEditView (
$action,
$object ) [private]
Creates the editor view for the specified mail template.
Generated by Doxygen
3.41 ImageFilter Class Reference 157
Parameters
string $action The action ("edit" or "new").
int $object The database id of the mail template to edit (unused for "new" action).
Returns
Felira::Response::BackEnd A back-end response object.
3.41.3.2 createListView()
createListView ( ) [private]
Creates the image filter list view and returns a back-end response for it.
Returns
Felira::Response::BackEnd A back-end response object.
3.41.3.3 getFilterTypes()
getFilterTypes ( ) [private]
Returns the array of filter types for an image filter. This array is used for the editor selection.
Returns
array The filter types array.
3.41.3.4 getImageFilterById()
getImageFilterById (
$id )
Returns the specified image filter.
Parameters
int $id The database id of the image filter to load.
Generated by Doxygen
158 Data Structure Documentation
Returns
array|null The specified image filter or null if the image filter is not found.
3.41.3.5 getImageFilterByName()
getImageFilterByName (
$imageFilterName )
Returns the specified image filter.
Parameters
string $imageFilterName The name if the image filter to return.
Returns
array|null The specified image filter or null if the image filter is not found.
3.41.3.6 getImageFilters()
getImageFilters ( )
Reads all image filters from the database.
Returns
array The array of image filters on success, an empty array otherwise.
3.41.3.7 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.41.3.8 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Image Filter section.
Generated by Doxygen
3.42 ImageProcessor Class Reference 159
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.41.3.9 verboseFilterType()
verboseFilterType (
$type ) [private]
Verboses the specified filter type.
Parameters
string $type The filter type to verbose.
Returns
string The verbosed filter type.
3.42 ImageProcessor Class Reference
The image processor of the Felira system.
Public Member Functions
• __construct ()• applyFilter ($filter, $sourceFile, $targetFile)• resizeImage ($sourceFile, $targetFile, $width, $height, $keepAspectRatio, $jpegQuality=75)• cropImage ($sourceFile, $targetFile, $width, $height, $jpegQuality=75)• greyscaleImage ($sourceFile, $targetFile, $jpegQuality=75)
Protected Attributes
• $gdInfo = null
Generated by Doxygen
160 Data Structure Documentation
Private Member Functions
• loadImage ($imageFile)• saveImage ($fileInfo, $fileName, $imageData, $jpegQuality)
3.42.1 Detailed Description
The image processor of the Felira system.
It can be used to manipulate images (via image filters).
Copyright
Copyright © Miscalis ®
3.42.2 Constructor & Destructor Documentation
3.42.2.1 __construct()
__construct ( )
Creates a new instance of the Felira image processor.
3.42.3 Member Function Documentation
3.42.3.1 applyFilter()
applyFilter (
$filter,
$sourceFile,
$targetFile )
Applies the specified image filter to the specified image.
Parameters
array $filter The array with the image filter data.
string $sourceFile The full name of the source file to manipulate.
string $targetFile The full name of the target file to write.
Generated by Doxygen
3.42 ImageProcessor Class Reference 161
3.42.3.2 cropImage()
cropImage (
$sourceFile,
$targetFile,
$width,
$height,
$jpegQuality = 75 )
Crops the specified image to the specified width and height.
Parameters
string $sourceFile The full name of the source file to manipulate.
string $targetFile The full name of the target file to write.
int $width The desired width in pixels.
int $height The desired height in pixels.
int $jpegQuality The jpeg quality, if the image is a jpeg (optional, 75% by default).
3.42.3.3 greyscaleImage()
greyscaleImage (
$sourceFile,
$targetFile,
$jpegQuality = 75 )
Converts the image to greyscale.
Parameters
string $sourceFile The full name of the source file to manipulate.
string $targetFile The full name of the target file to write.
int $jpegQuality The jpeg quality, if the image is a jpeg (optional, 75% by default).
3.42.3.4 loadImage()
loadImage (
$imageFile ) [private]
Loads the image specified by its full qualified name.
Parameters
string $imageFile The full qualified file name of the image.
Generated by Doxygen
162 Data Structure Documentation
Returns
array An array with the folowing fields:
1. The image descriptor or null on error.
2. The image information structure.
3.42.3.5 resizeImage()
resizeImage (
$sourceFile,
$targetFile,
$width,
$height,
$keepAspectRatio,
$jpegQuality = 75 )
Resizes the specified image to the specified width and height.
Parameters
string $sourceFile The full name of the source file to manipulate.
string $targetFile The full name of the target file to write.
int $width The desired width in pixels.
int $height The desired height in pixels.
bool $keepAspectRatio false to force the exact target dimensions, true to keep aspect ratio.
int $jpegQuality The jpeg quality, if the image is a jpeg (optional, 75% by default).
3.42.3.6 saveImage()
saveImage (
$fileInfo,
$fileName,
$imageData,
$jpegQuality ) [private]
Saves the specified image to the specified file.
Parameters
array $fileInfo The file info structure.
string $fileName The file name to save the image to.
string $imageData The image data to save.
int $jpegQuality The jpeg quality, if the image is a jpeg.
Generated by Doxygen
3.43 JSON Class Reference 163
Returns
bool true on success, false otherwise.
3.42.4 Field Documentation
3.42.4.1 $gdInfo
$gdInfo = null [protected]
The structure with the capabilities of the gd library or null if no gd library is available.
3.43 JSON Class Reference
The JSON response object of the Felira system.
Inheritance diagram for JSON:
JSON
Response
Public Member Functions
• __construct ()• setJsonData (array $data)
Protected Member Functions
• getResponseData ()
Private Attributes
• $jsonData = ''
Additional Inherited Members
3.43.1 Detailed Description
The JSON response object of the Felira system.
It is used deliver JSON content to the client.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
164 Data Structure Documentation
3.43.2 Constructor & Destructor Documentation
3.43.2.1 __construct()
__construct ( )
Creates a new instance of a JSON response.
3.43.3 Member Function Documentation
3.43.3.1 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
3.43.3.2 setJsonData()
setJsonData (
array $data )
Sets the data for the JSON response.
Parameters
array $data An array of data to deliver as JSON content.
3.43.4 Field Documentation
Generated by Doxygen
3.44 Module\LessManager Class Reference 165
3.43.4.1 $jsonData
$jsonData = '' [private]
Returns the JSON data.
3.44 Module\LessManager Class Reference
The Less manager module of the Felira system. It provides online less file editing & compiling.
Inheritance diagram for Module\LessManager:
ModuleLessManager
SystemEditor
Module
Public Member Functions
• __construct ()• registerCssAndJsFiles (\Felira\Response\BackEnd $response)• onAfterSave ($name, $fullFileName)
Private Member Functions
• parsePrivateVariables ($data)
Additional Inherited Members
3.44.1 Detailed Description
The Less manager module of the Felira system. It provides online less file editing & compiling.
Copyright
Copyright © Miscalis ®
3.44.2 Constructor & Destructor Documentation
Generated by Doxygen
166 Data Structure Documentation
3.44.2.1 __construct()
__construct ( )
Creates a new instance of the Felira less manager module.
3.44.3 Member Function Documentation
3.44.3.1 onAfterSave()
onAfterSave (
$name,
$fullFileName )
The callback that is called after the file has been saved and is used to compile the less file into a css file.
Parameters
string $name The file name of the saved file, relative to the path the files for this editor are in (css,media, etc.).
string $fullFileName The full file name of the saved file.
Returns
bool true if successful, false otherwise.
3.44.3.2 parsePrivateVariables()
parsePrivateVariables (
$data ) [private]
Processes the specified less file data and replaces all private (internal) variables by their values.
Parameters
string $data The data to parse.
Returns
string The processed data.
Generated by Doxygen
3.45 Link Class Reference 167
3.44.3.3 registerCssAndJsFiles()
registerCssAndJsFiles (
\Felira\Response\BackEnd $response )
Registers the used css and js files for the editor.
Parameters
object $response The response object.
Reimplemented from SystemEditor.
3.45 Link Class Reference
The content element for a link.
Inheritance diagram for Link:
Link
ContentElement
Module
Public Member Functions
• __construct ()• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.45.1 Detailed Description
The content element for a link.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
168 Data Structure Documentation
3.45.2 Constructor & Destructor Documentation
3.45.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.45.3 Member Function Documentation
3.45.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.45.3.2 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Generated by Doxygen
3.46 Login Class Reference 169
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
3.46 Login Class Reference
The log-in manager of the Felira system.
Inheritance diagram for Login:
Login
Module
Public Member Functions
• __construct ()• process ()
Private Member Functions
• getLoginPageCode ()• getDefaultPage ()
Additional Inherited Members
3.46.1 Detailed Description
The log-in manager of the Felira system.
It is used to manage the user log-in for the back-end.
Copyright
Copyright © Miscalis ®
3.46.2 Constructor & Destructor Documentation
Generated by Doxygen
170 Data Structure Documentation
3.46.2.1 __construct()
__construct ( )
Creates a new instance of the Felira log-in manager.
3.46.3 Member Function Documentation
3.46.3.1 getDefaultPage()
getDefaultPage ( ) [private]
Returns the default page (the page that is displayed by clicking on the leftmost top-menu item).
Returns
string The module name (page name) of the menu item.
3.46.3.2 getLoginPageCode()
getLoginPageCode ( ) [private]
Returns the html code of the login page to the back-end.
Returns
string The html code as string.
3.46.3.3 process()
process ( )
Processes a log-in request or the back-end request if no user is logged in.
Returns
string The html code of the page to display.
3.47 Mailer Class Reference
The mailer of the Felira system.
Generated by Doxygen
3.47 Mailer Class Reference 171
Public Member Functions
• sendMail ($subject, $content, $recipientName=null, $recipientAddress=null, $senderName=null, $sender←↩
Address=null)• sendHtmlMail ($subject, $content, $recipientName=null, $recipientAddress=null, $senderName=null,
$senderAddress=null)
Protected Member Functions
• validateMailSettings (&$recipientName, &$recipientAddress, &$senderName, &$senderAddress)
3.47.1 Detailed Description
The mailer of the Felira system.
The Felira mailer can be used to send e-mails via the internal mail() function. The mail server settings must beconfigured in the PHP configuration.
Copyright
Copyright © Miscalis ®
3.47.2 Member Function Documentation
3.47.2.1 sendHtmlMail()
sendHtmlMail (
$subject,
$content,
$recipientName = null,
$recipientAddress = null,
$senderName = null,
$senderAddress = null )
Sends an html mail with the specified data from the specified sender to the specified recipient. If no recipient and/orsender is specified the data is taken from the system settings. Errors are written to the event log.
Parameters
string $subject The mail subject.
string $content The mail body text (sent as text/plain).
string $recipientName The name of the recipient (optional, default setting will be used if null).
string $recipientAddress The address of the recipient (optional, default setting will be used if null).
string $senderName The name of the sender (optional, default setting will be used if null).
string $senderAddress The address of the sender (optional, default setting will be used if null).
Generated by Doxygen
172 Data Structure Documentation
Returns
bool true on success, false otherwise.
3.47.2.2 sendMail()
sendMail (
$subject,
$content,
$recipientName = null,
$recipientAddress = null,
$senderName = null,
$senderAddress = null )
Sends a plain text utf-8 mail with the specified data from the specified sender to the specified recipient. If norecipient and/or sender is specified the data is taken from the system settings. Errors are written to the event log.
Parameters
string $subject The mail subject.
string $content The mail body text (sent as text/plain).
string $recipientName The name of the recipient (optional, default setting will be used if null).
string $recipientAddress The address of the recipient (optional, default setting will be used if null).
string $senderName The name of the sender (optional, default setting will be used if null).
string $senderAddress The address of the sender (optional, default setting will be used if null).
Returns
bool true on success, false otherwise.
3.47.2.3 validateMailSettings()
validateMailSettings (
& $recipientName,
& $recipientAddress,
& $senderName,
& $senderAddress ) [protected]
Checks if the mailer is enabled and validates the specified settings for a mail.
Parameters
$recipientName
$recipientAddress
$senderName
$senderAddress
Generated by Doxygen
3.48 MailTemplate Class Reference 173
Returns
true on success, false otherwise.
3.48 MailTemplate Class Reference
The mail template manager of the Felira system.
Inheritance diagram for MailTemplate:
MailTemplate
DataObject
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getMailTemplates ()• getMailTemplateById ($id)• getMailTemplateList ()
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• createListView ()• createEditView ($action, $object)
Additional Inherited Members
3.48.1 Detailed Description
The mail template manager of the Felira system.
It is used to manage the mail templates that can be used to send mails.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
174 Data Structure Documentation
3.48.2 Constructor & Destructor Documentation
3.48.2.1 __construct()
__construct ( )
Creates a new instance of the Felira mail template manager.
3.48.3 Member Function Documentation
3.48.3.1 createEditView()
createEditView (
$action,
$object ) [private]
Creates the editor view for the specified mail template.
Parameters
string $action The action ("edit" or "new").
string | int $object The database id of the mail template to edit (unused for "new" action).
Returns
Felira::Response::BackEnd A back-end response object.
3.48.3.2 createListView()
createListView ( ) [private]
Creates the mail template list view and returns a back-end response for it.
Returns
Felira::Response::BackEnd A back-end response object.
3.48.3.3 getMailTemplateById()
getMailTemplateById (
$id )
Returns the specified mail.
Generated by Doxygen
3.48 MailTemplate Class Reference 175
Parameters
int $id The database id of the mail to return.
Returns
array|null The specified mail or null if the mail is not found.
3.48.3.4 getMailTemplateList()
getMailTemplateList ( )
Returns an array with all mail templates that can be used to display as selection.
Returns
array An array with the mails or an array with an empty entry.
3.48.3.5 getMailTemplates()
getMailTemplates ( )
Reads all mails from the database.
Returns
array The array of mails on success, an empty array otherwise.
3.48.3.6 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.48.3.7 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Mail Templates section.
Generated by Doxygen
176 Data Structure Documentation
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.49 Maintenance Class Reference
The "maintenance mode" renderer for the Felira system.
Inheritance diagram for Maintenance:
Maintenance
Renderer
Public Member Functions
• __construct ()• render ()
Additional Inherited Members
3.49.1 Detailed Description
The "maintenance mode" renderer for the Felira system.
. It is used to render the "maintenance" page.
Copyright
Copyright © Miscalis ®
3.49.2 Constructor & Destructor Documentation
Generated by Doxygen
3.50 Maintenance Class Reference 177
3.49.2.1 __construct()
__construct ( )
Creates a new instance of the Felira maintenance renderer.
Reimplemented from Renderer.
3.49.3 Member Function Documentation
3.49.3.1 render()
render ( )
Renders the maintenance mode.
Returns
string|bool The HTML code of the page string or false on error.
3.50 Maintenance Class Reference
The maintenance response object of the Felira system.
Inheritance diagram for Maintenance:
Maintenance
Response
Public Member Functions
• __construct ()
Protected Member Functions
• getResponseData ()
Generated by Doxygen
178 Data Structure Documentation
Additional Inherited Members
3.50.1 Detailed Description
The maintenance response object of the Felira system.
It is used deliver the maintenance page to the client.
Copyright
Copyright © Miscalis ®
3.50.2 Constructor & Destructor Documentation
3.50.2.1 __construct()
__construct ( )
Creates a new instance of a maintenance response.
3.50.3 Member Function Documentation
3.50.3.1 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
3.51 MessageHandler Class Reference
The message handler class of the Felira system.
Generated by Doxygen
3.51 MessageHandler Class Reference 179
Public Member Functions
• addMessage ($type, $token, $args=null, $details=null, $link=null, $linkToken=null)• addSuccessMessage ($token, $args=null)• addWarningMessage ($token, $args=null)• addErrorMessage ($token, $args=null)• addDetailedErrorMessage ($token, $args, $details)• addInfoMessage ($token, $args=null)• getMessages ($removeMessages=true)• getLastMessage ()• getMessageCount ()
Data Fields
• const FELIRA_MESSAGE_SUCCESS = 0• const FELIRA_MESSAGE_WARNING = 1• const FELIRA_MESSAGE_ERROR = 2• const FELIRA_MESSAGE_INFO = 3
Private Attributes
• $messages = array()
3.51.1 Detailed Description
The message handler class of the Felira system.
It can be used for passing messages from the program logic to the web site (front-end and back-end). The messagedata is stored in the session (back-end session or front-end session, depending on current request).
Copyright
Copyright © Miscalis ®
3.51.2 Member Function Documentation
3.51.2.1 addDetailedErrorMessage()
addDetailedErrorMessage (
$token,
$args,
$details )
Adds a new error message with detail information to the list of messages.
Generated by Doxygen
180 Data Structure Documentation
Parameters
string $token The translation token of the message to display.
array $args An array with string values that are inserted into the message string, if placeholders arefound (optional, null by default).
string $details Additional detail information that will be added to the message.
3.51.2.2 addErrorMessage()
addErrorMessage (
$token,
$args = null )
Adds a new error message to the list of messages.
Parameters
string $token The translation token of the message to display.
array | null $args An array with string values that are inserted into the message string, if placeholders arefound (optional, null by default).
3.51.2.3 addInfoMessage()
addInfoMessage (
$token,
$args = null )
Adds a new informational message to the list of messages.
Parameters
string $token The translation token of the message to display.
array $args An array with string values that are inserted into the message string, if placeholders arefound (optional, null by default).
3.51.2.4 addMessage()
addMessage (
$type,
$token,
$args = null,
Generated by Doxygen
3.51 MessageHandler Class Reference 181
$details = null,
$link = null,
$linkToken = null )
Adds a new message to the list of messages.
Parameters
int $type The type of message to add (one of the FELIRA_MESSAGE_∗ constants).
string $token The translation token of the message to add.
array | null $args An array with string values that are inserted into the message string, if placeholdersare found (optional, null by default).
string | null $details Additional detail information that will be added to the message (optional, null bydefault).
string | null $link The URL of a link or null for no link (optional, null by default).
string | null $linkToken The translation token of the text to display as link (optional, null by default).
3.51.2.5 addSuccessMessage()
addSuccessMessage (
$token,
$args = null )
Adds a new success message to the list of messages.
Parameters
string $token The translation token of the message to display.
array | null $args An array with string values that are inserted into the message string, if placeholders arefound (optional, null by default).
3.51.2.6 addWarningMessage()
addWarningMessage (
$token,
$args = null )
Adds a new warning message to the list of messages.
Parameters
string $token The translation token of the message to display.
array | null $args An array with string values that are inserted into the message string, if placeholders arefound (optional, null by default).
Generated by Doxygen
182 Data Structure Documentation
3.51.2.7 getLastMessage()
getLastMessage ( )
Returns the list last message that was added.
Returns
string The last message as string or an empty string if none.
3.51.2.8 getMessageCount()
getMessageCount ( )
Returns the number of messages in the current queue.
Returns
int The number of messages in the current queue.
3.51.2.9 getMessages()
getMessages (
$removeMessages = true )
Returns the list of all currently set message (read from the session).
Parameters
bool $removeMessages The flag that specifies if the messages are removed from the list (optional, true bydefault).
Returns
array The message list as array or an empty array if none.
3.51.3 Field Documentation
Generated by Doxygen
3.52 Module Class Reference 183
3.51.3.1 $messages
$messages = array() [private]
The array of currently active messages.
3.51.3.2 FELIRA_MESSAGE_ERROR
const FELIRA_MESSAGE_ERROR = 2
The constant for identifying Felira error messages.
3.51.3.3 FELIRA_MESSAGE_INFO
const FELIRA_MESSAGE_INFO = 3
The constant for identifying Felira information messages.
3.51.3.4 FELIRA_MESSAGE_SUCCESS
const FELIRA_MESSAGE_SUCCESS = 0
The constant for identifying Felira success messages.
3.51.3.5 FELIRA_MESSAGE_WARNING
const FELIRA_MESSAGE_WARNING = 1
The constant for identifying Felira warning messages.
3.52 Module Class Reference
The base class for all types of Felira modules.
Inheritance diagram for Module:
Generated by Doxygen
184 Data Structure Documentation
Module
ModuleContactForm
ContentElement
ModuleDashboard
DatabaseManager
DataObject
ModuleDistributionManager
EventLog
FileBrowser
ModuleFileManager
Login
Relation
ModuleSitemap
SystemEditor
ModuleSystemInformation
TemplateCache
ModuleUpdateClient
ModuleUpdateServer
Data Structures
• class ContactForm
The contact form module of the Felira system. It is used to process the data of a contact form that was submittedfrom the front-end (via Ajax).
• class Dashboard
The Dashboard of the Felira system. It is used in the back-end to provide information to the user on the dashboard.• class DistributionManager
The distribution manager of the Felira system.• class FileManager
The file manager module of the Felira system. It is used to upload and manage additional files for the page.• class LessManager
The Less manager module of the Felira system. It provides online less file editing & compiling.• class Sitemap
The sitemap class of the Felira system.• class StyleManager
The style manager module of the Felira system. It provides online css file editing.• class SystemInformation
The system information module of the Felira system. It is used to provide and evaluate system information in theback-end.
• class TemplateManager
The template file manager module of the Felira system. It provides online template file editing.• class UpdateClient
The update client of the Felira system.• class UpdateServer
The update server of the Felira system.
Generated by Doxygen
3.52 Module Class Reference 185
Public Member Functions
• __construct ($moduleName=null)• setPluginDirectory ($pluginDirectory)• getPluginDirectory ()• getPluginPath ()• getVendorPath ()• getPluginTemplatePath ()• getPluginUrl ()• getModuleName ()• getModuleActions ()• addAction ($action, $token)• addDirectAction ($action, $token)• addDummyAction ($action)• getFirstAllowedAction ()• addPopupMenu ($name, $pos, $action=null, $toFront=false)• addMenuItem ($popup, $index, $name, $action=null)• getNotifications ()• processBackEndRequest ($action, $object)• processFrontEndRequest (\Felira\Renderer\FrontEnd $renderer, $action, $object)• processFrontEndAjaxRequest ($action, $object)
Static Public Member Functions
• static getMenuItems ()
Protected Attributes
• $moduleName = null
Private Attributes
• $actions = array()• $pluginDirectory = null
Static Private Attributes
• static $menuItems = array()
3.52.1 Detailed Description
The base class for all types of Felira modules.
All manager classes and plug-ins are derived from this class. It stored the information about the module such as thename, description and version and provides functions for accessing these information. It also handles the moduleactions used for the user permissions.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
186 Data Structure Documentation
3.52.2 Constructor & Destructor Documentation
3.52.2.1 __construct()
__construct (
$moduleName = null )
Creates a new instance of a Felira module.
Parameters
string $moduleName The internal name of the module (optional, null by default).
3.52.3 Member Function Documentation
3.52.3.1 addAction()
addAction (
$action,
$token )
Adds a new (non-direct) action for the current module. These actions are expected to produce a page.
See also
addDummyAction()
addDirectAction()
Parameters
string $action The action to add.
string $token The translation token for the title of the action.
3.52.3.2 addDirectAction()
addDirectAction (
$action,
$token )
Adds a new direct action for the current module. Direct actions are executed but do not produce a page output (likedelete or duplicate actions).
Generated by Doxygen
3.52 Module Class Reference 187
See also
addAction()
addDummyAction()
Parameters
string $action The action to add.
string $token The translation token for the title of the action.
3.52.3.3 addDummyAction()
addDummyAction (
$action )
Adds a new dummy action for the current module. Dummy actions have no user right and are used for redirection ifno other action is allowed for the user.
See also
addAction()
addDirectAction()
Parameters
string $action The action to add.
3.52.3.4 addMenuItem()
addMenuItem (
$popup,
$index,
$name,
$action = null )
Adds a new menu item for the module.
Parameters
array $popup The pop-up menu to add item item to.
int $index The (numberic) index of the menu item.
string $name The name of the item to add.
string | null $action The action of the menu item (optional).
Generated by Doxygen
188 Data Structure Documentation
3.52.3.5 addPopupMenu()
addPopupMenu (
$name,
$pos,
$action = null,
$toFront = false )
Adds a new pop-up menu to the end of the menu.
Parameters
string $name The name of the item to add.
string $pos The position of the top menu item ('left' or 'right').
string | null $action The action to perform (optional, no sub-items are created if set).
bool $toFront true to add the menu item to the front of the menu, false (default) otherwise.
3.52.3.6 getFirstAllowedAction()
getFirstAllowedAction ( )
Returns the first action that may be performed by the current user. The action is determined by checking the currentuser permissions that are stored in the session.
Returns
string The first allowed action or an empty string if none.
3.52.3.7 getMenuItems()
static getMenuItems ( ) [static]
Returns all menu items.
Returns
array The array with the menu item data.
Generated by Doxygen
3.52 Module Class Reference 189
3.52.3.8 getModuleActions()
getModuleActions ( )
Returns the available actions for this module.
Returns
array An array with the available actions for this module.
See also
addAction()
3.52.3.9 getModuleName()
getModuleName ( )
Returns the internal name of the module.
Returns
string The internal name of the module as string.
3.52.3.10 getNotifications()
getNotifications ( )
Returns a list of notifications (warnings, problems) for this module.
Returns
array The list of notifications as array. Each entry is an array with the following fields:
1. "type": The type of the message (one of the FELIRA_MESSAGE_∗ constants).
2. "token": The translation token of the message to display.
3. "args": An array of options (optional, null by default).
4. "details": Additional information (optional, null by default).
5. "link": The link to a page that can be used to fix the problem (optional, may be false).
6. "link_token": The translation token of the text to display as link (only needed, if the link is valid).
See also
Felira::MessageHandler
Reimplemented in Settings, DatabaseManager, and EventLog.
Generated by Doxygen
190 Data Structure Documentation
3.52.3.11 getPluginDirectory()
getPluginDirectory ( )
Gets the name of the directory of the plug-in, relative to the plug-in folder. This is only the name without trailingdirectory separator.
See also
setPluginDirectory()
Returns
string The name of the directory of the plug-in.
3.52.3.12 getPluginPath()
getPluginPath ( )
Gets the absolute path name of the plug-in directory.
Returns
string The path of the plug-in.
3.52.3.13 getPluginTemplatePath()
getPluginTemplatePath ( )
Gets the absolute path name of the template directory of the plug-in.
Returns
string The template path of the module.
3.52.3.14 getPluginUrl()
getPluginUrl ( )
Gets the full URL of the root directory of the plug-in.
Returns
string The full URL of the module.
Generated by Doxygen
3.52 Module Class Reference 191
3.52.3.15 getVendorPath()
getVendorPath ( )
Gets the full path of the directory that stores the classes for this plug-in (if the module was loaded from a plug-in).
Returns
string The full path of the class directory of the plug-in.
3.52.3.16 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the back-end section of this module in Felira.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented in RichSnippet, ElementData, Settings, Article, Category, FileStorage, ImageFilter, MailTemplate,User, UserEvent, ContentElement, Template, SystemEditor, DatabaseManager, EventLog, TemplateCache,Module\Dashboard, Module\UpdateClient, Module\DistributionManager, Module\FileManager, Module\SystemInformation,and FileBrowser.
3.52.3.17 processFrontEndAjaxRequest()
processFrontEndAjaxRequest (
$action,
$object )
Processes an AJAX request from the Felira front-end.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Generated by Doxygen
192 Data Structure Documentation
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented in Module\ContactForm.
3.52.3.18 processFrontEndRequest()
processFrontEndRequest (
\Felira\Renderer\FrontEnd $renderer,
$action,
$object )
Processes a request from the Felira front-end.
Parameters
\Felira\Renderer\FrontEnd $renderer The front-end renderer that can be used to render templates or settemplate variables.
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented in Module\Sitemap, and Module\UpdateServer.
3.52.3.19 setPluginDirectory()
setPluginDirectory (
$pluginDirectory )
Stores the name of the directory of the plug-in (without trailing directory separator), relative to the plug-in folder.This is done when loading the plugins.
See also
getPluginDirectory()
Parameters
string $pluginDirectory The directory name of the plug-in.
Generated by Doxygen
3.53 MSSQL Class Reference 193
3.52.4 Field Documentation
3.52.4.1 $actions
$actions = array() [private]
The array with the available module actions, if any. Module actions are used for the user permissions and fordetermining the first active menu item.
3.52.4.2 $menuItems
$menuItems = array() [static], [private]
The array with the available menu items, if any.
3.52.4.3 $moduleName
$moduleName = null [protected]
The internal name of the module (used for user permissions etc.). This is not a name for displaying to the user, butshould be a translation token that can be translated into a human-readable name. For content element modules,this is the name stored in the content element table. It must be unique for all installed modules.
3.52.4.4 $pluginDirectory
$pluginDirectory = null [private]
The name of the plug-in directory (the last part of the path), if the module is in a plug-in.
3.53 MSSQL Class Reference
The database connector for Microsoft SQL Server databases.
Inheritance diagram for MSSQL:
MSSQL
Generic
Public Member Functions
• __construct ($databaseSettings)• getPDOInstance ()
Generated by Doxygen
194 Data Structure Documentation
Additional Inherited Members
3.53.1 Detailed Description
The database connector for Microsoft SQL Server databases.
A database connector contains the database-specific extension for the database handling.
Copyright
Copyright © Miscalis ®
3.53.2 Constructor & Destructor Documentation
3.53.2.1 __construct()
__construct (
$databaseSettings )
Creates a new Microsoft SQL Server database connector.
Parameters
array $databaseSettings The settings to connect to the database. An array with the following fields:
1. "connector": The connector used to connect to the database. Must be oneof the database type names supported by PDO.
2. "server": The server name or IP address of the database server.
3. "database": The database name.
4. "username": The user name used to connect to the database.
5. "password": The password used to connect to the database.
6. "charset": The character set used for the database connection.
Reimplemented from Generic.
3.53.3 Member Function Documentation
Generated by Doxygen
3.54 MySQL Class Reference 195
3.53.3.1 getPDOInstance()
getPDOInstance ( )
Returns a PDO instance for the database.
Returns
object|null A PDO instance or null.
Reimplemented from Generic.
3.54 MySQL Class Reference
The database connector for MySQL or MariaDB databases.
Inheritance diagram for MySQL:
MySQL
Generic
Public Member Functions
• __construct ($databaseSettings)• getPDOInstance ()
Additional Inherited Members
3.54.1 Detailed Description
The database connector for MySQL or MariaDB databases.
A database connector contains the database-specific extension for the database handling.
Copyright
Copyright © Miscalis ®
3.54.2 Constructor & Destructor Documentation
3.54.2.1 __construct()
__construct (
$databaseSettings )
Creates a new MySQL / MariaDB database connector.
Generated by Doxygen
196 Data Structure Documentation
Parameters
array $databaseSettings The settings to connect to the database. An array with the following fields:
1. "connector": The connector used to connect to the database. Must be oneof the database type names supported by PDO.
2. "server": The server name or IP address of the database server.
3. "database": The database name.
4. "username": The user name used to connect to the database.
5. "password": The password used to connect to the database.
6. "charset": The character set used for the database connection.
Reimplemented from Generic.
3.54.3 Member Function Documentation
3.54.3.1 getPDOInstance()
getPDOInstance ( )
Returns a PDO instance for the database.
Returns
object|null A PDO instance or null.
Reimplemented from Generic.
3.55 ObjectList Class Reference
The object list class of the Felira system.
Generated by Doxygen
3.55 ObjectList Class Reference 197
Public Member Functions
• __construct ()• addMenuItem ($title, $link, $active=false, $count=-1)• addTopButton ($titleToken, $link, $question=null)• addColumn ($field, $titleToken, $sort=false, $filter=false, $filterSelection=array())• addItem ($item, $active=true, $actions=array(), $title=null, $template=null, $styles='', $icon=null)• createAction ($icon, $title, $link, $question=null)• getList ()
Protected Attributes
• $columns = array()• $items = array()• $menu = array()• $topLinks = array()
3.55.1 Detailed Description
The object list class of the Felira system.
It encapsulates an object list for the back-end.
Copyright
Copyright © Miscalis ®
3.55.2 Constructor & Destructor Documentation
3.55.2.1 __construct()
__construct ( )
Creates a new instance of an object list.
3.55.3 Member Function Documentation
3.55.3.1 addColumn()
addColumn (
$field,
$titleToken,
$sort = false,
$filter = false,
$filterSelection = array() )
Adds a new column to the list.
Generated by Doxygen
198 Data Structure Documentation
Parameters
string $field The name of the data field that is displayed in this columns. Must be unique within alist.
string $titleToken The translation token of the title of the column as displayed to the user.
bool $sort The flag that specifies if the list may be sorted by this column. Optional, false bydefault.
bool $filter The flag that specifies if the list may be filtered by this column. Optional, false bydefault.
array $filterSelection An array of strings that are presented as selection field to filter the column for.
3.55.3.2 addItem()
addItem (
$item,
$active = true,
$actions = array(),
$title = null,
$template = null,
$styles = '',
$icon = null )
Adds a new item to the list.
Parameters
array $item The item data as associative array.
bool $active The flag that specifies if the item is active. Optional, true by default.
array $actions An array with actions that are available for the item (optional).
string | null $title The title to use in tile view (optional).
string | null $template The template to use for the item if in tile view (optional).
string $styles Additional styles for the item (applied to the table row, optional).
string | null $icon The url of an icon display in front of the first column of the list item (optional).
3.55.3.3 addMenuItem()
addMenuItem (
$title,
$link,
$active = false,
$count = -1 )
Adds an item for the menu next to the object list.
Generated by Doxygen
3.55 ObjectList Class Reference 199
Parameters
string $title The menu item title.
string $link The link for the menu item.
bool $active The flag that specifies if the menu item is active (false by default).
int $count The count of sub-items (optional, -1 by default). This value is displayed as bullet, if >= 0.
3.55.3.4 addTopButton()
addTopButton (
$titleToken,
$link,
$question = null )
Adds a new button to the top of the list.
Parameters
string $titleToken The translation token for the title.
string $link The link as string.
string | null $question The question for the warning message of the link (Optional).
3.55.3.5 createAction()
createAction (
$icon,
$title,
$link,
$question = null )
Creates and returns a new action entry for a list item.
Parameters
string $icon The name of the icon for the list item.
string $title The tranlation token of the title for the action.
string $link The link for the action.
string $question The question for the warning message of the item (Optional).
Returns
array The action item.
Generated by Doxygen
200 Data Structure Documentation
3.55.3.6 getList()
getList ( )
Returns the list object for rendering.
Returns
array An array with the list data.
3.55.4 Field Documentation
3.55.4.1 $columns
$columns = array() [protected]
The list of columns.
3.55.4.2 $items
$items = array() [protected]
The list of items.
3.55.4.3 $menu
$menu = array() [protected]
The menu left of the list.
3.55.4.4 $topLinks
$topLinks = array() [protected]
The list of link objects above the list.
3.56 Plugin Class Reference
The style manager plugin of the Felira system. It provides online css file editing.
Inheritance diagram for Plugin:
Plugin
Plugin
Generated by Doxygen
3.57 Plugin Class Reference 201
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.56.1 Detailed Description
The style manager plugin of the Felira system. It provides online css file editing.
Copyright
Copyright © Miscalis ®
3.56.2 Constructor & Destructor Documentation
3.56.2.1 __construct()
__construct ( )
Creates a new instance of the Felira style manager.
3.56.3 Member Function Documentation
3.56.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.57 Plugin Class Reference
The system information plugin of the Felira system. It is used to provide and evaluate system information in theback-end.
Inheritance diagram for Plugin:
Generated by Doxygen
202 Data Structure Documentation
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.57.1 Detailed Description
The system information plugin of the Felira system. It is used to provide and evaluate system information in theback-end.
Copyright
Copyright © Miscalis ®
3.57.2 Constructor & Destructor Documentation
3.57.2.1 __construct()
__construct ( )
Creates a new instance of the Felira system information manager.
3.57.3 Member Function Documentation
3.57.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
Generated by Doxygen
3.58 Plugin Class Reference 203
3.58 Plugin Class Reference
The template editor plugin of the Felira system. It provides online template file editing.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.58.1 Detailed Description
The template editor plugin of the Felira system. It provides online template file editing.
Copyright
Copyright © Miscalis ®
3.58.2 Constructor & Destructor Documentation
3.58.2.1 __construct()
__construct ( )
Creates a new instance of the Felira template editor plugin.
3.58.3 Member Function Documentation
3.58.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Generated by Doxygen
204 Data Structure Documentation
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.59 Plugin Class Reference
The updater plugin of the Felira system. It provides the back-end interface for the updater.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.59.1 Detailed Description
The updater plugin of the Felira system. It provides the back-end interface for the updater.
Copyright
Copyright © Miscalis ®
3.59.2 Constructor & Destructor Documentation
3.59.2.1 __construct()
__construct ( )
Creates a new instance of the Felira template file manager.
3.59.3 Member Function Documentation
3.59.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Generated by Doxygen
3.60 Plugin Class Reference 205
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.60 Plugin Class Reference
The update server plugin of the Felira system. It provides an interface to query the available updates for Felira.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.60.1 Detailed Description
The update server plugin of the Felira system. It provides an interface to query the available updates for Felira.
Copyright
Copyright © Miscalis ®
3.60.2 Constructor & Destructor Documentation
3.60.2.1 __construct()
__construct ( )
Creates a new instance of the Felira update server plugin.
3.60.3 Member Function Documentation
3.60.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Generated by Doxygen
206 Data Structure Documentation
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.61 Plugin Class Reference
The base class for a Felira plug-in.
Inheritance diagram for Plugin:
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Plugin
Public Member Functions
• __construct ($pluginNameToken, $pluginVersion, $frontEnd=true)• setPluginDirectory ($pluginDirectory)• getPluginDirectory ()• getPluginId ()• getPluginUrl ()• getTranslationPath ()• setPluginLogo ($logoUrl)• getPluginLogo ()• addComponentInformation ($name, $version)• getComponentInformation ()• getVersion ()• getNameToken ()• usedInFrontEnd ()• init (PluginManager $pluginManager)
Generated by Doxygen
3.61 Plugin Class Reference 207
Private Attributes
• $version = null• $nameToken = null• $componentData = array()• $pluginDirectory = null• $frontEnd = true• $imageUrl = null
3.61.1 Detailed Description
The base class for a Felira plug-in.
It provides the basic functions for plug-ins. All plug-ins are required to implement this class.
Copyright
Copyright © Miscalis ®
3.61.2 Constructor & Destructor Documentation
3.61.2.1 __construct()
__construct (
$pluginNameToken,
$pluginVersion,
$frontEnd = true )
Creates a new instance of a Felira system plug-in.
Parameters
string $pluginNameToken The translation token of the name of the plug-in as displayed to the user.
string $pluginVersion The version number (as string) of the plug-in.
bool $frontEnd The flag that specifies if the plug-in is initialized when rendering the front-end(true) or not (false).
3.61.3 Member Function Documentation
3.61.3.1 addComponentInformation()
addComponentInformation (
$name,
$version )
Generated by Doxygen
208 Data Structure Documentation
Adds the name and version of a component used by this module. This information is only used for informationalpurpose..
Parameters
string $name The name of the component.
string $version The version of the component.
3.61.3.2 getComponentInformation()
getComponentInformation ( )
Returns the component data.
Returns
array The component data as array. Each entry contains the following fields:
1. "name": The name of the component.
2. "version": The version of the component.
3.61.3.3 getNameToken()
getNameToken ( )
Returns the translation token of the name of the plug-in.
Returns
string The translation token of the name of the plug-in.
3.61.3.4 getPluginDirectory()
getPluginDirectory ( )
Gets the name of the directory of the plug-in, relative to the plug-in folder. This is only the name without trailingdirectory separator.
See also
SetPluginDirectory()
Returns
string The name of the directory of the plug-in.
Generated by Doxygen
3.61 Plugin Class Reference 209
3.61.3.5 getPluginId()
getPluginId ( )
Returns a unique id for the plugin. This id is created from the plugin directory name.
Returns
string The unique id of the plugin.
3.61.3.6 getPluginLogo()
getPluginLogo ( )
Gets the plug-in logo image URL, if any.
Returns
string The URL of the image logo (may be null if no image is specified).
3.61.3.7 getPluginUrl()
getPluginUrl ( )
Gets the URL of the root directory of the plug-in.
Returns
string The URL of the root directory of the plug-in.
3.61.3.8 getTranslationPath()
getTranslationPath ( )
Gets the full path of the directory that stores the translations for this plug-in.
Returns
string The full path of the translation directory of the plug-in.
Generated by Doxygen
210 Data Structure Documentation
3.61.3.9 getVersion()
getVersion ( )
Returns the version number of the plug-in as string.
Returns
string The version number of the plug-in as string.
3.61.3.10 init()
init (
PluginManager $pluginManager ) [abstract]
Initializes the plug-in.
Parameters
\Felira\PluginManager $pluginManager The plug-in manager instance.
3.61.3.11 setPluginDirectory()
setPluginDirectory (
$pluginDirectory )
Stores the name of the directory of the plug-in (without trailing directory separator), relative to the plug-in folder.This is done when loading the plug-ins.
See also
getPluginDirectory()
Parameters
string $pluginDirectory The directory name of the plug-in.
3.61.3.12 setPluginLogo()
setPluginLogo (
$logoUrl )
Sets the plug-in logo image URL. The image should be of size 16x16px.
Generated by Doxygen
3.61 Plugin Class Reference 211
Parameters
string $logoUrl The URL of the image logo.
3.61.3.13 usedInFrontEnd()
usedInFrontEnd ( )
Returns if the plug-in is used in the front-end.
Returns
bool true if the plug-in is used in the front-end, false otherwise.
3.61.4 Field Documentation
3.61.4.1 $componentData
$componentData = array() [private]
The array to store component information in.
3.61.4.2 $frontEnd
$frontEnd = true [private]
The flag that specifies if the plug-in is needed for front-end rendering.
3.61.4.3 $imageUrl
string $imageUrl = null [private]
The URL of a logo image (16x16) for the plug-in (optional, null by default).
3.61.4.4 $nameToken
$nameToken = null [private]
The translation token of the name of plug-in that can be displayed to the user.
Generated by Doxygen
212 Data Structure Documentation
3.61.4.5 $pluginDirectory
$pluginDirectory = null [private]
The name of the plug-in directory (the last part of the path).
3.61.4.6 $version
$version = null [private]
The version of the plug-in as string (can be displayed to the user).
3.62 Plugin Class Reference
The default contact form plugin of the Felira system.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.62.1 Detailed Description
The default contact form plugin of the Felira system.
It provides the back-end part of a contact form.
Copyright
Copyright © Miscalis ®
3.62.2 Constructor & Destructor Documentation
Generated by Doxygen
3.63 Plugin Class Reference 213
3.62.2.1 __construct()
__construct ( )
Creates a new instance of the Felira contact form plugin.
3.62.3 Member Function Documentation
3.62.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plug-in.
Parameters
\Felira\PluginManager $pluginManager The plug-in manager instance.
3.63 Plugin Class Reference
The dashboard plugin of the Felira system.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.63.1 Detailed Description
The dashboard plugin of the Felira system.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
214 Data Structure Documentation
3.63.2 Constructor & Destructor Documentation
3.63.2.1 __construct()
__construct ( )
Creates a new instance of the Felira Dashboard plugin.
3.63.3 Member Function Documentation
3.63.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.64 Plugin Class Reference
The distribution tool plugin of the Felira system. It is used to create zip archives for Felira distribution and update.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()
• init (\Felira\PluginManager $pluginManager)
Generated by Doxygen
3.65 Plugin Class Reference 215
3.64.1 Detailed Description
The distribution tool plugin of the Felira system. It is used to create zip archives for Felira distribution and update.
Copyright
Copyright © Miscalis ®
3.64.2 Constructor & Destructor Documentation
3.64.2.1 __construct()
__construct ( )
Creates a new instance of the Felira Distribution Tool plugin.
3.64.3 Member Function Documentation
3.64.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.65 Plugin Class Reference
The file manager plugin of the Felira system. It is used to upload and manage additional files for the page.
Inheritance diagram for Plugin:
Plugin
Plugin
Generated by Doxygen
216 Data Structure Documentation
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.65.1 Detailed Description
The file manager plugin of the Felira system. It is used to upload and manage additional files for the page.
Copyright
Copyright © Miscalis ®
3.65.2 Constructor & Destructor Documentation
3.65.2.1 __construct()
__construct ( )
Creates a new instance of the Felira file manager.
3.65.3 Member Function Documentation
3.65.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.66 Plugin Class Reference
The Less manager plugin of the Felira system. It provides online less file editing & compiling.
Inheritance diagram for Plugin:
Generated by Doxygen
3.66 Plugin Class Reference 217
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.66.1 Detailed Description
The Less manager plugin of the Felira system. It provides online less file editing & compiling.
Copyright
Copyright © Miscalis ®
3.66.2 Constructor & Destructor Documentation
3.66.2.1 __construct()
__construct ( )
Creates a new instance of the Felira Less manager.
3.66.3 Member Function Documentation
3.66.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
Generated by Doxygen
218 Data Structure Documentation
3.67 Plugin Class Reference
The Sitemap plugin of the Felira system. It provides the Sitemap for Felira.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.67.1 Detailed Description
The Sitemap plugin of the Felira system. It provides the Sitemap for Felira.
Copyright
Copyright © Miscalis ®
3.67.2 Constructor & Destructor Documentation
3.67.2.1 __construct()
__construct ( )
Creates a new instance of the Felira update server plugin.
3.67.3 Member Function Documentation
3.67.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plugin.
Generated by Doxygen
3.68 Plugin Class Reference 219
Parameters
\Felira\PluginManager $pluginManager The plugin manager instance.
3.68 Plugin Class Reference
The content element plug-in of the Felira system.
Inheritance diagram for Plugin:
Plugin
Plugin
Public Member Functions
• __construct ()• init (\Felira\PluginManager $pluginManager)
3.68.1 Detailed Description
The content element plug-in of the Felira system.
It provides the basic content elements for the Felira system.
Copyright
Copyright © Miscalis ®
3.68.2 Constructor & Destructor Documentation
3.68.2.1 __construct()
__construct ( )
Creates a new instance of the content elements plugin.
3.68.3 Member Function Documentation
3.68.3.1 init()
init (
\Felira\PluginManager $pluginManager )
Initializes the plug-in.
Generated by Doxygen
220 Data Structure Documentation
Parameters
\Felira\PluginManager $pluginManager The plug-in manager instance.
3.69 PluginManager Class Reference
The plug-in manager of the Felira system.
Public Member Functions
• __construct ($frontEnd)• getPluginClasses ()• registerModule (Plugin $plugin, Module $module)• registerSystemModule (Module $module)• getModule ($moduleName)• registerContentElement (Plugin $plugin, Module\ContentElement $element)• getContentElements ()• getContentElement ($moduleName)• getContentElementOptionsArray ()• getDefaultTypeName ()• getModules ()• getObjects ($getRelations=false)
Private Member Functions
• loadPlugins ($frontEnd)• loadPlugin ($plugIn, $frontEnd)
Private Attributes
• $plugins = array()• $modules = array()• $elements = array()
3.69.1 Detailed Description
The plug-in manager of the Felira system.
It is used to manage all plug-ins for Felira.
Copyright
Copyright © Miscalis ®
3.69.2 Constructor & Destructor Documentation
3.69.2.1 __construct()
__construct (
$frontEnd )
Creates a new instance of the Felira plug-in manager. All installed plug-ins are loaded here.
Generated by Doxygen
3.69 PluginManager Class Reference 221
Parameters
bool $frontEnd The flag that specifies if only front-end plug-ins should be loaded (true) or not (false).
3.69.3 Member Function Documentation
3.69.3.1 getContentElement()
getContentElement (
$moduleName )
Returns the content element instance with the specified module name.
Parameters
string $moduleName The module name.
Returns
Felira::Module::ContentElement The content element
3.69.3.2 getContentElementOptionsArray()
getContentElementOptionsArray ( )
Returns a list of all loaded content element types in the format that is used to creation combo box options lists.
Returns
array The array with the list of content element types.
3.69.3.3 getContentElements()
getContentElements ( )
Returns the array of registered content elements.
Returns
array The array of registered content elements.
Generated by Doxygen
222 Data Structure Documentation
3.69.3.4 getDefaultTypeName()
getDefaultTypeName ( )
Returns the type name of the default content element type.
Returns
string A string with the default content element type or an empty string if no content elements.
3.69.3.5 getModule()
getModule (
$moduleName )
Returns the module class instance for the specified module name. All available modules are checked (internal &plug-in).
Parameters
string $moduleName The module name to get the class for.
Returns
Felira::Module|null The module class or null if no class with this module name was found.
3.69.3.6 getModules()
getModules ( )
Returns an array with instances of all modules.
Returns
array An array of module classes.
3.69.3.7 getObjects()
getObjects (
$getRelations = false )
Returns an array with all registered objects.
Generated by Doxygen
3.69 PluginManager Class Reference 223
Parameters
bool $getRelations true to include relation objects, false otherwise (default).
Returns
array An array with all registered objects on success or an empty array on failure.
3.69.3.8 getPluginClasses()
getPluginClasses ( )
Returns the array of loaded plug-in classes.
Returns
array The array of plug-in classes.
3.69.3.9 loadPlugin()
loadPlugin (
$plugIn,
$frontEnd ) [private]
Loads a single plug-in.
Parameters
string $plugIn The name of the plug-in (relative to the Felira plug-in folder).
bool $frontEnd The flag that specified if only plug-ins for use in the front-end should be loaded (true) ornot (false).
3.69.3.10 loadPlugins()
loadPlugins (
$frontEnd ) [private]
Loads all installed plug-ins from the file system and stores them in an array.
Generated by Doxygen
224 Data Structure Documentation
Parameters
bool $frontEnd The flag that specified if only plug-ins for use in the front-end should be loaded (true) or not(false).
Returns
bool true on success, false otherwise.
3.69.3.11 registerContentElement()
registerContentElement (
Plugin $plugin,
Module\ContentElement $element )
Registers a new module that provides a content element.
Parameters
\Felira\Plugin $plugin The plug-in that registers the content element.
\Felira\Module\ContentElement $element The content element to register.
3.69.3.12 registerModule()
registerModule (
Plugin $plugin,
Module $module )
Registers a new module that does not provide a content element.
Parameters
\Felira\Plugin $plugin The plug-in that registers the module.
\Felira\Module $module The module to register.
3.69.3.13 registerSystemModule()
registerSystemModule (
Module $module )
Registers a new system module.
Generated by Doxygen
3.70 Preview Class Reference 225
Parameters
\Felira\Module $module The module to register.
3.69.4 Field Documentation
3.69.4.1 $elements
$elements = array() [private]
The array of registered content elements.
3.69.4.2 $modules
$modules = array() [private]
The array of registered modules.
3.69.4.3 $plugins
$plugins = array() [private]
The array that contains all loaded plug-ins (the plug-in classes).
3.70 Preview Class Reference
The renderer for the article wysiwyg preview in the back-end of the Felira system.
Inheritance diagram for Preview:
Preview
Renderer
Public Member Functions
• __construct ()• render ()
Generated by Doxygen
226 Data Structure Documentation
Additional Inherited Members
3.70.1 Detailed Description
The renderer for the article wysiwyg preview in the back-end of the Felira system.
It is used to render a single article in page view for the back-end article wysiwyg editor / preview.
Copyright
Copyright © Miscalis ®
3.70.2 Constructor & Destructor Documentation
3.70.2.1 __construct()
__construct ( )
Creates a new instance of the Felira preview/editor renderer.
Reimplemented from Renderer.
3.70.3 Member Function Documentation
3.70.3.1 render()
render ( )
Renders the specified article and returns the result as string. The "article" GET variable must provide the databaseid of the article to render.
Returns
string|bool The page data as string or false on error.
3.71 Relation Class Reference
The basic relation class of the Felira system.
Inheritance diagram for Relation:
Relation
Module
Generated by Doxygen
3.71 Relation Class Reference 227
Public Member Functions
• __construct ($identifier, $table)• getTableName ()• getDefinedFields ()• addRelation ($val1, $val2)• deleteRelation ($val1, $val2)
Protected Member Functions
• setRelation ($field1, $constraint1, $field2, $constraint2)
Protected Attributes
• $table = null
Private Attributes
• $relation = array()
Additional Inherited Members
3.71.1 Detailed Description
The basic relation class of the Felira system.
It is the base class for n:m relations in the database.
Copyright
Copyright © Miscalis ®
3.71.2 Constructor & Destructor Documentation
3.71.2.1 __construct()
__construct (
$identifier,
$table )
Creates a new instance of the Felira relation manager.
Generated by Doxygen
228 Data Structure Documentation
Parameters
string $identifier The identifier of the managed object that is used to create the menu items, pages andrequest variables. Stored as module name.
string $table The table that is managed by this object manager.
3.71.3 Member Function Documentation
3.71.3.1 addRelation()
addRelation (
$val1,
$val2 )
Adds a new relation entry.
Parameters
int $val1 The value for the first column of the relation.
int $val2 The value for the second column of the relation.
Exceptions
Exception if there was an error
3.71.3.2 deleteRelation()
deleteRelation (
$val1,
$val2 )
Deletes a relation entry.
Parameters
int $val1 The value for the first column of the relation.
int $val2 The value for the second column of the relation.
Exceptions
Exception if there was an error
Generated by Doxygen
3.71 Relation Class Reference 229
3.71.3.3 getDefinedFields()
getDefinedFields ( )
Returns the field definitions for the object managed by this manager.
Returns
array An array with the field definitions (may be empty).
3.71.3.4 getTableName()
getTableName ( )
Returns the name of the database table that stores the objects.
Returns
string The table name as string.
3.71.3.5 setRelation()
setRelation (
$field1,
$constraint1,
$field2,
$constraint2 ) [protected]
Sets the relation data for the database.
Parameters
string $field1 The name of the first field in the database.
array $constraint1 The first database constraint. This is an array with 'table' and 'column' fields of theconstraint target set.
string $field2 The name of the second field in the database.
array $constraint2 The second database constraint. This is an array with 'table' and 'column' fields of theconstraint target set.
Generated by Doxygen
230 Data Structure Documentation
3.71.4 Field Documentation
3.71.4.1 $relation
$relation = array() [private]
The relation data that is managed in this class.
3.71.4.2 $table
$table = null [protected]
The table that is managed by this object manager.
3.72 Renderer Class Reference
The base renderer of the Felira system.
Inheritance diagram for Renderer:
Renderer
Article BackEnd FrontEnd Maintenance Preview Sitemap Tile
Public Member Functions
• __construct ()• getTemplateDir ()• setTemplateDir ($directory)• prepareTemplate ()• setTemplateVar ($name, $value)• getTemplateVars ()• renderExplicitTemplate ($template)• renderTemplate ($template, $statusCode=null)• renderErrorTemplate ($errorToken, $statusCode=null)• setHTTPStatusCode ($statusCode)• cleanupHtml ($code)
Protected Attributes
• $browserInformation = array()
Generated by Doxygen
3.72 Renderer Class Reference 231
Private Attributes
• $smarty = null
3.72.1 Detailed Description
The base renderer of the Felira system.
This is the base class for all Felira renderers. It manages and provides the data common to all renderers.
Copyright
Copyright © Miscalis ®
3.72.2 Constructor & Destructor Documentation
3.72.2.1 __construct()
__construct ( )
Creates a new instance of the Felira renderer.
Reimplemented in Sitemap, BackEnd, FrontEnd, Maintenance, Preview, and Tile.
3.72.3 Member Function Documentation
3.72.3.1 cleanupHtml()
cleanupHtml (
$code )
Cleans up the specified HTML code.
Parameters
string $code The code to cleanup.
Returns
string The cleaned up code.
Generated by Doxygen
232 Data Structure Documentation
3.72.3.2 getTemplateDir()
getTemplateDir ( )
Gets the directory where to get the templates from.
Returns
string The template directory.
3.72.3.3 getTemplateVars()
getTemplateVars ( )
Returns an array with all currently assigned template variables.
Returns
array The array of template variables.
3.72.3.4 prepareTemplate()
prepareTemplate ( )
Prepares the template for renderering. This is done by clearing all (previously set) template variables and settingthe system-wide available template variables.
3.72.3.5 renderErrorTemplate()
renderErrorTemplate (
$errorToken,
$statusCode = null )
Renders the Felira error page.
Parameters
string $errorToken The translation token of the error message to display.
int $statusCode The HTTP status code that is set for the page (optional).
Returns
string|false The error page as string or false on error.
Generated by Doxygen
3.72 Renderer Class Reference 233
3.72.3.6 renderExplicitTemplate()
renderExplicitTemplate (
$template )
Renders the specified template and returns the rendered data as string. If the template cannot be found or there isan error, false is returned.
Parameters
string $template The full name of the template file to render.
Returns
string|false The rendered template or false on error.
3.72.3.7 renderTemplate()
renderTemplate (
$template,
$statusCode = null )
Renders the specified template and returns the rendered data as string. If the template cannot be found or there isan error, the error template is rendered. If this fails too, false is returned.
Parameters
string $template The full name of the template file to render.
int $statusCode The HTTP status code that is set for the page (optional).
Returns
string|false The rendered template as string or false on error.
3.72.3.8 setHTTPStatusCode()
setHTTPStatusCode (
$statusCode )
Sets the HTTP status code for the page being rendered. If the page headers (HTTP headers) have already beensent, nothing is done.
Parameters
int $statusCode The HTTP status code.
Generated by Doxygen
234 Data Structure Documentation
3.72.3.9 setTemplateDir()
setTemplateDir (
$directory )
Sets the directory where to get the templates from.
Parameters
string $directory The new template directory.
3.72.3.10 setTemplateVar()
setTemplateVar (
$name,
$value )
Sets the specified variable for use in the template.
Parameters
string $name The name of the template variable to set.
object $value The value of the template variable to set.
3.72.4 Field Documentation
3.72.4.1 $browserInformation
$browserInformation = array() [protected]
The array that contains the browser information.
3.72.4.2 $smarty
$smarty = null [private]
The internal Smarty template engine instance.
Generated by Doxygen
3.73 Request Class Reference 235
3.73 Request Class Reference
The Request object of the Felira system.
Public Member Functions
• isPostVariableSet ($variable)• getGetVariable ($variable)• getPostVariable ($variable)• setPostVariable ($variable, $data)• redirect ($url)• isAjaxRequest ()• getPostVariables ()• calculateSecurityHash ()• getRemoteIp ()• getJSONData ()• frontEndRedirect ($article=null, $module=null, $action=null, $object=null)• backEndRedirect ($module=null, $action=null, $object=null)
Static Public Member Functions
• static get ()
Private Member Functions
• __construct ()
Static Private Attributes
• static $instance = null
3.73.1 Detailed Description
The Request object of the Felira system.
This class encapsulates the current (web) request to the Felira system. It is the only recommended method foraccessing request data (like GET and POST data, etc.).
Copyright
Copyright © Miscalis ®
3.73.2 Constructor & Destructor Documentation
Generated by Doxygen
236 Data Structure Documentation
3.73.2.1 __construct()
__construct ( ) [private]
No instance of the class can be created.
3.73.3 Member Function Documentation
3.73.3.1 backEndRedirect()
backEndRedirect (
$module = null,
$action = null,
$object = null )
Redirects the browser to the a URL in the back-end, if no output has been made yet.This is a shortcut for using Felira::Request::redirect(Felira::Felira::getURLBuilder()->createBackEndURL(...))
Parameters
string $module The modules that handles the back-end request (optional).
string $action The action to perform (optional).
string | int $object The object to perform the action on (optional).
3.73.3.2 calculateSecurityHash()
calculateSecurityHash ( )
Calculates a hash that is used to (almost) uniquely identify the user that initiated the session.
Returns
string The hash as string.
3.73.3.3 frontEndRedirect()
frontEndRedirect (
$article = null,
$module = null,
$action = null,
$object = null )
Redirects the browser to the a URL in the front-end, if no output has been made yet.This is a shortcut for using Felira::Request::redirect(Felira::Felira::getURLBuilder()->createFrontEndURL(...))
Generated by Doxygen
3.73 Request Class Reference 237
Parameters
string $article The alias of the article or category to reference (optional).
string $module The modules that handles the front-end request (optional).
string $action The action to perform (optional).
string | int $object The object to perform the action on (optional).
3.73.3.4 get()
static get ( ) [static]
Returns the request.
Returns
Felira::Request The current request.
3.73.3.5 getGetVariable()
getGetVariable (
$variable )
Returns the contents of the specified GET variable.
Parameters
string $variable The name of the variable to return the contents for.
Returns
string|null The contents of the specified variable or null if the variable is not set.
3.73.3.6 getJSONData()
getJSONData ( )
Returns JSON data from a POST request.
Returns
array An array with the decoded JSON data.
Generated by Doxygen
238 Data Structure Documentation
3.73.3.7 getPostVariable()
getPostVariable (
$variable )
Returns the contents of the specified POST variable.
Parameters
string $variable The name of the variable to return the contents for.
Returns
string|null The contents of the specified variable or null if the variable is not set.
3.73.3.8 getPostVariables()
getPostVariables ( )
Returns an array with all POST variables.
Returns
array An array with all POST variables.
3.73.3.9 getRemoteIp()
getRemoteIp ( )
Returns the remote IP address of the request.
Returns
string The remote IP address of the request as string.
3.73.3.10 isAjaxRequest()
isAjaxRequest ( )
Checks if the current request is an AJAX request.
Returns
bool true if the request is an AJAX request, false otherwise.
3.73.3.11 isPostVariableSet()
isPostVariableSet (
$variable )
Checks if the specified POST variable is set in the current request.
Generated by Doxygen
3.73 Request Class Reference 239
Parameters
string $variable The name of the variable to check.
Returns
bool true if the variable is set, false otherwise.
3.73.3.12 redirect()
redirect (
$url )
Redirects the browser to the specified URL, if no output has been made yet. The script is ended after setting theredirect in any case.
Parameters
string $url The URL to redirect to.
3.73.3.13 setPostVariable()
setPostVariable (
$variable,
$data )
Sets the contents of the specified POST variable.
Parameters
string $variable The name of the variable to set the contents for.
string | null $data The data to set for the variable
3.73.4 Field Documentation
3.73.4.1 $instance
Felira Request $instance = null [static], [private]
The current (and only) instance of the request object.
Generated by Doxygen
240 Data Structure Documentation
3.74 Response Class Reference
The generic response object for the Felira system.
Inheritance diagram for Response:
Response
BackEnd Binary FrontEnd HTML JSON Maintenance XML
Public Member Functions
• getContentType ()• setContentType ($type)• getCharacterSet ()• getFileName ()• setFileName ($name, $inline=false)• setStatusCode ($code)• sendResponse ()
Protected Member Functions
• getResponseData ()
Protected Attributes
• $contentType = 'text/html'• $charset = 'utf-8'• $fileName = null• $inline = false• $statusCode = null
3.74.1 Detailed Description
The generic response object for the Felira system.
All responses must be derived of this class. The default content type is "text/html" in character set "utf-8".
Copyright
Copyright © Miscalis ®
3.74.2 Member Function Documentation
Generated by Doxygen
3.74 Response Class Reference 241
3.74.2.1 getCharacterSet()
getCharacterSet ( )
Returns the character set.
Returns
string The character set as string.
3.74.2.2 getContentType()
getContentType ( )
Returns the content type.
Returns
string The content type as string.
3.74.2.3 getFileName()
getFileName ( )
Returns the file name used for the content-disposition header.
Returns
string|null The file name set as string or null, if no file name specified.
3.74.2.4 getResponseData()
getResponseData ( ) [abstract], [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented in BackEnd, FrontEnd, JSON, XML, Binary, HTML, and Maintenance.
Generated by Doxygen
242 Data Structure Documentation
3.74.2.5 sendResponse()
sendResponse ( )
Sends the response, i.e. sets the appropiate HTTP headers and returns the response data as string.
Returns
string A string that contains the response data (ready for output).
3.74.2.6 setContentType()
setContentType (
$type )
Sets the content type (used for the content-type HTTP header).
Parameters
string $type The content type as string.
3.74.2.7 setFileName()
setFileName (
$name,
$inline = false )
Sets the file name.
Parameters
string $name The file name to send to the client (in the content-disposition header).
bool $inline true to display the document inline (in the browser), false otherwise (default).
3.74.2.8 setStatusCode()
setStatusCode (
$code )
Sets the status code (for the HTTP response).
Generated by Doxygen
3.74 Response Class Reference 243
Parameters
int $code The status code (see RFC 7231).
3.74.3 Field Documentation
3.74.3.1 $charset
string $charset = 'utf-8' [protected]
The character set for the HTTP response.
3.74.3.2 $contentType
string $contentType = 'text/html' [protected]
The content type for the HTTP response.
3.74.3.3 $fileName
string $fileName = null [protected]
The file name (for the content-disposition header) of the response.
3.74.3.4 $inline
boolean $inline = false [protected]
The flag that specifies if the document is displayed inline (default).Only valid, if a file name was set.
3.74.3.5 $statusCode
integer $statusCode = null [protected]
The HTTP status code that is sent back to the client. If null (default), no status code is set in the HTTP response.
Generated by Doxygen
244 Data Structure Documentation
3.75 RichSnippet Class Reference
The Rich Snippet manager of the Felira system.
Inheritance diagram for RichSnippet:
RichSnippet
DataObject
Module
Public Member Functions
• __construct ()
• getRichSnippetData ($articleId)
• getSnippetItemtypeOptionArray ()
• getSnippetItempropOptionArray ($itemtype)
• getItemtypeNameToken ($itemtype)
• getSnippetDataForArticle ($articleId, $itemtype)
• saveRichSnippetsData ()
• processBackEndRequest ($action, $object)
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• initSnippetData ()
• createItemProp ($property, $name, $type)
• createItemType ($itemtype, $name, $properties=array())
• inheritItemType ($newItemtype, $itemtype, $name, $properties=array())
• getItemProp ($property)
• getItemByItemtype ($itemtype)
Private Attributes
• $itemTypeData = array()
• $itemPropData = array()
Generated by Doxygen
3.75 RichSnippet Class Reference 245
Additional Inherited Members
3.75.1 Detailed Description
The Rich Snippet manager of the Felira system.
It is used to manage the Rich Snippet data (according to the specification on schema.org) used for articles. RichSnippets are used for SEO optimization of the web site.
Copyright
Copyright © Miscalis ®
3.75.2 Constructor & Destructor Documentation
3.75.2.1 __construct()
__construct ( )
Creates a new instance of the Felira Rich Snippet manager.
3.75.3 Member Function Documentation
3.75.3.1 createItemProp()
createItemProp (
$property,
$name,
$type ) [private]
Creates a new property.
Parameters
string $property The property.
string $name The name token.
string $type The datatype of the property.
Returns
array The new itemprop.
Generated by Doxygen
246 Data Structure Documentation
3.75.3.2 createItemType()
createItemType (
$itemtype,
$name,
$properties = array() ) [private]
Creates an itemtype with the default properties of a 'Thing'.
Parameters
string $itemtype The itemtype.
string $name The name token.
array $properties An array of additional properties the itemtype may have.
Returns
array The new itemtype.
3.75.3.3 getItemByItemtype()
getItemByItemtype (
$itemtype ) [private]
Returns the item data for a specified item type.
Parameters
string $itemtype The item type.
Returns
array|null The array with the item data or null on error.
3.75.3.4 getItemProp()
getItemProp (
$property ) [private]
Returns the itemprop object for the specified itemprop name.
Parameters
string $property The itemprop
Generated by Doxygen
3.75 RichSnippet Class Reference 247
Returns
3.75.3.5 getItemtypeNameToken()
getItemtypeNameToken (
$itemtype )
Returns the name token for the specified itemtype.
Parameters
string $itemtype The itemtype to verbose.
Returns
string The token for the specified property or an empty string if none.
3.75.3.6 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.75.3.7 getRichSnippetData()
getRichSnippetData (
$articleId )
Returns the Rich Snippet data for the specified article.
Parameters
int $article←↩
IdThe database id of the article to read the snippet data for.
Returns
array The list of Rich Snippet data or an empty array on error.
Generated by Doxygen
248 Data Structure Documentation
3.75.3.8 getSnippetDataForArticle()
getSnippetDataForArticle (
$articleId,
$itemtype )
Reads the Rich Snippet data for the specified article.
Parameters
int $articleId The database id of the article to read the snippet data for.
string $itemtype The Rich Snippet item type.
Returns
array|null The array with the Rich Snippet data on success, null otherwise.
3.75.3.9 getSnippetItempropOptionArray()
getSnippetItempropOptionArray (
$itemtype )
Returns an array with the supported item properties for the rich snippets.
Parameters
string $itemtype The itemtype of the article, used to limit the available properties to the ones supported bythis itemtype.
Returns
array An array for use as option list with the following fields:
1. "value": The actual rich snippet itemtype.
2. "name": The name token of the item.
3. "disabled": Always false.
4. "translate": Always false.
Generated by Doxygen
3.75 RichSnippet Class Reference 249
3.75.3.10 getSnippetItemtypeOptionArray()
getSnippetItemtypeOptionArray ( )
Returns an array with the supported item types for the rich snippets.
Returns
array An array for use as option list with the following fields:
1. "value": The actual rich snippet itemtype.
2. "name": The name token of the item.
3. "disabled": Always false.
4. "translate": Always true.
3.75.3.11 inheritItemType()
inheritItemType (
$newItemtype,
$itemtype,
$name,
$properties = array() ) [private]
Inherits an itemtype with the all properties.
Parameters
string $newItemtype The itemtype.
string $itemtype The itemtype.
string $name The name token.
array $properties An array of additional properties the itemtype may have.
Returns
array The new itemtype.
3.75.3.12 initSnippetData()
initSnippetData ( ) [private]
Initializes the snippet data. This function must be called to make the item properties and item types available.
Generated by Doxygen
250 Data Structure Documentation
3.75.3.13 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Rich Snippets section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|int An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.75.3.14 saveRichSnippetsData()
saveRichSnippetsData ( )
Saves the data of multiple Rich Snippets data items (from the back-end editor).
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The id of the category of the article whose Rich Snippets data was to be saved.
3.75.4 Field Documentation
3.75.4.1 $itemPropData
$itemPropData = array() [private]
The array for the itemprop data.
Generated by Doxygen
3.76 Session Class Reference 251
3.75.4.2 $itemTypeData
$itemTypeData = array() [private]
The array for the itemtype data.
3.76 Session Class Reference
The session class of the Felira system.
Public Member Functions
• __construct ($sessionName)• login ($id, $displayName, $permissions, $locale, $securityHash)• logout ()• isUserLoggedIn ()• getUserName ()• getUserId ()• getUserPermissions ()• getUserLocale ()• getSecurityHash ()• setCurrentPageData ($module, $action, $object)• getCurrentPageData ($module)• setCustomData ($tag, $data)• getCustomData ($tag)• deleteCustomData ($tag)• isAllowed ($module, $action)• getDataArray ()
3.76.1 Detailed Description
The session class of the Felira system.
It contains all functions used for session management and storage of user data. It is used in the front-end and theback-end. It stores the information about the current logged-in user.
Copyright
Copyright © Miscalis ®
3.76.2 Constructor & Destructor Documentation
3.76.2.1 __construct()
__construct (
$sessionName )
Creates a new instance of the Felira session.(Re-)activates the session with the name specified in the Felira defines.
Generated by Doxygen
252 Data Structure Documentation
Parameters
string $sessionName The name of the session to start.
3.76.3 Member Function Documentation
3.76.3.1 deleteCustomData()
deleteCustomData (
$tag )
Removes a custom data object from the session.
Parameters
string $tag The tag that is used to identify the data.
3.76.3.2 getCurrentPageData()
getCurrentPageData (
$module )
Returns the current page data for the specified module from the session. The page data is cleared after reading.
Parameters
string $module The module to get the page data for.
Returns
array An array with action and object for the specified module.
3.76.3.3 getCustomData()
getCustomData (
$tag )
Gets a custom data object from the session.
Generated by Doxygen
3.76 Session Class Reference 253
Parameters
string $tag The tag that is used to identify the data.
Returns
object|null The data from the session or null if no data is present.
3.76.3.4 getDataArray()
getDataArray ( )
Returns all data stored in the session as array.
Returns
array An array with all session data.
3.76.3.5 getSecurityHash()
getSecurityHash ( )
Returns the security hash of the currently logged in user.
Returns
string The security hash as string.
3.76.3.6 getUserId()
getUserId ( )
Returns the database id of the logged-in user, if any, or 0 otherwise.
Returns
int The database id of the logged-in user.
Generated by Doxygen
254 Data Structure Documentation
3.76.3.7 getUserLocale()
getUserLocale ( )
Returns the locale identifier (xx_XX) of the user.
Returns
string The user locale.
3.76.3.8 getUserName()
getUserName ( )
Returns the display name of the logged-in user, if any, or an empty string otherwise.
Returns
string The display name of the logged-in user, if any.
3.76.3.9 getUserPermissions()
getUserPermissions ( )
Returns the user permissions of the logged-in user, if any, or an empty array otherwise.
Returns
array The user permissions of the logged-in user.
3.76.3.10 isAllowed()
isAllowed (
$module,
$action )
Checks if the current user permissions allow the execution of the specified module action. If the specified actioncannot be found in the permissions array, the action is assumed to be allowed!
Parameters
string $module The module to check.
string $action The action to check.
Generated by Doxygen
3.76 Session Class Reference 255
Returns
bool true if the action for the module is allowed, false otherwise.
3.76.3.11 isUserLoggedIn()
isUserLoggedIn ( )
Returns true if a user is logged in, false otherwise.
Returns
true if a user is logged in, false otherwise.
3.76.3.12 login()
login (
$id,
$displayName,
$permissions,
$locale,
$securityHash )
Stores the essential information of the user that is currently signed on in the session. The authentication itself isdone in the Felira user manager.
Parameters
int $id The database id of the user.
string $displayName The display name of the user.
array $permissions The array with the user permissions.
string $locale The user locale (in the format xx_XX).
string $securityHash A hash that is used to identify the user that created the session.
Returns
bool true on success, false otherwise.
3.76.3.13 logout()
logout ( )
Clears all session information.
Generated by Doxygen
256 Data Structure Documentation
3.76.3.14 setCurrentPageData()
setCurrentPageData (
$module,
$action,
$object )
Stores the current page data in the session. This is the current module, action and object.
Parameters
string $module The module to store the page data for.
string $action The action to store.
string | int $object The object to store.
3.76.3.15 setCustomData()
setCustomData (
$tag,
$data )
Sets a custom data object into the session.
Parameters
string $tag The tag that is used to identify the data.
object $data The data to store.
3.77 Settings Class Reference
The settings manager of the Felira system.
Inheritance diagram for Settings:
Settings
DataObject
Module
Public Member Functions
• __construct ()
Generated by Doxygen
3.77 Settings Class Reference 257
• processBackEndRequest ($action, $object)• saveObject ()• registerSetting ($key, $type, $size, $default, $section, $options=null, $callback=null)• verifyMaintenanceModeIp ($settingsManager, &$setting)• verifyXDebug ($settingsManager, &$setting)• getSetting ($key)• setSetting ($key, $value)• disableSetting ($key)• getSettingsForTemplate ()• getNotifications ()
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• registerDefaultSettings ()
Private Attributes
• $sections = array()• $settings = array()• $settingsData = array()
Additional Inherited Members
3.77.1 Detailed Description
The settings manager of the Felira system.
It is used to manage and provide access to all system- and page-related settings (for front-end and back-end).
Copyright
Copyright © Miscalis ®
3.77.2 Constructor & Destructor Documentation
3.77.2.1 __construct()
__construct ( )
Creates a new instance of the Felira settings manager, loads the settings from the database and registers the defaultsystem settings.
Generated by Doxygen
258 Data Structure Documentation
3.77.3 Member Function Documentation
3.77.3.1 disableSetting()
disableSetting (
$key )
Disables the specified setting in the editor in the back-end. The setting is still available to read, but cannot bechanged.
Parameters
string $key The name (key) of the setting to disable.
Returns
bool true on success, false (or if the item cannot be found).
3.77.3.2 getNotifications()
getNotifications ( )
Returns a list of notifications (warnings, problems) for this module.
Returns
array The list of notifications as array. Each entry is an array with the following fields:
1. "type": The type of the message (one of the FELIRA_MESSAGE_∗ constants).
2. "token": The translation token of the message to display.
3. "args": An array of options (optional, null by default).
4. "details": Additional information (optional, null by default).
5. "link": The link to a page that can be used to fix the problem (optional, may be false).
6. "link_token": The translation token of the text to display as link (only needed, if the link is valid).
See also
Felira::MessageHandler
Reimplemented from Module.
Generated by Doxygen
3.77 Settings Class Reference 259
3.77.3.3 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.77.3.4 getSetting()
getSetting (
$key )
Returns the value of the setting with the specified name.
Parameters
string $key The name (key) of the setting to return.
Returns
string|int|bool|null The setting value or null if no setting found.
3.77.3.5 getSettingsForTemplate()
getSettingsForTemplate ( )
Returns all loaded settings as associative array key => value.
Returns
array The array with the settings.
3.77.3.6 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Settings section.
Generated by Doxygen
260 Data Structure Documentation
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.77.3.7 registerDefaultSettings()
registerDefaultSettings ( ) [private]
Registers the default settings for Felira.
3.77.3.8 registerSetting()
registerSetting (
$key,
$type,
$size,
$default,
$section,
$options = null,
$callback = null )
Registers a system setting.
Parameters
string $key The name (key) of the setting.
string $type The data type for the setting.
int $size The size of the field, if type = "string".
string | int | bool | null $default The default value.
string $section The section that is used to group settings together.
array $options An array of key-value pairs for the selection, if type = 'selection', nullotherwise.
string | array $callback The callback function (name or array with class and name) that is calledafter the setting has been loaded from the database, or null if no callbackfunction is provided.
Generated by Doxygen
3.77 Settings Class Reference 261
3.77.3.9 saveObject()
saveObject ( )
Saves the object from the data specified in the request.
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The name of the section whose settings were to be saved.
3.77.3.10 setSetting()
setSetting (
$key,
$value )
Sets the value of the setting with the specified name.
Parameters
string $key The name (key) of the setting to set.
string | int | bool | null $value The value of the settings to set.
Returns
bool true on success, false otherwise (or if the item cannot be found).
3.77.3.11 verifyMaintenanceModeIp()
verifyMaintenanceModeIp (
$settingsManager,
& $setting )
The callback function that verifies the IP address of the maintenance mode.
Parameters
\Felira\DataObject\Settings $settingsManager The settings manager.
array $setting The setting for the maintenance mode IP.
Generated by Doxygen
262 Data Structure Documentation
3.77.3.12 verifyXDebug()
verifyXDebug (
$settingsManager,
& $setting )
The callback function that verifies the IP address of the maintenance mode.
Parameters
\Felira\DataObject\Settings $settingsManager The settings manager.
array $setting The setting for the maintenance mode IP.
3.77.4 Field Documentation
3.77.4.1 $sections
$sections = array() [private]
The array that contains all available sections for settings.
3.77.4.2 $settings
$settings = array() [private]
The array that contains the Felira settings. Each entry is an array with all data about the setting.
3.77.4.3 $settingsData
$settingsData = array() [private]
The array that contains the settings data from the database.
3.78 SimpleSlider Class Reference
The content element for a simple slider.
Inheritance diagram for SimpleSlider:
SimpleSlider
ContentElement
Module
Generated by Doxygen
3.78 SimpleSlider Class Reference 263
Public Member Functions
• __construct ()• onAfterRender (\Felira\Response $response)• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.78.1 Detailed Description
The content element for a simple slider.
Copyright
Copyright © Miscalis ®
3.78.2 Constructor & Destructor Documentation
3.78.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.78.3 Member Function Documentation
3.78.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.78.3.2 onAfterRender()
onAfterRender (
\Felira\Response $response )
Loads the css and js files for the content element.
Generated by Doxygen
264 Data Structure Documentation
Parameters
\Felira\Response $response The response object.
Reimplemented from ContentElement.
3.78.3.3 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
3.79 SimpleText Class Reference
The content element for simple non-html text content.
Inheritance diagram for SimpleText:
SimpleText
ContentElement
Module
Public Member Functions
• __construct ()• getUsedFields ()
Generated by Doxygen
3.79 SimpleText Class Reference 265
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.79.1 Detailed Description
The content element for simple non-html text content.
Copyright
Copyright © Miscalis ®
3.79.2 Constructor & Destructor Documentation
3.79.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.79.3 Member Function Documentation
3.79.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.79.3.2 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Generated by Doxygen
266 Data Structure Documentation
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
3.80 Module\Sitemap Class Reference
The sitemap class of the Felira system.
Inheritance diagram for Module\Sitemap:
ModuleSitemap
Module
Public Member Functions
• __construct ()• processFrontEndRequest (\Felira\Renderer\FrontEnd $renderer, $action, $object)
Additional Inherited Members
3.80.1 Detailed Description
The sitemap class of the Felira system.
It provides the sitemap for the webpage.
Copyright
Copyright © Miscalis ®
3.80.2 Constructor & Destructor Documentation
Generated by Doxygen
3.81 Sitemap Class Reference 267
3.80.2.1 __construct()
__construct ( )
Creates a new instance of the Felira sitemap.
3.80.3 Member Function Documentation
3.80.3.1 processFrontEndRequest()
processFrontEndRequest (
\Felira\Renderer\FrontEnd $renderer,
$action,
$object )
Processes a request to the sitemap module.
Parameters
\Felira\Renderer\FrontEnd $renderer The front-end renderer that can be used to render templates or settemplate variables.
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.81 Sitemap Class Reference
The Sitemap renderer of the Felira system.
Inheritance diagram for Sitemap:
Sitemap
Renderer
Generated by Doxygen
268 Data Structure Documentation
Public Member Functions
• __construct ()• renderSitemap ($articleAlias=null)• createSitemapLinks ($category, $articles)
Additional Inherited Members
3.81.1 Detailed Description
The Sitemap renderer of the Felira system.
It is used to render the Sitemap for the front-end.
Copyright
Copyright © Miscalis ®
3.81.2 Constructor & Destructor Documentation
3.81.2.1 __construct()
__construct ( )
Creates a new instance of the Felira Sitemap renderer.
Reimplemented from Renderer.
3.81.3 Member Function Documentation
3.81.3.1 createSitemapLinks()
createSitemapLinks (
$category,
$articles )
Creates an array of links for sitemap creation.
Parameters
array $category The category object of the category to create the links for.
array $articles The array of articles to create the sitemap for.
Generated by Doxygen
3.82 Module\StyleManager Class Reference 269
Returns
array An array with all sitemaps or an empty array on error.
3.81.3.2 renderSitemap()
renderSitemap (
$articleAlias = null )
Renders the page sitemap and returns the resulting XML code as string.
Parameters
string $articleAlias The alias of the article to use as start article for the page. If null, the start article of thefirst page category is used.
Returns
string The page sitemap as string or an empty string on error.
3.82 Module\StyleManager Class Reference
The style manager module of the Felira system. It provides online css file editing.
Inheritance diagram for Module\StyleManager:
ModuleStyleManager
SystemEditor
Module
Public Member Functions
• __construct ()• registerCssAndJsFiles (\Felira\Response\BackEnd $response)
Additional Inherited Members
3.82.1 Detailed Description
The style manager module of the Felira system. It provides online css file editing.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
270 Data Structure Documentation
3.82.2 Constructor & Destructor Documentation
3.82.2.1 __construct()
__construct ( )
Creates a new instance of the Felira style manager module.
3.82.3 Member Function Documentation
3.82.3.1 registerCssAndJsFiles()
registerCssAndJsFiles (
\Felira\Response\BackEnd $response )
Registers the used css and js files for the editor.
Parameters
\Felira\Response\BackEnd $response The response object.
Reimplemented from SystemEditor.
3.83 SvgFile Class Reference
The Scalable Vector Graphics file encapsulation of the Felira system.
Public Member Functions
• __construct ($width=0, $height=0)• clear ()• setPenColor ($color)• setPenSize ($width)• setBrushColor ($color)• setFont ($name, $size)• addLine ($x1, $y1, $x2, $y2, $dashes='')• addCircle ($x, $y, $radius)• addRect ($x, $y, $width, $height, $roundx=0, $roundy=0)• addText ($x, $y, $text)• render ()
Generated by Doxygen
3.83 SvgFile Class Reference 271
Private Attributes
• $elementList = array()• $penColor = '#000'• $penSize = 0• $brushColor = '#fff'• $fontSize = '12'• $fontFamily = 'Verdana'• $canvasWidth = 0• $canvasHeight = 0
3.83.1 Detailed Description
The Scalable Vector Graphics file encapsulation of the Felira system.
This class can be used to create svg files dynamically.
Copyright
Copyright © Miscalis ®
3.83.2 Constructor & Destructor Documentation
3.83.2.1 __construct()
__construct (
$width = 0,
$height = 0 )
Creates a new instance of an Scalable Vector Graphics file.
Parameters
int $width The width of the canvas (optional, 0 by default).
int $height The height of the canvas (optional, 0 by default).
3.83.3 Member Function Documentation
3.83.3.1 addCircle()
addCircle (
$x,
Generated by Doxygen
272 Data Structure Documentation
$y,
$radius )
Adds a new circle to the svg file.
Parameters
int $x The x coordinate of the center point.
int $y The y coordinate of the center point.
int $radius The radius of the circle.
3.83.3.2 addLine()
addLine (
$x1,
$y1,
$x2,
$y2,
$dashes = '' )
Adds a new line to the svg file.
Parameters
int $x1 The x coordinate of the line start point.
int $y1 The y coordinate of the line start point.
int $x2 The x coordinate of the line end point.
int $y2 The y coordinate of the line end point.
array $dashes The array with the dash information (optional).
3.83.3.3 addRect()
addRect (
$x,
$y,
$width,
$height,
$roundx = 0,
$roundy = 0 )
Adds a new rectangle to the svg file.
Parameters
int $x The x coordinate of the center point.
int $y The y coordinate of the center point.
Generated by Doxygen
3.83 SvgFile Class Reference 273
Parameters
int $width The width of the rectangle.
int $height The width of the rectangle.
int $roundx The x-axis radius of the ellipse to round the corners (optional).
int $roundy The y-axis radius of the ellipse to round the corners (optional).
3.83.3.4 addText()
addText (
$x,
$y,
$text )
Adds a new text to the svg file.
Parameters
int $x The x coordinate of the center point.
int $y The y coordinate of the center point.
string $text The text string to add.
3.83.3.5 clear()
clear ( )
Clears all elements from the svg file.
3.83.3.6 render()
render ( )
Renders the svg file.
Returns
string A string containing the svg file.
3.83.3.7 setBrushColor()
setBrushColor (
$color )
Sets the brush color for subsequent drawing operations.The brush color is specified in css notation.
Generated by Doxygen
274 Data Structure Documentation
Parameters
string $color The new brush color.
3.83.3.8 setFont()
setFont (
$name,
$size )
Sets the font attributes for subsequent drawing operations.
Parameters
string $name The font family name.
int $size The font size.
3.83.3.9 setPenColor()
setPenColor (
$color )
Sets the pen color for subsequent drawing operations.The pen color is specified in css notation.
Parameters
string $color The new pen color.
3.83.3.10 setPenSize()
setPenSize (
$width )
Sets the width of the pen for subsequent drawing operations.
Parameters
int $width The new pen size.
Generated by Doxygen
3.83 SvgFile Class Reference 275
3.83.4 Field Documentation
3.83.4.1 $brushColor
$brushColor = '#fff' [private]
The color of the brush for drawing operations.
3.83.4.2 $canvasHeight
$canvasHeight = 0 [private]
The height of the image viewport.
3.83.4.3 $canvasWidth
$canvasWidth = 0 [private]
The width of the image viewport.
3.83.4.4 $elementList
$elementList = array() [private]
The array of elements contained in the svg file.
3.83.4.5 $fontFamily
$fontFamily = 'Verdana' [private]
The font family name for text drawing operations.
3.83.4.6 $fontSize
$fontSize = '12' [private]
The font size for text drawing operations.
3.83.4.7 $penColor
$penColor = '#000' [private]
The color of the pen for drawing operations.
Generated by Doxygen
276 Data Structure Documentation
3.83.4.8 $penSize
$penSize = 0 [private]
The size of the pen for drawing operations.
3.84 Syslog Class Reference
The system log class of the Felira system.
Public Member Functions
• getEventMask ()• setEventMask ($bitmask)• logPostVariables ()• logError ($text, $data=null)• logErrorWithoutTrace ($text, $data=null)• logWarning ($text, $data=null)• logInfo ($text, $data=null)• logDebug ($text, $data=null)• getLastErrorMessage ()• getLog ()• clearLog ()
Static Public Member Functions
• static get ()
Protected Attributes
• $fileName = null• $logTypeMask = FELIRA_LOG_TYPE_ERROR
Private Member Functions
• __construct ()• logEvent ($type, $text, $data, $timeAndTrace)
Private Attributes
• $lastEventMessage = ''
Static Private Attributes
• static $instance = null
Generated by Doxygen
3.84 Syslog Class Reference 277
3.84.1 Detailed Description
The system log class of the Felira system.
It can be used to log events (errors, warnings, info) into the log file and to access the log file data.
Copyright
Copyright © Miscalis ®
3.84.2 Constructor & Destructor Documentation
3.84.2.1 __construct()
__construct ( ) [private]
No instance of the class can be created.
3.84.3 Member Function Documentation
3.84.3.1 clearLog()
clearLog ( )
Clears the content of the log file. If no log file is present, an empty log file is created.
3.84.3.2 get()
static get ( ) [static]
Returns a system logger instance.
Returns
Felira::Syslog The system logger instance.
Generated by Doxygen
278 Data Structure Documentation
3.84.3.3 getEventMask()
getEventMask ( )
Returns the bit mask of the events that are currently logged.
Returns
int The bit mask, which is a combination of the FELIRA_LOG_TYPE_... flags.
3.84.3.4 getLastErrorMessage()
getLastErrorMessage ( )
Returns the last message (only the message text) that was written to event log. All HTML special chars are escaped,so the resulting text can be displayed on a web page.
Returns
string A string with the last message or an empty string if none.
3.84.3.5 getLog()
getLog ( )
Returns an array with the contents of the event log. Empty lines are ignored. All HTML special chars are escaped,so the resulting text can be displayed on a web page.
Returns
array An array with the contents of the event log.
3.84.3.6 logDebug()
logDebug (
$text,
$data = null )
Writes the specified debugging message to the log file.
Parameters
string $text The info message.
string $data Additional data to log (optional).Generated by Doxygen
3.84 Syslog Class Reference 279
3.84.3.7 logError()
logError (
$text,
$data = null )
Writes the specified error message to the log file.
Parameters
string $text The error message.
string $data Additional data to log (optional).
3.84.3.8 logErrorWithoutTrace()
logErrorWithoutTrace (
$text,
$data = null )
Writes the specified error message to the log file without adding a stack trace.
Parameters
string $text The error message.
string $data Additional data to log (optional).
3.84.3.9 logEvent()
logEvent (
$type,
$text,
$data,
$timeAndTrace ) [private]
Logs the specified event data to the database. This function is used internally to log all event types.
Generated by Doxygen
280 Data Structure Documentation
Parameters
int $type The type of event to log. It must be one (or a combination) of the followingconstants:FELIRA_LOG_TYPE_ERROR: An error is reportedFELIRA_LOG_TYPE_WARNING: A warning is reportFELIRA_LOG_TYPE_INFO: Some information is reportedFELIRA_LOG_TYPE_DEBUG: Debug information is reported
string $text The event description.
string | null $data Additional event data to log (null for none).
bool $timeAndTrace true to add timestamp and stack trace, false otherwise.
3.84.3.10 logInfo()
logInfo (
$text,
$data = null )
Writes the specified informational message to the log file.
Parameters
string $text The info message.
string $data Additional data to log (optional).
3.84.3.11 logPostVariables()
logPostVariables ( )
Write the POST variables to the log file
3.84.3.12 logWarning()
logWarning (
$text,
$data = null )
Writes the specified warning message to the log file.
Parameters
string $text The warning message.
string $data Additional data to log (optional).
Generated by Doxygen
3.84 Syslog Class Reference 281
3.84.3.13 setEventMask()
setEventMask (
$bitmask )
Sets the bit mask of the events that are to be logged.
Parameters
int $bitmask The bit mask of the events to log. It must be a combination of the following constants:FELIRA_LOG_TYPE_NONE: Nothing is written to the log fileFELIRA_LOG_TYPE_ERROR: Error messages are written to the log fileFELIRA_LOG_TYPE_WARNING: Warnings are written to the log fileFELIRA_LOG_TYPE_INFO: Informational messages are written to the log fileFELIRA_LOG_TYPE_DEBUG: Debug information (such as SQL statements) are written tothe log fileWarning: Specifying FELIRA_LOG_TYPE_DEBUG produces a lot of output and writes userpasswords to the log file as well!
3.84.4 Field Documentation
3.84.4.1 $fileName
$fileName = null [protected]
The full path and file name of the log file. It is usually located in the Felira log file directory.
3.84.4.2 $instance
Felira Syslog $instance = null [static], [private]
The current (and only) instance of the Syslog object.
3.84.4.3 $lastEventMessage
$lastEventMessage = '' [private]
The variables that keeps the last message that was written to the event log.
Generated by Doxygen
282 Data Structure Documentation
3.84.4.4 $logTypeMask
$logTypeMask = FELIRA_LOG_TYPE_ERROR [protected]
The bit mask for the type of logged events. It specifies what messages are actually written into the log file.It must be a combination of the following constants:FELIRA_LOG_TYPE_NONE: Nothing is written to the log fileFELIRA_LOG_TYPE_ERROR: Error messages are written to the log fileFELIRA_LOG_TYPE_WARNING: Warnings are written to the log fileFELIRA_LOG_TYPE_INFO: Informational messages are written to the log fileFELIRA_LOG_TYPE_DEBUG: Debug information (such as SQL statements) are written to the log fileWarning: Specifying FELIRA_LOG_TYPE_DEBUG produces a lot of output and writes user passwords to the logfile as well!
3.85 SystemEditor Class Reference
The base class for a Felira system editor.
Inheritance diagram for SystemEditor:
SystemEditor
Module
ModuleLessManager ModuleStyleManager ModuleTemplateManager
Public Member Functions
• __construct ($moduleName, $folderName)
• processBackEndRequest ($action, $object)
• registerCssAndJsFiles (\Felira\Response\BackEnd $response)
Protected Member Functions
• getFileList (\Felira\FileManager $fileManager)
• saveFile ()
Protected Attributes
• $folderName = null
Generated by Doxygen
3.85 SystemEditor Class Reference 283
Additional Inherited Members
3.85.1 Detailed Description
The base class for a Felira system editor.
A system editor is used to edit files in the back-end, like template files or css files.
Copyright
Copyright © Miscalis ®
3.85.2 Constructor & Destructor Documentation
3.85.2.1 __construct()
__construct (
$moduleName,
$folderName )
Creates a new instance of a Felira editor module.
Parameters
string $moduleName The internal name of the module.
string $folderName The name of the folder (relative to the custom page folder) with the files that may beedited with this module.
3.85.3 Member Function Documentation
3.85.3.1 getFileList()
getFileList (
\Felira\FileManager $fileManager ) [protected]
Creates a list of all files in the managed folder of this system editor. The folder is a sub-folder of the "mypage" folder.
Parameters
\Felira\FileManager $fileManager The file manager used to access the files.
Generated by Doxygen
284 Data Structure Documentation
Returns
array An array with the file list.
3.85.3.2 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a back-end request in a system editor.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response::BackEnd|bool|null An instance of a Felira::Response::BackEnd on success, null if the man-ager does not process the request or false if there was an error.
Reimplemented from Module.
3.85.3.3 registerCssAndJsFiles()
registerCssAndJsFiles (
\Felira\Response\BackEnd $response ) [abstract]
Registers the css and js files used for the editor.
Parameters
\Felira\Response\BackEnd $response The response object.
Reimplemented in Module\LessManager, Module\StyleManager, and Module\TemplateManager.
3.85.3.4 saveFile()
saveFile ( ) [protected]
Saves the file data that is specified in the POST data to the specified file.
Generated by Doxygen
3.86 Module\SystemInformation Class Reference 285
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The array index of the file that was saved (and will now be displayed).
3.85.4 Field Documentation
3.85.4.1 $folderName
$folderName = null [protected]
The name of the folder (relative to the custom page folder) with the files that may be edited with this plugin.
3.86 Module\SystemInformation Class Reference
The system information module of the Felira system. It is used to provide and evaluate system information in theback-end.
Inheritance diagram for Module\SystemInformation:
ModuleSystemInformation
Module
Public Member Functions
• __construct ()
• processBackEndRequest ($action, $object)
Private Member Functions
• getPHPInformation ()
• getSystemInformation ()
• createDataItem ($key, $value, $status=0, $imageUrl=null)
Generated by Doxygen
286 Data Structure Documentation
Additional Inherited Members
3.86.1 Detailed Description
The system information module of the Felira system. It is used to provide and evaluate system information in theback-end.
Copyright
Copyright © Miscalis ®
3.86.2 Constructor & Destructor Documentation
3.86.2.1 __construct()
__construct ( )
Creates a new instance of the Felira system information manager module.
3.86.3 Member Function Documentation
3.86.3.1 createDataItem()
createDataItem (
$key,
$value,
$status = 0,
$imageUrl = null ) [private]
Creates a data item for the back-end system info page.
Parameters
string $key The key (name of the item).
string $value The value of the item.
int $status The status of the value (0 = none, 1 = error, 2 = warning, 3 = success).
string $imageUrl The URL of a small (16x16) logo image to be displayed (empty by default).
Returns
array An array with the item data.
Generated by Doxygen
3.87 Template Class Reference 287
3.86.3.2 getPHPInformation()
getPHPInformation ( ) [private]
Returns the PHP information data.
Returns
array The PHP data
3.86.3.3 getSystemInformation()
getSystemInformation ( ) [private]
Returns the system information data.
Returns
array The system data
3.86.3.4 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the System Information section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.87 Template Class Reference
The template manager of the Felira system.
Generated by Doxygen
288 Data Structure Documentation
Inheritance diagram for Template:
Template
DataObject
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getTemplates ()• getTemplateOptionsArray ()• deleteTemplate ($id)
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• createEditView ($action, $templateId)• createConfigView ($action, $templateId)• createListView ()
Additional Inherited Members
3.87.1 Detailed Description
The template manager of the Felira system.
It is used to manage all user-defined template objects (not the template files).
Copyright
Copyright © Miscalis ®
3.87.2 Constructor & Destructor Documentation
Generated by Doxygen
3.87 Template Class Reference 289
3.87.2.1 __construct()
__construct ( )
Creates a new instance of the Felira template manager.
3.87.3 Member Function Documentation
3.87.3.1 createConfigView()
createConfigView (
$action,
$templateId ) [private]
Creates the template element configuration view and returns a back-end response for it.
Parameters
string $action The action ("newelement" or "elements").
integer $template←↩
IdThe database id of the template to create the editor view for.
3.87.3.2 createEditView()
createEditView (
$action,
$templateId ) [private]
Creates the template editor view and returns a back-end response for it.
Parameters
string $action The action ("edit" or "new").
integer $template←↩
IdThe database id of the template to create the editor view for (or 0 for "new" action).
3.87.3.3 createListView()
createListView ( ) [private]
Creates the template list view and returns a back-end response for it.
Generated by Doxygen
290 Data Structure Documentation
3.87.3.4 deleteTemplate()
deleteTemplate (
$id )
Deletes the specified template and all assigned data, if the template is not in use.
Parameters
int $id The database id of the template to delete.
Returns
bool true if the operation was successful, false otherwise.
3.87.3.5 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.87.3.6 getTemplateOptionsArray()
getTemplateOptionsArray ( )
Returns a list of all templates in the format that is used to creation combo box options lists.
Returns
array A list of templates (to use in a combo box).
3.87.3.7 getTemplates()
getTemplates ( )
Returns all templates from the database, ordered by template name.
Returns
array An array with all templates or an empty array on error.
3.87.3.8 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Templates section.
Generated by Doxygen
3.88 TemplateCache Class Reference 291
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.88 TemplateCache Class Reference
The template cache manager of the Felira system.
Inheritance diagram for TemplateCache:
TemplateCache
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getCacheInformation ()• clear ()
Additional Inherited Members
3.88.1 Detailed Description
The template cache manager of the Felira system.
It is used to manage the template cache.
Copyright
Copyright © Miscalis ®
3.88.2 Constructor & Destructor Documentation
Generated by Doxygen
292 Data Structure Documentation
3.88.2.1 __construct()
__construct ( )
Creates a new instance of the Felira cache manager.
3.88.3 Member Function Documentation
3.88.3.1 clear()
clear ( )
Clears the template cache.
Returns
true on success, false otherwise.
3.88.3.2 getCacheInformation()
getCacheInformation ( )
Returns an array with a list of files in the Felira cache directory.
See also
Felira::FileManager::getFileList
Returns
array An array with the list of files in the cache directory or an empty array on error.
3.88.3.3 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Template Cache section.
Generated by Doxygen
3.89 Module\TemplateManager Class Reference 293
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.89 Module\TemplateManager Class Reference
The template file manager module of the Felira system. It provides online template file editing.
Inheritance diagram for Module\TemplateManager:
ModuleTemplateManager
SystemEditor
Module
Public Member Functions
• __construct ()• registerCssAndJsFiles (\Felira\Response\BackEnd $response)
Additional Inherited Members
3.89.1 Detailed Description
The template file manager module of the Felira system. It provides online template file editing.
Copyright
Copyright © Miscalis ®
3.89.2 Constructor & Destructor Documentation
Generated by Doxygen
294 Data Structure Documentation
3.89.2.1 __construct()
__construct ( )
Creates a new instance of the Felira style manager module.
3.89.3 Member Function Documentation
3.89.3.1 registerCssAndJsFiles()
registerCssAndJsFiles (
\Felira\Response\BackEnd $response )
Registers the used css and js files for the editor.
Parameters
\Felira\Response\BackEnd $response The response processor.
Reimplemented from SystemEditor.
3.90 Tile Class Reference
The tile class for the back-end tile system.
Public Member Functions
• setObject ($object)• setIcon ($url)• setDeleteLink ($url, $title, $message)• setTitle ($title)• setTemplate ($template)
Data Fields
• $title = ''• $object = null• $iconUrl = false• $template = ''• $deleteLink = false
Generated by Doxygen
3.90 Tile Class Reference 295
3.90.1 Detailed Description
The tile class for the back-end tile system.
It encapsulates a single tile for the back-end area.
Copyright
Copyright © Miscalis ®
3.90.2 Member Function Documentation
3.90.2.1 setDeleteLink()
setDeleteLink (
$url,
$title,
$message )
Sets the url of the delete link for the tile.
Parameters
string $url The absolute url of the delete action as string or false, if none.
string $title The link title for the delete link.
string $message The warning message for the deletion.
3.90.2.2 setIcon()
setIcon (
$url )
Sets the url of the icon of the tile.
Parameters
string $url The absolute url of the tile icon as string.
3.90.2.3 setObject()
setObject (
$object )
Generated by Doxygen
296 Data Structure Documentation
Sets the object that is displayed in the tile.This information is available in the tile template via the FELIRA_OBJECT variable.
Parameters
object $object The object for the tile.
3.90.2.4 setTemplate()
setTemplate (
$template )
Sets the template of the tile.
Parameters
string $template The file name of the template of the tile (relative to the template directory).
3.90.2.5 setTitle()
setTitle (
$title )
Sets the title of the tile.
Parameters
string $title The title of the tile as string (already translated).
3.90.3 Field Documentation
3.90.3.1 $deleteLink
string $deleteLink = false
The url for the deletion of the tile object. false means: No delete option.
3.90.3.2 $iconUrl
string $iconUrl = false
The url of the icon for the tile. false means: No icon.
Generated by Doxygen
3.91 Tile Class Reference 297
3.90.3.3 $object
$object = null
The object data of the object displayed in the tile.
3.90.3.4 $template
string $template = ''
The name of the template for the tile.
3.90.3.5 $title
string $title = ''
The title of the tile (already translated).
3.91 Tile Class Reference
The tile renderer for the Felira system.
Inheritance diagram for Tile:
Tile
Renderer
Public Member Functions
• __construct ()• renderTiles ($tiles)
Additional Inherited Members
3.91.1 Detailed Description
The tile renderer for the Felira system.
. It is used to render the tiles used the back-end.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
298 Data Structure Documentation
3.91.2 Constructor & Destructor Documentation
3.91.2.1 __construct()
__construct ( )
Creates a new instance of the Felira tile renderer.
Reimplemented from Renderer.
3.91.3 Member Function Documentation
3.91.3.1 renderTiles()
renderTiles (
$tiles )
Renders the specified tiles.
Parameters
array $tiles The array of tiles to render.
Returns
array The array of rendered tiles.
3.92 Timer Class Reference
The timer of the Felira system.
Public Member Functions
• __construct ()
• start ()
• stop ()
• getDuration ()
• getTimestamp ()
Generated by Doxygen
3.92 Timer Class Reference 299
Private Attributes
• $startTime = 0• $endTime = 0• $useMicrotime = false
3.92.1 Detailed Description
The timer of the Felira system.
It can be used to measure times.
Copyright
Copyright © Miscalis ®
3.92.2 Constructor & Destructor Documentation
3.92.2.1 __construct()
__construct ( )
Creates a new instance of the Felira timer.
3.92.3 Member Function Documentation
3.92.3.1 getDuration()
getDuration ( )
Returns the duration in milliseconds between the calls to Start() and Stop().
Returns
int The elapsed time in milliseconds.
Generated by Doxygen
300 Data Structure Documentation
3.92.3.2 getTimestamp()
getTimestamp ( )
Returns the current time in milliseconds.
Returns
int The current time in milliseconds.
3.92.3.3 start()
start ( )
Starts the timer.
3.92.3.4 stop()
stop ( )
Stops the timer.
3.92.4 Field Documentation
3.92.4.1 $endTime
$endTime = 0 [private]
The end time.
3.92.4.2 $startTime
$startTime = 0 [private]
The start time.
3.92.4.3 $useMicrotime
$useMicrotime = false [private]
The flag that specifies if the microtime() function is used. This is determined in the constructor.
Generated by Doxygen
3.93 Translator Class Reference 301
3.93 Translator Class Reference
The translator of the Felira system.
Public Member Functions
• __construct ($language)• addBackEndTranslations ()• addFrontEndTranslations ()• translate ($property)• translateParams ($property, $params)• addTranslations ($translationPath)• getTranslations ()
Private Attributes
• $translations = array()• $languageCode = ''
3.93.1 Detailed Description
The translator of the Felira system.
It is used to provide all texts in the system in the requested language (if available).
Copyright
Copyright © Miscalis ®
3.93.2 Constructor & Destructor Documentation
3.93.2.1 __construct()
__construct (
$language )
Creates a new instance of the Felira translator.
Parameters
string $language The ISO 639-1 code of the language.
Generated by Doxygen
302 Data Structure Documentation
3.93.3 Member Function Documentation
3.93.3.1 addBackEndTranslations()
addBackEndTranslations ( )
Loads the translation files for the back-end.
3.93.3.2 addFrontEndTranslations()
addFrontEndTranslations ( )
Loads the translation files for the front-end.
3.93.3.3 addTranslations()
addTranslations (
$translationPath )
Adds the translations in the current language from the specified path to the translation array.
Parameters
string $translationPath The path to the language file(s).
Returns
bool true on success, false otherwise.
3.93.3.4 getTranslations()
getTranslations ( )
Returns the currently loaded translations.
Returns
array An array with the translations.
3.93.3.5 translate()
translate (
$property )
Translates a property.
Generated by Doxygen
3.93 Translator Class Reference 303
Parameters
string $property The property to translate.
Returns
string The translated text or the name of the property if no translation can be found.
3.93.3.6 translateParams()
translateParams (
$property,
$params )
Translates a property and replaces the placeholders by the specified parameters.
Parameters
string $property The property to translate.
array | null $params The array of parameters (may be null).
Returns
string The translated text or the name of the property if no translation can be found.
3.93.4 Field Documentation
3.93.4.1 $languageCode
$languageCode = '' [private]
The language code of the current language.
3.93.4.2 $translations
$translations = array() [private]
The array that contains the translations.
Generated by Doxygen
304 Data Structure Documentation
3.94 Module\UpdateClient Class Reference
The update client of the Felira system.
Inheritance diagram for Module\UpdateClient:
ModuleUpdateClient
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)
Private Member Functions
• updateFromUpload ()• updateFromServer ()• getUpdateFileList ()
Additional Inherited Members
3.94.1 Detailed Description
The update client of the Felira system.
It is used to load and apply updates for the Felira system.
Copyright
Copyright © Miscalis ®
3.94.2 Constructor & Destructor Documentation
3.94.2.1 __construct()
__construct ( )
Creates a new instance of the Felira update client.
Generated by Doxygen
3.94 Module\UpdateClient Class Reference 305
3.94.3 Member Function Documentation
3.94.3.1 getUpdateFileList()
getUpdateFileList ( ) [private]
Returns the list of available update archives from the update server.
Returns
array|bool An array with the files or false on error.
3.94.3.2 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the Update Client section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.94.3.3 updateFromServer()
updateFromServer ( ) [private]
Updates Felira from the Felira update server.
Returns
true on success, false otherwise.
Generated by Doxygen
306 Data Structure Documentation
3.94.3.4 updateFromUpload()
updateFromUpload ( ) [private]
Updates Felira from the uploaded zip archive.
Returns
true on success, false otherwise.
3.95 Updater Class Reference
The Felira updater.
Public Member Functions
• __construct ()• updateFromArchive ($fileName)• updateFromPath ($updatePath)
Private Member Functions
• updateDirectory ($sourcePath, $targetPath)• cleanupDirectory ($sourcePath, $dir, $ignorePlugins=true)• getUpdatePath ()
Private Attributes
• $fileManager = null
3.95.1 Detailed Description
The Felira updater.
The Felira updater can be used to update Felira to the latest version.
Copyright
Copyright © Miscalis ®
3.95.2 Constructor & Destructor Documentation
Generated by Doxygen
3.95 Updater Class Reference 307
3.95.2.1 __construct()
__construct ( )
Creates a new instance of the Felira updater.
3.95.3 Member Function Documentation
3.95.3.1 cleanupDirectory()
cleanupDirectory (
$sourcePath,
$dir,
$ignorePlugins = true ) [private]
Removes all files from the target directory (and its sub-directories) that are not found in the source directory.
Parameters
string $sourcePath The source path to check files against.
string $dir The sub-directories to check the files in.
bool $ignorePlugins The flag that specifies if to ignore files in the plugin folder (true) or to clean them up(false).
Returns
bool true on success, false otherwise.
3.95.3.2 getUpdatePath()
getUpdatePath ( ) [private]
Returns the path for the update directory.
Returns
string The path as string or false on failure.
3.95.3.3 updateDirectory()
updateDirectory (
$sourcePath,
$targetPath ) [private]
Updates a single directory and its sub-directories.
Generated by Doxygen
308 Data Structure Documentation
Parameters
string $sourcePath The source path.
string $targetPath The target path.
Returns
bool true on success, false otherwise.
3.95.3.4 updateFromArchive()
updateFromArchive (
$fileName )
Updates the current installation from the specified archive file (zip).
Parameters
string $fileName The file name of the update archive.
Returns
bool true on success, false otherwise.
3.95.3.5 updateFromPath()
updateFromPath (
$updatePath )
Updates the current installation from the specified path.
Parameters
string $updatePath The path to update the installation from.
Returns
bool true on success, false otherwise.
3.95.4 Field Documentation
Generated by Doxygen
3.96 Module\UpdateServer Class Reference 309
3.95.4.1 $fileManager
Felira FileManager $fileManager = null [private]
The file manager used for all file operations during the update.
3.96 Module\UpdateServer Class Reference
The update server of the Felira system.
Inheritance diagram for Module\UpdateServer:
ModuleUpdateServer
Module
Public Member Functions
• __construct ()• processFrontEndRequest (\Felira\Renderer\FrontEnd $renderer, $action, $object)
Private Member Functions
• extractVersionHistory ($text, $version)
Additional Inherited Members
3.96.1 Detailed Description
The update server of the Felira system.
It is used to provide updates for download via the automatic updater.
Copyright
Copyright © Miscalis ®
3.96.2 Constructor & Destructor Documentation
Generated by Doxygen
310 Data Structure Documentation
3.96.2.1 __construct()
__construct ( )
Creates a new instance of the Felira update server.
3.96.3 Member Function Documentation
3.96.3.1 extractVersionHistory()
extractVersionHistory (
$text,
$version ) [private]
Extracts the part of the specified text that contains the information for the specified version.
Parameters
string $text The text (full version history)
string $version The version to find
Returns
string The text with the version information (may be empty)
3.96.3.2 processFrontEndRequest()
processFrontEndRequest (
\Felira\Renderer\FrontEnd $renderer,
$action,
$object )
Processes a request from the Felira front-end.
Parameters
\Felira\Renderer\FrontEnd $renderer The front-end renderer that can be used to render templates or settemplate variables.
string $action The action to perform.
string | int $object The object to perform the action on.
Generated by Doxygen
3.97 UrlBuilder Class Reference 311
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.97 UrlBuilder Class Reference
The Felira URL builder.
Public Member Functions
• __construct ()• createBackEndURL ($module=null, $action=null, $object=null)• createFrontEndURL ($article=null, $module=null, $action=null, $object=null)• createBackEndLink ($module=null, $action=null, $object=null)
3.97.1 Detailed Description
The Felira URL builder.
This class provides the functions to create URLs for the front-end and the back-end.
Copyright
Copyright © Miscalis ®
3.97.2 Constructor & Destructor Documentation
3.97.2.1 __construct()
__construct ( )
Creates a new instance of the Felira URL builder.
3.97.3 Member Function Documentation
3.97.3.1 createBackEndLink()
createBackEndLink (
$module = null,
$action = null,
$object = null )
Creates a link to the specified module/action/object combination in the back-end if permitted by current user per-missions.
Generated by Doxygen
312 Data Structure Documentation
Parameters
string $module The module that handles the back-end request (optional).
string $action The action to perform (optional).
string | int $object The object to perform the action on (optional).
Returns
string The URL as string or false, if not permitted.
3.97.3.2 createBackEndURL()
createBackEndURL (
$module = null,
$action = null,
$object = null )
Creates an absolute URL to a back-end page.
Parameters
string $module The module to handle the request (optional).
string $action The action to perform (optional).
string | int $object The object to perform the action on (optional).
Returns
string The URL as string.
3.97.3.3 createFrontEndURL()
createFrontEndURL (
$article = null,
$module = null,
$action = null,
$object = null )
Creates an absolute URL to a front-end page.
Parameters
string $article The alias of the article to reference (optional). An underscore (_) may be used if thearticle is unused.
string $module The module to perform an action in (optional).
string $action The action to perform on the front-end page (optional).
string | int $object The object to perform the action on (optional).Generated by Doxygen
3.98 User Class Reference 313
Returns
string The URL as string.
3.98 User Class Reference
The user manager of the Felira system.
Inheritance diagram for User:
User
DataObject
Module
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• authenticate ($username, $password)• saveUser ()• validateMailAddress ($mailAddress, $checkForExisting)• getUsers ($sql=null, $params=null)• getUserById ($userId)• getUserNameOptionsArray ()• deleteUser ($id)• getLocales ()
Protected Member Functions
• getObjectDefinition ()
Private Member Functions
• createListView ()• createEditView ($action, $object)• createRightsEditor ($userId)• getRightsFromUser ($user)• saveUserRights ($userId)
Additional Inherited Members
3.98.1 Detailed Description
The user manager of the Felira system.
It is used to manage all back-end users in the system.
Copyright
Copyright © Miscalis ®
Generated by Doxygen
314 Data Structure Documentation
3.98.2 Constructor & Destructor Documentation
3.98.2.1 __construct()
__construct ( )
Creates a new instance of the Felira user manager.
3.98.3 Member Function Documentation
3.98.3.1 authenticate()
authenticate (
$username,
$password )
Authenticates the specified user.
Parameters
string $username The name (mail address) of the user.
string $password The password of the user.
Returns
array|bool The user object on success, false otherwise.
3.98.3.2 createEditView()
createEditView (
$action,
$object ) [private]
Creates the editor view for the specified user.
Parameters
string $action The action ("edit" or "new").
int $object The database id of the user to edit (unused for "new" action).
Generated by Doxygen
3.98 User Class Reference 315
Returns
Felira::Response::BackEnd A Felira::Response::BackEnd object.
3.98.3.3 createListView()
createListView ( ) [private]
Creates the user list view and returns a back-end response for it.
Returns
Felira::Response::BackEnd A Felira::Response::BackEnd object.
3.98.3.4 createRightsEditor()
createRightsEditor (
$userId ) [private]
Creates the editor view for the specified user.
Parameters
int $user←↩
IdThe database id of the user to edit the rights for.
Returns
Felira::Response::BackEnd A Felira::Response::BackEnd object.
3.98.3.5 deleteUser()
deleteUser (
$id )
Deletes the specified user.
Parameters
int $id The database id of the user to delete.
Generated by Doxygen
316 Data Structure Documentation
Returns
bool true if the operation was successful, false otherwise.
3.98.3.6 getLocales()
getLocales ( )
Returns an array with all locales supported by the system.
Returns
array An array with the locales that can be used for selection fields.
3.98.3.7 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.98.3.8 getRightsFromUser()
getRightsFromUser (
$user ) [private]
Extracts the user permissions for all modules for the specified user.
Parameters
array $user The user object as returned from the getUsers() function.
Returns
array An array with the user permissions. Each entry has the following format:
1. "name": The (translated) name of the module.
2. "actions": An array with the user permissions.
See also
Felira::DataObject::User::getUsers
Generated by Doxygen
3.98 User Class Reference 317
3.98.3.9 getUserById()
getUserById (
$userId )
Loads the specified user.
Parameters
int $user←↩
IdThe database id of the user to load.
Returns
array|null The user on success, null otherwise.
3.98.3.10 getUserNameOptionsArray()
getUserNameOptionsArray ( )
Returns a list of all Felira users in the format that is used to create combo box options lists.
Returns
array The array with the list of users.
3.98.3.11 getUsers()
getUsers (
$sql = null,
$params = null )
Loads all users and their respective user permissions.
Parameters
string | null $sql The select statement used to get the list of users (optional, all users by default).
array | null $params An array with the parameters to be mapped to the prepared statement (optional, if noparameters are specified an unprepared query is used).
Returns
array The list of users on success, an empty array otherwise.
Generated by Doxygen
318 Data Structure Documentation
3.98.3.12 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the User section.
Parameters
string $action The action to perform.
int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.98.3.13 saveUser()
saveUser ( )
Saves the specified user specified in the request data.
Returns
array An array with:
1. true if the operation was successful, false otherwise.
2. The id of the user on success, 0 otherwise.
3.98.3.14 saveUserRights()
saveUserRights (
$userId ) [private]
Saves the user permissions for the specified user.
Generated by Doxygen
3.99 UserEvent Class Reference 319
Parameters
int $user←↩
IdThe database id of the user to save the permissions for.
Returns
bool true if the operation was successful, false otherwise.
3.98.3.15 validateMailAddress()
validateMailAddress (
$mailAddress,
$checkForExisting )
Validate the specified mail address.
Parameters
string $mailAddress The mail address to check.
bool $checkForExisting true to check if a user with this mail address already exists, false otherwise.
Returns
array An array with:
1. true if the mail address is valid, false otherwise.
2. The message token of the error message if the mail address is invalid, null otherwise.
3. An optional array of parameters for the message.
3.99 UserEvent Class Reference
The user event manager of the Felira system.
Inheritance diagram for UserEvent:
UserEvent
DataObject
Module
Generated by Doxygen
320 Data Structure Documentation
Public Member Functions
• __construct ()• processBackEndRequest ($action, $object)• getUserEvents ($limit=0)• clearEvents ()• logUserEvent ($userId, $eventType, $eventToken, $eventData=null)
Data Fields
• const UET_SUCCESS = 0• const UET_WARNING = 1• const UET_ERROR = 2• const UET_INFO = 3
Protected Member Functions
• getObjectDefinition ()
Additional Inherited Members
3.99.1 Detailed Description
The user event manager of the Felira system.
It is used to log all user-related events in the system.
Copyright
Copyright © Miscalis ®
3.99.2 Constructor & Destructor Documentation
3.99.2.1 __construct()
__construct ( )
Creates a new instance of the Felira user event manager.
3.99.3 Member Function Documentation
Generated by Doxygen
3.99 UserEvent Class Reference 321
3.99.3.1 clearEvents()
clearEvents ( )
Clears all events from the table.
3.99.3.2 getObjectDefinition()
getObjectDefinition ( ) [protected]
Adds all database fields to the object definition.
Reimplemented from DataObject.
3.99.3.3 getUserEvents()
getUserEvents (
$limit = 0 )
Loads the last specified number of user event entries.
Parameters
int $limit The number of entries to load (optional, all by default).
Returns
array An array with all user event entries or an empty array.
3.99.3.4 logUserEvent()
logUserEvent (
$userId,
$eventType,
$eventToken,
$eventData = null )
Logs an event for the specified user from the specified request.
Parameters
int $userId The database id of the user
int $eventType The type of event to log. One of the UET_∗ constants.
string $eventToken The translation token of the event text.
string $eventData Additional event data (text).
Generated by Doxygen
322 Data Structure Documentation
Returns
bool true on success, false otherwise.
3.99.3.5 processBackEndRequest()
processBackEndRequest (
$action,
$object )
Processes a request in the user event section.
Parameters
string $action The action to perform.
string | int $object The object to perform the action on.
Returns
Felira::Response|bool|null An instance of a Felira::Response on success, null if the manager does not processthe request or false if there was an error.
Reimplemented from Module.
3.99.4 Field Documentation
3.99.4.1 UET_ERROR
const UET_ERROR = 2
The event type code for "Error" events.
3.99.4.2 UET_INFO
const UET_INFO = 3
The event type code for informational events.
3.99.4.3 UET_SUCCESS
const UET_SUCCESS = 0
The event type code for "Success" events.
Generated by Doxygen
3.100 Video Class Reference 323
3.99.4.4 UET_WARNING
const UET_WARNING = 1
The event type code for "Warning" events.
3.100 Video Class Reference
The content element for a video.
Inheritance diagram for Video:
Video
ContentElement
Module
Public Member Functions
• __construct ()• getUsedFields ()
Protected Member Functions
• prepareElementTemplate (\Felira\Renderer $renderer, $contentElement, $inEditor)
Additional Inherited Members
3.100.1 Detailed Description
The content element for a video.
Copyright
Copyright © Miscalis ®
3.100.2 Constructor & Destructor Documentation
Generated by Doxygen
324 Data Structure Documentation
3.100.2.1 __construct()
__construct ( )
Creates a new instance of a Felira content element.
3.100.3 Member Function Documentation
3.100.3.1 getUsedFields()
getUsedFields ( )
Returns the field names of the content data fields that are used by this content element.
Returns
array An array with the field names or an empty array on error.
Reimplemented from ContentElement.
3.100.3.2 prepareElementTemplate()
prepareElementTemplate (
\Felira\Renderer $renderer,
$contentElement,
$inEditor ) [protected]
Prepares the template variables for rendering.
Parameters
\Felira\Renderer $renderer The renderer that is used to render the content element.
array $contentElement The data of the content element to render.
bool $inEditor The flag that specifies if the content element is rendered for use in theweb site (false) or in the back-end wysiwyg editor (true).
Returns
bool true on success, false on error.
Reimplemented from ContentElement.
Generated by Doxygen
3.101 XML Class Reference 325
3.101 XML Class Reference
The XML response object of the Felira system.
Inheritance diagram for XML:
XML
Response
Public Member Functions
• __construct ()• setXML ($domDocument)
Protected Member Functions
• getResponseData ()
Private Attributes
• $xmlData = ''
Additional Inherited Members
3.101.1 Detailed Description
The XML response object of the Felira system.
It is used deliver an XML document to the client.
Copyright
Copyright © Miscalis ®
3.101.2 Constructor & Destructor Documentation
3.101.2.1 __construct()
__construct ( )
Creates a new instance of an XML response.
Generated by Doxygen
326 Data Structure Documentation
3.101.3 Member Function Documentation
3.101.3.1 getResponseData()
getResponseData ( ) [protected]
Returns the response data.
Returns
string The response data as string.
Reimplemented from Response.
3.101.3.2 setXML()
setXML (
$domDocument )
Sets the xml data.
Parameters
\DOMDocument $domDocument The xml data as DOMDocument.
3.101.4 Field Documentation
3.101.4.1 $xmlData
DOMDocument $xmlData = '' [private]
The xml document data.
Generated by Doxygen
Index
$actionBackEnd, 35
$actionsModule, 193
$breadcrumbsBackEnd, 35
$browserInformationBrowserDetector, 43Renderer, 234
$brushColorSvgFile, 275
$canvasHeightSvgFile, 275
$canvasWidthSvgFile, 275
$charsetResponse, 243
$classLoaderFelira, 113
$columnsObjectList, 200
$componentDataPlugin, 211
$connectorDatabase, 71
$contentElementCacheContentElement, 57
$contentElementManagerArticle, 21
$contentElementRendererArticle, 25
$contentTypeResponse, 243
$cssFilesBackEnd, 35FrontEnd, 141
$dataBinary, 41
$databaseFelira, 113
$dbGeneric, 147
$defaultSelectDataObject, 87
$deleteLinkTile, 296
$displayNameFile, 120
$elementDataManager
Article, 21$elementList
SvgFile, 275$elements
PluginManager, 225$endTime
Timer, 300$fieldDefinitions
DataObject, 87$fileContentTypes
File, 120$fileManager
Updater, 308$fileName
Response, 243Syslog, 281
$fileTypesFile, 121
$folderNameSystemEditor, 285
$fontFamilySvgFile, 275
$fontSizeSvgFile, 275
$frontEndPlugin, 211
$gdInfoImageProcessor, 163
$handleDatabase, 71
$htmlDataHTML, 151
$iconUrlTile, 296
$imageUrlPlugin, 211
$inlineResponse, 243
$instanceEnvironment, 102Request, 239Syslog, 281
$isConnectedDatabase, 71
$isWindowsFileManager, 128
$itemPropDataRichSnippet, 250
$itemTypeData
328 INDEX
RichSnippet, 250$items
ObjectList, 200$jsFiles
BackEnd, 35FrontEnd, 141
$jsonDataJSON, 164
$languageCodeTranslator, 303
$lastEventMessageSyslog, 281
$leftColumnDelimiterGeneric, 147
$listColumnsQueryGeneric, 147
$listConstraintsQueryGeneric, 147
$listDatabasesQueryGeneric, 147
$listTablesQueryGeneric, 147
$logTypeMaskSyslog, 281
$menuBackEndMenu, 39ObjectList, 200
$menuItemsModule, 193
$messageHandlerFelira, 113
$messagesMessageHandler, 182
$moduleBackEnd, 35
$moduleNameModule, 193
$modulesPluginManager, 225
$nameFile, 121
$nameTokenContentElement, 61Plugin, 211
$objectBackEnd, 35Tile, 296
$objectNameFile, 121
$penColorSvgFile, 275
$penSizeSvgFile, 275
$pluginDirectoryModule, 193Plugin, 211
$pluginManagerFelira, 113
$pluginsPluginManager, 225
$relationRelation, 230
$rendererContentElement, 53Extension, 108FrontEnd, 141
$richSnippetManagerArticle, 21
$rightColumnDelimiterGeneric, 147
$sectionsSettings, 262
$sessionFelira, 113
$settingsFelira, 113Settings, 262
$settingsDataSettings, 262
$smartyRenderer, 234
$startTimeTimer, 300
$statusCodeResponse, 243
$systemNameFile, 121
$tableDataObject, 87Relation, 230
$templateBackEnd, 35Tile, 297
$tilesBackEnd, 35
$titleBackEnd, 36Tile, 297
$topLinksObjectList, 200
$translationsTranslator, 303
$translatorFelira, 114
$urlFile, 121
$urlBuilderFelira, 114
$usageCountContentElement, 61
$useMicrotimeTimer, 300
$variablesBackEnd, 36
$versionPlugin, 212
Generated by Doxygen
INDEX 329
$xmlDataXML, 326
__constructArticle, 14, 22ArticleLink, 26BackEnd, 27, 29BackEndMenu, 37Binary, 40BrowserDetector, 42Category, 44ClassLoader, 49ContentElement, 52, 54, 59Database, 64DatabaseManager, 72DataObject, 80ElementData, 91Environment, 96EventLog, 103ExportableObject, 105Extension, 107Felira, 109File, 115FileBrowser, 122FileManager, 124FileStorage, 132FrontEnd, 136, 139Generic, 144GoogleMaps, 148HTML, 151HtmlText, 152Image, 154ImageFilter, 156ImageProcessor, 160JSON, 164Link, 168Login, 169MailTemplate, 174Maintenance, 176, 178Module, 186Module\ContactForm, 51Module\Dashboard, 62Module\DistributionManager, 88Module\FileManager, 129Module\LessManager, 165Module\Sitemap, 266Module\StyleManager, 270Module\SystemInformation, 286Module\TemplateManager, 293Module\UpdateClient, 304Module\UpdateServer, 309MSSQL, 194MySQL, 195ObjectList, 197Plugin, 201–205, 207, 212, 214–219PluginManager, 220Preview, 226Relation, 227Renderer, 231
Request, 235RichSnippet, 245Session, 251Settings, 257SimpleSlider, 263SimpleText, 265Sitemap, 268SvgFile, 271Syslog, 277SystemEditor, 283Template, 288TemplateCache, 291Tile, 298Timer, 299Translator, 301Updater, 306UrlBuilder, 311User, 314UserEvent, 320Video, 323XML, 325
__destructDatabase, 64
activateArticleArticle, 14
addActionModule, 186
addBackEndTranslationsTranslator, 302
addBreadcrumbBackEnd, 30
addCircleSvgFile, 271
addColumnObjectList, 197
addComponentInformationPlugin, 207
addCssFileBackEnd, 31FrontEnd, 139
addDetailedErrorMessageMessageHandler, 179
addDirectActionModule, 186
addDummyActionModule, 187
addErrorMessageMessageHandler, 180
addFieldDefinitionDataObject, 81
addFrontEndTranslationsTranslator, 302
addIncludePathClassLoader, 49
addInfoMessageMessageHandler, 180
addItemObjectList, 198
Generated by Doxygen
330 INDEX
addJsFileBackEnd, 31FrontEnd, 139
addLineSvgFile, 272
addMenuItemModule, 187ObjectList, 198
addMessageMessageHandler, 180
addPopupMenuModule, 188
addRectSvgFile, 272
addRelationRelation, 228
addSuccessMessageMessageHandler, 181
addTextSvgFile, 273
addTileBackEnd, 31
addTopButtonObjectList, 199
addTopMenuBackEndMenu, 38
addTranslationsTranslator, 302
addVariableBackEnd, 32
addWarningMessageMessageHandler, 181
afterRenderArticle, 23ContentElement, 52
applyFilterImageProcessor, 160
ArchiveManager, 11createZip, 11extractZip, 12getArchiveComment, 12
Article, 13, 22$contentElementManager, 21$contentElementRenderer, 25$elementDataManager, 21$richSnippetManager, 21__construct, 14, 22activateArticle, 14afterRender, 23createConfigurationView, 14createEditView, 15createListView, 15createMenuItems, 16createPreview, 16createRichSnippetsEditor, 16deleteArticle, 17duplicateArticle, 17getArticleByAlias, 18
getArticleById, 18getArticleNameOptionsArray, 18getArticles, 19getArticlesByCategory, 19getArticlesForMenu, 19getCategoryForArticle, 20getObjectDefinition, 20loadSingleContentElementData, 20processBackEndRequest, 21renderArticle, 23renderArticles, 23
ArticleLink, 25__construct, 26getUsedFields, 26prepareElementTemplate, 26
authenticateUser, 314
BackEnd, 27, 28, 36$action, 35$breadcrumbs, 35$cssFiles, 35$jsFiles, 35$module, 35$object, 35$template, 35$tiles, 35$title, 36$variables, 36__construct, 27, 29addBreadcrumb, 30addCssFile, 31addJsFile, 31addTile, 31addVariable, 32getAction, 32getCssFiles, 32getJsFiles, 32getModule, 33getObject, 33getResponseData, 33process, 36render, 28setRequestInfo, 33setTemplate, 34setTitle, 34setTitleToken, 34
BackEndMenu, 37$menu, 39__construct, 37addTopMenu, 38createBackEndMenuItems, 38isMenuItemVisible, 38sortMenuArray, 39
backEndRedirectRequest, 236
Binary, 40$data, 41__construct, 40
Generated by Doxygen
INDEX 331
getResponseData, 41setBinaryData, 41
BrowserDetector, 41$browserInformation, 43__construct, 42extractBrowserInformation, 42extractVersionNumber, 42getBrowserInformation, 43
calculateSecurityHashRequest, 236
Category, 43__construct, 44createEditView, 44deleteCategory, 45getCategories, 45getCategoriesWithArticleCount, 45getCategoryByAlias, 45getCategoryByArticleAlias, 46getCategoryById, 46getCategoryNameOptions, 47getCategoryTypeOptions, 47getMainPageCategory, 47getObjectDefinition, 47processBackEndRequest, 47sortCategory, 48verboseCategoryType, 48
checkAddFileToArchiveModule\DistributionManager, 88
checkColumnsDatabaseManager, 72
checkConstraintsDatabaseManager, 73
checkTablesDatabaseManager, 73
ClassLoader, 49__construct, 49addIncludePath, 49loadClass, 50
cleanupDirectoryUpdater, 307
cleanupHtmlRenderer, 231
clearSvgFile, 273TemplateCache, 292
clearEventsUserEvent, 320
clearLogSyslog, 277
compareMemoryEnvironment, 96
connectDatabase, 65
ContentElement, 51, 53, 58$contentElementCache, 57$nameToken, 61$renderer, 53$usageCount, 61
__construct, 52, 54, 59afterRender, 52countUse, 59deleteContentElement, 54getNameToken, 59getObjectDefinition, 55getUsedFields, 59loadContentElementAssignments, 55onAfterRender, 60prepareElementTemplate, 60processBackEndRequest, 55render, 61renderContentElement, 52saveContentElements, 57
convertFileListToOptionListFileManager, 124
copyFileFileManager, 124
countUseContentElement, 59
createActionObjectList, 199
createAliasDataObject, 81
createBackEndLinkUrlBuilder, 311
createBackEndMenuItemsBackEndMenu, 38
createBackEndURLUrlBuilder, 312
createConfigurationViewArticle, 14
createConfigViewTemplate, 289
createDataItemModule\SystemInformation, 286
createDistributionArchiveModule\DistributionManager, 89
createDistributionItemsModule\DistributionManager, 89
createEditViewArticle, 15Category, 44ImageFilter, 156MailTemplate, 174Template, 289User, 314
createFrontEndURLUrlBuilder, 312
createItemPropRichSnippet, 245
createItemTypeRichSnippet, 245
createListViewArticle, 15ImageFilter, 157MailTemplate, 174Template, 289
Generated by Doxygen
332 INDEX
User, 315createMenuItems
Article, 16createNewObject
DataObject, 82createPreview
Article, 16createResponse
FrontEnd, 142createRichSnippetsEditor
Article, 16createRightsEditor
User, 315createScript
DatabaseManager, 74createSitemapLinks
Sitemap, 268createZip
ArchiveManager, 11cropImage
ImageProcessor, 160
Database, 63$connector, 71$handle, 71$isConnected, 71__construct, 64__destruct, 64connect, 65disconnect, 65escapeColumn, 65executeCommand, 65executeCommandExtendedParam, 66executeQuery, 66getDatabaseType, 67getLastInsertId, 67isConnected, 67listColumns, 68listConstraints, 69listDatabases, 69listTables, 69logQuery, 69transactionCommit, 70transactionRollBack, 70transactionStart, 70
DatabaseManager, 71__construct, 72checkColumns, 72checkConstraints, 73checkTables, 73createScript, 74getColumnDataType, 74getCreateColumnStatement, 74getCreateConstraintStatement, 75getCreateTableStatement, 75getDropColumnStatement, 75getDropConstraintStatement, 76getDropTableStatement, 76getModifyColumnStatement, 77
getNotifications, 77getQueuedCommands, 77performDatabaseUpdate, 78processBackEndRequest, 78
DataObject, 79$defaultSelect, 87$fieldDefinitions, 87$table, 87__construct, 80addFieldDefinition, 81createAlias, 81createNewObject, 82deleteObject, 82escapeObjectStrings, 82getDefinedFields, 83getObjectDefinition, 83getTableName, 83hideFieldDefinition, 83loadObjects, 84loadSingleObject, 84performInsert, 84performUpdate, 85processObjectData, 85saveObject, 86setFieldOptions, 86
deleteFile, 115
deleteArticleArticle, 17
deleteCategoryCategory, 45
deleteContentElementContentElement, 54
deleteCustomDataSession, 252
deleteFileFileManager, 125FileStorage, 132
deleteObjectDataObject, 82
deletePathFileManager, 125
deleteRelationRelation, 228
deleteTemplateTemplate, 289
deleteUserUser, 315
disableSettingSettings, 258
disconnectDatabase, 65
duplicateArticleArticle, 17
duplicateElementsElementData, 91
ElementData, 90__construct, 91
Generated by Doxygen
INDEX 333
duplicateElements, 91getAllElementsWithImages, 92getElementsForArticle, 92getObjectDefinition, 92loadOrCreateElementData, 92processBackEndRequest, 93processElementField, 93saveElementData, 94saveMultipleElementData, 94
Environment, 95$instance, 102__construct, 96compareMemory, 96get, 96getDocumentRoot, 97getGDVersion, 97getMaxScriptExecutionTime, 97getMaxScriptInputTime, 97getMemoryLimit, 97getOperatingSystem, 98getPeakMemoryUsage, 98getPHPIniFile, 98getPHPInterface, 98getPHPVersion, 99getPOSTLimit, 99getServerSoftware, 99getSessionCookieLifetime, 99getSessionDataLifetime, 100getSizeInBytes, 100getSystemIdentifier, 100getTempDir, 100getTotalUploadLimit, 101getUploadLimit, 101getZendVersion, 101isModHeadersInstalled, 101isModRewriteInstalled, 102isWindows, 102
escapeColumnDatabase, 65Generic, 144
escapeObjectStringsDataObject, 82
EventLog, 103__construct, 103getNotifications, 103processBackEndRequest, 104
executeCommandDatabase, 65
executeCommandExtendedParamDatabase, 66
executeQueryDatabase, 66
ExportableObject, 105__construct, 105generateDefaultCSV, 106generateExportList, 106
Extension, 107$renderer, 108
__construct, 107tagFeliraArticle, 108tagFeliraImage, 108
extractBrowserInformationBrowserDetector, 42
extractVersionHistoryModule\UpdateServer, 310
extractVersionNumberBrowserDetector, 42
extractZipArchiveManager, 12
Felira, 108$classLoader, 113$database, 113$messageHandler, 113$pluginManager, 113$session, 113$settings, 113$translator, 114$urlBuilder, 114__construct, 109getClassLoader, 110getDatabase, 110getMessageHandler, 110getMyPagePath, 110getMyPageUrl, 110getPluginManager, 111getSession, 111getSettingsManager, 111getTranslator, 111getURLBuilder, 112renderBackEnd, 112renderFrontEnd, 112renderPreview, 112
FELIRA_MESSAGE_ERRORMessageHandler, 183
FELIRA_MESSAGE_INFOMessageHandler, 183
FELIRA_MESSAGE_SUCCESSMessageHandler, 183
FELIRA_MESSAGE_WARNINGMessageHandler, 183
File, 114$displayName, 120$fileContentTypes, 120$fileTypes, 121$name, 121$objectName, 121$systemName, 121$url, 121__construct, 115delete, 115getAccessTime, 116getCreationTime, 116getDisplayName, 116getExtension, 116getModificationTime, 116getName, 117
Generated by Doxygen
334 INDEX
getObjectName, 117getPermissions, 117getSize, 117getSystemName, 118getType, 118getUrl, 118isDirectory, 118isReadable, 119read, 119setDisplayName, 119setUrl, 119verbosePermission, 120
FileBrowser, 122__construct, 122processBackEndRequest, 122
FileManager, 123$isWindows, 128__construct, 124convertFileListToOptionList, 124copyFile, 124deleteFile, 125deletePath, 125getDirectoryList, 126getFileList, 126getSystemName, 127isDirectory, 127processFileUpload, 127touchFiles, 128writeFileWithBackup, 128
FileStorage, 131__construct, 132deleteFile, 132getFile, 133getFiles, 133getObjectDefinition, 133getStorageTypes, 133processBackEndRequest, 134retrieveFile, 134storeFile, 135verboseFileStorageType, 135
FrontEnd, 135, 138, 141$cssFiles, 141$jsFiles, 141$renderer, 141__construct, 136, 139addCssFile, 139addJsFile, 139createResponse, 142getCssFiles, 139getJsFiles, 140getRenderer, 140getResponseData, 140process, 142processAjaxRequest, 142processRequest, 142render, 136renderSinglePager, 137renderWebsite, 137
frontEndRedirectRequest, 236
generateDefaultCSVExportableObject, 106
generateExportListExportableObject, 106
Generic, 143$db, 147$leftColumnDelimiter, 147$listColumnsQuery, 147$listConstraintsQuery, 147$listDatabasesQuery, 147$listTablesQuery, 147$rightColumnDelimiter, 147__construct, 144escapeColumn, 144getDatabase, 145getListColumnsQuery, 145getListConstraintsQuery, 145getListDatabasesQuery, 145getListTablesQuery, 146getPDOInstance, 146getType, 146
getEnvironment, 96Request, 237Syslog, 277
getAccessTimeFile, 116
getActionBackEnd, 32
getAllElementsWithImagesElementData, 92
getArchiveCommentArchiveManager, 12
getArticleByAliasArticle, 18
getArticleByIdArticle, 18
getArticleNameOptionsArrayArticle, 18
getArticlesArticle, 19
getArticlesByCategoryArticle, 19
getArticlesForMenuArticle, 19
getBrowserInformationBrowserDetector, 43
getCacheInformationTemplateCache, 292
getCategoriesCategory, 45
getCategoriesWithArticleCountCategory, 45
getCategoryByAliasCategory, 45
getCategoryByArticleAlias
Generated by Doxygen
INDEX 335
Category, 46getCategoryById
Category, 46getCategoryForArticle
Article, 20getCategoryNameOptions
Category, 47getCategoryTypeOptions
Category, 47getCharacterSet
Response, 240getClassLoader
Felira, 110getColumnDataType
DatabaseManager, 74getComponentInformation
Plugin, 208getContentElement
PluginManager, 221getContentElementOptionsArray
PluginManager, 221getContentElements
PluginManager, 221getContentType
Response, 241getCreateColumnStatement
DatabaseManager, 74getCreateConstraintStatement
DatabaseManager, 75getCreateTableStatement
DatabaseManager, 75getCreationTime
File, 116getCssFiles
BackEnd, 32FrontEnd, 139
getCurrentPageDataSession, 252
getCustomDataSession, 252
getDataArraySession, 253
getDatabaseFelira, 110Generic, 145
getDatabaseTypeDatabase, 67
getDefaultPageLogin, 170
getDefaultTypeNamePluginManager, 221
getDefinedFieldsDataObject, 83Relation, 229
getDirectoryListFileManager, 126
getDisplayNameFile, 116
getDistributionItemsModule\DistributionManager, 89
getDocumentRootEnvironment, 97
getDropColumnStatementDatabaseManager, 75
getDropConstraintStatementDatabaseManager, 76
getDropTableStatementDatabaseManager, 76
getDurationTimer, 299
getElementsForArticleElementData, 92
getEventMaskSyslog, 277
getExtensionFile, 116
getFileFileStorage, 133
getFileListFileManager, 126Module\FileManager, 130SystemEditor, 283
getFileNameResponse, 241
getFilesFileStorage, 133
getFilterTypesImageFilter, 157
getFirstAllowedActionModule, 188
getGDVersionEnvironment, 97
getGetVariableRequest, 237
getImageFilterByIdImageFilter, 157
getImageFilterByNameImageFilter, 158
getImageFiltersImageFilter, 158
getItemByItemtypeRichSnippet, 246
getItemPropRichSnippet, 246
getItemtypeNameTokenRichSnippet, 247
getJsFilesBackEnd, 32FrontEnd, 140
getJSONDataRequest, 237
getLastErrorMessageSyslog, 278
getLastInsertIdDatabase, 67
getLastMessage
Generated by Doxygen
336 INDEX
MessageHandler, 182getList
ObjectList, 199getListColumnsQuery
Generic, 145getListConstraintsQuery
Generic, 145getListDatabasesQuery
Generic, 145getListTablesQuery
Generic, 146getLocales
User, 316getLog
Syslog, 278getLoginPageCode
Login, 170getMailTemplateById
MailTemplate, 174getMailTemplateList
MailTemplate, 175getMailTemplates
MailTemplate, 175getMainPageCategory
Category, 47getMaxScriptExecutionTime
Environment, 97getMaxScriptInputTime
Environment, 97getMemoryLimit
Environment, 97getMenuItems
Module, 188getMessageCount
MessageHandler, 182getMessageHandler
Felira, 110getMessages
MessageHandler, 182getModificationTime
File, 116getModifyColumnStatement
DatabaseManager, 77getModule
BackEnd, 33PluginManager, 222
getModuleActionsModule, 188
getModuleNameModule, 189
getModulesPluginManager, 222
getMyPagePathFelira, 110
getMyPageUrlFelira, 110
getNameFile, 117
getNameTokenContentElement, 59Plugin, 208
getNotificationsDatabaseManager, 77EventLog, 103Module, 189Settings, 258
getObjectBackEnd, 33
getObjectDefinitionArticle, 20Category, 47ContentElement, 55DataObject, 83ElementData, 92FileStorage, 133ImageFilter, 158MailTemplate, 175RichSnippet, 247Settings, 258Template, 290User, 316UserEvent, 321
getObjectNameFile, 117
getObjectsPluginManager, 222
getOperatingSystemEnvironment, 98
getPDOInstanceGeneric, 146MSSQL, 194MySQL, 196
getPeakMemoryUsageEnvironment, 98
getPermissionsFile, 117
getPHPInformationModule\SystemInformation, 286
getPHPIniFileEnvironment, 98
getPHPInterfaceEnvironment, 98
getPHPVersionEnvironment, 99
getPluginClassesPluginManager, 223
getPluginDirectoryModule, 189Plugin, 208
getPluginIdPlugin, 208
getPluginLogoPlugin, 209
getPluginManagerFelira, 111
getPluginPath
Generated by Doxygen
INDEX 337
Module, 190getPluginTemplatePath
Module, 190getPluginUrl
Module, 190Plugin, 209
getPOSTLimitEnvironment, 99
getPostVariableRequest, 237
getPostVariablesRequest, 238
getQueuedCommandsDatabaseManager, 77
getRemoteIpRequest, 238
getRendererFrontEnd, 140
getResponseDataBackEnd, 33Binary, 41FrontEnd, 140HTML, 151JSON, 164Maintenance, 178Response, 241XML, 326
getRichSnippetDataRichSnippet, 247
getRightsFromUserUser, 316
getSecurityHashSession, 253
getServerSoftwareEnvironment, 99
getSessionFelira, 111
getSessionCookieLifetimeEnvironment, 99
getSessionDataLifetimeEnvironment, 100
getSettingSettings, 259
getSettingsForTemplateSettings, 259
getSettingsManagerFelira, 111
getSizeFile, 117
getSizeInBytesEnvironment, 100
getSnippetDataForArticleRichSnippet, 247
getSnippetItempropOptionArrayRichSnippet, 248
getSnippetItemtypeOptionArrayRichSnippet, 248
getStorageTypes
FileStorage, 133getSystemIdentifier
Environment, 100getSystemInformation
Module\SystemInformation, 287getSystemName
File, 118FileManager, 127
getTableNameDataObject, 83Relation, 229
getTempDirEnvironment, 100
getTemplateDirRenderer, 231
getTemplateOptionsArrayTemplate, 290
getTemplatesTemplate, 290
getTemplateVarsRenderer, 232
getTimestampTimer, 299
getTotalUploadLimitEnvironment, 101
getTranslationPathPlugin, 209
getTranslationsTranslator, 302
getTranslatorFelira, 111
getTypeFile, 118Generic, 146
getUpdateFileListModule\UpdateClient, 305
getUpdatePathUpdater, 307
getUploadLimitEnvironment, 101
getUrlFile, 118
getURLBuilderFelira, 112
getUsedFieldsArticleLink, 26ContentElement, 59GoogleMaps, 149HtmlText, 153Image, 154Link, 168SimpleSlider, 263SimpleText, 265Video, 324
getUserByIdUser, 316
getUserEventsUserEvent, 321
Generated by Doxygen
338 INDEX
getUserIdSession, 253
getUserLocaleSession, 253
getUserNameSession, 254
getUserNameOptionsArrayUser, 317
getUserPermissionsSession, 254
getUsersUser, 317
getVendorPathModule, 190
getVersionPlugin, 209
getZendVersionEnvironment, 101
GoogleMaps, 148__construct, 148getUsedFields, 149onAfterRender, 149prepareElementTemplate, 149
greyscaleImageImageProcessor, 161
hideFieldDefinitionDataObject, 83
HTML, 150$htmlData, 151__construct, 151getResponseData, 151setHTML, 151
HtmlText, 152__construct, 152getUsedFields, 153prepareElementTemplate, 153
Image, 154__construct, 154getUsedFields, 154prepareElementTemplate, 155
ImageFilter, 155__construct, 156createEditView, 156createListView, 157getFilterTypes, 157getImageFilterById, 157getImageFilterByName, 158getImageFilters, 158getObjectDefinition, 158processBackEndRequest, 158verboseFilterType, 159
ImageProcessor, 159$gdInfo, 163__construct, 160applyFilter, 160cropImage, 160greyscaleImage, 161
loadImage, 161resizeImage, 162saveImage, 162
inheritItemTypeRichSnippet, 249
initPlugin, 201–205, 210, 213–219
initSnippetDataRichSnippet, 249
isAjaxRequestRequest, 238
isAllowedSession, 254
isConnectedDatabase, 67
isDirectoryFile, 118FileManager, 127
isMenuItemVisibleBackEndMenu, 38
isModHeadersInstalledEnvironment, 101
isModRewriteInstalledEnvironment, 102
isPostVariableSetRequest, 238
isReadableFile, 119
isUserLoggedInSession, 255
isWindowsEnvironment, 102
JSON, 163$jsonData, 164__construct, 164getResponseData, 164setJsonData, 164
Link, 167__construct, 168getUsedFields, 168prepareElementTemplate, 168
listColumnsDatabase, 68
listConstraintsDatabase, 69
listDatabasesDatabase, 69
listTablesDatabase, 69
loadClassClassLoader, 50
loadContentElementAssignmentsContentElement, 55
loadImageImageProcessor, 161
loadObjectsDataObject, 84
Generated by Doxygen
INDEX 339
loadOrCreateElementDataElementData, 92
loadPluginPluginManager, 223
loadPluginsPluginManager, 223
loadSingleContentElementDataArticle, 20
loadSingleObjectDataObject, 84
logDebugSyslog, 278
logErrorSyslog, 279
logErrorWithoutTraceSyslog, 279
logEventSyslog, 279
Login, 169__construct, 169getDefaultPage, 170getLoginPageCode, 170process, 170
loginSession, 255
logInfoSyslog, 280
logoutSession, 255
logPostVariablesSyslog, 280
logQueryDatabase, 69
logUserEventUserEvent, 321
logWarningSyslog, 280
Mailer, 170sendHtmlMail, 171sendMail, 172validateMailSettings, 172
MailTemplate, 173__construct, 174createEditView, 174createListView, 174getMailTemplateById, 174getMailTemplateList, 175getMailTemplates, 175getObjectDefinition, 175processBackEndRequest, 175
Maintenance, 176, 177__construct, 176, 178getResponseData, 178render, 177
MessageHandler, 178$messages, 182addDetailedErrorMessage, 179addErrorMessage, 180
addInfoMessage, 180addMessage, 180addSuccessMessage, 181addWarningMessage, 181FELIRA_MESSAGE_ERROR, 183FELIRA_MESSAGE_INFO, 183FELIRA_MESSAGE_SUCCESS, 183FELIRA_MESSAGE_WARNING, 183getLastMessage, 182getMessageCount, 182getMessages, 182
Module, 183$actions, 193$menuItems, 193$moduleName, 193$pluginDirectory, 193__construct, 186addAction, 186addDirectAction, 186addDummyAction, 187addMenuItem, 187addPopupMenu, 188getFirstAllowedAction, 188getMenuItems, 188getModuleActions, 188getModuleName, 189getNotifications, 189getPluginDirectory, 189getPluginPath, 190getPluginTemplatePath, 190getPluginUrl, 190getVendorPath, 190processBackEndRequest, 191processFrontEndAjaxRequest, 191processFrontEndRequest, 192setPluginDirectory, 192
Module\ContactForm, 50__construct, 51processFrontEndAjaxRequest, 51
Module\Dashboard, 62__construct, 62processBackEndRequest, 62
Module\DistributionManager, 87__construct, 88checkAddFileToArchive, 88createDistributionArchive, 89createDistributionItems, 89getDistributionItems, 89processBackEndRequest, 90
Module\FileManager, 129__construct, 129getFileList, 130processBackEndRequest, 130processFileManagerRequest, 131
Module\LessManager, 165__construct, 165onAfterSave, 166parsePrivateVariables, 166
Generated by Doxygen
340 INDEX
registerCssAndJsFiles, 166Module\Sitemap, 266
__construct, 266processFrontEndRequest, 267
Module\StyleManager, 269__construct, 270registerCssAndJsFiles, 270
Module\SystemInformation, 285__construct, 286createDataItem, 286getPHPInformation, 286getSystemInformation, 287processBackEndRequest, 287
Module\TemplateManager, 293__construct, 293registerCssAndJsFiles, 294
Module\UpdateClient, 304__construct, 304getUpdateFileList, 305processBackEndRequest, 305updateFromServer, 305updateFromUpload, 305
Module\UpdateServer, 309__construct, 309extractVersionHistory, 310processFrontEndRequest, 310
MSSQL, 193__construct, 194getPDOInstance, 194
MySQL, 195__construct, 195getPDOInstance, 196
ObjectList, 196$columns, 200$items, 200$menu, 200$topLinks, 200__construct, 197addColumn, 197addItem, 198addMenuItem, 198addTopButton, 199createAction, 199getList, 199
onAfterRenderContentElement, 60GoogleMaps, 149SimpleSlider, 263
onAfterSaveModule\LessManager, 166
parsePrivateVariablesModule\LessManager, 166
performDatabaseUpdateDatabaseManager, 78
performInsertDataObject, 84
performUpdate
DataObject, 85Plugin, 200, 201, 203–206, 212–216, 218, 219
$componentData, 211$frontEnd, 211$imageUrl, 211$nameToken, 211$pluginDirectory, 211$version, 212__construct, 201–205, 207, 212, 214–219addComponentInformation, 207getComponentInformation, 208getNameToken, 208getPluginDirectory, 208getPluginId, 208getPluginLogo, 209getPluginUrl, 209getTranslationPath, 209getVersion, 209init, 201–205, 210, 213–219setPluginDirectory, 210setPluginLogo, 210usedInFrontEnd, 211
PluginManager, 220$elements, 225$modules, 225$plugins, 225__construct, 220getContentElement, 221getContentElementOptionsArray, 221getContentElements, 221getDefaultTypeName, 221getModule, 222getModules, 222getObjects, 222getPluginClasses, 223loadPlugin, 223loadPlugins, 223registerContentElement, 224registerModule, 224registerSystemModule, 224
prepareElementTemplateArticleLink, 26ContentElement, 60GoogleMaps, 149HtmlText, 153Image, 155Link, 168SimpleSlider, 264SimpleText, 265Video, 324
prepareTemplateRenderer, 232
Preview, 225__construct, 226render, 226
processBackEnd, 36FrontEnd, 142
Generated by Doxygen
INDEX 341
Login, 170processAjaxRequest
FrontEnd, 142processBackEndRequest
Article, 21Category, 47ContentElement, 55DatabaseManager, 78ElementData, 93EventLog, 104FileBrowser, 122FileStorage, 134ImageFilter, 158MailTemplate, 175Module, 191Module\Dashboard, 62Module\DistributionManager, 90Module\FileManager, 130Module\SystemInformation, 287Module\UpdateClient, 305RichSnippet, 249Settings, 259SystemEditor, 284Template, 290TemplateCache, 292User, 317UserEvent, 322
processElementFieldElementData, 93
processFileManagerRequestModule\FileManager, 131
processFileUploadFileManager, 127
processFrontEndAjaxRequestModule, 191Module\ContactForm, 51
processFrontEndRequestModule, 192Module\Sitemap, 267Module\UpdateServer, 310
processObjectDataDataObject, 85
processRequestFrontEnd, 142
readFile, 119
redirectRequest, 239
registerContentElementPluginManager, 224
registerCssAndJsFilesModule\LessManager, 166Module\StyleManager, 270Module\TemplateManager, 294SystemEditor, 284
registerDefaultSettingsSettings, 260
registerModule
PluginManager, 224registerSetting
Settings, 260registerSystemModule
PluginManager, 224Relation, 226
$relation, 230$table, 230__construct, 227addRelation, 228deleteRelation, 228getDefinedFields, 229getTableName, 229setRelation, 229
renderBackEnd, 28ContentElement, 61FrontEnd, 136Maintenance, 177Preview, 226SvgFile, 273
renderArticleArticle, 23
renderArticlesArticle, 23
renderBackEndFelira, 112
renderContentElementContentElement, 52
Renderer, 230$browserInformation, 234$smarty, 234__construct, 231cleanupHtml, 231getTemplateDir, 231getTemplateVars, 232prepareTemplate, 232renderErrorTemplate, 232renderExplicitTemplate, 232renderTemplate, 233setHTTPStatusCode, 233setTemplateDir, 234setTemplateVar, 234
renderErrorTemplateRenderer, 232
renderExplicitTemplateRenderer, 232
renderFrontEndFelira, 112
renderPreviewFelira, 112
renderSinglePagerFrontEnd, 137
renderSitemapSitemap, 269
renderTemplateRenderer, 233
renderTiles
Generated by Doxygen
342 INDEX
Tile, 298renderWebsite
FrontEnd, 137Request, 235
$instance, 239__construct, 235backEndRedirect, 236calculateSecurityHash, 236frontEndRedirect, 236get, 237getGetVariable, 237getJSONData, 237getPostVariable, 237getPostVariables, 238getRemoteIp, 238isAjaxRequest, 238isPostVariableSet, 238redirect, 239setPostVariable, 239
resizeImageImageProcessor, 162
Response, 240$charset, 243$contentType, 243$fileName, 243$inline, 243$statusCode, 243getCharacterSet, 240getContentType, 241getFileName, 241getResponseData, 241sendResponse, 241setContentType, 242setFileName, 242setStatusCode, 242
retrieveFileFileStorage, 134
RichSnippet, 244$itemPropData, 250$itemTypeData, 250__construct, 245createItemProp, 245createItemType, 245getItemByItemtype, 246getItemProp, 246getItemtypeNameToken, 247getObjectDefinition, 247getRichSnippetData, 247getSnippetDataForArticle, 247getSnippetItempropOptionArray, 248getSnippetItemtypeOptionArray, 248inheritItemType, 249initSnippetData, 249processBackEndRequest, 249saveRichSnippetsData, 250
saveContentElementsContentElement, 57
saveElementData
ElementData, 94saveFile
SystemEditor, 284saveImage
ImageProcessor, 162saveMultipleElementData
ElementData, 94saveObject
DataObject, 86Settings, 260
saveRichSnippetsDataRichSnippet, 250
saveUserUser, 318
saveUserRightsUser, 318
sendHtmlMailMailer, 171
sendMailMailer, 172
sendResponseResponse, 241
Session, 251__construct, 251deleteCustomData, 252getCurrentPageData, 252getCustomData, 252getDataArray, 253getSecurityHash, 253getUserId, 253getUserLocale, 253getUserName, 254getUserPermissions, 254isAllowed, 254isUserLoggedIn, 255login, 255logout, 255setCurrentPageData, 255setCustomData, 256
setBinaryDataBinary, 41
setBrushColorSvgFile, 273
setContentTypeResponse, 242
setCurrentPageDataSession, 255
setCustomDataSession, 256
setDeleteLinkTile, 295
setDisplayNameFile, 119
setEventMaskSyslog, 281
setFieldOptionsDataObject, 86
setFileName
Generated by Doxygen
INDEX 343
Response, 242setFont
SvgFile, 274setHTML
HTML, 151setHTTPStatusCode
Renderer, 233setIcon
Tile, 295setJsonData
JSON, 164setObject
Tile, 295setPenColor
SvgFile, 274setPenSize
SvgFile, 274setPluginDirectory
Module, 192Plugin, 210
setPluginLogoPlugin, 210
setPostVariableRequest, 239
setRelationRelation, 229
setRequestInfoBackEnd, 33
setSettingSettings, 261
setStatusCodeResponse, 242
setTemplateBackEnd, 34Tile, 296
setTemplateDirRenderer, 234
setTemplateVarRenderer, 234
Settings, 256$sections, 262$settings, 262$settingsData, 262__construct, 257disableSetting, 258getNotifications, 258getObjectDefinition, 258getSetting, 259getSettingsForTemplate, 259processBackEndRequest, 259registerDefaultSettings, 260registerSetting, 260saveObject, 260setSetting, 261verifyMaintenanceModeIp, 261verifyXDebug, 262
setTitleBackEnd, 34
Tile, 296setTitleToken
BackEnd, 34setUrl
File, 119setXML
XML, 326SimpleSlider, 262
__construct, 263getUsedFields, 263onAfterRender, 263prepareElementTemplate, 264
SimpleText, 264__construct, 265getUsedFields, 265prepareElementTemplate, 265
Sitemap, 267__construct, 268createSitemapLinks, 268renderSitemap, 269
sortCategoryCategory, 48
sortMenuArrayBackEndMenu, 39
startTimer, 300
stopTimer, 300
storeFileFileStorage, 135
SvgFile, 270$brushColor, 275$canvasHeight, 275$canvasWidth, 275$elementList, 275$fontFamily, 275$fontSize, 275$penColor, 275$penSize, 275__construct, 271addCircle, 271addLine, 272addRect, 272addText, 273clear, 273render, 273setBrushColor, 273setFont, 274setPenColor, 274setPenSize, 274
Syslog, 276$fileName, 281$instance, 281$lastEventMessage, 281$logTypeMask, 281__construct, 277clearLog, 277get, 277
Generated by Doxygen
344 INDEX
getEventMask, 277getLastErrorMessage, 278getLog, 278logDebug, 278logError, 279logErrorWithoutTrace, 279logEvent, 279logInfo, 280logPostVariables, 280logWarning, 280setEventMask, 281
SystemEditor, 282$folderName, 285__construct, 283getFileList, 283processBackEndRequest, 284registerCssAndJsFiles, 284saveFile, 284
tagFeliraArticleExtension, 108
tagFeliraImageExtension, 108
Template, 287__construct, 288createConfigView, 289createEditView, 289createListView, 289deleteTemplate, 289getObjectDefinition, 290getTemplateOptionsArray, 290getTemplates, 290processBackEndRequest, 290
TemplateCache, 291__construct, 291clear, 292getCacheInformation, 292processBackEndRequest, 292
Tile, 294, 297$deleteLink, 296$iconUrl, 296$object, 296$template, 297$title, 297__construct, 298renderTiles, 298setDeleteLink, 295setIcon, 295setObject, 295setTemplate, 296setTitle, 296
Timer, 298$endTime, 300$startTime, 300$useMicrotime, 300__construct, 299getDuration, 299getTimestamp, 299start, 300
stop, 300touchFiles
FileManager, 128transactionCommit
Database, 70transactionRollBack
Database, 70transactionStart
Database, 70translate
Translator, 302translateParams
Translator, 303Translator, 301
$languageCode, 303$translations, 303__construct, 301addBackEndTranslations, 302addFrontEndTranslations, 302addTranslations, 302getTranslations, 302translate, 302translateParams, 303
UET_ERRORUserEvent, 322
UET_INFOUserEvent, 322
UET_SUCCESSUserEvent, 322
UET_WARNINGUserEvent, 322
updateDirectoryUpdater, 307
updateFromArchiveUpdater, 308
updateFromPathUpdater, 308
updateFromServerModule\UpdateClient, 305
updateFromUploadModule\UpdateClient, 305
Updater, 306$fileManager, 308__construct, 306cleanupDirectory, 307getUpdatePath, 307updateDirectory, 307updateFromArchive, 308updateFromPath, 308
UrlBuilder, 311__construct, 311createBackEndLink, 311createBackEndURL, 312createFrontEndURL, 312
usedInFrontEndPlugin, 211
User, 313__construct, 314
Generated by Doxygen
INDEX 345
authenticate, 314createEditView, 314createListView, 315createRightsEditor, 315deleteUser, 315getLocales, 316getObjectDefinition, 316getRightsFromUser, 316getUserById, 316getUserNameOptionsArray, 317getUsers, 317processBackEndRequest, 317saveUser, 318saveUserRights, 318validateMailAddress, 319
UserEvent, 319__construct, 320clearEvents, 320getObjectDefinition, 321getUserEvents, 321logUserEvent, 321processBackEndRequest, 322UET_ERROR, 322UET_INFO, 322UET_SUCCESS, 322UET_WARNING, 322
validateMailAddressUser, 319
validateMailSettingsMailer, 172
verboseCategoryTypeCategory, 48
verboseFileStorageTypeFileStorage, 135
verboseFilterTypeImageFilter, 159
verbosePermissionFile, 120
verifyMaintenanceModeIpSettings, 261
verifyXDebugSettings, 262
Video, 323__construct, 323getUsedFields, 324prepareElementTemplate, 324
writeFileWithBackupFileManager, 128
XML, 325$xmlData, 326__construct, 325getResponseData, 326setXML, 326
Generated by Doxygen