gyselroth /
balloon
Complex classes like Filesystem often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Filesystem, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class Filesystem |
||
| 29 | { |
||
| 30 | /** |
||
| 31 | * Database. |
||
| 32 | * |
||
| 33 | * @var Database |
||
| 34 | */ |
||
| 35 | protected $db; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * LoggerInterface. |
||
| 39 | * |
||
| 40 | * @var LoggerInterface |
||
| 41 | */ |
||
| 42 | protected $logger; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * Hook. |
||
| 46 | * |
||
| 47 | * @var Hook |
||
| 48 | */ |
||
| 49 | protected $hook; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * Server. |
||
| 53 | * |
||
| 54 | * @var Server |
||
| 55 | */ |
||
| 56 | protected $server; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Root collection. |
||
| 60 | * |
||
| 61 | * @var Collection |
||
| 62 | */ |
||
| 63 | protected $root; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * User. |
||
| 67 | * |
||
| 68 | * @var Delta |
||
| 69 | */ |
||
| 70 | protected $delta; |
||
| 71 | |||
| 72 | /** |
||
| 73 | * Get user. |
||
| 74 | * |
||
| 75 | * @var User |
||
| 76 | */ |
||
| 77 | protected $user; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Node factory. |
||
| 81 | * |
||
| 82 | * @var NodeFactory |
||
| 83 | */ |
||
| 84 | protected $node_factory; |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Acl. |
||
| 88 | * |
||
| 89 | * @var Acl |
||
| 90 | */ |
||
| 91 | protected $acl; |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Cache. |
||
| 95 | * |
||
| 96 | * @var array |
||
| 97 | */ |
||
| 98 | protected $cache = []; |
||
| 99 | |||
| 100 | /** |
||
| 101 | * RAW Cache. |
||
| 102 | * |
||
| 103 | * @var array |
||
| 104 | */ |
||
| 105 | protected $raw_cache = []; |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Initialize. |
||
| 109 | */ |
||
| 110 | public function __construct(Server $server, Database $db, Hook $hook, LoggerInterface $logger, NodeFactory $node_factory, Acl $acl, ?User $user = null) |
||
| 111 | { |
||
| 112 | $this->user = $user; |
||
| 113 | $this->server = $server; |
||
| 114 | $this->db = $db; |
||
| 115 | $this->logger = $logger; |
||
| 116 | $this->hook = $hook; |
||
| 117 | $this->node_factory = $node_factory; |
||
| 118 | $this->acl = $acl; |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Get user. |
||
| 123 | */ |
||
| 124 | public function getUser(): ?User |
||
| 125 | { |
||
| 126 | return $this->user; |
||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Get server. |
||
| 131 | */ |
||
| 132 | public function getServer(): Server |
||
| 133 | { |
||
| 134 | return $this->server; |
||
| 135 | } |
||
| 136 | |||
| 137 | /** |
||
| 138 | * Get database. |
||
| 139 | */ |
||
| 140 | public function getDatabase(): Database |
||
| 141 | { |
||
| 142 | return $this->db; |
||
| 143 | } |
||
| 144 | |||
| 145 | /** |
||
| 146 | * Get root. |
||
| 147 | */ |
||
| 148 | public function getRoot(): Collection |
||
| 149 | { |
||
| 150 | if ($this->root instanceof Collection) { |
||
| 151 | return $this->root; |
||
| 152 | } |
||
| 153 | |||
| 154 | return $this->root = $this->initNode([ |
||
| 155 | 'directory' => true, |
||
| 156 | '_id' => null, |
||
| 157 | 'owner' => $this->user ? $this->user->getId() : null, |
||
| 158 | ]); |
||
| 159 | } |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Get delta. |
||
| 163 | */ |
||
| 164 | public function getDelta(): Delta |
||
| 165 | { |
||
| 166 | if ($this->delta instanceof Delta) { |
||
| 167 | return $this->delta; |
||
| 168 | } |
||
| 169 | |||
| 170 | return $this->delta = new Delta($this, $this->db, $this->acl); |
||
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Find raw node. |
||
| 175 | */ |
||
| 176 | public function findRawNode(ObjectId $id): array |
||
| 177 | { |
||
| 178 | if (isset($this->raw_cache[(string) $id])) { |
||
| 179 | return $this->raw_cache[(string) $id]; |
||
| 180 | } |
||
| 181 | |||
| 182 | $node = $this->db->storage->findOne(['_id' => $id]); |
||
| 183 | if (null === $node) { |
||
| 184 | throw new Exception\NotFound( |
||
| 185 | 'node '.$id.' not found', |
||
| 186 | Exception\NotFound::NODE_NOT_FOUND |
||
| 187 | ); |
||
| 188 | } |
||
| 189 | |||
| 190 | $this->raw_cache[(string) $id] = $node; |
||
| 191 | |||
| 192 | return $node; |
||
| 193 | } |
||
| 194 | |||
| 195 | /** |
||
| 196 | * Factory loader. |
||
| 197 | */ |
||
| 198 | public function findNodeById($id, ?string $class = null, int $deleted = NodeInterface::DELETED_INCLUDE): NodeInterface |
||
| 199 | { |
||
| 200 | if (isset($this->cache[(string) $id])) { |
||
| 201 | return $this->cache[(string) $id]; |
||
| 202 | } |
||
| 203 | |||
| 204 | if (!is_string($id) && !($id instanceof ObjectId)) { |
||
| 205 | throw new Exception\InvalidArgument($id.' node id has to be a string or instance of \MongoDB\BSON\ObjectId'); |
||
| 206 | } |
||
| 207 | |||
| 208 | try { |
||
| 209 | if (is_string($id)) { |
||
| 210 | $id = new ObjectId($id); |
||
| 211 | } |
||
| 212 | } catch (\Exception $e) { |
||
| 213 | throw new Exception\InvalidArgument('invalid node id specified'); |
||
| 214 | } |
||
| 215 | |||
| 216 | $filter = [ |
||
| 217 | '_id' => $id, |
||
| 218 | ]; |
||
| 219 | |||
| 220 | switch ($deleted) { |
||
| 221 | case NodeInterface::DELETED_INCLUDE: |
||
| 222 | break; |
||
| 223 | case NodeInterface::DELETED_EXCLUDE: |
||
| 224 | $filter['deleted'] = false; |
||
| 225 | |||
| 226 | break; |
||
| 227 | case NodeInterface::DELETED_ONLY: |
||
| 228 | $filter['deleted'] = ['$type' => 9]; |
||
| 229 | |||
| 230 | break; |
||
| 231 | } |
||
| 232 | |||
| 233 | $node = $this->db->storage->findOne($filter); |
||
| 234 | |||
| 235 | if (null === $node) { |
||
| 236 | throw new Exception\NotFound( |
||
| 237 | 'node ['.$id.'] not found', |
||
| 238 | Exception\NotFound::NODE_NOT_FOUND |
||
| 239 | ); |
||
| 240 | } |
||
| 241 | |||
| 242 | $return = $this->initNode($node); |
||
| 243 | |||
| 244 | if (null !== $class && !($return instanceof $class)) { |
||
| 245 | throw new Exception('node '.get_class($return).' is not instance of '.$class); |
||
| 246 | } |
||
| 247 | |||
| 248 | return $return; |
||
| 249 | } |
||
| 250 | |||
| 251 | /** |
||
| 252 | * Load nodes by id. |
||
| 253 | */ |
||
| 254 | public function findNodesById(array $id = [], ?string $class = null, int $deleted = NodeInterface::DELETED_INCLUDE): Generator |
||
| 255 | { |
||
| 256 | $find = []; |
||
| 257 | foreach ($id as $i) { |
||
| 258 | $find[] = new ObjectId($i); |
||
| 259 | } |
||
| 260 | |||
| 261 | $filter = [ |
||
| 262 | '_id' => ['$in' => $find], |
||
| 263 | ]; |
||
| 264 | |||
| 265 | switch ($deleted) { |
||
| 266 | case NodeInterface::DELETED_INCLUDE: |
||
| 267 | break; |
||
| 268 | case NodeInterface::DELETED_EXCLUDE: |
||
| 269 | $filter['deleted'] = false; |
||
| 270 | |||
| 271 | break; |
||
| 272 | case NodeInterface::DELETED_ONLY: |
||
| 273 | $filter['deleted'] = ['$type' => 9]; |
||
| 274 | |||
| 275 | break; |
||
| 276 | } |
||
| 277 | |||
| 278 | $result = $this->db->storage->find($filter); |
||
| 279 | |||
| 280 | $nodes = []; |
||
| 281 | foreach ($result as $node) { |
||
| 282 | try { |
||
| 283 | $return = $this->initNode($node); |
||
| 284 | |||
| 285 | if (in_array($return->getId(), $nodes)) { |
||
| 286 | continue; |
||
| 287 | } |
||
| 288 | |||
| 289 | $nodes[] = $return->getId(); |
||
| 290 | } catch (\Exception $e) { |
||
| 291 | $this->logger->error('remove node from result list, failed load node', [ |
||
| 292 | 'category' => get_class($this), |
||
| 293 | 'exception' => $e, |
||
| 294 | ]); |
||
| 295 | |||
| 296 | continue; |
||
| 297 | } |
||
| 298 | |||
| 299 | if (null !== $class && !($return instanceof $class)) { |
||
| 300 | throw new Exception('node is not an instance of '.$class); |
||
| 301 | } |
||
| 302 | |||
| 303 | yield $return; |
||
| 304 | } |
||
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | * Load nodes by id. |
||
| 309 | * |
||
| 310 | * @param null|mixed $class |
||
| 311 | */ |
||
| 312 | public function getNodes(?array $id = null, $class = null, int $deleted = NodeInterface::DELETED_EXCLUDE): Generator |
||
| 313 | { |
||
| 314 | return $this->findNodesById($id, $class, $deleted); |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Load node. |
||
| 319 | * |
||
| 320 | * @param null|mixed $id |
||
| 321 | * @param null|mixed $class |
||
| 322 | */ |
||
| 323 | public function getNode($id = null, $class = null, bool $multiple = false, bool $allow_root = false, ?int $deleted = null): NodeInterface |
||
| 324 | { |
||
| 325 | if (empty($id)) { |
||
| 326 | if (true === $allow_root) { |
||
| 327 | return $this->getRoot(); |
||
| 328 | } |
||
| 329 | |||
| 330 | throw new Exception\InvalidArgument('invalid id given'); |
||
| 331 | } |
||
| 332 | |||
| 333 | if (null === $deleted) { |
||
| 334 | $deleted = NodeInterface::DELETED_INCLUDE; |
||
| 335 | } |
||
| 336 | |||
| 337 | if (true === $multiple && is_array($id)) { |
||
| 338 | return $this->findNodesById($id, $class, $deleted); |
||
| 339 | } |
||
| 340 | |||
| 341 | return $this->findNodeById($id, $class, $deleted); |
||
| 342 | } |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Find node with custom filter. |
||
| 346 | */ |
||
| 347 | public function findNodeByFilter(array $filter): NodeInterface |
||
| 348 | { |
||
| 349 | $result = $this->db->storage->findOne($filter); |
||
| 350 | if (null === $result) { |
||
| 351 | throw new Exception\NotFound( |
||
| 352 | 'node with custom filter was not found', |
||
| 353 | Exception\NotFound::NODE_NOT_FOUND |
||
| 354 | ); |
||
| 355 | } |
||
| 356 | |||
| 357 | return $this->initNode($result); |
||
| 358 | } |
||
| 359 | |||
| 360 | /** |
||
| 361 | * Count. |
||
| 362 | */ |
||
| 363 | public function countNodes(array $filter = []): int |
||
| 364 | { |
||
| 365 | return $this->db->storage->count($filter); |
||
| 366 | } |
||
| 367 | |||
| 368 | /** |
||
| 369 | * Find nodes with custom filters. |
||
| 370 | */ |
||
| 371 | public function findNodesByFilter(array $filter, ?int $offset = null, ?int $limit = null): Generator |
||
| 372 | { |
||
| 373 | $result = $this->db->storage->find($filter, [ |
||
| 374 | 'skip' => $offset, |
||
| 375 | 'limit' => $limit, |
||
| 376 | ]); |
||
| 377 | |||
| 378 | $count = $this->countNodes($filter); |
||
| 379 | |||
| 380 | foreach ($result as $node) { |
||
| 381 | try { |
||
| 382 | yield $this->initNode($node); |
||
| 383 | } catch (\Exception $e) { |
||
| 384 | $this->logger->error('remove node from result list, failed load node', [ |
||
| 385 | 'category' => get_class($this), |
||
| 386 | 'exception' => $e, |
||
| 387 | ]); |
||
| 388 | } |
||
| 389 | } |
||
| 390 | |||
| 391 | return $count; |
||
| 392 | } |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Find nodes with custom filter recursive. |
||
| 396 | */ |
||
| 397 | public function findNodesByFilterRecursiveToArray(Collection $collection, array $filter = []): array |
||
| 398 | { |
||
| 399 | $graph = [ |
||
| 400 | 'from' => 'storage', |
||
| 401 | 'startWith' => '$pointer', |
||
| 402 | 'connectFromField' => 'pointer', |
||
| 403 | 'connectToField' => 'parent', |
||
| 404 | 'as' => 'children', |
||
| 405 | ]; |
||
| 406 | |||
| 407 | if (count($filter) > 0) { |
||
| 408 | $graph['restrictSearchWithMatch'] = $filter; |
||
| 409 | } |
||
| 410 | |||
| 411 | $query = [ |
||
| 412 | ['$match' => ['_id' => $collection->getId()]], |
||
| 413 | ['$graphLookup' => $graph], |
||
| 414 | ['$unwind' => '$children'], |
||
| 415 | ['$project' => ['id' => '$children._id']], |
||
| 416 | ]; |
||
| 417 | |||
| 418 | $result = $this->db->storage->aggregate($query); |
||
| 419 | |||
| 420 | return array_column(iterator_to_array($result), 'id'); |
||
| 421 | } |
||
| 422 | |||
| 423 | /** |
||
| 424 | * Find nodes with custom filter recursive. |
||
| 425 | */ |
||
| 426 | public function findNodesByFilterRecursive(Collection $collection, array $filter = [], ?int $offset = null, ?int $limit = null): Generator |
||
| 427 | { |
||
| 428 | $graph = [ |
||
| 429 | 'from' => 'storage', |
||
| 430 | 'startWith' => '$pointer', |
||
| 431 | 'connectFromField' => 'pointer', |
||
| 432 | 'connectToField' => 'parent', |
||
| 433 | 'as' => 'children', |
||
| 434 | ]; |
||
| 435 | |||
| 436 | if (count($filter) > 0) { |
||
| 437 | $graph['restrictSearchWithMatch'] = $filter; |
||
| 438 | } |
||
| 439 | |||
| 440 | $query = [ |
||
| 441 | ['$match' => ['_id' => $collection->getId()]], |
||
| 442 | ['$graphLookup' => $graph], |
||
| 443 | ['$unwind' => '$children'], |
||
| 444 | ['$group' => ['_id' => null, 'total' => ['$sum' => 1]]], |
||
| 445 | ]; |
||
| 446 | |||
| 447 | $result = $this->db->storage->aggregate($query); |
||
| 448 | |||
| 449 | $total = 0; |
||
| 450 | $result = iterator_to_array($result); |
||
| 451 | if (count($result) > 0) { |
||
| 452 | $total = $result[0]['total']; |
||
| 453 | } |
||
| 454 | |||
| 455 | array_pop($query); |
||
| 456 | $query[] = ['$skip' => $offset]; |
||
| 457 | $query[] = ['$limit' => $limit]; |
||
| 458 | $result = $this->db->storage->aggregate($query); |
||
| 459 | |||
| 460 | foreach ($result as $node) { |
||
| 461 | try { |
||
| 462 | if (isset($node['children'])) { |
||
| 463 | $node = $node['children']; |
||
| 464 | } |
||
| 465 | |||
| 466 | yield $this->initNode($node); |
||
| 467 | } catch (\Exception $e) { |
||
| 468 | $this->logger->error('remove node from result list, failed load node', [ |
||
| 469 | 'category' => get_class($this), |
||
| 470 | 'exception' => $e, |
||
| 471 | ]); |
||
| 472 | } |
||
| 473 | } |
||
| 474 | |||
| 475 | return $total; |
||
| 476 | } |
||
| 477 | |||
| 478 | /** |
||
| 479 | * Get custom filtered children. |
||
| 480 | */ |
||
| 481 | public function findNodesByFilterUser(int $deleted, array $filter, ?int $offset = null, ?int $limit = null): Generator |
||
| 482 | { |
||
| 483 | $shares = $this->user->getShares(); |
||
| 484 | $stored_filter = ['$and' => [ |
||
| 485 | [], |
||
| 486 | ['$or' => [ |
||
| 487 | ['owner' => $this->user->getId()], |
||
| 488 | ['shared' => ['$in' => $shares]], |
||
| 489 | ]], |
||
| 490 | ]]; |
||
| 491 | |||
| 492 | if (NodeInterface::DELETED_EXCLUDE === $deleted) { |
||
| 493 | $stored_filter['$and'][0]['deleted'] = false; |
||
| 494 | } elseif (NodeInterface::DELETED_ONLY === $deleted) { |
||
| 495 | $stored_filter['$and'][0]['deleted'] = ['$type' => 9]; |
||
| 496 | } |
||
| 497 | |||
| 498 | $stored_filter['$and'][0] = array_merge($filter, $stored_filter['$and'][0]); |
||
| 499 | |||
| 500 | $result = $this->db->storage->find($stored_filter, [ |
||
| 501 | 'skip' => $offset, |
||
| 502 | 'limit' => $limit, |
||
| 503 | ]); |
||
| 504 | |||
| 505 | $count = $this->db->storage->count($stored_filter); |
||
| 506 | |||
| 507 | foreach ($result as $node) { |
||
| 508 | try { |
||
| 509 | yield $this->initNode($node); |
||
| 510 | } catch (\Exception $e) { |
||
| 511 | $this->logger->error('remove node from result list, failed load node', [ |
||
| 512 | 'category' => get_class($this), |
||
| 513 | 'exception' => $e, |
||
| 514 | ]); |
||
| 515 | } |
||
| 516 | } |
||
| 517 | |||
| 518 | return $count; |
||
| 519 | } |
||
| 520 | |||
| 521 | /** |
||
| 522 | * Init node. |
||
| 523 | */ |
||
| 524 | public function initNode(array $node): NodeInterface |
||
| 525 | { |
||
| 526 | $id = $node['_id']; |
||
| 527 | |||
| 528 | if (isset($node['shared']) && true === $node['shared'] && null !== $this->user && $node['owner'] != $this->user->getId()) { |
||
| 529 | $node = $this->findReferenceNode($node); |
||
| 530 | } |
||
| 531 | |||
| 532 | if (isset($node['parent'])) { |
||
| 533 | $parent = $this->findNodeById($node['parent']); |
||
| 534 | } elseif ($node['_id'] !== null) { |
||
| 535 | $parent = $this->getRoot(); |
||
| 536 | } else { |
||
| 537 | $parent = null; |
||
| 538 | } |
||
| 539 | |||
| 540 | if (!array_key_exists('directory', $node)) { |
||
| 541 | throw new Exception('invalid node ['.$node['_id'].'] found, directory attribute does not exists'); |
||
| 542 | } |
||
| 543 | |||
| 544 | $instance = $this->node_factory->build($this, $node, $parent); |
||
| 545 | |||
| 546 | if (!$this->acl->isAllowed($instance, 'r')) { |
||
| 547 | if ($instance->isReference()) { |
||
| 548 | $instance->delete(true); |
||
| 549 | } |
||
| 550 | |||
| 551 | throw new ForbiddenException( |
||
| 552 | 'not allowed to access node', |
||
| 553 | ForbiddenException::NOT_ALLOWED_TO_ACCESS |
||
| 554 | ); |
||
| 555 | } |
||
| 556 | |||
| 557 | $loaded = isset($this->cache[(string) $node['_id']]); |
||
| 558 | |||
| 559 | if ($loaded === false) { |
||
| 560 | $this->cache[(string) $node['_id']] = $instance; |
||
| 561 | } |
||
| 562 | |||
| 563 | if ($loaded === false && isset($node['destroy']) && $node['destroy'] instanceof UTCDateTime && $node['destroy']->toDateTime()->format('U') <= time()) { |
||
| 564 | $this->logger->info('node ['.$node['_id'].'] is not accessible anmyore, destroy node cause of expired destroy flag', [ |
||
| 565 | 'category' => get_class($this), |
||
| 566 | ]); |
||
| 567 | |||
| 568 | $instance->delete(true); |
||
| 569 | |||
| 570 | throw new Exception\Conflict('node is not available anymore'); |
||
| 571 | } |
||
| 572 | |||
| 573 | if (PHP_SAPI === 'cli') { |
||
| 574 | unset($this->cache[(string) $node['_id']]); |
||
| 575 | } |
||
| 576 | |||
| 577 | return $instance; |
||
| 578 | } |
||
| 579 | |||
| 580 | /** |
||
| 581 | * Resolve shared node to reference or share depending who requested. |
||
| 582 | */ |
||
| 583 | protected function findReferenceNode(array $node): array |
||
| 623 | } |
||
| 624 |
Loading history...
Let’s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let’s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: