@@ -32,63 +32,63 @@ |
||
32 | 32 | */ |
33 | 33 | class MapperEvent extends Event { |
34 | 34 | |
35 | - const EVENT_ASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::assignTags'; |
|
36 | - const EVENT_UNASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags'; |
|
35 | + const EVENT_ASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::assignTags'; |
|
36 | + const EVENT_UNASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags'; |
|
37 | 37 | |
38 | - /** @var string */ |
|
39 | - protected $event; |
|
40 | - /** @var string */ |
|
41 | - protected $objectType; |
|
42 | - /** @var string */ |
|
43 | - protected $objectId; |
|
44 | - /** @var int[] */ |
|
45 | - protected $tags; |
|
38 | + /** @var string */ |
|
39 | + protected $event; |
|
40 | + /** @var string */ |
|
41 | + protected $objectType; |
|
42 | + /** @var string */ |
|
43 | + protected $objectId; |
|
44 | + /** @var int[] */ |
|
45 | + protected $tags; |
|
46 | 46 | |
47 | - /** |
|
48 | - * DispatcherEvent constructor. |
|
49 | - * |
|
50 | - * @param string $event |
|
51 | - * @param string $objectType |
|
52 | - * @param string $objectId |
|
53 | - * @param int[] $tags |
|
54 | - * @since 9.0.0 |
|
55 | - */ |
|
56 | - public function __construct($event, $objectType, $objectId, array $tags) { |
|
57 | - $this->event = $event; |
|
58 | - $this->objectType = $objectType; |
|
59 | - $this->objectId = $objectId; |
|
60 | - $this->tags = $tags; |
|
61 | - } |
|
47 | + /** |
|
48 | + * DispatcherEvent constructor. |
|
49 | + * |
|
50 | + * @param string $event |
|
51 | + * @param string $objectType |
|
52 | + * @param string $objectId |
|
53 | + * @param int[] $tags |
|
54 | + * @since 9.0.0 |
|
55 | + */ |
|
56 | + public function __construct($event, $objectType, $objectId, array $tags) { |
|
57 | + $this->event = $event; |
|
58 | + $this->objectType = $objectType; |
|
59 | + $this->objectId = $objectId; |
|
60 | + $this->tags = $tags; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return string |
|
65 | - * @since 9.0.0 |
|
66 | - */ |
|
67 | - public function getEvent() { |
|
68 | - return $this->event; |
|
69 | - } |
|
63 | + /** |
|
64 | + * @return string |
|
65 | + * @since 9.0.0 |
|
66 | + */ |
|
67 | + public function getEvent() { |
|
68 | + return $this->event; |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * @return string |
|
73 | - * @since 9.0.0 |
|
74 | - */ |
|
75 | - public function getObjectType() { |
|
76 | - return $this->objectType; |
|
77 | - } |
|
71 | + /** |
|
72 | + * @return string |
|
73 | + * @since 9.0.0 |
|
74 | + */ |
|
75 | + public function getObjectType() { |
|
76 | + return $this->objectType; |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * @return string |
|
81 | - * @since 9.0.0 |
|
82 | - */ |
|
83 | - public function getObjectId() { |
|
84 | - return $this->objectId; |
|
85 | - } |
|
79 | + /** |
|
80 | + * @return string |
|
81 | + * @since 9.0.0 |
|
82 | + */ |
|
83 | + public function getObjectId() { |
|
84 | + return $this->objectId; |
|
85 | + } |
|
86 | 86 | |
87 | - /** |
|
88 | - * @return int[] |
|
89 | - * @since 9.0.0 |
|
90 | - */ |
|
91 | - public function getTags() { |
|
92 | - return $this->tags; |
|
93 | - } |
|
87 | + /** |
|
88 | + * @return int[] |
|
89 | + * @since 9.0.0 |
|
90 | + */ |
|
91 | + public function getTags() { |
|
92 | + return $this->tags; |
|
93 | + } |
|
94 | 94 | } |
@@ -29,41 +29,41 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISystemTag { |
31 | 31 | |
32 | - /** |
|
33 | - * Returns the tag id |
|
34 | - * |
|
35 | - * @return string id |
|
36 | - * |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function getId(); |
|
32 | + /** |
|
33 | + * Returns the tag id |
|
34 | + * |
|
35 | + * @return string id |
|
36 | + * |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function getId(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Returns the tag display name |
|
43 | - * |
|
44 | - * @return string tag display name |
|
45 | - * |
|
46 | - * @since 9.0.0 |
|
47 | - */ |
|
48 | - public function getName(); |
|
41 | + /** |
|
42 | + * Returns the tag display name |
|
43 | + * |
|
44 | + * @return string tag display name |
|
45 | + * |
|
46 | + * @since 9.0.0 |
|
47 | + */ |
|
48 | + public function getName(); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns whether the tag is visible for regular users |
|
52 | - * |
|
53 | - * @return bool true if visible, false otherwise |
|
54 | - * |
|
55 | - * @since 9.0.0 |
|
56 | - */ |
|
57 | - public function isUserVisible(); |
|
50 | + /** |
|
51 | + * Returns whether the tag is visible for regular users |
|
52 | + * |
|
53 | + * @return bool true if visible, false otherwise |
|
54 | + * |
|
55 | + * @since 9.0.0 |
|
56 | + */ |
|
57 | + public function isUserVisible(); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns whether the tag can be assigned to objects by regular users |
|
61 | - * |
|
62 | - * @return bool true if assignable, false otherwise |
|
63 | - * |
|
64 | - * @since 9.0.0 |
|
65 | - */ |
|
66 | - public function isUserAssignable(); |
|
59 | + /** |
|
60 | + * Returns whether the tag can be assigned to objects by regular users |
|
61 | + * |
|
62 | + * @return bool true if assignable, false otherwise |
|
63 | + * |
|
64 | + * @since 9.0.0 |
|
65 | + */ |
|
66 | + public function isUserAssignable(); |
|
67 | 67 | |
68 | 68 | } |
69 | 69 |
@@ -32,55 +32,55 @@ |
||
32 | 32 | */ |
33 | 33 | class ManagerEvent extends Event { |
34 | 34 | |
35 | - const EVENT_CREATE = 'OCP\SystemTag\ISystemTagManager::createTag'; |
|
36 | - const EVENT_UPDATE = 'OCP\SystemTag\ISystemTagManager::updateTag'; |
|
37 | - const EVENT_DELETE = 'OCP\SystemTag\ISystemTagManager::deleteTag'; |
|
35 | + const EVENT_CREATE = 'OCP\SystemTag\ISystemTagManager::createTag'; |
|
36 | + const EVENT_UPDATE = 'OCP\SystemTag\ISystemTagManager::updateTag'; |
|
37 | + const EVENT_DELETE = 'OCP\SystemTag\ISystemTagManager::deleteTag'; |
|
38 | 38 | |
39 | - /** @var string */ |
|
40 | - protected $event; |
|
41 | - /** @var ISystemTag */ |
|
42 | - protected $tag; |
|
43 | - /** @var ISystemTag */ |
|
44 | - protected $beforeTag; |
|
39 | + /** @var string */ |
|
40 | + protected $event; |
|
41 | + /** @var ISystemTag */ |
|
42 | + protected $tag; |
|
43 | + /** @var ISystemTag */ |
|
44 | + protected $beforeTag; |
|
45 | 45 | |
46 | - /** |
|
47 | - * DispatcherEvent constructor. |
|
48 | - * |
|
49 | - * @param string $event |
|
50 | - * @param ISystemTag $tag |
|
51 | - * @param ISystemTag $beforeTag |
|
52 | - * @since 9.0.0 |
|
53 | - */ |
|
54 | - public function __construct($event, ISystemTag $tag, ISystemTag $beforeTag = null) { |
|
55 | - $this->event = $event; |
|
56 | - $this->tag = $tag; |
|
57 | - $this->beforeTag = $beforeTag; |
|
58 | - } |
|
46 | + /** |
|
47 | + * DispatcherEvent constructor. |
|
48 | + * |
|
49 | + * @param string $event |
|
50 | + * @param ISystemTag $tag |
|
51 | + * @param ISystemTag $beforeTag |
|
52 | + * @since 9.0.0 |
|
53 | + */ |
|
54 | + public function __construct($event, ISystemTag $tag, ISystemTag $beforeTag = null) { |
|
55 | + $this->event = $event; |
|
56 | + $this->tag = $tag; |
|
57 | + $this->beforeTag = $beforeTag; |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * @return string |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function getEvent() { |
|
65 | - return $this->event; |
|
66 | - } |
|
60 | + /** |
|
61 | + * @return string |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function getEvent() { |
|
65 | + return $this->event; |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * @return ISystemTag |
|
70 | - * @since 9.0.0 |
|
71 | - */ |
|
72 | - public function getTag() { |
|
73 | - return $this->tag; |
|
74 | - } |
|
68 | + /** |
|
69 | + * @return ISystemTag |
|
70 | + * @since 9.0.0 |
|
71 | + */ |
|
72 | + public function getTag() { |
|
73 | + return $this->tag; |
|
74 | + } |
|
75 | 75 | |
76 | - /** |
|
77 | - * @return ISystemTag |
|
78 | - * @since 9.0.0 |
|
79 | - */ |
|
80 | - public function getTagBefore() { |
|
81 | - if ($this->event !== self::EVENT_UPDATE) { |
|
82 | - throw new \BadMethodCallException('getTagBefore is only available on the update Event'); |
|
83 | - } |
|
84 | - return $this->beforeTag; |
|
85 | - } |
|
76 | + /** |
|
77 | + * @return ISystemTag |
|
78 | + * @since 9.0.0 |
|
79 | + */ |
|
80 | + public function getTagBefore() { |
|
81 | + if ($this->event !== self::EVENT_UPDATE) { |
|
82 | + throw new \BadMethodCallException('getTagBefore is only available on the update Event'); |
|
83 | + } |
|
84 | + return $this->beforeTag; |
|
85 | + } |
|
86 | 86 | } |
@@ -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 | } |
@@ -33,113 +33,113 @@ |
||
33 | 33 | * https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface |
34 | 34 | */ |
35 | 35 | interface ILogger { |
36 | - /** |
|
37 | - * System is unusable. |
|
38 | - * |
|
39 | - * @param string $message |
|
40 | - * @param array $context |
|
41 | - * @return null |
|
42 | - * @since 7.0.0 |
|
43 | - */ |
|
44 | - public function emergency($message, array $context = array()); |
|
36 | + /** |
|
37 | + * System is unusable. |
|
38 | + * |
|
39 | + * @param string $message |
|
40 | + * @param array $context |
|
41 | + * @return null |
|
42 | + * @since 7.0.0 |
|
43 | + */ |
|
44 | + public function emergency($message, array $context = array()); |
|
45 | 45 | |
46 | - /** |
|
47 | - * Action must be taken immediately. |
|
48 | - * |
|
49 | - * @param string $message |
|
50 | - * @param array $context |
|
51 | - * @return null |
|
52 | - * @since 7.0.0 |
|
53 | - */ |
|
54 | - public function alert($message, array $context = array()); |
|
46 | + /** |
|
47 | + * Action must be taken immediately. |
|
48 | + * |
|
49 | + * @param string $message |
|
50 | + * @param array $context |
|
51 | + * @return null |
|
52 | + * @since 7.0.0 |
|
53 | + */ |
|
54 | + public function alert($message, array $context = array()); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Critical conditions. |
|
58 | - * |
|
59 | - * @param string $message |
|
60 | - * @param array $context |
|
61 | - * @return null |
|
62 | - * @since 7.0.0 |
|
63 | - */ |
|
64 | - public function critical($message, array $context = array()); |
|
56 | + /** |
|
57 | + * Critical conditions. |
|
58 | + * |
|
59 | + * @param string $message |
|
60 | + * @param array $context |
|
61 | + * @return null |
|
62 | + * @since 7.0.0 |
|
63 | + */ |
|
64 | + public function critical($message, array $context = array()); |
|
65 | 65 | |
66 | - /** |
|
67 | - * Runtime errors that do not require immediate action but should typically |
|
68 | - * be logged and monitored. |
|
69 | - * |
|
70 | - * @param string $message |
|
71 | - * @param array $context |
|
72 | - * @return null |
|
73 | - * @since 7.0.0 |
|
74 | - */ |
|
75 | - public function error($message, array $context = array()); |
|
66 | + /** |
|
67 | + * Runtime errors that do not require immediate action but should typically |
|
68 | + * be logged and monitored. |
|
69 | + * |
|
70 | + * @param string $message |
|
71 | + * @param array $context |
|
72 | + * @return null |
|
73 | + * @since 7.0.0 |
|
74 | + */ |
|
75 | + public function error($message, array $context = array()); |
|
76 | 76 | |
77 | - /** |
|
78 | - * Exceptional occurrences that are not errors. |
|
79 | - * |
|
80 | - * @param string $message |
|
81 | - * @param array $context |
|
82 | - * @return null |
|
83 | - * @since 7.0.0 |
|
84 | - */ |
|
85 | - public function warning($message, array $context = array()); |
|
77 | + /** |
|
78 | + * Exceptional occurrences that are not errors. |
|
79 | + * |
|
80 | + * @param string $message |
|
81 | + * @param array $context |
|
82 | + * @return null |
|
83 | + * @since 7.0.0 |
|
84 | + */ |
|
85 | + public function warning($message, array $context = array()); |
|
86 | 86 | |
87 | - /** |
|
88 | - * Normal but significant events. |
|
89 | - * |
|
90 | - * @param string $message |
|
91 | - * @param array $context |
|
92 | - * @return null |
|
93 | - * @since 7.0.0 |
|
94 | - */ |
|
95 | - public function notice($message, array $context = array()); |
|
87 | + /** |
|
88 | + * Normal but significant events. |
|
89 | + * |
|
90 | + * @param string $message |
|
91 | + * @param array $context |
|
92 | + * @return null |
|
93 | + * @since 7.0.0 |
|
94 | + */ |
|
95 | + public function notice($message, array $context = array()); |
|
96 | 96 | |
97 | - /** |
|
98 | - * Interesting events. |
|
99 | - * |
|
100 | - * @param string $message |
|
101 | - * @param array $context |
|
102 | - * @return null |
|
103 | - * @since 7.0.0 |
|
104 | - */ |
|
105 | - public function info($message, array $context = array()); |
|
97 | + /** |
|
98 | + * Interesting events. |
|
99 | + * |
|
100 | + * @param string $message |
|
101 | + * @param array $context |
|
102 | + * @return null |
|
103 | + * @since 7.0.0 |
|
104 | + */ |
|
105 | + public function info($message, array $context = array()); |
|
106 | 106 | |
107 | - /** |
|
108 | - * Detailed debug information. |
|
109 | - * |
|
110 | - * @param string $message |
|
111 | - * @param array $context |
|
112 | - * @return null |
|
113 | - * @since 7.0.0 |
|
114 | - */ |
|
115 | - public function debug($message, array $context = array()); |
|
107 | + /** |
|
108 | + * Detailed debug information. |
|
109 | + * |
|
110 | + * @param string $message |
|
111 | + * @param array $context |
|
112 | + * @return null |
|
113 | + * @since 7.0.0 |
|
114 | + */ |
|
115 | + public function debug($message, array $context = array()); |
|
116 | 116 | |
117 | - /** |
|
118 | - * Logs with an arbitrary level. |
|
119 | - * |
|
120 | - * @param mixed $level |
|
121 | - * @param string $message |
|
122 | - * @param array $context |
|
123 | - * @return mixed |
|
124 | - * @since 7.0.0 |
|
125 | - */ |
|
126 | - public function log($level, $message, array $context = array()); |
|
117 | + /** |
|
118 | + * Logs with an arbitrary level. |
|
119 | + * |
|
120 | + * @param mixed $level |
|
121 | + * @param string $message |
|
122 | + * @param array $context |
|
123 | + * @return mixed |
|
124 | + * @since 7.0.0 |
|
125 | + */ |
|
126 | + public function log($level, $message, array $context = array()); |
|
127 | 127 | |
128 | - /** |
|
129 | - * Logs an exception very detailed |
|
130 | - * An additional message can we written to the log by adding it to the |
|
131 | - * context. |
|
132 | - * |
|
133 | - * <code> |
|
134 | - * $logger->logException($ex, [ |
|
135 | - * 'message' => 'Exception during cron job execution' |
|
136 | - * ]); |
|
137 | - * </code> |
|
138 | - * |
|
139 | - * @param \Exception $exception |
|
140 | - * @param array $context |
|
141 | - * @return void |
|
142 | - * @since 8.2.0 |
|
143 | - */ |
|
144 | - public function logException(\Exception $exception, array $context = array()); |
|
128 | + /** |
|
129 | + * Logs an exception very detailed |
|
130 | + * An additional message can we written to the log by adding it to the |
|
131 | + * context. |
|
132 | + * |
|
133 | + * <code> |
|
134 | + * $logger->logException($ex, [ |
|
135 | + * 'message' => 'Exception during cron job execution' |
|
136 | + * ]); |
|
137 | + * </code> |
|
138 | + * |
|
139 | + * @param \Exception $exception |
|
140 | + * @param array $context |
|
141 | + * @return void |
|
142 | + * @since 8.2.0 |
|
143 | + */ |
|
144 | + public function logException(\Exception $exception, array $context = array()); |
|
145 | 145 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 5.0.0 |
32 | 32 | */ |
33 | 33 | interface Share_Backend_File_Dependent extends Share_Backend { |
34 | - /** |
|
35 | - * Get the file path of the item |
|
36 | - * @param string $itemSource |
|
37 | - * @param string $uidOwner User that is the owner of shared item |
|
38 | - * @return string|false |
|
39 | - * @since 5.0.0 |
|
40 | - */ |
|
41 | - public function getFilePath($itemSource, $uidOwner); |
|
34 | + /** |
|
35 | + * Get the file path of the item |
|
36 | + * @param string $itemSource |
|
37 | + * @param string $uidOwner User that is the owner of shared item |
|
38 | + * @return string|false |
|
39 | + * @since 5.0.0 |
|
40 | + */ |
|
41 | + public function getFilePath($itemSource, $uidOwner); |
|
42 | 42 | |
43 | 43 | } |
@@ -30,92 +30,92 @@ |
||
30 | 30 | * @since 7.0.0 |
31 | 31 | */ |
32 | 32 | interface IAppConfig { |
33 | - /** |
|
34 | - * check if a key is set in the appconfig |
|
35 | - * @param string $app |
|
36 | - * @param string $key |
|
37 | - * @return bool |
|
38 | - * @since 7.0.0 |
|
39 | - */ |
|
40 | - public function hasKey($app, $key); |
|
33 | + /** |
|
34 | + * check if a key is set in the appconfig |
|
35 | + * @param string $app |
|
36 | + * @param string $key |
|
37 | + * @return bool |
|
38 | + * @since 7.0.0 |
|
39 | + */ |
|
40 | + public function hasKey($app, $key); |
|
41 | 41 | |
42 | - /** |
|
43 | - * Gets the config value |
|
44 | - * @param string $app app |
|
45 | - * @param string $key key |
|
46 | - * @param string $default = null, default value if the key does not exist |
|
47 | - * @return string the value or $default |
|
48 | - * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig |
|
49 | - * |
|
50 | - * This function gets a value from the appconfig table. If the key does |
|
51 | - * not exist the default value will be returned |
|
52 | - * @since 7.0.0 |
|
53 | - */ |
|
54 | - public function getValue($app, $key, $default = null); |
|
42 | + /** |
|
43 | + * Gets the config value |
|
44 | + * @param string $app app |
|
45 | + * @param string $key key |
|
46 | + * @param string $default = null, default value if the key does not exist |
|
47 | + * @return string the value or $default |
|
48 | + * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig |
|
49 | + * |
|
50 | + * This function gets a value from the appconfig table. If the key does |
|
51 | + * not exist the default value will be returned |
|
52 | + * @since 7.0.0 |
|
53 | + */ |
|
54 | + public function getValue($app, $key, $default = null); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Deletes a key |
|
58 | - * @param string $app app |
|
59 | - * @param string $key key |
|
60 | - * @return bool |
|
61 | - * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig |
|
62 | - * @since 7.0.0 |
|
63 | - */ |
|
64 | - public function deleteKey($app, $key); |
|
56 | + /** |
|
57 | + * Deletes a key |
|
58 | + * @param string $app app |
|
59 | + * @param string $key key |
|
60 | + * @return bool |
|
61 | + * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig |
|
62 | + * @since 7.0.0 |
|
63 | + */ |
|
64 | + public function deleteKey($app, $key); |
|
65 | 65 | |
66 | - /** |
|
67 | - * Get the available keys for an app |
|
68 | - * @param string $app the app we are looking for |
|
69 | - * @return array an array of key names |
|
70 | - * @deprecated 8.0.0 use method getAppKeys of \OCP\IConfig |
|
71 | - * |
|
72 | - * This function gets all keys of an app. Please note that the values are |
|
73 | - * not returned. |
|
74 | - * @since 7.0.0 |
|
75 | - */ |
|
76 | - public function getKeys($app); |
|
66 | + /** |
|
67 | + * Get the available keys for an app |
|
68 | + * @param string $app the app we are looking for |
|
69 | + * @return array an array of key names |
|
70 | + * @deprecated 8.0.0 use method getAppKeys of \OCP\IConfig |
|
71 | + * |
|
72 | + * This function gets all keys of an app. Please note that the values are |
|
73 | + * not returned. |
|
74 | + * @since 7.0.0 |
|
75 | + */ |
|
76 | + public function getKeys($app); |
|
77 | 77 | |
78 | - /** |
|
79 | - * get multiply values, either the app or key can be used as wildcard by setting it to false |
|
80 | - * |
|
81 | - * @param string|false $key |
|
82 | - * @param string|false $app |
|
83 | - * @return array|false |
|
84 | - * @since 7.0.0 |
|
85 | - */ |
|
86 | - public function getValues($app, $key); |
|
78 | + /** |
|
79 | + * get multiply values, either the app or key can be used as wildcard by setting it to false |
|
80 | + * |
|
81 | + * @param string|false $key |
|
82 | + * @param string|false $app |
|
83 | + * @return array|false |
|
84 | + * @since 7.0.0 |
|
85 | + */ |
|
86 | + public function getValues($app, $key); |
|
87 | 87 | |
88 | - /** |
|
89 | - * sets a value in the appconfig |
|
90 | - * @param string $app app |
|
91 | - * @param string $key key |
|
92 | - * @param string $value value |
|
93 | - * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig |
|
94 | - * |
|
95 | - * Sets a value. If the key did not exist before it will be created. |
|
96 | - * @return void |
|
97 | - * @since 7.0.0 |
|
98 | - */ |
|
99 | - public function setValue($app, $key, $value); |
|
88 | + /** |
|
89 | + * sets a value in the appconfig |
|
90 | + * @param string $app app |
|
91 | + * @param string $key key |
|
92 | + * @param string $value value |
|
93 | + * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig |
|
94 | + * |
|
95 | + * Sets a value. If the key did not exist before it will be created. |
|
96 | + * @return void |
|
97 | + * @since 7.0.0 |
|
98 | + */ |
|
99 | + public function setValue($app, $key, $value); |
|
100 | 100 | |
101 | - /** |
|
102 | - * Get all apps using the config |
|
103 | - * @return array an array of app ids |
|
104 | - * |
|
105 | - * This function returns a list of all apps that have at least one |
|
106 | - * entry in the appconfig table. |
|
107 | - * @since 7.0.0 |
|
108 | - */ |
|
109 | - public function getApps(); |
|
101 | + /** |
|
102 | + * Get all apps using the config |
|
103 | + * @return array an array of app ids |
|
104 | + * |
|
105 | + * This function returns a list of all apps that have at least one |
|
106 | + * entry in the appconfig table. |
|
107 | + * @since 7.0.0 |
|
108 | + */ |
|
109 | + public function getApps(); |
|
110 | 110 | |
111 | - /** |
|
112 | - * Remove app from appconfig |
|
113 | - * @param string $app app |
|
114 | - * @return bool |
|
115 | - * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig |
|
116 | - * |
|
117 | - * Removes all keys in appconfig belonging to the app. |
|
118 | - * @since 7.0.0 |
|
119 | - */ |
|
120 | - public function deleteApp($app); |
|
111 | + /** |
|
112 | + * Remove app from appconfig |
|
113 | + * @param string $app app |
|
114 | + * @return bool |
|
115 | + * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig |
|
116 | + * |
|
117 | + * Removes all keys in appconfig belonging to the app. |
|
118 | + * @since 7.0.0 |
|
119 | + */ |
|
120 | + public function deleteApp($app); |
|
121 | 121 | } |
@@ -34,83 +34,83 @@ |
||
34 | 34 | * @since 8.0.0 |
35 | 35 | */ |
36 | 36 | interface IAppManager { |
37 | - /** |
|
38 | - * Check if an app is enabled for user |
|
39 | - * |
|
40 | - * @param string $appId |
|
41 | - * @param \OCP\IUser $user (optional) if not defined, the currently loggedin user will be used |
|
42 | - * @return bool |
|
43 | - * @since 8.0.0 |
|
44 | - */ |
|
45 | - public function isEnabledForUser($appId, $user = null); |
|
37 | + /** |
|
38 | + * Check if an app is enabled for user |
|
39 | + * |
|
40 | + * @param string $appId |
|
41 | + * @param \OCP\IUser $user (optional) if not defined, the currently loggedin user will be used |
|
42 | + * @return bool |
|
43 | + * @since 8.0.0 |
|
44 | + */ |
|
45 | + public function isEnabledForUser($appId, $user = null); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Check if an app is installed in the instance |
|
49 | - * |
|
50 | - * @param string $appId |
|
51 | - * @return bool |
|
52 | - * @since 8.0.0 |
|
53 | - */ |
|
54 | - public function isInstalled($appId); |
|
47 | + /** |
|
48 | + * Check if an app is installed in the instance |
|
49 | + * |
|
50 | + * @param string $appId |
|
51 | + * @return bool |
|
52 | + * @since 8.0.0 |
|
53 | + */ |
|
54 | + public function isInstalled($appId); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Enable an app for every user |
|
58 | - * |
|
59 | - * @param string $appId |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function enableApp($appId); |
|
56 | + /** |
|
57 | + * Enable an app for every user |
|
58 | + * |
|
59 | + * @param string $appId |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function enableApp($appId); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Enable an app only for specific groups |
|
66 | - * |
|
67 | - * @param string $appId |
|
68 | - * @param \OCP\IGroup[] $groups |
|
69 | - * @since 8.0.0 |
|
70 | - */ |
|
71 | - public function enableAppForGroups($appId, $groups); |
|
64 | + /** |
|
65 | + * Enable an app only for specific groups |
|
66 | + * |
|
67 | + * @param string $appId |
|
68 | + * @param \OCP\IGroup[] $groups |
|
69 | + * @since 8.0.0 |
|
70 | + */ |
|
71 | + public function enableAppForGroups($appId, $groups); |
|
72 | 72 | |
73 | - /** |
|
74 | - * Disable an app for every user |
|
75 | - * |
|
76 | - * @param string $appId |
|
77 | - * @since 8.0.0 |
|
78 | - */ |
|
79 | - public function disableApp($appId); |
|
73 | + /** |
|
74 | + * Disable an app for every user |
|
75 | + * |
|
76 | + * @param string $appId |
|
77 | + * @since 8.0.0 |
|
78 | + */ |
|
79 | + public function disableApp($appId); |
|
80 | 80 | |
81 | - /** |
|
82 | - * List all apps enabled for a user |
|
83 | - * |
|
84 | - * @param \OCP\IUser $user |
|
85 | - * @return string[] |
|
86 | - * @since 8.1.0 |
|
87 | - */ |
|
88 | - public function getEnabledAppsForUser(IUser $user); |
|
81 | + /** |
|
82 | + * List all apps enabled for a user |
|
83 | + * |
|
84 | + * @param \OCP\IUser $user |
|
85 | + * @return string[] |
|
86 | + * @since 8.1.0 |
|
87 | + */ |
|
88 | + public function getEnabledAppsForUser(IUser $user); |
|
89 | 89 | |
90 | - /** |
|
91 | - * List all installed apps |
|
92 | - * |
|
93 | - * @return string[] |
|
94 | - * @since 8.1.0 |
|
95 | - */ |
|
96 | - public function getInstalledApps(); |
|
90 | + /** |
|
91 | + * List all installed apps |
|
92 | + * |
|
93 | + * @return string[] |
|
94 | + * @since 8.1.0 |
|
95 | + */ |
|
96 | + public function getInstalledApps(); |
|
97 | 97 | |
98 | - /** |
|
99 | - * Clear the cached list of apps when enabling/disabling an app |
|
100 | - * @since 8.1.0 |
|
101 | - */ |
|
102 | - public function clearAppsCache(); |
|
98 | + /** |
|
99 | + * Clear the cached list of apps when enabling/disabling an app |
|
100 | + * @since 8.1.0 |
|
101 | + */ |
|
102 | + public function clearAppsCache(); |
|
103 | 103 | |
104 | - /** |
|
105 | - * @param string $appId |
|
106 | - * @return boolean |
|
107 | - * @since 9.0.0 |
|
108 | - */ |
|
109 | - public function isShipped($appId); |
|
104 | + /** |
|
105 | + * @param string $appId |
|
106 | + * @return boolean |
|
107 | + * @since 9.0.0 |
|
108 | + */ |
|
109 | + public function isShipped($appId); |
|
110 | 110 | |
111 | - /** |
|
112 | - * @return string[] |
|
113 | - * @since 9.0.0 |
|
114 | - */ |
|
115 | - public function getAlwaysEnabledApps(); |
|
111 | + /** |
|
112 | + * @return string[] |
|
113 | + * @since 9.0.0 |
|
114 | + */ |
|
115 | + public function getAlwaysEnabledApps(); |
|
116 | 116 | } |
@@ -30,116 +30,116 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IDateTimeFormatter { |
33 | - /** |
|
34 | - * Formats the date of the given timestamp |
|
35 | - * |
|
36 | - * @param int|\DateTime $timestamp |
|
37 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
38 | - * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
39 | - * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
40 | - * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
41 | - * short: e.g. 'M/d/yy' => '8/20/14' |
|
42 | - * The exact format is dependent on the language |
|
43 | - * @param \DateTimeZone $timeZone The timezone to use |
|
44 | - * @param \OCP\IL10N $l The locale to use |
|
45 | - * @return string Formatted date string |
|
46 | - * @since 8.0.0 |
|
47 | - */ |
|
48 | - public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
33 | + /** |
|
34 | + * Formats the date of the given timestamp |
|
35 | + * |
|
36 | + * @param int|\DateTime $timestamp |
|
37 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
38 | + * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
39 | + * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
40 | + * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
41 | + * short: e.g. 'M/d/yy' => '8/20/14' |
|
42 | + * The exact format is dependent on the language |
|
43 | + * @param \DateTimeZone $timeZone The timezone to use |
|
44 | + * @param \OCP\IL10N $l The locale to use |
|
45 | + * @return string Formatted date string |
|
46 | + * @since 8.0.0 |
|
47 | + */ |
|
48 | + public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Formats the date of the given timestamp |
|
52 | - * |
|
53 | - * @param int|\DateTime $timestamp |
|
54 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
55 | - * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
56 | - * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
57 | - * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
58 | - * short: e.g. 'M/d/yy' => '8/20/14' |
|
59 | - * The exact format is dependent on the language |
|
60 | - * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
61 | - * @param \DateTimeZone $timeZone The timezone to use |
|
62 | - * @param \OCP\IL10N $l The locale to use |
|
63 | - * @return string Formatted relative date string |
|
64 | - * @since 8.0.0 |
|
65 | - */ |
|
66 | - public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
50 | + /** |
|
51 | + * Formats the date of the given timestamp |
|
52 | + * |
|
53 | + * @param int|\DateTime $timestamp |
|
54 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
55 | + * full: e.g. 'EEEE, MMMM d, y' => 'Wednesday, August 20, 2014' |
|
56 | + * long: e.g. 'MMMM d, y' => 'August 20, 2014' |
|
57 | + * medium: e.g. 'MMM d, y' => 'Aug 20, 2014' |
|
58 | + * short: e.g. 'M/d/yy' => '8/20/14' |
|
59 | + * The exact format is dependent on the language |
|
60 | + * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
61 | + * @param \DateTimeZone $timeZone The timezone to use |
|
62 | + * @param \OCP\IL10N $l The locale to use |
|
63 | + * @return string Formatted relative date string |
|
64 | + * @since 8.0.0 |
|
65 | + */ |
|
66 | + public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
67 | 67 | |
68 | - /** |
|
69 | - * Gives the relative date of the timestamp |
|
70 | - * Only works for past dates |
|
71 | - * |
|
72 | - * @param int|\DateTime $timestamp |
|
73 | - * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
74 | - * @return string Dates returned are: |
|
75 | - * < 1 month => Today, Yesterday, n days ago |
|
76 | - * < 13 month => last month, n months ago |
|
77 | - * >= 13 month => last year, n years ago |
|
78 | - * @param \OCP\IL10N $l The locale to use |
|
79 | - * @return string Formatted date span |
|
80 | - * @since 8.0.0 |
|
81 | - */ |
|
82 | - public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
68 | + /** |
|
69 | + * Gives the relative date of the timestamp |
|
70 | + * Only works for past dates |
|
71 | + * |
|
72 | + * @param int|\DateTime $timestamp |
|
73 | + * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
74 | + * @return string Dates returned are: |
|
75 | + * < 1 month => Today, Yesterday, n days ago |
|
76 | + * < 13 month => last month, n months ago |
|
77 | + * >= 13 month => last year, n years ago |
|
78 | + * @param \OCP\IL10N $l The locale to use |
|
79 | + * @return string Formatted date span |
|
80 | + * @since 8.0.0 |
|
81 | + */ |
|
82 | + public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
83 | 83 | |
84 | - /** |
|
85 | - * Formats the time of the given timestamp |
|
86 | - * |
|
87 | - * @param int|\DateTime $timestamp |
|
88 | - * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
89 | - * full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00' |
|
90 | - * long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT' |
|
91 | - * medium: e.g. 'h:mm:ss a' => '11:42:13 AM' |
|
92 | - * short: e.g. 'h:mm a' => '11:42 AM' |
|
93 | - * The exact format is dependent on the language |
|
94 | - * @param \DateTimeZone $timeZone The timezone to use |
|
95 | - * @param \OCP\IL10N $l The locale to use |
|
96 | - * @return string Formatted time string |
|
97 | - * @since 8.0.0 |
|
98 | - */ |
|
99 | - public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
84 | + /** |
|
85 | + * Formats the time of the given timestamp |
|
86 | + * |
|
87 | + * @param int|\DateTime $timestamp |
|
88 | + * @param string $format Either 'full', 'long', 'medium' or 'short' |
|
89 | + * full: e.g. 'h:mm:ss a zzzz' => '11:42:13 AM GMT+0:00' |
|
90 | + * long: e.g. 'h:mm:ss a z' => '11:42:13 AM GMT' |
|
91 | + * medium: e.g. 'h:mm:ss a' => '11:42:13 AM' |
|
92 | + * short: e.g. 'h:mm a' => '11:42 AM' |
|
93 | + * The exact format is dependent on the language |
|
94 | + * @param \DateTimeZone $timeZone The timezone to use |
|
95 | + * @param \OCP\IL10N $l The locale to use |
|
96 | + * @return string Formatted time string |
|
97 | + * @since 8.0.0 |
|
98 | + */ |
|
99 | + public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
100 | 100 | |
101 | - /** |
|
102 | - * Gives the relative past time of the timestamp |
|
103 | - * |
|
104 | - * @param int|\DateTime $timestamp |
|
105 | - * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
106 | - * @return string Dates returned are: |
|
107 | - * < 60 sec => seconds ago |
|
108 | - * < 1 hour => n minutes ago |
|
109 | - * < 1 day => n hours ago |
|
110 | - * < 1 month => Yesterday, n days ago |
|
111 | - * < 13 month => last month, n months ago |
|
112 | - * >= 13 month => last year, n years ago |
|
113 | - * @param \OCP\IL10N $l The locale to use |
|
114 | - * @return string Formatted time span |
|
115 | - * @since 8.0.0 |
|
116 | - */ |
|
117 | - public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
101 | + /** |
|
102 | + * Gives the relative past time of the timestamp |
|
103 | + * |
|
104 | + * @param int|\DateTime $timestamp |
|
105 | + * @param int|\DateTime $baseTimestamp Timestamp to compare $timestamp against, defaults to current time |
|
106 | + * @return string Dates returned are: |
|
107 | + * < 60 sec => seconds ago |
|
108 | + * < 1 hour => n minutes ago |
|
109 | + * < 1 day => n hours ago |
|
110 | + * < 1 month => Yesterday, n days ago |
|
111 | + * < 13 month => last month, n months ago |
|
112 | + * >= 13 month => last year, n years ago |
|
113 | + * @param \OCP\IL10N $l The locale to use |
|
114 | + * @return string Formatted time span |
|
115 | + * @since 8.0.0 |
|
116 | + */ |
|
117 | + public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Formats the date and time of the given timestamp |
|
121 | - * |
|
122 | - * @param int|\DateTime $timestamp |
|
123 | - * @param string $formatDate See formatDate() for description |
|
124 | - * @param string $formatTime See formatTime() for description |
|
125 | - * @param \DateTimeZone $timeZone The timezone to use |
|
126 | - * @param \OCP\IL10N $l The locale to use |
|
127 | - * @return string Formatted date and time string |
|
128 | - * @since 8.0.0 |
|
129 | - */ |
|
130 | - public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
119 | + /** |
|
120 | + * Formats the date and time of the given timestamp |
|
121 | + * |
|
122 | + * @param int|\DateTime $timestamp |
|
123 | + * @param string $formatDate See formatDate() for description |
|
124 | + * @param string $formatTime See formatTime() for description |
|
125 | + * @param \DateTimeZone $timeZone The timezone to use |
|
126 | + * @param \OCP\IL10N $l The locale to use |
|
127 | + * @return string Formatted date and time string |
|
128 | + * @since 8.0.0 |
|
129 | + */ |
|
130 | + public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
131 | 131 | |
132 | - /** |
|
133 | - * Formats the date and time of the given timestamp |
|
134 | - * |
|
135 | - * @param int|\DateTime $timestamp |
|
136 | - * @param string $formatDate See formatDate() for description |
|
137 | - * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
138 | - * @param string $formatTime See formatTime() for description |
|
139 | - * @param \DateTimeZone $timeZone The timezone to use |
|
140 | - * @param \OCP\IL10N $l The locale to use |
|
141 | - * @return string Formatted relative date and time string |
|
142 | - * @since 8.0.0 |
|
143 | - */ |
|
144 | - public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
132 | + /** |
|
133 | + * Formats the date and time of the given timestamp |
|
134 | + * |
|
135 | + * @param int|\DateTime $timestamp |
|
136 | + * @param string $formatDate See formatDate() for description |
|
137 | + * Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable |
|
138 | + * @param string $formatTime See formatTime() for description |
|
139 | + * @param \DateTimeZone $timeZone The timezone to use |
|
140 | + * @param \OCP\IL10N $l The locale to use |
|
141 | + * @return string Formatted relative date and time string |
|
142 | + * @since 8.0.0 |
|
143 | + */ |
|
144 | + public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null); |
|
145 | 145 | } |