VersioningService::checkIn() - Code Metrics - Inspection of "Fill in VersioningService and usages" - dkd/php-cmis-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

unknown

created 2016-03-28 21:19 UTC

VersioningService::checkIn() B

↳ Parent: VersioningService

Complexity

Conditions	8
Paths	64

Size

Total Lines	58
Code Lines	43

Duplication

Lines	14
Ratio	24.14 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes	3
Bugs	1	Features	1

Metric	Value
c	3
b	1
f	1
dl	14
loc	58
ccs	0
cts	41
cp	0
rs	7.1977
cc	8
eloc	43
nc	64
nop	10
crap	72

How to fix Long Method Many Parameters

<?php
namespace Dkd\PhpCmis\Bindings\Browser;

/**
 * This file is part of php-cmis-lib.
 *
 * (c) Sascha Egerer <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

use Dkd\PhpCmis\Constants;
use Dkd\PhpCmis\Data\AclInterface;
use Dkd\PhpCmis\PropertyIds;
use GuzzleHttp\Stream\StreamInterface;
use Dkd\PhpCmis\Data\ExtensionDataInterface;
use Dkd\PhpCmis\Data\ObjectDataInterface;
use Dkd\PhpCmis\Data\PropertiesInterface;
use Dkd\PhpCmis\VersioningServiceInterface;
use Dkd\PhpCmis\Enum\IncludeRelationships;

/**
 * Versioning Service Browser Binding client.
 */
class VersioningService extends AbstractBrowserBindingService implements VersioningServiceInterface
{
    /**
     * Reverses the effect of a check-out.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId the identifier for the PWC
     * @param ExtensionDataInterface|null $extension
	 * @return ObjectDataInterface|null
     */
    public function cancelCheckOut($repositoryId, $objectId, ExtensionDataInterface $extension = null)
    {
		return $this->getJsonConverter()->convertObject(
			$this->post(
				$this->getObjectUrl($repositoryId, $objectId),
				$this->createQueryArray(
					Constants::CMISACTION_CANCEL_CHECK_OUT,
					array(),
					$extension
				)
			)->json()
		);
    }

    /**
     * Checks-in the private working copy (PWC) document.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId input: the identifier for the PWC,
     *      output: the identifier for the newly created version document
     * @param boolean $major indicator if the new version should become a major (<code>true</code>) or minor
     *      (<code>false</code>) version
     * @param PropertiesInterface|null $properties the property values that must be applied to the
     *      newly created document object
     * @param StreamInterface|null $contentStream the content stream that must be stored
     *      for the newly created document object
     * @param string|null $checkinComment a version comment
     * @param string[] $policies a list of policy IDs that must be applied to the newly created document object
     * @param AclInterface|null $addAces a list of ACEs that must be added to the newly created document object
     * @param AclInterface|null $removeAces a list of ACEs that must be removed from the newly created document object
     * @param ExtensionDataInterface|null $extension
	 * @return ObjectDataInterface|null
     */
    public function checkIn(
        $repositoryId,
        $objectId,
        $major = true,
        PropertiesInterface $properties = null,
        StreamInterface $contentStream = null,
        $checkinComment = null,
        array $policies = array(),
        AclInterface $addAces = null,
        AclInterface $removeAces = null,
        ExtensionDataInterface $extension = null
    ) {
		$queryArray = $this->createQueryArray(
			Constants::CMISACTION_CHECK_IN,
			array(
				Constants::PARAM_MAJOR => $major ? 'true' : 'false',
			),
			$extension
		);
		if ($properties) {
			$queryArray = array_replace(
				$queryArray,
				$this->convertPropertiesToQueryArray($properties)
			);
		}
		if ($checkinComment) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$queryArray[Constants::PARAM_CHECKIN_COMMENT] = $checkinComment;
		}
		if (!empty($policies)) {
			$queryArray = array_replace(
				$queryArray,
				$this->convertPolicyIdArrayToQueryArray($policies)
			);
		}
		if (!empty($removeAces)) {

			$queryArray = array_replace($queryArray, $this->convertAclToQueryArray(
				$removeAces,
				Constants::CONTROL_REMOVE_ACE_PRINCIPAL,
				Constants::CONTROL_REMOVE_ACE_PERMISSION
			));
		}
		if (!empty($addAces)) {

			$queryArray = array_replace($queryArray, $this->convertAclToQueryArray(
				$addAces,
				Constants::CONTROL_ADD_ACE_PRINCIPAL,
				Constants::CONTROL_ADD_ACE_PERMISSION
			));
		}
		if ($contentStream) {
			$queryArray['content'] = $contentStream;
		}
		return $this->getJsonConverter()->convertObject(
			$this->post(
				$this->getObjectUrl($repositoryId, $objectId),
				$queryArray
			)->json()
		);
    }

    /**
     * Create a private working copy of the document.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId input: the identifier for the document that should be checked out,
     *      output: the identifier for the newly created PWC
     * @param ExtensionDataInterface|null $extension
     * @param boolean|null $contentCopied output: indicator if the content of the original
     *      document has been copied to the PWC
	 * @return ObjectDataInterface|null
     */
    public function checkOut(
        $repositoryId,
        & $objectId,
        ExtensionDataInterface $extension = null,
        $contentCopied = null
    ) {
		$objectData = $this->getJsonConverter()->convertObject(
			$this->post(
				$this->getObjectUrl($repositoryId, $objectId),
				$this->createQueryArray(
					Constants::CMISACTION_CHECK_OUT,
					array(),
					$extension
				)
			)->json()
		);
		$objectId = $objectData->getId();
		return $objectData;
    }

    /**
     * Returns the list of all document objects in the specified version series,
     * sorted by the property "cmis:creationDate" descending.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId the identifier for the object
     * @param string $versionSeriesId the identifier for the object
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the allowable
     *      actions for the objects (default is <code>false</code>)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectDataInterface[] the complete version history of the version series
     */
    public function getAllVersions(
        $repositoryId,
        $objectId,
        $versionSeriesId,
        $filter = null,
        $includeAllowableActions = false,
        ExtensionDataInterface $extension = null
    ) {
        return $this->getJsonConverter()->convertObjectList(
			array(
				'objects' => $this->read(
					$this->getObjectUrl($repositoryId, $objectId, Constants::SELECTOR_VERSIONS)
				)->json()
			)
		)->getObjects();
    }

    /**
     * Get the latest document object in the version series.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId
     * @param string $versionSeriesId
     * @param boolean $major
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param boolean $includeAllowableActions
     * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects
     *      participate must be returned (default is <code>IncludeRelationships::NONE</code>)
     * @param string $renditionFilter indicates what set of renditions the repository must return whose kind
     *      matches this filter (default is "cmis:none")
     * @param boolean $includePolicyIds if <code>true</code>, then the repository must return the policy ids for
     *      the object (default is <code>false</code>)
     * @param boolean $includeAcl if <code>true</code>, then the repository must return the ACL for the object
     *      (default is <code>false</code>)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectDataInterface
     */
    public function getObjectOfLatestVersion(
        $repositoryId,
        $objectId,
        $versionSeriesId,
        $major = false,
        $filter = null,
        $includeAllowableActions = false,
        IncludeRelationships $includeRelationships = null,
        $renditionFilter = Constants::RENDITION_NONE,
        $includePolicyIds = false,
        $includeAcl = false,
        ExtensionDataInterface $extension = null
    ) {
		return $this->getJsonConverter()->convertObject(
			reset(
				$this->read(

					$this->getObjectUrl($repositoryId, $objectId, Constants::SELECTOR_VERSIONS)
				)->json()
			)
		);
    }

    /**
     * Get a subset of the properties for the latest document object in the version series.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId The identifier for the object
     * @param string $versionSeriesId The identifier for the version series.
     * @param boolean $major If <code>true</code>, then the repository MUST return the properties for the latest
     *      major version object in the version series.
     *      If <code>false</code>, the repository MUST return the properties for the latest
     *      (major or non-major) version object in the version series.
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param ExtensionDataInterface|null $extension
     * @return PropertiesInterface
     */
    public function getPropertiesOfLatestVersion(
        $repositoryId,
        $objectId,
        $versionSeriesId,
        $major = false,
        $filter = null,
        ExtensionDataInterface $extension = null
    ) {
        return $this->getObjectOfLatestVersion(
			$repositoryId,
			$objectId,
			$versionSeriesId,
			$major,
			$filter,
			$extension
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		)->getProperties();
    }

	/**
	 * @param string $action
	 * @param array $parameters
	 * @param ExtensionDataInterface $extension

	 * @return array
	 */
	protected function createQueryArray(
		$action,
		array $parameters = array(),
		ExtensionDataInterface $extension = null

	) {
		$queryArray = array_replace(
			$parameters,
			array(
				Constants::CONTROL_CMISACTION => $action,
				Constants::PARAM_SUCCINCT => $this->getSuccinct() ? 'true' : 'false',
			)
		);
		return $queryArray;
	}

}


1		<?php
2		namespace Dkd\PhpCmis\Bindings\Browser;
3
4		/**
5		* This file is part of php-cmis-lib.
6		*
7		* (c) Sascha Egerer <[email protected]>
8		*
9		* For the full copyright and license information, please view the LICENSE
10		* file that was distributed with this source code.
11		*/
12
13		use Dkd\PhpCmis\Constants;
14		use Dkd\PhpCmis\Data\AclInterface;
15		use Dkd\PhpCmis\PropertyIds;
16		use GuzzleHttp\Stream\StreamInterface;
17		use Dkd\PhpCmis\Data\ExtensionDataInterface;
18		use Dkd\PhpCmis\Data\ObjectDataInterface;
19		use Dkd\PhpCmis\Data\PropertiesInterface;
20		use Dkd\PhpCmis\VersioningServiceInterface;
21		use Dkd\PhpCmis\Enum\IncludeRelationships;
22
23		/**
24		* Versioning Service Browser Binding client.
25		*/
26		class VersioningService extends AbstractBrowserBindingService implements VersioningServiceInterface
27		{
28		/**
29		* Reverses the effect of a check-out.
30		*
31		* @param string $repositoryId the identifier for the repository
32		* @param string $objectId the identifier for the PWC
33		* @param ExtensionDataInterface\|null $extension
34		* @return ObjectDataInterface\|null
35		*/
36		public function cancelCheckOut($repositoryId, $objectId, ExtensionDataInterface $extension = null)
37		{
38		return $this->getJsonConverter()->convertObject(
39		$this->post(
40		$this->getObjectUrl($repositoryId, $objectId),
41		$this->createQueryArray(
42		Constants::CMISACTION_CANCEL_CHECK_OUT,
43		array(),
44		$extension
45		)
46		)->json()
47		);
48		}
49
50		/**
51		* Checks-in the private working copy (PWC) document.
52		*
53		* @param string $repositoryId the identifier for the repository
54		* @param string $objectId input: the identifier for the PWC,
55		* output: the identifier for the newly created version document
56		* @param boolean $major indicator if the new version should become a major (<code>true</code>) or minor
57		* (<code>false</code>) version
58		* @param PropertiesInterface\|null $properties the property values that must be applied to the
59		* newly created document object
60		* @param StreamInterface\|null $contentStream the content stream that must be stored
61		* for the newly created document object
62		* @param string\|null $checkinComment a version comment
63		* @param string[] $policies a list of policy IDs that must be applied to the newly created document object
64		* @param AclInterface\|null $addAces a list of ACEs that must be added to the newly created document object
65		* @param AclInterface\|null $removeAces a list of ACEs that must be removed from the newly created document object
66		* @param ExtensionDataInterface\|null $extension
67		* @return ObjectDataInterface\|null
68		*/
69		public function checkIn(
70		$repositoryId,
71		$objectId,
72		$major = true,
73		PropertiesInterface $properties = null,
74		StreamInterface $contentStream = null,
75		$checkinComment = null,
76		array $policies = array(),
77		AclInterface $addAces = null,
78		AclInterface $removeAces = null,
79		ExtensionDataInterface $extension = null
80		) {
81		$queryArray = $this->createQueryArray(
82		Constants::CMISACTION_CHECK_IN,
83		array(
84		Constants::PARAM_MAJOR => $major ? 'true' : 'false',
85		),
86		$extension
87		);
88		if ($properties) {
89		$queryArray = array_replace(
90		$queryArray,
91		$this->convertPropertiesToQueryArray($properties)
92		);
93		}
94		if ($checkinComment) {
		0 ignored issues – show Bug Best Practice introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report The expression `$checkinComment` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
95		$queryArray[Constants::PARAM_CHECKIN_COMMENT] = $checkinComment;
96		}
97		if (!empty($policies)) {
98		$queryArray = array_replace(
99		$queryArray,
100		$this->convertPolicyIdArrayToQueryArray($policies)
101		);
102		}
103	View Code Duplication	if (!empty($removeAces)) {
		0 ignored issues – show Duplication introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
104		$queryArray = array_replace($queryArray, $this->convertAclToQueryArray(
105		$removeAces,
106		Constants::CONTROL_REMOVE_ACE_PRINCIPAL,
107		Constants::CONTROL_REMOVE_ACE_PERMISSION
108		));
109		}
110	View Code Duplication	if (!empty($addAces)) {
		0 ignored issues – show Duplication introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
111		$queryArray = array_replace($queryArray, $this->convertAclToQueryArray(
112		$addAces,
113		Constants::CONTROL_ADD_ACE_PRINCIPAL,
114		Constants::CONTROL_ADD_ACE_PERMISSION
115		));
116		}
117		if ($contentStream) {
118		$queryArray['content'] = $contentStream;
119		}
120		return $this->getJsonConverter()->convertObject(
121		$this->post(
122		$this->getObjectUrl($repositoryId, $objectId),
123		$queryArray
124		)->json()
125		);
126		}
127
128		/**
129		* Create a private working copy of the document.
130		*
131		* @param string $repositoryId the identifier for the repository
132		* @param string $objectId input: the identifier for the document that should be checked out,
133		* output: the identifier for the newly created PWC
134		* @param ExtensionDataInterface\|null $extension
135		* @param boolean\|null $contentCopied output: indicator if the content of the original
136		* document has been copied to the PWC
137		* @return ObjectDataInterface\|null
138		*/
139		public function checkOut(
140		$repositoryId,
141		& $objectId,
142		ExtensionDataInterface $extension = null,
143		$contentCopied = null
144		) {
145		$objectData = $this->getJsonConverter()->convertObject(
146		$this->post(
147		$this->getObjectUrl($repositoryId, $objectId),
148		$this->createQueryArray(
149		Constants::CMISACTION_CHECK_OUT,
150		array(),
151		$extension
152		)
153		)->json()
154		);
155		$objectId = $objectData->getId();
156		return $objectData;
157		}
158
159		/**
160		* Returns the list of all document objects in the specified version series,
161		* sorted by the property "cmis:creationDate" descending.
162		*
163		* @param string $repositoryId the identifier for the repository
164		* @param string $objectId the identifier for the object
165		* @param string $versionSeriesId the identifier for the object
166		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
167		* returned by the repository (default is repository specific)
168		* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the allowable
169		* actions for the objects (default is <code>false</code>)
170		* @param ExtensionDataInterface\|null $extension
171		* @return ObjectDataInterface[] the complete version history of the version series
172		*/
173		public function getAllVersions(
174		$repositoryId,
175		$objectId,
176		$versionSeriesId,
177		$filter = null,
178		$includeAllowableActions = false,
179		ExtensionDataInterface $extension = null
180		) {
181		return $this->getJsonConverter()->convertObjectList(
182		array(
183		'objects' => $this->read(
184		$this->getObjectUrl($repositoryId, $objectId, Constants::SELECTOR_VERSIONS)
185		)->json()
186		)
187		)->getObjects();
188		}
189
190		/**
191		* Get the latest document object in the version series.
192		*
193		* @param string $repositoryId the identifier for the repository
194		* @param string $objectId
195		* @param string $versionSeriesId
196		* @param boolean $major
197		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
198		* returned by the repository (default is repository specific)
199		* @param boolean $includeAllowableActions
200		* @param IncludeRelationships\|null $includeRelationships indicates what relationships in which the objects
201		* participate must be returned (default is <code>IncludeRelationships::NONE</code>)
202		* @param string $renditionFilter indicates what set of renditions the repository must return whose kind
203		* matches this filter (default is "cmis:none")
204		* @param boolean $includePolicyIds if <code>true</code>, then the repository must return the policy ids for
205		* the object (default is <code>false</code>)
206		* @param boolean $includeAcl if <code>true</code>, then the repository must return the ACL for the object
207		* (default is <code>false</code>)
208		* @param ExtensionDataInterface\|null $extension
209		* @return ObjectDataInterface
210		*/
211		public function getObjectOfLatestVersion(
212		$repositoryId,
213		$objectId,
214		$versionSeriesId,
215		$major = false,
216		$filter = null,
217		$includeAllowableActions = false,
218		IncludeRelationships $includeRelationships = null,
219		$renditionFilter = Constants::RENDITION_NONE,
220		$includePolicyIds = false,
221		$includeAcl = false,
222		ExtensionDataInterface $extension = null
223		) {
224		return $this->getJsonConverter()->convertObject(
225		reset(
226		$this->read(
		0 ignored issues – show Bug introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report `$this->read($this->getOb...CTOR_VERSIONS))->json()` cannot be passed to `reset()` as the parameter `$array` expects a reference. Loading history...
227		$this->getObjectUrl($repositoryId, $objectId, Constants::SELECTOR_VERSIONS)
228		)->json()
229		)
230		);
231		}
232
233		/**
234		* Get a subset of the properties for the latest document object in the version series.
235		*
236		* @param string $repositoryId the identifier for the repository
237		* @param string $objectId The identifier for the object
238		* @param string $versionSeriesId The identifier for the version series.
239		* @param boolean $major If <code>true</code>, then the repository MUST return the properties for the latest
240		* major version object in the version series.
241		* If <code>false</code>, the repository MUST return the properties for the latest
242		* (major or non-major) version object in the version series.
243		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
244		* returned by the repository (default is repository specific)
245		* @param ExtensionDataInterface\|null $extension
246		* @return PropertiesInterface
247		*/
248		public function getPropertiesOfLatestVersion(
249		$repositoryId,
250		$objectId,
251		$versionSeriesId,
252		$major = false,
253		$filter = null,
254		ExtensionDataInterface $extension = null
255		) {
256		return $this->getObjectOfLatestVersion(
257		$repositoryId,
258		$objectId,
259		$versionSeriesId,
260		$major,
261		$filter,
262		$extension
		0 ignored issues – show Documentation introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report `$extension` is of type `null\|object<Dkd\PhpCmis\...ExtensionDataInterface>`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
263		)->getProperties();
264		}
265
266		/**
267		* @param string $action
268		* @param array $parameters
269		* @param ExtensionDataInterface $extension
		0 ignored issues – show Documentation introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report Should the type for parameter `$extension` not be `null\|ExtensionDataInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
270		* @return array
271		*/
272		protected function createQueryArray(
273		$action,
274		array $parameters = array(),
275		ExtensionDataInterface $extension = null
		0 ignored issues – show Unused Code introduced 2016-03-28 21:25 UTC by Report Bug Copy Issue Report The parameter `$extension` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
276		) {
277		$queryArray = array_replace(
278		$parameters,
279		array(
280		Constants::CONTROL_CMISACTION => $action,
281		Constants::PARAM_SUCCINCT => $this->getSuccinct() ? 'true' : 'false',
282		)
283		);
284		return $queryArray;
285		}
286
287		}
288

dkd / php-cmis-client

GitHub Access Token became invalid

Pull Request — master (#15)

VersioningService::checkIn() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like