- Class name: ControllerCore
- This is an abstract class
- Source: classes/controller/Controller.php line 31
- $ajax
- $content_only
- $context
- $controller_type
- $css_files
- $display_footer
- $display_header
- $display_header_javascript
- $js_files
- $json
- $php_errors
- $php_self
- $redirect_after
- $status
- $template
- __construct
- addCSS
- addJS
- addJquery
- addJqueryPlugin
- addJqueryUI
- ajaxDie
- checkAccess
- display
- displayFooter
- displayHeader
- displayHeaderJavaScript
- getController
- init
- initContent
- initCursedPage
- initFooter
- initHeader
- isCached
- isXmlHttpRequest
- myErrorHandler
- postProcess
- redirect
- removeCSS
- removeJS
- run
- setMedia
- setRedirectAfter
- setTemplate
- smartyOutputContent
- viewAccess
public boolean $ajax = false
- Visibility: public
- Source: classes/controller/Controller.php line 61.
protected boolean $content_only = false
- Visibility: protected
- Source: classes/controller/Controller.php line 58.
protected \Context $context
- Visibility: protected
- Source: classes/controller/Controller.php line 34.
public string $controller_type
- Visibility: public
- Source: classes/controller/Controller.php line 76.
public array $css_files = array()
- Visibility: public
- Source: classes/controller/Controller.php line 37.
protected string $display_footer
- Visibility: protected
- Source: classes/controller/Controller.php line 55.
protected boolean $display_header
- Visibility: protected
- Source: classes/controller/Controller.php line 46.
protected boolean $display_header_javascript
- Visibility: protected
- Source: classes/controller/Controller.php line 49.
public array $js_files = array()
- Visibility: public
- Source: classes/controller/Controller.php line 40.
protected boolean $json = false
- Visibility: protected
- Source: classes/controller/Controller.php line 64.
public array $php_errors = array()
- Visibility: public
- This property is static.
- Source: classes/controller/Controller.php line 43.
public string $php_self
- Visibility: public
- Source: classes/controller/Controller.php line 79.
protected string $redirect_after = null
- Visibility: protected
- Source: classes/controller/Controller.php line 73.
protected string $status = ''
- Visibility: protected
- Source: classes/controller/Controller.php line 67.
protected string $template
- Visibility: protected
- Source: classes/controller/Controller.php line 52.
mixed ControllerCore::__construct()
- Visibility: public
- Source: classes/controller/Controller.php line 137
true ControllerCore::addCSS(string|array $css_uri, string $css_media_type, integer|null $offset, boolean $check_path)
Adds a new stylesheet(s) to the page header.
- Visibility: public
- Source: classes/controller/Controller.php line 299
- $css_uri string|array - Path to CSS file, or list of css files like this : array(array(uri => media_type), ...)
- $css_media_type string
- $offset integer|null
- $check_path boolean
void ControllerCore::addJS(string|array $js_uri, boolean $check_path)
Adds a new JavaScript file(s) to the page header.
- Visibility: public
- Source: classes/controller/Controller.php line 373
- $js_uri string|array - Path to JS file or an array like: array(uri, ...)
- $check_path boolean
mixed ControllerCore::addJquery(string|null $version, string|null $folder, boolean $minifier)
Adds jQuery library file to queued JS file list
- Visibility: public
- Source: classes/controller/Controller.php line 447
- $version string|null - jQuery library version
- $folder string|null - jQuery file folder
- $minifier boolean - If set tot true, a minified version will be included.
mixed ControllerCore::addJqueryPlugin(string|array $name, $folder, boolean $css)
Adds jQuery plugin(s) to queued JS file list
- Visibility: public
- Source: classes/controller/Controller.php line 479
- $name string|array
- $folder mixed
- $css boolean
mixed ControllerCore::addJqueryUI(string|array $component, string $theme, boolean $check_dependencies)
Adds jQuery UI component(s) to queued JS file list
- Visibility: public
- Source: classes/controller/Controller.php line 459
- $component string|array
- $theme string
- $check_dependencies boolean
mixed ControllerCore::ajaxDie(string|null $value, string|null $controller, string|null $method)
Dies and echoes output value
- Visibility: protected
- Source: classes/controller/Controller.php line 636
- $value string|null
- $controller string|null
- $method string|null
mixed ControllerCore::checkAccess()
Check if the controller is available for the current user/visitor
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 84
mixed ControllerCore::display()
Displays page view
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 117
mixed ControllerCore::displayFooter(boolean $display)
Sets page header display
- Visibility: public
- Source: classes/controller/Controller.php line 242
- $display boolean
mixed ControllerCore::displayHeader(boolean $display)
Sets page header display
- Visibility: public
- Source: classes/controller/Controller.php line 222
- $display boolean
mixed ControllerCore::displayHeaderJavaScript(boolean $display)
Sets page header javascript display
- Visibility: public
- Source: classes/controller/Controller.php line 232
- $display boolean
\Controller ControllerCore::getController(string $class_name, boolean $auth, boolean $ssl)
returns a new instance of this controller
- Visibility: public
- This method is static.
- Source: classes/controller/Controller.php line 132
- $class_name string
- $auth boolean
- $ssl boolean
mixed ControllerCore::init()
Initialize the page
- Visibility: public
- Source: classes/controller/Controller.php line 94
mixed ControllerCore::initContent()
Assigns Smarty variables for the page main content
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 265
mixed ControllerCore::initCursedPage()
Assigns Smarty variables when access is forbidden
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 270
mixed ControllerCore::initFooter()
Assigns Smarty variables for the page footer
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 275
mixed ControllerCore::initHeader()
Assigns Smarty variables for the page header
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 260
boolean ControllerCore::isCached(string $template, string|null $cache_id, string|null $compile_id)
Checks if a template is cached
- Visibility: protected
- Source: classes/controller/Controller.php line 575
- $template string
- $cache_id string|null - Cache item ID
- $compile_id string|null
boolean ControllerCore::isXmlHttpRequest()
Checks if the controller has been called from XmlHttpRequest (AJAX)
- Visibility: public
- Source: classes/controller/Controller.php line 504
boolean ControllerCore::myErrorHandler(string $errno, string $errstr, string $errfile, integer $errline)
Custom error handler
- Visibility: public
- This method is static.
- Source: classes/controller/Controller.php line 593
- $errno string
- $errstr string
- $errfile string
- $errline integer
mixed ControllerCore::postProcess()
Do the page treatment: process input, process AJAX, etc.
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 112
mixed ControllerCore::redirect()
Redirects to $this->redirect_after after the process if there is no error
- Visibility: protected
- This method is abstract.
- Source: classes/controller/Controller.php line 280
mixed ControllerCore::removeCSS(string|array $css_uri, string $css_media_type, boolean $check_path)
Removes CSS stylesheet(s) from the queued stylesheet list
- Visibility: public
- Source: classes/controller/Controller.php line 339
- $css_uri string|array - Path to CSS file or an array like: array(array(uri => media_type), ...)
- $css_media_type string
- $check_path boolean
mixed ControllerCore::removeJS(string|array $js_uri, boolean $check_path)
Removes JS file(s) from the queued JS file list
- Visibility: public
- Source: classes/controller/Controller.php line 415
- $js_uri string|array - Path to JS file or an array like: array(uri, ...)
- $check_path boolean
mixed ControllerCore::run()
Starts the controller process (this method should not be overridden!)
- Visibility: public
- Source: classes/controller/Controller.php line 168
mixed ControllerCore::setMedia()
Sets default media list for this controller
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 122
mixed ControllerCore::setRedirectAfter($url)
Set $this->redirect_after that will be used by redirect() after the process
- Visibility: public
- Source: classes/controller/Controller.php line 285
- $url mixed
mixed ControllerCore::setTemplate(string $template)
Sets template file for page content output
- Visibility: public
- Source: classes/controller/Controller.php line 252
- $template string
mixed ControllerCore::smartyOutputContent(array|string $content)
Renders controller templates and generates page content
- Visibility: protected
- Source: classes/controller/Controller.php line 516
- $content array|string - Template file(s) to be rendered
mixed ControllerCore::viewAccess()
Check if the current user/visitor has valid view permissions
- Visibility: public
- This method is abstract.
- Source: classes/controller/Controller.php line 89