2013-09-20 15:34:33 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-02-26 10:37:37 +00:00
|
|
|
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
|
|
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
|
|
* later.
|
|
|
|
* See the COPYING-README file.
|
2013-09-20 15:34:33 +00:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2013-09-20 15:34:33 +00:00
|
|
|
namespace OC;
|
|
|
|
|
|
|
|
/**
|
2013-09-20 19:45:27 +00:00
|
|
|
* Manages the ownCloud navigation
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
2013-09-20 20:45:22 +00:00
|
|
|
class NavigationManager implements \OCP\INavigationManager {
|
2013-09-20 15:34:33 +00:00
|
|
|
protected $entries = array();
|
2015-03-16 15:17:43 +00:00
|
|
|
protected $closureEntries = array();
|
2013-09-20 19:45:27 +00:00
|
|
|
protected $activeEntry;
|
2013-09-20 15:34:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new navigation entry
|
2015-03-16 15:17:43 +00:00
|
|
|
*
|
|
|
|
* @param array|\Closure $entry Array containing: id, name, order, icon and href key
|
|
|
|
* The use of a closure is preferred, because it will avoid
|
|
|
|
* loading the routing of your app, unless required.
|
|
|
|
* @return void
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
2015-03-16 15:17:43 +00:00
|
|
|
public function add($entry) {
|
|
|
|
if ($entry instanceof \Closure) {
|
|
|
|
$this->closureEntries[] = $entry;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2013-09-20 15:34:33 +00:00
|
|
|
$entry['active'] = false;
|
|
|
|
if(!isset($entry['icon'])) {
|
|
|
|
$entry['icon'] = '';
|
|
|
|
}
|
|
|
|
$this->entries[] = $entry;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* returns all the added Menu entries
|
2014-05-11 17:13:51 +00:00
|
|
|
* @return array an array of the added entries
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
|
|
|
public function getAll() {
|
2015-03-16 15:17:43 +00:00
|
|
|
foreach ($this->closureEntries as $c) {
|
|
|
|
$this->add($c());
|
|
|
|
}
|
|
|
|
$this->closureEntries = array();
|
2013-09-20 15:34:33 +00:00
|
|
|
return $this->entries;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* removes all the entries
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
|
|
|
public function clear() {
|
|
|
|
$this->entries = array();
|
2015-03-16 15:17:43 +00:00
|
|
|
$this->closureEntries = array();
|
2013-09-20 15:34:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the current navigation entry of the currently running app
|
|
|
|
* @param string $id of the app entry to activate (from added $entry)
|
|
|
|
*/
|
|
|
|
public function setActiveEntry($id) {
|
|
|
|
$this->activeEntry = $id;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* gets the active Menu entry
|
2013-09-20 15:34:33 +00:00
|
|
|
* @return string id or empty string
|
|
|
|
*
|
|
|
|
* This function returns the id of the active navigation entry (set by
|
|
|
|
* setActiveEntry
|
|
|
|
*/
|
|
|
|
public function getActiveEntry() {
|
|
|
|
return $this->activeEntry;
|
|
|
|
}
|
|
|
|
}
|