Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Namespaces | Functions | Variables
pageowner.php File Reference

Go to the source code of this file.

Namespaces

 Elgg\Core
 Activate a plugin or plugins.
 

Functions

 elgg_get_page_owner_guid ($guid=0)
 Gets the guid of the entity that owns the current page. More...
 
 elgg_get_page_owner_entity ()
 Gets the owner entity for the current page. More...
 
 elgg_set_page_owner_guid ($guid)
 Set the guid of the entity that owns this page. More...
 
 default_page_owner_handler ($hook, $entity_type, $returnvalue, $params)
 Sets the page owner based on request. More...
 
 elgg_set_context ($context)
 Sets the page context. More...
 
 elgg_get_context ()
 Get the current context. More...
 
 elgg_push_context ($context)
 Push a context onto the top of the stack. More...
 
 elgg_pop_context ()
 Removes and returns the top context string from the stack. More...
 
 elgg_in_context ($context)
 Check if this context exists anywhere in the stack. More...
 
 elgg_get_context_stack ()
 Get the entire context stack (e.g. More...
 
 elgg_set_context_stack (array $stack)
 Set the entire context stack. More...
 
 _elgg_set_initial_context (\Elgg\Http\Request $request)
 Set an initial context if using index.php front controller. More...
 
 page_owner_boot ()
 Initializes the page owner functions. More...
 

Variables

return function (\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks)
 

Function Documentation

_elgg_set_initial_context ( \Elgg\Http\Request  $request)

Set an initial context if using index.php front controller.

Parameters
Request$requestElgg HTTP request
Returns
void private

Definition at line 273 of file pageowner.php.

default_page_owner_handler (   $hook,
  $entity_type,
  $returnvalue,
  $params 
)

Sets the page owner based on request.

Tries to figure out the page owner by looking at the URL or a request parameter. The request parameters used are 'username' and 'owner_guid'. Otherwise, this function attempts to figure out the owner if the url fits the patterns of: <identifier>/owner/<username> <identifier>/friends/<username> <identifier>/view/<entity guid>=""> <identifier>/add/<container guid>=""> <identifier>/edit/<entity guid>=""> <identifier>/group/<group guid>="">

Note
Access is disabled while finding the page owner for the group gatekeeper functions.
Parameters
string$hook'page_owner'
string$entity_type'system'
int$returnvaluePrevious function's return value
array$paramsno parameters
Returns
int GUID private

Definition at line 101 of file pageowner.php.

elgg_get_context ( )

Get the current context.

Since context is a stack, this is equivalent to a peek.

Returns
string|null
Since
1.8.0

Definition at line 204 of file pageowner.php.

elgg_get_context_stack ( )

Get the entire context stack (e.g.

for backing it up)

Returns
string[]
Since
1.11

Definition at line 251 of file pageowner.php.

elgg_get_page_owner_entity ( )

Gets the owner entity for the current page.

Returns
|false The current page owner or false if none.
Since
1.8.0

Definition at line 56 of file pageowner.php.

elgg_get_page_owner_guid (   $guid = 0)

Gets the guid of the entity that owns the current page.

See Also
default_page_owner_handler Used to guess the page owner if it's not been set.
Parameters
int$guidOptional parameter used by elgg_set_page_owner_guid().
Returns
int The current page owner guid (0 if none).
Since
1.8.0

Definition at line 22 of file pageowner.php.

elgg_in_context (   $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
Since
1.8.0

Definition at line 241 of file pageowner.php.

elgg_pop_context ( )

Removes and returns the top context string from the stack.

Returns
string|null
Since
1.8.0

Definition at line 225 of file pageowner.php.

elgg_push_context (   $context)

Push a context onto the top of the stack.

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

Definition at line 215 of file pageowner.php.

elgg_set_context (   $context)

Sets the page 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'.

If no context was been set, the default context returned is 'main'.

Warning
The context is not available until the page_handler runs (after the 'init, system' event processing has completed).
Parameters
string$contextThe context of the page
Returns
bool
Since
1.8.0

Definition at line 192 of file pageowner.php.

elgg_set_context_stack ( array  $stack)

Set the entire context stack.

Parameters
string[]$stack All contexts to be placed on the stack
Returns
void
Since
1.11

Definition at line 262 of file pageowner.php.

elgg_set_page_owner_guid (   $guid)

Set the guid of the entity that owns this page.

Parameters
int$guidThe guid of the page owner
Returns
void
Since
1.8.0

Definition at line 72 of file pageowner.php.

page_owner_boot ( )

Initializes the page owner functions.

Returns
void private

Definition at line 291 of file pageowner.php.

Variable Documentation

Definition at line 297 of file pageowner.php.