@@ -31,40 +31,40 @@ |
||
31 | 31 | |
32 | 32 | class ClearFrontendCaches implements IRepairStep { |
33 | 33 | |
34 | - /** @var ICacheFactory */ |
|
35 | - protected $cacheFactory; |
|
34 | + /** @var ICacheFactory */ |
|
35 | + protected $cacheFactory; |
|
36 | 36 | |
37 | - /** @var SCSSCacher */ |
|
38 | - protected $scssCacher; |
|
37 | + /** @var SCSSCacher */ |
|
38 | + protected $scssCacher; |
|
39 | 39 | |
40 | - /** @var JSCombiner */ |
|
41 | - protected $jsCombiner; |
|
40 | + /** @var JSCombiner */ |
|
41 | + protected $jsCombiner; |
|
42 | 42 | |
43 | - public function __construct(ICacheFactory $cacheFactory, |
|
44 | - SCSSCacher $SCSSCacher, |
|
45 | - JSCombiner $JSCombiner) { |
|
46 | - $this->cacheFactory = $cacheFactory; |
|
47 | - $this->scssCacher = $SCSSCacher; |
|
48 | - $this->jsCombiner = $JSCombiner; |
|
49 | - } |
|
43 | + public function __construct(ICacheFactory $cacheFactory, |
|
44 | + SCSSCacher $SCSSCacher, |
|
45 | + JSCombiner $JSCombiner) { |
|
46 | + $this->cacheFactory = $cacheFactory; |
|
47 | + $this->scssCacher = $SCSSCacher; |
|
48 | + $this->jsCombiner = $JSCombiner; |
|
49 | + } |
|
50 | 50 | |
51 | - public function getName() { |
|
52 | - return 'Clear frontend caches'; |
|
53 | - } |
|
51 | + public function getName() { |
|
52 | + return 'Clear frontend caches'; |
|
53 | + } |
|
54 | 54 | |
55 | - public function run(IOutput $output) { |
|
56 | - try { |
|
57 | - $c = $this->cacheFactory->createDistributed('imagePath'); |
|
58 | - $c->clear(); |
|
59 | - $output->info('Image cache cleared'); |
|
55 | + public function run(IOutput $output) { |
|
56 | + try { |
|
57 | + $c = $this->cacheFactory->createDistributed('imagePath'); |
|
58 | + $c->clear(); |
|
59 | + $output->info('Image cache cleared'); |
|
60 | 60 | |
61 | - $this->scssCacher->resetCache(); |
|
62 | - $output->info('SCSS cache cleared'); |
|
61 | + $this->scssCacher->resetCache(); |
|
62 | + $output->info('SCSS cache cleared'); |
|
63 | 63 | |
64 | - $this->jsCombiner->resetCache(); |
|
65 | - $output->info('JS cache cleared'); |
|
66 | - } catch (\Exception $e) { |
|
67 | - $output->warning('Unable to clear the frontend cache'); |
|
68 | - } |
|
69 | - } |
|
64 | + $this->jsCombiner->resetCache(); |
|
65 | + $output->info('JS cache cleared'); |
|
66 | + } catch (\Exception $e) { |
|
67 | + $output->warning('Unable to clear the frontend cache'); |
|
68 | + } |
|
69 | + } |
|
70 | 70 | } |
@@ -34,35 +34,35 @@ |
||
34 | 34 | * @since 11.0.0 |
35 | 35 | */ |
36 | 36 | interface ISimpleRoot { |
37 | - /** |
|
38 | - * Get the folder with name $name |
|
39 | - * |
|
40 | - * @param string $name |
|
41 | - * @return ISimpleFolder |
|
42 | - * @throws NotFoundException |
|
43 | - * @throws \RuntimeException |
|
44 | - * @since 11.0.0 |
|
45 | - */ |
|
46 | - public function getFolder(string $name): ISimpleFolder; |
|
37 | + /** |
|
38 | + * Get the folder with name $name |
|
39 | + * |
|
40 | + * @param string $name |
|
41 | + * @return ISimpleFolder |
|
42 | + * @throws NotFoundException |
|
43 | + * @throws \RuntimeException |
|
44 | + * @since 11.0.0 |
|
45 | + */ |
|
46 | + public function getFolder(string $name): ISimpleFolder; |
|
47 | 47 | |
48 | - /** |
|
49 | - * Get all the Folders |
|
50 | - * |
|
51 | - * @return ISimpleFolder[] |
|
52 | - * @throws NotFoundException |
|
53 | - * @throws \RuntimeException |
|
54 | - * @since 11.0.0 |
|
55 | - */ |
|
56 | - public function getDirectoryListing(): array; |
|
48 | + /** |
|
49 | + * Get all the Folders |
|
50 | + * |
|
51 | + * @return ISimpleFolder[] |
|
52 | + * @throws NotFoundException |
|
53 | + * @throws \RuntimeException |
|
54 | + * @since 11.0.0 |
|
55 | + */ |
|
56 | + public function getDirectoryListing(): array; |
|
57 | 57 | |
58 | - /** |
|
59 | - * Create a new folder named $name |
|
60 | - * |
|
61 | - * @param string $name |
|
62 | - * @return ISimpleFolder |
|
63 | - * @throws NotPermittedException |
|
64 | - * @throws \RuntimeException |
|
65 | - * @since 11.0.0 |
|
66 | - */ |
|
67 | - public function newFolder(string $name): ISimpleFolder; |
|
58 | + /** |
|
59 | + * Create a new folder named $name |
|
60 | + * |
|
61 | + * @param string $name |
|
62 | + * @return ISimpleFolder |
|
63 | + * @throws NotPermittedException |
|
64 | + * @throws \RuntimeException |
|
65 | + * @since 11.0.0 |
|
66 | + */ |
|
67 | + public function newFolder(string $name): ISimpleFolder; |
|
68 | 68 | } |
@@ -164,7 +164,7 @@ |
||
164 | 164 | * @since 14.0.0 |
165 | 165 | */ |
166 | 166 | public function render(): string { |
167 | - $detailContent = ($this->detail !== '') ? ' <span class="download-size">(' . Util::sanitizeHTML($this->detail) . ')</span>' : ''; |
|
167 | + $detailContent = ($this->detail !== '') ? ' <span class="download-size">('.Util::sanitizeHTML($this->detail).')</span>' : ''; |
|
168 | 168 | return sprintf( |
169 | 169 | '<li id="%s"><a href="%s"><span class="icon %s"></span>%s %s</a></li>', |
170 | 170 | Util::sanitizeHTML($this->id), Util::sanitizeHTML($this->link), Util::sanitizeHTML($this->icon), Util::sanitizeHTML($this->label), $detailContent |
@@ -32,93 +32,93 @@ |
||
32 | 32 | */ |
33 | 33 | class SimpleMenuAction implements IMenuAction { |
34 | 34 | |
35 | - /** @var string */ |
|
36 | - private $id; |
|
35 | + /** @var string */ |
|
36 | + private $id; |
|
37 | 37 | |
38 | - /** @var string */ |
|
39 | - private $label; |
|
38 | + /** @var string */ |
|
39 | + private $label; |
|
40 | 40 | |
41 | - /** @var string */ |
|
42 | - private $icon; |
|
41 | + /** @var string */ |
|
42 | + private $icon; |
|
43 | 43 | |
44 | - /** @var string */ |
|
45 | - private $link; |
|
44 | + /** @var string */ |
|
45 | + private $link; |
|
46 | 46 | |
47 | - /** @var int */ |
|
48 | - private $priority; |
|
47 | + /** @var int */ |
|
48 | + private $priority; |
|
49 | 49 | |
50 | - /** @var string */ |
|
51 | - private $detail; |
|
50 | + /** @var string */ |
|
51 | + private $detail; |
|
52 | 52 | |
53 | - /** |
|
54 | - * SimpleMenuAction constructor. |
|
55 | - * |
|
56 | - * @param string $id |
|
57 | - * @param string $label |
|
58 | - * @param string $icon |
|
59 | - * @param string $link |
|
60 | - * @param int $priority |
|
61 | - * @param string $detail |
|
62 | - * @since 14.0.0 |
|
63 | - */ |
|
64 | - public function __construct(string $id, string $label, string $icon, string $link = '', int $priority = 100, string $detail = '') { |
|
65 | - $this->id = $id; |
|
66 | - $this->label = $label; |
|
67 | - $this->icon = $icon; |
|
68 | - $this->link = $link; |
|
69 | - $this->priority = $priority; |
|
70 | - $this->detail = $detail; |
|
71 | - } |
|
53 | + /** |
|
54 | + * SimpleMenuAction constructor. |
|
55 | + * |
|
56 | + * @param string $id |
|
57 | + * @param string $label |
|
58 | + * @param string $icon |
|
59 | + * @param string $link |
|
60 | + * @param int $priority |
|
61 | + * @param string $detail |
|
62 | + * @since 14.0.0 |
|
63 | + */ |
|
64 | + public function __construct(string $id, string $label, string $icon, string $link = '', int $priority = 100, string $detail = '') { |
|
65 | + $this->id = $id; |
|
66 | + $this->label = $label; |
|
67 | + $this->icon = $icon; |
|
68 | + $this->link = $link; |
|
69 | + $this->priority = $priority; |
|
70 | + $this->detail = $detail; |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * @return string |
|
75 | - * @since 14.0.0 |
|
76 | - */ |
|
77 | - public function getId(): string { |
|
78 | - return $this->id; |
|
79 | - } |
|
73 | + /** |
|
74 | + * @return string |
|
75 | + * @since 14.0.0 |
|
76 | + */ |
|
77 | + public function getId(): string { |
|
78 | + return $this->id; |
|
79 | + } |
|
80 | 80 | |
81 | - /** |
|
82 | - * @return string |
|
83 | - * @since 14.0.0 |
|
84 | - */ |
|
85 | - public function getLabel(): string { |
|
86 | - return $this->label; |
|
87 | - } |
|
81 | + /** |
|
82 | + * @return string |
|
83 | + * @since 14.0.0 |
|
84 | + */ |
|
85 | + public function getLabel(): string { |
|
86 | + return $this->label; |
|
87 | + } |
|
88 | 88 | |
89 | - /** |
|
90 | - * @return string |
|
91 | - * @since 14.0.0 |
|
92 | - */ |
|
93 | - public function getIcon(): string { |
|
94 | - return $this->icon; |
|
95 | - } |
|
89 | + /** |
|
90 | + * @return string |
|
91 | + * @since 14.0.0 |
|
92 | + */ |
|
93 | + public function getIcon(): string { |
|
94 | + return $this->icon; |
|
95 | + } |
|
96 | 96 | |
97 | - /** |
|
98 | - * @return string |
|
99 | - * @since 14.0.0 |
|
100 | - */ |
|
101 | - public function getLink(): string { |
|
102 | - return $this->link; |
|
103 | - } |
|
97 | + /** |
|
98 | + * @return string |
|
99 | + * @since 14.0.0 |
|
100 | + */ |
|
101 | + public function getLink(): string { |
|
102 | + return $this->link; |
|
103 | + } |
|
104 | 104 | |
105 | - /** |
|
106 | - * @return int |
|
107 | - * @since 14.0.0 |
|
108 | - */ |
|
109 | - public function getPriority(): int { |
|
110 | - return $this->priority; |
|
111 | - } |
|
105 | + /** |
|
106 | + * @return int |
|
107 | + * @since 14.0.0 |
|
108 | + */ |
|
109 | + public function getPriority(): int { |
|
110 | + return $this->priority; |
|
111 | + } |
|
112 | 112 | |
113 | - /** |
|
114 | - * @return string |
|
115 | - * @since 14.0.0 |
|
116 | - */ |
|
117 | - public function render(): string { |
|
118 | - $detailContent = ($this->detail !== '') ? ' <span class="download-size">(' . Util::sanitizeHTML($this->detail) . ')</span>' : ''; |
|
119 | - return sprintf( |
|
120 | - '<li id="%s"><a href="%s"><span class="icon %s"></span>%s %s</a></li>', |
|
121 | - Util::sanitizeHTML($this->id), Util::sanitizeHTML($this->link), Util::sanitizeHTML($this->icon), Util::sanitizeHTML($this->label), $detailContent |
|
122 | - ); |
|
123 | - } |
|
113 | + /** |
|
114 | + * @return string |
|
115 | + * @since 14.0.0 |
|
116 | + */ |
|
117 | + public function render(): string { |
|
118 | + $detailContent = ($this->detail !== '') ? ' <span class="download-size">(' . Util::sanitizeHTML($this->detail) . ')</span>' : ''; |
|
119 | + return sprintf( |
|
120 | + '<li id="%s"><a href="%s"><span class="icon %s"></span>%s %s</a></li>', |
|
121 | + Util::sanitizeHTML($this->id), Util::sanitizeHTML($this->link), Util::sanitizeHTML($this->icon), Util::sanitizeHTML($this->label), $detailContent |
|
122 | + ); |
|
123 | + } |
|
124 | 124 | } |
@@ -34,101 +34,101 @@ |
||
34 | 34 | use OCP\Share\IShareHelper; |
35 | 35 | |
36 | 36 | class Listener { |
37 | - /** @var IManager */ |
|
38 | - protected $activityManager; |
|
39 | - /** @var IUserSession */ |
|
40 | - protected $session; |
|
41 | - /** @var \OCP\App\IAppManager */ |
|
42 | - protected $appManager; |
|
43 | - /** @var \OCP\Files\Config\IMountProviderCollection */ |
|
44 | - protected $mountCollection; |
|
45 | - /** @var \OCP\Files\IRootFolder */ |
|
46 | - protected $rootFolder; |
|
47 | - /** @var IShareHelper */ |
|
48 | - protected $shareHelper; |
|
37 | + /** @var IManager */ |
|
38 | + protected $activityManager; |
|
39 | + /** @var IUserSession */ |
|
40 | + protected $session; |
|
41 | + /** @var \OCP\App\IAppManager */ |
|
42 | + protected $appManager; |
|
43 | + /** @var \OCP\Files\Config\IMountProviderCollection */ |
|
44 | + protected $mountCollection; |
|
45 | + /** @var \OCP\Files\IRootFolder */ |
|
46 | + protected $rootFolder; |
|
47 | + /** @var IShareHelper */ |
|
48 | + protected $shareHelper; |
|
49 | 49 | |
50 | - /** |
|
51 | - * Listener constructor. |
|
52 | - * |
|
53 | - * @param IManager $activityManager |
|
54 | - * @param IUserSession $session |
|
55 | - * @param IAppManager $appManager |
|
56 | - * @param IMountProviderCollection $mountCollection |
|
57 | - * @param IRootFolder $rootFolder |
|
58 | - * @param IShareHelper $shareHelper |
|
59 | - */ |
|
60 | - public function __construct(IManager $activityManager, |
|
61 | - IUserSession $session, |
|
62 | - IAppManager $appManager, |
|
63 | - IMountProviderCollection $mountCollection, |
|
64 | - IRootFolder $rootFolder, |
|
65 | - IShareHelper $shareHelper) { |
|
66 | - $this->activityManager = $activityManager; |
|
67 | - $this->session = $session; |
|
68 | - $this->appManager = $appManager; |
|
69 | - $this->mountCollection = $mountCollection; |
|
70 | - $this->rootFolder = $rootFolder; |
|
71 | - $this->shareHelper = $shareHelper; |
|
72 | - } |
|
50 | + /** |
|
51 | + * Listener constructor. |
|
52 | + * |
|
53 | + * @param IManager $activityManager |
|
54 | + * @param IUserSession $session |
|
55 | + * @param IAppManager $appManager |
|
56 | + * @param IMountProviderCollection $mountCollection |
|
57 | + * @param IRootFolder $rootFolder |
|
58 | + * @param IShareHelper $shareHelper |
|
59 | + */ |
|
60 | + public function __construct(IManager $activityManager, |
|
61 | + IUserSession $session, |
|
62 | + IAppManager $appManager, |
|
63 | + IMountProviderCollection $mountCollection, |
|
64 | + IRootFolder $rootFolder, |
|
65 | + IShareHelper $shareHelper) { |
|
66 | + $this->activityManager = $activityManager; |
|
67 | + $this->session = $session; |
|
68 | + $this->appManager = $appManager; |
|
69 | + $this->mountCollection = $mountCollection; |
|
70 | + $this->rootFolder = $rootFolder; |
|
71 | + $this->shareHelper = $shareHelper; |
|
72 | + } |
|
73 | 73 | |
74 | - /** |
|
75 | - * @param CommentsEvent $event |
|
76 | - */ |
|
77 | - public function commentEvent(CommentsEvent $event) { |
|
78 | - if ($event->getComment()->getObjectType() !== 'files' |
|
79 | - || $event->getEvent() !== CommentsEvent::EVENT_ADD |
|
80 | - || !$this->appManager->isInstalled('activity')) { |
|
81 | - // Comment not for file, not adding a comment or no activity-app enabled (save the energy) |
|
82 | - return; |
|
83 | - } |
|
74 | + /** |
|
75 | + * @param CommentsEvent $event |
|
76 | + */ |
|
77 | + public function commentEvent(CommentsEvent $event) { |
|
78 | + if ($event->getComment()->getObjectType() !== 'files' |
|
79 | + || $event->getEvent() !== CommentsEvent::EVENT_ADD |
|
80 | + || !$this->appManager->isInstalled('activity')) { |
|
81 | + // Comment not for file, not adding a comment or no activity-app enabled (save the energy) |
|
82 | + return; |
|
83 | + } |
|
84 | 84 | |
85 | - // Get all mount point owners |
|
86 | - $cache = $this->mountCollection->getMountCache(); |
|
87 | - $mounts = $cache->getMountsForFileId((int)$event->getComment()->getObjectId()); |
|
88 | - if (empty($mounts)) { |
|
89 | - return; |
|
90 | - } |
|
85 | + // Get all mount point owners |
|
86 | + $cache = $this->mountCollection->getMountCache(); |
|
87 | + $mounts = $cache->getMountsForFileId((int)$event->getComment()->getObjectId()); |
|
88 | + if (empty($mounts)) { |
|
89 | + return; |
|
90 | + } |
|
91 | 91 | |
92 | - $users = []; |
|
93 | - foreach ($mounts as $mount) { |
|
94 | - $owner = $mount->getUser()->getUID(); |
|
95 | - $ownerFolder = $this->rootFolder->getUserFolder($owner); |
|
96 | - $nodes = $ownerFolder->getById((int)$event->getComment()->getObjectId()); |
|
97 | - if (!empty($nodes)) { |
|
98 | - /** @var Node $node */ |
|
99 | - $node = array_shift($nodes); |
|
100 | - $al = $this->shareHelper->getPathsForAccessList($node); |
|
101 | - $users += $al['users']; |
|
102 | - } |
|
103 | - } |
|
92 | + $users = []; |
|
93 | + foreach ($mounts as $mount) { |
|
94 | + $owner = $mount->getUser()->getUID(); |
|
95 | + $ownerFolder = $this->rootFolder->getUserFolder($owner); |
|
96 | + $nodes = $ownerFolder->getById((int)$event->getComment()->getObjectId()); |
|
97 | + if (!empty($nodes)) { |
|
98 | + /** @var Node $node */ |
|
99 | + $node = array_shift($nodes); |
|
100 | + $al = $this->shareHelper->getPathsForAccessList($node); |
|
101 | + $users += $al['users']; |
|
102 | + } |
|
103 | + } |
|
104 | 104 | |
105 | - $actor = $this->session->getUser(); |
|
106 | - if ($actor instanceof IUser) { |
|
107 | - $actor = $actor->getUID(); |
|
108 | - } else { |
|
109 | - $actor = ''; |
|
110 | - } |
|
105 | + $actor = $this->session->getUser(); |
|
106 | + if ($actor instanceof IUser) { |
|
107 | + $actor = $actor->getUID(); |
|
108 | + } else { |
|
109 | + $actor = ''; |
|
110 | + } |
|
111 | 111 | |
112 | - $activity = $this->activityManager->generateEvent(); |
|
113 | - $activity->setApp('comments') |
|
114 | - ->setType('comments') |
|
115 | - ->setAuthor($actor) |
|
116 | - ->setObject($event->getComment()->getObjectType(), (int) $event->getComment()->getObjectId()) |
|
117 | - ->setMessage('add_comment_message', [ |
|
118 | - 'commentId' => $event->getComment()->getId(), |
|
119 | - ]); |
|
112 | + $activity = $this->activityManager->generateEvent(); |
|
113 | + $activity->setApp('comments') |
|
114 | + ->setType('comments') |
|
115 | + ->setAuthor($actor) |
|
116 | + ->setObject($event->getComment()->getObjectType(), (int) $event->getComment()->getObjectId()) |
|
117 | + ->setMessage('add_comment_message', [ |
|
118 | + 'commentId' => $event->getComment()->getId(), |
|
119 | + ]); |
|
120 | 120 | |
121 | - foreach ($users as $user => $path) { |
|
122 | - // numerical user ids end up as integers from array keys, but string |
|
123 | - // is required |
|
124 | - $activity->setAffectedUser((string)$user); |
|
121 | + foreach ($users as $user => $path) { |
|
122 | + // numerical user ids end up as integers from array keys, but string |
|
123 | + // is required |
|
124 | + $activity->setAffectedUser((string)$user); |
|
125 | 125 | |
126 | - $activity->setSubject('add_comment_subject', [ |
|
127 | - 'actor' => $actor, |
|
128 | - 'fileId' => (int) $event->getComment()->getObjectId(), |
|
129 | - 'filePath' => trim($path, '/'), |
|
130 | - ]); |
|
131 | - $this->activityManager->publish($activity); |
|
132 | - } |
|
133 | - } |
|
126 | + $activity->setSubject('add_comment_subject', [ |
|
127 | + 'actor' => $actor, |
|
128 | + 'fileId' => (int) $event->getComment()->getObjectId(), |
|
129 | + 'filePath' => trim($path, '/'), |
|
130 | + ]); |
|
131 | + $this->activityManager->publish($activity); |
|
132 | + } |
|
133 | + } |
|
134 | 134 | } |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | |
85 | 85 | // Get all mount point owners |
86 | 86 | $cache = $this->mountCollection->getMountCache(); |
87 | - $mounts = $cache->getMountsForFileId((int)$event->getComment()->getObjectId()); |
|
87 | + $mounts = $cache->getMountsForFileId((int) $event->getComment()->getObjectId()); |
|
88 | 88 | if (empty($mounts)) { |
89 | 89 | return; |
90 | 90 | } |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | foreach ($mounts as $mount) { |
94 | 94 | $owner = $mount->getUser()->getUID(); |
95 | 95 | $ownerFolder = $this->rootFolder->getUserFolder($owner); |
96 | - $nodes = $ownerFolder->getById((int)$event->getComment()->getObjectId()); |
|
96 | + $nodes = $ownerFolder->getById((int) $event->getComment()->getObjectId()); |
|
97 | 97 | if (!empty($nodes)) { |
98 | 98 | /** @var Node $node */ |
99 | 99 | $node = array_shift($nodes); |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | foreach ($users as $user => $path) { |
122 | 122 | // numerical user ids end up as integers from array keys, but string |
123 | 123 | // is required |
124 | - $activity->setAffectedUser((string)$user); |
|
124 | + $activity->setAffectedUser((string) $user); |
|
125 | 125 | |
126 | 126 | $activity->setSubject('add_comment_subject', [ |
127 | 127 | 'actor' => $actor, |
@@ -30,21 +30,21 @@ |
||
30 | 30 | * @package OC\IntegrityCheck\Helpers |
31 | 31 | */ |
32 | 32 | class EnvironmentHelper { |
33 | - /** |
|
34 | - * Provides \OC::$SERVERROOT |
|
35 | - * |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public function getServerRoot(): string { |
|
39 | - return rtrim(\OC::$SERVERROOT, '/'); |
|
40 | - } |
|
33 | + /** |
|
34 | + * Provides \OC::$SERVERROOT |
|
35 | + * |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public function getServerRoot(): string { |
|
39 | + return rtrim(\OC::$SERVERROOT, '/'); |
|
40 | + } |
|
41 | 41 | |
42 | - /** |
|
43 | - * Provides \OC_Util::getChannel() |
|
44 | - * |
|
45 | - * @return string |
|
46 | - */ |
|
47 | - public function getChannel(): string { |
|
48 | - return \OC_Util::getChannel(); |
|
49 | - } |
|
42 | + /** |
|
43 | + * Provides \OC_Util::getChannel() |
|
44 | + * |
|
45 | + * @return string |
|
46 | + */ |
|
47 | + public function getChannel(): string { |
|
48 | + return \OC_Util::getChannel(); |
|
49 | + } |
|
50 | 50 | } |
@@ -31,102 +31,102 @@ |
||
31 | 31 | */ |
32 | 32 | interface ISystemTagObjectMapper { |
33 | 33 | |
34 | - /** |
|
35 | - * Get a list of tag ids for the given object ids. |
|
36 | - * |
|
37 | - * This returns an array that maps object id to tag ids |
|
38 | - * [ |
|
39 | - * 1 => array('id1', 'id2'), |
|
40 | - * 2 => array('id3', 'id2'), |
|
41 | - * 3 => array('id5'), |
|
42 | - * 4 => array() |
|
43 | - * ] |
|
44 | - * |
|
45 | - * Untagged objects will have an empty array associated. |
|
46 | - * |
|
47 | - * @param string|array $objIds object ids |
|
48 | - * @param string $objectType object type |
|
49 | - * |
|
50 | - * @return array with object id as key and an array |
|
51 | - * of tag ids as value |
|
52 | - * |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function getTagIdsForObjects($objIds, string $objectType): array; |
|
34 | + /** |
|
35 | + * Get a list of tag ids for the given object ids. |
|
36 | + * |
|
37 | + * This returns an array that maps object id to tag ids |
|
38 | + * [ |
|
39 | + * 1 => array('id1', 'id2'), |
|
40 | + * 2 => array('id3', 'id2'), |
|
41 | + * 3 => array('id5'), |
|
42 | + * 4 => array() |
|
43 | + * ] |
|
44 | + * |
|
45 | + * Untagged objects will have an empty array associated. |
|
46 | + * |
|
47 | + * @param string|array $objIds object ids |
|
48 | + * @param string $objectType object type |
|
49 | + * |
|
50 | + * @return array with object id as key and an array |
|
51 | + * of tag ids as value |
|
52 | + * |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function getTagIdsForObjects($objIds, string $objectType): array; |
|
56 | 56 | |
57 | - /** |
|
58 | - * Get a list of objects tagged with $tagIds. |
|
59 | - * |
|
60 | - * @param string|array $tagIds Tag id or array of tag ids. |
|
61 | - * @param string $objectType object type |
|
62 | - * @param int $limit Count of object ids you want to get |
|
63 | - * @param string $offset The last object id you already received |
|
64 | - * |
|
65 | - * @return string[] array of object ids or empty array if none found |
|
66 | - * |
|
67 | - * @throws TagNotFoundException if at least one of the |
|
68 | - * given tags does not exist |
|
69 | - * @throws \InvalidArgumentException When a limit is specified together with |
|
70 | - * multiple tag ids |
|
71 | - * |
|
72 | - * @since 9.0.0 |
|
73 | - */ |
|
74 | - public function getObjectIdsForTags($tagIds, string $objectType, int $limit = 0, string $offset = ''): array; |
|
57 | + /** |
|
58 | + * Get a list of objects tagged with $tagIds. |
|
59 | + * |
|
60 | + * @param string|array $tagIds Tag id or array of tag ids. |
|
61 | + * @param string $objectType object type |
|
62 | + * @param int $limit Count of object ids you want to get |
|
63 | + * @param string $offset The last object id you already received |
|
64 | + * |
|
65 | + * @return string[] array of object ids or empty array if none found |
|
66 | + * |
|
67 | + * @throws TagNotFoundException if at least one of the |
|
68 | + * given tags does not exist |
|
69 | + * @throws \InvalidArgumentException When a limit is specified together with |
|
70 | + * multiple tag ids |
|
71 | + * |
|
72 | + * @since 9.0.0 |
|
73 | + */ |
|
74 | + public function getObjectIdsForTags($tagIds, string $objectType, int $limit = 0, string $offset = ''): array; |
|
75 | 75 | |
76 | - /** |
|
77 | - * Assign the given tags to the given object. |
|
78 | - * |
|
79 | - * If at least one of the given tag ids doesn't exist, none of the tags |
|
80 | - * will be assigned. |
|
81 | - * |
|
82 | - * If the relationship already existed, fail silently. |
|
83 | - * |
|
84 | - * @param string $objId object id |
|
85 | - * @param string $objectType object type |
|
86 | - * @param string|array $tagIds tag id or array of tag ids to assign |
|
87 | - * |
|
88 | - * @throws TagNotFoundException if at least one of the |
|
89 | - * given tags does not exist |
|
90 | - * |
|
91 | - * @since 9.0.0 |
|
92 | - */ |
|
93 | - public function assignTags(string $objId, string $objectType, $tagIds); |
|
76 | + /** |
|
77 | + * Assign the given tags to the given object. |
|
78 | + * |
|
79 | + * If at least one of the given tag ids doesn't exist, none of the tags |
|
80 | + * will be assigned. |
|
81 | + * |
|
82 | + * If the relationship already existed, fail silently. |
|
83 | + * |
|
84 | + * @param string $objId object id |
|
85 | + * @param string $objectType object type |
|
86 | + * @param string|array $tagIds tag id or array of tag ids to assign |
|
87 | + * |
|
88 | + * @throws TagNotFoundException if at least one of the |
|
89 | + * given tags does not exist |
|
90 | + * |
|
91 | + * @since 9.0.0 |
|
92 | + */ |
|
93 | + public function assignTags(string $objId, string $objectType, $tagIds); |
|
94 | 94 | |
95 | - /** |
|
96 | - * Unassign the given tags from the given object. |
|
97 | - * |
|
98 | - * If at least one of the given tag ids doesn't exist, none of the tags |
|
99 | - * will be unassigned. |
|
100 | - * |
|
101 | - * If the relationship did not exist in the first place, fail silently. |
|
102 | - * |
|
103 | - * @param string $objId object id |
|
104 | - * @param string $objectType object type |
|
105 | - * @param string|array $tagIds tag id or array of tag ids to unassign |
|
106 | - * |
|
107 | - * @throws TagNotFoundException if at least one of the |
|
108 | - * given tags does not exist |
|
109 | - * |
|
110 | - * @since 9.0.0 |
|
111 | - */ |
|
112 | - public function unassignTags(string $objId, string $objectType, $tagIds); |
|
95 | + /** |
|
96 | + * Unassign the given tags from the given object. |
|
97 | + * |
|
98 | + * If at least one of the given tag ids doesn't exist, none of the tags |
|
99 | + * will be unassigned. |
|
100 | + * |
|
101 | + * If the relationship did not exist in the first place, fail silently. |
|
102 | + * |
|
103 | + * @param string $objId object id |
|
104 | + * @param string $objectType object type |
|
105 | + * @param string|array $tagIds tag id or array of tag ids to unassign |
|
106 | + * |
|
107 | + * @throws TagNotFoundException if at least one of the |
|
108 | + * given tags does not exist |
|
109 | + * |
|
110 | + * @since 9.0.0 |
|
111 | + */ |
|
112 | + public function unassignTags(string $objId, string $objectType, $tagIds); |
|
113 | 113 | |
114 | - /** |
|
115 | - * Checks whether the given objects have the given tag. |
|
116 | - * |
|
117 | - * @param string|array $objIds object ids |
|
118 | - * @param string $objectType object type |
|
119 | - * @param string $tagId tag id to check |
|
120 | - * @param bool $all true to check that ALL objects have the tag assigned, |
|
121 | - * false to check that at least ONE object has the tag. |
|
122 | - * |
|
123 | - * @return bool true if the condition set by $all is matched, false |
|
124 | - * otherwise |
|
125 | - * |
|
126 | - * @throws TagNotFoundException if the tag does not exist |
|
127 | - * |
|
128 | - * @since 9.0.0 |
|
129 | - */ |
|
130 | - public function haveTag($objIds, string $objectType, string $tagId, bool $all = true): bool; |
|
114 | + /** |
|
115 | + * Checks whether the given objects have the given tag. |
|
116 | + * |
|
117 | + * @param string|array $objIds object ids |
|
118 | + * @param string $objectType object type |
|
119 | + * @param string $tagId tag id to check |
|
120 | + * @param bool $all true to check that ALL objects have the tag assigned, |
|
121 | + * false to check that at least ONE object has the tag. |
|
122 | + * |
|
123 | + * @return bool true if the condition set by $all is matched, false |
|
124 | + * otherwise |
|
125 | + * |
|
126 | + * @throws TagNotFoundException if the tag does not exist |
|
127 | + * |
|
128 | + * @since 9.0.0 |
|
129 | + */ |
|
130 | + public function haveTag($objIds, string $objectType, string $tagId, bool $all = true): bool; |
|
131 | 131 | |
132 | 132 | } |
@@ -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 | } |