@@ -34,28 +34,28 @@ |
||
34 | 34 | */ |
35 | 35 | interface ISystemTagManagerFactory { |
36 | 36 | |
37 | - /** |
|
38 | - * Constructor for the system tag manager factory |
|
39 | - * |
|
40 | - * @param IServerContainer $serverContainer server container |
|
41 | - * @since 9.0.0 |
|
42 | - */ |
|
43 | - public function __construct(IServerContainer $serverContainer); |
|
37 | + /** |
|
38 | + * Constructor for the system tag manager factory |
|
39 | + * |
|
40 | + * @param IServerContainer $serverContainer server container |
|
41 | + * @since 9.0.0 |
|
42 | + */ |
|
43 | + public function __construct(IServerContainer $serverContainer); |
|
44 | 44 | |
45 | - /** |
|
46 | - * creates and returns an instance of the system tag manager |
|
47 | - * |
|
48 | - * @return ISystemTagManager |
|
49 | - * @since 9.0.0 |
|
50 | - */ |
|
51 | - public function getManager(): ISystemTagManager; |
|
45 | + /** |
|
46 | + * creates and returns an instance of the system tag manager |
|
47 | + * |
|
48 | + * @return ISystemTagManager |
|
49 | + * @since 9.0.0 |
|
50 | + */ |
|
51 | + public function getManager(): ISystemTagManager; |
|
52 | 52 | |
53 | - /** |
|
54 | - * creates and returns an instance of the system tag object |
|
55 | - * mapper |
|
56 | - * |
|
57 | - * @return ISystemTagObjectMapper |
|
58 | - * @since 9.0.0 |
|
59 | - */ |
|
60 | - public function getObjectMapper(): ISystemTagObjectMapper; |
|
53 | + /** |
|
54 | + * creates and returns an instance of the system tag object |
|
55 | + * mapper |
|
56 | + * |
|
57 | + * @return ISystemTagObjectMapper |
|
58 | + * @since 9.0.0 |
|
59 | + */ |
|
60 | + public function getObjectMapper(): ISystemTagObjectMapper; |
|
61 | 61 | } |
@@ -33,133 +33,133 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISystemTagManager { |
35 | 35 | |
36 | - /** |
|
37 | - * Returns the tag objects matching the given tag ids. |
|
38 | - * |
|
39 | - * @param array|string $tagIds id or array of unique ids of the tag to retrieve |
|
40 | - * |
|
41 | - * @return ISystemTag[] array of system tags with tag id as key |
|
42 | - * |
|
43 | - * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.) |
|
44 | - * @throws TagNotFoundException if at least one given tag ids did no exist |
|
45 | - * The message contains a json_encoded array of the ids that could not be found |
|
46 | - * |
|
47 | - * @since 9.0.0 |
|
48 | - */ |
|
49 | - public function getTagsByIds($tagIds): array; |
|
36 | + /** |
|
37 | + * Returns the tag objects matching the given tag ids. |
|
38 | + * |
|
39 | + * @param array|string $tagIds id or array of unique ids of the tag to retrieve |
|
40 | + * |
|
41 | + * @return ISystemTag[] array of system tags with tag id as key |
|
42 | + * |
|
43 | + * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.) |
|
44 | + * @throws TagNotFoundException if at least one given tag ids did no exist |
|
45 | + * The message contains a json_encoded array of the ids that could not be found |
|
46 | + * |
|
47 | + * @since 9.0.0 |
|
48 | + */ |
|
49 | + public function getTagsByIds($tagIds): array; |
|
50 | 50 | |
51 | - /** |
|
52 | - * Returns the tag object matching the given attributes. |
|
53 | - * |
|
54 | - * @param string $tagName tag name |
|
55 | - * @param bool $userVisible whether the tag is visible by users |
|
56 | - * @param bool $userAssignable whether the tag is assignable by users |
|
57 | - * |
|
58 | - * @return ISystemTag system tag |
|
59 | - * |
|
60 | - * @throws TagNotFoundException if tag does not exist |
|
61 | - * |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag; |
|
51 | + /** |
|
52 | + * Returns the tag object matching the given attributes. |
|
53 | + * |
|
54 | + * @param string $tagName tag name |
|
55 | + * @param bool $userVisible whether the tag is visible by users |
|
56 | + * @param bool $userAssignable whether the tag is assignable by users |
|
57 | + * |
|
58 | + * @return ISystemTag system tag |
|
59 | + * |
|
60 | + * @throws TagNotFoundException if tag does not exist |
|
61 | + * |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag; |
|
65 | 65 | |
66 | - /** |
|
67 | - * Creates the tag object using the given attributes. |
|
68 | - * |
|
69 | - * @param string $tagName tag name |
|
70 | - * @param bool $userVisible whether the tag is visible by users |
|
71 | - * @param bool $userAssignable whether the tag is assignable by users |
|
72 | - * |
|
73 | - * @return ISystemTag system tag |
|
74 | - * |
|
75 | - * @throws TagAlreadyExistsException if tag already exists |
|
76 | - * |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag; |
|
66 | + /** |
|
67 | + * Creates the tag object using the given attributes. |
|
68 | + * |
|
69 | + * @param string $tagName tag name |
|
70 | + * @param bool $userVisible whether the tag is visible by users |
|
71 | + * @param bool $userAssignable whether the tag is assignable by users |
|
72 | + * |
|
73 | + * @return ISystemTag system tag |
|
74 | + * |
|
75 | + * @throws TagAlreadyExistsException if tag already exists |
|
76 | + * |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag; |
|
80 | 80 | |
81 | - /** |
|
82 | - * Returns all known tags, optionally filtered by visibility. |
|
83 | - * |
|
84 | - * @param bool|null $visibilityFilter filter by visibility if non-null |
|
85 | - * @param string $nameSearchPattern optional search pattern for the tag name |
|
86 | - * |
|
87 | - * @return ISystemTag[] array of system tags or empty array if none found |
|
88 | - * |
|
89 | - * @since 9.0.0 |
|
90 | - */ |
|
91 | - public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array; |
|
81 | + /** |
|
82 | + * Returns all known tags, optionally filtered by visibility. |
|
83 | + * |
|
84 | + * @param bool|null $visibilityFilter filter by visibility if non-null |
|
85 | + * @param string $nameSearchPattern optional search pattern for the tag name |
|
86 | + * |
|
87 | + * @return ISystemTag[] array of system tags or empty array if none found |
|
88 | + * |
|
89 | + * @since 9.0.0 |
|
90 | + */ |
|
91 | + public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array; |
|
92 | 92 | |
93 | - /** |
|
94 | - * Updates the given tag |
|
95 | - * |
|
96 | - * @param string $tagId tag id |
|
97 | - * @param string $newName the new tag name |
|
98 | - * @param bool $userVisible whether the tag is visible by users |
|
99 | - * @param bool $userAssignable whether the tag is assignable by users |
|
100 | - * |
|
101 | - * @throws TagNotFoundException if tag with the given id does not exist |
|
102 | - * @throws TagAlreadyExistsException if there is already another tag |
|
103 | - * with the same attributes |
|
104 | - * |
|
105 | - * @since 9.0.0 |
|
106 | - */ |
|
107 | - public function updateTag(string $tagId, string $newName, bool $userVisible, bool $userAssignable); |
|
93 | + /** |
|
94 | + * Updates the given tag |
|
95 | + * |
|
96 | + * @param string $tagId tag id |
|
97 | + * @param string $newName the new tag name |
|
98 | + * @param bool $userVisible whether the tag is visible by users |
|
99 | + * @param bool $userAssignable whether the tag is assignable by users |
|
100 | + * |
|
101 | + * @throws TagNotFoundException if tag with the given id does not exist |
|
102 | + * @throws TagAlreadyExistsException if there is already another tag |
|
103 | + * with the same attributes |
|
104 | + * |
|
105 | + * @since 9.0.0 |
|
106 | + */ |
|
107 | + public function updateTag(string $tagId, string $newName, bool $userVisible, bool $userAssignable); |
|
108 | 108 | |
109 | - /** |
|
110 | - * Delete the given tags from the database and all their relationships. |
|
111 | - * |
|
112 | - * @param string|array $tagIds array of tag ids |
|
113 | - * |
|
114 | - * @throws TagNotFoundException if at least one tag did not exist |
|
115 | - * |
|
116 | - * @since 9.0.0 |
|
117 | - */ |
|
118 | - public function deleteTags($tagIds); |
|
109 | + /** |
|
110 | + * Delete the given tags from the database and all their relationships. |
|
111 | + * |
|
112 | + * @param string|array $tagIds array of tag ids |
|
113 | + * |
|
114 | + * @throws TagNotFoundException if at least one tag did not exist |
|
115 | + * |
|
116 | + * @since 9.0.0 |
|
117 | + */ |
|
118 | + public function deleteTags($tagIds); |
|
119 | 119 | |
120 | - /** |
|
121 | - * Checks whether the given user is allowed to assign/unassign the tag with the |
|
122 | - * given id. |
|
123 | - * |
|
124 | - * @param ISystemTag $tag tag to check permission for |
|
125 | - * @param IUser $user user to check permission for |
|
126 | - * |
|
127 | - * @return true if the user is allowed to assign/unassign the tag, false otherwise |
|
128 | - * |
|
129 | - * @since 9.1.0 |
|
130 | - */ |
|
131 | - public function canUserAssignTag(ISystemTag $tag, IUser $user): bool; |
|
120 | + /** |
|
121 | + * Checks whether the given user is allowed to assign/unassign the tag with the |
|
122 | + * given id. |
|
123 | + * |
|
124 | + * @param ISystemTag $tag tag to check permission for |
|
125 | + * @param IUser $user user to check permission for |
|
126 | + * |
|
127 | + * @return true if the user is allowed to assign/unassign the tag, false otherwise |
|
128 | + * |
|
129 | + * @since 9.1.0 |
|
130 | + */ |
|
131 | + public function canUserAssignTag(ISystemTag $tag, IUser $user): bool; |
|
132 | 132 | |
133 | - /** |
|
134 | - * Checks whether the given user is allowed to see the tag with the given id. |
|
135 | - * |
|
136 | - * @param ISystemTag $tag tag to check permission for |
|
137 | - * @param IUser $user user to check permission for |
|
138 | - * |
|
139 | - * @return true if the user can see the tag, false otherwise |
|
140 | - * |
|
141 | - * @since 9.1.0 |
|
142 | - */ |
|
143 | - public function canUserSeeTag(ISystemTag $tag, IUser $user): bool; |
|
133 | + /** |
|
134 | + * Checks whether the given user is allowed to see the tag with the given id. |
|
135 | + * |
|
136 | + * @param ISystemTag $tag tag to check permission for |
|
137 | + * @param IUser $user user to check permission for |
|
138 | + * |
|
139 | + * @return true if the user can see the tag, false otherwise |
|
140 | + * |
|
141 | + * @since 9.1.0 |
|
142 | + */ |
|
143 | + public function canUserSeeTag(ISystemTag $tag, IUser $user): bool; |
|
144 | 144 | |
145 | - /** |
|
146 | - * Set groups that can assign a given tag. |
|
147 | - * |
|
148 | - * @param ISystemTag $tag tag for group assignment |
|
149 | - * @param string[] $groupIds group ids of groups that can assign/unassign the tag |
|
150 | - * |
|
151 | - * @since 9.1.0 |
|
152 | - */ |
|
153 | - public function setTagGroups(ISystemTag $tag, array $groupIds); |
|
145 | + /** |
|
146 | + * Set groups that can assign a given tag. |
|
147 | + * |
|
148 | + * @param ISystemTag $tag tag for group assignment |
|
149 | + * @param string[] $groupIds group ids of groups that can assign/unassign the tag |
|
150 | + * |
|
151 | + * @since 9.1.0 |
|
152 | + */ |
|
153 | + public function setTagGroups(ISystemTag $tag, array $groupIds); |
|
154 | 154 | |
155 | - /** |
|
156 | - * Get groups that can assign a given tag. |
|
157 | - * |
|
158 | - * @param ISystemTag $tag tag for group assignment |
|
159 | - * |
|
160 | - * @return string[] group ids of groups that can assign/unassign the tag |
|
161 | - * |
|
162 | - * @since 9.1.0 |
|
163 | - */ |
|
164 | - public function getTagGroups(ISystemTag $tag): array; |
|
155 | + /** |
|
156 | + * Get groups that can assign a given tag. |
|
157 | + * |
|
158 | + * @param ISystemTag $tag tag for group assignment |
|
159 | + * |
|
160 | + * @return string[] group ids of groups that can assign/unassign the tag |
|
161 | + * |
|
162 | + * @since 9.1.0 |
|
163 | + */ |
|
164 | + public function getTagGroups(ISystemTag $tag): array; |
|
165 | 165 | } |
@@ -32,28 +32,28 @@ |
||
32 | 32 | */ |
33 | 33 | class TagNotFoundException extends \RuntimeException { |
34 | 34 | |
35 | - /** @var string[] */ |
|
36 | - protected $tags; |
|
35 | + /** @var string[] */ |
|
36 | + protected $tags; |
|
37 | 37 | |
38 | - /** |
|
39 | - * TagNotFoundException constructor. |
|
40 | - * |
|
41 | - * @param string $message |
|
42 | - * @param int $code |
|
43 | - * @param \Exception|null $previous |
|
44 | - * @param string[] $tags |
|
45 | - * @since 9.0.0 |
|
46 | - */ |
|
47 | - public function __construct(string $message = '', int $code = 0, \Exception $previous = null, array $tags = []) { |
|
48 | - parent::__construct($message, $code, $previous); |
|
49 | - $this->tags = $tags; |
|
50 | - } |
|
38 | + /** |
|
39 | + * TagNotFoundException constructor. |
|
40 | + * |
|
41 | + * @param string $message |
|
42 | + * @param int $code |
|
43 | + * @param \Exception|null $previous |
|
44 | + * @param string[] $tags |
|
45 | + * @since 9.0.0 |
|
46 | + */ |
|
47 | + public function __construct(string $message = '', int $code = 0, \Exception $previous = null, array $tags = []) { |
|
48 | + parent::__construct($message, $code, $previous); |
|
49 | + $this->tags = $tags; |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return string[] |
|
54 | - * @since 9.0.0 |
|
55 | - */ |
|
56 | - public function getMissingTags(): array { |
|
57 | - return $this->tags; |
|
58 | - } |
|
52 | + /** |
|
53 | + * @return string[] |
|
54 | + * @since 9.0.0 |
|
55 | + */ |
|
56 | + public function getMissingTags(): array { |
|
57 | + return $this->tags; |
|
58 | + } |
|
59 | 59 | } |
@@ -36,48 +36,48 @@ |
||
36 | 36 | */ |
37 | 37 | class ManagerFactory implements ISystemTagManagerFactory { |
38 | 38 | |
39 | - /** |
|
40 | - * Server container |
|
41 | - * |
|
42 | - * @var IServerContainer |
|
43 | - */ |
|
44 | - private $serverContainer; |
|
39 | + /** |
|
40 | + * Server container |
|
41 | + * |
|
42 | + * @var IServerContainer |
|
43 | + */ |
|
44 | + private $serverContainer; |
|
45 | 45 | |
46 | - /** |
|
47 | - * Constructor for the system tag manager factory |
|
48 | - * |
|
49 | - * @param IServerContainer $serverContainer server container |
|
50 | - */ |
|
51 | - public function __construct(IServerContainer $serverContainer) { |
|
52 | - $this->serverContainer = $serverContainer; |
|
53 | - } |
|
46 | + /** |
|
47 | + * Constructor for the system tag manager factory |
|
48 | + * |
|
49 | + * @param IServerContainer $serverContainer server container |
|
50 | + */ |
|
51 | + public function __construct(IServerContainer $serverContainer) { |
|
52 | + $this->serverContainer = $serverContainer; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * Creates and returns an instance of the system tag manager |
|
57 | - * |
|
58 | - * @return ISystemTagManager |
|
59 | - * @since 9.0.0 |
|
60 | - */ |
|
61 | - public function getManager(): ISystemTagManager { |
|
62 | - return new SystemTagManager( |
|
63 | - $this->serverContainer->getDatabaseConnection(), |
|
64 | - $this->serverContainer->getGroupManager(), |
|
65 | - $this->serverContainer->getEventDispatcher() |
|
66 | - ); |
|
67 | - } |
|
55 | + /** |
|
56 | + * Creates and returns an instance of the system tag manager |
|
57 | + * |
|
58 | + * @return ISystemTagManager |
|
59 | + * @since 9.0.0 |
|
60 | + */ |
|
61 | + public function getManager(): ISystemTagManager { |
|
62 | + return new SystemTagManager( |
|
63 | + $this->serverContainer->getDatabaseConnection(), |
|
64 | + $this->serverContainer->getGroupManager(), |
|
65 | + $this->serverContainer->getEventDispatcher() |
|
66 | + ); |
|
67 | + } |
|
68 | 68 | |
69 | - /** |
|
70 | - * Creates and returns an instance of the system tag object |
|
71 | - * mapper |
|
72 | - * |
|
73 | - * @return ISystemTagObjectMapper |
|
74 | - * @since 9.0.0 |
|
75 | - */ |
|
76 | - public function getObjectMapper(): ISystemTagObjectMapper { |
|
77 | - return new SystemTagObjectMapper( |
|
78 | - $this->serverContainer->getDatabaseConnection(), |
|
79 | - $this->getManager(), |
|
80 | - $this->serverContainer->getEventDispatcher() |
|
81 | - ); |
|
82 | - } |
|
69 | + /** |
|
70 | + * Creates and returns an instance of the system tag object |
|
71 | + * mapper |
|
72 | + * |
|
73 | + * @return ISystemTagObjectMapper |
|
74 | + * @since 9.0.0 |
|
75 | + */ |
|
76 | + public function getObjectMapper(): ISystemTagObjectMapper { |
|
77 | + return new SystemTagObjectMapper( |
|
78 | + $this->serverContainer->getDatabaseConnection(), |
|
79 | + $this->getManager(), |
|
80 | + $this->serverContainer->getEventDispatcher() |
|
81 | + ); |
|
82 | + } |
|
83 | 83 | } |
@@ -36,7 +36,7 @@ |
||
36 | 36 | * @package OC\AppFramework\Middleware\Security\Exceptions |
37 | 37 | */ |
38 | 38 | class NotAdminException extends SecurityException { |
39 | - public function __construct(string $message) { |
|
40 | - parent::__construct($message, Http::STATUS_FORBIDDEN); |
|
41 | - } |
|
39 | + public function __construct(string $message) { |
|
40 | + parent::__construct($message, Http::STATUS_FORBIDDEN); |
|
41 | + } |
|
42 | 42 | } |
@@ -34,48 +34,48 @@ |
||
34 | 34 | */ |
35 | 35 | class Attachment implements IAttachment { |
36 | 36 | |
37 | - /** @var \Swift_Mime_Attachment */ |
|
38 | - protected $swiftAttachment; |
|
37 | + /** @var \Swift_Mime_Attachment */ |
|
38 | + protected $swiftAttachment; |
|
39 | 39 | |
40 | - public function __construct(\Swift_Mime_Attachment $attachment) { |
|
41 | - $this->swiftAttachment = $attachment; |
|
42 | - } |
|
40 | + public function __construct(\Swift_Mime_Attachment $attachment) { |
|
41 | + $this->swiftAttachment = $attachment; |
|
42 | + } |
|
43 | 43 | |
44 | - /** |
|
45 | - * @param string $filename |
|
46 | - * @return $this |
|
47 | - * @since 13.0.0 |
|
48 | - */ |
|
49 | - public function setFilename(string $filename): IAttachment { |
|
50 | - $this->swiftAttachment->setFilename($filename); |
|
51 | - return $this; |
|
52 | - } |
|
44 | + /** |
|
45 | + * @param string $filename |
|
46 | + * @return $this |
|
47 | + * @since 13.0.0 |
|
48 | + */ |
|
49 | + public function setFilename(string $filename): IAttachment { |
|
50 | + $this->swiftAttachment->setFilename($filename); |
|
51 | + return $this; |
|
52 | + } |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param string $contentType |
|
56 | - * @return $this |
|
57 | - * @since 13.0.0 |
|
58 | - */ |
|
59 | - public function setContentType(string $contentType): IAttachment { |
|
60 | - $this->swiftAttachment->setContentType($contentType); |
|
61 | - return $this; |
|
62 | - } |
|
54 | + /** |
|
55 | + * @param string $contentType |
|
56 | + * @return $this |
|
57 | + * @since 13.0.0 |
|
58 | + */ |
|
59 | + public function setContentType(string $contentType): IAttachment { |
|
60 | + $this->swiftAttachment->setContentType($contentType); |
|
61 | + return $this; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * @param string $body |
|
66 | - * @return $this |
|
67 | - * @since 13.0.0 |
|
68 | - */ |
|
69 | - public function setBody(string $body): IAttachment { |
|
70 | - $this->swiftAttachment->setBody($body); |
|
71 | - return $this; |
|
72 | - } |
|
64 | + /** |
|
65 | + * @param string $body |
|
66 | + * @return $this |
|
67 | + * @since 13.0.0 |
|
68 | + */ |
|
69 | + public function setBody(string $body): IAttachment { |
|
70 | + $this->swiftAttachment->setBody($body); |
|
71 | + return $this; |
|
72 | + } |
|
73 | 73 | |
74 | - /** |
|
75 | - * @return \Swift_Mime_Attachment |
|
76 | - */ |
|
77 | - public function getSwiftAttachment(): \Swift_Mime_Attachment { |
|
78 | - return $this->swiftAttachment; |
|
79 | - } |
|
74 | + /** |
|
75 | + * @return \Swift_Mime_Attachment |
|
76 | + */ |
|
77 | + public function getSwiftAttachment(): \Swift_Mime_Attachment { |
|
78 | + return $this->swiftAttachment; |
|
79 | + } |
|
80 | 80 | |
81 | 81 | } |
@@ -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 | } |