Collaboration diagram for Context:

Public Member Functions
	initController ()
	Init controller. More...

	addControllerDefinition ($controller, $path, $className)
	Add controller definition. More...

	setControllerFound ()
	Set controller found. More...

	getRootUrl ($controller='', $moreParams='', $addToken=true)
	Get root url. More...

	getControllerUrl ($controller='', $moreParams='', $addToken=true)
	Get controller url according to context. More...

	userIsLog ()
	Check if user is logged. More...

	menuIsActive ($menuName)
	Is menu enabled ? More...

	setError ($errors)
	Set errors. More...

	getErrors ()
	Get errors. More...

	clearErrors ()
	Clear errors. More...

	setEventMessage ($mesgs, $style='mesgs')
	Set event messages in dol_events session object. More...

	setEventMessages ($mesg, $mesgs, $style='mesgs')
	Set event messages in dol_events session object. More...

	loadEventMessages ()
	Load event messages. More...

	clearEventMessages ()
	Clear event messages. More...

	newToken ()
	Return the value of token currently saved into session with name 'newToken'. More...

	getUrlToken ()
	Get token url. More...

	getFormToken ()
	Get token input for form. More...

	getThirdPartyAccountFromLogin ($login, $pass)
	Try to find the third-party account id from. More...

Static Public Member Functions
static	getInstance ()
	Singleton method to create one instance of this object. More...

static	getRootConfigUrl ()
	Get WebPortal root url. More...

static	getPublicControllerUrl ($controller='', $moreParams='', $Tparams=array())
	Generate public controller URL Used for external link (like email or web page) so remove token and contextual behavior associate with current user. More...

static	urlOrigin ($withRequestUri=true, $use_forwarded_host=false)
	Url origin. More...

Public Attributes
	$appliName
	The application name.

	$object
	Current object of page.

Protected Member Functions
	generateNewToken ()
	Generate new token. More...

Private Member Functions
	__construct ()
	Constructor. More...

Detailed Description

Class Context.

Definition at line 32 of file context.class.php.

Constructor & Destructor Documentation

◆ __construct()

Context::__construct ( )

private

Constructor.

Returns: void

Definition at line 158 of file context.class.php.

Member Function Documentation

◆ addControllerDefinition()

Context::addControllerDefinition	(	$controller,
		$path,
		$className
	)

Add controller definition.

Parameters

string	$controller	Name
string	$path	Path
string	$className	Class name

Returns: bool

Definition at line 252 of file context.class.php.

◆ clearErrors()

Context::clearErrors ( )

Clear errors.

Returns: void

Definition at line 496 of file context.class.php.

◆ clearEventMessages()

Context::clearEventMessages ( )

Clear event messages.

Returns: void

Definition at line 582 of file context.class.php.

◆ generateNewToken()

Context::generateNewToken ( )

protected

Generate new token.

Deprecated:: see main

Returns: string

Definition at line 605 of file context.class.php.

References newToken().

◆ getControllerUrl()

Context::getControllerUrl	(	$controller = `''`,
		$moreParams = `''`,
		$addToken = `true`
	)

Get controller url according to context.

Parameters

string	$controller	Controller name
string \| array	$moreParams	More parameters
bool	$addToken	Add token hash only if controller is set

Returns: string

Definition at line 324 of file context.class.php.

Referenced by getRootUrl().

◆ getErrors()

Context::getErrors ( )

Get errors.

Returns: int

Definition at line 481 of file context.class.php.

◆ getFormToken()

Context::getFormToken ( )

Get token input for form.

Returns: string|null

Definition at line 645 of file context.class.php.

References newToken().

◆ getInstance()

static Context::getInstance ( )

static

Singleton method to create one instance of this object.

Returns: Context Instance

Definition at line 197 of file context.class.php.

◆ getPublicControllerUrl()

static Context::getPublicControllerUrl	(	$controller = `''`,
		$moreParams = `''`,
		$Tparams = `array()`
	)

static

Generate public controller URL Used for external link (like email or web page) so remove token and contextual behavior associate with current user.

Parameters

string	$controller	Controller
string \| array	$moreParams	More parameters
array	$Tparams	Parameters

Returns: string

