@@ -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 | } |
@@ -30,43 +30,43 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICredentialsManager { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Store a set of credentials |
|
| 35 | - * |
|
| 36 | - * @param string|null $userId Null for system-wide credentials |
|
| 37 | - * @param string $identifier |
|
| 38 | - * @param mixed $credentials |
|
| 39 | - * @since 8.2.0 |
|
| 40 | - */ |
|
| 41 | - public function store($userId, $identifier, $credentials); |
|
| 33 | + /** |
|
| 34 | + * Store a set of credentials |
|
| 35 | + * |
|
| 36 | + * @param string|null $userId Null for system-wide credentials |
|
| 37 | + * @param string $identifier |
|
| 38 | + * @param mixed $credentials |
|
| 39 | + * @since 8.2.0 |
|
| 40 | + */ |
|
| 41 | + public function store($userId, $identifier, $credentials); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Retrieve a set of credentials |
|
| 45 | - * |
|
| 46 | - * @param string|null $userId Null for system-wide credentials |
|
| 47 | - * @param string $identifier |
|
| 48 | - * @return mixed |
|
| 49 | - * @since 8.2.0 |
|
| 50 | - */ |
|
| 51 | - public function retrieve($userId, $identifier); |
|
| 43 | + /** |
|
| 44 | + * Retrieve a set of credentials |
|
| 45 | + * |
|
| 46 | + * @param string|null $userId Null for system-wide credentials |
|
| 47 | + * @param string $identifier |
|
| 48 | + * @return mixed |
|
| 49 | + * @since 8.2.0 |
|
| 50 | + */ |
|
| 51 | + public function retrieve($userId, $identifier); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Delete a set of credentials |
|
| 55 | - * |
|
| 56 | - * @param string|null $userId Null for system-wide credentials |
|
| 57 | - * @param string $identifier |
|
| 58 | - * @return int rows removed |
|
| 59 | - * @since 8.2.0 |
|
| 60 | - */ |
|
| 61 | - public function delete($userId, $identifier); |
|
| 53 | + /** |
|
| 54 | + * Delete a set of credentials |
|
| 55 | + * |
|
| 56 | + * @param string|null $userId Null for system-wide credentials |
|
| 57 | + * @param string $identifier |
|
| 58 | + * @return int rows removed |
|
| 59 | + * @since 8.2.0 |
|
| 60 | + */ |
|
| 61 | + public function delete($userId, $identifier); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Erase all credentials stored for a user |
|
| 65 | - * |
|
| 66 | - * @param string $userId |
|
| 67 | - * @return int rows removed |
|
| 68 | - * @since 8.2.0 |
|
| 69 | - */ |
|
| 70 | - public function erase($userId); |
|
| 63 | + /** |
|
| 64 | + * Erase all credentials stored for a user |
|
| 65 | + * |
|
| 66 | + * @param string $userId |
|
| 67 | + * @return int rows removed |
|
| 68 | + * @since 8.2.0 |
|
| 69 | + */ |
|
| 70 | + public function erase($userId); |
|
| 71 | 71 | |
| 72 | 72 | } |
@@ -32,41 +32,41 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class CommentsEvent extends Event { |
| 34 | 34 | |
| 35 | - const EVENT_ADD = 'OCP\Comments\ICommentsManager::addComment'; |
|
| 36 | - const EVENT_PRE_UPDATE = 'OCP\Comments\ICommentsManager::preUpdateComment'; |
|
| 37 | - const EVENT_UPDATE = 'OCP\Comments\ICommentsManager::updateComment'; |
|
| 38 | - const EVENT_DELETE = 'OCP\Comments\ICommentsManager::deleteComment'; |
|
| 35 | + const EVENT_ADD = 'OCP\Comments\ICommentsManager::addComment'; |
|
| 36 | + const EVENT_PRE_UPDATE = 'OCP\Comments\ICommentsManager::preUpdateComment'; |
|
| 37 | + const EVENT_UPDATE = 'OCP\Comments\ICommentsManager::updateComment'; |
|
| 38 | + const EVENT_DELETE = 'OCP\Comments\ICommentsManager::deleteComment'; |
|
| 39 | 39 | |
| 40 | - /** @var string */ |
|
| 41 | - protected $event; |
|
| 42 | - /** @var IComment */ |
|
| 43 | - protected $comment; |
|
| 40 | + /** @var string */ |
|
| 41 | + protected $event; |
|
| 42 | + /** @var IComment */ |
|
| 43 | + protected $comment; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * DispatcherEvent constructor. |
|
| 47 | - * |
|
| 48 | - * @param string $event |
|
| 49 | - * @param IComment $comment |
|
| 50 | - * @since 9.0.0 |
|
| 51 | - */ |
|
| 52 | - public function __construct($event, IComment $comment) { |
|
| 53 | - $this->event = $event; |
|
| 54 | - $this->comment = $comment; |
|
| 55 | - } |
|
| 45 | + /** |
|
| 46 | + * DispatcherEvent constructor. |
|
| 47 | + * |
|
| 48 | + * @param string $event |
|
| 49 | + * @param IComment $comment |
|
| 50 | + * @since 9.0.0 |
|
| 51 | + */ |
|
| 52 | + public function __construct($event, IComment $comment) { |
|
| 53 | + $this->event = $event; |
|
| 54 | + $this->comment = $comment; |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @return string |
|
| 59 | - * @since 9.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getEvent() { |
|
| 62 | - return $this->event; |
|
| 63 | - } |
|
| 57 | + /** |
|
| 58 | + * @return string |
|
| 59 | + * @since 9.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getEvent() { |
|
| 62 | + return $this->event; |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @return IComment |
|
| 67 | - * @since 9.0.0 |
|
| 68 | - */ |
|
| 69 | - public function getComment() { |
|
| 70 | - return $this->comment; |
|
| 71 | - } |
|
| 65 | + /** |
|
| 66 | + * @return IComment |
|
| 67 | + * @since 9.0.0 |
|
| 68 | + */ |
|
| 69 | + public function getComment() { |
|
| 70 | + return $this->comment; |
|
| 71 | + } |
|
| 72 | 72 | } |
@@ -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 | } |
@@ -32,46 +32,46 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class CommentsEntityEvent extends Event { |
| 34 | 34 | |
| 35 | - const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
| 35 | + const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
| 36 | 36 | |
| 37 | - /** @var string */ |
|
| 38 | - protected $event; |
|
| 39 | - /** @var \Closure[] */ |
|
| 40 | - protected $collections; |
|
| 37 | + /** @var string */ |
|
| 38 | + protected $event; |
|
| 39 | + /** @var \Closure[] */ |
|
| 40 | + protected $collections; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * DispatcherEvent constructor. |
|
| 44 | - * |
|
| 45 | - * @param string $event |
|
| 46 | - * @since 9.1.0 |
|
| 47 | - */ |
|
| 48 | - public function __construct($event) { |
|
| 49 | - $this->event = $event; |
|
| 50 | - $this->collections = []; |
|
| 51 | - } |
|
| 42 | + /** |
|
| 43 | + * DispatcherEvent constructor. |
|
| 44 | + * |
|
| 45 | + * @param string $event |
|
| 46 | + * @since 9.1.0 |
|
| 47 | + */ |
|
| 48 | + public function __construct($event) { |
|
| 49 | + $this->event = $event; |
|
| 50 | + $this->collections = []; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * @param string $name |
|
| 55 | - * @param \Closure $entityExistsFunction The closure should take one |
|
| 56 | - * argument, which is the id of the entity, that comments |
|
| 57 | - * should be handled for. The return should then be bool, |
|
| 58 | - * depending on whether comments are allowed (true) or not. |
|
| 59 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
| 60 | - * @since 9.1.0 |
|
| 61 | - */ |
|
| 62 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
| 63 | - if (isset($this->collections[$name])) { |
|
| 64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
| 65 | - } |
|
| 53 | + /** |
|
| 54 | + * @param string $name |
|
| 55 | + * @param \Closure $entityExistsFunction The closure should take one |
|
| 56 | + * argument, which is the id of the entity, that comments |
|
| 57 | + * should be handled for. The return should then be bool, |
|
| 58 | + * depending on whether comments are allowed (true) or not. |
|
| 59 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
| 60 | + * @since 9.1.0 |
|
| 61 | + */ |
|
| 62 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
| 63 | + if (isset($this->collections[$name])) { |
|
| 64 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - $this->collections[$name] = $entityExistsFunction; |
|
| 68 | - } |
|
| 67 | + $this->collections[$name] = $entityExistsFunction; |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * @return \Closure[] |
|
| 72 | - * @since 9.1.0 |
|
| 73 | - */ |
|
| 74 | - public function getEntityCollections() { |
|
| 75 | - return $this->collections; |
|
| 76 | - } |
|
| 70 | + /** |
|
| 71 | + * @return \Closure[] |
|
| 72 | + * @since 9.1.0 |
|
| 73 | + */ |
|
| 74 | + public function getEntityCollections() { |
|
| 75 | + return $this->collections; |
|
| 76 | + } |
|
| 77 | 77 | } |
@@ -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 | } |