@@ -115,7 +115,7 @@ |
||
115 | 115 | \OC_Util::setupFS($user); |
116 | 116 | |
117 | 117 | // Check if this user has a version directory |
118 | - $view = new \OC\Files\View('/' . $user); |
|
118 | + $view = new \OC\Files\View('/'.$user); |
|
119 | 119 | if (!$view->is_dir('/files_versions')) { |
120 | 120 | return false; |
121 | 121 | } |
@@ -35,93 +35,93 @@ |
||
35 | 35 | |
36 | 36 | class ExpireVersions extends Command { |
37 | 37 | |
38 | - /** |
|
39 | - * @var Expiration |
|
40 | - */ |
|
41 | - private $expiration; |
|
38 | + /** |
|
39 | + * @var Expiration |
|
40 | + */ |
|
41 | + private $expiration; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @var IUserManager |
|
45 | - */ |
|
46 | - private $userManager; |
|
43 | + /** |
|
44 | + * @var IUserManager |
|
45 | + */ |
|
46 | + private $userManager; |
|
47 | 47 | |
48 | - /** |
|
49 | - * @param IUserManager $userManager |
|
50 | - * @param Expiration $expiration |
|
51 | - */ |
|
52 | - public function __construct(IUserManager $userManager, |
|
53 | - Expiration $expiration) { |
|
54 | - parent::__construct(); |
|
48 | + /** |
|
49 | + * @param IUserManager $userManager |
|
50 | + * @param Expiration $expiration |
|
51 | + */ |
|
52 | + public function __construct(IUserManager $userManager, |
|
53 | + Expiration $expiration) { |
|
54 | + parent::__construct(); |
|
55 | 55 | |
56 | - $this->userManager = $userManager; |
|
57 | - $this->expiration = $expiration; |
|
58 | - } |
|
56 | + $this->userManager = $userManager; |
|
57 | + $this->expiration = $expiration; |
|
58 | + } |
|
59 | 59 | |
60 | - protected function configure() { |
|
61 | - $this |
|
62 | - ->setName('versions:expire') |
|
63 | - ->setDescription('Expires the users file versions') |
|
64 | - ->addArgument( |
|
65 | - 'user_id', |
|
66 | - InputArgument::OPTIONAL | InputArgument::IS_ARRAY, |
|
67 | - 'expire file versions of the given user(s), if no user is given file versions for all users will be expired.' |
|
68 | - ); |
|
69 | - } |
|
60 | + protected function configure() { |
|
61 | + $this |
|
62 | + ->setName('versions:expire') |
|
63 | + ->setDescription('Expires the users file versions') |
|
64 | + ->addArgument( |
|
65 | + 'user_id', |
|
66 | + InputArgument::OPTIONAL | InputArgument::IS_ARRAY, |
|
67 | + 'expire file versions of the given user(s), if no user is given file versions for all users will be expired.' |
|
68 | + ); |
|
69 | + } |
|
70 | 70 | |
71 | - protected function execute(InputInterface $input, OutputInterface $output) { |
|
71 | + protected function execute(InputInterface $input, OutputInterface $output) { |
|
72 | 72 | |
73 | - $maxAge = $this->expiration->getMaxAgeAsTimestamp(); |
|
74 | - if (!$maxAge) { |
|
75 | - $output->writeln("No expiry configured."); |
|
76 | - return; |
|
77 | - } |
|
73 | + $maxAge = $this->expiration->getMaxAgeAsTimestamp(); |
|
74 | + if (!$maxAge) { |
|
75 | + $output->writeln("No expiry configured."); |
|
76 | + return; |
|
77 | + } |
|
78 | 78 | |
79 | - $users = $input->getArgument('user_id'); |
|
80 | - if (!empty($users)) { |
|
81 | - foreach ($users as $user) { |
|
82 | - if ($this->userManager->userExists($user)) { |
|
83 | - $output->writeln("Remove deleted files of <info>$user</info>"); |
|
84 | - $userObject = $this->userManager->get($user); |
|
85 | - $this->expireVersionsForUser($userObject); |
|
86 | - } else { |
|
87 | - $output->writeln("<error>Unknown user $user</error>"); |
|
88 | - } |
|
89 | - } |
|
90 | - } else { |
|
91 | - $p = new ProgressBar($output); |
|
92 | - $p->start(); |
|
93 | - $this->userManager->callForSeenUsers(function(IUser $user) use ($p) { |
|
94 | - $p->advance(); |
|
95 | - $this->expireVersionsForUser($user); |
|
96 | - }); |
|
97 | - $p->finish(); |
|
98 | - $output->writeln(''); |
|
99 | - } |
|
100 | - } |
|
79 | + $users = $input->getArgument('user_id'); |
|
80 | + if (!empty($users)) { |
|
81 | + foreach ($users as $user) { |
|
82 | + if ($this->userManager->userExists($user)) { |
|
83 | + $output->writeln("Remove deleted files of <info>$user</info>"); |
|
84 | + $userObject = $this->userManager->get($user); |
|
85 | + $this->expireVersionsForUser($userObject); |
|
86 | + } else { |
|
87 | + $output->writeln("<error>Unknown user $user</error>"); |
|
88 | + } |
|
89 | + } |
|
90 | + } else { |
|
91 | + $p = new ProgressBar($output); |
|
92 | + $p->start(); |
|
93 | + $this->userManager->callForSeenUsers(function(IUser $user) use ($p) { |
|
94 | + $p->advance(); |
|
95 | + $this->expireVersionsForUser($user); |
|
96 | + }); |
|
97 | + $p->finish(); |
|
98 | + $output->writeln(''); |
|
99 | + } |
|
100 | + } |
|
101 | 101 | |
102 | - function expireVersionsForUser(IUser $user) { |
|
103 | - $uid = $user->getUID(); |
|
104 | - if (!$this->setupFS($uid)) { |
|
105 | - return; |
|
106 | - } |
|
107 | - Storage::expireOlderThanMaxForUser($uid); |
|
108 | - } |
|
102 | + function expireVersionsForUser(IUser $user) { |
|
103 | + $uid = $user->getUID(); |
|
104 | + if (!$this->setupFS($uid)) { |
|
105 | + return; |
|
106 | + } |
|
107 | + Storage::expireOlderThanMaxForUser($uid); |
|
108 | + } |
|
109 | 109 | |
110 | - /** |
|
111 | - * Act on behalf on versions item owner |
|
112 | - * @param string $user |
|
113 | - * @return boolean |
|
114 | - */ |
|
115 | - protected function setupFS($user) { |
|
116 | - \OC_Util::tearDownFS(); |
|
117 | - \OC_Util::setupFS($user); |
|
110 | + /** |
|
111 | + * Act on behalf on versions item owner |
|
112 | + * @param string $user |
|
113 | + * @return boolean |
|
114 | + */ |
|
115 | + protected function setupFS($user) { |
|
116 | + \OC_Util::tearDownFS(); |
|
117 | + \OC_Util::setupFS($user); |
|
118 | 118 | |
119 | - // Check if this user has a version directory |
|
120 | - $view = new \OC\Files\View('/' . $user); |
|
121 | - if (!$view->is_dir('/files_versions')) { |
|
122 | - return false; |
|
123 | - } |
|
119 | + // Check if this user has a version directory |
|
120 | + $view = new \OC\Files\View('/' . $user); |
|
121 | + if (!$view->is_dir('/files_versions')) { |
|
122 | + return false; |
|
123 | + } |
|
124 | 124 | |
125 | - return true; |
|
126 | - } |
|
125 | + return true; |
|
126 | + } |
|
127 | 127 | } |
@@ -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 | } |
@@ -107,8 +107,8 @@ |
||
107 | 107 | protected function deleteVersions($user) { |
108 | 108 | \OC_Util::tearDownFS(); |
109 | 109 | \OC_Util::setupFS($user); |
110 | - if ($this->rootFolder->nodeExists('/' . $user . '/files_versions')) { |
|
111 | - $this->rootFolder->get('/' . $user . '/files_versions')->delete(); |
|
110 | + if ($this->rootFolder->nodeExists('/'.$user.'/files_versions')) { |
|
111 | + $this->rootFolder->get('/'.$user.'/files_versions')->delete(); |
|
112 | 112 | } |
113 | 113 | } |
114 | 114 |
@@ -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 | } |
@@ -86,7 +86,7 @@ |
||
86 | 86 | \OC_Util::setupFS($user); |
87 | 87 | |
88 | 88 | // Check if this user has a versions directory |
89 | - $view = new \OC\Files\View('/' . $user); |
|
89 | + $view = new \OC\Files\View('/'.$user); |
|
90 | 90 | if (!$view->is_dir('/files_versions')) { |
91 | 91 | return false; |
92 | 92 | } |
@@ -26,7 +26,6 @@ |
||
26 | 26 | |
27 | 27 | use OCP\IUser; |
28 | 28 | use OCP\IUserManager; |
29 | -use OCA\Files_Versions\AppInfo\Application; |
|
30 | 29 | use OCA\Files_Versions\Storage; |
31 | 30 | use OCA\Files_Versions\Expiration; |
32 | 31 |
@@ -32,56 +32,56 @@ |
||
32 | 32 | |
33 | 33 | class ExpireVersions extends \OC\BackgroundJob\TimedJob { |
34 | 34 | |
35 | - const ITEMS_PER_SESSION = 1000; |
|
35 | + const ITEMS_PER_SESSION = 1000; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @var Expiration |
|
39 | - */ |
|
40 | - private $expiration; |
|
37 | + /** |
|
38 | + * @var Expiration |
|
39 | + */ |
|
40 | + private $expiration; |
|
41 | 41 | |
42 | - /** |
|
43 | - * @var IUserManager |
|
44 | - */ |
|
45 | - private $userManager; |
|
42 | + /** |
|
43 | + * @var IUserManager |
|
44 | + */ |
|
45 | + private $userManager; |
|
46 | 46 | |
47 | - public function __construct(IUserManager $userManager, Expiration $expiration) { |
|
48 | - // Run once per 30 minutes |
|
49 | - $this->setInterval(60 * 30); |
|
47 | + public function __construct(IUserManager $userManager, Expiration $expiration) { |
|
48 | + // Run once per 30 minutes |
|
49 | + $this->setInterval(60 * 30); |
|
50 | 50 | |
51 | - $this->expiration = $expiration; |
|
52 | - $this->userManager = $userManager; |
|
53 | - } |
|
51 | + $this->expiration = $expiration; |
|
52 | + $this->userManager = $userManager; |
|
53 | + } |
|
54 | 54 | |
55 | - protected function run($argument) { |
|
56 | - $maxAge = $this->expiration->getMaxAgeAsTimestamp(); |
|
57 | - if (!$maxAge) { |
|
58 | - return; |
|
59 | - } |
|
55 | + protected function run($argument) { |
|
56 | + $maxAge = $this->expiration->getMaxAgeAsTimestamp(); |
|
57 | + if (!$maxAge) { |
|
58 | + return; |
|
59 | + } |
|
60 | 60 | |
61 | - $this->userManager->callForSeenUsers(function(IUser $user) { |
|
62 | - $uid = $user->getUID(); |
|
63 | - if (!$this->setupFS($uid)) { |
|
64 | - return; |
|
65 | - } |
|
66 | - Storage::expireOlderThanMaxForUser($uid); |
|
67 | - }); |
|
68 | - } |
|
61 | + $this->userManager->callForSeenUsers(function(IUser $user) { |
|
62 | + $uid = $user->getUID(); |
|
63 | + if (!$this->setupFS($uid)) { |
|
64 | + return; |
|
65 | + } |
|
66 | + Storage::expireOlderThanMaxForUser($uid); |
|
67 | + }); |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * Act on behalf on trash item owner |
|
72 | - * @param string $user |
|
73 | - * @return boolean |
|
74 | - */ |
|
75 | - protected function setupFS($user) { |
|
76 | - \OC_Util::tearDownFS(); |
|
77 | - \OC_Util::setupFS($user); |
|
70 | + /** |
|
71 | + * Act on behalf on trash item owner |
|
72 | + * @param string $user |
|
73 | + * @return boolean |
|
74 | + */ |
|
75 | + protected function setupFS($user) { |
|
76 | + \OC_Util::tearDownFS(); |
|
77 | + \OC_Util::setupFS($user); |
|
78 | 78 | |
79 | - // Check if this user has a versions directory |
|
80 | - $view = new \OC\Files\View('/' . $user); |
|
81 | - if (!$view->is_dir('/files_versions')) { |
|
82 | - return false; |
|
83 | - } |
|
79 | + // Check if this user has a versions directory |
|
80 | + $view = new \OC\Files\View('/' . $user); |
|
81 | + if (!$view->is_dir('/files_versions')) { |
|
82 | + return false; |
|
83 | + } |
|
84 | 84 | |
85 | - return true; |
|
86 | - } |
|
85 | + return true; |
|
86 | + } |
|
87 | 87 | } |
@@ -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 | } |
@@ -42,11 +42,11 @@ |
||
42 | 42 | const METHOD_STREAM = 'stream'; |
43 | 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 | 51 | /** |
52 | 52 | * The extension can return an array of additional notification types. |