@@ -35,46 +35,46 @@ |
||
| 35 | 35 | */ |
| 36 | 36 | class HintException extends \Exception { |
| 37 | 37 | |
| 38 | - private $hint; |
|
| 38 | + private $hint; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * HintException constructor. |
|
| 42 | - * |
|
| 43 | - * @param string $message The error message. It will be not revealed to the |
|
| 44 | - * the user (unless the hint is empty) and thus |
|
| 45 | - * should be not translated. |
|
| 46 | - * @param string $hint A useful message that is presented to the end |
|
| 47 | - * user. It should be translated, but must not |
|
| 48 | - * contain sensitive data. |
|
| 49 | - * @param int $code |
|
| 50 | - * @param \Exception|null $previous |
|
| 51 | - */ |
|
| 52 | - public function __construct($message, $hint = '', $code = 0, \Exception $previous = null) { |
|
| 53 | - $this->hint = $hint; |
|
| 54 | - parent::__construct($message, $code, $previous); |
|
| 55 | - } |
|
| 40 | + /** |
|
| 41 | + * HintException constructor. |
|
| 42 | + * |
|
| 43 | + * @param string $message The error message. It will be not revealed to the |
|
| 44 | + * the user (unless the hint is empty) and thus |
|
| 45 | + * should be not translated. |
|
| 46 | + * @param string $hint A useful message that is presented to the end |
|
| 47 | + * user. It should be translated, but must not |
|
| 48 | + * contain sensitive data. |
|
| 49 | + * @param int $code |
|
| 50 | + * @param \Exception|null $previous |
|
| 51 | + */ |
|
| 52 | + public function __construct($message, $hint = '', $code = 0, \Exception $previous = null) { |
|
| 53 | + $this->hint = $hint; |
|
| 54 | + parent::__construct($message, $code, $previous); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Returns a string representation of this Exception that includes the error |
|
| 59 | - * code, the message and the hint. |
|
| 60 | - * |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 63 | - public function __toString() { |
|
| 64 | - return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n"; |
|
| 65 | - } |
|
| 57 | + /** |
|
| 58 | + * Returns a string representation of this Exception that includes the error |
|
| 59 | + * code, the message and the hint. |
|
| 60 | + * |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | + public function __toString() { |
|
| 64 | + return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n"; |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Returns the hint with the intention to be presented to the end user. If |
|
| 69 | - * an empty hint was specified upon instatiation, the message is returned |
|
| 70 | - * instead. |
|
| 71 | - * |
|
| 72 | - * @return string |
|
| 73 | - */ |
|
| 74 | - public function getHint() { |
|
| 75 | - if (empty($this->hint)) { |
|
| 76 | - return $this->message; |
|
| 77 | - } |
|
| 78 | - return $this->hint; |
|
| 79 | - } |
|
| 67 | + /** |
|
| 68 | + * Returns the hint with the intention to be presented to the end user. If |
|
| 69 | + * an empty hint was specified upon instatiation, the message is returned |
|
| 70 | + * instead. |
|
| 71 | + * |
|
| 72 | + * @return string |
|
| 73 | + */ |
|
| 74 | + public function getHint() { |
|
| 75 | + if (empty($this->hint)) { |
|
| 76 | + return $this->message; |
|
| 77 | + } |
|
| 78 | + return $this->hint; |
|
| 79 | + } |
|
| 80 | 80 | } |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | * @return string |
| 62 | 62 | */ |
| 63 | 63 | public function __toString() { |
| 64 | - return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n"; |
|
| 64 | + return __CLASS__.": [{$this->code}]: {$this->message} ({$this->hint})\n"; |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | /** |
@@ -58,7 +58,7 @@ |
||
| 58 | 58 | use Symfony\Component\EventDispatcher\EventDispatcher; |
| 59 | 59 | use Symfony\Component\EventDispatcher\GenericEvent; |
| 60 | 60 | |
| 61 | -class Repair implements IOutput{ |
|
| 61 | +class Repair implements IOutput { |
|
| 62 | 62 | /* @var IRepairStep[] */ |
| 63 | 63 | private $repairSteps; |
| 64 | 64 | /** @var EventDispatcher */ |
@@ -57,171 +57,171 @@ |
||
| 57 | 57 | use Symfony\Component\EventDispatcher\GenericEvent; |
| 58 | 58 | |
| 59 | 59 | class Repair implements IOutput{ |
| 60 | - /* @var IRepairStep[] */ |
|
| 61 | - private $repairSteps; |
|
| 62 | - /** @var EventDispatcher */ |
|
| 63 | - private $dispatcher; |
|
| 64 | - /** @var string */ |
|
| 65 | - private $currentStep; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Creates a new repair step runner |
|
| 69 | - * |
|
| 70 | - * @param IRepairStep[] $repairSteps array of RepairStep instances |
|
| 71 | - * @param EventDispatcher $dispatcher |
|
| 72 | - */ |
|
| 73 | - public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) { |
|
| 74 | - $this->repairSteps = $repairSteps; |
|
| 75 | - $this->dispatcher = $dispatcher; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Run a series of repair steps for common problems |
|
| 80 | - */ |
|
| 81 | - public function run() { |
|
| 82 | - if (count($this->repairSteps) === 0) { |
|
| 83 | - $this->emit('\OC\Repair', 'info', array('No repair steps available')); |
|
| 84 | - return; |
|
| 85 | - } |
|
| 86 | - // run each repair step |
|
| 87 | - foreach ($this->repairSteps as $step) { |
|
| 88 | - $this->currentStep = $step->getName(); |
|
| 89 | - $this->emit('\OC\Repair', 'step', [$this->currentStep]); |
|
| 90 | - $step->run($this); |
|
| 91 | - } |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * Add repair step |
|
| 96 | - * |
|
| 97 | - * @param IRepairStep|string $repairStep repair step |
|
| 98 | - * @throws \Exception |
|
| 99 | - */ |
|
| 100 | - public function addStep($repairStep) { |
|
| 101 | - if (is_string($repairStep)) { |
|
| 102 | - try { |
|
| 103 | - $s = \OC::$server->query($repairStep); |
|
| 104 | - } catch (QueryException $e) { |
|
| 105 | - if (class_exists($repairStep)) { |
|
| 106 | - $s = new $repairStep(); |
|
| 107 | - } else { |
|
| 108 | - throw new \Exception("Repair step '$repairStep' is unknown"); |
|
| 109 | - } |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - if ($s instanceof IRepairStep) { |
|
| 113 | - $this->repairSteps[] = $s; |
|
| 114 | - } else { |
|
| 115 | - throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep"); |
|
| 116 | - } |
|
| 117 | - } else { |
|
| 118 | - $this->repairSteps[] = $repairStep; |
|
| 119 | - } |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Returns the default repair steps to be run on the |
|
| 124 | - * command line or after an upgrade. |
|
| 125 | - * |
|
| 126 | - * @return IRepairStep[] |
|
| 127 | - */ |
|
| 128 | - public static function getRepairSteps() { |
|
| 129 | - return [ |
|
| 130 | - new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false), |
|
| 131 | - new RepairMimeTypes(\OC::$server->getConfig()), |
|
| 132 | - new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()), |
|
| 133 | - new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()), |
|
| 134 | - new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()), |
|
| 135 | - new MoveUpdaterStepFile(\OC::$server->getConfig()), |
|
| 136 | - new FixMountStorages(\OC::$server->getDatabaseConnection()), |
|
| 137 | - new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), |
|
| 138 | - new AddLogRotateJob(\OC::$server->getJobList()), |
|
| 139 | - new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)), |
|
| 140 | - new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()), |
|
| 141 | - new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()), |
|
| 142 | - new RepairPendingCronJobs(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), |
|
| 143 | - new SetVcardDatabaseUID(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), |
|
| 144 | - ]; |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * Returns expensive repair steps to be run on the |
|
| 149 | - * command line with a special option. |
|
| 150 | - * |
|
| 151 | - * @return IRepairStep[] |
|
| 152 | - */ |
|
| 153 | - public static function getExpensiveRepairSteps() { |
|
| 154 | - return [ |
|
| 155 | - new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()), |
|
| 156 | - ]; |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * Returns the repair steps to be run before an |
|
| 161 | - * upgrade. |
|
| 162 | - * |
|
| 163 | - * @return IRepairStep[] |
|
| 164 | - */ |
|
| 165 | - public static function getBeforeUpgradeRepairSteps() { |
|
| 166 | - $connection = \OC::$server->getDatabaseConnection(); |
|
| 167 | - $config = \OC::$server->getConfig(); |
|
| 168 | - $steps = [ |
|
| 169 | - new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true), |
|
| 170 | - new SqliteAutoincrement($connection), |
|
| 171 | - new SaveAccountsTableData($connection, $config), |
|
| 172 | - new DropAccountTermsTable($connection), |
|
| 173 | - ]; |
|
| 174 | - |
|
| 175 | - return $steps; |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * @param string $scope |
|
| 180 | - * @param string $method |
|
| 181 | - * @param array $arguments |
|
| 182 | - */ |
|
| 183 | - public function emit($scope, $method, array $arguments = []) { |
|
| 184 | - if (!is_null($this->dispatcher)) { |
|
| 185 | - $this->dispatcher->dispatch("$scope::$method", |
|
| 186 | - new GenericEvent("$scope::$method", $arguments)); |
|
| 187 | - } |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - public function info($string) { |
|
| 191 | - // for now just emit as we did in the past |
|
| 192 | - $this->emit('\OC\Repair', 'info', array($string)); |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * @param string $message |
|
| 197 | - */ |
|
| 198 | - public function warning($message) { |
|
| 199 | - // for now just emit as we did in the past |
|
| 200 | - $this->emit('\OC\Repair', 'warning', [$message]); |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * @param int $max |
|
| 205 | - */ |
|
| 206 | - public function startProgress($max = 0) { |
|
| 207 | - // for now just emit as we did in the past |
|
| 208 | - $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]); |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - /** |
|
| 212 | - * @param int $step |
|
| 213 | - * @param string $description |
|
| 214 | - */ |
|
| 215 | - public function advance($step = 1, $description = '') { |
|
| 216 | - // for now just emit as we did in the past |
|
| 217 | - $this->emit('\OC\Repair', 'advance', [$step, $description]); |
|
| 218 | - } |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * @param int $max |
|
| 222 | - */ |
|
| 223 | - public function finishProgress() { |
|
| 224 | - // for now just emit as we did in the past |
|
| 225 | - $this->emit('\OC\Repair', 'finishProgress', []); |
|
| 226 | - } |
|
| 60 | + /* @var IRepairStep[] */ |
|
| 61 | + private $repairSteps; |
|
| 62 | + /** @var EventDispatcher */ |
|
| 63 | + private $dispatcher; |
|
| 64 | + /** @var string */ |
|
| 65 | + private $currentStep; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Creates a new repair step runner |
|
| 69 | + * |
|
| 70 | + * @param IRepairStep[] $repairSteps array of RepairStep instances |
|
| 71 | + * @param EventDispatcher $dispatcher |
|
| 72 | + */ |
|
| 73 | + public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) { |
|
| 74 | + $this->repairSteps = $repairSteps; |
|
| 75 | + $this->dispatcher = $dispatcher; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Run a series of repair steps for common problems |
|
| 80 | + */ |
|
| 81 | + public function run() { |
|
| 82 | + if (count($this->repairSteps) === 0) { |
|
| 83 | + $this->emit('\OC\Repair', 'info', array('No repair steps available')); |
|
| 84 | + return; |
|
| 85 | + } |
|
| 86 | + // run each repair step |
|
| 87 | + foreach ($this->repairSteps as $step) { |
|
| 88 | + $this->currentStep = $step->getName(); |
|
| 89 | + $this->emit('\OC\Repair', 'step', [$this->currentStep]); |
|
| 90 | + $step->run($this); |
|
| 91 | + } |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * Add repair step |
|
| 96 | + * |
|
| 97 | + * @param IRepairStep|string $repairStep repair step |
|
| 98 | + * @throws \Exception |
|
| 99 | + */ |
|
| 100 | + public function addStep($repairStep) { |
|
| 101 | + if (is_string($repairStep)) { |
|
| 102 | + try { |
|
| 103 | + $s = \OC::$server->query($repairStep); |
|
| 104 | + } catch (QueryException $e) { |
|
| 105 | + if (class_exists($repairStep)) { |
|
| 106 | + $s = new $repairStep(); |
|
| 107 | + } else { |
|
| 108 | + throw new \Exception("Repair step '$repairStep' is unknown"); |
|
| 109 | + } |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + if ($s instanceof IRepairStep) { |
|
| 113 | + $this->repairSteps[] = $s; |
|
| 114 | + } else { |
|
| 115 | + throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep"); |
|
| 116 | + } |
|
| 117 | + } else { |
|
| 118 | + $this->repairSteps[] = $repairStep; |
|
| 119 | + } |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Returns the default repair steps to be run on the |
|
| 124 | + * command line or after an upgrade. |
|
| 125 | + * |
|
| 126 | + * @return IRepairStep[] |
|
| 127 | + */ |
|
| 128 | + public static function getRepairSteps() { |
|
| 129 | + return [ |
|
| 130 | + new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false), |
|
| 131 | + new RepairMimeTypes(\OC::$server->getConfig()), |
|
| 132 | + new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()), |
|
| 133 | + new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()), |
|
| 134 | + new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()), |
|
| 135 | + new MoveUpdaterStepFile(\OC::$server->getConfig()), |
|
| 136 | + new FixMountStorages(\OC::$server->getDatabaseConnection()), |
|
| 137 | + new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), |
|
| 138 | + new AddLogRotateJob(\OC::$server->getJobList()), |
|
| 139 | + new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)), |
|
| 140 | + new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()), |
|
| 141 | + new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()), |
|
| 142 | + new RepairPendingCronJobs(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), |
|
| 143 | + new SetVcardDatabaseUID(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), |
|
| 144 | + ]; |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * Returns expensive repair steps to be run on the |
|
| 149 | + * command line with a special option. |
|
| 150 | + * |
|
| 151 | + * @return IRepairStep[] |
|
| 152 | + */ |
|
| 153 | + public static function getExpensiveRepairSteps() { |
|
| 154 | + return [ |
|
| 155 | + new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()), |
|
| 156 | + ]; |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * Returns the repair steps to be run before an |
|
| 161 | + * upgrade. |
|
| 162 | + * |
|
| 163 | + * @return IRepairStep[] |
|
| 164 | + */ |
|
| 165 | + public static function getBeforeUpgradeRepairSteps() { |
|
| 166 | + $connection = \OC::$server->getDatabaseConnection(); |
|
| 167 | + $config = \OC::$server->getConfig(); |
|
| 168 | + $steps = [ |
|
| 169 | + new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true), |
|
| 170 | + new SqliteAutoincrement($connection), |
|
| 171 | + new SaveAccountsTableData($connection, $config), |
|
| 172 | + new DropAccountTermsTable($connection), |
|
| 173 | + ]; |
|
| 174 | + |
|
| 175 | + return $steps; |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * @param string $scope |
|
| 180 | + * @param string $method |
|
| 181 | + * @param array $arguments |
|
| 182 | + */ |
|
| 183 | + public function emit($scope, $method, array $arguments = []) { |
|
| 184 | + if (!is_null($this->dispatcher)) { |
|
| 185 | + $this->dispatcher->dispatch("$scope::$method", |
|
| 186 | + new GenericEvent("$scope::$method", $arguments)); |
|
| 187 | + } |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + public function info($string) { |
|
| 191 | + // for now just emit as we did in the past |
|
| 192 | + $this->emit('\OC\Repair', 'info', array($string)); |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * @param string $message |
|
| 197 | + */ |
|
| 198 | + public function warning($message) { |
|
| 199 | + // for now just emit as we did in the past |
|
| 200 | + $this->emit('\OC\Repair', 'warning', [$message]); |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * @param int $max |
|
| 205 | + */ |
|
| 206 | + public function startProgress($max = 0) { |
|
| 207 | + // for now just emit as we did in the past |
|
| 208 | + $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]); |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + /** |
|
| 212 | + * @param int $step |
|
| 213 | + * @param string $description |
|
| 214 | + */ |
|
| 215 | + public function advance($step = 1, $description = '') { |
|
| 216 | + // for now just emit as we did in the past |
|
| 217 | + $this->emit('\OC\Repair', 'advance', [$step, $description]); |
|
| 218 | + } |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * @param int $max |
|
| 222 | + */ |
|
| 223 | + public function finishProgress() { |
|
| 224 | + // for now just emit as we did in the past |
|
| 225 | + $this->emit('\OC\Repair', 'finishProgress', []); |
|
| 226 | + } |
|
| 227 | 227 | } |
@@ -29,136 +29,136 @@ |
||
| 29 | 29 | * capabilities. |
| 30 | 30 | */ |
| 31 | 31 | abstract class Backend implements UserInterface { |
| 32 | - /** |
|
| 33 | - * error code for functions not provided by the user backend |
|
| 34 | - */ |
|
| 35 | - const NOT_IMPLEMENTED = -501; |
|
| 32 | + /** |
|
| 33 | + * error code for functions not provided by the user backend |
|
| 34 | + */ |
|
| 35 | + const NOT_IMPLEMENTED = -501; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * actions that user backends can define |
|
| 39 | - */ |
|
| 40 | - const CREATE_USER = 1; // 1 << 0 |
|
| 41 | - const SET_PASSWORD = 16; // 1 << 4 |
|
| 42 | - const CHECK_PASSWORD = 256; // 1 << 8 |
|
| 43 | - const GET_HOME = 4096; // 1 << 12 |
|
| 44 | - const GET_DISPLAYNAME = 65536; // 1 << 16 |
|
| 45 | - const SET_DISPLAYNAME = 1048576; // 1 << 20 |
|
| 46 | - const PROVIDE_AVATAR = 16777216; // 1 << 24 |
|
| 47 | - const COUNT_USERS = 268435456; // 1 << 28 |
|
| 37 | + /** |
|
| 38 | + * actions that user backends can define |
|
| 39 | + */ |
|
| 40 | + const CREATE_USER = 1; // 1 << 0 |
|
| 41 | + const SET_PASSWORD = 16; // 1 << 4 |
|
| 42 | + const CHECK_PASSWORD = 256; // 1 << 8 |
|
| 43 | + const GET_HOME = 4096; // 1 << 12 |
|
| 44 | + const GET_DISPLAYNAME = 65536; // 1 << 16 |
|
| 45 | + const SET_DISPLAYNAME = 1048576; // 1 << 20 |
|
| 46 | + const PROVIDE_AVATAR = 16777216; // 1 << 24 |
|
| 47 | + const COUNT_USERS = 268435456; // 1 << 28 |
|
| 48 | 48 | |
| 49 | - protected $possibleActions = array( |
|
| 50 | - self::CREATE_USER => 'createUser', |
|
| 51 | - self::SET_PASSWORD => 'setPassword', |
|
| 52 | - self::CHECK_PASSWORD => 'checkPassword', |
|
| 53 | - self::GET_HOME => 'getHome', |
|
| 54 | - self::GET_DISPLAYNAME => 'getDisplayName', |
|
| 55 | - self::SET_DISPLAYNAME => 'setDisplayName', |
|
| 56 | - self::PROVIDE_AVATAR => 'canChangeAvatar', |
|
| 57 | - self::COUNT_USERS => 'countUsers', |
|
| 58 | - ); |
|
| 49 | + protected $possibleActions = array( |
|
| 50 | + self::CREATE_USER => 'createUser', |
|
| 51 | + self::SET_PASSWORD => 'setPassword', |
|
| 52 | + self::CHECK_PASSWORD => 'checkPassword', |
|
| 53 | + self::GET_HOME => 'getHome', |
|
| 54 | + self::GET_DISPLAYNAME => 'getDisplayName', |
|
| 55 | + self::SET_DISPLAYNAME => 'setDisplayName', |
|
| 56 | + self::PROVIDE_AVATAR => 'canChangeAvatar', |
|
| 57 | + self::COUNT_USERS => 'countUsers', |
|
| 58 | + ); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Get all supported actions |
|
| 62 | - * @return int bitwise-or'ed actions |
|
| 63 | - * |
|
| 64 | - * Returns the supported actions as int to be |
|
| 65 | - * compared with self::CREATE_USER etc. |
|
| 66 | - */ |
|
| 67 | - public function getSupportedActions() { |
|
| 68 | - $actions = 0; |
|
| 69 | - foreach($this->possibleActions AS $action => $methodName) { |
|
| 70 | - if(method_exists($this, $methodName)) { |
|
| 71 | - $actions |= $action; |
|
| 72 | - } |
|
| 73 | - } |
|
| 60 | + /** |
|
| 61 | + * Get all supported actions |
|
| 62 | + * @return int bitwise-or'ed actions |
|
| 63 | + * |
|
| 64 | + * Returns the supported actions as int to be |
|
| 65 | + * compared with self::CREATE_USER etc. |
|
| 66 | + */ |
|
| 67 | + public function getSupportedActions() { |
|
| 68 | + $actions = 0; |
|
| 69 | + foreach($this->possibleActions AS $action => $methodName) { |
|
| 70 | + if(method_exists($this, $methodName)) { |
|
| 71 | + $actions |= $action; |
|
| 72 | + } |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - return $actions; |
|
| 76 | - } |
|
| 75 | + return $actions; |
|
| 76 | + } |
|
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Check if backend implements actions |
|
| 80 | - * @param int $actions bitwise-or'ed actions |
|
| 81 | - * @return boolean |
|
| 82 | - * |
|
| 83 | - * Returns the supported actions as int to be |
|
| 84 | - * compared with self::CREATE_USER etc. |
|
| 85 | - */ |
|
| 86 | - public function implementsActions($actions) { |
|
| 87 | - return (bool)($this->getSupportedActions() & $actions); |
|
| 88 | - } |
|
| 78 | + /** |
|
| 79 | + * Check if backend implements actions |
|
| 80 | + * @param int $actions bitwise-or'ed actions |
|
| 81 | + * @return boolean |
|
| 82 | + * |
|
| 83 | + * Returns the supported actions as int to be |
|
| 84 | + * compared with self::CREATE_USER etc. |
|
| 85 | + */ |
|
| 86 | + public function implementsActions($actions) { |
|
| 87 | + return (bool)($this->getSupportedActions() & $actions); |
|
| 88 | + } |
|
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * delete a user |
|
| 92 | - * @param string $uid The username of the user to delete |
|
| 93 | - * @return bool |
|
| 94 | - * |
|
| 95 | - * Deletes a user |
|
| 96 | - */ |
|
| 97 | - public function deleteUser( $uid ) { |
|
| 98 | - return false; |
|
| 99 | - } |
|
| 90 | + /** |
|
| 91 | + * delete a user |
|
| 92 | + * @param string $uid The username of the user to delete |
|
| 93 | + * @return bool |
|
| 94 | + * |
|
| 95 | + * Deletes a user |
|
| 96 | + */ |
|
| 97 | + public function deleteUser( $uid ) { |
|
| 98 | + return false; |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Get a list of all users |
|
| 103 | - * |
|
| 104 | - * @param string $search |
|
| 105 | - * @param null|int $limit |
|
| 106 | - * @param null|int $offset |
|
| 107 | - * @return string[] an array of all uids |
|
| 108 | - */ |
|
| 109 | - public function getUsers($search = '', $limit = null, $offset = null) { |
|
| 110 | - return array(); |
|
| 111 | - } |
|
| 101 | + /** |
|
| 102 | + * Get a list of all users |
|
| 103 | + * |
|
| 104 | + * @param string $search |
|
| 105 | + * @param null|int $limit |
|
| 106 | + * @param null|int $offset |
|
| 107 | + * @return string[] an array of all uids |
|
| 108 | + */ |
|
| 109 | + public function getUsers($search = '', $limit = null, $offset = null) { |
|
| 110 | + return array(); |
|
| 111 | + } |
|
| 112 | 112 | |
| 113 | - /** |
|
| 114 | - * check if a user exists |
|
| 115 | - * @param string $uid the username |
|
| 116 | - * @return boolean |
|
| 117 | - */ |
|
| 118 | - public function userExists($uid) { |
|
| 119 | - return false; |
|
| 120 | - } |
|
| 113 | + /** |
|
| 114 | + * check if a user exists |
|
| 115 | + * @param string $uid the username |
|
| 116 | + * @return boolean |
|
| 117 | + */ |
|
| 118 | + public function userExists($uid) { |
|
| 119 | + return false; |
|
| 120 | + } |
|
| 121 | 121 | |
| 122 | - /** |
|
| 123 | - * get the user's home directory |
|
| 124 | - * @param string $uid the username |
|
| 125 | - * @return boolean |
|
| 126 | - */ |
|
| 127 | - public function getHome($uid) { |
|
| 128 | - return false; |
|
| 129 | - } |
|
| 122 | + /** |
|
| 123 | + * get the user's home directory |
|
| 124 | + * @param string $uid the username |
|
| 125 | + * @return boolean |
|
| 126 | + */ |
|
| 127 | + public function getHome($uid) { |
|
| 128 | + return false; |
|
| 129 | + } |
|
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * get display name of the user |
|
| 133 | - * @param string $uid user ID of the user |
|
| 134 | - * @return string display name |
|
| 135 | - */ |
|
| 136 | - public function getDisplayName($uid) { |
|
| 137 | - return $uid; |
|
| 138 | - } |
|
| 131 | + /** |
|
| 132 | + * get display name of the user |
|
| 133 | + * @param string $uid user ID of the user |
|
| 134 | + * @return string display name |
|
| 135 | + */ |
|
| 136 | + public function getDisplayName($uid) { |
|
| 137 | + return $uid; |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - /** |
|
| 141 | - * Get a list of all display names and user ids. |
|
| 142 | - * |
|
| 143 | - * @param string $search |
|
| 144 | - * @param string|null $limit |
|
| 145 | - * @param string|null $offset |
|
| 146 | - * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
| 147 | - */ |
|
| 148 | - public function getDisplayNames($search = '', $limit = null, $offset = null) { |
|
| 149 | - $displayNames = array(); |
|
| 150 | - $users = $this->getUsers($search, $limit, $offset); |
|
| 151 | - foreach ( $users as $user) { |
|
| 152 | - $displayNames[$user] = $user; |
|
| 153 | - } |
|
| 154 | - return $displayNames; |
|
| 155 | - } |
|
| 140 | + /** |
|
| 141 | + * Get a list of all display names and user ids. |
|
| 142 | + * |
|
| 143 | + * @param string $search |
|
| 144 | + * @param string|null $limit |
|
| 145 | + * @param string|null $offset |
|
| 146 | + * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
| 147 | + */ |
|
| 148 | + public function getDisplayNames($search = '', $limit = null, $offset = null) { |
|
| 149 | + $displayNames = array(); |
|
| 150 | + $users = $this->getUsers($search, $limit, $offset); |
|
| 151 | + foreach ( $users as $user) { |
|
| 152 | + $displayNames[$user] = $user; |
|
| 153 | + } |
|
| 154 | + return $displayNames; |
|
| 155 | + } |
|
| 156 | 156 | |
| 157 | - /** |
|
| 158 | - * Check if a user list is available or not |
|
| 159 | - * @return boolean if users can be listed or not |
|
| 160 | - */ |
|
| 161 | - public function hasUserListings() { |
|
| 162 | - return false; |
|
| 163 | - } |
|
| 157 | + /** |
|
| 158 | + * Check if a user list is available or not |
|
| 159 | + * @return boolean if users can be listed or not |
|
| 160 | + */ |
|
| 161 | + public function hasUserListings() { |
|
| 162 | + return false; |
|
| 163 | + } |
|
| 164 | 164 | } |
@@ -37,14 +37,14 @@ discard block |
||
| 37 | 37 | /** |
| 38 | 38 | * actions that user backends can define |
| 39 | 39 | */ |
| 40 | - const CREATE_USER = 1; // 1 << 0 |
|
| 41 | - const SET_PASSWORD = 16; // 1 << 4 |
|
| 42 | - const CHECK_PASSWORD = 256; // 1 << 8 |
|
| 43 | - const GET_HOME = 4096; // 1 << 12 |
|
| 44 | - const GET_DISPLAYNAME = 65536; // 1 << 16 |
|
| 45 | - const SET_DISPLAYNAME = 1048576; // 1 << 20 |
|
| 46 | - const PROVIDE_AVATAR = 16777216; // 1 << 24 |
|
| 47 | - const COUNT_USERS = 268435456; // 1 << 28 |
|
| 40 | + const CREATE_USER = 1; // 1 << 0 |
|
| 41 | + const SET_PASSWORD = 16; // 1 << 4 |
|
| 42 | + const CHECK_PASSWORD = 256; // 1 << 8 |
|
| 43 | + const GET_HOME = 4096; // 1 << 12 |
|
| 44 | + const GET_DISPLAYNAME = 65536; // 1 << 16 |
|
| 45 | + const SET_DISPLAYNAME = 1048576; // 1 << 20 |
|
| 46 | + const PROVIDE_AVATAR = 16777216; // 1 << 24 |
|
| 47 | + const COUNT_USERS = 268435456; // 1 << 28 |
|
| 48 | 48 | |
| 49 | 49 | protected $possibleActions = array( |
| 50 | 50 | self::CREATE_USER => 'createUser', |
@@ -66,8 +66,8 @@ discard block |
||
| 66 | 66 | */ |
| 67 | 67 | public function getSupportedActions() { |
| 68 | 68 | $actions = 0; |
| 69 | - foreach($this->possibleActions AS $action => $methodName) { |
|
| 70 | - if(method_exists($this, $methodName)) { |
|
| 69 | + foreach ($this->possibleActions AS $action => $methodName) { |
|
| 70 | + if (method_exists($this, $methodName)) { |
|
| 71 | 71 | $actions |= $action; |
| 72 | 72 | } |
| 73 | 73 | } |
@@ -84,7 +84,7 @@ discard block |
||
| 84 | 84 | * compared with self::CREATE_USER etc. |
| 85 | 85 | */ |
| 86 | 86 | public function implementsActions($actions) { |
| 87 | - return (bool)($this->getSupportedActions() & $actions); |
|
| 87 | + return (bool) ($this->getSupportedActions() & $actions); |
|
| 88 | 88 | } |
| 89 | 89 | |
| 90 | 90 | /** |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | * |
| 95 | 95 | * Deletes a user |
| 96 | 96 | */ |
| 97 | - public function deleteUser( $uid ) { |
|
| 97 | + public function deleteUser($uid) { |
|
| 98 | 98 | return false; |
| 99 | 99 | } |
| 100 | 100 | |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | public function getDisplayNames($search = '', $limit = null, $offset = null) { |
| 149 | 149 | $displayNames = array(); |
| 150 | 150 | $users = $this->getUsers($search, $limit, $offset); |
| 151 | - foreach ( $users as $user) { |
|
| 151 | + foreach ($users as $user) { |
|
| 152 | 152 | $displayNames[$user] = $user; |
| 153 | 153 | } |
| 154 | 154 | return $displayNames; |
@@ -26,79 +26,79 @@ |
||
| 26 | 26 | use OCP\Diagnostics\IEvent; |
| 27 | 27 | |
| 28 | 28 | class Event implements IEvent { |
| 29 | - /** |
|
| 30 | - * @var string |
|
| 31 | - */ |
|
| 32 | - protected $id; |
|
| 29 | + /** |
|
| 30 | + * @var string |
|
| 31 | + */ |
|
| 32 | + protected $id; |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var float |
|
| 36 | - */ |
|
| 37 | - protected $start; |
|
| 34 | + /** |
|
| 35 | + * @var float |
|
| 36 | + */ |
|
| 37 | + protected $start; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var float |
|
| 41 | - */ |
|
| 42 | - protected $end; |
|
| 39 | + /** |
|
| 40 | + * @var float |
|
| 41 | + */ |
|
| 42 | + protected $end; |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var string |
|
| 46 | - */ |
|
| 47 | - protected $description; |
|
| 44 | + /** |
|
| 45 | + * @var string |
|
| 46 | + */ |
|
| 47 | + protected $description; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @param string $id |
|
| 51 | - * @param string $description |
|
| 52 | - * @param float $start |
|
| 53 | - */ |
|
| 54 | - public function __construct($id, $description, $start) { |
|
| 55 | - $this->id = $id; |
|
| 56 | - $this->description = $description; |
|
| 57 | - $this->start = $start; |
|
| 58 | - } |
|
| 49 | + /** |
|
| 50 | + * @param string $id |
|
| 51 | + * @param string $description |
|
| 52 | + * @param float $start |
|
| 53 | + */ |
|
| 54 | + public function __construct($id, $description, $start) { |
|
| 55 | + $this->id = $id; |
|
| 56 | + $this->description = $description; |
|
| 57 | + $this->start = $start; |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @param float $time |
|
| 62 | - */ |
|
| 63 | - public function end($time) { |
|
| 64 | - $this->end = $time; |
|
| 65 | - } |
|
| 60 | + /** |
|
| 61 | + * @param float $time |
|
| 62 | + */ |
|
| 63 | + public function end($time) { |
|
| 64 | + $this->end = $time; |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * @return float |
|
| 69 | - */ |
|
| 70 | - public function getStart() { |
|
| 71 | - return $this->start; |
|
| 72 | - } |
|
| 67 | + /** |
|
| 68 | + * @return float |
|
| 69 | + */ |
|
| 70 | + public function getStart() { |
|
| 71 | + return $this->start; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @return string |
|
| 76 | - */ |
|
| 77 | - public function getId() { |
|
| 78 | - return $this->id; |
|
| 79 | - } |
|
| 74 | + /** |
|
| 75 | + * @return string |
|
| 76 | + */ |
|
| 77 | + public function getId() { |
|
| 78 | + return $this->id; |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @return string |
|
| 83 | - */ |
|
| 84 | - public function getDescription() { |
|
| 85 | - return $this->description; |
|
| 86 | - } |
|
| 81 | + /** |
|
| 82 | + * @return string |
|
| 83 | + */ |
|
| 84 | + public function getDescription() { |
|
| 85 | + return $this->description; |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * @return float |
|
| 90 | - */ |
|
| 91 | - public function getEnd() { |
|
| 92 | - return $this->end; |
|
| 93 | - } |
|
| 88 | + /** |
|
| 89 | + * @return float |
|
| 90 | + */ |
|
| 91 | + public function getEnd() { |
|
| 92 | + return $this->end; |
|
| 93 | + } |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * @return float |
|
| 97 | - */ |
|
| 98 | - public function getDuration() { |
|
| 99 | - if (!$this->end) { |
|
| 100 | - $this->end = microtime(true); |
|
| 101 | - } |
|
| 102 | - return $this->end - $this->start; |
|
| 103 | - } |
|
| 95 | + /** |
|
| 96 | + * @return float |
|
| 97 | + */ |
|
| 98 | + public function getDuration() { |
|
| 99 | + if (!$this->end) { |
|
| 100 | + $this->end = microtime(true); |
|
| 101 | + } |
|
| 102 | + return $this->end - $this->start; |
|
| 103 | + } |
|
| 104 | 104 | } |
@@ -50,12 +50,12 @@ discard block |
||
| 50 | 50 | * @return array An array of Tag objects. |
| 51 | 51 | */ |
| 52 | 52 | public function loadTags($owners, $type) { |
| 53 | - if(!is_array($owners)) { |
|
| 53 | + if (!is_array($owners)) { |
|
| 54 | 54 | $owners = array($owners); |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` ' |
|
| 58 | - . 'WHERE `uid` IN (' . str_repeat('?,', count($owners)-1) . '?) AND `type` = ? ORDER BY `category`'; |
|
| 57 | + $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `'.$this->getTableName().'` ' |
|
| 58 | + . 'WHERE `uid` IN ('.str_repeat('?,', count($owners) - 1).'?) AND `type` = ? ORDER BY `category`'; |
|
| 59 | 59 | return $this->findEntities($sql, array_merge($owners, array($type))); |
| 60 | 60 | } |
| 61 | 61 | |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | * @return bool |
| 67 | 67 | */ |
| 68 | 68 | public function tagExists($tag) { |
| 69 | - $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` ' |
|
| 69 | + $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `'.$this->getTableName().'` ' |
|
| 70 | 70 | . 'WHERE `uid` = ? AND `type` = ? AND `category` = ?'; |
| 71 | 71 | try { |
| 72 | 72 | $this->findEntity($sql, array($tag->getOwner(), $tag->getType(), $tag->getName())); |
@@ -33,47 +33,47 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | class TagMapper extends Mapper { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Constructor. |
|
| 38 | - * |
|
| 39 | - * @param IDBConnection $db Instance of the Db abstraction layer. |
|
| 40 | - */ |
|
| 41 | - public function __construct(IDBConnection $db) { |
|
| 42 | - parent::__construct($db, 'vcategory', Tag::class); |
|
| 43 | - } |
|
| 36 | + /** |
|
| 37 | + * Constructor. |
|
| 38 | + * |
|
| 39 | + * @param IDBConnection $db Instance of the Db abstraction layer. |
|
| 40 | + */ |
|
| 41 | + public function __construct(IDBConnection $db) { |
|
| 42 | + parent::__construct($db, 'vcategory', Tag::class); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Load tags from the database. |
|
| 47 | - * |
|
| 48 | - * @param array|string $owners The user(s) whose tags we are going to load. |
|
| 49 | - * @param string $type The type of item for which we are loading tags. |
|
| 50 | - * @return array An array of Tag objects. |
|
| 51 | - */ |
|
| 52 | - public function loadTags($owners, $type) { |
|
| 53 | - if(!is_array($owners)) { |
|
| 54 | - $owners = array($owners); |
|
| 55 | - } |
|
| 45 | + /** |
|
| 46 | + * Load tags from the database. |
|
| 47 | + * |
|
| 48 | + * @param array|string $owners The user(s) whose tags we are going to load. |
|
| 49 | + * @param string $type The type of item for which we are loading tags. |
|
| 50 | + * @return array An array of Tag objects. |
|
| 51 | + */ |
|
| 52 | + public function loadTags($owners, $type) { |
|
| 53 | + if(!is_array($owners)) { |
|
| 54 | + $owners = array($owners); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` ' |
|
| 58 | - . 'WHERE `uid` IN (' . str_repeat('?,', count($owners)-1) . '?) AND `type` = ? ORDER BY `category`'; |
|
| 59 | - return $this->findEntities($sql, array_merge($owners, array($type))); |
|
| 60 | - } |
|
| 57 | + $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` ' |
|
| 58 | + . 'WHERE `uid` IN (' . str_repeat('?,', count($owners)-1) . '?) AND `type` = ? ORDER BY `category`'; |
|
| 59 | + return $this->findEntities($sql, array_merge($owners, array($type))); |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Check if a given Tag object already exists in the database. |
|
| 64 | - * |
|
| 65 | - * @param Tag $tag The tag to look for in the database. |
|
| 66 | - * @return bool |
|
| 67 | - */ |
|
| 68 | - public function tagExists($tag) { |
|
| 69 | - $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` ' |
|
| 70 | - . 'WHERE `uid` = ? AND `type` = ? AND `category` = ?'; |
|
| 71 | - try { |
|
| 72 | - $this->findEntity($sql, array($tag->getOwner(), $tag->getType(), $tag->getName())); |
|
| 73 | - } catch (DoesNotExistException $e) { |
|
| 74 | - return false; |
|
| 75 | - } |
|
| 76 | - return true; |
|
| 77 | - } |
|
| 62 | + /** |
|
| 63 | + * Check if a given Tag object already exists in the database. |
|
| 64 | + * |
|
| 65 | + * @param Tag $tag The tag to look for in the database. |
|
| 66 | + * @return bool |
|
| 67 | + */ |
|
| 68 | + public function tagExists($tag) { |
|
| 69 | + $sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` ' |
|
| 70 | + . 'WHERE `uid` = ? AND `type` = ? AND `category` = ?'; |
|
| 71 | + try { |
|
| 72 | + $this->findEntity($sql, array($tag->getOwner(), $tag->getType(), $tag->getName())); |
|
| 73 | + } catch (DoesNotExistException $e) { |
|
| 74 | + return false; |
|
| 75 | + } |
|
| 76 | + return true; |
|
| 77 | + } |
|
| 78 | 78 | } |
| 79 | 79 | |
@@ -37,54 +37,54 @@ |
||
| 37 | 37 | */ |
| 38 | 38 | class Tag extends Entity { |
| 39 | 39 | |
| 40 | - protected $owner; |
|
| 41 | - protected $type; |
|
| 42 | - protected $name; |
|
| 40 | + protected $owner; |
|
| 41 | + protected $type; |
|
| 42 | + protected $name; |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Constructor. |
|
| 46 | - * |
|
| 47 | - * @param string $owner The tag's owner |
|
| 48 | - * @param string $type The type of item this tag is used for |
|
| 49 | - * @param string $name The tag's name |
|
| 50 | - */ |
|
| 51 | - public function __construct($owner = null, $type = null, $name = null) { |
|
| 52 | - $this->setOwner($owner); |
|
| 53 | - $this->setType($type); |
|
| 54 | - $this->setName($name); |
|
| 55 | - } |
|
| 44 | + /** |
|
| 45 | + * Constructor. |
|
| 46 | + * |
|
| 47 | + * @param string $owner The tag's owner |
|
| 48 | + * @param string $type The type of item this tag is used for |
|
| 49 | + * @param string $name The tag's name |
|
| 50 | + */ |
|
| 51 | + public function __construct($owner = null, $type = null, $name = null) { |
|
| 52 | + $this->setOwner($owner); |
|
| 53 | + $this->setType($type); |
|
| 54 | + $this->setName($name); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Transform a database columnname to a property |
|
| 59 | - * |
|
| 60 | - * @param string $columnName the name of the column |
|
| 61 | - * @return string the property name |
|
| 62 | - * @todo migrate existing database columns to the correct names |
|
| 63 | - * to be able to drop this direct mapping |
|
| 64 | - */ |
|
| 65 | - public function columnToProperty($columnName){ |
|
| 66 | - if ($columnName === 'category') { |
|
| 67 | - return 'name'; |
|
| 68 | - } elseif ($columnName === 'uid') { |
|
| 69 | - return 'owner'; |
|
| 70 | - } else { |
|
| 71 | - return parent::columnToProperty($columnName); |
|
| 72 | - } |
|
| 73 | - } |
|
| 57 | + /** |
|
| 58 | + * Transform a database columnname to a property |
|
| 59 | + * |
|
| 60 | + * @param string $columnName the name of the column |
|
| 61 | + * @return string the property name |
|
| 62 | + * @todo migrate existing database columns to the correct names |
|
| 63 | + * to be able to drop this direct mapping |
|
| 64 | + */ |
|
| 65 | + public function columnToProperty($columnName){ |
|
| 66 | + if ($columnName === 'category') { |
|
| 67 | + return 'name'; |
|
| 68 | + } elseif ($columnName === 'uid') { |
|
| 69 | + return 'owner'; |
|
| 70 | + } else { |
|
| 71 | + return parent::columnToProperty($columnName); |
|
| 72 | + } |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Transform a property to a database column name |
|
| 77 | - * |
|
| 78 | - * @param string $property the name of the property |
|
| 79 | - * @return string the column name |
|
| 80 | - */ |
|
| 81 | - public function propertyToColumn($property){ |
|
| 82 | - if ($property === 'name') { |
|
| 83 | - return 'category'; |
|
| 84 | - } elseif ($property === 'owner') { |
|
| 85 | - return 'uid'; |
|
| 86 | - } else { |
|
| 87 | - return parent::propertyToColumn($property); |
|
| 88 | - } |
|
| 89 | - } |
|
| 75 | + /** |
|
| 76 | + * Transform a property to a database column name |
|
| 77 | + * |
|
| 78 | + * @param string $property the name of the property |
|
| 79 | + * @return string the column name |
|
| 80 | + */ |
|
| 81 | + public function propertyToColumn($property){ |
|
| 82 | + if ($property === 'name') { |
|
| 83 | + return 'category'; |
|
| 84 | + } elseif ($property === 'owner') { |
|
| 85 | + return 'uid'; |
|
| 86 | + } else { |
|
| 87 | + return parent::propertyToColumn($property); |
|
| 88 | + } |
|
| 89 | + } |
|
| 90 | 90 | } |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | * @todo migrate existing database columns to the correct names |
| 63 | 63 | * to be able to drop this direct mapping |
| 64 | 64 | */ |
| 65 | - public function columnToProperty($columnName){ |
|
| 65 | + public function columnToProperty($columnName) { |
|
| 66 | 66 | if ($columnName === 'category') { |
| 67 | 67 | return 'name'; |
| 68 | 68 | } elseif ($columnName === 'uid') { |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | * @param string $property the name of the property |
| 79 | 79 | * @return string the column name |
| 80 | 80 | */ |
| 81 | - public function propertyToColumn($property){ |
|
| 81 | + public function propertyToColumn($property) { |
|
| 82 | 82 | if ($property === 'name') { |
| 83 | 83 | return 'category'; |
| 84 | 84 | } elseif ($property === 'owner') { |
@@ -40,53 +40,53 @@ |
||
| 40 | 40 | |
| 41 | 41 | class TagManager implements \OCP\ITagManager { |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * User session |
|
| 45 | - * |
|
| 46 | - * @var \OCP\IUserSession |
|
| 47 | - */ |
|
| 48 | - private $userSession; |
|
| 43 | + /** |
|
| 44 | + * User session |
|
| 45 | + * |
|
| 46 | + * @var \OCP\IUserSession |
|
| 47 | + */ |
|
| 48 | + private $userSession; |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * TagMapper |
|
| 52 | - * |
|
| 53 | - * @var TagMapper |
|
| 54 | - */ |
|
| 55 | - private $mapper; |
|
| 50 | + /** |
|
| 51 | + * TagMapper |
|
| 52 | + * |
|
| 53 | + * @var TagMapper |
|
| 54 | + */ |
|
| 55 | + private $mapper; |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Constructor. |
|
| 59 | - * |
|
| 60 | - * @param TagMapper $mapper Instance of the TagMapper abstraction layer. |
|
| 61 | - * @param \OCP\IUserSession $userSession the user session |
|
| 62 | - */ |
|
| 63 | - public function __construct(TagMapper $mapper, \OCP\IUserSession $userSession) { |
|
| 64 | - $this->mapper = $mapper; |
|
| 65 | - $this->userSession = $userSession; |
|
| 57 | + /** |
|
| 58 | + * Constructor. |
|
| 59 | + * |
|
| 60 | + * @param TagMapper $mapper Instance of the TagMapper abstraction layer. |
|
| 61 | + * @param \OCP\IUserSession $userSession the user session |
|
| 62 | + */ |
|
| 63 | + public function __construct(TagMapper $mapper, \OCP\IUserSession $userSession) { |
|
| 64 | + $this->mapper = $mapper; |
|
| 65 | + $this->userSession = $userSession; |
|
| 66 | 66 | |
| 67 | - } |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Create a new \OCP\ITags instance and load tags from db. |
|
| 71 | - * |
|
| 72 | - * @see \OCP\ITags |
|
| 73 | - * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
| 74 | - * @param array $defaultTags An array of default tags to be used if none are stored. |
|
| 75 | - * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
| 76 | - * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
| 77 | - * logged in user |
|
| 78 | - * @return \OCP\ITags |
|
| 79 | - */ |
|
| 80 | - public function load($type, $defaultTags = array(), $includeShared = false, $userId = null) { |
|
| 81 | - if (is_null($userId)) { |
|
| 82 | - $user = $this->userSession->getUser(); |
|
| 83 | - if ($user === null) { |
|
| 84 | - // nothing we can do without a user |
|
| 85 | - return null; |
|
| 86 | - } |
|
| 87 | - $userId = $this->userSession->getUser()->getUId(); |
|
| 88 | - } |
|
| 89 | - return new Tags($this->mapper, $userId, $type, $defaultTags, $includeShared); |
|
| 90 | - } |
|
| 69 | + /** |
|
| 70 | + * Create a new \OCP\ITags instance and load tags from db. |
|
| 71 | + * |
|
| 72 | + * @see \OCP\ITags |
|
| 73 | + * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
| 74 | + * @param array $defaultTags An array of default tags to be used if none are stored. |
|
| 75 | + * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
| 76 | + * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
| 77 | + * logged in user |
|
| 78 | + * @return \OCP\ITags |
|
| 79 | + */ |
|
| 80 | + public function load($type, $defaultTags = array(), $includeShared = false, $userId = null) { |
|
| 81 | + if (is_null($userId)) { |
|
| 82 | + $user = $this->userSession->getUser(); |
|
| 83 | + if ($user === null) { |
|
| 84 | + // nothing we can do without a user |
|
| 85 | + return null; |
|
| 86 | + } |
|
| 87 | + $userId = $this->userSession->getUser()->getUId(); |
|
| 88 | + } |
|
| 89 | + return new Tags($this->mapper, $userId, $type, $defaultTags, $includeShared); |
|
| 90 | + } |
|
| 91 | 91 | |
| 92 | 92 | } |
@@ -27,164 +27,164 @@ |
||
| 27 | 27 | |
| 28 | 28 | namespace OC { |
| 29 | 29 | |
| 30 | - class ContactsManager implements \OCP\Contacts\IManager { |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * This function is used to search and find contacts within the users address books. |
|
| 34 | - * In case $pattern is empty all contacts will be returned. |
|
| 35 | - * |
|
| 36 | - * @param string $pattern which should match within the $searchProperties |
|
| 37 | - * @param array $searchProperties defines the properties within the query pattern should match |
|
| 38 | - * @param array $options - for future use. One should always have options! |
|
| 39 | - * @return array an array of contacts which are arrays of key-value-pairs |
|
| 40 | - */ |
|
| 41 | - public function search($pattern, $searchProperties = array(), $options = array()) { |
|
| 42 | - $this->loadAddressBooks(); |
|
| 43 | - $result = array(); |
|
| 44 | - foreach($this->addressBooks as $addressBook) { |
|
| 45 | - $r = $addressBook->search($pattern, $searchProperties, $options); |
|
| 46 | - $contacts = array(); |
|
| 47 | - foreach($r as $c){ |
|
| 48 | - $c['addressbook-key'] = $addressBook->getKey(); |
|
| 49 | - $contacts[] = $c; |
|
| 50 | - } |
|
| 51 | - $result = array_merge($result, $contacts); |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - return $result; |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * This function can be used to delete the contact identified by the given id |
|
| 59 | - * |
|
| 60 | - * @param object $id the unique identifier to a contact |
|
| 61 | - * @param string $addressBookKey identifier of the address book in which the contact shall be deleted |
|
| 62 | - * @return bool successful or not |
|
| 63 | - */ |
|
| 64 | - public function delete($id, $addressBookKey) { |
|
| 65 | - $addressBook = $this->getAddressBook($addressBookKey); |
|
| 66 | - if (!$addressBook) { |
|
| 67 | - return null; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_DELETE) { |
|
| 71 | - return $addressBook->delete($id); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - return null; |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * This function is used to create a new contact if 'id' is not given or not present. |
|
| 79 | - * Otherwise the contact will be updated by replacing the entire data set. |
|
| 80 | - * |
|
| 81 | - * @param array $properties this array if key-value-pairs defines a contact |
|
| 82 | - * @param string $addressBookKey identifier of the address book in which the contact shall be created or updated |
|
| 83 | - * @return array representing the contact just created or updated |
|
| 84 | - */ |
|
| 85 | - public function createOrUpdate($properties, $addressBookKey) { |
|
| 86 | - $addressBook = $this->getAddressBook($addressBookKey); |
|
| 87 | - if (!$addressBook) { |
|
| 88 | - return null; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_CREATE) { |
|
| 92 | - return $addressBook->createOrUpdate($properties); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - return null; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Check if contacts are available (e.g. contacts app enabled) |
|
| 100 | - * |
|
| 101 | - * @return bool true if enabled, false if not |
|
| 102 | - */ |
|
| 103 | - public function isEnabled() { |
|
| 104 | - return !empty($this->addressBooks) || !empty($this->addressBookLoaders); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * @param \OCP\IAddressBook $addressBook |
|
| 109 | - */ |
|
| 110 | - public function registerAddressBook(\OCP\IAddressBook $addressBook) { |
|
| 111 | - $this->addressBooks[$addressBook->getKey()] = $addressBook; |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * @param \OCP\IAddressBook $addressBook |
|
| 116 | - */ |
|
| 117 | - public function unregisterAddressBook(\OCP\IAddressBook $addressBook) { |
|
| 118 | - unset($this->addressBooks[$addressBook->getKey()]); |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * @return array |
|
| 123 | - */ |
|
| 124 | - public function getAddressBooks() { |
|
| 125 | - $this->loadAddressBooks(); |
|
| 126 | - $result = array(); |
|
| 127 | - foreach($this->addressBooks as $addressBook) { |
|
| 128 | - $result[$addressBook->getKey()] = $addressBook->getDisplayName(); |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - return $result; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * removes all registered address book instances |
|
| 136 | - */ |
|
| 137 | - public function clear() { |
|
| 138 | - $this->addressBooks = array(); |
|
| 139 | - $this->addressBookLoaders = array(); |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * @var \OCP\IAddressBook[] which holds all registered address books |
|
| 144 | - */ |
|
| 145 | - private $addressBooks = array(); |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * @var \Closure[] to call to load/register address books |
|
| 149 | - */ |
|
| 150 | - private $addressBookLoaders = array(); |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * In order to improve lazy loading a closure can be registered which will be called in case |
|
| 154 | - * address books are actually requested |
|
| 155 | - * |
|
| 156 | - * @param \Closure $callable |
|
| 157 | - */ |
|
| 158 | - public function register(\Closure $callable) |
|
| 159 | - { |
|
| 160 | - $this->addressBookLoaders[] = $callable; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * Get (and load when needed) the address book for $key |
|
| 165 | - * |
|
| 166 | - * @param string $addressBookKey |
|
| 167 | - * @return \OCP\IAddressBook |
|
| 168 | - */ |
|
| 169 | - protected function getAddressBook($addressBookKey) |
|
| 170 | - { |
|
| 171 | - $this->loadAddressBooks(); |
|
| 172 | - if (!array_key_exists($addressBookKey, $this->addressBooks)) { |
|
| 173 | - return null; |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - return $this->addressBooks[$addressBookKey]; |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - /** |
|
| 180 | - * Load all address books registered with 'register' |
|
| 181 | - */ |
|
| 182 | - protected function loadAddressBooks() |
|
| 183 | - { |
|
| 184 | - foreach($this->addressBookLoaders as $callable) { |
|
| 185 | - $callable($this); |
|
| 186 | - } |
|
| 187 | - $this->addressBookLoaders = array(); |
|
| 188 | - } |
|
| 189 | - } |
|
| 30 | + class ContactsManager implements \OCP\Contacts\IManager { |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * This function is used to search and find contacts within the users address books. |
|
| 34 | + * In case $pattern is empty all contacts will be returned. |
|
| 35 | + * |
|
| 36 | + * @param string $pattern which should match within the $searchProperties |
|
| 37 | + * @param array $searchProperties defines the properties within the query pattern should match |
|
| 38 | + * @param array $options - for future use. One should always have options! |
|
| 39 | + * @return array an array of contacts which are arrays of key-value-pairs |
|
| 40 | + */ |
|
| 41 | + public function search($pattern, $searchProperties = array(), $options = array()) { |
|
| 42 | + $this->loadAddressBooks(); |
|
| 43 | + $result = array(); |
|
| 44 | + foreach($this->addressBooks as $addressBook) { |
|
| 45 | + $r = $addressBook->search($pattern, $searchProperties, $options); |
|
| 46 | + $contacts = array(); |
|
| 47 | + foreach($r as $c){ |
|
| 48 | + $c['addressbook-key'] = $addressBook->getKey(); |
|
| 49 | + $contacts[] = $c; |
|
| 50 | + } |
|
| 51 | + $result = array_merge($result, $contacts); |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + return $result; |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * This function can be used to delete the contact identified by the given id |
|
| 59 | + * |
|
| 60 | + * @param object $id the unique identifier to a contact |
|
| 61 | + * @param string $addressBookKey identifier of the address book in which the contact shall be deleted |
|
| 62 | + * @return bool successful or not |
|
| 63 | + */ |
|
| 64 | + public function delete($id, $addressBookKey) { |
|
| 65 | + $addressBook = $this->getAddressBook($addressBookKey); |
|
| 66 | + if (!$addressBook) { |
|
| 67 | + return null; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_DELETE) { |
|
| 71 | + return $addressBook->delete($id); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + return null; |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * This function is used to create a new contact if 'id' is not given or not present. |
|
| 79 | + * Otherwise the contact will be updated by replacing the entire data set. |
|
| 80 | + * |
|
| 81 | + * @param array $properties this array if key-value-pairs defines a contact |
|
| 82 | + * @param string $addressBookKey identifier of the address book in which the contact shall be created or updated |
|
| 83 | + * @return array representing the contact just created or updated |
|
| 84 | + */ |
|
| 85 | + public function createOrUpdate($properties, $addressBookKey) { |
|
| 86 | + $addressBook = $this->getAddressBook($addressBookKey); |
|
| 87 | + if (!$addressBook) { |
|
| 88 | + return null; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + if ($addressBook->getPermissions() & \OCP\Constants::PERMISSION_CREATE) { |
|
| 92 | + return $addressBook->createOrUpdate($properties); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + return null; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Check if contacts are available (e.g. contacts app enabled) |
|
| 100 | + * |
|
| 101 | + * @return bool true if enabled, false if not |
|
| 102 | + */ |
|
| 103 | + public function isEnabled() { |
|
| 104 | + return !empty($this->addressBooks) || !empty($this->addressBookLoaders); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * @param \OCP\IAddressBook $addressBook |
|
| 109 | + */ |
|
| 110 | + public function registerAddressBook(\OCP\IAddressBook $addressBook) { |
|
| 111 | + $this->addressBooks[$addressBook->getKey()] = $addressBook; |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * @param \OCP\IAddressBook $addressBook |
|
| 116 | + */ |
|
| 117 | + public function unregisterAddressBook(\OCP\IAddressBook $addressBook) { |
|
| 118 | + unset($this->addressBooks[$addressBook->getKey()]); |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * @return array |
|
| 123 | + */ |
|
| 124 | + public function getAddressBooks() { |
|
| 125 | + $this->loadAddressBooks(); |
|
| 126 | + $result = array(); |
|
| 127 | + foreach($this->addressBooks as $addressBook) { |
|
| 128 | + $result[$addressBook->getKey()] = $addressBook->getDisplayName(); |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + return $result; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * removes all registered address book instances |
|
| 136 | + */ |
|
| 137 | + public function clear() { |
|
| 138 | + $this->addressBooks = array(); |
|
| 139 | + $this->addressBookLoaders = array(); |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * @var \OCP\IAddressBook[] which holds all registered address books |
|
| 144 | + */ |
|
| 145 | + private $addressBooks = array(); |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * @var \Closure[] to call to load/register address books |
|
| 149 | + */ |
|
| 150 | + private $addressBookLoaders = array(); |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * In order to improve lazy loading a closure can be registered which will be called in case |
|
| 154 | + * address books are actually requested |
|
| 155 | + * |
|
| 156 | + * @param \Closure $callable |
|
| 157 | + */ |
|
| 158 | + public function register(\Closure $callable) |
|
| 159 | + { |
|
| 160 | + $this->addressBookLoaders[] = $callable; |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * Get (and load when needed) the address book for $key |
|
| 165 | + * |
|
| 166 | + * @param string $addressBookKey |
|
| 167 | + * @return \OCP\IAddressBook |
|
| 168 | + */ |
|
| 169 | + protected function getAddressBook($addressBookKey) |
|
| 170 | + { |
|
| 171 | + $this->loadAddressBooks(); |
|
| 172 | + if (!array_key_exists($addressBookKey, $this->addressBooks)) { |
|
| 173 | + return null; |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + return $this->addressBooks[$addressBookKey]; |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + /** |
|
| 180 | + * Load all address books registered with 'register' |
|
| 181 | + */ |
|
| 182 | + protected function loadAddressBooks() |
|
| 183 | + { |
|
| 184 | + foreach($this->addressBookLoaders as $callable) { |
|
| 185 | + $callable($this); |
|
| 186 | + } |
|
| 187 | + $this->addressBookLoaders = array(); |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | 190 | } |
@@ -41,10 +41,10 @@ discard block |
||
| 41 | 41 | public function search($pattern, $searchProperties = array(), $options = array()) { |
| 42 | 42 | $this->loadAddressBooks(); |
| 43 | 43 | $result = array(); |
| 44 | - foreach($this->addressBooks as $addressBook) { |
|
| 44 | + foreach ($this->addressBooks as $addressBook) { |
|
| 45 | 45 | $r = $addressBook->search($pattern, $searchProperties, $options); |
| 46 | 46 | $contacts = array(); |
| 47 | - foreach($r as $c){ |
|
| 47 | + foreach ($r as $c) { |
|
| 48 | 48 | $c['addressbook-key'] = $addressBook->getKey(); |
| 49 | 49 | $contacts[] = $c; |
| 50 | 50 | } |
@@ -124,7 +124,7 @@ discard block |
||
| 124 | 124 | public function getAddressBooks() { |
| 125 | 125 | $this->loadAddressBooks(); |
| 126 | 126 | $result = array(); |
| 127 | - foreach($this->addressBooks as $addressBook) { |
|
| 127 | + foreach ($this->addressBooks as $addressBook) { |
|
| 128 | 128 | $result[$addressBook->getKey()] = $addressBook->getDisplayName(); |
| 129 | 129 | } |
| 130 | 130 | |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | */ |
| 182 | 182 | protected function loadAddressBooks() |
| 183 | 183 | { |
| 184 | - foreach($this->addressBookLoaders as $callable) { |
|
| 184 | + foreach ($this->addressBookLoaders as $callable) { |
|
| 185 | 185 | $callable($this); |
| 186 | 186 | } |
| 187 | 187 | $this->addressBookLoaders = array(); |
@@ -134,7 +134,7 @@ |
||
| 134 | 134 | } |
| 135 | 135 | if(is_dir($source.'/'.$file)) { |
| 136 | 136 | $this->addRecursive($path.'/'.$file, $source.'/'.$file); |
| 137 | - }else{ |
|
| 137 | + } else{ |
|
| 138 | 138 | $this->addFile($path.'/'.$file, $source.'/'.$file); |
| 139 | 139 | } |
| 140 | 140 | } |
@@ -33,111 +33,111 @@ |
||
| 33 | 33 | namespace OC\Archive; |
| 34 | 34 | |
| 35 | 35 | abstract class Archive { |
| 36 | - /** |
|
| 37 | - * @param $source |
|
| 38 | - */ |
|
| 39 | - public abstract function __construct($source); |
|
| 40 | - /** |
|
| 41 | - * add an empty folder to the archive |
|
| 42 | - * @param string $path |
|
| 43 | - * @return bool |
|
| 44 | - */ |
|
| 45 | - public abstract function addFolder($path); |
|
| 46 | - /** |
|
| 47 | - * add a file to the archive |
|
| 48 | - * @param string $path |
|
| 49 | - * @param string $source either a local file or string data |
|
| 50 | - * @return bool |
|
| 51 | - */ |
|
| 52 | - public abstract function addFile($path, $source=''); |
|
| 53 | - /** |
|
| 54 | - * rename a file or folder in the archive |
|
| 55 | - * @param string $source |
|
| 56 | - * @param string $dest |
|
| 57 | - * @return bool |
|
| 58 | - */ |
|
| 59 | - public abstract function rename($source, $dest); |
|
| 60 | - /** |
|
| 61 | - * get the uncompressed size of a file in the archive |
|
| 62 | - * @param string $path |
|
| 63 | - * @return int |
|
| 64 | - */ |
|
| 65 | - public abstract function filesize($path); |
|
| 66 | - /** |
|
| 67 | - * get the last modified time of a file in the archive |
|
| 68 | - * @param string $path |
|
| 69 | - * @return int |
|
| 70 | - */ |
|
| 71 | - public abstract function mtime($path); |
|
| 72 | - /** |
|
| 73 | - * get the files in a folder |
|
| 74 | - * @param string $path |
|
| 75 | - * @return array |
|
| 76 | - */ |
|
| 77 | - public abstract function getFolder($path); |
|
| 78 | - /** |
|
| 79 | - * get all files in the archive |
|
| 80 | - * @return array |
|
| 81 | - */ |
|
| 82 | - public abstract function getFiles(); |
|
| 83 | - /** |
|
| 84 | - * get the content of a file |
|
| 85 | - * @param string $path |
|
| 86 | - * @return string |
|
| 87 | - */ |
|
| 88 | - public abstract function getFile($path); |
|
| 89 | - /** |
|
| 90 | - * extract a single file from the archive |
|
| 91 | - * @param string $path |
|
| 92 | - * @param string $dest |
|
| 93 | - * @return bool |
|
| 94 | - */ |
|
| 95 | - public abstract function extractFile($path, $dest); |
|
| 96 | - /** |
|
| 97 | - * extract the archive |
|
| 98 | - * @param string $dest |
|
| 99 | - * @return bool |
|
| 100 | - */ |
|
| 101 | - public abstract function extract($dest); |
|
| 102 | - /** |
|
| 103 | - * check if a file or folder exists in the archive |
|
| 104 | - * @param string $path |
|
| 105 | - * @return bool |
|
| 106 | - */ |
|
| 107 | - public abstract function fileExists($path); |
|
| 108 | - /** |
|
| 109 | - * remove a file or folder from the archive |
|
| 110 | - * @param string $path |
|
| 111 | - * @return bool |
|
| 112 | - */ |
|
| 113 | - public abstract function remove($path); |
|
| 114 | - /** |
|
| 115 | - * get a file handler |
|
| 116 | - * @param string $path |
|
| 117 | - * @param string $mode |
|
| 118 | - * @return resource |
|
| 119 | - */ |
|
| 120 | - public abstract function getStream($path, $mode); |
|
| 121 | - /** |
|
| 122 | - * add a folder and all its content |
|
| 123 | - * @param string $path |
|
| 124 | - * @param string $source |
|
| 125 | - * @return boolean|null |
|
| 126 | - */ |
|
| 127 | - public function addRecursive($path, $source) { |
|
| 128 | - $dh = opendir($source); |
|
| 129 | - if(is_resource($dh)) { |
|
| 130 | - $this->addFolder($path); |
|
| 131 | - while (($file = readdir($dh)) !== false) { |
|
| 132 | - if($file === '.' || $file === '..') { |
|
| 133 | - continue; |
|
| 134 | - } |
|
| 135 | - if(is_dir($source.'/'.$file)) { |
|
| 136 | - $this->addRecursive($path.'/'.$file, $source.'/'.$file); |
|
| 137 | - }else{ |
|
| 138 | - $this->addFile($path.'/'.$file, $source.'/'.$file); |
|
| 139 | - } |
|
| 140 | - } |
|
| 141 | - } |
|
| 142 | - } |
|
| 36 | + /** |
|
| 37 | + * @param $source |
|
| 38 | + */ |
|
| 39 | + public abstract function __construct($source); |
|
| 40 | + /** |
|
| 41 | + * add an empty folder to the archive |
|
| 42 | + * @param string $path |
|
| 43 | + * @return bool |
|
| 44 | + */ |
|
| 45 | + public abstract function addFolder($path); |
|
| 46 | + /** |
|
| 47 | + * add a file to the archive |
|
| 48 | + * @param string $path |
|
| 49 | + * @param string $source either a local file or string data |
|
| 50 | + * @return bool |
|
| 51 | + */ |
|
| 52 | + public abstract function addFile($path, $source=''); |
|
| 53 | + /** |
|
| 54 | + * rename a file or folder in the archive |
|
| 55 | + * @param string $source |
|
| 56 | + * @param string $dest |
|
| 57 | + * @return bool |
|
| 58 | + */ |
|
| 59 | + public abstract function rename($source, $dest); |
|
| 60 | + /** |
|
| 61 | + * get the uncompressed size of a file in the archive |
|
| 62 | + * @param string $path |
|
| 63 | + * @return int |
|
| 64 | + */ |
|
| 65 | + public abstract function filesize($path); |
|
| 66 | + /** |
|
| 67 | + * get the last modified time of a file in the archive |
|
| 68 | + * @param string $path |
|
| 69 | + * @return int |
|
| 70 | + */ |
|
| 71 | + public abstract function mtime($path); |
|
| 72 | + /** |
|
| 73 | + * get the files in a folder |
|
| 74 | + * @param string $path |
|
| 75 | + * @return array |
|
| 76 | + */ |
|
| 77 | + public abstract function getFolder($path); |
|
| 78 | + /** |
|
| 79 | + * get all files in the archive |
|
| 80 | + * @return array |
|
| 81 | + */ |
|
| 82 | + public abstract function getFiles(); |
|
| 83 | + /** |
|
| 84 | + * get the content of a file |
|
| 85 | + * @param string $path |
|
| 86 | + * @return string |
|
| 87 | + */ |
|
| 88 | + public abstract function getFile($path); |
|
| 89 | + /** |
|
| 90 | + * extract a single file from the archive |
|
| 91 | + * @param string $path |
|
| 92 | + * @param string $dest |
|
| 93 | + * @return bool |
|
| 94 | + */ |
|
| 95 | + public abstract function extractFile($path, $dest); |
|
| 96 | + /** |
|
| 97 | + * extract the archive |
|
| 98 | + * @param string $dest |
|
| 99 | + * @return bool |
|
| 100 | + */ |
|
| 101 | + public abstract function extract($dest); |
|
| 102 | + /** |
|
| 103 | + * check if a file or folder exists in the archive |
|
| 104 | + * @param string $path |
|
| 105 | + * @return bool |
|
| 106 | + */ |
|
| 107 | + public abstract function fileExists($path); |
|
| 108 | + /** |
|
| 109 | + * remove a file or folder from the archive |
|
| 110 | + * @param string $path |
|
| 111 | + * @return bool |
|
| 112 | + */ |
|
| 113 | + public abstract function remove($path); |
|
| 114 | + /** |
|
| 115 | + * get a file handler |
|
| 116 | + * @param string $path |
|
| 117 | + * @param string $mode |
|
| 118 | + * @return resource |
|
| 119 | + */ |
|
| 120 | + public abstract function getStream($path, $mode); |
|
| 121 | + /** |
|
| 122 | + * add a folder and all its content |
|
| 123 | + * @param string $path |
|
| 124 | + * @param string $source |
|
| 125 | + * @return boolean|null |
|
| 126 | + */ |
|
| 127 | + public function addRecursive($path, $source) { |
|
| 128 | + $dh = opendir($source); |
|
| 129 | + if(is_resource($dh)) { |
|
| 130 | + $this->addFolder($path); |
|
| 131 | + while (($file = readdir($dh)) !== false) { |
|
| 132 | + if($file === '.' || $file === '..') { |
|
| 133 | + continue; |
|
| 134 | + } |
|
| 135 | + if(is_dir($source.'/'.$file)) { |
|
| 136 | + $this->addRecursive($path.'/'.$file, $source.'/'.$file); |
|
| 137 | + }else{ |
|
| 138 | + $this->addFile($path.'/'.$file, $source.'/'.$file); |
|
| 139 | + } |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | + } |
|
| 143 | 143 | } |
@@ -49,7 +49,7 @@ discard block |
||
| 49 | 49 | * @param string $source either a local file or string data |
| 50 | 50 | * @return bool |
| 51 | 51 | */ |
| 52 | - public abstract function addFile($path, $source=''); |
|
| 52 | + public abstract function addFile($path, $source = ''); |
|
| 53 | 53 | /** |
| 54 | 54 | * rename a file or folder in the archive |
| 55 | 55 | * @param string $source |
@@ -126,15 +126,15 @@ discard block |
||
| 126 | 126 | */ |
| 127 | 127 | public function addRecursive($path, $source) { |
| 128 | 128 | $dh = opendir($source); |
| 129 | - if(is_resource($dh)) { |
|
| 129 | + if (is_resource($dh)) { |
|
| 130 | 130 | $this->addFolder($path); |
| 131 | 131 | while (($file = readdir($dh)) !== false) { |
| 132 | - if($file === '.' || $file === '..') { |
|
| 132 | + if ($file === '.' || $file === '..') { |
|
| 133 | 133 | continue; |
| 134 | 134 | } |
| 135 | - if(is_dir($source.'/'.$file)) { |
|
| 135 | + if (is_dir($source.'/'.$file)) { |
|
| 136 | 136 | $this->addRecursive($path.'/'.$file, $source.'/'.$file); |
| 137 | - }else{ |
|
| 137 | + } else { |
|
| 138 | 138 | $this->addFile($path.'/'.$file, $source.'/'.$file); |
| 139 | 139 | } |
| 140 | 140 | } |