Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/server.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2019-01-24 18:52:38 +0300
committerJoas Schilling <coding@schilljs.com>2019-01-24 18:52:38 +0300
commitabd305eff5904a10218d559f596c80c08e2b9c4e (patch)
treed8c242f381c9c7009ba72870ad2889dd2a476cde /lib/public/Activity
parent82b5828e3773f08a845a2a1d9a69247ec605f2d8 (diff)
Remove legacy activity stuff
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'lib/public/Activity')
-rw-r--r--lib/public/Activity/IExtension.php127
-rw-r--r--lib/public/Activity/IManager.php147
2 files changed, 18 insertions, 256 deletions
diff --git a/lib/public/Activity/IExtension.php b/lib/public/Activity/IExtension.php
index 321c2f03bc3..eaf425fb779 100644
--- a/lib/public/Activity/IExtension.php
+++ b/lib/public/Activity/IExtension.php
@@ -24,13 +24,6 @@
*
*/
-/**
- * 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;
/**
@@ -48,124 +41,4 @@ interface IExtension {
const PRIORITY_MEDIUM = 30;
const PRIORITY_HIGH = 40;
const PRIORITY_VERYHIGH = 50;
-
- /**
- * 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 Array "stringID of the type" => "translated string description for the setting"
- * or Array "stringID of the type" => [
- * 'desc' => "translated string description for the setting"
- * 'methods' => [self::METHOD_*],
- * ]
- * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
- */
- public function getNotificationTypes($languageCode);
-
- /**
- * 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
- * @since 8.0.0
- */
- public function getDefaultTypes($method);
-
- /**
- * 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
- * @since 8.0.0
- */
- public function getTypeIcon($type);
-
- /**
- * 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
- * @since 8.0.0
- */
- public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
-
- /**
- * The extension can define the type of parameters for translation
- *
- * Currently known types are:
- * * file => will strip away the path of the file and add a tooltip with it
- * * username => will add the avatar of the user
- * * email => will add a mailto link
- *
- * @param string $app
- * @param string $text
- * @return array|false
- * @since 8.0.0
- */
- public function getSpecialParameterList($app, $text);
-
- /**
- * 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
- * @since 8.0.0
- */
- 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
- * @since 8.0.0
- * @deprecated 11.0.0 - Register an IFilter instead
- */
- 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
- * @since 8.0.0
- * @deprecated 11.0.0 - Register an IFilter instead
- */
- public function isFilterValid($filterValue);
-
- /**
- * 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
- * @since 8.0.0
- * @deprecated 11.0.0 - Register an IFilter instead
- */
- public function filterNotificationTypes($types, $filter);
-
- /**
- * 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
- * @since 8.0.0
- * @deprecated 11.0.0 - Register an IFilter instead
- */
- public function getQueryForFilter($filter);
}
diff --git a/lib/public/Activity/IManager.php b/lib/public/Activity/IManager.php
index 90959a57099..b00e64f33e7 100644
--- a/lib/public/Activity/IManager.php
+++ b/lib/public/Activity/IManager.php
@@ -1,4 +1,5 @@
<?php
+declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
@@ -24,13 +25,6 @@
*
*/
-/**
- * Public interface of ownCloud for apps to use.
- * Activity/IManager 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;
/**
@@ -53,7 +47,7 @@ interface IManager {
* @return IEvent
* @since 8.2.0
*/
- public function generateEvent();
+ public function generateEvent(): IEvent;
/**
* Publish an event to the activity consumers
@@ -68,7 +62,7 @@ interface IManager {
* @throws \BadMethodCallException if required values have not been set
* @since 8.2.0
*/
- public function publish(IEvent $event);
+ public function publish(IEvent $event): void;
/**
* In order to improve lazy loading a closure can be registered which will be called in case
@@ -77,35 +71,21 @@ interface IManager {
* $callable has to return an instance of \OCP\Activity\IConsumer
*
* @param \Closure $callable
- * @return void
* @since 6.0.0
*/
- public 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
- * @since 8.0.0
- */
- public function registerExtension(\Closure $callable);
+ public function registerConsumer(\Closure $callable): void;
/**
* @param string $filter Class must implement OCA\Activity\IFilter
- * @return void
* @since 11.0.0
*/
- public function registerFilter($filter);
+ public function registerFilter(string $filter): void;
/**
* @return IFilter[]
* @since 11.0.0
*/
- public function getFilters();
+ public function getFilters(): array;
/**
* @param string $id
@@ -113,33 +93,31 @@ interface IManager {
* @throws \InvalidArgumentException when the filter was not found
* @since 11.0.0
*/
- public function getFilterById($id);
+ public function getFilterById(string $id): IFilter;
/**
* @param string $setting Class must implement OCA\Activity\ISetting
- * @return void
* @since 11.0.0
*/
- public function registerSetting($setting);
+ public function registerSetting(string $setting): void;
/**
* @return ISetting[]
* @since 11.0.0
*/
- public function getSettings();
+ public function getSettings(): array;
/**
* @param string $provider Class must implement OCA\Activity\IProvider
- * @return void
* @since 11.0.0
*/
- public function registerProvider($provider);
+ public function registerProvider(string $provider): void;
/**
* @return IProvider[]
* @since 11.0.0
*/
- public function getProviders();
+ public function getProviders(): array;
/**
* @param string $id
@@ -147,89 +125,32 @@ interface IManager {
* @throws \InvalidArgumentException when the setting was not found
* @since 11.0.0
*/
- public function getSettingById($id);
-
- /**
- * Will return additional notification types as specified by other apps
- *
- * @param string $languageCode
- * @return array Array "stringID of the type" => "translated string description for the setting"
- * or Array "stringID of the type" => [
- * 'desc' => "translated string description for the setting"
- * 'methods' => [\OCP\Activity\IExtension::METHOD_*],
- * ]
- * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
- * @deprecated 11.0.0 - Use getSettings() instead
- */
- public function getNotificationTypes($languageCode);
-
- /**
- * @param string $method
- * @return array
- * @since 8.0.0
- * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
- */
- public function getDefaultTypes($method);
-
- /**
- * @param string $type
- * @return string
- * @since 8.0.0
- */
- public function getTypeIcon($type);
+ public function getSettingById(string $id): ISetting;
/**
* @param string $type
* @param int $id
* @since 8.2.0
*/
- public function setFormattingObject($type, $id);
+ public function setFormattingObject(string $type, int $id): void;
/**
* @return bool
* @since 8.2.0
*/
- public function isFormattingFilteredObject();
+ public function isFormattingFilteredObject(): bool;
/**
* @param bool $status Set to true, when parsing events should not use SVG icons
* @since 12.0.1
*/
- public function setRequirePNG($status);
+ public function setRequirePNG(bool $status): void;
/**
* @return bool
* @since 12.0.1
*/
- public function getRequirePNG();
-
- /**
- * @param string $app
- * @param string $text
- * @param array $params
- * @param boolean $stripPath
- * @param boolean $highlightParams
- * @param string $languageCode
- * @return string|false
- * @since 8.0.0
- */
- public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
-
- /**
- * @param string $app
- * @param string $text
- * @return array|false
- * @since 8.0.0
- */
- public function getSpecialParameterList($app, $text);
-
- /**
- * @param array $activity
- * @return integer|false
- * @since 8.0.0
- */
- public function getGroupParameter($activity);
-
+ public function getRequirePNG(): bool;
/**
* Set the user we need to use
@@ -238,7 +159,7 @@ interface IManager {
* @throws \UnexpectedValueException If the user is invalid
* @since 9.0.1
*/
- public function setCurrentUserId($currentUserId);
+ public function setCurrentUserId(string $currentUserId = null): void;
/**
* Get the user we need to use
@@ -249,37 +170,5 @@ interface IManager {
* @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
* @since 8.1.0
*/
- public function getCurrentUserId();
-
- /**
- * @return array
- * @since 8.0.0
- * @deprecated 11.0.0 - Use getFilters() instead
- */
- public function getNavigation();
-
- /**
- * @param string $filterValue
- * @return boolean
- * @since 8.0.0
- * @deprecated 11.0.0 - Use getFilterById() instead
- */
- public function isFilterValid($filterValue);
-
- /**
- * @param array $types
- * @param string $filter
- * @return array
- * @since 8.0.0
- * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
- */
- public function filterNotificationTypes($types, $filter);
-
- /**
- * @param string $filter
- * @return array
- * @since 8.0.0
- * @deprecated 11.0.0 - Use getFilterById() instead
- */
- public function getQueryForFilter($filter);
+ public function getCurrentUserId(): string;
}