Signed-off-by: Joas Schilling <coding@schilljs.com>tags/v11.0RC2
@@ -64,7 +64,7 @@ class Favorites implements IFilter { | |||
/** | |||
* @return string Lowercase a-z only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'files_favorites'; | |||
@@ -72,7 +72,7 @@ class Favorites implements IFilter { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('Favorites'); | |||
@@ -80,7 +80,7 @@ class Favorites implements IFilter { | |||
/** | |||
* @return int | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 10; | |||
@@ -88,7 +88,7 @@ class Favorites implements IFilter { | |||
/** | |||
* @return string Full URL to an icon, empty string when none is given | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIcon() { | |||
return $this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/star-dark.svg')); | |||
@@ -97,7 +97,7 @@ class Favorites implements IFilter { | |||
/** | |||
* @param string[] $types | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function filterTypes(array $types) { | |||
return array_intersect([ | |||
@@ -110,7 +110,7 @@ class Favorites implements IFilter { | |||
/** | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function allowedApps() { | |||
return ['files']; |
@@ -41,7 +41,7 @@ class FileChanges implements IFilter { | |||
/** | |||
* @return string Lowercase a-z only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'files'; | |||
@@ -49,7 +49,7 @@ class FileChanges implements IFilter { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('File changes'); | |||
@@ -57,7 +57,7 @@ class FileChanges implements IFilter { | |||
/** | |||
* @return int | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 30; | |||
@@ -65,7 +65,7 @@ class FileChanges implements IFilter { | |||
/** | |||
* @return string Full URL to an icon, empty string when none is given | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIcon() { | |||
return $this->url->getAbsoluteURL($this->url->imagePath('core', 'places/files-dark.svg')); | |||
@@ -74,7 +74,7 @@ class FileChanges implements IFilter { | |||
/** | |||
* @param string[] $types | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function filterTypes(array $types) { | |||
return array_intersect([ | |||
@@ -87,7 +87,7 @@ class FileChanges implements IFilter { | |||
/** | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function allowedApps() { | |||
return ['files']; |
@@ -55,7 +55,7 @@ class Provider implements IProvider { | |||
* @param IEvent|null $previousEvent | |||
* @return IEvent | |||
* @throws \InvalidArgumentException | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function parse(IEvent $event, IEvent $previousEvent = null) { | |||
if ($event->getApp() !== 'files') { | |||
@@ -82,7 +82,7 @@ class Provider implements IProvider { | |||
* @param IEvent $event | |||
* @return IEvent | |||
* @throws \InvalidArgumentException | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function parseShortVersion(IEvent $event) { | |||
$parsedParameters = $this->getParsedParameters($event->getSubject(), $event->getSubjectParameters()); | |||
@@ -122,7 +122,7 @@ class Provider implements IProvider { | |||
* @param IEvent $event | |||
* @return IEvent | |||
* @throws \InvalidArgumentException | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function parseLongVersion(IEvent $event) { | |||
$parsedParameters = $this->getParsedParameters($event->getSubject(), $event->getSubjectParameters()); |
@@ -39,7 +39,7 @@ class FileChanged implements ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'file_changed'; | |||
@@ -47,7 +47,7 @@ class FileChanged implements ISetting { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('A file or folder has been <strong>changed</strong> or <strong>renamed</strong>'); | |||
@@ -57,7 +57,7 @@ class FileChanged implements ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 1; | |||
@@ -65,7 +65,7 @@ class FileChanged implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream() { | |||
return true; | |||
@@ -73,7 +73,7 @@ class FileChanged implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream() { | |||
return true; | |||
@@ -81,7 +81,7 @@ class FileChanged implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail() { | |||
return true; | |||
@@ -89,7 +89,7 @@ class FileChanged implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail() { | |||
return false; |
@@ -39,7 +39,7 @@ class FileCreated implements ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'file_created'; | |||
@@ -47,7 +47,7 @@ class FileCreated implements ISetting { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('A new file or folder has been <strong>created</strong>'); | |||
@@ -57,7 +57,7 @@ class FileCreated implements ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 0; | |||
@@ -65,7 +65,7 @@ class FileCreated implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream() { | |||
return true; | |||
@@ -73,7 +73,7 @@ class FileCreated implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream() { | |||
return true; | |||
@@ -81,7 +81,7 @@ class FileCreated implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail() { | |||
return true; | |||
@@ -89,7 +89,7 @@ class FileCreated implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail() { | |||
return false; |
@@ -39,7 +39,7 @@ class FileDeleted implements ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'file_deleted'; | |||
@@ -47,7 +47,7 @@ class FileDeleted implements ISetting { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('A new file or folder has been <strong>deleted</strong>'); | |||
@@ -57,7 +57,7 @@ class FileDeleted implements ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 3; | |||
@@ -65,7 +65,7 @@ class FileDeleted implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream() { | |||
return true; | |||
@@ -73,7 +73,7 @@ class FileDeleted implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream() { | |||
return true; | |||
@@ -81,7 +81,7 @@ class FileDeleted implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail() { | |||
return true; | |||
@@ -89,7 +89,7 @@ class FileDeleted implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail() { | |||
return false; |
@@ -39,7 +39,7 @@ class FileFavorite implements ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'file_favorite'; | |||
@@ -47,7 +47,7 @@ class FileFavorite implements ISetting { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('Limit notifications about creation and changes to your <strong>favorite files</strong> <em>(Stream only)</em>'); | |||
@@ -57,7 +57,7 @@ class FileFavorite implements ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 2; | |||
@@ -65,7 +65,7 @@ class FileFavorite implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream() { | |||
return true; | |||
@@ -73,7 +73,7 @@ class FileFavorite implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream() { | |||
return false; | |||
@@ -81,7 +81,7 @@ class FileFavorite implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail() { | |||
return false; | |||
@@ -89,7 +89,7 @@ class FileFavorite implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail() { | |||
return false; |
@@ -39,7 +39,7 @@ class FileRestored implements ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return 'file_restored'; | |||
@@ -47,7 +47,7 @@ class FileRestored implements ISetting { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->l->t('A new file or folder has been <strong>restored</strong>'); | |||
@@ -57,7 +57,7 @@ class FileRestored implements ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 4; | |||
@@ -65,7 +65,7 @@ class FileRestored implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream() { | |||
return true; | |||
@@ -73,7 +73,7 @@ class FileRestored implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream() { | |||
return true; | |||
@@ -81,7 +81,7 @@ class FileRestored implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail() { | |||
return true; | |||
@@ -89,7 +89,7 @@ class FileRestored implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail() { | |||
return false; |
@@ -233,7 +233,7 @@ class Event implements IEvent { | |||
* @param string $subject | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject is invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setParsedSubject($subject) { | |||
if (!is_string($subject) || $subject === '') { | |||
@@ -245,7 +245,7 @@ class Event implements IEvent { | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getParsedSubject() { | |||
return $this->subjectParsed; | |||
@@ -256,7 +256,7 @@ class Event implements IEvent { | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setRichSubject($subject, array $parameters = []) { | |||
if (!is_string($subject) || $subject === '') { | |||
@@ -274,7 +274,7 @@ class Event implements IEvent { | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichSubject() { | |||
return $this->subjectRich; | |||
@@ -282,7 +282,7 @@ class Event implements IEvent { | |||
/** | |||
* @return array[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichSubjectParameters() { | |||
return $this->subjectRichParameters; | |||
@@ -324,7 +324,7 @@ class Event implements IEvent { | |||
* @param string $message | |||
* @return $this | |||
* @throws \InvalidArgumentException if the message is invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setParsedMessage($message) { | |||
if (!is_string($message)) { | |||
@@ -336,7 +336,7 @@ class Event implements IEvent { | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getParsedMessage() { | |||
return $this->messageParsed; | |||
@@ -347,7 +347,7 @@ class Event implements IEvent { | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setRichMessage($message, array $parameters = []) { | |||
if (!is_string($message)) { | |||
@@ -365,7 +365,7 @@ class Event implements IEvent { | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichMessage() { | |||
return $this->messageRich; | |||
@@ -373,7 +373,7 @@ class Event implements IEvent { | |||
/** | |||
* @return array[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichMessageParameters() { | |||
return $this->messageRichParameters; | |||
@@ -453,7 +453,7 @@ class Event implements IEvent { | |||
* @param string $icon | |||
* @return $this | |||
* @throws \InvalidArgumentException if the icon is invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setIcon($icon) { | |||
if (!is_string($icon) || isset($icon[4000])) { | |||
@@ -465,7 +465,7 @@ class Event implements IEvent { | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIcon() { | |||
return $this->icon; | |||
@@ -473,7 +473,7 @@ class Event implements IEvent { | |||
/** | |||
* @param IEvent $child | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setChildEvent(IEvent $child) { | |||
$this->child = $child; | |||
@@ -481,7 +481,7 @@ class Event implements IEvent { | |||
/** | |||
* @return IEvent|null | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getChildEvent() { | |||
return $this->child; |
@@ -55,7 +55,7 @@ class LegacyFilter implements IFilter { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return $this->identifier; | |||
@@ -63,7 +63,7 @@ class LegacyFilter implements IFilter { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->name; | |||
@@ -73,7 +73,7 @@ class LegacyFilter implements IFilter { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return $this->isTopFilter ? 40 : 50; | |||
@@ -81,7 +81,7 @@ class LegacyFilter implements IFilter { | |||
/** | |||
* @return string Full URL to an icon, empty string when none is given | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIcon() { | |||
// Old API was CSS class, so we can not use this... | |||
@@ -91,7 +91,7 @@ class LegacyFilter implements IFilter { | |||
/** | |||
* @param string[] $types | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function filterTypes(array $types) { | |||
return $this->manager->filterNotificationTypes($types, $this->getIdentifier()); | |||
@@ -99,7 +99,7 @@ class LegacyFilter implements IFilter { | |||
/** | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function allowedApps() { | |||
return []; |
@@ -64,7 +64,7 @@ class LegacySetting implements ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier() { | |||
return $this->identifier; | |||
@@ -72,7 +72,7 @@ class LegacySetting implements ISetting { | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName() { | |||
return $this->name; | |||
@@ -82,7 +82,7 @@ class LegacySetting implements ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority() { | |||
return 70; | |||
@@ -90,7 +90,7 @@ class LegacySetting implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream() { | |||
return $this->canChangeStream; | |||
@@ -98,7 +98,7 @@ class LegacySetting implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream() { | |||
return $this->isDefaultEnabledStream; | |||
@@ -106,7 +106,7 @@ class LegacySetting implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail() { | |||
return $this->canChangeMail; | |||
@@ -114,7 +114,7 @@ class LegacySetting implements ISetting { | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail() { | |||
return $this->isDefaultEnabledMail; |
@@ -301,7 +301,7 @@ class Manager implements IManager { | |||
* @param string $id | |||
* @return IFilter | |||
* @throws \InvalidArgumentException when the filter was not found | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getFilterById($id) { | |||
$filters = $this->getFilters(); | |||
@@ -413,7 +413,7 @@ class Manager implements IManager { | |||
* @param string $id | |||
* @return ISetting | |||
* @throws \InvalidArgumentException when the setting was not found | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getSettingById($id) { | |||
$settings = $this->getSettings(); | |||
@@ -581,7 +581,7 @@ class Manager implements IManager { | |||
/** | |||
* @return array | |||
* @deprecated 9.2.0 - Use getFilters() instead | |||
* @deprecated 11.0.0 - Use getFilters() instead | |||
*/ | |||
public function getNavigation() { | |||
$entries = array( | |||
@@ -602,7 +602,7 @@ class Manager implements IManager { | |||
/** | |||
* @param string $filterValue | |||
* @return boolean | |||
* @deprecated 9.2.0 - Use getFilterById() instead | |||
* @deprecated 11.0.0 - Use getFilterById() instead | |||
*/ | |||
public function isFilterValid($filterValue) { | |||
if (isset($this->validFilters[$filterValue])) { | |||
@@ -624,7 +624,7 @@ class Manager implements IManager { | |||
* @param array $types | |||
* @param string $filter | |||
* @return array | |||
* @deprecated 9.2.0 - Use getFilterById()->filterTypes() instead | |||
* @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead | |||
*/ | |||
public function filterNotificationTypes($types, $filter) { | |||
if (!$this->isFilterValid($filter)) { | |||
@@ -643,7 +643,7 @@ class Manager implements IManager { | |||
/** | |||
* @param string $filter | |||
* @return array | |||
* @deprecated 9.2.0 - Use getFilterById() instead | |||
* @deprecated 11.0.0 - Use getFilterById() instead | |||
*/ | |||
public function getQueryForFilter($filter) { | |||
if (!$this->isFilterValid($filter)) { | |||
@@ -676,7 +676,7 @@ class Manager implements IManager { | |||
* | |||
* @param string $languageCode | |||
* @return array | |||
* @deprecated 9.2.0 - Use getSettings() instead | |||
* @deprecated 11.0.0 - Use getSettings() instead | |||
*/ | |||
public function getNotificationTypes($languageCode) { | |||
$notificationTypes = $sharingNotificationTypes = []; | |||
@@ -698,7 +698,7 @@ class Manager implements IManager { | |||
/** | |||
* @param string $method | |||
* @return array | |||
* @deprecated 9.2.0 - Use getSettings()->isDefaulEnabled<method>() instead | |||
* @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead | |||
*/ | |||
public function getDefaultTypes($method) { | |||
$defaultTypes = array(); |
@@ -101,13 +101,13 @@ interface IEvent { | |||
* @param string $subject | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject is invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setParsedSubject($subject); | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getParsedSubject(); | |||
@@ -116,19 +116,19 @@ interface IEvent { | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the subject or parameters are invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setRichSubject($subject, array $parameters = []); | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichSubject(); | |||
/** | |||
* @return array[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichSubjectParameters(); | |||
@@ -147,13 +147,13 @@ interface IEvent { | |||
* @param string $message | |||
* @return $this | |||
* @throws \InvalidArgumentException if the message is invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setParsedMessage($message); | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getParsedMessage(); | |||
@@ -162,19 +162,19 @@ interface IEvent { | |||
* @param array $parameters | |||
* @return $this | |||
* @throws \InvalidArgumentException if the message or parameters are invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setRichMessage($message, array $parameters = []); | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichMessage(); | |||
/** | |||
* @return array[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getRichMessageParameters(); | |||
@@ -282,37 +282,37 @@ interface IEvent { | |||
* @param string $icon | |||
* @return $this | |||
* @throws \InvalidArgumentException if the icon is invalid | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setIcon($icon); | |||
/** | |||
* @return string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIcon(); | |||
/** | |||
* @param IEvent $child | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function setChildEvent(IEvent $child); | |||
/** | |||
* @return IEvent|null | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getChildEvent(); | |||
/** | |||
* @return bool | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isValid(); | |||
/** | |||
* @return bool | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isValidParsed(); | |||
} |
@@ -129,7 +129,7 @@ interface IExtension { | |||
* | |||
* @return array|false | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Register an IFilter instead | |||
* @deprecated 11.0.0 - Register an IFilter instead | |||
*/ | |||
public function getNavigation(); | |||
@@ -139,7 +139,7 @@ interface IExtension { | |||
* @param string $filterValue | |||
* @return boolean | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Register an IFilter instead | |||
* @deprecated 11.0.0 - Register an IFilter instead | |||
*/ | |||
public function isFilterValid($filterValue); | |||
@@ -151,7 +151,7 @@ interface IExtension { | |||
* @param string $filter | |||
* @return array|false | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Register an IFilter instead | |||
* @deprecated 11.0.0 - Register an IFilter instead | |||
*/ | |||
public function filterNotificationTypes($types, $filter); | |||
@@ -164,7 +164,7 @@ interface IExtension { | |||
* @param string $filter | |||
* @return array|false | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Register an IFilter instead | |||
* @deprecated 11.0.0 - Register an IFilter instead | |||
*/ | |||
public function getQueryForFilter($filter); | |||
} |
@@ -28,19 +28,19 @@ namespace OCP\Activity; | |||
* Interface IFilter | |||
* | |||
* @package OCP\Activity | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
interface IFilter { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier(); | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName(); | |||
@@ -48,26 +48,26 @@ interface IFilter { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority(); | |||
/** | |||
* @return string Full URL to an icon, empty string when none is given | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIcon(); | |||
/** | |||
* @param string[] $types | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function filterTypes(array $types); | |||
/** | |||
* @return string[] An array of allowed apps from which activities should be displayed | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function allowedApps(); | |||
} |
@@ -111,13 +111,13 @@ interface IManager { | |||
/** | |||
* @param string $filter Class must implement OCA\Activity\IFilter | |||
* @return void | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function registerFilter($filter); | |||
/** | |||
* @return IFilter[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getFilters(); | |||
@@ -125,33 +125,33 @@ interface IManager { | |||
* @param string $id | |||
* @return IFilter | |||
* @throws \InvalidArgumentException when the filter was not found | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getFilterById($id); | |||
/** | |||
* @param string $setting Class must implement OCA\Activity\ISetting | |||
* @return void | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function registerSetting($setting); | |||
/** | |||
* @return ISetting[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getSettings(); | |||
/** | |||
* @param string $provider Class must implement OCA\Activity\IProvider | |||
* @return void | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function registerProvider($provider); | |||
/** | |||
* @return IProvider[] | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getProviders(); | |||
@@ -159,7 +159,7 @@ interface IManager { | |||
* @param string $id | |||
* @return ISetting | |||
* @throws \InvalidArgumentException when the setting was not found | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getSettingById($id); | |||
@@ -173,7 +173,7 @@ interface IManager { | |||
* 'methods' => [\OCP\Activity\IExtension::METHOD_*], | |||
* ] | |||
* @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods | |||
* @deprecated 9.2.0 - Use getSettings() instead | |||
* @deprecated 11.0.0 - Use getSettings() instead | |||
*/ | |||
public function getNotificationTypes($languageCode); | |||
@@ -181,7 +181,7 @@ interface IManager { | |||
* @param string $method | |||
* @return array | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Use getSettings()->isDefaulEnabled<method>() instead | |||
* @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead | |||
*/ | |||
public function getDefaultTypes($method); | |||
@@ -256,7 +256,7 @@ interface IManager { | |||
/** | |||
* @return array | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Use getFilters() instead | |||
* @deprecated 11.0.0 - Use getFilters() instead | |||
*/ | |||
public function getNavigation(); | |||
@@ -264,7 +264,7 @@ interface IManager { | |||
* @param string $filterValue | |||
* @return boolean | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Use getFilterById() instead | |||
* @deprecated 11.0.0 - Use getFilterById() instead | |||
*/ | |||
public function isFilterValid($filterValue); | |||
@@ -273,7 +273,7 @@ interface IManager { | |||
* @param string $filter | |||
* @return array | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Use getFilterById()->filterTypes() instead | |||
* @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead | |||
*/ | |||
public function filterNotificationTypes($types, $filter); | |||
@@ -281,7 +281,7 @@ interface IManager { | |||
* @param string $filter | |||
* @return array | |||
* @since 8.0.0 | |||
* @deprecated 9.2.0 - Use getFilterById() instead | |||
* @deprecated 11.0.0 - Use getFilterById() instead | |||
*/ | |||
public function getQueryForFilter($filter); | |||
} |
@@ -25,7 +25,7 @@ namespace OCP\Activity; | |||
* Interface IProvider | |||
* | |||
* @package OCP\Activity | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
interface IProvider { | |||
/** | |||
@@ -33,7 +33,7 @@ interface IProvider { | |||
* @param IEvent|null $previousEvent | |||
* @return IEvent | |||
* @throws \InvalidArgumentException | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function parse(IEvent $event, IEvent $previousEvent = null); | |||
} |
@@ -25,19 +25,19 @@ namespace OCP\Activity; | |||
* Interface ISetting | |||
* | |||
* @package OCP\Activity | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
interface ISetting { | |||
/** | |||
* @return string Lowercase a-z and underscore only identifier | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getIdentifier(); | |||
/** | |||
* @return string A translated string | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getName(); | |||
@@ -45,31 +45,31 @@ interface ISetting { | |||
* @return int whether the filter should be rather on the top or bottom of | |||
* the admin section. The filters are arranged in ascending order of the | |||
* priority values. It is required to return a value between 0 and 100. | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function getPriority(); | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeStream(); | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledStream(); | |||
/** | |||
* @return bool True when the option can be changed for the mail | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function canChangeMail(); | |||
/** | |||
* @return bool True when the option can be changed for the stream | |||
* @since 9.2.0 | |||
* @since 11.0.0 | |||
*/ | |||
public function isDefaultEnabledMail(); | |||
} |