2012-05-01 22:50:26 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
|
|
* @author Frank Karlitschek <frank@owncloud.org>
|
|
|
|
* @author Georg Ehrke <georg@owncloud.com>
|
|
|
|
* @author Joas Schilling <nickvergessen@owncloud.com>
|
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-01-12 14:02:16 +00:00
|
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2016-01-12 14:02:16 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
2015-03-26 10:44:34 +00:00
|
|
|
* @license AGPL-3.0
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* This code is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
|
|
* as published by the Free Software Foundation.
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2013-11-03 12:51:39 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 10:44:34 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* App Class
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2012-08-29 06:38:33 +00:00
|
|
|
// use OCP namespace for all classes that are considered public.
|
2012-05-01 22:50:26 +00:00
|
|
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
|
|
|
namespace OCP;
|
|
|
|
|
2012-05-19 08:36:57 +00:00
|
|
|
/**
|
|
|
|
* This class provides functions to manage apps in ownCloud
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-05-19 08:36:57 +00:00
|
|
|
*/
|
2012-05-01 22:50:26 +00:00
|
|
|
class App {
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Adds an entry to the navigation
|
2012-09-08 13:54:30 +00:00
|
|
|
*
|
|
|
|
* This function adds a new entry to the navigation visible to users. $data
|
|
|
|
* is an associative array.
|
|
|
|
* The following keys are required:
|
|
|
|
* - id: unique id for this entry ('addressbook_index')
|
|
|
|
* - href: link to the page
|
|
|
|
* - name: Human readable name ('Addressbook')
|
|
|
|
*
|
|
|
|
* The following keys are optional:
|
|
|
|
* - icon: path to the icon of the app
|
|
|
|
* - order: integer, that influences the position of your application in
|
2015-03-17 11:14:34 +00:00
|
|
|
* the navigation. Lower values come first.
|
|
|
|
*
|
|
|
|
* @param array $data containing the data
|
|
|
|
* @return boolean
|
|
|
|
*
|
2015-04-18 23:04:59 +00:00
|
|
|
* @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->add() instead to
|
2015-03-17 11:14:34 +00:00
|
|
|
* register a closure, this helps to speed up all requests against ownCloud
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
2015-03-17 11:14:34 +00:00
|
|
|
public static function addNavigationEntry($data) {
|
|
|
|
\OC::$server->getNavigationManager()->add($data);
|
|
|
|
return true;
|
2012-09-08 13:54:30 +00:00
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Marks a navigation entry as active
|
2014-05-11 20:51:30 +00:00
|
|
|
* @param string $id id of the entry
|
2013-10-16 22:07:29 +00:00
|
|
|
* @return boolean
|
2012-09-08 13:54:30 +00:00
|
|
|
*
|
|
|
|
* This function sets a navigation entry as active and removes the 'active'
|
|
|
|
* property from all other entries. The templates can use this for
|
|
|
|
* highlighting the current position of the user.
|
2015-03-17 11:14:34 +00:00
|
|
|
*
|
2015-04-18 23:04:59 +00:00
|
|
|
* @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->setActiveEntry() instead
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function setActiveNavigationEntry( $id ) {
|
2015-12-04 16:23:51 +00:00
|
|
|
\OC::$server->getNavigationManager()->setActiveEntry($id);
|
|
|
|
return true;
|
2012-09-08 13:54:30 +00:00
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Register a Configuration Screen that should appear in the personal settings section.
|
2014-05-11 20:51:30 +00:00
|
|
|
* @param string $app appid
|
|
|
|
* @param string $page page to be included
|
2014-02-08 10:47:55 +00:00
|
|
|
* @return void
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function registerPersonal( $app, $page ) {
|
2013-01-06 22:57:27 +00:00
|
|
|
\OC_App::registerPersonal( $app, $page );
|
2012-09-08 13:54:30 +00:00
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Register a Configuration Screen that should appear in the Admin section.
|
2014-02-06 15:30:58 +00:00
|
|
|
* @param string $app string appid
|
|
|
|
* @param string $page string page to be included
|
2014-02-08 10:47:55 +00:00
|
|
|
* @return void
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function registerAdmin( $app, $page ) {
|
2013-01-06 22:57:27 +00:00
|
|
|
\OC_App::registerAdmin( $app, $page );
|
2012-09-08 13:54:30 +00:00
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Read app metadata from the info.xml file
|
2012-09-08 13:54:30 +00:00
|
|
|
* @param string $app id of the app or the path of the info.xml file
|
2013-09-20 19:43:17 +00:00
|
|
|
* @param boolean $path (optional)
|
2013-10-16 22:07:29 +00:00
|
|
|
* @return array
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function getAppInfo( $app, $path=false ) {
|
|
|
|
return \OC_App::getAppInfo( $app, $path);
|
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* checks whether or not an app is enabled
|
2014-02-06 15:30:58 +00:00
|
|
|
* @param string $app
|
2013-10-16 22:07:29 +00:00
|
|
|
* @return boolean
|
2012-09-08 13:54:30 +00:00
|
|
|
*
|
|
|
|
* This function checks whether or not an app is enabled.
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function isEnabled( $app ) {
|
|
|
|
return \OC_App::isEnabled( $app );
|
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Check if the app is enabled, redirects to home if not
|
2014-02-08 10:47:55 +00:00
|
|
|
* @param string $app
|
|
|
|
* @return void
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2015-12-18 14:51:03 +00:00
|
|
|
* @deprecated 9.0.0 ownCloud core will handle disabled apps and redirects to valid URLs
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function checkAppEnabled( $app ) {
|
|
|
|
}
|
2012-09-08 13:52:29 +00:00
|
|
|
|
2012-09-08 13:54:30 +00:00
|
|
|
/**
|
2013-10-16 22:07:29 +00:00
|
|
|
* Get the last version of the app, either from appinfo/version or from appinfo/info.xml
|
2014-02-08 10:47:55 +00:00
|
|
|
* @param string $app
|
2014-02-06 15:30:58 +00:00
|
|
|
* @return string
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 4.0.0
|
2012-09-08 13:54:30 +00:00
|
|
|
*/
|
|
|
|
public static function getAppVersion( $app ) {
|
|
|
|
return \OC_App::getAppVersion( $app );
|
|
|
|
}
|
2012-05-01 22:50:26 +00:00
|
|
|
}
|