@@ -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 | } |
@@ -31,66 +31,66 @@ |
||
31 | 31 | |
32 | 32 | class ExpireVersions extends \OC\BackgroundJob\TimedJob { |
33 | 33 | |
34 | - const ITEMS_PER_SESSION = 1000; |
|
34 | + const ITEMS_PER_SESSION = 1000; |
|
35 | 35 | |
36 | - /** |
|
37 | - * @var Expiration |
|
38 | - */ |
|
39 | - private $expiration; |
|
36 | + /** |
|
37 | + * @var Expiration |
|
38 | + */ |
|
39 | + private $expiration; |
|
40 | 40 | |
41 | - /** |
|
42 | - * @var IUserManager |
|
43 | - */ |
|
44 | - private $userManager; |
|
41 | + /** |
|
42 | + * @var IUserManager |
|
43 | + */ |
|
44 | + private $userManager; |
|
45 | 45 | |
46 | - public function __construct(IUserManager $userManager = null, Expiration $expiration = null) { |
|
47 | - // Run once per 30 minutes |
|
48 | - $this->setInterval(60 * 30); |
|
46 | + public function __construct(IUserManager $userManager = null, Expiration $expiration = null) { |
|
47 | + // Run once per 30 minutes |
|
48 | + $this->setInterval(60 * 30); |
|
49 | 49 | |
50 | - if (is_null($expiration) || is_null($userManager)) { |
|
51 | - $this->fixDIForJobs(); |
|
52 | - } else { |
|
53 | - $this->expiration = $expiration; |
|
54 | - $this->userManager = $userManager; |
|
55 | - } |
|
56 | - } |
|
50 | + if (is_null($expiration) || is_null($userManager)) { |
|
51 | + $this->fixDIForJobs(); |
|
52 | + } else { |
|
53 | + $this->expiration = $expiration; |
|
54 | + $this->userManager = $userManager; |
|
55 | + } |
|
56 | + } |
|
57 | 57 | |
58 | - protected function fixDIForJobs() { |
|
59 | - $application = new Application(); |
|
60 | - $this->expiration = $application->getContainer()->query('Expiration'); |
|
61 | - $this->userManager = \OC::$server->getUserManager(); |
|
62 | - } |
|
58 | + protected function fixDIForJobs() { |
|
59 | + $application = new Application(); |
|
60 | + $this->expiration = $application->getContainer()->query('Expiration'); |
|
61 | + $this->userManager = \OC::$server->getUserManager(); |
|
62 | + } |
|
63 | 63 | |
64 | - protected function run($argument) { |
|
65 | - $maxAge = $this->expiration->getMaxAgeAsTimestamp(); |
|
66 | - if (!$maxAge) { |
|
67 | - return; |
|
68 | - } |
|
64 | + protected function run($argument) { |
|
65 | + $maxAge = $this->expiration->getMaxAgeAsTimestamp(); |
|
66 | + if (!$maxAge) { |
|
67 | + return; |
|
68 | + } |
|
69 | 69 | |
70 | - $this->userManager->callForSeenUsers(function(IUser $user) { |
|
71 | - $uid = $user->getUID(); |
|
72 | - if (!$this->setupFS($uid)) { |
|
73 | - return; |
|
74 | - } |
|
75 | - Storage::expireOlderThanMaxForUser($uid); |
|
76 | - }); |
|
77 | - } |
|
70 | + $this->userManager->callForSeenUsers(function(IUser $user) { |
|
71 | + $uid = $user->getUID(); |
|
72 | + if (!$this->setupFS($uid)) { |
|
73 | + return; |
|
74 | + } |
|
75 | + Storage::expireOlderThanMaxForUser($uid); |
|
76 | + }); |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * Act on behalf on trash item owner |
|
81 | - * @param string $user |
|
82 | - * @return boolean |
|
83 | - */ |
|
84 | - protected function setupFS($user) { |
|
85 | - \OC_Util::tearDownFS(); |
|
86 | - \OC_Util::setupFS($user); |
|
79 | + /** |
|
80 | + * Act on behalf on trash item owner |
|
81 | + * @param string $user |
|
82 | + * @return boolean |
|
83 | + */ |
|
84 | + protected function setupFS($user) { |
|
85 | + \OC_Util::tearDownFS(); |
|
86 | + \OC_Util::setupFS($user); |
|
87 | 87 | |
88 | - // Check if this user has a versions directory |
|
89 | - $view = new \OC\Files\View('/' . $user); |
|
90 | - if (!$view->is_dir('/files_versions')) { |
|
91 | - return false; |
|
92 | - } |
|
88 | + // Check if this user has a versions directory |
|
89 | + $view = new \OC\Files\View('/' . $user); |
|
90 | + if (!$view->is_dir('/files_versions')) { |
|
91 | + return false; |
|
92 | + } |
|
93 | 93 | |
94 | - return true; |
|
95 | - } |
|
94 | + return true; |
|
95 | + } |
|
96 | 96 | } |
@@ -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 | } |
@@ -32,13 +32,13 @@ |
||
32 | 32 | $revision=(int)$_GET['revision']; |
33 | 33 | |
34 | 34 | try { |
35 | - list($uid, $filename) = OCA\Files_Versions\Storage::getUidAndFilename($file); |
|
35 | + list($uid, $filename) = OCA\Files_Versions\Storage::getUidAndFilename($file); |
|
36 | 36 | } catch(\OCP\Files\NotFoundException $e) { |
37 | - header("HTTP/1.1 404 Not Found"); |
|
38 | - $tmpl = new OCP\Template('', '404', 'guest'); |
|
39 | - $tmpl->assign('file', ''); |
|
40 | - $tmpl->printPage(); |
|
41 | - exit(); |
|
37 | + header("HTTP/1.1 404 Not Found"); |
|
38 | + $tmpl = new OCP\Template('', '404', 'guest'); |
|
39 | + $tmpl->assign('file', ''); |
|
40 | + $tmpl->printPage(); |
|
41 | + exit(); |
|
42 | 42 | } |
43 | 43 | |
44 | 44 | $versionName = '/'.$uid.'/files_versions/'.$filename.'.v'.$revision; |
@@ -29,11 +29,11 @@ discard block |
||
29 | 29 | \OC_JSON::checkLoggedIn(); |
30 | 30 | |
31 | 31 | $file = $_GET['file']; |
32 | -$revision=(int)$_GET['revision']; |
|
32 | +$revision = (int) $_GET['revision']; |
|
33 | 33 | |
34 | 34 | try { |
35 | 35 | list($uid, $filename) = OCA\Files_Versions\Storage::getUidAndFilename($file); |
36 | -} catch(\OCP\Files\NotFoundException $e) { |
|
36 | +} catch (\OCP\Files\NotFoundException $e) { |
|
37 | 37 | header("HTTP/1.1 404 Not Found"); |
38 | 38 | $tmpl = new OCP\Template('', '404', 'guest'); |
39 | 39 | $tmpl->assign('file', ''); |
@@ -49,7 +49,7 @@ discard block |
||
49 | 49 | |
50 | 50 | header('Content-Type:'.$ftype); |
51 | 51 | \OC_Response::setContentDispositionHeader(basename($filename), 'attachment'); |
52 | -header('Pragma: public');// enable caching in IE |
|
52 | +header('Pragma: public'); // enable caching in IE |
|
53 | 53 | header('Expires: 0'); |
54 | 54 | header("Cache-Control: must-revalidate, post-check=0, pre-check=0"); |
55 | 55 | \OC_Response::setContentLengthHeader($view->filesize($versionName)); |
@@ -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 | } |
@@ -59,7 +59,7 @@ |
||
59 | 59 | * @return \Doctrine\DBAL\Driver\Statement The prepared statement. |
60 | 60 | * @since 6.0.0 |
61 | 61 | */ |
62 | - public function prepare($sql, $limit=null, $offset=null); |
|
62 | + public function prepare($sql, $limit = null, $offset = null); |
|
63 | 63 | |
64 | 64 | /** |
65 | 65 | * Executes an, optionally parameterized, SQL query. |
@@ -44,236 +44,236 @@ |
||
44 | 44 | * @since 6.0.0 |
45 | 45 | */ |
46 | 46 | interface IDBConnection { |
47 | - /** |
|
48 | - * Gets the QueryBuilder for the connection. |
|
49 | - * |
|
50 | - * @return \OCP\DB\QueryBuilder\IQueryBuilder |
|
51 | - * @since 8.2.0 |
|
52 | - */ |
|
53 | - public function getQueryBuilder(); |
|
47 | + /** |
|
48 | + * Gets the QueryBuilder for the connection. |
|
49 | + * |
|
50 | + * @return \OCP\DB\QueryBuilder\IQueryBuilder |
|
51 | + * @since 8.2.0 |
|
52 | + */ |
|
53 | + public function getQueryBuilder(); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Used to abstract the ownCloud database access away |
|
57 | - * @param string $sql the sql query with ? placeholder for params |
|
58 | - * @param int $limit the maximum number of rows |
|
59 | - * @param int $offset from which row we want to start |
|
60 | - * @return \Doctrine\DBAL\Driver\Statement The prepared statement. |
|
61 | - * @since 6.0.0 |
|
62 | - */ |
|
63 | - public function prepare($sql, $limit=null, $offset=null); |
|
55 | + /** |
|
56 | + * Used to abstract the ownCloud database access away |
|
57 | + * @param string $sql the sql query with ? placeholder for params |
|
58 | + * @param int $limit the maximum number of rows |
|
59 | + * @param int $offset from which row we want to start |
|
60 | + * @return \Doctrine\DBAL\Driver\Statement The prepared statement. |
|
61 | + * @since 6.0.0 |
|
62 | + */ |
|
63 | + public function prepare($sql, $limit=null, $offset=null); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Executes an, optionally parameterized, SQL query. |
|
67 | - * |
|
68 | - * If the query is parameterized, a prepared statement is used. |
|
69 | - * If an SQLLogger is configured, the execution is logged. |
|
70 | - * |
|
71 | - * @param string $query The SQL query to execute. |
|
72 | - * @param string[] $params The parameters to bind to the query, if any. |
|
73 | - * @param array $types The types the previous parameters are in. |
|
74 | - * @return \Doctrine\DBAL\Driver\Statement The executed statement. |
|
75 | - * @since 8.0.0 |
|
76 | - */ |
|
77 | - public function executeQuery($query, array $params = array(), $types = array()); |
|
65 | + /** |
|
66 | + * Executes an, optionally parameterized, SQL query. |
|
67 | + * |
|
68 | + * If the query is parameterized, a prepared statement is used. |
|
69 | + * If an SQLLogger is configured, the execution is logged. |
|
70 | + * |
|
71 | + * @param string $query The SQL query to execute. |
|
72 | + * @param string[] $params The parameters to bind to the query, if any. |
|
73 | + * @param array $types The types the previous parameters are in. |
|
74 | + * @return \Doctrine\DBAL\Driver\Statement The executed statement. |
|
75 | + * @since 8.0.0 |
|
76 | + */ |
|
77 | + public function executeQuery($query, array $params = array(), $types = array()); |
|
78 | 78 | |
79 | - /** |
|
80 | - * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters |
|
81 | - * and returns the number of affected rows. |
|
82 | - * |
|
83 | - * This method supports PDO binding types as well as DBAL mapping types. |
|
84 | - * |
|
85 | - * @param string $query The SQL query. |
|
86 | - * @param array $params The query parameters. |
|
87 | - * @param array $types The parameter types. |
|
88 | - * @return integer The number of affected rows. |
|
89 | - * @since 8.0.0 |
|
90 | - */ |
|
91 | - public function executeUpdate($query, array $params = array(), array $types = array()); |
|
79 | + /** |
|
80 | + * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters |
|
81 | + * and returns the number of affected rows. |
|
82 | + * |
|
83 | + * This method supports PDO binding types as well as DBAL mapping types. |
|
84 | + * |
|
85 | + * @param string $query The SQL query. |
|
86 | + * @param array $params The query parameters. |
|
87 | + * @param array $types The parameter types. |
|
88 | + * @return integer The number of affected rows. |
|
89 | + * @since 8.0.0 |
|
90 | + */ |
|
91 | + public function executeUpdate($query, array $params = array(), array $types = array()); |
|
92 | 92 | |
93 | - /** |
|
94 | - * Used to get the id of the just inserted element |
|
95 | - * @param string $table the name of the table where we inserted the item |
|
96 | - * @return int the id of the inserted element |
|
97 | - * @since 6.0.0 |
|
98 | - */ |
|
99 | - public function lastInsertId($table = null); |
|
93 | + /** |
|
94 | + * Used to get the id of the just inserted element |
|
95 | + * @param string $table the name of the table where we inserted the item |
|
96 | + * @return int the id of the inserted element |
|
97 | + * @since 6.0.0 |
|
98 | + */ |
|
99 | + public function lastInsertId($table = null); |
|
100 | 100 | |
101 | - /** |
|
102 | - * Insert a row if the matching row does not exists. |
|
103 | - * |
|
104 | - * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
105 | - * @param array $input data that should be inserted into the table (column name => value) |
|
106 | - * @param array|null $compare List of values that should be checked for "if not exists" |
|
107 | - * If this is null or an empty array, all keys of $input will be compared |
|
108 | - * Please note: text fields (clob) must not be used in the compare array |
|
109 | - * @return int number of inserted rows |
|
110 | - * @throws \Doctrine\DBAL\DBALException |
|
111 | - * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0 |
|
112 | - */ |
|
113 | - public function insertIfNotExist($table, $input, array $compare = null); |
|
101 | + /** |
|
102 | + * Insert a row if the matching row does not exists. |
|
103 | + * |
|
104 | + * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
105 | + * @param array $input data that should be inserted into the table (column name => value) |
|
106 | + * @param array|null $compare List of values that should be checked for "if not exists" |
|
107 | + * If this is null or an empty array, all keys of $input will be compared |
|
108 | + * Please note: text fields (clob) must not be used in the compare array |
|
109 | + * @return int number of inserted rows |
|
110 | + * @throws \Doctrine\DBAL\DBALException |
|
111 | + * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0 |
|
112 | + */ |
|
113 | + public function insertIfNotExist($table, $input, array $compare = null); |
|
114 | 114 | |
115 | - /** |
|
116 | - * Insert or update a row value |
|
117 | - * |
|
118 | - * @param string $table |
|
119 | - * @param array $keys (column name => value) |
|
120 | - * @param array $values (column name => value) |
|
121 | - * @param array $updatePreconditionValues ensure values match preconditions (column name => value) |
|
122 | - * @return int number of new rows |
|
123 | - * @throws \Doctrine\DBAL\DBALException |
|
124 | - * @throws PreconditionNotMetException |
|
125 | - * @since 9.0.0 |
|
126 | - */ |
|
127 | - public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []); |
|
115 | + /** |
|
116 | + * Insert or update a row value |
|
117 | + * |
|
118 | + * @param string $table |
|
119 | + * @param array $keys (column name => value) |
|
120 | + * @param array $values (column name => value) |
|
121 | + * @param array $updatePreconditionValues ensure values match preconditions (column name => value) |
|
122 | + * @return int number of new rows |
|
123 | + * @throws \Doctrine\DBAL\DBALException |
|
124 | + * @throws PreconditionNotMetException |
|
125 | + * @since 9.0.0 |
|
126 | + */ |
|
127 | + public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []); |
|
128 | 128 | |
129 | - /** |
|
130 | - * Create an exclusive read+write lock on a table |
|
131 | - * |
|
132 | - * Important Note: Due to the nature how locks work on different DBs, it is |
|
133 | - * only possible to lock one table at a time. You should also NOT start a |
|
134 | - * transaction while holding a lock. |
|
135 | - * |
|
136 | - * @param string $tableName |
|
137 | - * @since 9.1.0 |
|
138 | - */ |
|
139 | - public function lockTable($tableName); |
|
129 | + /** |
|
130 | + * Create an exclusive read+write lock on a table |
|
131 | + * |
|
132 | + * Important Note: Due to the nature how locks work on different DBs, it is |
|
133 | + * only possible to lock one table at a time. You should also NOT start a |
|
134 | + * transaction while holding a lock. |
|
135 | + * |
|
136 | + * @param string $tableName |
|
137 | + * @since 9.1.0 |
|
138 | + */ |
|
139 | + public function lockTable($tableName); |
|
140 | 140 | |
141 | - /** |
|
142 | - * Release a previous acquired lock again |
|
143 | - * |
|
144 | - * @since 9.1.0 |
|
145 | - */ |
|
146 | - public function unlockTable(); |
|
141 | + /** |
|
142 | + * Release a previous acquired lock again |
|
143 | + * |
|
144 | + * @since 9.1.0 |
|
145 | + */ |
|
146 | + public function unlockTable(); |
|
147 | 147 | |
148 | - /** |
|
149 | - * Start a transaction |
|
150 | - * @since 6.0.0 |
|
151 | - */ |
|
152 | - public function beginTransaction(); |
|
148 | + /** |
|
149 | + * Start a transaction |
|
150 | + * @since 6.0.0 |
|
151 | + */ |
|
152 | + public function beginTransaction(); |
|
153 | 153 | |
154 | - /** |
|
155 | - * Check if a transaction is active |
|
156 | - * |
|
157 | - * @return bool |
|
158 | - * @since 8.2.0 |
|
159 | - */ |
|
160 | - public function inTransaction(); |
|
154 | + /** |
|
155 | + * Check if a transaction is active |
|
156 | + * |
|
157 | + * @return bool |
|
158 | + * @since 8.2.0 |
|
159 | + */ |
|
160 | + public function inTransaction(); |
|
161 | 161 | |
162 | - /** |
|
163 | - * Commit the database changes done during a transaction that is in progress |
|
164 | - * @since 6.0.0 |
|
165 | - */ |
|
166 | - public function commit(); |
|
162 | + /** |
|
163 | + * Commit the database changes done during a transaction that is in progress |
|
164 | + * @since 6.0.0 |
|
165 | + */ |
|
166 | + public function commit(); |
|
167 | 167 | |
168 | - /** |
|
169 | - * Rollback the database changes done during a transaction that is in progress |
|
170 | - * @since 6.0.0 |
|
171 | - */ |
|
172 | - public function rollBack(); |
|
168 | + /** |
|
169 | + * Rollback the database changes done during a transaction that is in progress |
|
170 | + * @since 6.0.0 |
|
171 | + */ |
|
172 | + public function rollBack(); |
|
173 | 173 | |
174 | - /** |
|
175 | - * Gets the error code and message as a string for logging |
|
176 | - * @return string |
|
177 | - * @since 6.0.0 |
|
178 | - */ |
|
179 | - public function getError(); |
|
174 | + /** |
|
175 | + * Gets the error code and message as a string for logging |
|
176 | + * @return string |
|
177 | + * @since 6.0.0 |
|
178 | + */ |
|
179 | + public function getError(); |
|
180 | 180 | |
181 | - /** |
|
182 | - * Fetch the SQLSTATE associated with the last database operation. |
|
183 | - * |
|
184 | - * @return integer The last error code. |
|
185 | - * @since 8.0.0 |
|
186 | - */ |
|
187 | - public function errorCode(); |
|
181 | + /** |
|
182 | + * Fetch the SQLSTATE associated with the last database operation. |
|
183 | + * |
|
184 | + * @return integer The last error code. |
|
185 | + * @since 8.0.0 |
|
186 | + */ |
|
187 | + public function errorCode(); |
|
188 | 188 | |
189 | - /** |
|
190 | - * Fetch extended error information associated with the last database operation. |
|
191 | - * |
|
192 | - * @return array The last error information. |
|
193 | - * @since 8.0.0 |
|
194 | - */ |
|
195 | - public function errorInfo(); |
|
189 | + /** |
|
190 | + * Fetch extended error information associated with the last database operation. |
|
191 | + * |
|
192 | + * @return array The last error information. |
|
193 | + * @since 8.0.0 |
|
194 | + */ |
|
195 | + public function errorInfo(); |
|
196 | 196 | |
197 | - /** |
|
198 | - * Establishes the connection with the database. |
|
199 | - * |
|
200 | - * @return bool |
|
201 | - * @since 8.0.0 |
|
202 | - */ |
|
203 | - public function connect(); |
|
197 | + /** |
|
198 | + * Establishes the connection with the database. |
|
199 | + * |
|
200 | + * @return bool |
|
201 | + * @since 8.0.0 |
|
202 | + */ |
|
203 | + public function connect(); |
|
204 | 204 | |
205 | - /** |
|
206 | - * Close the database connection |
|
207 | - * @since 8.0.0 |
|
208 | - */ |
|
209 | - public function close(); |
|
205 | + /** |
|
206 | + * Close the database connection |
|
207 | + * @since 8.0.0 |
|
208 | + */ |
|
209 | + public function close(); |
|
210 | 210 | |
211 | - /** |
|
212 | - * Quotes a given input parameter. |
|
213 | - * |
|
214 | - * @param mixed $input Parameter to be quoted. |
|
215 | - * @param int $type Type of the parameter. |
|
216 | - * @return string The quoted parameter. |
|
217 | - * @since 8.0.0 |
|
218 | - */ |
|
219 | - public function quote($input, $type = IQueryBuilder::PARAM_STR); |
|
211 | + /** |
|
212 | + * Quotes a given input parameter. |
|
213 | + * |
|
214 | + * @param mixed $input Parameter to be quoted. |
|
215 | + * @param int $type Type of the parameter. |
|
216 | + * @return string The quoted parameter. |
|
217 | + * @since 8.0.0 |
|
218 | + */ |
|
219 | + public function quote($input, $type = IQueryBuilder::PARAM_STR); |
|
220 | 220 | |
221 | - /** |
|
222 | - * Gets the DatabasePlatform instance that provides all the metadata about |
|
223 | - * the platform this driver connects to. |
|
224 | - * |
|
225 | - * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform. |
|
226 | - * @since 8.0.0 |
|
227 | - */ |
|
228 | - public function getDatabasePlatform(); |
|
221 | + /** |
|
222 | + * Gets the DatabasePlatform instance that provides all the metadata about |
|
223 | + * the platform this driver connects to. |
|
224 | + * |
|
225 | + * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform. |
|
226 | + * @since 8.0.0 |
|
227 | + */ |
|
228 | + public function getDatabasePlatform(); |
|
229 | 229 | |
230 | - /** |
|
231 | - * Drop a table from the database if it exists |
|
232 | - * |
|
233 | - * @param string $table table name without the prefix |
|
234 | - * @since 8.0.0 |
|
235 | - */ |
|
236 | - public function dropTable($table); |
|
230 | + /** |
|
231 | + * Drop a table from the database if it exists |
|
232 | + * |
|
233 | + * @param string $table table name without the prefix |
|
234 | + * @since 8.0.0 |
|
235 | + */ |
|
236 | + public function dropTable($table); |
|
237 | 237 | |
238 | - /** |
|
239 | - * Check if a table exists |
|
240 | - * |
|
241 | - * @param string $table table name without the prefix |
|
242 | - * @return bool |
|
243 | - * @since 8.0.0 |
|
244 | - */ |
|
245 | - public function tableExists($table); |
|
238 | + /** |
|
239 | + * Check if a table exists |
|
240 | + * |
|
241 | + * @param string $table table name without the prefix |
|
242 | + * @return bool |
|
243 | + * @since 8.0.0 |
|
244 | + */ |
|
245 | + public function tableExists($table); |
|
246 | 246 | |
247 | - /** |
|
248 | - * Escape a parameter to be used in a LIKE query |
|
249 | - * |
|
250 | - * @param string $param |
|
251 | - * @return string |
|
252 | - * @since 9.0.0 |
|
253 | - */ |
|
254 | - public function escapeLikeParameter($param); |
|
247 | + /** |
|
248 | + * Escape a parameter to be used in a LIKE query |
|
249 | + * |
|
250 | + * @param string $param |
|
251 | + * @return string |
|
252 | + * @since 9.0.0 |
|
253 | + */ |
|
254 | + public function escapeLikeParameter($param); |
|
255 | 255 | |
256 | - /** |
|
257 | - * Check whether or not the current database support 4byte wide unicode |
|
258 | - * |
|
259 | - * @return bool |
|
260 | - * @since 11.0.0 |
|
261 | - */ |
|
262 | - public function supports4ByteText(); |
|
256 | + /** |
|
257 | + * Check whether or not the current database support 4byte wide unicode |
|
258 | + * |
|
259 | + * @return bool |
|
260 | + * @since 11.0.0 |
|
261 | + */ |
|
262 | + public function supports4ByteText(); |
|
263 | 263 | |
264 | - /** |
|
265 | - * Create the schema of the connected database |
|
266 | - * |
|
267 | - * @return Schema |
|
268 | - * @since 13.0.0 |
|
269 | - */ |
|
270 | - public function createSchema(); |
|
264 | + /** |
|
265 | + * Create the schema of the connected database |
|
266 | + * |
|
267 | + * @return Schema |
|
268 | + * @since 13.0.0 |
|
269 | + */ |
|
270 | + public function createSchema(); |
|
271 | 271 | |
272 | - /** |
|
273 | - * Migrate the database to the given schema |
|
274 | - * |
|
275 | - * @param Schema $toSchema |
|
276 | - * @since 13.0.0 |
|
277 | - */ |
|
278 | - public function migrateToSchema(Schema $toSchema); |
|
272 | + /** |
|
273 | + * Migrate the database to the given schema |
|
274 | + * |
|
275 | + * @param Schema $toSchema |
|
276 | + * @since 13.0.0 |
|
277 | + */ |
|
278 | + public function migrateToSchema(Schema $toSchema); |
|
279 | 279 | } |