SCHLIX\cmsApplication_Basic
Inherited from cmsTemplateViewer
Implements interface_cmsApplication_Basic
Inherits Core, Core_Captcha, Core_EmailSetup, Core_Help, Core_SCHLIXUpdater, Search, simpleSitemap, cmsApplication_List
Implements interface_cmsApplication_Basic
Inherits Core, Core_Captcha, Core_EmailSetup, Core_Help, Core_SCHLIXUpdater, Search, simpleSitemap, cmsApplication_List
Protected Attributes
| protected | $hook_priority | = 10 |
| protected | $disable_frontend_runtime | = false |
| protected | $has_versioning | = false |
| protected | $has_custom_media_header | = false |
| protected | $has_custom_fields | = true |
| protected | $app_description | |
| protected | $disable_app_description_in_page_title | = false |
| protected | $cache | |
| protected | $has_logged_in_user_main_page | = false |
| protected | $data_directories | = NULL |
| protected | $config | = null |
| protected | $disable_app | |
| protected | $app_js_controller | |
| protected | $app_real_class_alias | |
| protected | $app_subclass_suffix | |
| protected | $app_admin_url_path | |
| protected | $app_admin_url_path_no_base | |
| protected | $bread_crumbs | |
| protected | $data_entities | = [] |
| protected | $page_title | |
| protected | $page_meta_keywords | |
| protected | $page_meta_description | |
| protected | $paginationStringFormat | |
| protected | $master_config |
Public Attributes
| public | $full_application_alias |
Protected Methods
| protected | setEntity(string $entity_name, \SCHLIX\cmsSQLQueryBuilder $sqltable) Set the entity (can be a table, or join table, etc)
|
| protected | resetBreadCrumbs() Reset the breadcrumb for this app
|
| protected | addToBreadCrumbs(string $name, string $link) Adds a name and link to breadcrumb
|
| protected | probeFriendlyURLDestination($urlpath) |
| protected | getStartAndEndForItemPagination($pg=1, $perpage=DEFAULT_FRONTEND_ITEMS_PERPAGE, $itemscount) |
| protected boolean | setTable(string $table_alias, string $real_table_name) Set the property of $this->table_{$table_alias} to an instantiated class of cmsSQLTable
|
Public Methods
| public | __construct($app_description) |
| public | refreshApplicationAlias(bool $use_cache=true) Gets the application alias from the database. The purpose of this function is to fix an issue where the regenerated links still refer to the old alias and needed to be saved twice
|
| public int | getHookPriority() Returns the hook priority
|
| public \SCHLIX\cmsSQLQueryBuilder $sqltable | getEntity(string $entity_name) Return the entity (can be a table, or join table, etc)
|
| public array | getPersonalDataByUserID(int $user_id) GDPR - returns an array of personal data by email
|
| public array | getPersonalDataByEmail($email_address) GDPR - returns an array of personal data by email
|
| public | removePersonalDataByUserID(int $user_id, string $request_guid) GDPR - remove personal data by email
|
| public | removePersonalDataByEmail(string $email_address, string $request_guid) GDPR - remove personal data by email
|
| public string | getOriginalFullApplicationAlias() Returns the original full application alias
|
| public string | getFullApplicationAlias() Returns the full application alias, e.g. users.history, for the the purpose of SEO URL
|
| public object | createSubClassInstance(string $sibling) Create a sub class instance. e.g. Newsletters_Admin --> Newsletters_Queues
|
| public | createMasterClassInstance() |
| public string | createMasterClassFriendlyURL(string $str) Create master class friendly URL
|
| public string | createSiblingClassFriendlyURL($sibling, string $str) Create sibling class friendly URL
|
| public string | getDataDirectoryRelativePath(string $key) Return the relative path to CURRENT_SUBSITE_PATH of a specific data directory as defined in the $this->data_directory protected variable
|
| public | getDataDirectoryFullPath(string $key) Return the directory path to CURRENT_SUBSITE_PATH of a specific data directory as defined in the $this->data_directory protected variable
|
| public string | getDataDirectoryURLPath(string $key) Return the absolute URL path of a specific data directory as defined in the $this->data_directory protected variable
|
| public string | getDataFileRelativePath(string $key, string $filename) Return the relative path to CURRENT_SUBSITE_PATH of a file as defined in the $this->data_directory protected variable
|
| public string | getDataFileFullPath(string $key, string $filename) Return the full file path of a file inside $this->data_directory[$key]
|
| public string | getDataFileURLPath(string $key, string $filename) Return encoded absolute URL path of a file inside $this->data_directory[$key]
|
| public string | getDataFileURLPathWithHash(string $key, string $filename) Return encoded absolute URL path of a file inside $this->data_directory[$key]
|
| public array | initializeDataDirectories() Creates all the folder as defined in $this->data_directory if not exists. Returns a string array of errorlist, or an empty/null array if there's no error @global \SCHLIX\cmsLogger $SystemLog
|
| public array | getDataDirectories() Returns a key-value array of data directories as defined in $this->data_directories
|
| public bool | isFrontendRuntimeDisabled() Returns true if this application is a backend only app The value is set from $this->disable_frontend_runtime
|
| public string | getAjaxControllerScript() Get the ajax controller default script file name.
|
| public bool | hasVersioning() Returns true if versioning is enabled
|
| public | hasAuthenticatedUserMainPage() |
| public bool | hasCustomMediaHeader() Returns true if custom media header allowed
|
| public | recordLog($message, $type='info') |
| public | logError($message) |
| public | logInfo($message) |
| public | logWarning($message) |
| public | redirectToOtherAction(string $action, string $protocol=OPT_REDIRECT_DEFAULT) Redirects to internal action, e.g. /action/myaction. Protocol can be OPT_REDIRECT_DEFAULT or OPT_REDIRECT_HTTPS or OPT_REDIRECT_HTTP
|
| public | declarePageLastModified($date) |
| public string | displayBreadCrumbs(string $separator=' »') Displays the breadcrumb
|
| public array | getRawBreadCrumbs() Get raw breadcrumbs array
|
| public array | getBreadCrumbsArray() Returns an array of HTML link of breadcrumbs Deprecatedsince version 2.2.0
since version 2.2.0
|
| public mixed | getConfig(string $key, string $default_value=null) Returns a config value from key for this app Note: this function has been changed as of July 2019. To get the master config, use getMasterConfig method instead. @global \SCHLIX\cmsRegistryConfig $SystemConfig @global \SCHLIX\cmsUser $CurrentUser
|
| public mixed | setConfig(string $key, string $value) Set a config value for this app. Note: this function has been changed as of July 2019. To set the master config, use setMasterConfig method instead. @global \SCHLIX\cmsRegistryConfig $SystemConfig
|
| public mixed | getMasterConfig(string $key, string $default_value=FALSE) Returns a config value from key for the master app
@global \SCHLIX\cmsRegistryConfig $SystemConfig @global \SCHLIX\cmsUser $CurrentUser
|
| public mixed | setMasterConfig(string $key, string $value) Set a config value for this app @global \SCHLIX\cmsRegistryConfig $SystemConfig
|
| public type | getApplicationName() Returns the application name
|
| public | getApplicationNameOnly() |
| public type | getOriginalApplicationDescription() Returns the application description not from the database
|
| public string | getApplicationDescription() Returns the application description from database. If it's empty, then the default application description set in the class will be used instead
|
| public bool | processDataOutputWithMacro(array $data, string $function_name, array $extra_info=NULL) Change output data @global \App\Core_MacroManager $Macros
|
| public | displayPageTitle() Outputs the page title
|
| public | displayPageMetaDescription() Outputs the page meta description
|
| public | displayPageMetaKeywords() Outputs the page metta keywords
|
| public | viewAuthenticatedUserAuthenticationPage() |
| public | viewAuthenticatedUserMainPage() |
| public | viewMainPage() Frontend: view the main page.
|
| public array | interpretFriendlyURL(string $urlpath) Returns an array of command, given $urlpath.
|
| public string | createFriendlyURL(string $str) create SEO friendly URL. Format is action={...}¶m1={....}¶m2={...}
|
| public array | getItemPagination(int $pg, int $pages, string $new_url_query_string, bool $friendly=true) Returns an array of paging items Deprecatedsince version 2.2.0
since version 2.2.0
|
| public array | getItemPaginationArray(int $pg, int $pages, string $new_url_query_string, bool $friendly=true) Returns an array of paging items
|
| public | displayItemPagination($pg, $pages, $new_url_query_string, $friendly=true) |
| public | setPageTitle(string $title) Set the current page title
|
| public string | getPageTitle() Returns the current page title, HTML-encoded UTF-8
|
| public string | getPageMetaDescription() Returns the page meta description
|
| public string | getPageMetaKeywords() Returns the page meta keywords
|
| public | setPageMetaDescription(string $meta_description) Set the page meta description
|
| public | setPageMetaKeywords(string $meta_keywords) Set the page meta keywords
|
| public array | translateMetaOptions(string $serialized_options) Given a serialized string coded from an array of key/value pair, returns a translated array containing the option
|
| public | RunAjax($command) |
| public boolean | Run(string $command) Runs command. If return value is true, then it will be displayed as a full page If return value is false, AJAX method is assumed
|