]>
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:
80 * - _PAGE_: current page
81 * - _LOGGEDIN_: true/false
83 * @param array $data data passed to plugin
85 * @return array altered $data.
87 function hook_demo_plugin_render_footer($data)
90 $data['text'][] = 'Shaarli is now enhanced by the awesome demo_plugin.';
92 // List of plugin's JS files.
93 // Note that you just need to specify CSS path.
94 $data['js_files'][] = PluginManager
::$PLUGINS_PATH . '/demo_plugin/demo_plugin.js';
104 * Hook render_linklist.
106 * Template placeholders:
107 * - action_plugin: next to 'private only' button.
108 * - plugin_start_zone: page start
109 * - plugin_end_zone: page end
110 * - link_plugin: icons below each links.
113 * - _LOGGEDIN_: true/false
115 * @param array $data data passed to plugin
117 * @return array altered $data.
119 function hook_demo_plugin_render_linklist($data)
122 $data['action_plugin'][] = '<div class="upper_plugin_demo"><a href="?up" title="Uppercase!">←</a></div>';
124 if (isset($_GET['up'])) {
125 // Manipulate link data
126 foreach ($data['links'] as &$value) {
127 $value['description'] = strtoupper($value['description']);
128 $value['title'] = strtoupper($value['title']);
132 // link_plugin (for each link)
133 foreach ($data['links'] as &$value) {
134 $value['link_plugin'][] = ' DEMO \o/';
138 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
140 $data['plugin_end_zone'][] = '<center>AFTER</center>';
146 * Hook render_editlink.
148 * Template placeholders:
149 * - field_plugin: add link fields after tags.
151 * @param array $data data passed to plugin
153 * @return array altered $data.
155 function hook_demo_plugin_render_editlink($data)
157 // Load HTML into a string
158 $html = file_get_contents(PluginManager
::$PLUGINS_PATH .'/demo_plugin/field.html');
160 // replace value in HTML if it exists in $data
161 if (!empty($data['link']['stuff'])) {
162 $html = sprintf($html, $data['link']['stuff']);
164 $html = sprintf($html, '');
168 $data['edit_link_plugin'][] = $html;
176 * Template placeholders:
177 * - tools_plugin: after other tools.
179 * @param array $data data passed to plugin
181 * @return array altered $data.
183 function hook_demo_plugin_render_tools($data)
186 $data['tools_plugin'][] = 'tools_plugin';
192 * Hook render_picwall.
194 * Template placeholders:
195 * - plugin_start_zone: page start.
196 * - plugin_end_zone: page end.
199 * - _LOGGEDIN_: true/false
201 * @param array $data data passed to plugin
203 * @return array altered $data.
205 function hook_demo_plugin_render_picwall($data)
208 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
210 $data['plugin_end_zone'][] = '<center>AFTER</center>';
216 * Hook render_tagcloud.
218 * Template placeholders:
219 * - plugin_start_zone: page start.
220 * - plugin_end_zone: page end.
223 * - _LOGGEDIN_: true/false
225 * @param array $data data passed to plugin
227 * @return array altered $data.
229 function hook_demo_plugin_render_tagcloud($data)
232 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
234 $data['plugin_end_zone'][] = '<center>AFTER</center>';
242 * Template placeholders:
243 * - plugin_start_zone: page start.
244 * - plugin_end_zone: page end.
247 * - _LOGGEDIN_: true/false
249 * @param array $data data passed to plugin
251 * @return array altered $data.
253 function hook_demo_plugin_render_daily($data)
256 $data['plugin_start_zone'][] = '<center>BEFORE</center>';
258 $data['plugin_end_zone'][] = '<center>AFTER</center>';
261 // Manipulate columns data
262 foreach ($data['cols'] as &$value) {
263 foreach ($value as &$value2) {
264 $value2['formatedDescription'] .= ' ಠ_ಠ';
268 // Add plugin content at the end of each link
269 foreach ($data['cols'] as &$value) {
270 foreach ($value as &$value2) {
271 $value2['link_plugin'][] = 'DEMO';
285 * Triggered when a link is save (new or edit).
286 * All new links now contain a 'stuff' value.
288 * @param array $data contains the new link data.
290 * @return array altered $data.
292 function hook_demo_plugin_save_link($data)
295 // Save stuff added in editlink field
296 if (!empty($_POST['lf_stuff'])) {
297 $data['stuff'] = escape($_POST['lf_stuff']);
306 * Triggered when a link is deleted.
308 * @param array $data contains the link to be deleted.
310 * @return array altered data.
312 function hook_demo_plugin_delete_link($data)
314 if (strpos($data['url'], 'youtube.com') !== false) {
315 exit('You can not delete a YouTube link. Don\'t ask.');