]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - plugins/demo_plugin/demo_plugin.php
5 * This plugin try to cover Shaarli's plugin API entirely.
6 * Can be used by plugin developper to make their own.
10 * RENDER HEADER, INCLUDES, FOOTER
12 * Those hooks are called at every page rendering.
13 * You can filter its execution by checking _PAGE_ value
14 * and check user status with _LOGGEDIN_.
19 * Executed on every page redering.
21 * Template placeholders:
25 * @param array $data data passed to plugin
27 * @return array altered $data.
29 function hook_demo_plugin_render_header($data)
31 // Only execute when linklist is rendered.
32 if ($data['_PAGE_'] == Router
::$PAGE_LINKLIST) {
35 if ($data['_LOGGEDIN_'] === true) {
37 $data['buttons_toolbar'][] = '<li><a href="#">DEMO_buttons_toolbar</a></li>';
41 $data['fields_toolbar'][] = 'DEMO_fields_toolbar';
48 * Hook render_includes.
49 * Executed on every page redering.
51 * Template placeholders:
55 * - _PAGE_: current page
56 * - _LOGGEDIN_: true/false
58 * @param array $data data passed to plugin
60 * @return array altered $data.
62 function hook_demo_plugin_render_includes($data)
64 // List of plugin's CSS files.
65 // Note that you just need to specify CSS path.
66 $data['css_files'][] = PluginManager
::$PLUGINS_PATH . '/demo_plugin/custom_demo.css';
73 * Executed on every page redering.
75 * Template placeholders:
81 * - _PAGE_: current page
82 * - _LOGGEDIN_: true/false
84 * @param array $data data passed to plugin
86 * @return array altered $data.
88 function hook_demo_plugin_render_footer($data)
91 $data['text'][] = 'Shaarli is now enhanced by the awesome demo_plugin.';
93 // Free elements at the end of the page.
94 $data['endofpage'][] = '<marquee id="demo_marquee">' .
95 'DEMO: it\'s 1999 all over again!' .
98 // List of plugin's JS files.
99 // Note that you just need to specify CSS path.
100 $data['js_files'][] = PluginManager
::$PLUGINS_PATH . '/demo_plugin/demo_plugin.js';
110 * Hook render_linklist.
112 * Template placeholders:
113 * - action_plugin: next to 'private only' button.
114 * - plugin_start_zone: page start
115 * - plugin_end_zone: page end
116 * - link_plugin: icons below each links.
119 * - _LOGGEDIN_: true/false
121 * @param array $data data passed to plugin
123 * @return array altered $data.
125 function hook_demo_plugin_render_linklist($data)
128 $data['action_plugin'][] = '<div class="upper_plugin_demo"><a href="?up" title="Uppercase!">←</a></div>';
130 if (isset($_GET['up'])) {
131 // Manipulate link data
132 foreach ($data['links'] as &$value) {
133 $value['description'] = strtoupper($value['description']);
134 $value['title'] = strtoupper($value['title']);
138 // link_plugin (for each link)
139 foreach ($data['links'] as &$value) {
140 $value['link_plugin'][] = ' DEMO \o/';
144 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
146 $data['plugin_end_zone'][] = '<center>AFTER</center>';
152 * Hook render_editlink.
154 * Template placeholders:
155 * - field_plugin: add link fields after tags.
157 * @param array $data data passed to plugin
159 * @return array altered $data.
161 function hook_demo_plugin_render_editlink($data)
163 // Load HTML into a string
164 $html = file_get_contents(PluginManager
::$PLUGINS_PATH .'/demo_plugin/field.html');
166 // replace value in HTML if it exists in $data
167 if (!empty($data['link']['stuff'])) {
168 $html = sprintf($html, $data['link']['stuff']);
170 $html = sprintf($html, '');
174 $data['edit_link_plugin'][] = $html;
182 * Template placeholders:
183 * - tools_plugin: after other tools.
185 * @param array $data data passed to plugin
187 * @return array altered $data.
189 function hook_demo_plugin_render_tools($data)
192 $data['tools_plugin'][] = 'tools_plugin';
198 * Hook render_picwall.
200 * Template placeholders:
201 * - plugin_start_zone: page start.
202 * - plugin_end_zone: page end.
205 * - _LOGGEDIN_: true/false
207 * @param array $data data passed to plugin
209 * @return array altered $data.
211 function hook_demo_plugin_render_picwall($data)
214 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
216 $data['plugin_end_zone'][] = '<center>AFTER</center>';
222 * Hook render_tagcloud.
224 * Template placeholders:
225 * - plugin_start_zone: page start.
226 * - plugin_end_zone: page end.
229 * - _LOGGEDIN_: true/false
231 * @param array $data data passed to plugin
233 * @return array altered $data.
235 function hook_demo_plugin_render_tagcloud($data)
238 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
240 $data['plugin_end_zone'][] = '<center>AFTER</center>';
248 * Template placeholders:
249 * - plugin_start_zone: page start.
250 * - plugin_end_zone: page end.
253 * - _LOGGEDIN_: true/false
255 * @param array $data data passed to plugin
257 * @return array altered $data.
259 function hook_demo_plugin_render_daily($data)
262 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
264 $data['plugin_end_zone'][] = '<center>AFTER</center>';
267 // Manipulate columns data
268 foreach ($data['cols'] as &$value) {
269 foreach ($value as &$value2) {
270 $value2['formatedDescription'] .= ' ಠ_ಠ';
274 // Add plugin content at the end of each link
275 foreach ($data['cols'] as &$value) {
276 foreach ($value as &$value2) {
277 $value2['link_plugin'][] = 'DEMO';
291 * Triggered when a link is save (new or edit).
292 * All new links now contain a 'stuff' value.
294 * @param array $data contains the new link data.
296 * @return array altered $data.
298 function hook_demo_plugin_save_link($data)
301 // Save stuff added in editlink field
302 if (!empty($_POST['lf_stuff'])) {
303 $data['stuff'] = escape($_POST['lf_stuff']);
312 * Triggered when a link is deleted.
314 * @param array $data contains the link to be deleted.
316 * @return array altered data.
318 function hook_demo_plugin_delete_link($data)
320 if (strpos($data['url'], 'youtube.com') !== false) {
321 exit('You can not delete a YouTube link. Don\'t ask.');