@@ -45,21 +45,21 @@ |
||
45 | 45 | * @since 17.0.0 |
46 | 46 | */ |
47 | 47 | class AddContentSecurityPolicyEvent extends Event { |
48 | - /** @var ContentSecurityPolicyManager */ |
|
49 | - private $policyManager; |
|
48 | + /** @var ContentSecurityPolicyManager */ |
|
49 | + private $policyManager; |
|
50 | 50 | |
51 | - /** |
|
52 | - * @since 17.0.0 |
|
53 | - */ |
|
54 | - public function __construct(ContentSecurityPolicyManager $policyManager) { |
|
55 | - parent::__construct(); |
|
56 | - $this->policyManager = $policyManager; |
|
57 | - } |
|
51 | + /** |
|
52 | + * @since 17.0.0 |
|
53 | + */ |
|
54 | + public function __construct(ContentSecurityPolicyManager $policyManager) { |
|
55 | + parent::__construct(); |
|
56 | + $this->policyManager = $policyManager; |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * @since 17.0.0 |
|
61 | - */ |
|
62 | - public function addPolicy(EmptyContentSecurityPolicy $csp): void { |
|
63 | - $this->policyManager->addDefaultPolicy($csp); |
|
64 | - } |
|
59 | + /** |
|
60 | + * @since 17.0.0 |
|
61 | + */ |
|
62 | + public function addPolicy(EmptyContentSecurityPolicy $csp): void { |
|
63 | + $this->policyManager->addDefaultPolicy($csp); |
|
64 | + } |
|
65 | 65 | } |
@@ -37,31 +37,31 @@ |
||
37 | 37 | * @since 8.0.0 |
38 | 38 | */ |
39 | 39 | interface ICrypto { |
40 | - /** |
|
41 | - * @param string $message The message to authenticate |
|
42 | - * @param string $password Password to use (defaults to `secret` in config.php) |
|
43 | - * @return string Calculated HMAC |
|
44 | - * @since 8.0.0 |
|
45 | - */ |
|
46 | - public function calculateHMAC(string $message, string $password = ''): string; |
|
40 | + /** |
|
41 | + * @param string $message The message to authenticate |
|
42 | + * @param string $password Password to use (defaults to `secret` in config.php) |
|
43 | + * @return string Calculated HMAC |
|
44 | + * @since 8.0.0 |
|
45 | + */ |
|
46 | + public function calculateHMAC(string $message, string $password = ''): string; |
|
47 | 47 | |
48 | - /** |
|
49 | - * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
50 | - * @param string $plaintext |
|
51 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
52 | - * @return string Authenticated ciphertext |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function encrypt(string $plaintext, string $password = ''): string; |
|
48 | + /** |
|
49 | + * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
50 | + * @param string $plaintext |
|
51 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
52 | + * @return string Authenticated ciphertext |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function encrypt(string $plaintext, string $password = ''): string; |
|
56 | 56 | |
57 | - /** |
|
58 | - * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
59 | - * @param string $authenticatedCiphertext |
|
60 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
61 | - * @return string plaintext |
|
62 | - * @throws \Exception If the HMAC does not match |
|
63 | - * @throws \Exception If the decryption failed |
|
64 | - * @since 8.0.0 |
|
65 | - */ |
|
66 | - public function decrypt(string $authenticatedCiphertext, string $password = ''): string; |
|
57 | + /** |
|
58 | + * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
59 | + * @param string $authenticatedCiphertext |
|
60 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
61 | + * @return string plaintext |
|
62 | + * @throws \Exception If the HMAC does not match |
|
63 | + * @throws \Exception If the decryption failed |
|
64 | + * @since 8.0.0 |
|
65 | + */ |
|
66 | + public function decrypt(string $authenticatedCiphertext, string $password = ''): string; |
|
67 | 67 | } |
@@ -32,30 +32,30 @@ |
||
32 | 32 | * @since 23.0.0 |
33 | 33 | */ |
34 | 34 | interface IVerificationToken { |
35 | - /** |
|
36 | - * Checks whether the a provided tokent matches a stored token and its |
|
37 | - * constraints. An InvalidTokenException is thrown on issues, otherwise |
|
38 | - * the check is successful. |
|
39 | - * |
|
40 | - * null can be passed as $user, but mind that this is for conveniently |
|
41 | - * passing the return of IUserManager::getUser() to this method. When |
|
42 | - * $user is null, InvalidTokenException is thrown for all the issued |
|
43 | - * tokens are user related. |
|
44 | - * |
|
45 | - * @throws InvalidTokenException |
|
46 | - * @since 23.0.0 |
|
47 | - */ |
|
48 | - public function check(string $token, ?IUser $user, string $subject, string $passwordPrefix = '', bool $expiresWithLogin = false): void; |
|
35 | + /** |
|
36 | + * Checks whether the a provided tokent matches a stored token and its |
|
37 | + * constraints. An InvalidTokenException is thrown on issues, otherwise |
|
38 | + * the check is successful. |
|
39 | + * |
|
40 | + * null can be passed as $user, but mind that this is for conveniently |
|
41 | + * passing the return of IUserManager::getUser() to this method. When |
|
42 | + * $user is null, InvalidTokenException is thrown for all the issued |
|
43 | + * tokens are user related. |
|
44 | + * |
|
45 | + * @throws InvalidTokenException |
|
46 | + * @since 23.0.0 |
|
47 | + */ |
|
48 | + public function check(string $token, ?IUser $user, string $subject, string $passwordPrefix = '', bool $expiresWithLogin = false): void; |
|
49 | 49 | |
50 | - /** |
|
51 | - * @since 23.0.0 |
|
52 | - */ |
|
53 | - public function create(IUser $user, string $subject, string $passwordPrefix = ''): string; |
|
50 | + /** |
|
51 | + * @since 23.0.0 |
|
52 | + */ |
|
53 | + public function create(IUser $user, string $subject, string $passwordPrefix = ''): string; |
|
54 | 54 | |
55 | - /** |
|
56 | - * Deletes the token identified by the provided parameters |
|
57 | - * |
|
58 | - * @since 23.0.0 |
|
59 | - */ |
|
60 | - public function delete(string $token, IUser $user, string $subject): void; |
|
55 | + /** |
|
56 | + * Deletes the token identified by the provided parameters |
|
57 | + * |
|
58 | + * @since 23.0.0 |
|
59 | + */ |
|
60 | + public function delete(string $token, IUser $user, string $subject): void; |
|
61 | 61 | } |
@@ -35,65 +35,65 @@ |
||
35 | 35 | * @since 18.0.0 |
36 | 36 | */ |
37 | 37 | interface IManager { |
38 | - /** |
|
39 | - * Register a new editor |
|
40 | - * |
|
41 | - * @since 18.0.0 |
|
42 | - * @param IEditor $directEditor |
|
43 | - */ |
|
44 | - public function registerDirectEditor(IEditor $directEditor): void; |
|
38 | + /** |
|
39 | + * Register a new editor |
|
40 | + * |
|
41 | + * @since 18.0.0 |
|
42 | + * @param IEditor $directEditor |
|
43 | + */ |
|
44 | + public function registerDirectEditor(IEditor $directEditor): void; |
|
45 | 45 | |
46 | - /** |
|
47 | - * Open the editing page for a provided token |
|
48 | - * |
|
49 | - * @since 18.0.0 |
|
50 | - * @param string $token |
|
51 | - * @return Response |
|
52 | - */ |
|
53 | - public function edit(string $token): Response; |
|
46 | + /** |
|
47 | + * Open the editing page for a provided token |
|
48 | + * |
|
49 | + * @since 18.0.0 |
|
50 | + * @param string $token |
|
51 | + * @return Response |
|
52 | + */ |
|
53 | + public function edit(string $token): Response; |
|
54 | 54 | |
55 | - /** |
|
56 | - * Create a new token based on the file path and editor details |
|
57 | - * |
|
58 | - * @since 18.0.0 |
|
59 | - * @param string $path |
|
60 | - * @param string $editorId |
|
61 | - * @param string $creatorId |
|
62 | - * @param null $templateId |
|
63 | - * @return string |
|
64 | - * @throws NotPermittedException |
|
65 | - * @throws RuntimeException |
|
66 | - */ |
|
67 | - public function create(string $path, string $editorId, string $creatorId, $templateId = null): string; |
|
55 | + /** |
|
56 | + * Create a new token based on the file path and editor details |
|
57 | + * |
|
58 | + * @since 18.0.0 |
|
59 | + * @param string $path |
|
60 | + * @param string $editorId |
|
61 | + * @param string $creatorId |
|
62 | + * @param null $templateId |
|
63 | + * @return string |
|
64 | + * @throws NotPermittedException |
|
65 | + * @throws RuntimeException |
|
66 | + */ |
|
67 | + public function create(string $path, string $editorId, string $creatorId, $templateId = null): string; |
|
68 | 68 | |
69 | - /** |
|
70 | - * Get the token details for a given token |
|
71 | - * |
|
72 | - * @since 18.0.0 |
|
73 | - * @param string $token |
|
74 | - * @return IToken |
|
75 | - */ |
|
76 | - public function getToken(string $token): IToken; |
|
69 | + /** |
|
70 | + * Get the token details for a given token |
|
71 | + * |
|
72 | + * @since 18.0.0 |
|
73 | + * @param string $token |
|
74 | + * @return IToken |
|
75 | + */ |
|
76 | + public function getToken(string $token): IToken; |
|
77 | 77 | |
78 | - /** |
|
79 | - * Cleanup expired tokens |
|
80 | - * |
|
81 | - * @since 18.0.0 |
|
82 | - * @return int number of deleted tokens |
|
83 | - */ |
|
84 | - public function cleanup(): int; |
|
78 | + /** |
|
79 | + * Cleanup expired tokens |
|
80 | + * |
|
81 | + * @since 18.0.0 |
|
82 | + * @return int number of deleted tokens |
|
83 | + */ |
|
84 | + public function cleanup(): int; |
|
85 | 85 | |
86 | - /** |
|
87 | - * Check if direct editing is enabled |
|
88 | - * |
|
89 | - * @since 20.0.0 |
|
90 | - * @return bool |
|
91 | - */ |
|
92 | - public function isEnabled(): bool; |
|
86 | + /** |
|
87 | + * Check if direct editing is enabled |
|
88 | + * |
|
89 | + * @since 20.0.0 |
|
90 | + * @return bool |
|
91 | + */ |
|
92 | + public function isEnabled(): bool; |
|
93 | 93 | |
94 | - /** |
|
95 | - * @since 24.0.0 |
|
96 | - * @return IEditor[] |
|
97 | - */ |
|
98 | - public function getEditors(): array; |
|
94 | + /** |
|
95 | + * @since 24.0.0 |
|
96 | + * @return IEditor[] |
|
97 | + */ |
|
98 | + public function getEditors(): array; |
|
99 | 99 | } |
@@ -26,11 +26,11 @@ |
||
26 | 26 | * @since 18.0.0 |
27 | 27 | */ |
28 | 28 | abstract class ACreateFromTemplate extends ACreateEmpty { |
29 | - /** |
|
30 | - * List of available templates for the create from template action |
|
31 | - * |
|
32 | - * @since 18.0.0 |
|
33 | - * @return ATemplate[] |
|
34 | - */ |
|
35 | - abstract public function getTemplates(): array; |
|
29 | + /** |
|
30 | + * List of available templates for the create from template action |
|
31 | + * |
|
32 | + * @since 18.0.0 |
|
33 | + * @return ATemplate[] |
|
34 | + */ |
|
35 | + abstract public function getTemplates(): array; |
|
36 | 36 | } |
@@ -31,27 +31,27 @@ |
||
31 | 31 | * @since 18.0.0 |
32 | 32 | */ |
33 | 33 | class RegisterDirectEditorEvent extends Event { |
34 | - /** |
|
35 | - * @var IManager |
|
36 | - */ |
|
37 | - private $manager; |
|
34 | + /** |
|
35 | + * @var IManager |
|
36 | + */ |
|
37 | + private $manager; |
|
38 | 38 | |
39 | - /** |
|
40 | - * RegisterDirectEditorEvent constructor. |
|
41 | - * |
|
42 | - * @param IManager $manager |
|
43 | - * @since 18.0.0 |
|
44 | - */ |
|
45 | - public function __construct(IManager $manager) { |
|
46 | - parent::__construct(); |
|
47 | - $this->manager = $manager; |
|
48 | - } |
|
39 | + /** |
|
40 | + * RegisterDirectEditorEvent constructor. |
|
41 | + * |
|
42 | + * @param IManager $manager |
|
43 | + * @since 18.0.0 |
|
44 | + */ |
|
45 | + public function __construct(IManager $manager) { |
|
46 | + parent::__construct(); |
|
47 | + $this->manager = $manager; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * @since 18.0.0 |
|
52 | - * @param IEditor $editor |
|
53 | - */ |
|
54 | - public function register(IEditor $editor): void { |
|
55 | - $this->manager->registerDirectEditor($editor); |
|
56 | - } |
|
50 | + /** |
|
51 | + * @since 18.0.0 |
|
52 | + * @param IEditor $editor |
|
53 | + */ |
|
54 | + public function register(IEditor $editor): void { |
|
55 | + $this->manager->registerDirectEditor($editor); |
|
56 | + } |
|
57 | 57 | } |
@@ -30,38 +30,38 @@ |
||
30 | 30 | * @since 18.0.0 |
31 | 31 | */ |
32 | 32 | abstract class ATemplate implements JsonSerializable { |
33 | - /** |
|
34 | - * Return a unique id so the app can identify the template |
|
35 | - * |
|
36 | - * @since 18.0.0 |
|
37 | - * @return string |
|
38 | - */ |
|
39 | - abstract public function getId(): string; |
|
33 | + /** |
|
34 | + * Return a unique id so the app can identify the template |
|
35 | + * |
|
36 | + * @since 18.0.0 |
|
37 | + * @return string |
|
38 | + */ |
|
39 | + abstract public function getId(): string; |
|
40 | 40 | |
41 | - /** |
|
42 | - * Return a title that is displayed to the user |
|
43 | - * |
|
44 | - * @since 18.0.0 |
|
45 | - * @return string |
|
46 | - */ |
|
47 | - abstract public function getTitle(): string; |
|
41 | + /** |
|
42 | + * Return a title that is displayed to the user |
|
43 | + * |
|
44 | + * @since 18.0.0 |
|
45 | + * @return string |
|
46 | + */ |
|
47 | + abstract public function getTitle(): string; |
|
48 | 48 | |
49 | - /** |
|
50 | - * Return a link to the template preview image |
|
51 | - * |
|
52 | - * @since 18.0.0 |
|
53 | - * @return string |
|
54 | - */ |
|
55 | - abstract public function getPreview(): string; |
|
49 | + /** |
|
50 | + * Return a link to the template preview image |
|
51 | + * |
|
52 | + * @since 18.0.0 |
|
53 | + * @return string |
|
54 | + */ |
|
55 | + abstract public function getPreview(): string; |
|
56 | 56 | |
57 | - /** |
|
58 | - * @since 18.0.0 |
|
59 | - */ |
|
60 | - public function jsonSerialize(): array { |
|
61 | - return [ |
|
62 | - 'id' => $this->getId(), |
|
63 | - 'title' => $this->getTitle(), |
|
64 | - 'preview' => $this->getPreview(), |
|
65 | - ]; |
|
66 | - } |
|
57 | + /** |
|
58 | + * @since 18.0.0 |
|
59 | + */ |
|
60 | + public function jsonSerialize(): array { |
|
61 | + return [ |
|
62 | + 'id' => $this->getId(), |
|
63 | + 'title' => $this->getTitle(), |
|
64 | + 'preview' => $this->getPreview(), |
|
65 | + ]; |
|
66 | + } |
|
67 | 67 | } |
@@ -29,53 +29,53 @@ |
||
29 | 29 | * @since 18.0.0 |
30 | 30 | */ |
31 | 31 | interface IToken { |
32 | - /** |
|
33 | - * Extend the token validity time |
|
34 | - * |
|
35 | - * @since 18.0.0 |
|
36 | - */ |
|
37 | - public function extend(): void; |
|
32 | + /** |
|
33 | + * Extend the token validity time |
|
34 | + * |
|
35 | + * @since 18.0.0 |
|
36 | + */ |
|
37 | + public function extend(): void; |
|
38 | 38 | |
39 | - /** |
|
40 | - * Invalidate the token |
|
41 | - * |
|
42 | - * @since 18.0.0 |
|
43 | - */ |
|
44 | - public function invalidate(): void; |
|
39 | + /** |
|
40 | + * Invalidate the token |
|
41 | + * |
|
42 | + * @since 18.0.0 |
|
43 | + */ |
|
44 | + public function invalidate(): void; |
|
45 | 45 | |
46 | - /** |
|
47 | - * Check if the token has already been used |
|
48 | - * |
|
49 | - * @since 18.0.0 |
|
50 | - * @return bool |
|
51 | - */ |
|
52 | - public function hasBeenAccessed(): bool; |
|
46 | + /** |
|
47 | + * Check if the token has already been used |
|
48 | + * |
|
49 | + * @since 18.0.0 |
|
50 | + * @return bool |
|
51 | + */ |
|
52 | + public function hasBeenAccessed(): bool; |
|
53 | 53 | |
54 | - /** |
|
55 | - * Change to the user scope of the token |
|
56 | - * |
|
57 | - * @since 18.0.0 |
|
58 | - */ |
|
59 | - public function useTokenScope(): void; |
|
54 | + /** |
|
55 | + * Change to the user scope of the token |
|
56 | + * |
|
57 | + * @since 18.0.0 |
|
58 | + */ |
|
59 | + public function useTokenScope(): void; |
|
60 | 60 | |
61 | - /** |
|
62 | - * Get the file that is related to the token |
|
63 | - * |
|
64 | - * @since 18.0.0 |
|
65 | - * @return File |
|
66 | - * @throws NotFoundException |
|
67 | - */ |
|
68 | - public function getFile(): File; |
|
61 | + /** |
|
62 | + * Get the file that is related to the token |
|
63 | + * |
|
64 | + * @since 18.0.0 |
|
65 | + * @return File |
|
66 | + * @throws NotFoundException |
|
67 | + */ |
|
68 | + public function getFile(): File; |
|
69 | 69 | |
70 | - /** |
|
71 | - * @since 18.0.0 |
|
72 | - * @return string |
|
73 | - */ |
|
74 | - public function getEditor(): string; |
|
70 | + /** |
|
71 | + * @since 18.0.0 |
|
72 | + * @return string |
|
73 | + */ |
|
74 | + public function getEditor(): string; |
|
75 | 75 | |
76 | - /** |
|
77 | - * @since 18.0.0 |
|
78 | - * @return string |
|
79 | - */ |
|
80 | - public function getUser(): string; |
|
76 | + /** |
|
77 | + * @since 18.0.0 |
|
78 | + * @return string |
|
79 | + */ |
|
80 | + public function getUser(): string; |
|
81 | 81 | } |
@@ -34,57 +34,57 @@ |
||
34 | 34 | * @since 18.0.0 |
35 | 35 | */ |
36 | 36 | class PostLoginEvent extends Event { |
37 | - /** @var IUser */ |
|
38 | - private $user; |
|
37 | + /** @var IUser */ |
|
38 | + private $user; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @since 20.0.0 |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - private $loginName; |
|
40 | + /** |
|
41 | + * @since 20.0.0 |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + private $loginName; |
|
45 | 45 | |
46 | - /** @var string */ |
|
47 | - private $password; |
|
46 | + /** @var string */ |
|
47 | + private $password; |
|
48 | 48 | |
49 | - /** @var bool */ |
|
50 | - private $isTokenLogin; |
|
49 | + /** @var bool */ |
|
50 | + private $isTokenLogin; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @since 18.0.0 |
|
54 | - */ |
|
55 | - public function __construct(IUser $user, string $loginName, string $password, bool $isTokenLogin) { |
|
56 | - parent::__construct(); |
|
57 | - $this->user = $user; |
|
58 | - $this->loginName = $loginName; |
|
59 | - $this->password = $password; |
|
60 | - $this->isTokenLogin = $isTokenLogin; |
|
61 | - } |
|
52 | + /** |
|
53 | + * @since 18.0.0 |
|
54 | + */ |
|
55 | + public function __construct(IUser $user, string $loginName, string $password, bool $isTokenLogin) { |
|
56 | + parent::__construct(); |
|
57 | + $this->user = $user; |
|
58 | + $this->loginName = $loginName; |
|
59 | + $this->password = $password; |
|
60 | + $this->isTokenLogin = $isTokenLogin; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @since 18.0.0 |
|
65 | - */ |
|
66 | - public function getUser(): IUser { |
|
67 | - return $this->user; |
|
68 | - } |
|
63 | + /** |
|
64 | + * @since 18.0.0 |
|
65 | + */ |
|
66 | + public function getUser(): IUser { |
|
67 | + return $this->user; |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * @since 20.0.0 |
|
72 | - */ |
|
73 | - public function getLoginName(): string { |
|
74 | - return $this->loginName; |
|
75 | - } |
|
70 | + /** |
|
71 | + * @since 20.0.0 |
|
72 | + */ |
|
73 | + public function getLoginName(): string { |
|
74 | + return $this->loginName; |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * @since 18.0.0 |
|
79 | - */ |
|
80 | - public function getPassword(): string { |
|
81 | - return $this->password; |
|
82 | - } |
|
77 | + /** |
|
78 | + * @since 18.0.0 |
|
79 | + */ |
|
80 | + public function getPassword(): string { |
|
81 | + return $this->password; |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * @since 18.0.0 |
|
86 | - */ |
|
87 | - public function isTokenLogin(): bool { |
|
88 | - return $this->isTokenLogin; |
|
89 | - } |
|
84 | + /** |
|
85 | + * @since 18.0.0 |
|
86 | + */ |
|
87 | + public function isTokenLogin(): bool { |
|
88 | + return $this->isTokenLogin; |
|
89 | + } |
|
90 | 90 | } |