Context Class Reference

Class Context. More...

Collaboration diagram for Context:

Public Member Functions
	initController ()
	Init controller.
	addControllerDefinition ($controller, $path, $className)
	Add controller definition.
	setControllerFound ()
	Set controller found.
	getRootUrl ($controller='', $moreParams='', $addToken=true)
	Get root url.
	getControllerUrl ($controller='', $moreParams='', $addToken=true)
	Get controller url according to context.
	userIsLog ()
	Check if user is logged.
	menuIsActive ($menuName)
	Is menu enabled ?
	setError ($errors)
	Set errors.
	getErrors ()
	Get errors.
	clearErrors ()
	Clear errors.
	setEventMessage ($mesgs, $style='mesgs')
	Set event messages in dol_events session object.
	setEventMessages ($mesg, $mesgs, $style='mesgs')
	Set event messages in dol_events session object.
	loadEventMessages ()
	Load event messages.
	clearEventMessages ()
	Clear event messages.
	newToken ()
	Return the value of token currently saved into session with name 'newToken'.
	getUrlToken ()
	Get token url.
	getFormToken ()
	Get token input for form.
	getThirdPartyAccountFromLogin ($login, $pass)
	Try to find the third-party account id from.

Static Public Member Functions
static	getInstance ()
	Singleton method to create one instance of this object.
static	getRootConfigUrl ()
	Get WebPortal root url.
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.
static	urlOrigin ($withRequestUri=true, $use_forwarded_host=false)
	Url origin.

Public Attributes
	$appliName
	The application name.
	$object
	Current object of page.

Protected Member Functions
	generateNewToken ()
	Generate new token.

Private Member Functions
	__construct ()
	Constructor.

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.

References getControllerUrl(), getDolGlobalString(), GETPOST(), getRootConfigUrl(), and initController().

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.

References setError().

Referenced by initController().

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 dol_hash(), and 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.

References getPublicControllerUrl(), and newToken().

Referenced by __construct(), and 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.

Referenced by DefaultController\action(), DocumentController\action(), InvoiceListController\action(), LoginController\action(), MemberCardController\action(), OrderListController\action(), PartnershipCardController\action(), PropalListController\action(), Controller\checkAccess(), LoginController\checkAccess(), MemberCardController\checkAccess(), PartnershipCardController\checkAccess(), Controller\display(), DefaultController\display(), DocumentController\display(), InvoiceListController\display(), LoginController\display(), MemberCardController\display(), OrderListController\display(), PartnershipCardController\display(), PropalListController\display(), FormCardWebPortal\doActions(), FormWebPortal\getDocumentsLink(), getNavItem(), Controller\hookDoAction(), Controller\hookPrintPageView(), DocumentController\init(), and Controller\loadTemplate().

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.

References getRootConfigUrl().

Referenced by getControllerUrl().

getRootConfigUrl()

static Context::getRootConfigUrl ( )

static

Get WebPortal root url.

Returns

string Web Portal root url

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

References dol_buildpath(), and getDolGlobalString().

Referenced by __construct(), and getPublicControllerUrl().

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.

References dol_syslog(), dol_verifyHash(), getDolGlobalString(), and getEntity().

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.

References addControllerDefinition(), and setControllerFound().

Referenced by __construct().

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.

References newToken().

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

setControllerFound()

Context::setControllerFound

(

)

Set controller found.

Returns

void

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

Referenced by initController().

setError()

Context::setError

(

$errors

)

Set errors.

Parameters

array

$errors

Errors

Returns

void

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

Referenced by addControllerDefinition().

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.

Referenced by setEventMessages().

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.

References dol_print_error(), dol_syslog(), and setEventMessage().

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_20.0/htdocs/webportal/class/context.class.php