1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?php
/**
* @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>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* 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/>
*
*/
/**
* Public interface of ownCloud for apps to use.
* App Class
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* This class provides functions to manage apps in ownCloud
* @since 4.0.0
*/
class App {
/**
* Adds an entry to the navigation
*
* 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
* the navigation. Lower values come first.
*
* @param array $data containing the data
* @return boolean
*
* @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->add() instead to
* register a closure, this helps to speed up all requests against ownCloud
* @since 4.0.0
*/
public static function addNavigationEntry($data) {
\OC::$server->getNavigationManager()->add($data);
return true;
}
/**
* Marks a navigation entry as active
* @param string $id id of the entry
* @return boolean
*
* 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.
*
* @deprecated 8.1.0 Use \OC::$server->getNavigationManager()->setActiveEntry() instead
* @since 4.0.0
*/
public static function setActiveNavigationEntry( $id ) {
return \OC_App::setActiveNavigationEntry( $id );
}
/**
* Register a Configuration Screen that should appear in the personal settings section.
* @param string $app appid
* @param string $page page to be included
* @return void
* @since 4.0.0
*/
public static function registerPersonal( $app, $page ) {
\OC_App::registerPersonal( $app, $page );
}
/**
* Register a Configuration Screen that should appear in the Admin section.
* @param string $app string appid
* @param string $page string page to be included
* @return void
* @since 4.0.0
*/
public static function registerAdmin( $app, $page ) {
\OC_App::registerAdmin( $app, $page );
}
/**
* Read app metadata from the info.xml file
* @param string $app id of the app or the path of the info.xml file
* @param boolean $path (optional)
* @return array
* @since 4.0.0
*/
public static function getAppInfo( $app, $path=false ) {
return \OC_App::getAppInfo( $app, $path);
}
/**
* checks whether or not an app is enabled
* @param string $app
* @return boolean
*
* This function checks whether or not an app is enabled.
* @since 4.0.0
*/
public static function isEnabled( $app ) {
return \OC_App::isEnabled( $app );
}
/**
* Check if the app is enabled, redirects to home if not
* @param string $app
* @return void
* @since 4.0.0
*/
public static function checkAppEnabled( $app ) {
\OC_Util::checkAppEnabled( $app );
}
/**
* Get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param string $app
* @return string
* @since 4.0.0
*/
public static function getAppVersion( $app ) {
return \OC_App::getAppVersion( $app );
}
}
|