Definition at line 355 of file context.class.php.

◆ getRootConfigUrl()

static Context::getRootConfigUrl ( )

static

Get WebPortal root url.

Returns: string Web Portal root url

Definition at line 285 of file context.class.php.

◆ getRootUrl()

Context::getRootUrl	(	$controller = `''`,
		$moreParams = `''`,
		$addToken = `true`
	)

Get root url.

Parameters

string	$controller	Controller name
string \| array	$moreParams	More parameters
bool	$addToken	Add token hash only if $controller is set

Returns: string

Deprecated:: see getControllerUrl()

Definition at line 311 of file context.class.php.

References getControllerUrl().

◆ getThirdPartyAccountFromLogin()

Context::getThirdPartyAccountFromLogin	(	$login,
		$pass
	)

Try to find the third-party account id from.

Parameters

string	$login	Login
string	$pass	Password

Returns: int Third-party account id || <0 if error

Definition at line 662 of file context.class.php.

◆ getUrlToken()

Context::getUrlToken ( )

Get token url.

Returns: string|null

Definition at line 630 of file context.class.php.

References newToken().

◆ initController()

Context::initController ( )

Init controller.

Returns: void

Definition at line 211 of file context.class.php.

◆ loadEventMessages()

Context::loadEventMessages ( )

Load event messages.

Returns: int

Definition at line 567 of file context.class.php.

◆ menuIsActive()

Context::menuIsActive ( $menuName )

Is menu enabled ?

Parameters

string $menuName Menu name

Returns: bool

Definition at line 450 of file context.class.php.

◆ newToken()

Context::newToken ( )

Return the value of token currently saved into session with name 'newToken'.

This token must be sent by any POST as it will be used by next page for comparison with value in session. This token depends on controller

Returns: string

Definition at line 595 of file context.class.php.

Referenced by generateNewToken(), getFormToken(), and getUrlToken().

◆ setControllerFound()

Context::setControllerFound ( )

Set controller found.

Returns: void

Definition at line 275 of file context.class.php.

◆ setError()

Context::setError ( $errors )

Set errors.

Parameters

array $errors Errors

Returns: void

Definition at line 461 of file context.class.php.

◆ setEventMessage()

Context::setEventMessage	(	$mesgs,
		$style = `'mesgs'`
	)

Set event messages in dol_events session object.

Will be output by calling dol_htmloutput_events. Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.

Parameters

string \| string[]	$mesgs	Message string or array
string	$style	Which style to use ('mesgs' by default, 'warnings', 'errors')

Returns: void

Definition at line 510 of file context.class.php.

◆ setEventMessages()

Context::setEventMessages	(	$mesg,
		$mesgs,
		$style = `'mesgs'`
	)

Set event messages in dol_events session object.

Will be output by calling dol_htmloutput_events. Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.

Parameters

string	$mesg	Message string
array \| null	$mesgs	Message array
string	$style	Which style to use ('mesgs' by default, 'warnings', 'errors')

Returns: void

Definition at line 543 of file context.class.php.

◆ urlOrigin()

static Context::urlOrigin	(	$withRequestUri = `true`,
		$use_forwarded_host = `false`
	)

static

Url origin.

Parameters

bool	$withRequestUri	With request URI
bool	$use_forwarded_host	Use formatted host

Returns: string

Definition at line 409 of file context.class.php.

◆ userIsLog()

Context::userIsLog ( )

Check if user is logged.

Returns: bool

Definition at line 435 of file context.class.php.

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

dolibarr_dev/htdocs/webportal/class/context.class.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addControllerDefinition()

◆ clearErrors()

◆ clearEventMessages()

◆ generateNewToken()

◆ getControllerUrl()

◆ getErrors()

◆ getFormToken()

◆ getInstance()

◆ getPublicControllerUrl()

◆ getRootConfigUrl()

◆ getRootUrl()

◆ getThirdPartyAccountFromLogin()

◆ getUrlToken()

◆ initController()

◆ loadEventMessages()

◆ menuIsActive()

◆ newToken()

◆ setControllerFound()

◆ setError()

◆ setEventMessage()

◆ setEventMessages()

◆ urlOrigin()

◆ userIsLog()