1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?php
/**
* Elgg page owner library
* Contains functions for managing page ownership and context
*
* @package Elgg.Core
* @subpackage PageOwner
*/
/**
* Gets the guid of the entity that owns the current page.
*
* @param int $guid Optional parameter used by elgg_set_page_owner_guid().
*
* @return int The current page owner guid (0 if none).
* @since 1.8.0
*/
function elgg_get_page_owner_guid($guid = 0) {
static $page_owner_guid;
if ($guid) {
$page_owner_guid = $guid;
}
if (isset($page_owner_guid)) {
return $page_owner_guid;
}
$guid = elgg_trigger_plugin_hook('page_owner', 'system', NULL, 0);
$page_owner_guid = $guid;
return $guid;
}
/**
* Gets the owner entity for the current page.
*
* @return ElggEntity|false The current page owner or false if none.
*
* @since 1.8.0
*/
function elgg_get_page_owner_entity() {
$guid = elgg_get_page_owner_guid();
if ($guid > 0) {
return get_entity($guid);
}
return FALSE;
}
/**
* Set the guid of the entity that owns this page
*
* @param int $guid The guid of the page owner
*
* @since 1.8.0
*/
function elgg_set_page_owner_guid($guid) {
elgg_get_page_owner_guid($guid);
}
/**
* Handles default page owners
*
* @param string $hook page_owner
* @param string $entity_type system
* @param mixed $returnvalue Previous function's return value
* @param mixed $params Params
*
* @return int
*/
function default_page_owner_handler($hook, $entity_type, $returnvalue, $params) {
if ($returnvalue) {
return $returnvalue;
}
$username = get_input("username");
if ($username) {
if (substr_count($username, 'group:')) {
preg_match('/group\:([0-9]+)/i', $username, $matches);
$guid = $matches[1];
if ($entity = get_entity($guid)) {
return $entity->getGUID();
}
}
if ($user = get_user_by_username($username)) {
return $user->getGUID();
}
}
$owner = get_input("owner_guid");
if ($owner) {
if ($user = get_entity($owner)) {
return $user->getGUID();
}
}
return $returnvalue;
}
/**
* 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 'pg'. Example: http://elgg.org/pg/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).
*
* @param string $context The context of the page
* @return bool
* @since 1.8.0
*/
function elgg_set_context($context) {
global $CONFIG;
$context = trim($context);
if (empty($context)) {
return false;
}
$context = strtolower($context);
array_pop($CONFIG->context);
array_push($CONFIG->context, $context);
return true;
}
/**
* Get the current context.
*
* Since context is a stack, this is equivalent to a peek.
*
* @return string|NULL
* @since 1.8.0
*/
function elgg_get_context() {
global $CONFIG;
return $CONFIG->context[count($CONFIG->context) - 1];
}
/**
* Push a context onto the top of the stack
*
* @param string $context The context string to add to the context stack
* @since 1.8.0
*/
function elgg_push_context($context) {
global $CONFIG;
array_push($CONFIG->context, $context);
}
/**
* Removes and returns the top context string from the stack
*
* @return string|NULL
* @since 1.8.0
*/
function elgg_pop_context() {
global $CONFIG;
return array_pop($CONFIG->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.
*
* @param string $context The context string to check for
* @return bool
* @since 1.8.0
*/
function elgg_in_context($context) {
global $CONFIG;
return in_array($context, $CONFIG->context);
}
/**
* Initializes the page owner functions
*
* @note This is on the 'boot, system' event so that the context is set up quickly.
*
* @return void
*/
function page_owner_boot() {
global $CONFIG;
elgg_register_plugin_hook_handler('page_owner', 'system', 'default_page_owner_handler');
// initial context - will be replaced by page handler
$CONFIG->context = array('main');
}
elgg_register_event_handler('boot', 'system', 'page_owner_boot');
|
