|
Elgg
Version 2.3
|
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) |
| _elgg_set_initial_context | ( | \Elgg\Http\Request | $request | ) |
Set an initial context if using index.php front controller.
| Request | $request | Elgg HTTP request |
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>="">
| string | $hook | 'page_owner' |
| string | $entity_type | 'system' |
| int | $returnvalue | Previous function's return value |
| array | $params | no parameters |
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.
Definition at line 204 of file pageowner.php.
| elgg_get_context_stack | ( | ) |
Get the entire context stack (e.g.
for backing it up)
Definition at line 251 of file pageowner.php.
| elgg_get_page_owner_entity | ( | ) |
Gets the owner entity for the current page.
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.
| int | $guid | Optional parameter used by elgg_set_page_owner_guid(). |
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.
| string | $context | The context string to check for |
Definition at line 241 of file pageowner.php.
| elgg_pop_context | ( | ) |
Removes and returns the top context string from the stack.
Definition at line 225 of file pageowner.php.
| elgg_push_context | ( | $context | ) |
Push a context onto the top of the stack.
| string | $context | The context string to add to the context stack |
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'.
| string | $context | The context of the page |
Definition at line 192 of file pageowner.php.
| elgg_set_context_stack | ( | array | $stack | ) |
Set the entire context stack.
| string[] | $stack All contexts to be placed on the stack |
Definition at line 262 of file pageowner.php.
| elgg_set_page_owner_guid | ( | $guid | ) |
Set the guid of the entity that owns this page.
| int | $guid | The guid of the page owner |
Definition at line 72 of file pageowner.php.
| page_owner_boot | ( | ) |
Initializes the page owner functions.
Definition at line 291 of file pageowner.php.
| return function(\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks) |
Definition at line 297 of file pageowner.php.
1.8.11
