Elgg\Context Class Reference

Public Member Functions
	peek ()
	Get the most recently pushed context value. More...
	push ($context)
	Push a context onto the top of the stack. More...
	pop ()
	Removes and returns the top context string from the stack. More...
	set ($context)
	Sets the page context. More...
	contains ($context)
	Check if this context exists anywhere in the stack. More...
	toArray ()
	Get the entire context stack as an array (e.g. More...
	fromArray (array $stack)
	Overwrite the entire context stack from an array of strings. More...

Detailed Description

Definition at line 27 of file Context.php.

Member Function Documentation

Elgg\Context::contains

(

$context

)

Check if this context exists anywhere in the stack.

This is useful for situations with more than one element in the stack. For example, a widget has a context of 'widget'. If a widget view needs to render itself differently based on being on the dashboard or profile pages, it can check the stack.

Parameters

string

$context

The context string to check for

Returns

bool

Definition at line 92 of file Context.php.

Elgg\Context::fromArray

(

array

$stack

)

Overwrite the entire context stack from an array of strings.

Parameters

string[]

$stack All contexts to be placed on the stack

Returns

void

Definition at line 111 of file Context.php.

Elgg\Context::peek

(

)

Get the most recently pushed context value.

Returns

string|null

Definition at line 36 of file Context.php.

Elgg\Context::pop

(

)

Removes and returns the top context string from the stack.

Returns

string|null

Definition at line 56 of file Context.php.

Elgg\Context::push

(

$context

)

Push a context onto the top of the stack.

Parameters

string

$context

The context string to add to the context stack

Returns

void

Definition at line 47 of file Context.php.

Elgg\Context::set

(

$context

)

Sets the page context.

Parameters

string

$context

The context of the page

Returns

bool

Definition at line 66 of file Context.php.

Elgg\Context::toArray

(

)

Get the entire context stack as an array (e.g.

for backing it up)

Returns

string[]

Definition at line 101 of file Context.php.

---

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

• engine/classes/Elgg/Context.php