mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Extend the interfaces IManager and IConsumer to allow passing in the object

This commit is contained in:
Joas Schilling 2015-08-18 09:03:56 +02:00
parent 4c93a07196
commit bc2aa14849
3 changed files with 71 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
lib/private/activitymanager.php
View File

@ -124,20 +124,23 @@ class ActivityManager implements IManager {
}
/**
* @param $app
* @param $subject
* @param $subjectParams
* @param $message
* @param $messageParams
* @param $file
* @param $link
* @param $affectedUser
* @param $type
* @param $priority
* @return mixed
* @param string $app The app where this event is associated with
* @param string $subject A short description of the event
* @param array $subjectParams Array with parameters that are filled in the subject
* @param string $message A longer description of the event
* @param array $messageParams Array with parameters that are filled in the message
* @param string $file The file including path where this event is associated with
* @param string $link A link where this event is associated with
* @param string $affectedUser Recipient of the activity
* @param string $type Type of the notification
* @param int $priority Priority of the notification (@deprecated)
* @param string $objectType Object type can be used to filter the activities later (e.g. files)
* @param int $objectId Object id can be used to filter the activities later (e.g. the ID of the cache entry)
* @return null
*/
function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority) {
public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority, $objectType = '', $objectId = 0) {
foreach($this->getConsumers() as $c) {
try {
$c->receive(
$app,
@ -149,7 +152,9 @@ class ActivityManager implements IManager {
$link,
$affectedUser,
$type,
$priority);
$objectType,
$objectId
);
} catch (\Exception $ex) {
// TODO: log the exception
}
@ -164,7 +169,7 @@ class ActivityManager implements IManager {
*
* @param \Closure $callable
*/
function registerConsumer(\Closure $callable) {
public function registerConsumer(\Closure $callable) {
array_push($this->consumersClosures, $callable);
$this->consumers = [];
}
@ -178,7 +183,7 @@ class ActivityManager implements IManager {
* @param \Closure $callable
* @return void
*/
function registerExtension(\Closure $callable) {
public function registerExtension(\Closure $callable) {
array_push($this->extensionsClosures, $callable);
$this->extensions = [];
}
@ -189,7 +194,7 @@ class ActivityManager implements IManager {
* @param string $languageCode
* @return array
*/
function getNotificationTypes($languageCode) {
public function getNotificationTypes($languageCode) {
$notificationTypes = array();
foreach ($this->getExtensions() as $c) {
$result = $c->getNotificationTypes($languageCode);
@ -205,7 +210,7 @@ class ActivityManager implements IManager {
* @param string $method
* @return array
*/
function getDefaultTypes($method) {
public function getDefaultTypes($method) {
$defaultTypes = array();
foreach ($this->getExtensions() as $c) {
$types = $c->getDefaultTypes($method);
@ -220,7 +225,7 @@ class ActivityManager implements IManager {
* @param string $type
* @return string
*/
function getTypeIcon($type) {
public function getTypeIcon($type) {
if (isset($this->typeIcons[$type])) {
return $this->typeIcons[$type];
}
@ -246,7 +251,7 @@ class ActivityManager implements IManager {
* @param string $languageCode
* @return string|false
*/
function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
foreach ($this->getExtensions() as $c) {
$translation = $c->translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
if (is_string($translation)) {
@ -262,7 +267,7 @@ class ActivityManager implements IManager {
* @param string $text
* @return array|false
*/
function getSpecialParameterList($app, $text) {
public function getSpecialParameterList($app, $text) {
if (isset($this->specialParameters[$app][$text])) {
return $this->specialParameters[$app][$text];
}
@ -287,7 +292,7 @@ class ActivityManager implements IManager {
* @param array $activity
* @return integer|false
*/
function getGroupParameter($activity) {
public function getGroupParameter($activity) {
foreach ($this->getExtensions() as $c) {
$parameter = $c->getGroupParameter($activity);
if ($parameter !== false) {
@ -301,7 +306,7 @@ class ActivityManager implements IManager {
/**
* @return array
*/
function getNavigation() {
public function getNavigation() {
$entries = array(
'apps' => array(),
'top' => array(),
@ -321,7 +326,7 @@ class ActivityManager implements IManager {
* @param string $filterValue
* @return boolean
*/
function isFilterValid($filterValue) {
public function isFilterValid($filterValue) {
if (isset($this->validFilters[$filterValue])) {
return $this->validFilters[$filterValue];
}
@ -342,7 +347,7 @@ class ActivityManager implements IManager {
* @param string $filter
* @return array
*/
function filterNotificationTypes($types, $filter) {
public function filterNotificationTypes($types, $filter) {
if (!$this->isFilterValid($filter)) {
return $types;
}
@ -360,7 +365,7 @@ class ActivityManager implements IManager {
* @param string $filter
* @return array
*/
function getQueryForFilter($filter) {
public function getQueryForFilter($filter) {
if (!$this->isFilterValid($filter)) {
return [null, null];
}

26
lib/public/activity/iconsumer.php
View File

@ -37,19 +37,21 @@ namespace OCP\Activity;
*/
interface IConsumer {
/**
* @param $app
* @param $subject
* @param $subjectParams
* @param $message
* @param $messageParams
* @param $file
* @param $link
* @param $affectedUser
* @param $type
* @param $priority
* @return mixed
* @param string $app The app where this event is associated with
* @param string $subject A short description of the event
* @param array $subjectParams Array with parameters that are filled in the subject
* @param string $message A longer description of the event
* @param array $messageParams Array with parameters that are filled in the message
* @param string $file The file including path where this event is associated with
* @param string $link A link where this event is associated with
* @param string $affectedUser Recipient of the notification
* @param string $type Type of the notification
* @param string $objectType Object type can be used to filter the activities later (e.g. files)
* @param int $objectId Object id can be used to filter the activities later (e.g. the ID of the cache entry)
* @return null
* @since 6.0.0
* @since 8.2.0 Added $objectType and $objectId
*/
function receive($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority );
public function receive($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $objectType, $objectId);
}

51
lib/public/activity/imanager.php
View File

@ -40,20 +40,23 @@ namespace OCP\Activity;
interface IManager {
/**
* @param $app
* @param $subject
* @param $subjectParams
* @param $message
* @param $messageParams
* @param $file
* @param $link
* @param $affectedUser
* @param $type
* @param $priority
* @return mixed
* @param string $app The app where this event is associated with
* @param string $subject A short description of the event
* @param array $subjectParams Array with parameters that are filled in the subject
* @param string $message A longer description of the event
* @param array $messageParams Array with parameters that are filled in the message
* @param string $file The file including path where this event is associated with
* @param string $link A link where this event is associated with
* @param string $affectedUser Recipient of the activity
* @param string $type Type of the notification
* @param int $priority Priority of the notification (@deprecated)
* @param string $objectType Object type can be used to filter the activities later (e.g. files)
* @param int $objectId Object id can be used to filter the activities later (e.g. the ID of the cache entry)
* @return null
* @since 6.0.0
* @since 8.2.0 Added $objectType and $objectId
*/
function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority, $objectType = '', $objectId = 0);
/**
* In order to improve lazy loading a closure can be registered which will be called in case
@ -65,7 +68,7 @@ interface IManager {
* @return void
* @since 6.0.0
*/
function registerConsumer(\Closure $callable);
public function registerConsumer(\Closure $callable);
/**
* In order to improve lazy loading a closure can be registered which will be called in case
@ -77,7 +80,7 @@ interface IManager {
* @return void
* @since 8.0.0
*/
function registerExtension(\Closure $callable);
public function registerExtension(\Closure $callable);
/**
* Will return additional notification types as specified by other apps
@ -91,21 +94,21 @@ interface IManager {
* @since 8.0.0
* @changed 8.2.0 - Added support to allow limiting notifications to certain methods
*/
function getNotificationTypes($languageCode);
public function getNotificationTypes($languageCode);
/**
* @param string $method
* @return array
* @since 8.0.0
*/
function getDefaultTypes($method);
public function getDefaultTypes($method);
/**
* @param string $type
* @return string
* @since 8.0.0
*/
function getTypeIcon($type);
public function getTypeIcon($type);
/**
* @param string $app
@ -117,7 +120,7 @@ interface IManager {
* @return string|false
* @since 8.0.0
*/
function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
/**
* @param string $app
@ -125,27 +128,27 @@ interface IManager {
* @return array|false
* @since 8.0.0
*/
function getSpecialParameterList($app, $text);
public function getSpecialParameterList($app, $text);
/**
* @param array $activity
* @return integer|false
* @since 8.0.0
*/
function getGroupParameter($activity);
public function getGroupParameter($activity);
/**
* @return array
* @since 8.0.0
*/
function getNavigation();
public function getNavigation();
/**
* @param string $filterValue
* @return boolean
* @since 8.0.0
*/
function isFilterValid($filterValue);
public function isFilterValid($filterValue);
/**
* @param array $types
@ -153,14 +156,14 @@ interface IManager {
* @return array
* @since 8.0.0
*/
function filterNotificationTypes($types, $filter);
public function filterNotificationTypes($types, $filter);
/**
* @param string $filter
* @return array
* @since 8.0.0
*/
function getQueryForFilter($filter);
public function getQueryForFilter($filter);
/**
* Get the user we need to use