diff options
Diffstat (limited to 'lib/public')
| -rw-r--r-- | lib/public/activity/iextension.php | 120 | ||||
| -rw-r--r-- | lib/public/activity/imanager.php | 72 |
2 files changed, 191 insertions, 1 deletions
diff --git a/lib/public/activity/iextension.php b/lib/public/activity/iextension.php new file mode 100644 index 00000000000..6bb403a8896 --- /dev/null +++ b/lib/public/activity/iextension.php @@ -0,0 +1,120 @@ +<?php +/** + * ownCloud + * + * @author Thomas Müller + * @copyright 2014 Thomas Müller deepdiver@owncloud.com + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE + * License as published by the Free Software Foundation; either + * version 3 of the License, or any later version. + * + * This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>. + * + */ + +/** + * Public interface of ownCloud for apps to use. + * Activity/IExtension interface + */ + +// 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\Activity; + +interface IExtension { + /** + * The extension can return an array of additional notification types. + * If no additional types are to be added false is to be returned + * + * @param string $languageCode + * @return array|false + */ + public function getNotificationTypes($languageCode); + + /** + * The extension can filter the types based on the filter if required. + * In case no filter is to be applied false is to be returned unchanged. + * + * @param array $types + * @param string $filter + * @return array|false + */ + public function filterNotificationTypes($types, $filter); + + /** + * For a given method additional types to be displayed in the settings can be returned. + * In case no additional types are to be added false is to be returned. + * + * @param string $method + * @return array|false + */ + public function getDefaultTypes($method); + + /** + * The extension can translate a given message to the requested languages. + * If no translation is available false is to be returned. + * + * @param string $app + * @param string $text + * @param array $params + * @param boolean $stripPath + * @param boolean $highlightParams + * @param string $languageCode + * @return string|false + */ + public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); + + /** + * A string naming the css class for the icon to be used can be returned. + * If no icon is known for the given type false is to be returned. + * + * @param string $type + * @return string|false + */ + public function getTypeIcon($type); + + /** + * The extension can define the parameter grouping by returning the index as integer. + * In case no grouping is required false is to be returned. + * + * @param array $activity + * @return integer|false + */ + public function getGroupParameter($activity); + + /** + * The extension can define additional navigation entries. The array returned has to contain two keys 'top' + * and 'apps' which hold arrays with the relevant entries. + * If no further entries are to be added false is no be returned. + * + * @return array|false + */ + public function getNavigation(); + + /** + * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. + * + * @param string $filterValue + * @return boolean + */ + public function isFilterValid($filterValue); + + /** + * For a given filter the extension can specify the sql query conditions including parameters for that query. + * In case the extension does not know the filter false is to be returned. + * The query condition and the parameters are to be returned as array with two elements. + * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); + * + * @param string $filter + * @return array|false + */ + public function getQueryForFilter($filter); +} diff --git a/lib/public/activity/imanager.php b/lib/public/activity/imanager.php index 449fdcc934d..0a49fdf4999 100644 --- a/lib/public/activity/imanager.php +++ b/lib/public/activity/imanager.php @@ -50,11 +50,81 @@ interface IManager { * In order to improve lazy loading a closure can be registered which will be called in case * activity consumers are actually requested * - * $callable has to return an instance of OCA\Activity\IConsumer + * $callable has to return an instance of \OCP\Activity\IConsumer * * @param \Closure $callable * @return void */ function registerConsumer(\Closure $callable); + /** + * In order to improve lazy loading a closure can be registered which will be called in case + * activity consumers are actually requested + * + * $callable has to return an instance of \OCP\Activity\IExtension + * + * @param \Closure $callable + * @return void + */ + function registerExtension(\Closure $callable); + + /** + * Will return additional notification types as specified by other apps + * @param string $languageCode + * @return array + */ + function getNotificationTypes($languageCode); + + /** + * @param array $types + * @param string $filter + * @return array + */ + function filterNotificationTypes($types, $filter); + + /** + * @param string $method + * @return array + */ + function getDefaultTypes($method); + + /** + * @param string $app + * @param string $text + * @param array $params + * @param boolean $stripPath + * @param boolean $highlightParams + * @param string $languageCode + * @return string|false + */ + function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); + + /** + * @param string $type + * @return string + */ + function getTypeIcon($type); + + /** + * @param array $activity + * @return integer|false + */ + function getGroupParameter($activity); + + /** + * @return array + */ + function getNavigation(); + + /** + * @param string $filterValue + * @return boolean + */ + function isFilterValid($filterValue); + + /** + * @param string $filter + * @return array + */ + function getQueryForFilter($filter); } |