@@ -46,60 +46,60 @@ |
||
46 | 46 | * @since 8.1.0 |
47 | 47 | */ |
48 | 48 | interface IMailer { |
49 | - /** |
|
50 | - * Creates a new message object that can be passed to send() |
|
51 | - * |
|
52 | - * @return IMessage |
|
53 | - * @since 8.1.0 |
|
54 | - */ |
|
55 | - public function createMessage(): IMessage; |
|
49 | + /** |
|
50 | + * Creates a new message object that can be passed to send() |
|
51 | + * |
|
52 | + * @return IMessage |
|
53 | + * @since 8.1.0 |
|
54 | + */ |
|
55 | + public function createMessage(): IMessage; |
|
56 | 56 | |
57 | - /** |
|
58 | - * @param string|null $data |
|
59 | - * @param string|null $filename |
|
60 | - * @param string|null $contentType |
|
61 | - * @return IAttachment |
|
62 | - * @since 13.0.0 |
|
63 | - */ |
|
64 | - public function createAttachment($data = null, $filename = null, $contentType = null): IAttachment; |
|
57 | + /** |
|
58 | + * @param string|null $data |
|
59 | + * @param string|null $filename |
|
60 | + * @param string|null $contentType |
|
61 | + * @return IAttachment |
|
62 | + * @since 13.0.0 |
|
63 | + */ |
|
64 | + public function createAttachment($data = null, $filename = null, $contentType = null): IAttachment; |
|
65 | 65 | |
66 | - /** |
|
67 | - * @param string $path |
|
68 | - * @param string|null $contentType |
|
69 | - * @return IAttachment |
|
70 | - * @since 13.0.0 |
|
71 | - */ |
|
72 | - public function createAttachmentFromPath(string $path, $contentType = null): IAttachment; |
|
66 | + /** |
|
67 | + * @param string $path |
|
68 | + * @param string|null $contentType |
|
69 | + * @return IAttachment |
|
70 | + * @since 13.0.0 |
|
71 | + */ |
|
72 | + public function createAttachmentFromPath(string $path, $contentType = null): IAttachment; |
|
73 | 73 | |
74 | - /** |
|
75 | - * Creates a new email template object |
|
76 | - * |
|
77 | - * @param string $emailId |
|
78 | - * @param array $data |
|
79 | - * @return IEMailTemplate |
|
80 | - * @since 12.0.0 Parameters added in 12.0.3 |
|
81 | - */ |
|
82 | - public function createEMailTemplate(string $emailId, array $data = []): IEMailTemplate; |
|
74 | + /** |
|
75 | + * Creates a new email template object |
|
76 | + * |
|
77 | + * @param string $emailId |
|
78 | + * @param array $data |
|
79 | + * @return IEMailTemplate |
|
80 | + * @since 12.0.0 Parameters added in 12.0.3 |
|
81 | + */ |
|
82 | + public function createEMailTemplate(string $emailId, array $data = []): IEMailTemplate; |
|
83 | 83 | |
84 | - /** |
|
85 | - * Send the specified message. Also sets the from address to the value defined in config.php |
|
86 | - * if no-one has been passed. |
|
87 | - * |
|
88 | - * @param IMessage $message Message to send |
|
89 | - * @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and |
|
90 | - * therefore should be considered |
|
91 | - * @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address |
|
92 | - * has been supplied.) |
|
93 | - * @since 8.1.0 |
|
94 | - */ |
|
95 | - public function send(IMessage $message): array; |
|
84 | + /** |
|
85 | + * Send the specified message. Also sets the from address to the value defined in config.php |
|
86 | + * if no-one has been passed. |
|
87 | + * |
|
88 | + * @param IMessage $message Message to send |
|
89 | + * @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and |
|
90 | + * therefore should be considered |
|
91 | + * @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address |
|
92 | + * has been supplied.) |
|
93 | + * @since 8.1.0 |
|
94 | + */ |
|
95 | + public function send(IMessage $message): array; |
|
96 | 96 | |
97 | - /** |
|
98 | - * Checks if an e-mail address is valid |
|
99 | - * |
|
100 | - * @param string $email Email address to be validated |
|
101 | - * @return bool True if the mail address is valid, false otherwise |
|
102 | - * @since 8.1.0 |
|
103 | - */ |
|
104 | - public function validateMailAddress(string $email): bool; |
|
97 | + /** |
|
98 | + * Checks if an e-mail address is valid |
|
99 | + * |
|
100 | + * @param string $email Email address to be validated |
|
101 | + * @return bool True if the mail address is valid, false otherwise |
|
102 | + * @since 8.1.0 |
|
103 | + */ |
|
104 | + public function validateMailAddress(string $email): bool; |
|
105 | 105 | } |
@@ -32,25 +32,25 @@ |
||
32 | 32 | */ |
33 | 33 | interface IAttachment { |
34 | 34 | |
35 | - /** |
|
36 | - * @param string $filename |
|
37 | - * @return IAttachment |
|
38 | - * @since 13.0.0 |
|
39 | - */ |
|
40 | - public function setFilename(string $filename): IAttachment; |
|
35 | + /** |
|
36 | + * @param string $filename |
|
37 | + * @return IAttachment |
|
38 | + * @since 13.0.0 |
|
39 | + */ |
|
40 | + public function setFilename(string $filename): IAttachment; |
|
41 | 41 | |
42 | - /** |
|
43 | - * @param string $contentType |
|
44 | - * @return IAttachment |
|
45 | - * @since 13.0.0 |
|
46 | - */ |
|
47 | - public function setContentType(string $contentType): IAttachment; |
|
42 | + /** |
|
43 | + * @param string $contentType |
|
44 | + * @return IAttachment |
|
45 | + * @since 13.0.0 |
|
46 | + */ |
|
47 | + public function setContentType(string $contentType): IAttachment; |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $body |
|
51 | - * @return IAttachment |
|
52 | - * @since 13.0.0 |
|
53 | - */ |
|
54 | - public function setBody(string $body): IAttachment; |
|
49 | + /** |
|
50 | + * @param string $body |
|
51 | + * @return IAttachment |
|
52 | + * @since 13.0.0 |
|
53 | + */ |
|
54 | + public function setBody(string $body): IAttachment; |
|
55 | 55 | |
56 | 56 | } |
@@ -32,64 +32,64 @@ |
||
32 | 32 | */ |
33 | 33 | interface IMessage { |
34 | 34 | |
35 | - /** |
|
36 | - * @param IAttachment $attachment |
|
37 | - * @return IMessage |
|
38 | - * @since 13.0.0 |
|
39 | - */ |
|
40 | - public function attach(IAttachment $attachment): IMessage; |
|
35 | + /** |
|
36 | + * @param IAttachment $attachment |
|
37 | + * @return IMessage |
|
38 | + * @since 13.0.0 |
|
39 | + */ |
|
40 | + public function attach(IAttachment $attachment): IMessage; |
|
41 | 41 | |
42 | - /** |
|
43 | - * Set the from address of this message. |
|
44 | - * |
|
45 | - * If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php |
|
46 | - * |
|
47 | - * @param array $addresses Example: array('[email protected]', '[email protected]' => 'A name') |
|
48 | - * @return IMessage |
|
49 | - * @since 13.0.0 |
|
50 | - */ |
|
51 | - public function setFrom(array $addresses): IMessage; |
|
42 | + /** |
|
43 | + * Set the from address of this message. |
|
44 | + * |
|
45 | + * If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php |
|
46 | + * |
|
47 | + * @param array $addresses Example: array('[email protected]', '[email protected]' => 'A name') |
|
48 | + * @return IMessage |
|
49 | + * @since 13.0.0 |
|
50 | + */ |
|
51 | + public function setFrom(array $addresses): IMessage; |
|
52 | 52 | |
53 | - /** |
|
54 | - * Set the Reply-To address of this message |
|
55 | - * |
|
56 | - * @param array $addresses |
|
57 | - * @return IMessage |
|
58 | - * @since 13.0.0 |
|
59 | - */ |
|
60 | - public function setReplyTo(array $addresses): IMessage; |
|
53 | + /** |
|
54 | + * Set the Reply-To address of this message |
|
55 | + * |
|
56 | + * @param array $addresses |
|
57 | + * @return IMessage |
|
58 | + * @since 13.0.0 |
|
59 | + */ |
|
60 | + public function setReplyTo(array $addresses): IMessage; |
|
61 | 61 | |
62 | - /** |
|
63 | - * Set the to addresses of this message. |
|
64 | - * |
|
65 | - * @param array $recipients Example: array('[email protected]', '[email protected]' => 'A name') |
|
66 | - * @return IMessage |
|
67 | - * @since 13.0.0 |
|
68 | - */ |
|
69 | - public function setTo(array $recipients): IMessage; |
|
62 | + /** |
|
63 | + * Set the to addresses of this message. |
|
64 | + * |
|
65 | + * @param array $recipients Example: array('[email protected]', '[email protected]' => 'A name') |
|
66 | + * @return IMessage |
|
67 | + * @since 13.0.0 |
|
68 | + */ |
|
69 | + public function setTo(array $recipients): IMessage; |
|
70 | 70 | |
71 | - /** |
|
72 | - * Set the CC recipients of this message. |
|
73 | - * |
|
74 | - * @param array $recipients Example: array('[email protected]', '[email protected]' => 'A name') |
|
75 | - * @return IMessage |
|
76 | - * @since 13.0.0 |
|
77 | - */ |
|
78 | - public function setCc(array $recipients): IMessage; |
|
71 | + /** |
|
72 | + * Set the CC recipients of this message. |
|
73 | + * |
|
74 | + * @param array $recipients Example: array('[email protected]', '[email protected]' => 'A name') |
|
75 | + * @return IMessage |
|
76 | + * @since 13.0.0 |
|
77 | + */ |
|
78 | + public function setCc(array $recipients): IMessage; |
|
79 | 79 | |
80 | - /** |
|
81 | - * Set the BCC recipients of this message. |
|
82 | - * |
|
83 | - * @param array $recipients Example: array('[email protected]', '[email protected]' => 'A name') |
|
84 | - * @return IMessage |
|
85 | - * @since 13.0.0 |
|
86 | - */ |
|
87 | - public function setBcc(array $recipients): IMessage; |
|
80 | + /** |
|
81 | + * Set the BCC recipients of this message. |
|
82 | + * |
|
83 | + * @param array $recipients Example: array('[email protected]', '[email protected]' => 'A name') |
|
84 | + * @return IMessage |
|
85 | + * @since 13.0.0 |
|
86 | + */ |
|
87 | + public function setBcc(array $recipients): IMessage; |
|
88 | 88 | |
89 | - /** |
|
90 | - * @param IEMailTemplate $emailTemplate |
|
91 | - * @return IMessage |
|
92 | - * @since 13.0.0 |
|
93 | - */ |
|
94 | - public function useTemplate(IEMailTemplate $emailTemplate): IMessage; |
|
89 | + /** |
|
90 | + * @param IEMailTemplate $emailTemplate |
|
91 | + * @return IMessage |
|
92 | + * @since 13.0.0 |
|
93 | + */ |
|
94 | + public function useTemplate(IEMailTemplate $emailTemplate): IMessage; |
|
95 | 95 | } |
@@ -32,23 +32,23 @@ |
||
32 | 32 | * @package OC\Security\CSRF |
33 | 33 | */ |
34 | 34 | class CsrfTokenGenerator { |
35 | - /** @var ISecureRandom */ |
|
36 | - private $random; |
|
35 | + /** @var ISecureRandom */ |
|
36 | + private $random; |
|
37 | 37 | |
38 | - /** |
|
39 | - * @param ISecureRandom $random |
|
40 | - */ |
|
41 | - public function __construct(ISecureRandom $random) { |
|
42 | - $this->random = $random; |
|
43 | - } |
|
38 | + /** |
|
39 | + * @param ISecureRandom $random |
|
40 | + */ |
|
41 | + public function __construct(ISecureRandom $random) { |
|
42 | + $this->random = $random; |
|
43 | + } |
|
44 | 44 | |
45 | - /** |
|
46 | - * Generate a new CSRF token. |
|
47 | - * |
|
48 | - * @param int $length Length of the token in characters. |
|
49 | - * @return string |
|
50 | - */ |
|
51 | - public function generateToken(int $length = 32): string { |
|
52 | - return $this->random->generate($length); |
|
53 | - } |
|
45 | + /** |
|
46 | + * Generate a new CSRF token. |
|
47 | + * |
|
48 | + * @param int $length Length of the token in characters. |
|
49 | + * @return string |
|
50 | + */ |
|
51 | + public function generateToken(int $length = 32): string { |
|
52 | + return $this->random->generate($length); |
|
53 | + } |
|
54 | 54 | } |
@@ -25,25 +25,25 @@ |
||
25 | 25 | namespace OC\Security\IdentityProof; |
26 | 26 | |
27 | 27 | class Key { |
28 | - /** @var string */ |
|
29 | - private $publicKey; |
|
30 | - /** @var string */ |
|
31 | - private $privateKey; |
|
28 | + /** @var string */ |
|
29 | + private $publicKey; |
|
30 | + /** @var string */ |
|
31 | + private $privateKey; |
|
32 | 32 | |
33 | - /** |
|
34 | - * @param string $publicKey |
|
35 | - * @param string $privateKey |
|
36 | - */ |
|
37 | - public function __construct(string $publicKey, string $privateKey) { |
|
38 | - $this->publicKey = $publicKey; |
|
39 | - $this->privateKey = $privateKey; |
|
40 | - } |
|
33 | + /** |
|
34 | + * @param string $publicKey |
|
35 | + * @param string $privateKey |
|
36 | + */ |
|
37 | + public function __construct(string $publicKey, string $privateKey) { |
|
38 | + $this->publicKey = $publicKey; |
|
39 | + $this->privateKey = $privateKey; |
|
40 | + } |
|
41 | 41 | |
42 | - public function getPrivate(): string { |
|
43 | - return $this->privateKey; |
|
44 | - } |
|
42 | + public function getPrivate(): string { |
|
43 | + return $this->privateKey; |
|
44 | + } |
|
45 | 45 | |
46 | - public function getPublic(): string { |
|
47 | - return $this->publicKey; |
|
48 | - } |
|
46 | + public function getPublic(): string { |
|
47 | + return $this->publicKey; |
|
48 | + } |
|
49 | 49 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISetPasswordBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid The username |
|
36 | - * @param string $password The new password |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function setPassword(string $uid, string $password): bool; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid The username |
|
36 | + * @param string $password The new password |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function setPassword(string $uid, string $password): bool; |
|
40 | 40 | } |
@@ -33,40 +33,40 @@ |
||
33 | 33 | */ |
34 | 34 | abstract class ABackend implements IUserBackend, UserInterface { |
35 | 35 | |
36 | - /** |
|
37 | - * @deprecated 14.0.0 |
|
38 | - * |
|
39 | - * @param int $actions The action to check for |
|
40 | - * @return bool |
|
41 | - */ |
|
42 | - public function implementsActions($actions): bool { |
|
43 | - $implements = 0; |
|
36 | + /** |
|
37 | + * @deprecated 14.0.0 |
|
38 | + * |
|
39 | + * @param int $actions The action to check for |
|
40 | + * @return bool |
|
41 | + */ |
|
42 | + public function implementsActions($actions): bool { |
|
43 | + $implements = 0; |
|
44 | 44 | |
45 | - if ($this instanceof ICreateUserBackend) { |
|
46 | - $implements |= Backend::CREATE_USER; |
|
47 | - } |
|
48 | - if ($this instanceof ISetPasswordBackend) { |
|
49 | - $implements |= Backend::SET_PASSWORD; |
|
50 | - } |
|
51 | - if ($this instanceof ICheckPasswordBackend) { |
|
52 | - $implements |= Backend::CHECK_PASSWORD; |
|
53 | - } |
|
54 | - if ($this instanceof IGetHomeBackend) { |
|
55 | - $implements |= Backend::GET_HOME; |
|
56 | - } |
|
57 | - if ($this instanceof IGetDisplayNameBackend) { |
|
58 | - $implements |= Backend::GET_DISPLAYNAME; |
|
59 | - } |
|
60 | - if ($this instanceof ISetDisplayNameBackend) { |
|
61 | - $implements |= Backend::SET_DISPLAYNAME; |
|
62 | - } |
|
63 | - if ($this instanceof IProvideAvatarBackend) { |
|
64 | - $implements |= Backend::PROVIDE_AVATAR; |
|
65 | - } |
|
66 | - if ($this instanceof ICountUsersBackend) { |
|
67 | - $implements |= Backend::COUNT_USERS; |
|
68 | - } |
|
45 | + if ($this instanceof ICreateUserBackend) { |
|
46 | + $implements |= Backend::CREATE_USER; |
|
47 | + } |
|
48 | + if ($this instanceof ISetPasswordBackend) { |
|
49 | + $implements |= Backend::SET_PASSWORD; |
|
50 | + } |
|
51 | + if ($this instanceof ICheckPasswordBackend) { |
|
52 | + $implements |= Backend::CHECK_PASSWORD; |
|
53 | + } |
|
54 | + if ($this instanceof IGetHomeBackend) { |
|
55 | + $implements |= Backend::GET_HOME; |
|
56 | + } |
|
57 | + if ($this instanceof IGetDisplayNameBackend) { |
|
58 | + $implements |= Backend::GET_DISPLAYNAME; |
|
59 | + } |
|
60 | + if ($this instanceof ISetDisplayNameBackend) { |
|
61 | + $implements |= Backend::SET_DISPLAYNAME; |
|
62 | + } |
|
63 | + if ($this instanceof IProvideAvatarBackend) { |
|
64 | + $implements |= Backend::PROVIDE_AVATAR; |
|
65 | + } |
|
66 | + if ($this instanceof ICountUsersBackend) { |
|
67 | + $implements |= Backend::COUNT_USERS; |
|
68 | + } |
|
69 | 69 | |
70 | - return (bool)($actions & $implements); |
|
71 | - } |
|
70 | + return (bool)($actions & $implements); |
|
71 | + } |
|
72 | 72 | } |
@@ -29,10 +29,10 @@ |
||
29 | 29 | */ |
30 | 30 | interface ICountUsersBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @return int|bool The number of users on success false on failure |
|
36 | - */ |
|
37 | - public function countUsers(); |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @return int|bool The number of users on success false on failure |
|
36 | + */ |
|
37 | + public function countUsers(); |
|
38 | 38 | } |
@@ -29,11 +29,11 @@ |
||
29 | 29 | */ |
30 | 30 | interface IGetHomeBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid the username |
|
36 | - * @return string|bool Datadir on success false on failure |
|
37 | - */ |
|
38 | - public function getHome(string $uid); |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid the username |
|
36 | + * @return string|bool Datadir on success false on failure |
|
37 | + */ |
|
38 | + public function getHome(string $uid); |
|
39 | 39 | } |