@@ -31,20 +31,20 @@ |
||
| 31 | 31 | * @since 21.0.0 |
| 32 | 32 | */ |
| 33 | 33 | final class GenericResponse implements IResponse { |
| 34 | - /** @var Response */ |
|
| 35 | - private $response; |
|
| 34 | + /** @var Response */ |
|
| 35 | + private $response; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @since 21.0.0 |
|
| 39 | - */ |
|
| 40 | - public function __construct(Response $response) { |
|
| 41 | - $this->response = $response; |
|
| 42 | - } |
|
| 37 | + /** |
|
| 38 | + * @since 21.0.0 |
|
| 39 | + */ |
|
| 40 | + public function __construct(Response $response) { |
|
| 41 | + $this->response = $response; |
|
| 42 | + } |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @since 21.0.0 |
|
| 46 | - */ |
|
| 47 | - public function toHttpResponse(): Response { |
|
| 48 | - return $this->response; |
|
| 49 | - } |
|
| 44 | + /** |
|
| 45 | + * @since 21.0.0 |
|
| 46 | + */ |
|
| 47 | + public function toHttpResponse(): Response { |
|
| 48 | + return $this->response; |
|
| 49 | + } |
|
| 50 | 50 | } |
@@ -36,10 +36,10 @@ |
||
| 36 | 36 | * @since 21.0.0 |
| 37 | 37 | */ |
| 38 | 38 | interface IRequestContext { |
| 39 | - /** |
|
| 40 | - * @return IRequest |
|
| 41 | - * |
|
| 42 | - * @since 21.0.0 |
|
| 43 | - */ |
|
| 44 | - public function getHttpRequest(): IRequest; |
|
| 39 | + /** |
|
| 40 | + * @return IRequest |
|
| 41 | + * |
|
| 42 | + * @since 21.0.0 |
|
| 43 | + */ |
|
| 44 | + public function getHttpRequest(): IRequest; |
|
| 45 | 45 | } |
@@ -34,14 +34,14 @@ |
||
| 34 | 34 | * @since 21.0.0 |
| 35 | 35 | */ |
| 36 | 36 | interface IHandler { |
| 37 | - /** |
|
| 38 | - * @param string $service the name of the well known service, e.g. 'webfinger' |
|
| 39 | - * @param IRequestContext $context |
|
| 40 | - * @param IResponse|null $previousResponse the response of the previous handler, if any |
|
| 41 | - * |
|
| 42 | - * @return IResponse|null a response object if the request could be handled, null otherwise |
|
| 43 | - * |
|
| 44 | - * @since 21.0.0 |
|
| 45 | - */ |
|
| 46 | - public function handle(string $service, IRequestContext $context, ?IResponse $previousResponse): ?IResponse; |
|
| 37 | + /** |
|
| 38 | + * @param string $service the name of the well known service, e.g. 'webfinger' |
|
| 39 | + * @param IRequestContext $context |
|
| 40 | + * @param IResponse|null $previousResponse the response of the previous handler, if any |
|
| 41 | + * |
|
| 42 | + * @return IResponse|null a response object if the request could be handled, null otherwise |
|
| 43 | + * |
|
| 44 | + * @since 21.0.0 |
|
| 45 | + */ |
|
| 46 | + public function handle(string $service, IRequestContext $context, ?IResponse $previousResponse): ?IResponse; |
|
| 47 | 47 | } |
@@ -31,8 +31,8 @@ |
||
| 31 | 31 | * @since 21.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface IResponse { |
| 34 | - /** |
|
| 35 | - * @since 21.0.0 |
|
| 36 | - */ |
|
| 37 | - public function toHttpResponse(): Response; |
|
| 34 | + /** |
|
| 35 | + * @since 21.0.0 |
|
| 36 | + */ |
|
| 37 | + public function toHttpResponse(): Response; |
|
| 38 | 38 | } |
@@ -31,10 +31,10 @@ |
||
| 31 | 31 | * @since 18.0.1 |
| 32 | 32 | */ |
| 33 | 33 | interface IDataLogger { |
| 34 | - /** |
|
| 35 | - * allows to log custom data, similar to how logException works |
|
| 36 | - * |
|
| 37 | - * @since 18.0.1 |
|
| 38 | - */ |
|
| 39 | - public function logData(string $message, array $data, array $context = []): void; |
|
| 34 | + /** |
|
| 35 | + * allows to log custom data, similar to how logException works |
|
| 36 | + * |
|
| 37 | + * @since 18.0.1 |
|
| 38 | + */ |
|
| 39 | + public function logData(string $message, array $data, array $context = []): void; |
|
| 40 | 40 | } |
@@ -26,10 +26,10 @@ |
||
| 26 | 26 | * @since 12.0 |
| 27 | 27 | */ |
| 28 | 28 | interface IProvider { |
| 29 | - /** |
|
| 30 | - * @since 12.0 |
|
| 31 | - * @param IEntry $entry |
|
| 32 | - * @return void |
|
| 33 | - */ |
|
| 34 | - public function process(IEntry $entry); |
|
| 29 | + /** |
|
| 30 | + * @since 12.0 |
|
| 31 | + * @param IEntry $entry |
|
| 32 | + * @return void |
|
| 33 | + */ |
|
| 34 | + public function process(IEntry $entry); |
|
| 35 | 35 | } |
@@ -26,15 +26,15 @@ |
||
| 26 | 26 | * @since 12.0 |
| 27 | 27 | */ |
| 28 | 28 | interface ILinkAction extends IAction { |
| 29 | - /** |
|
| 30 | - * @param string $href the target URL of the action |
|
| 31 | - * @since 12.0 |
|
| 32 | - */ |
|
| 33 | - public function setHref(string $href); |
|
| 29 | + /** |
|
| 30 | + * @param string $href the target URL of the action |
|
| 31 | + * @since 12.0 |
|
| 32 | + */ |
|
| 33 | + public function setHref(string $href); |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @since 12.0 |
|
| 37 | - * @return string |
|
| 38 | - */ |
|
| 39 | - public function getHref(): string; |
|
| 35 | + /** |
|
| 36 | + * @since 12.0 |
|
| 37 | + * @return string |
|
| 38 | + */ |
|
| 39 | + public function getHref(): string; |
|
| 40 | 40 | } |
@@ -26,29 +26,29 @@ |
||
| 26 | 26 | * @since 12.0 |
| 27 | 27 | */ |
| 28 | 28 | interface IActionFactory { |
| 29 | - /** |
|
| 30 | - * Construct and return a new link action for the contacts menu |
|
| 31 | - * |
|
| 32 | - * @since 12.0 |
|
| 33 | - * |
|
| 34 | - * @param string $icon full path to the action's icon |
|
| 35 | - * @param string $name localized name of the action |
|
| 36 | - * @param string $href target URL |
|
| 37 | - * @param string $appId the app ID registering the action |
|
| 38 | - * @return ILinkAction |
|
| 39 | - */ |
|
| 40 | - public function newLinkAction(string $icon, string $name, string $href, string $appId = ''): ILinkAction; |
|
| 29 | + /** |
|
| 30 | + * Construct and return a new link action for the contacts menu |
|
| 31 | + * |
|
| 32 | + * @since 12.0 |
|
| 33 | + * |
|
| 34 | + * @param string $icon full path to the action's icon |
|
| 35 | + * @param string $name localized name of the action |
|
| 36 | + * @param string $href target URL |
|
| 37 | + * @param string $appId the app ID registering the action |
|
| 38 | + * @return ILinkAction |
|
| 39 | + */ |
|
| 40 | + public function newLinkAction(string $icon, string $name, string $href, string $appId = ''): ILinkAction; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Construct and return a new email action for the contacts menu |
|
| 44 | - * |
|
| 45 | - * @since 12.0 |
|
| 46 | - * |
|
| 47 | - * @param string $icon full path to the action's icon |
|
| 48 | - * @param string $name localized name of the action |
|
| 49 | - * @param string $email target e-mail address |
|
| 50 | - * @param string $appId the appName registering the action |
|
| 51 | - * @return ILinkAction |
|
| 52 | - */ |
|
| 53 | - public function newEMailAction(string $icon, string $name, string $email, string $appId = ''): ILinkAction; |
|
| 42 | + /** |
|
| 43 | + * Construct and return a new email action for the contacts menu |
|
| 44 | + * |
|
| 45 | + * @since 12.0 |
|
| 46 | + * |
|
| 47 | + * @param string $icon full path to the action's icon |
|
| 48 | + * @param string $name localized name of the action |
|
| 49 | + * @param string $email target e-mail address |
|
| 50 | + * @param string $appId the appName registering the action |
|
| 51 | + * @return ILinkAction |
|
| 52 | + */ |
|
| 53 | + public function newEMailAction(string $icon, string $name, string $email, string $appId = ''): ILinkAction; |
|
| 54 | 54 | } |
@@ -30,19 +30,19 @@ |
||
| 30 | 30 | * @since 13.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IContactsStore { |
| 33 | - /** |
|
| 34 | - * @param IUser $user |
|
| 35 | - * @param string|null $filter |
|
| 36 | - * @param int|null $limit added 19.0.2 |
|
| 37 | - * @param int|null $offset added 19.0.2 |
|
| 38 | - * @return IEntry[] |
|
| 39 | - * @since 13.0.0 |
|
| 40 | - */ |
|
| 41 | - public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array; |
|
| 33 | + /** |
|
| 34 | + * @param IUser $user |
|
| 35 | + * @param string|null $filter |
|
| 36 | + * @param int|null $limit added 19.0.2 |
|
| 37 | + * @param int|null $offset added 19.0.2 |
|
| 38 | + * @return IEntry[] |
|
| 39 | + * @since 13.0.0 |
|
| 40 | + */ |
|
| 41 | + public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @brief finds a contact by specifying the property to search on ($shareType) and the value ($shareWith) |
|
| 45 | - * @since 13.0.0 |
|
| 46 | - */ |
|
| 47 | - public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry; |
|
| 43 | + /** |
|
| 44 | + * @brief finds a contact by specifying the property to search on ($shareType) and the value ($shareWith) |
|
| 45 | + * @since 13.0.0 |
|
| 46 | + */ |
|
| 47 | + public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry; |
|
| 48 | 48 | } |