@@ -37,134 +37,134 @@ |
||
37 | 37 | * Mapping node for system tag to object id |
38 | 38 | */ |
39 | 39 | class SystemTagMappingNode implements \Sabre\DAV\INode { |
40 | - /** |
|
41 | - * @var ISystemTag |
|
42 | - */ |
|
43 | - protected $tag; |
|
44 | - |
|
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
48 | - private $objectId; |
|
49 | - |
|
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
53 | - private $objectType; |
|
54 | - |
|
55 | - /** |
|
56 | - * User |
|
57 | - * |
|
58 | - * @var IUser |
|
59 | - */ |
|
60 | - protected $user; |
|
61 | - |
|
62 | - /** |
|
63 | - * @var ISystemTagManager |
|
64 | - */ |
|
65 | - protected $tagManager; |
|
66 | - |
|
67 | - /** |
|
68 | - * @var ISystemTagObjectMapper |
|
69 | - */ |
|
70 | - private $tagMapper; |
|
71 | - |
|
72 | - /** |
|
73 | - * Sets up the node, expects a full path name |
|
74 | - * |
|
75 | - * @param ISystemTag $tag system tag |
|
76 | - * @param string $objectId |
|
77 | - * @param string $objectType |
|
78 | - * @param IUser $user user |
|
79 | - * @param ISystemTagManager $tagManager |
|
80 | - * @param ISystemTagObjectMapper $tagMapper |
|
81 | - */ |
|
82 | - public function __construct( |
|
83 | - ISystemTag $tag, |
|
84 | - $objectId, |
|
85 | - $objectType, |
|
86 | - IUser $user, |
|
87 | - ISystemTagManager $tagManager, |
|
88 | - ISystemTagObjectMapper $tagMapper |
|
89 | - ) { |
|
90 | - $this->tag = $tag; |
|
91 | - $this->objectId = $objectId; |
|
92 | - $this->objectType = $objectType; |
|
93 | - $this->user = $user; |
|
94 | - $this->tagManager = $tagManager; |
|
95 | - $this->tagMapper = $tagMapper; |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Returns the object id of the relationship |
|
100 | - * |
|
101 | - * @return string object id |
|
102 | - */ |
|
103 | - public function getObjectId() { |
|
104 | - return $this->objectId; |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * Returns the object type of the relationship |
|
109 | - * |
|
110 | - * @return string object type |
|
111 | - */ |
|
112 | - public function getObjectType() { |
|
113 | - return $this->objectType; |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Returns the system tag represented by this node |
|
118 | - * |
|
119 | - * @return ISystemTag system tag |
|
120 | - */ |
|
121 | - public function getSystemTag() { |
|
122 | - return $this->tag; |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * Returns the id of the tag |
|
127 | - * |
|
128 | - * @return string |
|
129 | - */ |
|
130 | - public function getName() { |
|
131 | - return $this->tag->getId(); |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Renames the node |
|
136 | - * |
|
137 | - * @param string $name The new name |
|
138 | - * |
|
139 | - * @throws MethodNotAllowed not allowed to rename node |
|
140 | - */ |
|
141 | - public function setName($name) { |
|
142 | - throw new MethodNotAllowed(); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Returns null, not supported |
|
147 | - * |
|
148 | - */ |
|
149 | - public function getLastModified() { |
|
150 | - return null; |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Delete tag to object association |
|
155 | - */ |
|
156 | - public function delete() { |
|
157 | - try { |
|
158 | - if (!$this->tagManager->canUserSeeTag($this->tag, $this->user)) { |
|
159 | - throw new NotFound('Tag with id ' . $this->tag->getId() . ' not found'); |
|
160 | - } |
|
161 | - if (!$this->tagManager->canUserAssignTag($this->tag, $this->user)) { |
|
162 | - throw new Forbidden('No permission to unassign tag ' . $this->tag->getId()); |
|
163 | - } |
|
164 | - $this->tagMapper->unassignTags($this->objectId, $this->objectType, $this->tag->getId()); |
|
165 | - } catch (TagNotFoundException $e) { |
|
166 | - // can happen if concurrent deletion occurred |
|
167 | - throw new NotFound('Tag with id ' . $this->tag->getId() . ' not found', 0, $e); |
|
168 | - } |
|
169 | - } |
|
40 | + /** |
|
41 | + * @var ISystemTag |
|
42 | + */ |
|
43 | + protected $tag; |
|
44 | + |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | + private $objectId; |
|
49 | + |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | + private $objectType; |
|
54 | + |
|
55 | + /** |
|
56 | + * User |
|
57 | + * |
|
58 | + * @var IUser |
|
59 | + */ |
|
60 | + protected $user; |
|
61 | + |
|
62 | + /** |
|
63 | + * @var ISystemTagManager |
|
64 | + */ |
|
65 | + protected $tagManager; |
|
66 | + |
|
67 | + /** |
|
68 | + * @var ISystemTagObjectMapper |
|
69 | + */ |
|
70 | + private $tagMapper; |
|
71 | + |
|
72 | + /** |
|
73 | + * Sets up the node, expects a full path name |
|
74 | + * |
|
75 | + * @param ISystemTag $tag system tag |
|
76 | + * @param string $objectId |
|
77 | + * @param string $objectType |
|
78 | + * @param IUser $user user |
|
79 | + * @param ISystemTagManager $tagManager |
|
80 | + * @param ISystemTagObjectMapper $tagMapper |
|
81 | + */ |
|
82 | + public function __construct( |
|
83 | + ISystemTag $tag, |
|
84 | + $objectId, |
|
85 | + $objectType, |
|
86 | + IUser $user, |
|
87 | + ISystemTagManager $tagManager, |
|
88 | + ISystemTagObjectMapper $tagMapper |
|
89 | + ) { |
|
90 | + $this->tag = $tag; |
|
91 | + $this->objectId = $objectId; |
|
92 | + $this->objectType = $objectType; |
|
93 | + $this->user = $user; |
|
94 | + $this->tagManager = $tagManager; |
|
95 | + $this->tagMapper = $tagMapper; |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Returns the object id of the relationship |
|
100 | + * |
|
101 | + * @return string object id |
|
102 | + */ |
|
103 | + public function getObjectId() { |
|
104 | + return $this->objectId; |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * Returns the object type of the relationship |
|
109 | + * |
|
110 | + * @return string object type |
|
111 | + */ |
|
112 | + public function getObjectType() { |
|
113 | + return $this->objectType; |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Returns the system tag represented by this node |
|
118 | + * |
|
119 | + * @return ISystemTag system tag |
|
120 | + */ |
|
121 | + public function getSystemTag() { |
|
122 | + return $this->tag; |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * Returns the id of the tag |
|
127 | + * |
|
128 | + * @return string |
|
129 | + */ |
|
130 | + public function getName() { |
|
131 | + return $this->tag->getId(); |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Renames the node |
|
136 | + * |
|
137 | + * @param string $name The new name |
|
138 | + * |
|
139 | + * @throws MethodNotAllowed not allowed to rename node |
|
140 | + */ |
|
141 | + public function setName($name) { |
|
142 | + throw new MethodNotAllowed(); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Returns null, not supported |
|
147 | + * |
|
148 | + */ |
|
149 | + public function getLastModified() { |
|
150 | + return null; |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * Delete tag to object association |
|
155 | + */ |
|
156 | + public function delete() { |
|
157 | + try { |
|
158 | + if (!$this->tagManager->canUserSeeTag($this->tag, $this->user)) { |
|
159 | + throw new NotFound('Tag with id ' . $this->tag->getId() . ' not found'); |
|
160 | + } |
|
161 | + if (!$this->tagManager->canUserAssignTag($this->tag, $this->user)) { |
|
162 | + throw new Forbidden('No permission to unassign tag ' . $this->tag->getId()); |
|
163 | + } |
|
164 | + $this->tagMapper->unassignTags($this->objectId, $this->objectType, $this->tag->getId()); |
|
165 | + } catch (TagNotFoundException $e) { |
|
166 | + // can happen if concurrent deletion occurred |
|
167 | + throw new NotFound('Tag with id ' . $this->tag->getId() . ' not found', 0, $e); |
|
168 | + } |
|
169 | + } |
|
170 | 170 | } |
@@ -33,83 +33,83 @@ |
||
33 | 33 | |
34 | 34 | class CleanUp extends Command { |
35 | 35 | |
36 | - /** @var IUserManager */ |
|
37 | - protected $userManager; |
|
38 | - |
|
39 | - /** @var IRootFolder */ |
|
40 | - protected $rootFolder; |
|
41 | - |
|
42 | - /** |
|
43 | - * @param IRootFolder $rootFolder |
|
44 | - * @param IUserManager $userManager |
|
45 | - */ |
|
46 | - function __construct(IRootFolder $rootFolder, IUserManager $userManager) { |
|
47 | - parent::__construct(); |
|
48 | - $this->userManager = $userManager; |
|
49 | - $this->rootFolder = $rootFolder; |
|
50 | - } |
|
51 | - |
|
52 | - protected function configure() { |
|
53 | - $this |
|
54 | - ->setName('versions:cleanup') |
|
55 | - ->setDescription('Delete versions') |
|
56 | - ->addArgument( |
|
57 | - 'user_id', |
|
58 | - InputArgument::OPTIONAL | InputArgument::IS_ARRAY, |
|
59 | - 'delete versions of the given user(s), if no user is given all versions will be deleted' |
|
60 | - ); |
|
61 | - } |
|
62 | - |
|
63 | - |
|
64 | - protected function execute(InputInterface $input, OutputInterface $output) { |
|
65 | - |
|
66 | - $users = $input->getArgument('user_id'); |
|
67 | - if (!empty($users)) { |
|
68 | - foreach ($users as $user) { |
|
69 | - if ($this->userManager->userExists($user)) { |
|
70 | - $output->writeln("Delete versions of <info>$user</info>"); |
|
71 | - $this->deleteVersions($user); |
|
72 | - } else { |
|
73 | - $output->writeln("<error>Unknown user $user</error>"); |
|
74 | - } |
|
75 | - } |
|
76 | - } else { |
|
77 | - $output->writeln('Delete all versions'); |
|
78 | - foreach ($this->userManager->getBackends() as $backend) { |
|
79 | - $name = get_class($backend); |
|
80 | - |
|
81 | - if ($backend instanceof IUserBackend) { |
|
82 | - $name = $backend->getBackendName(); |
|
83 | - } |
|
84 | - |
|
85 | - $output->writeln("Delete versions for users on backend <info>$name</info>"); |
|
86 | - |
|
87 | - $limit = 500; |
|
88 | - $offset = 0; |
|
89 | - do { |
|
90 | - $users = $backend->getUsers('', $limit, $offset); |
|
91 | - foreach ($users as $user) { |
|
92 | - $output->writeln(" <info>$user</info>"); |
|
93 | - $this->deleteVersions($user); |
|
94 | - } |
|
95 | - $offset += $limit; |
|
96 | - } while (count($users) >= $limit); |
|
97 | - } |
|
98 | - } |
|
99 | - } |
|
100 | - |
|
101 | - |
|
102 | - /** |
|
103 | - * delete versions for the given user |
|
104 | - * |
|
105 | - * @param string $user |
|
106 | - */ |
|
107 | - protected function deleteVersions($user) { |
|
108 | - \OC_Util::tearDownFS(); |
|
109 | - \OC_Util::setupFS($user); |
|
110 | - if ($this->rootFolder->nodeExists('/' . $user . '/files_versions')) { |
|
111 | - $this->rootFolder->get('/' . $user . '/files_versions')->delete(); |
|
112 | - } |
|
113 | - } |
|
36 | + /** @var IUserManager */ |
|
37 | + protected $userManager; |
|
38 | + |
|
39 | + /** @var IRootFolder */ |
|
40 | + protected $rootFolder; |
|
41 | + |
|
42 | + /** |
|
43 | + * @param IRootFolder $rootFolder |
|
44 | + * @param IUserManager $userManager |
|
45 | + */ |
|
46 | + function __construct(IRootFolder $rootFolder, IUserManager $userManager) { |
|
47 | + parent::__construct(); |
|
48 | + $this->userManager = $userManager; |
|
49 | + $this->rootFolder = $rootFolder; |
|
50 | + } |
|
51 | + |
|
52 | + protected function configure() { |
|
53 | + $this |
|
54 | + ->setName('versions:cleanup') |
|
55 | + ->setDescription('Delete versions') |
|
56 | + ->addArgument( |
|
57 | + 'user_id', |
|
58 | + InputArgument::OPTIONAL | InputArgument::IS_ARRAY, |
|
59 | + 'delete versions of the given user(s), if no user is given all versions will be deleted' |
|
60 | + ); |
|
61 | + } |
|
62 | + |
|
63 | + |
|
64 | + protected function execute(InputInterface $input, OutputInterface $output) { |
|
65 | + |
|
66 | + $users = $input->getArgument('user_id'); |
|
67 | + if (!empty($users)) { |
|
68 | + foreach ($users as $user) { |
|
69 | + if ($this->userManager->userExists($user)) { |
|
70 | + $output->writeln("Delete versions of <info>$user</info>"); |
|
71 | + $this->deleteVersions($user); |
|
72 | + } else { |
|
73 | + $output->writeln("<error>Unknown user $user</error>"); |
|
74 | + } |
|
75 | + } |
|
76 | + } else { |
|
77 | + $output->writeln('Delete all versions'); |
|
78 | + foreach ($this->userManager->getBackends() as $backend) { |
|
79 | + $name = get_class($backend); |
|
80 | + |
|
81 | + if ($backend instanceof IUserBackend) { |
|
82 | + $name = $backend->getBackendName(); |
|
83 | + } |
|
84 | + |
|
85 | + $output->writeln("Delete versions for users on backend <info>$name</info>"); |
|
86 | + |
|
87 | + $limit = 500; |
|
88 | + $offset = 0; |
|
89 | + do { |
|
90 | + $users = $backend->getUsers('', $limit, $offset); |
|
91 | + foreach ($users as $user) { |
|
92 | + $output->writeln(" <info>$user</info>"); |
|
93 | + $this->deleteVersions($user); |
|
94 | + } |
|
95 | + $offset += $limit; |
|
96 | + } while (count($users) >= $limit); |
|
97 | + } |
|
98 | + } |
|
99 | + } |
|
100 | + |
|
101 | + |
|
102 | + /** |
|
103 | + * delete versions for the given user |
|
104 | + * |
|
105 | + * @param string $user |
|
106 | + */ |
|
107 | + protected function deleteVersions($user) { |
|
108 | + \OC_Util::tearDownFS(); |
|
109 | + \OC_Util::setupFS($user); |
|
110 | + if ($this->rootFolder->nodeExists('/' . $user . '/files_versions')) { |
|
111 | + $this->rootFolder->get('/' . $user . '/files_versions')->delete(); |
|
112 | + } |
|
113 | + } |
|
114 | 114 | |
115 | 115 | } |
@@ -29,16 +29,16 @@ |
||
29 | 29 | |
30 | 30 | class Capabilities implements ICapability { |
31 | 31 | |
32 | - /** |
|
33 | - * Return this classes capabilities |
|
34 | - * |
|
35 | - * @return array |
|
36 | - */ |
|
37 | - public function getCapabilities() { |
|
38 | - return [ |
|
39 | - 'files' => [ |
|
40 | - 'versioning' => true |
|
41 | - ] |
|
42 | - ]; |
|
43 | - } |
|
32 | + /** |
|
33 | + * Return this classes capabilities |
|
34 | + * |
|
35 | + * @return array |
|
36 | + */ |
|
37 | + public function getCapabilities() { |
|
38 | + return [ |
|
39 | + 'files' => [ |
|
40 | + 'versioning' => true |
|
41 | + ] |
|
42 | + ]; |
|
43 | + } |
|
44 | 44 | } |
@@ -31,20 +31,20 @@ |
||
31 | 31 | |
32 | 32 | $application = new Application(); |
33 | 33 | $application->registerRoutes($this, [ |
34 | - 'routes' => [ |
|
35 | - [ |
|
36 | - 'name' => 'Preview#getPreview', |
|
37 | - 'url' => '/preview', |
|
38 | - 'verb' => 'GET', |
|
39 | - ], |
|
40 | - ], |
|
34 | + 'routes' => [ |
|
35 | + [ |
|
36 | + 'name' => 'Preview#getPreview', |
|
37 | + 'url' => '/preview', |
|
38 | + 'verb' => 'GET', |
|
39 | + ], |
|
40 | + ], |
|
41 | 41 | ]); |
42 | 42 | |
43 | 43 | /** @var $this \OCP\Route\IRouter */ |
44 | 44 | $this->create('files_versions_download', 'download.php') |
45 | - ->actionInclude('files_versions/download.php'); |
|
45 | + ->actionInclude('files_versions/download.php'); |
|
46 | 46 | $this->create('files_versions_ajax_getVersions', 'ajax/getVersions.php') |
47 | - ->actionInclude('files_versions/ajax/getVersions.php'); |
|
47 | + ->actionInclude('files_versions/ajax/getVersions.php'); |
|
48 | 48 | $this->create('files_versions_ajax_rollbackVersion', 'ajax/rollbackVersion.php') |
49 | - ->actionInclude('files_versions/ajax/rollbackVersion.php'); |
|
49 | + ->actionInclude('files_versions/ajax/rollbackVersion.php'); |
|
50 | 50 |
@@ -31,14 +31,14 @@ |
||
31 | 31 | */ |
32 | 32 | interface IStore { |
33 | 33 | |
34 | - /** |
|
35 | - * Get login credentials of the currently logged in user |
|
36 | - * |
|
37 | - * @since 12 |
|
38 | - * |
|
39 | - * @throws CredentialsUnavailableException |
|
40 | - * @return ICredentials the login credentials of the current user |
|
41 | - */ |
|
42 | - public function getLoginCredentials(); |
|
34 | + /** |
|
35 | + * Get login credentials of the currently logged in user |
|
36 | + * |
|
37 | + * @since 12 |
|
38 | + * |
|
39 | + * @throws CredentialsUnavailableException |
|
40 | + * @return ICredentials the login credentials of the current user |
|
41 | + */ |
|
42 | + public function getLoginCredentials(); |
|
43 | 43 | |
44 | 44 | } |
@@ -46,17 +46,17 @@ |
||
46 | 46 | */ |
47 | 47 | interface ITagManager { |
48 | 48 | |
49 | - /** |
|
50 | - * Create a new \OCP\ITags instance and load tags from db for the current user. |
|
51 | - * |
|
52 | - * @see \OCP\ITags |
|
53 | - * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
54 | - * @param array $defaultTags An array of default tags to be used if none are stored. |
|
55 | - * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
56 | - * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
57 | - * logged in user |
|
58 | - * @return \OCP\ITags |
|
59 | - * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0 |
|
60 | - */ |
|
61 | - public function load($type, $defaultTags = array(), $includeShared = false, $userId = null); |
|
49 | + /** |
|
50 | + * Create a new \OCP\ITags instance and load tags from db for the current user. |
|
51 | + * |
|
52 | + * @see \OCP\ITags |
|
53 | + * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
54 | + * @param array $defaultTags An array of default tags to be used if none are stored. |
|
55 | + * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
56 | + * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
57 | + * logged in user |
|
58 | + * @return \OCP\ITags |
|
59 | + * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0 |
|
60 | + */ |
|
61 | + public function load($type, $defaultTags = array(), $includeShared = false, $userId = null); |
|
62 | 62 | } |
@@ -32,39 +32,39 @@ |
||
32 | 32 | */ |
33 | 33 | class ConsoleEvent extends Event { |
34 | 34 | |
35 | - const EVENT_RUN = 'OC\Console\Application::run'; |
|
35 | + const EVENT_RUN = 'OC\Console\Application::run'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | 39 | |
40 | - /** @var string[] */ |
|
41 | - protected $arguments; |
|
40 | + /** @var string[] */ |
|
41 | + protected $arguments; |
|
42 | 42 | |
43 | - /** |
|
44 | - * DispatcherEvent constructor. |
|
45 | - * |
|
46 | - * @param string $event |
|
47 | - * @param string[] $arguments |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function __construct($event, array $arguments) { |
|
51 | - $this->event = $event; |
|
52 | - $this->arguments = $arguments; |
|
53 | - } |
|
43 | + /** |
|
44 | + * DispatcherEvent constructor. |
|
45 | + * |
|
46 | + * @param string $event |
|
47 | + * @param string[] $arguments |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function __construct($event, array $arguments) { |
|
51 | + $this->event = $event; |
|
52 | + $this->arguments = $arguments; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * @return string |
|
57 | - * @since 9.0.0 |
|
58 | - */ |
|
59 | - public function getEvent() { |
|
60 | - return $this->event; |
|
61 | - } |
|
55 | + /** |
|
56 | + * @return string |
|
57 | + * @since 9.0.0 |
|
58 | + */ |
|
59 | + public function getEvent() { |
|
60 | + return $this->event; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return string[] |
|
65 | - * @since 9.0.0 |
|
66 | - */ |
|
67 | - public function getArguments() { |
|
68 | - return $this->arguments; |
|
69 | - } |
|
63 | + /** |
|
64 | + * @return string[] |
|
65 | + * @since 9.0.0 |
|
66 | + */ |
|
67 | + public function getArguments() { |
|
68 | + return $this->arguments; |
|
69 | + } |
|
70 | 70 | } |
@@ -39,132 +39,132 @@ |
||
39 | 39 | * @since 8.0.0 |
40 | 40 | */ |
41 | 41 | interface IExtension { |
42 | - const METHOD_STREAM = 'stream'; |
|
43 | - const METHOD_MAIL = 'email'; |
|
42 | + const METHOD_STREAM = 'stream'; |
|
43 | + const METHOD_MAIL = 'email'; |
|
44 | 44 | |
45 | - const PRIORITY_VERYLOW = 10; |
|
46 | - const PRIORITY_LOW = 20; |
|
47 | - const PRIORITY_MEDIUM = 30; |
|
48 | - const PRIORITY_HIGH = 40; |
|
49 | - const PRIORITY_VERYHIGH = 50; |
|
45 | + const PRIORITY_VERYLOW = 10; |
|
46 | + const PRIORITY_LOW = 20; |
|
47 | + const PRIORITY_MEDIUM = 30; |
|
48 | + const PRIORITY_HIGH = 40; |
|
49 | + const PRIORITY_VERYHIGH = 50; |
|
50 | 50 | |
51 | - /** |
|
52 | - * The extension can return an array of additional notification types. |
|
53 | - * If no additional types are to be added false is to be returned |
|
54 | - * |
|
55 | - * @param string $languageCode |
|
56 | - * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
57 | - * or Array "stringID of the type" => [ |
|
58 | - * 'desc' => "translated string description for the setting" |
|
59 | - * 'methods' => [self::METHOD_*], |
|
60 | - * ] |
|
61 | - * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
62 | - */ |
|
63 | - public function getNotificationTypes($languageCode); |
|
51 | + /** |
|
52 | + * The extension can return an array of additional notification types. |
|
53 | + * If no additional types are to be added false is to be returned |
|
54 | + * |
|
55 | + * @param string $languageCode |
|
56 | + * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
57 | + * or Array "stringID of the type" => [ |
|
58 | + * 'desc' => "translated string description for the setting" |
|
59 | + * 'methods' => [self::METHOD_*], |
|
60 | + * ] |
|
61 | + * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
62 | + */ |
|
63 | + public function getNotificationTypes($languageCode); |
|
64 | 64 | |
65 | - /** |
|
66 | - * For a given method additional types to be displayed in the settings can be returned. |
|
67 | - * In case no additional types are to be added false is to be returned. |
|
68 | - * |
|
69 | - * @param string $method |
|
70 | - * @return array|false |
|
71 | - * @since 8.0.0 |
|
72 | - */ |
|
73 | - public function getDefaultTypes($method); |
|
65 | + /** |
|
66 | + * For a given method additional types to be displayed in the settings can be returned. |
|
67 | + * In case no additional types are to be added false is to be returned. |
|
68 | + * |
|
69 | + * @param string $method |
|
70 | + * @return array|false |
|
71 | + * @since 8.0.0 |
|
72 | + */ |
|
73 | + public function getDefaultTypes($method); |
|
74 | 74 | |
75 | - /** |
|
76 | - * A string naming the css class for the icon to be used can be returned. |
|
77 | - * If no icon is known for the given type false is to be returned. |
|
78 | - * |
|
79 | - * @param string $type |
|
80 | - * @return string|false |
|
81 | - * @since 8.0.0 |
|
82 | - */ |
|
83 | - public function getTypeIcon($type); |
|
75 | + /** |
|
76 | + * A string naming the css class for the icon to be used can be returned. |
|
77 | + * If no icon is known for the given type false is to be returned. |
|
78 | + * |
|
79 | + * @param string $type |
|
80 | + * @return string|false |
|
81 | + * @since 8.0.0 |
|
82 | + */ |
|
83 | + public function getTypeIcon($type); |
|
84 | 84 | |
85 | - /** |
|
86 | - * The extension can translate a given message to the requested languages. |
|
87 | - * If no translation is available false is to be returned. |
|
88 | - * |
|
89 | - * @param string $app |
|
90 | - * @param string $text |
|
91 | - * @param array $params |
|
92 | - * @param boolean $stripPath |
|
93 | - * @param boolean $highlightParams |
|
94 | - * @param string $languageCode |
|
95 | - * @return string|false |
|
96 | - * @since 8.0.0 |
|
97 | - */ |
|
98 | - public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
85 | + /** |
|
86 | + * The extension can translate a given message to the requested languages. |
|
87 | + * If no translation is available false is to be returned. |
|
88 | + * |
|
89 | + * @param string $app |
|
90 | + * @param string $text |
|
91 | + * @param array $params |
|
92 | + * @param boolean $stripPath |
|
93 | + * @param boolean $highlightParams |
|
94 | + * @param string $languageCode |
|
95 | + * @return string|false |
|
96 | + * @since 8.0.0 |
|
97 | + */ |
|
98 | + public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
99 | 99 | |
100 | - /** |
|
101 | - * The extension can define the type of parameters for translation |
|
102 | - * |
|
103 | - * Currently known types are: |
|
104 | - * * file => will strip away the path of the file and add a tooltip with it |
|
105 | - * * username => will add the avatar of the user |
|
106 | - * * email => will add a mailto link |
|
107 | - * |
|
108 | - * @param string $app |
|
109 | - * @param string $text |
|
110 | - * @return array|false |
|
111 | - * @since 8.0.0 |
|
112 | - */ |
|
113 | - public function getSpecialParameterList($app, $text); |
|
100 | + /** |
|
101 | + * The extension can define the type of parameters for translation |
|
102 | + * |
|
103 | + * Currently known types are: |
|
104 | + * * file => will strip away the path of the file and add a tooltip with it |
|
105 | + * * username => will add the avatar of the user |
|
106 | + * * email => will add a mailto link |
|
107 | + * |
|
108 | + * @param string $app |
|
109 | + * @param string $text |
|
110 | + * @return array|false |
|
111 | + * @since 8.0.0 |
|
112 | + */ |
|
113 | + public function getSpecialParameterList($app, $text); |
|
114 | 114 | |
115 | - /** |
|
116 | - * The extension can define the parameter grouping by returning the index as integer. |
|
117 | - * In case no grouping is required false is to be returned. |
|
118 | - * |
|
119 | - * @param array $activity |
|
120 | - * @return integer|false |
|
121 | - * @since 8.0.0 |
|
122 | - */ |
|
123 | - public function getGroupParameter($activity); |
|
115 | + /** |
|
116 | + * The extension can define the parameter grouping by returning the index as integer. |
|
117 | + * In case no grouping is required false is to be returned. |
|
118 | + * |
|
119 | + * @param array $activity |
|
120 | + * @return integer|false |
|
121 | + * @since 8.0.0 |
|
122 | + */ |
|
123 | + public function getGroupParameter($activity); |
|
124 | 124 | |
125 | - /** |
|
126 | - * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
127 | - * and 'apps' which hold arrays with the relevant entries. |
|
128 | - * If no further entries are to be added false is no be returned. |
|
129 | - * |
|
130 | - * @return array|false |
|
131 | - * @since 8.0.0 |
|
132 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
133 | - */ |
|
134 | - public function getNavigation(); |
|
125 | + /** |
|
126 | + * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
127 | + * and 'apps' which hold arrays with the relevant entries. |
|
128 | + * If no further entries are to be added false is no be returned. |
|
129 | + * |
|
130 | + * @return array|false |
|
131 | + * @since 8.0.0 |
|
132 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
133 | + */ |
|
134 | + public function getNavigation(); |
|
135 | 135 | |
136 | - /** |
|
137 | - * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
138 | - * |
|
139 | - * @param string $filterValue |
|
140 | - * @return boolean |
|
141 | - * @since 8.0.0 |
|
142 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
143 | - */ |
|
144 | - public function isFilterValid($filterValue); |
|
136 | + /** |
|
137 | + * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
138 | + * |
|
139 | + * @param string $filterValue |
|
140 | + * @return boolean |
|
141 | + * @since 8.0.0 |
|
142 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
143 | + */ |
|
144 | + public function isFilterValid($filterValue); |
|
145 | 145 | |
146 | - /** |
|
147 | - * The extension can filter the types based on the filter if required. |
|
148 | - * In case no filter is to be applied false is to be returned unchanged. |
|
149 | - * |
|
150 | - * @param array $types |
|
151 | - * @param string $filter |
|
152 | - * @return array|false |
|
153 | - * @since 8.0.0 |
|
154 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
155 | - */ |
|
156 | - public function filterNotificationTypes($types, $filter); |
|
146 | + /** |
|
147 | + * The extension can filter the types based on the filter if required. |
|
148 | + * In case no filter is to be applied false is to be returned unchanged. |
|
149 | + * |
|
150 | + * @param array $types |
|
151 | + * @param string $filter |
|
152 | + * @return array|false |
|
153 | + * @since 8.0.0 |
|
154 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
155 | + */ |
|
156 | + public function filterNotificationTypes($types, $filter); |
|
157 | 157 | |
158 | - /** |
|
159 | - * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
160 | - * In case the extension does not know the filter false is to be returned. |
|
161 | - * The query condition and the parameters are to be returned as array with two elements. |
|
162 | - * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
163 | - * |
|
164 | - * @param string $filter |
|
165 | - * @return array|false |
|
166 | - * @since 8.0.0 |
|
167 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
168 | - */ |
|
169 | - public function getQueryForFilter($filter); |
|
158 | + /** |
|
159 | + * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
160 | + * In case the extension does not know the filter false is to be returned. |
|
161 | + * The query condition and the parameters are to be returned as array with two elements. |
|
162 | + * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
163 | + * |
|
164 | + * @param string $filter |
|
165 | + * @return array|false |
|
166 | + * @since 8.0.0 |
|
167 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
168 | + */ |
|
169 | + public function getQueryForFilter($filter); |
|
170 | 170 | } |
@@ -29,43 +29,43 @@ |
||
29 | 29 | */ |
30 | 30 | interface IFilter { |
31 | 31 | |
32 | - /** |
|
33 | - * @return string Lowercase a-z and underscore only identifier |
|
34 | - * @since 11.0.0 |
|
35 | - */ |
|
36 | - public function getIdentifier(); |
|
32 | + /** |
|
33 | + * @return string Lowercase a-z and underscore only identifier |
|
34 | + * @since 11.0.0 |
|
35 | + */ |
|
36 | + public function getIdentifier(); |
|
37 | 37 | |
38 | - /** |
|
39 | - * @return string A translated string |
|
40 | - * @since 11.0.0 |
|
41 | - */ |
|
42 | - public function getName(); |
|
38 | + /** |
|
39 | + * @return string A translated string |
|
40 | + * @since 11.0.0 |
|
41 | + */ |
|
42 | + public function getName(); |
|
43 | 43 | |
44 | - /** |
|
45 | - * @return int whether the filter should be rather on the top or bottom of |
|
46 | - * the admin section. The filters are arranged in ascending order of the |
|
47 | - * priority values. It is required to return a value between 0 and 100. |
|
48 | - * @since 11.0.0 |
|
49 | - */ |
|
50 | - public function getPriority(); |
|
44 | + /** |
|
45 | + * @return int whether the filter should be rather on the top or bottom of |
|
46 | + * the admin section. The filters are arranged in ascending order of the |
|
47 | + * priority values. It is required to return a value between 0 and 100. |
|
48 | + * @since 11.0.0 |
|
49 | + */ |
|
50 | + public function getPriority(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return string Full URL to an icon, empty string when none is given |
|
54 | - * @since 11.0.0 |
|
55 | - */ |
|
56 | - public function getIcon(); |
|
52 | + /** |
|
53 | + * @return string Full URL to an icon, empty string when none is given |
|
54 | + * @since 11.0.0 |
|
55 | + */ |
|
56 | + public function getIcon(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param string[] $types |
|
60 | - * @return string[] An array of allowed apps from which activities should be displayed |
|
61 | - * @since 11.0.0 |
|
62 | - */ |
|
63 | - public function filterTypes(array $types); |
|
58 | + /** |
|
59 | + * @param string[] $types |
|
60 | + * @return string[] An array of allowed apps from which activities should be displayed |
|
61 | + * @since 11.0.0 |
|
62 | + */ |
|
63 | + public function filterTypes(array $types); |
|
64 | 64 | |
65 | - /** |
|
66 | - * @return string[] An array of allowed apps from which activities should be displayed |
|
67 | - * @since 11.0.0 |
|
68 | - */ |
|
69 | - public function allowedApps(); |
|
65 | + /** |
|
66 | + * @return string[] An array of allowed apps from which activities should be displayed |
|
67 | + * @since 11.0.0 |
|
68 | + */ |
|
69 | + public function allowedApps(); |
|
70 | 70 | } |
71 | 71 |