@@ -29,43 +29,43 @@ |
||
29 | 29 | */ |
30 | 30 | interface IFilter { |
31 | 31 | |
32 | - /** |
|
33 | - * @return string Lowercase a-z and underscore only identifier |
|
34 | - * @since 11.0.0 |
|
35 | - */ |
|
36 | - public function getIdentifier(); |
|
32 | + /** |
|
33 | + * @return string Lowercase a-z and underscore only identifier |
|
34 | + * @since 11.0.0 |
|
35 | + */ |
|
36 | + public function getIdentifier(); |
|
37 | 37 | |
38 | - /** |
|
39 | - * @return string A translated string |
|
40 | - * @since 11.0.0 |
|
41 | - */ |
|
42 | - public function getName(); |
|
38 | + /** |
|
39 | + * @return string A translated string |
|
40 | + * @since 11.0.0 |
|
41 | + */ |
|
42 | + public function getName(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * @return int whether the filter should be rather on the top or bottom of |
|
46 | - * the admin section. The filters are arranged in ascending order of the |
|
47 | - * priority values. It is required to return a value between 0 and 100. |
|
48 | - * @since 11.0.0 |
|
49 | - */ |
|
50 | - public function getPriority(); |
|
44 | + /** |
|
45 | + * @return int whether the filter should be rather on the top or bottom of |
|
46 | + * the admin section. The filters are arranged in ascending order of the |
|
47 | + * priority values. It is required to return a value between 0 and 100. |
|
48 | + * @since 11.0.0 |
|
49 | + */ |
|
50 | + public function getPriority(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return string Full URL to an icon, empty string when none is given |
|
54 | - * @since 11.0.0 |
|
55 | - */ |
|
56 | - public function getIcon(); |
|
52 | + /** |
|
53 | + * @return string Full URL to an icon, empty string when none is given |
|
54 | + * @since 11.0.0 |
|
55 | + */ |
|
56 | + public function getIcon(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param string[] $types |
|
60 | - * @return string[] An array of allowed apps from which activities should be displayed |
|
61 | - * @since 11.0.0 |
|
62 | - */ |
|
63 | - public function filterTypes(array $types); |
|
58 | + /** |
|
59 | + * @param string[] $types |
|
60 | + * @return string[] An array of allowed apps from which activities should be displayed |
|
61 | + * @since 11.0.0 |
|
62 | + */ |
|
63 | + public function filterTypes(array $types); |
|
64 | 64 | |
65 | - /** |
|
66 | - * @return string[] An array of allowed apps from which activities should be displayed |
|
67 | - * @since 11.0.0 |
|
68 | - */ |
|
69 | - public function allowedApps(); |
|
65 | + /** |
|
66 | + * @return string[] An array of allowed apps from which activities should be displayed |
|
67 | + * @since 11.0.0 |
|
68 | + */ |
|
69 | + public function allowedApps(); |
|
70 | 70 | } |
71 | 71 |
@@ -30,35 +30,35 @@ |
||
30 | 30 | */ |
31 | 31 | interface IEventMerger { |
32 | 32 | |
33 | - /** |
|
34 | - * Combines two events when possible to have grouping: |
|
35 | - * |
|
36 | - * Example1: Two events with subject '{user} created {file}' and |
|
37 | - * $mergeParameter file with different file and same user will be merged |
|
38 | - * to '{user} created {file1} and {file2}' and the childEvent on the return |
|
39 | - * will be set, if the events have been merged. |
|
40 | - * |
|
41 | - * Example2: Two events with subject '{user} created {file}' and |
|
42 | - * $mergeParameter file with same file and same user will be merged to |
|
43 | - * '{user} created {file1}' and the childEvent on the return will be set, if |
|
44 | - * the events have been merged. |
|
45 | - * |
|
46 | - * The following requirements have to be met, in order to be merged: |
|
47 | - * - Both events need to have the same `getApp()` |
|
48 | - * - Both events must not have a message `getMessage()` |
|
49 | - * - Both events need to have the same subject `getSubject()` |
|
50 | - * - Both events need to have the same object type `getObjectType()` |
|
51 | - * - The time difference between both events must not be bigger then 3 hours |
|
52 | - * - Only up to 5 events can be merged. |
|
53 | - * - All parameters apart from such starting with $mergeParameter must be |
|
54 | - * the same for both events. |
|
55 | - * |
|
56 | - * @param string $mergeParameter |
|
57 | - * @param IEvent $event |
|
58 | - * @param IEvent|null $previousEvent |
|
59 | - * @return IEvent |
|
60 | - * @since 11.0 |
|
61 | - */ |
|
62 | - public function mergeEvents($mergeParameter, IEvent $event, IEvent $previousEvent = null); |
|
33 | + /** |
|
34 | + * Combines two events when possible to have grouping: |
|
35 | + * |
|
36 | + * Example1: Two events with subject '{user} created {file}' and |
|
37 | + * $mergeParameter file with different file and same user will be merged |
|
38 | + * to '{user} created {file1} and {file2}' and the childEvent on the return |
|
39 | + * will be set, if the events have been merged. |
|
40 | + * |
|
41 | + * Example2: Two events with subject '{user} created {file}' and |
|
42 | + * $mergeParameter file with same file and same user will be merged to |
|
43 | + * '{user} created {file1}' and the childEvent on the return will be set, if |
|
44 | + * the events have been merged. |
|
45 | + * |
|
46 | + * The following requirements have to be met, in order to be merged: |
|
47 | + * - Both events need to have the same `getApp()` |
|
48 | + * - Both events must not have a message `getMessage()` |
|
49 | + * - Both events need to have the same subject `getSubject()` |
|
50 | + * - Both events need to have the same object type `getObjectType()` |
|
51 | + * - The time difference between both events must not be bigger then 3 hours |
|
52 | + * - Only up to 5 events can be merged. |
|
53 | + * - All parameters apart from such starting with $mergeParameter must be |
|
54 | + * the same for both events. |
|
55 | + * |
|
56 | + * @param string $mergeParameter |
|
57 | + * @param IEvent $event |
|
58 | + * @param IEvent|null $previousEvent |
|
59 | + * @return IEvent |
|
60 | + * @since 11.0 |
|
61 | + */ |
|
62 | + public function mergeEvents($mergeParameter, IEvent $event, IEvent $previousEvent = null); |
|
63 | 63 | |
64 | 64 | } |
@@ -29,48 +29,48 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISetting { |
31 | 31 | |
32 | - /** |
|
33 | - * @return string Lowercase a-z and underscore only identifier |
|
34 | - * @since 11.0.0 |
|
35 | - */ |
|
36 | - public function getIdentifier(); |
|
32 | + /** |
|
33 | + * @return string Lowercase a-z and underscore only identifier |
|
34 | + * @since 11.0.0 |
|
35 | + */ |
|
36 | + public function getIdentifier(); |
|
37 | 37 | |
38 | - /** |
|
39 | - * @return string A translated string |
|
40 | - * @since 11.0.0 |
|
41 | - */ |
|
42 | - public function getName(); |
|
38 | + /** |
|
39 | + * @return string A translated string |
|
40 | + * @since 11.0.0 |
|
41 | + */ |
|
42 | + public function getName(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * @return int whether the filter should be rather on the top or bottom of |
|
46 | - * the admin section. The filters are arranged in ascending order of the |
|
47 | - * priority values. It is required to return a value between 0 and 100. |
|
48 | - * @since 11.0.0 |
|
49 | - */ |
|
50 | - public function getPriority(); |
|
44 | + /** |
|
45 | + * @return int whether the filter should be rather on the top or bottom of |
|
46 | + * the admin section. The filters are arranged in ascending order of the |
|
47 | + * priority values. It is required to return a value between 0 and 100. |
|
48 | + * @since 11.0.0 |
|
49 | + */ |
|
50 | + public function getPriority(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return bool True when the option can be changed for the stream |
|
54 | - * @since 11.0.0 |
|
55 | - */ |
|
56 | - public function canChangeStream(); |
|
52 | + /** |
|
53 | + * @return bool True when the option can be changed for the stream |
|
54 | + * @since 11.0.0 |
|
55 | + */ |
|
56 | + public function canChangeStream(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @return bool True when the option can be changed for the stream |
|
60 | - * @since 11.0.0 |
|
61 | - */ |
|
62 | - public function isDefaultEnabledStream(); |
|
58 | + /** |
|
59 | + * @return bool True when the option can be changed for the stream |
|
60 | + * @since 11.0.0 |
|
61 | + */ |
|
62 | + public function isDefaultEnabledStream(); |
|
63 | 63 | |
64 | - /** |
|
65 | - * @return bool True when the option can be changed for the mail |
|
66 | - * @since 11.0.0 |
|
67 | - */ |
|
68 | - public function canChangeMail(); |
|
64 | + /** |
|
65 | + * @return bool True when the option can be changed for the mail |
|
66 | + * @since 11.0.0 |
|
67 | + */ |
|
68 | + public function canChangeMail(); |
|
69 | 69 | |
70 | - /** |
|
71 | - * @return bool True when the option can be changed for the stream |
|
72 | - * @since 11.0.0 |
|
73 | - */ |
|
74 | - public function isDefaultEnabledMail(); |
|
70 | + /** |
|
71 | + * @return bool True when the option can be changed for the stream |
|
72 | + * @since 11.0.0 |
|
73 | + */ |
|
74 | + public function isDefaultEnabledMail(); |
|
75 | 75 | } |
76 | 76 |
@@ -28,15 +28,15 @@ |
||
28 | 28 | * @since 11.0.0 |
29 | 29 | */ |
30 | 30 | interface IProvider { |
31 | - /** |
|
32 | - * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | - * @param IEvent $event The current event which should be parsed |
|
34 | - * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | - * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | - * combined subject on the current event. |
|
37 | - * @return IEvent |
|
38 | - * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | - * @since 11.0.0 |
|
40 | - */ |
|
41 | - public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
31 | + /** |
|
32 | + * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | + * @param IEvent $event The current event which should be parsed |
|
34 | + * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | + * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | + * combined subject on the current event. |
|
37 | + * @return IEvent |
|
38 | + * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | + * @since 11.0.0 |
|
40 | + */ |
|
41 | + public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
42 | 42 | } |
@@ -38,12 +38,12 @@ |
||
38 | 38 | * @since 6.0.0 |
39 | 39 | */ |
40 | 40 | interface IConsumer { |
41 | - /** |
|
42 | - * @param IEvent $event |
|
43 | - * @return null |
|
44 | - * @since 6.0.0 |
|
45 | - * @since 8.2.0 Replaced the parameters with an IEvent object |
|
46 | - */ |
|
47 | - public function receive(IEvent $event); |
|
41 | + /** |
|
42 | + * @param IEvent $event |
|
43 | + * @return null |
|
44 | + * @since 6.0.0 |
|
45 | + * @since 8.2.0 Replaced the parameters with an IEvent object |
|
46 | + */ |
|
47 | + public function receive(IEvent $event); |
|
48 | 48 | } |
49 | 49 |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @since 8.2.2 |
30 | 30 | */ |
31 | 31 | interface IMemcacheTTL extends IMemcache { |
32 | - /** |
|
33 | - * Set the ttl for an existing value |
|
34 | - * |
|
35 | - * @param string $key |
|
36 | - * @param int $ttl time to live in seconds |
|
37 | - * @since 8.2.2 |
|
38 | - */ |
|
39 | - public function setTTL($key, $ttl); |
|
32 | + /** |
|
33 | + * Set the ttl for an existing value |
|
34 | + * |
|
35 | + * @param string $key |
|
36 | + * @param int $ttl time to live in seconds |
|
37 | + * @since 8.2.2 |
|
38 | + */ |
|
39 | + public function setTTL($key, $ttl); |
|
40 | 40 | } |
@@ -30,10 +30,10 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IDateTimeZone { |
33 | - /** |
|
34 | - * @param bool|int $timestamp |
|
35 | - * @return \DateTimeZone |
|
36 | - * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
37 | - */ |
|
38 | - public function getTimeZone($timestamp = false); |
|
33 | + /** |
|
34 | + * @param bool|int $timestamp |
|
35 | + * @return \DateTimeZone |
|
36 | + * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
37 | + */ |
|
38 | + public function getTimeZone($timestamp = false); |
|
39 | 39 | } |
@@ -31,9 +31,9 @@ |
||
31 | 31 | */ |
32 | 32 | interface ICommentsEventHandler { |
33 | 33 | |
34 | - /** |
|
35 | - * @param CommentsEvent $event |
|
36 | - * @since 11.0.0 |
|
37 | - */ |
|
38 | - public function handle(CommentsEvent $event); |
|
34 | + /** |
|
35 | + * @param CommentsEvent $event |
|
36 | + * @since 11.0.0 |
|
37 | + */ |
|
38 | + public function handle(CommentsEvent $event); |
|
39 | 39 | } |
@@ -36,19 +36,19 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICommentsManagerFactory { |
38 | 38 | |
39 | - /** |
|
40 | - * Constructor for the comments manager factory |
|
41 | - * |
|
42 | - * @param IServerContainer $serverContainer server container |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function __construct(IServerContainer $serverContainer); |
|
39 | + /** |
|
40 | + * Constructor for the comments manager factory |
|
41 | + * |
|
42 | + * @param IServerContainer $serverContainer server container |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function __construct(IServerContainer $serverContainer); |
|
46 | 46 | |
47 | - /** |
|
48 | - * creates and returns an instance of the ICommentsManager |
|
49 | - * |
|
50 | - * @return ICommentsManager |
|
51 | - * @since 9.0.0 |
|
52 | - */ |
|
53 | - public function getManager(); |
|
47 | + /** |
|
48 | + * creates and returns an instance of the ICommentsManager |
|
49 | + * |
|
50 | + * @return ICommentsManager |
|
51 | + * @since 9.0.0 |
|
52 | + */ |
|
53 | + public function getManager(); |
|
54 | 54 | } |