4 * headermenuPlugin Class
6 * Copyright 2012-2013, Franck Villaume - TrivialDev
7 * http://fusionforge.org
9 * This file is part of FusionForge. FusionForge is free software;
10 * you can redistribute it and/or modify it under the terms of the
11 * GNU General Public License as published by the Free Software
12 * Foundation; either version 2 of the Licence, or (at your option)
15 * FusionForge is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with FusionForge; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 class headermenuPlugin extends Plugin {
29 function __construct() {
31 $this->name = 'headermenu';
32 $this->text = 'headermenu';
33 $this->_addHook('headermenu');
34 $this->_addHook('site_admin_option_hook');
35 $this->_addHook('outermenu');
36 $this->_addHook('groupisactivecheckbox'); // The "use ..." checkbox in editgroupinfo
37 $this->_addHook('groupisactivecheckboxpost');
38 $this->_addHook('groupmenu');
39 $this->_addHook('project_admin_plugins');
40 $this->_addHook('clone_project_from_template');
41 $this->_addHook('group_delete');
44 function CallHook($hookname, &$params) {
47 $this->getHeaderLink();
51 $this->getOuterLink($params);
54 case 'site_admin_option_hook': {
55 echo '<li>'.$this->getAdminOptionLink().'</li>';
59 $group_id = $params['group'];
60 $project = group_get_object($group_id);
61 if ($project->usesPlugin($this->name)) {
62 $this->getGroupLink($params);
66 case 'project_admin_plugins': {
67 $group_id = $params['group_id'];
68 $project = group_get_object($group_id);
69 if ($project->usesPlugin($this->name)) {
70 echo '<p>'.util_make_link('/plugins/'.$this->name.'/?type=projectadmin&group_id='.$group_id,
71 _('Project GroupMenu Admin'), array('class' => 'tabtitle', 'title' => _('Add/Remove/Activate/Desactivate tabs'))) . '</p>';
75 case 'clone_project_from_template': {
77 $res = db_query_params('SELECT url, name, description, is_enable, linkmenu, linktype, htmlcode, ordering FROM plugin_headermenu WHERE project = $1',
78 array($params['template']->getID()));
79 while ($row = db_fetch_array($res)) {
81 $linksData['url'] = $row['url'];
82 $linksData['name'] = $row['name'];
83 $linksData['description'] = $row['description'];
84 $linksData['is_enable'] = $row['is_enable'];
85 $linksData['linkmenu'] = $row['linkmenu'];
86 $linksData['linktype'] = $row['linktype'];
87 $linksData['htmlcode'] = $row['htmlcode'];
88 $linksData['ordering'] = $row['ordering'];
89 $links[] = $linksData;
92 foreach ($links as $link) {
93 db_query_params('INSERT INTO plugin_headermenu (url, name, description, is_enable, linkmenu, linktype, htmlcode, ordering, project) VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)',
102 $params['project']->getID()));
105 case 'group_delete': {
106 $group_id = $params['group_id'];
107 $group = group_get_object($group_id);
108 if ($group->usesPlugin($this->name)) {
109 $links = $this->getAvailableLinks('groupmenu', $group_id);
110 foreach ($links as $link) {
111 $this->deleteLink($link['id_headermenu']);
119 function getAdminOptionLink() {
120 return util_make_link('/plugins/'.$this->name.'/?type=globaladmin', _('Global HeaderMenu admin'), array('class' => 'tabtitle', 'title' => _('Direct link to global configuration of this plugin')));
124 * getHeaderLink - generate the links following the template
126 * @return bool true...
128 function getHeaderLink() {
129 $availableLinks = $this->getAvailableLinks('headermenu');
130 foreach ($availableLinks as $link) {
131 if ($link['is_enable']) {
132 $ahref = '<a href="'.$link['url'].'">'.htmlspecialchars($link['name']).'</a>';
133 $template = isset($params['template']) ? $params['template'] : ' | {menu}';
134 echo str_replace('{menu}', $ahref, $template);
141 * getOuterLink - update the links before generate the tab.
143 * @param array hook params array
144 * @return bool true...
146 function getOuterLink($params) {
147 $availableLinks = $this->getAvailableLinks('outermenu');
148 foreach ($availableLinks as $link) {
149 if ($link['is_enable']) {
150 switch ($link['linktype']) {
152 $params['DIRS'][] = $link['url'];
153 $params['TITLES'][] = $link['name'];
154 $params['TOOLTIPS'][] = $link['description'];
158 $params['DIRS'][] = '/plugins/'.$this->name.'/?type=pageview&pageid='.$link['id_headermenu'];
159 $params['TITLES'][] = $link['name'];
160 $params['TOOLTIPS'][] = $link['description'];
170 * getGroupLink - update the links before generate the tab.
172 * @param array hook params array
173 * @return bool true...
175 function getGroupLink($params) {
176 $availableLinks = $this->getAvailableLinks('groupmenu', $params['group']);
177 foreach ($availableLinks as $link) {
178 if ($link['is_enable']) {
179 switch ($link['linktype']) {
181 $params['DIRS'][] = $link['url'];
182 $params['TITLES'][] = $link['name'];
183 $params['TOOLTIPS'][] = $link['description'];
187 $params['DIRS'][] = '/plugins/'.$this->name.'/?type=pageview&group_id='.$params['group'].'&pageid='.$link['id_headermenu'];
188 $params['TITLES'][] = $link['name'];
189 $params['TOOLTIPS'][] = $link['description'];
190 if ($params['toptab'] == '/plugins/'.$this->name.'/?type=pageview&group_id='.$params['group'].'&pageid='.$link['id_headermenu']) {
191 $params['selected'] = (count($params['DIRS'])-1);
196 $params['DIRS'][] = '/plugins/'.$this->name.'/?type=iframeview&group_id='.$params['group'].'&pageid='.$link['id_headermenu'];
197 $params['TITLES'][] = $link['name'];
198 $params['TOOLTIPS'][] = $link['description'];
199 if ($params['toptab'] == '/plugins/'.$this->name.'/?type=iframeview&group_id='.$params['group'].'&pageid='.$link['id_headermenu']) {
200 $params['selected'] = (count($params['DIRS'])-1);
211 * getAvailableLinks - get all the links from the db of certain kind
213 * @param string the type of menu links search in db
214 * @param int the group_id. Default is 0 meaning : forge level
215 * @return array the available links
217 function getAvailableLinks($linkmenu, $project = 0) {
218 $links = db_query_params('select * FROM plugin_headermenu where linkmenu = $1 and project = $2 order by ordering asc', array($linkmenu, $project));
219 $availableLinks = array();
220 while ($arr = db_fetch_array($links)) {
221 $availableLinks[] = $arr;
223 return $availableLinks;
227 * getAllAvailableLinks - get all the links from the db
229 * @return array the available links
231 function getAllAvailableLinks() {
232 $availableOuterLinks = $this->getAvailableLinks('outermenu');
233 $availableHeaderLinks = $this->getAvailableLinks('headermenu');
234 return array_merge($availableOuterLinks, $availableHeaderLinks);
238 * setLinksOrder - set the linkOrder for a set of links id
240 * @param array $linksOrder array of ordered links id
241 * @return bool success or not
243 function setLinksOrder($linksOrder) {
244 for ($i =0; $i < count($linksOrder); $i++) {
245 $res = db_query_params('update plugin_headermenu set ordering = $1 where id_headermenu = $2', array($i, $linksOrder[$i]));
253 * addLink - add a new valid link
255 * @param string $url the url
256 * @param string $name the displayed name
257 * @param string $description a short description (to help administration)
258 * @param string $linkmenu linkmenu entry : headermenu or outermenu
259 * @param string $linktype
260 * @param int $project the group_id or 0 meaning forge level
261 * @param string $htmlcode
262 * @return bool success or not
264 function addLink($url, $name, $description, $linkmenu, $linktype = 'url', $project = 0, $htmlcode = '') {
265 $res = db_query_params('insert into plugin_headermenu (url, name, description, is_enable, linkmenu, linktype, project, htmlcode)
266 values ($1, $2, $3, $4, $5, $6, $7, $8)',
284 * deleteLink - delete a link
286 * @param int $idLink the link id
287 * @return bool success or not
289 function deleteLink($idLink) {
290 $res = db_query_params('delete from plugin_headermenu where id_headermenu = $1', array($idLink));
298 * updateLinkStatus - update the link status
300 * @param int $idLink the link id
301 * @param int $linkStatus the new status of the link id
302 * @return bool success or not
304 function updateLinkStatus($idLink, $linkStatus) {
305 $res = db_query_params('update plugin_headermenu set is_enable = $1 where id_headermenu = $2', array($linkStatus, $idLink));
313 * getLink - get all informations about a link
315 * @param int $idLink the link id
316 * @return array the link informations
318 function getLink($idLink) {
319 $res = db_query_params('select * from plugin_headermenu where id_headermenu = $1', array($idLink));
320 if (db_numrows($res) == 1) {
321 return db_fetch_array($res);
327 * updateLink - update a valid link
329 * @param int $idLink the link id to be updated
330 * @param string $url the url
331 * @param string $name the displayed name
332 * @param string $description a short description (to help administration)
333 * @param string $linkmenu linkmenu entry : headermenu or outermenu
334 * @param string $linktype : url or htmlcode, default is url
335 * @param string $htmlcode
336 * @return bool success or not
338 function updateLink($idLink, $url, $name, $description, $linkmenu, $linktype = 'url', $htmlcode ='') {
339 $res = db_query_params('update plugin_headermenu set url = $1, name = $2, description = $3, linkmenu = $4, linktype = $5, htmlcode = $6
340 where id_headermenu = $7',
341 array($url, $name, $description, $linkmenu, $linktype, $htmlcode, $idLink));
349 * pageView - display a static html code
351 * @param int the page id
352 * @return string the html code
354 function pageView($pageid) {
355 $link = $this->getLink($pageid);
357 return $link['htmlcode'];
359 return '<p class="error" >'._('Cannot retrieve the page').'</p>';
364 * iframeView - display the iframe
366 * @param int the iframe id
367 * @return string the html code
369 function iframeView($pageid) {
370 $link = $this->getLink($pageid);
372 return '<iframe src="'.rtrim($link['url'],'/').'" frameborder="0" height="600px" width="100%"></iframe>';
374 return '<p class="error" >'._('Cannot retrieve the page').'</p>';
379 * getHeader - initialize header and js
381 * @param string type : user, project, globaladmin (aka group)
382 * @return bool success or not
384 function getHeader($type) {
387 case 'globaladmin': {
388 session_require_global_perm('forge_admin');
390 require_once($gfwww.'admin/admin_utils.php');
393 use_javascript('scripts/HeaderMenuController.js');
394 use_javascript('/js/sortable.js');
395 site_admin_header(array('title'=>_('Site Global Menu Admin'), 'toptab' => ''));
401 $link = $this->getLink($this->pageid);
402 $group_id = getIntFromRequest('group_id');
404 $params['toptab'] = '/plugins/'.$this->name.'/?type='.$type.'&group_id='.$group_id.'&pageid='.$this->pageid;
405 $params['group'] = $group_id;
406 $params['title'] = $link['name'];
407 site_project_header($params);
409 site_header(array('title'=> $link['name'], 'toptab' => '/plugins/'.$this->name.'/?type='.$type.'&pageid='.$this->pageid));
414 case 'projectadmin': {
417 use_javascript('scripts/HeaderMenuController.js');
418 use_javascript('/js/sortable.js');
419 $group_id = getIntFromRequest('group_id');
420 $params['toptab'] = 'admin';
421 $params['group'] = $group_id;
422 $params['title'] = _('Project groupmenu Admin');
423 site_project_header($params);
432 * getGlobalAdminView - display the Global Admin View
436 function getGlobalAdminView() {
438 $user = session_get_user();
439 include $gfplugins.$this->name.'/view/admin/viewGlobalConfiguration.php';
444 * getProjectAdminView - display the Project Admin View
448 function getProjectAdminView() {
450 $user = session_get_user();
451 include $gfplugins.$this->name.'/view/admin/viewProjectConfiguration.php';
456 * getPluginDescription - display the description of this plugin in pluginman admin page
458 * @return string the description
460 function getPluginDescription() {
461 return _('Get the ability to set new links next to the login menu (headermenu), in the main menu (outermenu) or in the project menu (groupmenu).');