@@ -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 | } |
@@ -30,51 +30,51 @@ |
||
| 30 | 30 | * @since 8.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface ICertificate { |
| 33 | - /** |
|
| 34 | - * @return string |
|
| 35 | - * @since 8.0.0 |
|
| 36 | - */ |
|
| 37 | - public function getName(); |
|
| 33 | + /** |
|
| 34 | + * @return string |
|
| 35 | + * @since 8.0.0 |
|
| 36 | + */ |
|
| 37 | + public function getName(); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return string |
|
| 41 | - * @since 8.0.0 |
|
| 42 | - */ |
|
| 43 | - public function getCommonName(); |
|
| 39 | + /** |
|
| 40 | + * @return string |
|
| 41 | + * @since 8.0.0 |
|
| 42 | + */ |
|
| 43 | + public function getCommonName(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @return string |
|
| 47 | - * @since 8.0.0 |
|
| 48 | - */ |
|
| 49 | - public function getOrganization(); |
|
| 45 | + /** |
|
| 46 | + * @return string |
|
| 47 | + * @since 8.0.0 |
|
| 48 | + */ |
|
| 49 | + public function getOrganization(); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return \DateTime |
|
| 53 | - * @since 8.0.0 |
|
| 54 | - */ |
|
| 55 | - public function getIssueDate(); |
|
| 51 | + /** |
|
| 52 | + * @return \DateTime |
|
| 53 | + * @since 8.0.0 |
|
| 54 | + */ |
|
| 55 | + public function getIssueDate(); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @return \DateTime |
|
| 59 | - * @since 8.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getExpireDate(); |
|
| 57 | + /** |
|
| 58 | + * @return \DateTime |
|
| 59 | + * @since 8.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getExpireDate(); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @return bool |
|
| 65 | - * @since 8.0.0 |
|
| 66 | - */ |
|
| 67 | - public function isExpired(); |
|
| 63 | + /** |
|
| 64 | + * @return bool |
|
| 65 | + * @since 8.0.0 |
|
| 66 | + */ |
|
| 67 | + public function isExpired(); |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @return string |
|
| 71 | - * @since 8.0.0 |
|
| 72 | - */ |
|
| 73 | - public function getIssuerName(); |
|
| 69 | + /** |
|
| 70 | + * @return string |
|
| 71 | + * @since 8.0.0 |
|
| 72 | + */ |
|
| 73 | + public function getIssuerName(); |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * @return string |
|
| 77 | - * @since 8.0.0 |
|
| 78 | - */ |
|
| 79 | - public function getIssuerOrganization(); |
|
| 75 | + /** |
|
| 76 | + * @return string |
|
| 77 | + * @since 8.0.0 |
|
| 78 | + */ |
|
| 79 | + public function getIssuerOrganization(); |
|
| 80 | 80 | } |
@@ -38,11 +38,11 @@ |
||
| 38 | 38 | */ |
| 39 | 39 | interface IUserBackend { |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Backend name to be shown in user management |
|
| 43 | - * @return string the name of the backend to be shown |
|
| 44 | - * @since 8.0.0 |
|
| 45 | - */ |
|
| 46 | - public function getBackendName(); |
|
| 41 | + /** |
|
| 42 | + * Backend name to be shown in user management |
|
| 43 | + * @return string the name of the backend to be shown |
|
| 44 | + * @since 8.0.0 |
|
| 45 | + */ |
|
| 46 | + public function getBackendName(); |
|
| 47 | 47 | |
| 48 | 48 | } |
@@ -50,179 +50,179 @@ |
||
| 50 | 50 | |
| 51 | 51 | interface ITags { |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Check if any tags are saved for this type and user. |
|
| 55 | - * |
|
| 56 | - * @return boolean |
|
| 57 | - * @since 6.0.0 |
|
| 58 | - */ |
|
| 59 | - public function isEmpty(); |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Returns an array mapping a given tag's properties to its values: |
|
| 63 | - * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype'] |
|
| 64 | - * |
|
| 65 | - * @param string $id The ID of the tag that is going to be mapped |
|
| 66 | - * @return array|false |
|
| 67 | - * @since 8.0.0 |
|
| 68 | - */ |
|
| 69 | - public function getTag($id); |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * Get the tags for a specific user. |
|
| 73 | - * |
|
| 74 | - * This returns an array with id/name maps: |
|
| 75 | - * [ |
|
| 76 | - * ['id' => 0, 'name' = 'First tag'], |
|
| 77 | - * ['id' => 1, 'name' = 'Second tag'], |
|
| 78 | - * ] |
|
| 79 | - * |
|
| 80 | - * @return array |
|
| 81 | - * @since 6.0.0 |
|
| 82 | - */ |
|
| 83 | - public function getTags(); |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Get a list of tags for the given item ids. |
|
| 87 | - * |
|
| 88 | - * This returns an array with object id / tag names: |
|
| 89 | - * [ |
|
| 90 | - * 1 => array('First tag', 'Second tag'), |
|
| 91 | - * 2 => array('Second tag'), |
|
| 92 | - * 3 => array('Second tag', 'Third tag'), |
|
| 93 | - * ] |
|
| 94 | - * |
|
| 95 | - * @param array $objIds item ids |
|
| 96 | - * @return array|boolean with object id as key and an array |
|
| 97 | - * of tag names as value or false if an error occurred |
|
| 98 | - * @since 8.0.0 |
|
| 99 | - */ |
|
| 100 | - public function getTagsForObjects(array $objIds); |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Get a list of items tagged with $tag. |
|
| 104 | - * |
|
| 105 | - * Throws an exception if the tag could not be found. |
|
| 106 | - * |
|
| 107 | - * @param string|integer $tag Tag id or name. |
|
| 108 | - * @return array|false An array of object ids or false on error. |
|
| 109 | - * @since 6.0.0 |
|
| 110 | - */ |
|
| 111 | - public function getIdsForTag($tag); |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Checks whether a tag is already saved. |
|
| 115 | - * |
|
| 116 | - * @param string $name The name to check for. |
|
| 117 | - * @return bool |
|
| 118 | - * @since 6.0.0 |
|
| 119 | - */ |
|
| 120 | - public function hasTag($name); |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Checks whether a tag is saved for the given user, |
|
| 124 | - * disregarding the ones shared with him or her. |
|
| 125 | - * |
|
| 126 | - * @param string $name The tag name to check for. |
|
| 127 | - * @param string $user The user whose tags are to be checked. |
|
| 128 | - * @return bool |
|
| 129 | - * @since 8.0.0 |
|
| 130 | - */ |
|
| 131 | - public function userHasTag($name, $user); |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Add a new tag. |
|
| 135 | - * |
|
| 136 | - * @param string $name A string with a name of the tag |
|
| 137 | - * @return int|false the id of the added tag or false if it already exists. |
|
| 138 | - * @since 6.0.0 |
|
| 139 | - */ |
|
| 140 | - public function add($name); |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * Rename tag. |
|
| 144 | - * |
|
| 145 | - * @param string|integer $from The name or ID of the existing tag |
|
| 146 | - * @param string $to The new name of the tag. |
|
| 147 | - * @return bool |
|
| 148 | - * @since 6.0.0 |
|
| 149 | - */ |
|
| 150 | - public function rename($from, $to); |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Add a list of new tags. |
|
| 154 | - * |
|
| 155 | - * @param string[] $names A string with a name or an array of strings containing |
|
| 156 | - * the name(s) of the to add. |
|
| 157 | - * @param bool $sync When true, save the tags |
|
| 158 | - * @param int|null $id int Optional object id to add to this|these tag(s) |
|
| 159 | - * @return bool Returns false on error. |
|
| 160 | - * @since 6.0.0 |
|
| 161 | - */ |
|
| 162 | - public function addMultiple($names, $sync=false, $id = null); |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Delete tag/object relations from the db |
|
| 166 | - * |
|
| 167 | - * @param array $ids The ids of the objects |
|
| 168 | - * @return boolean Returns false on error. |
|
| 169 | - * @since 6.0.0 |
|
| 170 | - */ |
|
| 171 | - public function purgeObjects(array $ids); |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Get favorites for an object type |
|
| 175 | - * |
|
| 176 | - * @return array|false An array of object ids. |
|
| 177 | - * @since 6.0.0 |
|
| 178 | - */ |
|
| 179 | - public function getFavorites(); |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Add an object to favorites |
|
| 183 | - * |
|
| 184 | - * @param int $objid The id of the object |
|
| 185 | - * @return boolean |
|
| 186 | - * @since 6.0.0 |
|
| 187 | - */ |
|
| 188 | - public function addToFavorites($objid); |
|
| 189 | - |
|
| 190 | - /** |
|
| 191 | - * Remove an object from favorites |
|
| 192 | - * |
|
| 193 | - * @param int $objid The id of the object |
|
| 194 | - * @return boolean |
|
| 195 | - * @since 6.0.0 |
|
| 196 | - */ |
|
| 197 | - public function removeFromFavorites($objid); |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * Creates a tag/object relation. |
|
| 201 | - * |
|
| 202 | - * @param int $objid The id of the object |
|
| 203 | - * @param string $tag The id or name of the tag |
|
| 204 | - * @return boolean Returns false on database error. |
|
| 205 | - * @since 6.0.0 |
|
| 206 | - */ |
|
| 207 | - public function tagAs($objid, $tag); |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Delete single tag/object relation from the db |
|
| 211 | - * |
|
| 212 | - * @param int $objid The id of the object |
|
| 213 | - * @param string $tag The id or name of the tag |
|
| 214 | - * @return boolean |
|
| 215 | - * @since 6.0.0 |
|
| 216 | - */ |
|
| 217 | - public function unTag($objid, $tag); |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * Delete tags from the database |
|
| 221 | - * |
|
| 222 | - * @param string[]|integer[] $names An array of tags (names or IDs) to delete |
|
| 223 | - * @return bool Returns false on error |
|
| 224 | - * @since 6.0.0 |
|
| 225 | - */ |
|
| 226 | - public function delete($names); |
|
| 53 | + /** |
|
| 54 | + * Check if any tags are saved for this type and user. |
|
| 55 | + * |
|
| 56 | + * @return boolean |
|
| 57 | + * @since 6.0.0 |
|
| 58 | + */ |
|
| 59 | + public function isEmpty(); |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Returns an array mapping a given tag's properties to its values: |
|
| 63 | + * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype'] |
|
| 64 | + * |
|
| 65 | + * @param string $id The ID of the tag that is going to be mapped |
|
| 66 | + * @return array|false |
|
| 67 | + * @since 8.0.0 |
|
| 68 | + */ |
|
| 69 | + public function getTag($id); |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * Get the tags for a specific user. |
|
| 73 | + * |
|
| 74 | + * This returns an array with id/name maps: |
|
| 75 | + * [ |
|
| 76 | + * ['id' => 0, 'name' = 'First tag'], |
|
| 77 | + * ['id' => 1, 'name' = 'Second tag'], |
|
| 78 | + * ] |
|
| 79 | + * |
|
| 80 | + * @return array |
|
| 81 | + * @since 6.0.0 |
|
| 82 | + */ |
|
| 83 | + public function getTags(); |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Get a list of tags for the given item ids. |
|
| 87 | + * |
|
| 88 | + * This returns an array with object id / tag names: |
|
| 89 | + * [ |
|
| 90 | + * 1 => array('First tag', 'Second tag'), |
|
| 91 | + * 2 => array('Second tag'), |
|
| 92 | + * 3 => array('Second tag', 'Third tag'), |
|
| 93 | + * ] |
|
| 94 | + * |
|
| 95 | + * @param array $objIds item ids |
|
| 96 | + * @return array|boolean with object id as key and an array |
|
| 97 | + * of tag names as value or false if an error occurred |
|
| 98 | + * @since 8.0.0 |
|
| 99 | + */ |
|
| 100 | + public function getTagsForObjects(array $objIds); |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Get a list of items tagged with $tag. |
|
| 104 | + * |
|
| 105 | + * Throws an exception if the tag could not be found. |
|
| 106 | + * |
|
| 107 | + * @param string|integer $tag Tag id or name. |
|
| 108 | + * @return array|false An array of object ids or false on error. |
|
| 109 | + * @since 6.0.0 |
|
| 110 | + */ |
|
| 111 | + public function getIdsForTag($tag); |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Checks whether a tag is already saved. |
|
| 115 | + * |
|
| 116 | + * @param string $name The name to check for. |
|
| 117 | + * @return bool |
|
| 118 | + * @since 6.0.0 |
|
| 119 | + */ |
|
| 120 | + public function hasTag($name); |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Checks whether a tag is saved for the given user, |
|
| 124 | + * disregarding the ones shared with him or her. |
|
| 125 | + * |
|
| 126 | + * @param string $name The tag name to check for. |
|
| 127 | + * @param string $user The user whose tags are to be checked. |
|
| 128 | + * @return bool |
|
| 129 | + * @since 8.0.0 |
|
| 130 | + */ |
|
| 131 | + public function userHasTag($name, $user); |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Add a new tag. |
|
| 135 | + * |
|
| 136 | + * @param string $name A string with a name of the tag |
|
| 137 | + * @return int|false the id of the added tag or false if it already exists. |
|
| 138 | + * @since 6.0.0 |
|
| 139 | + */ |
|
| 140 | + public function add($name); |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * Rename tag. |
|
| 144 | + * |
|
| 145 | + * @param string|integer $from The name or ID of the existing tag |
|
| 146 | + * @param string $to The new name of the tag. |
|
| 147 | + * @return bool |
|
| 148 | + * @since 6.0.0 |
|
| 149 | + */ |
|
| 150 | + public function rename($from, $to); |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Add a list of new tags. |
|
| 154 | + * |
|
| 155 | + * @param string[] $names A string with a name or an array of strings containing |
|
| 156 | + * the name(s) of the to add. |
|
| 157 | + * @param bool $sync When true, save the tags |
|
| 158 | + * @param int|null $id int Optional object id to add to this|these tag(s) |
|
| 159 | + * @return bool Returns false on error. |
|
| 160 | + * @since 6.0.0 |
|
| 161 | + */ |
|
| 162 | + public function addMultiple($names, $sync=false, $id = null); |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Delete tag/object relations from the db |
|
| 166 | + * |
|
| 167 | + * @param array $ids The ids of the objects |
|
| 168 | + * @return boolean Returns false on error. |
|
| 169 | + * @since 6.0.0 |
|
| 170 | + */ |
|
| 171 | + public function purgeObjects(array $ids); |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Get favorites for an object type |
|
| 175 | + * |
|
| 176 | + * @return array|false An array of object ids. |
|
| 177 | + * @since 6.0.0 |
|
| 178 | + */ |
|
| 179 | + public function getFavorites(); |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Add an object to favorites |
|
| 183 | + * |
|
| 184 | + * @param int $objid The id of the object |
|
| 185 | + * @return boolean |
|
| 186 | + * @since 6.0.0 |
|
| 187 | + */ |
|
| 188 | + public function addToFavorites($objid); |
|
| 189 | + |
|
| 190 | + /** |
|
| 191 | + * Remove an object from favorites |
|
| 192 | + * |
|
| 193 | + * @param int $objid The id of the object |
|
| 194 | + * @return boolean |
|
| 195 | + * @since 6.0.0 |
|
| 196 | + */ |
|
| 197 | + public function removeFromFavorites($objid); |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * Creates a tag/object relation. |
|
| 201 | + * |
|
| 202 | + * @param int $objid The id of the object |
|
| 203 | + * @param string $tag The id or name of the tag |
|
| 204 | + * @return boolean Returns false on database error. |
|
| 205 | + * @since 6.0.0 |
|
| 206 | + */ |
|
| 207 | + public function tagAs($objid, $tag); |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Delete single tag/object relation from the db |
|
| 211 | + * |
|
| 212 | + * @param int $objid The id of the object |
|
| 213 | + * @param string $tag The id or name of the tag |
|
| 214 | + * @return boolean |
|
| 215 | + * @since 6.0.0 |
|
| 216 | + */ |
|
| 217 | + public function unTag($objid, $tag); |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Delete tags from the database |
|
| 221 | + * |
|
| 222 | + * @param string[]|integer[] $names An array of tags (names or IDs) to delete |
|
| 223 | + * @return bool Returns false on error |
|
| 224 | + * @since 6.0.0 |
|
| 225 | + */ |
|
| 226 | + public function delete($names); |
|
| 227 | 227 | |
| 228 | 228 | } |
@@ -30,33 +30,33 @@ |
||
| 30 | 30 | * @since 8.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IEvent { |
| 33 | - /** |
|
| 34 | - * @return string |
|
| 35 | - * @since 8.0.0 |
|
| 36 | - */ |
|
| 37 | - public function getId(); |
|
| 33 | + /** |
|
| 34 | + * @return string |
|
| 35 | + * @since 8.0.0 |
|
| 36 | + */ |
|
| 37 | + public function getId(); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return string |
|
| 41 | - * @since 8.0.0 |
|
| 42 | - */ |
|
| 43 | - public function getDescription(); |
|
| 39 | + /** |
|
| 40 | + * @return string |
|
| 41 | + * @since 8.0.0 |
|
| 42 | + */ |
|
| 43 | + public function getDescription(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @return float |
|
| 47 | - * @since 8.0.0 |
|
| 48 | - */ |
|
| 49 | - public function getStart(); |
|
| 45 | + /** |
|
| 46 | + * @return float |
|
| 47 | + * @since 8.0.0 |
|
| 48 | + */ |
|
| 49 | + public function getStart(); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return float |
|
| 53 | - * @since 8.0.0 |
|
| 54 | - */ |
|
| 55 | - public function getEnd(); |
|
| 51 | + /** |
|
| 52 | + * @return float |
|
| 53 | + * @since 8.0.0 |
|
| 54 | + */ |
|
| 55 | + public function getEnd(); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @return float |
|
| 59 | - * @since 8.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getDuration(); |
|
| 57 | + /** |
|
| 58 | + * @return float |
|
| 59 | + * @since 8.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getDuration(); |
|
| 62 | 62 | } |