@@ -29,29 +29,29 @@ |
||
29 | 29 | |
30 | 30 | class Admin implements ISettings { |
31 | 31 | |
32 | - /** |
|
33 | - * @return TemplateResponse |
|
34 | - */ |
|
35 | - public function getForm() { |
|
36 | - return new TemplateResponse('systemtags', 'admin', [], ''); |
|
37 | - } |
|
32 | + /** |
|
33 | + * @return TemplateResponse |
|
34 | + */ |
|
35 | + public function getForm() { |
|
36 | + return new TemplateResponse('systemtags', 'admin', [], ''); |
|
37 | + } |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string the section ID, e.g. 'sharing' |
|
41 | - */ |
|
42 | - public function getSection() { |
|
43 | - return 'server'; |
|
44 | - } |
|
39 | + /** |
|
40 | + * @return string the section ID, e.g. 'sharing' |
|
41 | + */ |
|
42 | + public function getSection() { |
|
43 | + return 'server'; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return int whether the form should be rather on the top or bottom of |
|
48 | - * the admin section. The forms are arranged in ascending order of the |
|
49 | - * priority values. It is required to return a value between 0 and 100. |
|
50 | - * |
|
51 | - * E.g.: 70 |
|
52 | - */ |
|
53 | - public function getPriority() { |
|
54 | - return 70; |
|
55 | - } |
|
46 | + /** |
|
47 | + * @return int whether the form should be rather on the top or bottom of |
|
48 | + * the admin section. The forms are arranged in ascending order of the |
|
49 | + * priority values. It is required to return a value between 0 and 100. |
|
50 | + * |
|
51 | + * E.g.: 70 |
|
52 | + */ |
|
53 | + public function getPriority() { |
|
54 | + return 70; |
|
55 | + } |
|
56 | 56 | |
57 | 57 | } |
@@ -29,45 +29,45 @@ |
||
29 | 29 | use OCP\Settings\IIconSection; |
30 | 30 | |
31 | 31 | class Section implements IIconSection { |
32 | - /** @var IL10N */ |
|
33 | - private $l; |
|
34 | - /** @var IURLGenerator */ |
|
35 | - private $url; |
|
32 | + /** @var IL10N */ |
|
33 | + private $l; |
|
34 | + /** @var IURLGenerator */ |
|
35 | + private $url; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @param IURLGenerator $url |
|
39 | - * @param IL10N $l |
|
40 | - */ |
|
41 | - public function __construct(IURLGenerator $url, IL10N $l) { |
|
42 | - $this->url = $url; |
|
43 | - $this->l = $l; |
|
44 | - } |
|
37 | + /** |
|
38 | + * @param IURLGenerator $url |
|
39 | + * @param IL10N $l |
|
40 | + */ |
|
41 | + public function __construct(IURLGenerator $url, IL10N $l) { |
|
42 | + $this->url = $url; |
|
43 | + $this->l = $l; |
|
44 | + } |
|
45 | 45 | |
46 | - /** |
|
47 | - * {@inheritdoc} |
|
48 | - */ |
|
49 | - public function getID() { |
|
50 | - return 'workflow'; |
|
51 | - } |
|
46 | + /** |
|
47 | + * {@inheritdoc} |
|
48 | + */ |
|
49 | + public function getID() { |
|
50 | + return 'workflow'; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * {@inheritdoc} |
|
55 | - */ |
|
56 | - public function getName() { |
|
57 | - return $this->l->t('Flow'); |
|
58 | - } |
|
53 | + /** |
|
54 | + * {@inheritdoc} |
|
55 | + */ |
|
56 | + public function getName() { |
|
57 | + return $this->l->t('Flow'); |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * {@inheritdoc} |
|
62 | - */ |
|
63 | - public function getPriority() { |
|
64 | - return 55; |
|
65 | - } |
|
60 | + /** |
|
61 | + * {@inheritdoc} |
|
62 | + */ |
|
63 | + public function getPriority() { |
|
64 | + return 55; |
|
65 | + } |
|
66 | 66 | |
67 | - /** |
|
68 | - * {@inheritdoc} |
|
69 | - */ |
|
70 | - public function getIcon() { |
|
71 | - return $this->url->imagePath(Application::APP_ID, 'app-dark.svg'); |
|
72 | - } |
|
67 | + /** |
|
68 | + * {@inheritdoc} |
|
69 | + */ |
|
70 | + public function getIcon() { |
|
71 | + return $this->url->imagePath(Application::APP_ID, 'app-dark.svg'); |
|
72 | + } |
|
73 | 73 | } |
@@ -32,68 +32,68 @@ |
||
32 | 32 | */ |
33 | 33 | interface IEditor { |
34 | 34 | |
35 | - /** |
|
36 | - * Return a unique identifier for the editor |
|
37 | - * |
|
38 | - * e.g. richdocuments |
|
39 | - * |
|
40 | - * @since 18.0.0 |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function getId(): string; |
|
35 | + /** |
|
36 | + * Return a unique identifier for the editor |
|
37 | + * |
|
38 | + * e.g. richdocuments |
|
39 | + * |
|
40 | + * @since 18.0.0 |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function getId(): string; |
|
44 | 44 | |
45 | - /** |
|
46 | - * Return a readable name for the editor |
|
47 | - * |
|
48 | - * e.g. Collabora Online |
|
49 | - * |
|
50 | - * @since 18.0.0 |
|
51 | - * @return string |
|
52 | - */ |
|
53 | - public function getName(): string; |
|
45 | + /** |
|
46 | + * Return a readable name for the editor |
|
47 | + * |
|
48 | + * e.g. Collabora Online |
|
49 | + * |
|
50 | + * @since 18.0.0 |
|
51 | + * @return string |
|
52 | + */ |
|
53 | + public function getName(): string; |
|
54 | 54 | |
55 | - /** |
|
56 | - * A list of mimetypes that should open the editor by default |
|
57 | - * |
|
58 | - * @since 18.0.0 |
|
59 | - * @return string[] |
|
60 | - */ |
|
61 | - public function getMimetypes(): array; |
|
55 | + /** |
|
56 | + * A list of mimetypes that should open the editor by default |
|
57 | + * |
|
58 | + * @since 18.0.0 |
|
59 | + * @return string[] |
|
60 | + */ |
|
61 | + public function getMimetypes(): array; |
|
62 | 62 | |
63 | - /** |
|
64 | - * A list of mimetypes that can be opened in the editor optionally |
|
65 | - * |
|
66 | - * @since 18.0.0 |
|
67 | - * @return string[] |
|
68 | - */ |
|
69 | - public function getMimetypesOptional(): array; |
|
63 | + /** |
|
64 | + * A list of mimetypes that can be opened in the editor optionally |
|
65 | + * |
|
66 | + * @since 18.0.0 |
|
67 | + * @return string[] |
|
68 | + */ |
|
69 | + public function getMimetypesOptional(): array; |
|
70 | 70 | |
71 | - /** |
|
72 | - * Return a list of file creation options to be presented to the user |
|
73 | - * |
|
74 | - * @since 18.0.0 |
|
75 | - * @return ACreateFromTemplate[]|ACreateEmpty[] |
|
76 | - */ |
|
77 | - public function getCreators(): array; |
|
71 | + /** |
|
72 | + * Return a list of file creation options to be presented to the user |
|
73 | + * |
|
74 | + * @since 18.0.0 |
|
75 | + * @return ACreateFromTemplate[]|ACreateEmpty[] |
|
76 | + */ |
|
77 | + public function getCreators(): array; |
|
78 | 78 | |
79 | - /** |
|
80 | - * Return if the view is able to securely view a file without downloading it to the browser |
|
81 | - * |
|
82 | - * @since 18.0.0 |
|
83 | - * @return bool |
|
84 | - */ |
|
85 | - public function isSecure(): bool; |
|
79 | + /** |
|
80 | + * Return if the view is able to securely view a file without downloading it to the browser |
|
81 | + * |
|
82 | + * @since 18.0.0 |
|
83 | + * @return bool |
|
84 | + */ |
|
85 | + public function isSecure(): bool; |
|
86 | 86 | |
87 | - /** |
|
88 | - * Return a template response for displaying the editor |
|
89 | - * |
|
90 | - * open can only be called once when the client requests the editor with a one-time-use token |
|
91 | - * For handling editing and later requests, editors need to impelement their own token handling and take care of invalidation |
|
92 | - * |
|
93 | - * This behavior is similar to the current direct editing implementation in collabora where we generate a one-time token and switch over to the regular wopi token for the actual editing/saving process |
|
94 | - * |
|
95 | - * @since 18.0.0 |
|
96 | - * @return Response |
|
97 | - */ |
|
98 | - public function open(IToken $token): Response; |
|
87 | + /** |
|
88 | + * Return a template response for displaying the editor |
|
89 | + * |
|
90 | + * open can only be called once when the client requests the editor with a one-time-use token |
|
91 | + * For handling editing and later requests, editors need to impelement their own token handling and take care of invalidation |
|
92 | + * |
|
93 | + * This behavior is similar to the current direct editing implementation in collabora where we generate a one-time token and switch over to the regular wopi token for the actual editing/saving process |
|
94 | + * |
|
95 | + * @since 18.0.0 |
|
96 | + * @return Response |
|
97 | + */ |
|
98 | + public function open(IToken $token): Response; |
|
99 | 99 | } |
@@ -28,12 +28,12 @@ |
||
28 | 28 | */ |
29 | 29 | abstract class ACreateFromTemplate extends ACreateEmpty { |
30 | 30 | |
31 | - /** |
|
32 | - * List of available templates for the create from template action |
|
33 | - * |
|
34 | - * @since 18.0.0 |
|
35 | - * @return ATemplate[] |
|
36 | - */ |
|
37 | - abstract public function getTemplates(): array; |
|
31 | + /** |
|
32 | + * List of available templates for the create from template action |
|
33 | + * |
|
34 | + * @since 18.0.0 |
|
35 | + * @return ATemplate[] |
|
36 | + */ |
|
37 | + abstract public function getTemplates(): array; |
|
38 | 38 | |
39 | 39 | } |
@@ -30,28 +30,28 @@ |
||
30 | 30 | */ |
31 | 31 | class RegisterDirectEditorEvent extends Event { |
32 | 32 | |
33 | - /** |
|
34 | - * @var IManager |
|
35 | - */ |
|
36 | - private $manager; |
|
33 | + /** |
|
34 | + * @var IManager |
|
35 | + */ |
|
36 | + private $manager; |
|
37 | 37 | |
38 | - /** |
|
39 | - * RegisterDirectEditorEvent constructor. |
|
40 | - * |
|
41 | - * @param IManager $manager |
|
42 | - * @since 18.0.0 |
|
43 | - */ |
|
44 | - public function __construct(IManager $manager) { |
|
45 | - parent::__construct(); |
|
46 | - $this->manager = $manager; |
|
47 | - } |
|
38 | + /** |
|
39 | + * RegisterDirectEditorEvent constructor. |
|
40 | + * |
|
41 | + * @param IManager $manager |
|
42 | + * @since 18.0.0 |
|
43 | + */ |
|
44 | + public function __construct(IManager $manager) { |
|
45 | + parent::__construct(); |
|
46 | + $this->manager = $manager; |
|
47 | + } |
|
48 | 48 | |
49 | - /** |
|
50 | - * @since 18.0.0 |
|
51 | - * @param IEditor $editor |
|
52 | - */ |
|
53 | - public function register(IEditor $editor): void { |
|
54 | - $this->manager->registerDirectEditor($editor); |
|
55 | - } |
|
49 | + /** |
|
50 | + * @since 18.0.0 |
|
51 | + * @param IEditor $editor |
|
52 | + */ |
|
53 | + public function register(IEditor $editor): void { |
|
54 | + $this->manager->registerDirectEditor($editor); |
|
55 | + } |
|
56 | 56 | |
57 | 57 | } |
@@ -36,37 +36,37 @@ |
||
36 | 36 | |
37 | 37 | class DirectEditingViewController extends Controller { |
38 | 38 | |
39 | - /** @var IEventDispatcher */ |
|
40 | - private $eventDispatcher; |
|
39 | + /** @var IEventDispatcher */ |
|
40 | + private $eventDispatcher; |
|
41 | 41 | |
42 | - /** @var IManager */ |
|
43 | - private $directEditingManager; |
|
42 | + /** @var IManager */ |
|
43 | + private $directEditingManager; |
|
44 | 44 | |
45 | - /** @var ILogger */ |
|
46 | - private $logger; |
|
45 | + /** @var ILogger */ |
|
46 | + private $logger; |
|
47 | 47 | |
48 | - public function __construct($appName, IRequest $request, IEventDispatcher $eventDispatcher, IManager $manager, ILogger $logger) { |
|
49 | - parent::__construct($appName, $request); |
|
48 | + public function __construct($appName, IRequest $request, IEventDispatcher $eventDispatcher, IManager $manager, ILogger $logger) { |
|
49 | + parent::__construct($appName, $request); |
|
50 | 50 | |
51 | - $this->eventDispatcher = $eventDispatcher; |
|
52 | - $this->directEditingManager = $manager; |
|
53 | - $this->logger = $logger; |
|
54 | - } |
|
51 | + $this->eventDispatcher = $eventDispatcher; |
|
52 | + $this->directEditingManager = $manager; |
|
53 | + $this->logger = $logger; |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * @PublicPage |
|
58 | - * @NoCSRFRequired |
|
59 | - * |
|
60 | - * @param string $token |
|
61 | - * @return Response |
|
62 | - */ |
|
63 | - public function edit(string $token): Response { |
|
64 | - $this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager)); |
|
65 | - try { |
|
66 | - return $this->directEditingManager->edit($token); |
|
67 | - } catch (Exception $e) { |
|
68 | - $this->logger->logException($e); |
|
69 | - return new NotFoundResponse(); |
|
70 | - } |
|
71 | - } |
|
56 | + /** |
|
57 | + * @PublicPage |
|
58 | + * @NoCSRFRequired |
|
59 | + * |
|
60 | + * @param string $token |
|
61 | + * @return Response |
|
62 | + */ |
|
63 | + public function edit(string $token): Response { |
|
64 | + $this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager)); |
|
65 | + try { |
|
66 | + return $this->directEditingManager->edit($token); |
|
67 | + } catch (Exception $e) { |
|
68 | + $this->logger->logException($e); |
|
69 | + return new NotFoundResponse(); |
|
70 | + } |
|
71 | + } |
|
72 | 72 | } |
@@ -42,72 +42,72 @@ |
||
42 | 42 | * @since 6.0.0 |
43 | 43 | */ |
44 | 44 | interface File extends Node { |
45 | - /** |
|
46 | - * Get the content of the file as string |
|
47 | - * |
|
48 | - * @return string |
|
49 | - * @throws NotPermittedException |
|
50 | - * @throws LockedException |
|
51 | - * @since 6.0.0 |
|
52 | - */ |
|
53 | - public function getContent(); |
|
45 | + /** |
|
46 | + * Get the content of the file as string |
|
47 | + * |
|
48 | + * @return string |
|
49 | + * @throws NotPermittedException |
|
50 | + * @throws LockedException |
|
51 | + * @since 6.0.0 |
|
52 | + */ |
|
53 | + public function getContent(); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Write to the file from string data |
|
57 | - * |
|
58 | - * @param string|resource $data |
|
59 | - * @throws NotPermittedException |
|
60 | - * @throws GenericFileException |
|
61 | - * @throws LockedException |
|
62 | - * @since 6.0.0 |
|
63 | - */ |
|
64 | - public function putContent($data); |
|
55 | + /** |
|
56 | + * Write to the file from string data |
|
57 | + * |
|
58 | + * @param string|resource $data |
|
59 | + * @throws NotPermittedException |
|
60 | + * @throws GenericFileException |
|
61 | + * @throws LockedException |
|
62 | + * @since 6.0.0 |
|
63 | + */ |
|
64 | + public function putContent($data); |
|
65 | 65 | |
66 | - /** |
|
67 | - * Get the mimetype of the file |
|
68 | - * |
|
69 | - * @return string |
|
70 | - * @since 6.0.0 |
|
71 | - */ |
|
72 | - public function getMimeType(); |
|
66 | + /** |
|
67 | + * Get the mimetype of the file |
|
68 | + * |
|
69 | + * @return string |
|
70 | + * @since 6.0.0 |
|
71 | + */ |
|
72 | + public function getMimeType(); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Open the file as stream, resulting resource can be operated as stream like the result from php's own fopen |
|
76 | - * |
|
77 | - * @param string $mode |
|
78 | - * @return resource |
|
79 | - * @throws NotPermittedException |
|
80 | - * @throws LockedException |
|
81 | - * @since 6.0.0 |
|
82 | - */ |
|
83 | - public function fopen($mode); |
|
74 | + /** |
|
75 | + * Open the file as stream, resulting resource can be operated as stream like the result from php's own fopen |
|
76 | + * |
|
77 | + * @param string $mode |
|
78 | + * @return resource |
|
79 | + * @throws NotPermittedException |
|
80 | + * @throws LockedException |
|
81 | + * @since 6.0.0 |
|
82 | + */ |
|
83 | + public function fopen($mode); |
|
84 | 84 | |
85 | - /** |
|
86 | - * Compute the hash of the file |
|
87 | - * Type of hash is set with $type and can be anything supported by php's hash_file |
|
88 | - * |
|
89 | - * @param string $type |
|
90 | - * @param bool $raw |
|
91 | - * @return string |
|
92 | - * @since 6.0.0 |
|
93 | - */ |
|
94 | - public function hash($type, $raw = false); |
|
85 | + /** |
|
86 | + * Compute the hash of the file |
|
87 | + * Type of hash is set with $type and can be anything supported by php's hash_file |
|
88 | + * |
|
89 | + * @param string $type |
|
90 | + * @param bool $raw |
|
91 | + * @return string |
|
92 | + * @since 6.0.0 |
|
93 | + */ |
|
94 | + public function hash($type, $raw = false); |
|
95 | 95 | |
96 | - /** |
|
97 | - * Get the stored checksum for this file |
|
98 | - * |
|
99 | - * @return string |
|
100 | - * @since 9.0.0 |
|
101 | - * @throws InvalidPathException |
|
102 | - * @throws NotFoundException |
|
103 | - */ |
|
104 | - public function getChecksum(); |
|
96 | + /** |
|
97 | + * Get the stored checksum for this file |
|
98 | + * |
|
99 | + * @return string |
|
100 | + * @since 9.0.0 |
|
101 | + * @throws InvalidPathException |
|
102 | + * @throws NotFoundException |
|
103 | + */ |
|
104 | + public function getChecksum(); |
|
105 | 105 | |
106 | - /** |
|
107 | - * Get the extension of this file |
|
108 | - * |
|
109 | - * @return string |
|
110 | - * @since 15.0.0 |
|
111 | - */ |
|
112 | - public function getExtension(): string; |
|
106 | + /** |
|
107 | + * Get the extension of this file |
|
108 | + * |
|
109 | + * @return string |
|
110 | + * @since 15.0.0 |
|
111 | + */ |
|
112 | + public function getExtension(): string; |
|
113 | 113 | } |
@@ -40,46 +40,46 @@ |
||
40 | 40 | */ |
41 | 41 | interface IEntity { |
42 | 42 | |
43 | - /** |
|
44 | - * returns a translated name to be presented in the web interface. |
|
45 | - * |
|
46 | - * Example: "File" (en), "Dosiero" (eo) |
|
47 | - * |
|
48 | - * @since 18.0.0 |
|
49 | - */ |
|
50 | - public function getName(): string; |
|
43 | + /** |
|
44 | + * returns a translated name to be presented in the web interface. |
|
45 | + * |
|
46 | + * Example: "File" (en), "Dosiero" (eo) |
|
47 | + * |
|
48 | + * @since 18.0.0 |
|
49 | + */ |
|
50 | + public function getName(): string; |
|
51 | 51 | |
52 | - /** |
|
53 | - * returns the URL to the icon of the entity for display in the web interface. |
|
54 | - * |
|
55 | - * Usually, the implementation would utilize the `imagePath()` method of the |
|
56 | - * `\OCP\IURLGenerator` instance and simply return its result. |
|
57 | - * |
|
58 | - * Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg'); |
|
59 | - * |
|
60 | - * @since 18.0.0 |
|
61 | - */ |
|
62 | - public function getIcon(): string; |
|
52 | + /** |
|
53 | + * returns the URL to the icon of the entity for display in the web interface. |
|
54 | + * |
|
55 | + * Usually, the implementation would utilize the `imagePath()` method of the |
|
56 | + * `\OCP\IURLGenerator` instance and simply return its result. |
|
57 | + * |
|
58 | + * Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg'); |
|
59 | + * |
|
60 | + * @since 18.0.0 |
|
61 | + */ |
|
62 | + public function getIcon(): string; |
|
63 | 63 | |
64 | - /** |
|
65 | - * returns a list of supported events |
|
66 | - * |
|
67 | - * @return IEntityEvent[] |
|
68 | - * @since 18.0.0 |
|
69 | - */ |
|
70 | - public function getEvents(): array; |
|
64 | + /** |
|
65 | + * returns a list of supported events |
|
66 | + * |
|
67 | + * @return IEntityEvent[] |
|
68 | + * @since 18.0.0 |
|
69 | + */ |
|
70 | + public function getEvents(): array; |
|
71 | 71 | |
72 | - /** |
|
73 | - * @since 18.0.0 |
|
74 | - */ |
|
75 | - public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void; |
|
72 | + /** |
|
73 | + * @since 18.0.0 |
|
74 | + */ |
|
75 | + public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void; |
|
76 | 76 | |
77 | - /** |
|
78 | - * returns whether the provided user id is allowed to run a flow against |
|
79 | - * the known context |
|
80 | - * |
|
81 | - * @since 18.0.0 |
|
82 | - */ |
|
83 | - public function isLegitimatedForUserId(string $userId): bool; |
|
77 | + /** |
|
78 | + * returns whether the provided user id is allowed to run a flow against |
|
79 | + * the known context |
|
80 | + * |
|
81 | + * @since 18.0.0 |
|
82 | + */ |
|
83 | + public function isLegitimatedForUserId(string $userId): bool; |
|
84 | 84 | |
85 | 85 | } |
@@ -32,10 +32,10 @@ |
||
32 | 32 | * @since 18.0.0 |
33 | 33 | */ |
34 | 34 | interface IUrl { |
35 | - /** |
|
36 | - * returns a URL that is related to the entity, e.g. the link to a share |
|
37 | - * |
|
38 | - * @since 18.0.0 |
|
39 | - */ |
|
40 | - public function getUrl(): string; |
|
35 | + /** |
|
36 | + * returns a URL that is related to the entity, e.g. the link to a share |
|
37 | + * |
|
38 | + * @since 18.0.0 |
|
39 | + */ |
|
40 | + public function getUrl(): string; |
|
41 | 41 | } |