Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Elgg\Context Class Reference

Manages a global stack of strings for sharing information about the current execution context. More...

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

Manages a global stack of strings for sharing information about the current execution context.

Views can modify their output based on the local context. You may want to display a list of blogs on a blog page or in a small widget. The rendered output could be different for those two contexts ('blog' vs 'widget').

Pages that pass through the page handling system set the context to the first string after the root url. Example: http://example.org/elgg/bookmarks/ results in the initial context being set to 'bookmarks'.

The context is a stack so that for a widget on a profile, the context stack may contain first 'profile' and then 'widget'.

Warning
The context is not available until the page_handler runs (after the 'init, system' event processing has completed).

private

Since
1.10.0

Definition at line 24 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$contextThe context string to check for
Returns
bool

Definition at line 89 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 108 of file Context.php.

Elgg\Context::peek ( )

Get the most recently pushed context value.

Returns
string|null

Definition at line 33 of file Context.php.

Elgg\Context::pop ( )

Removes and returns the top context string from the stack.

Returns
string|null

Definition at line 53 of file Context.php.

Elgg\Context::push (   $context)

Push a context onto the top of the stack.

Parameters
string$contextThe context string to add to the context stack
Returns
void

Definition at line 44 of file Context.php.

Elgg\Context::set (   $context)

Sets the page context.

Parameters
string$contextThe context of the page
Returns
bool

Definition at line 63 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 98 of file Context.php.


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