dolibarr  21.0.0-alpha
Public Member Functions | List of all members
Controller Class Reference

Class to manage pages. More...

Inheritance diagram for Controller:
Inheritance graph
[legend]

Public Member Functions

 __construct ()
 Constructor. More...
 
 action ()
 Action method is called before html output can be used to manage security and change context. More...
 
 checkAccess ()
 Check current access to controller. More...
 
 display ()
 Display. More...
 
 display404 ()
 Display error template. More...
 
 hookDoAction ($parameters=array())
 Execute hook doActions. More...
 
 hookPrintPageView ($parameters=array())
 Execute hook PrintPageView. More...
 
 loadTemplate ($templateName, $vars=false)
 Load a template .tpl file. More...
 

Detailed Description

Class to manage pages.

Definition at line 28 of file controller.class.php.

Constructor & Destructor Documentation

◆ __construct()

Controller::__construct ( )

Constructor.

Returns
void

Definition at line 65 of file controller.class.php.

Member Function Documentation

◆ action()

Controller::action ( )

Action method is called before html output can be used to manage security and change context.

Returns
int Return integer < 0 on error, > 0 on success

Reimplemented in PropalListController, PartnershipCardController, OrderListController, MemberCardController, LoginController, InvoiceListController, DocumentController, and DefaultController.

Definition at line 81 of file controller.class.php.

◆ checkAccess()

Controller::checkAccess ( )

◆ display()

Controller::display ( )

◆ display404()

Controller::display404 ( )

Display error template.

Returns
void

Definition at line 135 of file controller.class.php.

References loadTemplate().

◆ hookDoAction()

Controller::hookDoAction (   $parameters = array())

Execute hook doActions.

Parameters
array$parametersParameters
Returns
int Return integer < 0 on error, 0 on success, 1 to replace standard code

Definition at line 148 of file controller.class.php.

◆ hookPrintPageView()

Controller::hookPrintPageView (   $parameters = array())

Execute hook PrintPageView.

Parameters
array$parametersParameters
Returns
int Return integer < 0 on error, 0 on success, 1 to replace standard code

Definition at line 171 of file controller.class.php.

◆ loadTemplate()

Controller::loadTemplate (   $templateName,
  $vars = false 
)

Load a template .tpl file.

Parameters
string$templateNameTemplate file name (without the .tpl.php)
mixed$varsData to transmit to template
Returns
bool True if template found, else false

Definition at line 195 of file controller.class.php.

Referenced by display404().


The documentation for this class was generated from the following file: