dkd /
php-cmis-client
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like ObjectService 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 ObjectService, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 37 | class ObjectService extends AbstractBrowserBindingService implements ObjectServiceInterface |
||
| 38 | { |
||
| 39 | /** |
||
| 40 | * Appends the content stream to the content of the document. |
||
| 41 | * |
||
| 42 | * The stream in contentStream is consumed but not closed by this method. |
||
| 43 | * |
||
| 44 | * @param string $repositoryId the identifier for the repository |
||
| 45 | * @param string $objectId The identifier for the object. The repository might return a different/new object id |
||
| 46 | * @param StreamInterface $contentStream The content stream to append |
||
| 47 | * @param boolean $isLastChunk Indicates if this content stream is the last chunk |
||
| 48 | * @param string|null $changeToken The last change token of this object that the client received. |
||
| 49 | * The repository might return a new change token (default is <code>null</code>) |
||
| 50 | * @param ExtensionDataInterface|null $extension |
||
| 51 | */ |
||
| 52 | public function appendContentStream( |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Updates properties and secondary types of one or more objects. |
||
| 65 | * |
||
| 66 | * @param string $repositoryId the identifier for the repository |
||
| 67 | * @param BulkUpdateObjectIdAndChangeTokenInterface[] $objectIdsAndChangeTokens |
||
| 68 | * @param PropertiesInterface $properties |
||
| 69 | * @param string[] $addSecondaryTypeIds the secondary types to apply |
||
| 70 | * @param string[] $removeSecondaryTypeIds the secondary types to remove |
||
| 71 | * @param ExtensionDataInterface|null $extension |
||
| 72 | * @return BulkUpdateObjectIdAndChangeTokenInterface[] |
||
| 73 | */ |
||
| 74 | public function bulkUpdateProperties( |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Creates a document object of the specified type (given by the cmis:objectTypeId property) |
||
| 87 | * in the (optionally) specified location. |
||
| 88 | * |
||
| 89 | * @param string $repositoryId the identifier for the repository |
||
| 90 | * @param PropertiesInterface $properties the property values that must be applied to the newly |
||
| 91 | * created document object |
||
| 92 | * @param string|null $folderId if specified, the identifier for the folder that must be the parent |
||
| 93 | * folder for the newly created document object |
||
| 94 | * @param StreamInterface|null $contentStream the content stream that must be stored for the newly |
||
| 95 | * created document object |
||
| 96 | * @param VersioningState|null $versioningState specifies what the versioning state of the newly created object |
||
| 97 | * must be (default is <code>VersioningState::MAJOR</code>) |
||
| 98 | * @param string[] $policies a list of policy IDs that must be applied to the newly created document object |
||
| 99 | * @param AclInterface|null $addAces a list of ACEs that must be added to the newly created document object, |
||
| 100 | * either using the ACL from folderId if specified, or being applied if no folderId is specified |
||
| 101 | * @param AclInterface|null $removeAces a list of ACEs that must be removed from the newly created document object, |
||
| 102 | * either using the ACL from folderId if specified, or being ignored if no folderId is specified |
||
| 103 | * @param ExtensionDataInterface|null $extension |
||
| 104 | * @return string|null Returns the new object id or <code>null</code> if the repository sent an empty |
||
| 105 | * result (which should not happen) |
||
| 106 | */ |
||
| 107 | 3 | public function createDocument( |
|
| 173 | |||
| 174 | /** |
||
| 175 | * Creates a document object as a copy of the given source document in the (optionally) specified location. |
||
| 176 | * |
||
| 177 | * @param string $repositoryId the identifier for the repository |
||
| 178 | * @param string $sourceId the identifier for the source document |
||
| 179 | * @param PropertiesInterface $properties the property values that must be applied to the newly |
||
| 180 | * created document object |
||
| 181 | * @param string|null $folderId if specified, the identifier for the folder that must be the parent folder for the |
||
| 182 | * newly created document object |
||
| 183 | * @param VersioningState|null $versioningState specifies what the versioning state of the newly created object |
||
| 184 | * must be (default is <code>VersioningState::MAJOR</code>) |
||
| 185 | * @param string[] $policies a list of policy IDs that must be applied to the newly created document object |
||
| 186 | * @param AclInterface|null $addAces a list of ACEs that must be added to the newly created document object, |
||
| 187 | * either using the ACL from folderId if specified, or being applied if no folderId is specified |
||
| 188 | * @param AclInterface|null $removeAces a list of ACEs that must be removed from the newly created document object, |
||
| 189 | * either using the ACL from folderId if specified, or being ignored if no folderId is specified |
||
| 190 | * @param ExtensionDataInterface|null $extension |
||
| 191 | * @return string|null Returns the new object id or <code>null</code> if the repository sent an empty |
||
| 192 | * result (which should not happen) |
||
| 193 | */ |
||
| 194 | 2 | public function createDocumentFromSource( |
|
| 243 | |||
| 244 | /** |
||
| 245 | * Creates a folder object of the specified type (given by the cmis:objectTypeId property) in |
||
| 246 | * the specified location. |
||
| 247 | * |
||
| 248 | * @param string $repositoryId the identifier for the repository |
||
| 249 | * @param PropertiesInterface $properties the property values that must be applied to the newly |
||
| 250 | * created document object |
||
| 251 | * @param string $folderId if specified, the identifier for the folder that must be the parent folder for the |
||
| 252 | * newly created document object |
||
| 253 | * @param string[] $policies a list of policy IDs that must be applied to the newly created document object |
||
| 254 | * @param AclInterface|null $addAces a list of ACEs that must be added to the newly created document object, |
||
| 255 | * either using the ACL from folderId if specified, or being applied if no folderId is specified |
||
| 256 | * @param AclInterface|null $removeAces a list of ACEs that must be removed from the newly created document object, |
||
| 257 | * either using the ACL from folderId if specified, or being ignored if no folderId is specified |
||
| 258 | * @param ExtensionDataInterface|null $extension |
||
| 259 | * @return string|null Returns the new object id or <code>null</code> if the repository sent an empty |
||
| 260 | * result (which should not happen) |
||
| 261 | */ |
||
| 262 | 2 | View Code Duplication | public function createFolder( |
| 291 | |||
| 292 | /** |
||
| 293 | * Creates an item object of the specified type (given by the cmis:objectTypeId property). |
||
| 294 | * |
||
| 295 | * @param string $repositoryId The identifier for the repository |
||
| 296 | * @param PropertiesInterface $properties The property values that must be applied to the newly |
||
| 297 | * created document object |
||
| 298 | * @param string|null $folderId If specified, the identifier for the folder that must be the parent folder for the |
||
| 299 | * newly created document object |
||
| 300 | * @param string[] $policies A list of policy IDs that must be applied to the newly created document object |
||
| 301 | * @param AclInterface|null $addAces A list of ACEs that must be added to the newly created document object, |
||
| 302 | * either using the ACL from folderId if specified, or being applied if no folderId is specified |
||
| 303 | * @param AclInterface|null $removeAces A list of ACEs that must be removed from the newly created document object, |
||
| 304 | * either using the ACL from folderId if specified, or being ignored if no folderId is specified |
||
| 305 | * @param ExtensionDataInterface|null $extension |
||
| 306 | * @return string|null Returns the new item id or <code>null</code> if the repository sent an empty |
||
| 307 | * result (which should not happen) |
||
| 308 | */ |
||
| 309 | 2 | public function createItem( |
|
| 343 | |||
| 344 | /** |
||
| 345 | * Creates a policy object of the specified type (given by the cmis:objectTypeId property). |
||
| 346 | * |
||
| 347 | * @param string $repositoryId The identifier for the repository |
||
| 348 | * @param PropertiesInterface $properties The property values that must be applied to the newly |
||
| 349 | * created document object |
||
| 350 | * @param string|null $folderId If specified, the identifier for the folder that must be the parent folder for the |
||
| 351 | * newly created document object |
||
| 352 | * @param string[] $policies A list of policy IDs that must be applied to the newly created document object |
||
| 353 | * @param AclInterface|null $addAces A list of ACEs that must be added to the newly created document object, |
||
| 354 | * either using the ACL from folderId if specified, or being applied if no folderId is specified |
||
| 355 | * @param AclInterface|null $removeAces A list of ACEs that must be removed from the newly created document object, |
||
| 356 | * either using the ACL from folderId if specified, or being ignored if no folderId is specified |
||
| 357 | * @param ExtensionDataInterface|null $extension |
||
| 358 | * @return string The id of the newly-created policy. |
||
| 359 | */ |
||
| 360 | public function createPolicy( |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Creates a relationship object of the specified type (given by the cmis:objectTypeId property). |
||
| 374 | * |
||
| 375 | * @param string $repositoryId the identifier for the repository |
||
| 376 | * @param PropertiesInterface $properties the property values that must be applied to the newly |
||
| 377 | * created document object |
||
| 378 | * @param string[] $policies a list of policy IDs that must be applied to the newly created document object |
||
| 379 | * @param AclInterface|null $addAces a list of ACEs that must be added to the newly created document object, |
||
| 380 | * either using the ACL from folderId if specified, or being applied if no folderId is specified |
||
| 381 | * @param AclInterface|null $removeAces a list of ACEs that must be removed from the newly created document object, |
||
| 382 | * either using the ACL from folderId if specified, or being ignored if no folderId is specified |
||
| 383 | * @param ExtensionDataInterface|null $extension |
||
| 384 | * @return string|null Returns the new item id of the relationship object or <code>null</code> if the repository |
||
| 385 | * sent an empty result (which should not happen) |
||
| 386 | */ |
||
| 387 | View Code Duplication | public function createRelationship( |
|
| 415 | |||
| 416 | /** |
||
| 417 | * Deletes the content stream for the specified document object. |
||
| 418 | * |
||
| 419 | * @param string $repositoryId the identifier for the repository |
||
| 420 | * @param string $objectId the identifier for the object. The repository might return a different/new object id |
||
| 421 | * @param string|null $changeToken the last change token of this object that the client received. |
||
| 422 | * The repository might return a new change token (default is <code>null</code>) |
||
| 423 | * @param ExtensionDataInterface|null $extension |
||
| 424 | * @throws CmisInvalidArgumentException If $objectId is empty |
||
| 425 | */ |
||
| 426 | 3 | public function deleteContentStream( |
|
| 464 | |||
| 465 | /** |
||
| 466 | * Deletes the specified object. |
||
| 467 | * |
||
| 468 | * @param string $repositoryId the identifier for the repository |
||
| 469 | * @param string $objectId the identifier for the object |
||
| 470 | * @param boolean $allVersions If <code>true</code> then delete all versions of the document, otherwise delete only |
||
| 471 | * the document object specified (default is <code>true</code>) |
||
| 472 | * @param ExtensionDataInterface|null $extension |
||
| 473 | */ |
||
| 474 | 2 | public function deleteObject( |
|
| 490 | |||
| 491 | /** |
||
| 492 | * Deletes the specified folder object and all of its child- and descendant-objects. |
||
| 493 | * |
||
| 494 | * @param string $repositoryId the identifier for the repository |
||
| 495 | * @param string $folderId the identifier for the folder |
||
| 496 | * @param boolean $allVersions If <code>true</code> then delete all versions of the document, otherwise delete only |
||
| 497 | * the document object specified (default is <code>true</code>) |
||
| 498 | * @param UnfileObject|null $unfileObjects defines how the repository must process file-able child- or |
||
| 499 | * descendant-objects (default is <code>UnfileObject::DELETE</code>) |
||
| 500 | * @param boolean $continueOnFailure If <code>true</code>, then the repository should continue attempting to |
||
| 501 | * perform this operation even if deletion of a child- or descendant-object in the specified folder cannot |
||
| 502 | * be deleted |
||
| 503 | * @param ExtensionDataInterface|null $extension |
||
| 504 | * @return FailedToDeleteDataInterface Returns a list of object ids that could not be deleted |
||
| 505 | */ |
||
| 506 | 4 | public function deleteTree( |
|
| 532 | |||
| 533 | /** |
||
| 534 | * Gets the list of allowable actions for an object. |
||
| 535 | * |
||
| 536 | * @param string $repositoryId the identifier for the repository |
||
| 537 | * @param string $objectId the identifier for the object |
||
| 538 | * @param ExtensionDataInterface|null $extension |
||
| 539 | * @return AllowableActionsInterface |
||
| 540 | */ |
||
| 541 | public function getAllowableActions($repositoryId, $objectId, ExtensionDataInterface $extension = null) |
||
| 545 | |||
| 546 | /** |
||
| 547 | * Gets the content stream for the specified document object, or gets a rendition stream for |
||
| 548 | * a specified rendition of a document or folder object. |
||
| 549 | * |
||
| 550 | * @param string $repositoryId the identifier for the repository |
||
| 551 | * @param string $objectId the identifier for the object |
||
| 552 | * @param string|null $streamId The identifier for the rendition stream, when used to get a rendition stream. |
||
| 553 | * For documents, if not provided then this method returns the content stream. For folders, |
||
| 554 | * it MUST be provided. |
||
| 555 | * @param integer|null $offset |
||
| 556 | * @param integer|null $length |
||
| 557 | * @param ExtensionDataInterface|null $extension |
||
| 558 | * @return StreamInterface|null |
||
| 559 | * @throws CmisInvalidArgumentException If object id is empty |
||
| 560 | */ |
||
| 561 | 3 | public function getContentStream( |
|
| 593 | |||
| 594 | /** |
||
| 595 | * Gets the specified information for the object specified by id. |
||
| 596 | * |
||
| 597 | * @param string $repositoryId the identifier for the repository |
||
| 598 | * @param string $objectId the identifier for the object |
||
| 599 | * @param string|null $filter a comma-separated list of query names that defines which properties must be |
||
| 600 | * returned by the repository (default is repository specific) |
||
| 601 | * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the allowable |
||
| 602 | * actions for the object (default is <code>false</code>) |
||
| 603 | * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects |
||
| 604 | * participate must be returned (default is <code>IncludeRelationships::NONE</code>) |
||
| 605 | * @param string $renditionFilter indicates what set of renditions the repository must return whose kind |
||
| 606 | * matches this filter (default is "cmis:none") |
||
| 607 | * @param boolean $includePolicyIds if <code>true</code>, then the repository must return the policy ids for |
||
| 608 | * the object (default is <code>false</code>) |
||
| 609 | * @param boolean $includeAcl if <code>true</code>, then the repository must return the ACL for the object |
||
| 610 | * (default is <code>false</code>) |
||
| 611 | * @param ExtensionDataInterface|null $extension |
||
| 612 | * @return ObjectDataInterface|null Returns object of type ObjectDataInterface or <code>null</code> |
||
| 613 | * if the repository response was empty |
||
| 614 | */ |
||
| 615 | 3 | View Code Duplication | public function getObject( |
| 651 | |||
| 652 | /** |
||
| 653 | * Gets the specified information for the object specified by path. |
||
| 654 | * |
||
| 655 | * @param string $repositoryId the identifier for the repository |
||
| 656 | * @param string $path the path to the object |
||
| 657 | * @param string|null $filter a comma-separated list of query names that defines which properties must be |
||
| 658 | * returned by the repository (default is repository specific) |
||
| 659 | * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the allowable |
||
| 660 | * actions for the object (default is <code>false</code>) |
||
| 661 | * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects |
||
| 662 | * participate must be returned (default is <code>IncludeRelationships::NONE</code>) |
||
| 663 | * @param string $renditionFilter indicates what set of renditions the repository must return whose kind |
||
| 664 | * matches this filter (default is "cmis:none") |
||
| 665 | * @param boolean $includePolicyIds if <code>true</code>, then the repository must return the policy ids for |
||
| 666 | * the object (default is <code>false</code>) |
||
| 667 | * @param boolean $includeAcl if <code>true</code>, then the repository must return the ACL for the object |
||
| 668 | * (default is <code>false</code>) |
||
| 669 | * @param ExtensionDataInterface|null $extension |
||
| 670 | * @return ObjectDataInterface|null Returns object of type <code>ObjectDataInterface</code> or <code>null</code> |
||
| 671 | * if the repository response was empty |
||
| 672 | */ |
||
| 673 | 3 | View Code Duplication | public function getObjectByPath( |
| 709 | |||
| 710 | /** |
||
| 711 | * Gets the list of properties for an object. |
||
| 712 | * |
||
| 713 | * @param string $repositoryId the identifier for the repository |
||
| 714 | * @param string $objectId the identifier for the object |
||
| 715 | * @param string|null $filter a comma-separated list of query names that defines which properties must be |
||
| 716 | * returned by the repository (default is repository specific) |
||
| 717 | * @param ExtensionDataInterface|null $extension |
||
| 718 | * @return PropertiesInterface |
||
| 719 | */ |
||
| 720 | 2 | public function getProperties( |
|
| 747 | |||
| 748 | /** |
||
| 749 | * Gets the list of associated renditions for the specified object. |
||
| 750 | * Only rendition attributes are returned, not rendition stream. |
||
| 751 | * |
||
| 752 | * @param string $repositoryId the identifier for the repository |
||
| 753 | * @param string $objectId the identifier for the object |
||
| 754 | * @param string $renditionFilter indicates what set of renditions the repository must return whose kind |
||
| 755 | * matches this filter (default is "cmis:none") |
||
| 756 | * @param integer|null $maxItems the maximum number of items to return in a response |
||
| 757 | * (default is repository specific) |
||
| 758 | * @param integer $skipCount number of potential results that the repository MUST skip/page over before |
||
| 759 | * returning any results (default is 0) |
||
| 760 | * @param ExtensionDataInterface|null $extension |
||
| 761 | * @return RenditionDataInterface[] |
||
| 762 | * @throws CmisInvalidArgumentException If object id is empty or skip count not of type integer |
||
| 763 | */ |
||
| 764 | 2 | public function getRenditions( |
|
| 796 | |||
| 797 | /** |
||
| 798 | * Moves the specified file-able object from one folder to another. |
||
| 799 | * |
||
| 800 | * @param string $repositoryId the identifier for the repository |
||
| 801 | * @param string $objectId the identifier for the object. The repository might return a different/new object id |
||
| 802 | * @param string $targetFolderId the identifier for the target folder |
||
| 803 | * @param string $sourceFolderId the identifier for the source folder |
||
| 804 | * @param ExtensionDataInterface|null $extension |
||
| 805 | * @return ObjectDataInterface|null Returns object of type ObjectDataInterface or <code>null</code> |
||
| 806 | * if the repository response was empty |
||
| 807 | */ |
||
| 808 | 1 | public function moveObject( |
|
| 833 | |||
| 834 | /** |
||
| 835 | * Sets the content stream for the specified document object. |
||
| 836 | * |
||
| 837 | * @param string $repositoryId The identifier for the repository |
||
| 838 | * @param string $objectId The identifier for the object. The repository might return a different/new object id |
||
| 839 | * @param StreamInterface $contentStream The content stream |
||
| 840 | * @param boolean $overwriteFlag If <code>true</code>, then the repository must replace the existing content stream |
||
| 841 | * for the object (if any) with the input content stream. If <code>false</code>, then the repository must |
||
| 842 | * only set the input content stream for the object if the object currently does not have a content stream |
||
| 843 | * (default is <code>true</code>) |
||
| 844 | * @param string|null $changeToken The last change token of this object that the client received. |
||
| 845 | * The repository might return a new change token (default is <code>null</code>) |
||
| 846 | * @param ExtensionDataInterface|null $extension |
||
| 847 | * @throws CmisInvalidArgumentException If object id is empty |
||
| 848 | */ |
||
| 849 | 3 | public function setContentStream( |
|
| 894 | |||
| 895 | /** |
||
| 896 | * Updates properties of the specified object. |
||
| 897 | * |
||
| 898 | * @param string $repositoryId The identifier for the repository |
||
| 899 | * @param string $objectId The identifier for the object. The repository might return a different/new object id |
||
| 900 | * @param PropertiesInterface $properties The updated property values that must be applied to the object |
||
| 901 | * @param string|null $changeToken The last change token of this object that the client received. |
||
| 902 | * The repository might return a new change token (default is <code>null</code>) |
||
| 903 | * @param ExtensionDataInterface|null $extension |
||
| 904 | * @throws CmisInvalidArgumentException If $objectId is empty |
||
| 905 | */ |
||
| 906 | 3 | public function updateProperties( |
|
| 941 | } |
||
| 942 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.