Controller Class Reference

Class to manage pages. More...

Inheritance diagram for Controller:

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

Detailed Description

Class to manage pages.

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

Constructor & Destructor Documentation

__construct()

Controller::__construct

(

)

Constructor.

Returns

void

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

References $db.

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 DefaultController, DocumentController, DocumentListController, FicheinterListController, InvoiceListController, LoginController, MemberCardController, OrderListController, PartnershipCardController, PropalListController, SharedDocumentsController, TicketListController, and ViewImageController.

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

References hookDoAction().

checkAccess()

Controller::checkAccess

(

)

Check current access to controller.

Returns

bool

Reimplemented in DefaultController, DocumentController, DocumentListController, FicheinterListController, InvoiceListController, LoginController, MemberCardController, OrderListController, PartnershipCardController, PropalListController, SharedDocumentsController, TicketListController, and ViewImageController.

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

References $context, and Context\getInstance().

display()

Controller::display

(

)

Display.

Returns

void

Reimplemented in AbstractCardController, DefaultController, DocumentController, DocumentListController, FicheinterListController, InvoiceListController, LoginController, OrderListController, PropalListController, SharedDocumentsController, and TicketListController.

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

References $context, Context\getInstance(), hookPrintPageView(), and loadTemplate().

display404()

Controller::display404

(

)

Display error template.

Returns

void

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

References loadTemplate().

Referenced by AbstractCardController\display(), DefaultController\display(), DocumentListController\display(), FicheinterListController\display(), InvoiceListController\display(), LoginController\display(), OrderListController\display(), PropalListController\display(), SharedDocumentsController\display(), and TicketListController\display().

hookDoAction()

Controller::hookDoAction

(

$parameters = array()

)

Execute hook doActions.

Parameters

array<string,mixed>

$parameters Parameters

Returns

int Return integer < 0 on error, 0 on success, 1 to replace standard code

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

References $context, and Context\getInstance().

Referenced by action(), DefaultController\action(), FicheinterListController\action(), InvoiceListController\action(), LoginController\action(), MemberCardController\action(), OrderListController\action(), PartnershipCardController\action(), PropalListController\action(), and TicketListController\action().

hookPrintPageView()

Controller::hookPrintPageView

(

$parameters = array()

)

Execute hook PrintPageView.

Parameters

array<string,mixed>

$parameters Parameters

Returns

int Return integer < 0 on error, 0 on success, 1 to replace standard code

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

References $context, and Context\getInstance().

Referenced by AbstractCardController\display(), display(), DefaultController\display(), FicheinterListController\display(), InvoiceListController\display(), LoginController\display(), OrderListController\display(), PropalListController\display(), and TicketListController\display().

loadTemplate()

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

Load a template .tpl file.

Parameters

string	$templateName	Template file name (without the .tpl.php)
mixed	$vars	Data to transmit to template

Returns

bool True if template found, else false

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

References $conf, $context, and Context\getInstance().

Referenced by AbstractCardController\display(), display(), DefaultController\display(), DocumentListController\display(), FicheinterListController\display(), InvoiceListController\display(), LoginController\display(), OrderListController\display(), PropalListController\display(), SharedDocumentsController\display(), TicketListController\display(), and display404().

---

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

• dolibarr_dev/htdocs/webportal/class/controller.class.php