@@ -37,76 +37,76 @@ |
||
37 | 37 | use Symfony\Component\Console\Question\ConfirmationQuestion; |
38 | 38 | |
39 | 39 | class Delete extends Base { |
40 | - /** |
|
41 | - * @var GlobalStoragesService |
|
42 | - */ |
|
43 | - protected $globalService; |
|
40 | + /** |
|
41 | + * @var GlobalStoragesService |
|
42 | + */ |
|
43 | + protected $globalService; |
|
44 | 44 | |
45 | - /** |
|
46 | - * @var UserStoragesService |
|
47 | - */ |
|
48 | - protected $userService; |
|
45 | + /** |
|
46 | + * @var UserStoragesService |
|
47 | + */ |
|
48 | + protected $userService; |
|
49 | 49 | |
50 | - /** |
|
51 | - * @var IUserSession |
|
52 | - */ |
|
53 | - protected $userSession; |
|
50 | + /** |
|
51 | + * @var IUserSession |
|
52 | + */ |
|
53 | + protected $userSession; |
|
54 | 54 | |
55 | - /** |
|
56 | - * @var IUserManager |
|
57 | - */ |
|
58 | - protected $userManager; |
|
55 | + /** |
|
56 | + * @var IUserManager |
|
57 | + */ |
|
58 | + protected $userManager; |
|
59 | 59 | |
60 | - function __construct(GlobalStoragesService $globalService, UserStoragesService $userService, IUserSession $userSession, IUserManager $userManager) { |
|
61 | - parent::__construct(); |
|
62 | - $this->globalService = $globalService; |
|
63 | - $this->userService = $userService; |
|
64 | - $this->userSession = $userSession; |
|
65 | - $this->userManager = $userManager; |
|
66 | - } |
|
60 | + function __construct(GlobalStoragesService $globalService, UserStoragesService $userService, IUserSession $userSession, IUserManager $userManager) { |
|
61 | + parent::__construct(); |
|
62 | + $this->globalService = $globalService; |
|
63 | + $this->userService = $userService; |
|
64 | + $this->userSession = $userSession; |
|
65 | + $this->userManager = $userManager; |
|
66 | + } |
|
67 | 67 | |
68 | - protected function configure() { |
|
69 | - $this |
|
70 | - ->setName('files_external:delete') |
|
71 | - ->setDescription('Delete an external mount') |
|
72 | - ->addArgument( |
|
73 | - 'mount_id', |
|
74 | - InputArgument::REQUIRED, |
|
75 | - 'The id of the mount to edit' |
|
76 | - )->addOption( |
|
77 | - 'yes', |
|
78 | - 'y', |
|
79 | - InputOption::VALUE_NONE, |
|
80 | - 'Skip confirmation' |
|
81 | - ); |
|
82 | - parent::configure(); |
|
83 | - } |
|
68 | + protected function configure() { |
|
69 | + $this |
|
70 | + ->setName('files_external:delete') |
|
71 | + ->setDescription('Delete an external mount') |
|
72 | + ->addArgument( |
|
73 | + 'mount_id', |
|
74 | + InputArgument::REQUIRED, |
|
75 | + 'The id of the mount to edit' |
|
76 | + )->addOption( |
|
77 | + 'yes', |
|
78 | + 'y', |
|
79 | + InputOption::VALUE_NONE, |
|
80 | + 'Skip confirmation' |
|
81 | + ); |
|
82 | + parent::configure(); |
|
83 | + } |
|
84 | 84 | |
85 | - protected function execute(InputInterface $input, OutputInterface $output) { |
|
86 | - $mountId = $input->getArgument('mount_id'); |
|
87 | - try { |
|
88 | - $mount = $this->globalService->getStorage($mountId); |
|
89 | - } catch (NotFoundException $e) { |
|
90 | - $output->writeln('<error>Mount with id "' . $mountId . ' not found, check "occ files_external:list" to get available mounts"</error>'); |
|
91 | - return 404; |
|
92 | - } |
|
85 | + protected function execute(InputInterface $input, OutputInterface $output) { |
|
86 | + $mountId = $input->getArgument('mount_id'); |
|
87 | + try { |
|
88 | + $mount = $this->globalService->getStorage($mountId); |
|
89 | + } catch (NotFoundException $e) { |
|
90 | + $output->writeln('<error>Mount with id "' . $mountId . ' not found, check "occ files_external:list" to get available mounts"</error>'); |
|
91 | + return 404; |
|
92 | + } |
|
93 | 93 | |
94 | - $noConfirm = $input->getOption('yes'); |
|
94 | + $noConfirm = $input->getOption('yes'); |
|
95 | 95 | |
96 | - if (!$noConfirm) { |
|
97 | - $listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager); |
|
98 | - $listInput = new ArrayInput([], $listCommand->getDefinition()); |
|
99 | - $listInput->setOption('output', $input->getOption('output')); |
|
100 | - $listCommand->listMounts(null, [$mount], $listInput, $output); |
|
96 | + if (!$noConfirm) { |
|
97 | + $listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager); |
|
98 | + $listInput = new ArrayInput([], $listCommand->getDefinition()); |
|
99 | + $listInput->setOption('output', $input->getOption('output')); |
|
100 | + $listCommand->listMounts(null, [$mount], $listInput, $output); |
|
101 | 101 | |
102 | - $questionHelper = $this->getHelper('question'); |
|
103 | - $question = new ConfirmationQuestion('Delete this mount? [y/N] ', false); |
|
102 | + $questionHelper = $this->getHelper('question'); |
|
103 | + $question = new ConfirmationQuestion('Delete this mount? [y/N] ', false); |
|
104 | 104 | |
105 | - if (!$questionHelper->ask($input, $output, $question)) { |
|
106 | - return null; |
|
107 | - } |
|
108 | - } |
|
105 | + if (!$questionHelper->ask($input, $output, $question)) { |
|
106 | + return null; |
|
107 | + } |
|
108 | + } |
|
109 | 109 | |
110 | - $this->globalService->removeStorage($mountId); |
|
111 | - } |
|
110 | + $this->globalService->removeStorage($mountId); |
|
111 | + } |
|
112 | 112 | } |
@@ -21,62 +21,62 @@ |
||
21 | 21 | */ |
22 | 22 | |
23 | 23 | return [ |
24 | - 'routes' => [ |
|
25 | - [ |
|
26 | - 'name' => 'RateLimitTest#userAndAnonProtected', |
|
27 | - 'url' => '/userAndAnonProtected', |
|
28 | - 'verb' => 'GET', |
|
29 | - ], |
|
30 | - [ |
|
31 | - 'name' => 'RateLimitTest#onlyAnonProtected', |
|
32 | - 'url' => '/anonProtected', |
|
33 | - 'verb' => 'GET', |
|
34 | - ], |
|
35 | - ], |
|
24 | + 'routes' => [ |
|
25 | + [ |
|
26 | + 'name' => 'RateLimitTest#userAndAnonProtected', |
|
27 | + 'url' => '/userAndAnonProtected', |
|
28 | + 'verb' => 'GET', |
|
29 | + ], |
|
30 | + [ |
|
31 | + 'name' => 'RateLimitTest#onlyAnonProtected', |
|
32 | + 'url' => '/anonProtected', |
|
33 | + 'verb' => 'GET', |
|
34 | + ], |
|
35 | + ], |
|
36 | 36 | |
37 | - 'ocs' => [ |
|
38 | - [ |
|
39 | - 'name' => 'Config#setAppValue', |
|
40 | - 'url' => '/api/v1/app/{appid}/{configkey}', |
|
41 | - 'verb' => 'POST', |
|
42 | - ], |
|
43 | - [ |
|
44 | - 'name' => 'Config#deleteAppValue', |
|
45 | - 'url' => '/api/v1/app/{appid}/{configkey}', |
|
46 | - 'verb' => 'DELETE', |
|
47 | - ], |
|
48 | - [ |
|
49 | - 'name' => 'Locking#isLockingEnabled', |
|
50 | - 'url' => '/api/v1/lockprovisioning', |
|
51 | - 'verb' => 'GET', |
|
52 | - ], |
|
53 | - [ |
|
54 | - 'name' => 'Locking#isLocked', |
|
55 | - 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
56 | - 'verb' => 'GET', |
|
57 | - ], |
|
58 | - [ |
|
59 | - 'name' => 'Locking#acquireLock', |
|
60 | - 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
61 | - 'verb' => 'POST', |
|
62 | - ], |
|
63 | - [ |
|
64 | - 'name' => 'Locking#changeLock', |
|
65 | - 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
66 | - 'verb' => 'PUT', |
|
67 | - ], |
|
68 | - [ |
|
69 | - 'name' => 'Locking#releaseLock', |
|
70 | - 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
71 | - 'verb' => 'DELETE', |
|
72 | - ], |
|
73 | - [ |
|
74 | - 'name' => 'Locking#releaseAll', |
|
75 | - 'url' => '/api/v1/lockprovisioning/{type}', |
|
76 | - 'verb' => 'DELETE', |
|
77 | - 'defaults' => [ |
|
78 | - 'type' => null |
|
79 | - ] |
|
80 | - ], |
|
81 | - ], |
|
37 | + 'ocs' => [ |
|
38 | + [ |
|
39 | + 'name' => 'Config#setAppValue', |
|
40 | + 'url' => '/api/v1/app/{appid}/{configkey}', |
|
41 | + 'verb' => 'POST', |
|
42 | + ], |
|
43 | + [ |
|
44 | + 'name' => 'Config#deleteAppValue', |
|
45 | + 'url' => '/api/v1/app/{appid}/{configkey}', |
|
46 | + 'verb' => 'DELETE', |
|
47 | + ], |
|
48 | + [ |
|
49 | + 'name' => 'Locking#isLockingEnabled', |
|
50 | + 'url' => '/api/v1/lockprovisioning', |
|
51 | + 'verb' => 'GET', |
|
52 | + ], |
|
53 | + [ |
|
54 | + 'name' => 'Locking#isLocked', |
|
55 | + 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
56 | + 'verb' => 'GET', |
|
57 | + ], |
|
58 | + [ |
|
59 | + 'name' => 'Locking#acquireLock', |
|
60 | + 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
61 | + 'verb' => 'POST', |
|
62 | + ], |
|
63 | + [ |
|
64 | + 'name' => 'Locking#changeLock', |
|
65 | + 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
66 | + 'verb' => 'PUT', |
|
67 | + ], |
|
68 | + [ |
|
69 | + 'name' => 'Locking#releaseLock', |
|
70 | + 'url' => '/api/v1/lockprovisioning/{type}/{user}', |
|
71 | + 'verb' => 'DELETE', |
|
72 | + ], |
|
73 | + [ |
|
74 | + 'name' => 'Locking#releaseAll', |
|
75 | + 'url' => '/api/v1/lockprovisioning/{type}', |
|
76 | + 'verb' => 'DELETE', |
|
77 | + 'defaults' => [ |
|
78 | + 'type' => null |
|
79 | + ] |
|
80 | + ], |
|
81 | + ], |
|
82 | 82 | ]; |
@@ -36,91 +36,91 @@ |
||
36 | 36 | */ |
37 | 37 | interface IRouter { |
38 | 38 | |
39 | - /** |
|
40 | - * Get the files to load the routes from |
|
41 | - * |
|
42 | - * @return string[] |
|
43 | - * @since 7.0.0 |
|
44 | - * @deprecated 9.0.0 |
|
45 | - */ |
|
46 | - public function getRoutingFiles(); |
|
39 | + /** |
|
40 | + * Get the files to load the routes from |
|
41 | + * |
|
42 | + * @return string[] |
|
43 | + * @since 7.0.0 |
|
44 | + * @deprecated 9.0.0 |
|
45 | + */ |
|
46 | + public function getRoutingFiles(); |
|
47 | 47 | |
48 | - /** |
|
49 | - * @return string |
|
50 | - * @since 7.0.0 |
|
51 | - * @deprecated 9.0.0 |
|
52 | - */ |
|
53 | - public function getCacheKey(); |
|
48 | + /** |
|
49 | + * @return string |
|
50 | + * @since 7.0.0 |
|
51 | + * @deprecated 9.0.0 |
|
52 | + */ |
|
53 | + public function getCacheKey(); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Loads the routes |
|
57 | - * |
|
58 | - * @param null|string $app |
|
59 | - * @since 7.0.0 |
|
60 | - * @deprecated 9.0.0 |
|
61 | - */ |
|
62 | - public function loadRoutes($app = null); |
|
55 | + /** |
|
56 | + * Loads the routes |
|
57 | + * |
|
58 | + * @param null|string $app |
|
59 | + * @since 7.0.0 |
|
60 | + * @deprecated 9.0.0 |
|
61 | + */ |
|
62 | + public function loadRoutes($app = null); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sets the collection to use for adding routes |
|
66 | - * |
|
67 | - * @param string $name Name of the collection to use. |
|
68 | - * @return void |
|
69 | - * @since 7.0.0 |
|
70 | - * @deprecated 9.0.0 |
|
71 | - */ |
|
72 | - public function useCollection($name); |
|
64 | + /** |
|
65 | + * Sets the collection to use for adding routes |
|
66 | + * |
|
67 | + * @param string $name Name of the collection to use. |
|
68 | + * @return void |
|
69 | + * @since 7.0.0 |
|
70 | + * @deprecated 9.0.0 |
|
71 | + */ |
|
72 | + public function useCollection($name); |
|
73 | 73 | |
74 | - /** |
|
75 | - * returns the current collection name in use for adding routes |
|
76 | - * |
|
77 | - * @return string the collection name |
|
78 | - * @since 8.0.0 |
|
79 | - * @deprecated 9.0.0 |
|
80 | - */ |
|
81 | - public function getCurrentCollection(); |
|
74 | + /** |
|
75 | + * returns the current collection name in use for adding routes |
|
76 | + * |
|
77 | + * @return string the collection name |
|
78 | + * @since 8.0.0 |
|
79 | + * @deprecated 9.0.0 |
|
80 | + */ |
|
81 | + public function getCurrentCollection(); |
|
82 | 82 | |
83 | - /** |
|
84 | - * Create a \OCP\Route\IRoute. |
|
85 | - * |
|
86 | - * @param string $name Name of the route to create. |
|
87 | - * @param string $pattern The pattern to match |
|
88 | - * @param array $defaults An array of default parameter values |
|
89 | - * @param array $requirements An array of requirements for parameters (regexes) |
|
90 | - * @return \OCP\Route\IRoute |
|
91 | - * @since 7.0.0 |
|
92 | - * @deprecated 9.0.0 |
|
93 | - */ |
|
94 | - public function create($name, $pattern, array $defaults = [], array $requirements = []); |
|
83 | + /** |
|
84 | + * Create a \OCP\Route\IRoute. |
|
85 | + * |
|
86 | + * @param string $name Name of the route to create. |
|
87 | + * @param string $pattern The pattern to match |
|
88 | + * @param array $defaults An array of default parameter values |
|
89 | + * @param array $requirements An array of requirements for parameters (regexes) |
|
90 | + * @return \OCP\Route\IRoute |
|
91 | + * @since 7.0.0 |
|
92 | + * @deprecated 9.0.0 |
|
93 | + */ |
|
94 | + public function create($name, $pattern, array $defaults = [], array $requirements = []); |
|
95 | 95 | |
96 | - /** |
|
97 | - * Find the route matching $url. |
|
98 | - * |
|
99 | - * @param string $url The url to find |
|
100 | - * @throws \Exception |
|
101 | - * @return void |
|
102 | - * @since 7.0.0 |
|
103 | - * @deprecated 9.0.0 |
|
104 | - */ |
|
105 | - public function match($url); |
|
96 | + /** |
|
97 | + * Find the route matching $url. |
|
98 | + * |
|
99 | + * @param string $url The url to find |
|
100 | + * @throws \Exception |
|
101 | + * @return void |
|
102 | + * @since 7.0.0 |
|
103 | + * @deprecated 9.0.0 |
|
104 | + */ |
|
105 | + public function match($url); |
|
106 | 106 | |
107 | - /** |
|
108 | - * Get the url generator |
|
109 | - * |
|
110 | - * @since 7.0.0 |
|
111 | - * @deprecated 9.0.0 |
|
112 | - */ |
|
113 | - public function getGenerator(); |
|
107 | + /** |
|
108 | + * Get the url generator |
|
109 | + * |
|
110 | + * @since 7.0.0 |
|
111 | + * @deprecated 9.0.0 |
|
112 | + */ |
|
113 | + public function getGenerator(); |
|
114 | 114 | |
115 | - /** |
|
116 | - * Generate url based on $name and $parameters |
|
117 | - * |
|
118 | - * @param string $name Name of the route to use. |
|
119 | - * @param array $parameters Parameters for the route |
|
120 | - * @param bool $absolute |
|
121 | - * @return string |
|
122 | - * @since 7.0.0 |
|
123 | - * @deprecated 9.0.0 |
|
124 | - */ |
|
125 | - public function generate($name, $parameters = [], $absolute = false); |
|
115 | + /** |
|
116 | + * Generate url based on $name and $parameters |
|
117 | + * |
|
118 | + * @param string $name Name of the route to use. |
|
119 | + * @param array $parameters Parameters for the route |
|
120 | + * @param bool $absolute |
|
121 | + * @return string |
|
122 | + * @since 7.0.0 |
|
123 | + * @deprecated 9.0.0 |
|
124 | + */ |
|
125 | + public function generate($name, $parameters = [], $absolute = false); |
|
126 | 126 | } |
@@ -36,27 +36,27 @@ |
||
36 | 36 | * @since 7.0.0 |
37 | 37 | */ |
38 | 38 | class LockNotAcquiredException extends \Exception { |
39 | - /** @var string $path The path that could not be locked */ |
|
40 | - public $path; |
|
39 | + /** @var string $path The path that could not be locked */ |
|
40 | + public $path; |
|
41 | 41 | |
42 | - /** @var integer $lockType The type of the lock that was attempted */ |
|
43 | - public $lockType; |
|
42 | + /** @var integer $lockType The type of the lock that was attempted */ |
|
43 | + public $lockType; |
|
44 | 44 | |
45 | - /** |
|
46 | - * @since 7.0.0 |
|
47 | - */ |
|
48 | - public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { |
|
49 | - $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', [$lockType, $path]); |
|
50 | - parent::__construct($message, $code, $previous); |
|
51 | - } |
|
45 | + /** |
|
46 | + * @since 7.0.0 |
|
47 | + */ |
|
48 | + public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { |
|
49 | + $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', [$lockType, $path]); |
|
50 | + parent::__construct($message, $code, $previous); |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * custom string representation of object |
|
55 | - * |
|
56 | - * @return string |
|
57 | - * @since 7.0.0 |
|
58 | - */ |
|
59 | - public function __toString() { |
|
60 | - return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
61 | - } |
|
53 | + /** |
|
54 | + * custom string representation of object |
|
55 | + * |
|
56 | + * @return string |
|
57 | + * @since 7.0.0 |
|
58 | + */ |
|
59 | + public function __toString() { |
|
60 | + return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
61 | + } |
|
62 | 62 | } |
@@ -28,39 +28,39 @@ |
||
28 | 28 | * @since 8.2.0 |
29 | 29 | */ |
30 | 30 | interface ICompositeExpression { |
31 | - /** |
|
32 | - * Adds multiple parts to composite expression. |
|
33 | - * |
|
34 | - * @param array $parts |
|
35 | - * |
|
36 | - * @return ICompositeExpression |
|
37 | - * @since 8.2.0 |
|
38 | - */ |
|
39 | - public function addMultiple(array $parts = []); |
|
31 | + /** |
|
32 | + * Adds multiple parts to composite expression. |
|
33 | + * |
|
34 | + * @param array $parts |
|
35 | + * |
|
36 | + * @return ICompositeExpression |
|
37 | + * @since 8.2.0 |
|
38 | + */ |
|
39 | + public function addMultiple(array $parts = []); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Adds an expression to composite expression. |
|
43 | - * |
|
44 | - * @param mixed $part |
|
45 | - * |
|
46 | - * @return ICompositeExpression |
|
47 | - * @since 8.2.0 |
|
48 | - */ |
|
49 | - public function add($part); |
|
41 | + /** |
|
42 | + * Adds an expression to composite expression. |
|
43 | + * |
|
44 | + * @param mixed $part |
|
45 | + * |
|
46 | + * @return ICompositeExpression |
|
47 | + * @since 8.2.0 |
|
48 | + */ |
|
49 | + public function add($part); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Retrieves the amount of expressions on composite expression. |
|
53 | - * |
|
54 | - * @return integer |
|
55 | - * @since 8.2.0 |
|
56 | - */ |
|
57 | - public function count(); |
|
51 | + /** |
|
52 | + * Retrieves the amount of expressions on composite expression. |
|
53 | + * |
|
54 | + * @return integer |
|
55 | + * @since 8.2.0 |
|
56 | + */ |
|
57 | + public function count(); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns the type of this composite expression (AND/OR). |
|
61 | - * |
|
62 | - * @return string |
|
63 | - * @since 8.2.0 |
|
64 | - */ |
|
65 | - public function getType(); |
|
59 | + /** |
|
60 | + * Returns the type of this composite expression (AND/OR). |
|
61 | + * |
|
62 | + * @return string |
|
63 | + * @since 8.2.0 |
|
64 | + */ |
|
65 | + public function getType(); |
|
66 | 66 | } |
@@ -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 = [], $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 = [], $includeShared = false, $userId = null); |
|
62 | 62 | } |
@@ -32,60 +32,60 @@ |
||
32 | 32 | */ |
33 | 33 | abstract class Provider { |
34 | 34 | |
35 | - /** |
|
36 | - * @since 8.0.0 |
|
37 | - */ |
|
38 | - const OPTION_APPS = 'apps'; |
|
35 | + /** |
|
36 | + * @since 8.0.0 |
|
37 | + */ |
|
38 | + const OPTION_APPS = 'apps'; |
|
39 | 39 | |
40 | - /** |
|
41 | - * List of options |
|
42 | - * @var array |
|
43 | - * @since 7.0.0 |
|
44 | - */ |
|
45 | - protected $options; |
|
40 | + /** |
|
41 | + * List of options |
|
42 | + * @var array |
|
43 | + * @since 7.0.0 |
|
44 | + */ |
|
45 | + protected $options; |
|
46 | 46 | |
47 | - /** |
|
48 | - * Constructor |
|
49 | - * @param array $options as key => value |
|
50 | - * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
51 | - */ |
|
52 | - public function __construct($options = []) { |
|
53 | - $this->options = $options; |
|
54 | - } |
|
47 | + /** |
|
48 | + * Constructor |
|
49 | + * @param array $options as key => value |
|
50 | + * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
51 | + */ |
|
52 | + public function __construct($options = []) { |
|
53 | + $this->options = $options; |
|
54 | + } |
|
55 | 55 | |
56 | - /** |
|
57 | - * get a value from the options array or null |
|
58 | - * @param string $key |
|
59 | - * @return mixed |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function getOption($key) { |
|
63 | - if (is_array($this->options) && isset($this->options[$key])) { |
|
64 | - return $this->options[$key]; |
|
65 | - } else { |
|
66 | - return null; |
|
67 | - } |
|
68 | - } |
|
56 | + /** |
|
57 | + * get a value from the options array or null |
|
58 | + * @param string $key |
|
59 | + * @return mixed |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function getOption($key) { |
|
63 | + if (is_array($this->options) && isset($this->options[$key])) { |
|
64 | + return $this->options[$key]; |
|
65 | + } else { |
|
66 | + return null; |
|
67 | + } |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * checks if the given apps and the apps this provider has results for intersect |
|
72 | - * returns true if the given array is empty (all apps) |
|
73 | - * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
74 | - * or if the two above arrays have elements in common (intersect) |
|
75 | - * @param string[] $apps |
|
76 | - * @return bool |
|
77 | - * @since 8.0.0 |
|
78 | - */ |
|
79 | - public function providesResultsFor(array $apps = []) { |
|
80 | - $forApps = $this->getOption(self::OPTION_APPS); |
|
81 | - return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
82 | - } |
|
70 | + /** |
|
71 | + * checks if the given apps and the apps this provider has results for intersect |
|
72 | + * returns true if the given array is empty (all apps) |
|
73 | + * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
74 | + * or if the two above arrays have elements in common (intersect) |
|
75 | + * @param string[] $apps |
|
76 | + * @return bool |
|
77 | + * @since 8.0.0 |
|
78 | + */ |
|
79 | + public function providesResultsFor(array $apps = []) { |
|
80 | + $forApps = $this->getOption(self::OPTION_APPS); |
|
81 | + return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
82 | + } |
|
83 | 83 | |
84 | - /** |
|
85 | - * Search for $query |
|
86 | - * @param string $query |
|
87 | - * @return array An array of OCP\Search\Result's |
|
88 | - * @since 7.0.0 |
|
89 | - */ |
|
90 | - abstract public function search($query); |
|
84 | + /** |
|
85 | + * Search for $query |
|
86 | + * @param string $query |
|
87 | + * @return array An array of OCP\Search\Result's |
|
88 | + * @since 7.0.0 |
|
89 | + */ |
|
90 | + abstract public function search($query); |
|
91 | 91 | } |
@@ -32,14 +32,14 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class OCSNotFoundException extends OCSException { |
35 | - /** |
|
36 | - * OCSNotFoundException constructor. |
|
37 | - * |
|
38 | - * @param string $message |
|
39 | - * @param Exception|null $previous |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function __construct($message = '', Exception $previous = null) { |
|
43 | - parent::__construct($message, Http::STATUS_NOT_FOUND, $previous); |
|
44 | - } |
|
35 | + /** |
|
36 | + * OCSNotFoundException constructor. |
|
37 | + * |
|
38 | + * @param string $message |
|
39 | + * @param Exception|null $previous |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function __construct($message = '', Exception $previous = null) { |
|
43 | + parent::__construct($message, Http::STATUS_NOT_FOUND, $previous); |
|
44 | + } |
|
45 | 45 | } |
@@ -32,14 +32,14 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class OCSForbiddenException extends OCSException { |
35 | - /** |
|
36 | - * OCSForbiddenException constructor. |
|
37 | - * |
|
38 | - * @param string $message |
|
39 | - * @param Exception|null $previous |
|
40 | - * @since 9.1.0 |
|
41 | - */ |
|
42 | - public function __construct($message = '', Exception $previous = null) { |
|
43 | - parent::__construct($message, Http::STATUS_FORBIDDEN, $previous); |
|
44 | - } |
|
35 | + /** |
|
36 | + * OCSForbiddenException constructor. |
|
37 | + * |
|
38 | + * @param string $message |
|
39 | + * @param Exception|null $previous |
|
40 | + * @since 9.1.0 |
|
41 | + */ |
|
42 | + public function __construct($message = '', Exception $previous = null) { |
|
43 | + parent::__construct($message, Http::STATUS_FORBIDDEN, $previous); |
|
44 | + } |
|
45 | 45 | } |