diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-06 14:32:46 +0300 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-06 14:32:46 +0300 |
commit | ec8298c49360b0862af581f939b00948483a029b (patch) | |
tree | a5751d52f8ffdf3d4554fcfbe1bd4d3f8640d830 /lib/public/App | |
parent | c9601efe9580fb36ac3dda211af943f52518ec36 (diff) |
Move \OCP\App to PSR-4
Diffstat (limited to 'lib/public/App')
-rw-r--r-- | lib/public/App/IAppManager.php | 115 | ||||
-rw-r--r-- | lib/public/App/ManagerEvent.php | 86 |
2 files changed, 201 insertions, 0 deletions
diff --git a/lib/public/App/IAppManager.php b/lib/public/App/IAppManager.php new file mode 100644 index 00000000000..0e1e0dfbebd --- /dev/null +++ b/lib/public/App/IAppManager.php @@ -0,0 +1,115 @@ +<?php +/** + * @author Lukas Reschke <lukas@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin Appelman <icewind@owncloud.com> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * + * @copyright Copyright (c) 2016, 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/> + * + */ + +namespace OCP\App; + +use OCP\IUser; + +/** + * Interface IAppManager + * + * @package OCP\App + * @since 8.0.0 + */ +interface IAppManager { + /** + * Check if an app is enabled for user + * + * @param string $appId + * @param \OCP\IUser $user (optional) if not defined, the currently loggedin user will be used + * @return bool + * @since 8.0.0 + */ + public function isEnabledForUser($appId, $user = null); + + /** + * Check if an app is installed in the instance + * + * @param string $appId + * @return bool + * @since 8.0.0 + */ + public function isInstalled($appId); + + /** + * Enable an app for every user + * + * @param string $appId + * @since 8.0.0 + */ + public function enableApp($appId); + + /** + * Enable an app only for specific groups + * + * @param string $appId + * @param \OCP\IGroup[] $groups + * @since 8.0.0 + */ + public function enableAppForGroups($appId, $groups); + + /** + * Disable an app for every user + * + * @param string $appId + * @since 8.0.0 + */ + public function disableApp($appId); + + /** + * List all apps enabled for a user + * + * @param \OCP\IUser $user + * @return string[] + * @since 8.1.0 + */ + public function getEnabledAppsForUser(IUser $user); + + /** + * List all installed apps + * + * @return string[] + * @since 8.1.0 + */ + public function getInstalledApps(); + + /** + * Clear the cached list of apps when enabling/disabling an app + * @since 8.1.0 + */ + public function clearAppsCache(); + + /** + * @param string $appId + * @return boolean + * @since 9.0.0 + */ + public function isShipped($appId); + + /** + * @return string[] + * @since 9.0.0 + */ + public function getAlwaysEnabledApps(); +} diff --git a/lib/public/App/ManagerEvent.php b/lib/public/App/ManagerEvent.php new file mode 100644 index 00000000000..0ea7213dfc5 --- /dev/null +++ b/lib/public/App/ManagerEvent.php @@ -0,0 +1,86 @@ +<?php +/** + * @author Arthur Schiwon <blizzz@owncloud.com> + * + * @copyright Copyright (c) 2016, 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/> + * + */ + +namespace OCP\App; + +use Symfony\Component\EventDispatcher\Event; + +/** + * Class ManagerEvent + * + * @package OCP\APP + * @since 9.0.0 + */ +class ManagerEvent extends Event { + + const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp'; + const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups'; + const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp'; + + /** @var string */ + protected $event; + /** @var string */ + protected $appID; + /** @var \OCP\IGroup[] */ + protected $groups; + + /** + * DispatcherEvent constructor. + * + * @param string $event + * @param $appID + * @param \OCP\IGroup[] $groups + * @since 9.0.0 + */ + public function __construct($event, $appID, array $groups = null) { + $this->event = $event; + $this->appID = $appID; + $this->groups = $groups; + } + + /** + * @return string + * @since 9.0.0 + */ + public function getEvent() { + return $this->event; + } + + /** + * @return string + * @since 9.0.0 + */ + public function getAppID() { + return $this->appID; + } + + /** + * returns the group Ids + * @return string[] + * @since 9.0.0 + */ + public function getGroups() { + return array_map(function ($group) { + /** @var \OCP\IGroup $group */ + return $group->getGID(); + }, $this->groups); + } +} |