OperationContext - Code Metrics - dkd/php-cmis-client - Measure and Improve Code Quality continuously with Scrutinizer

OperationContext B
last analyzed 2019-11-19 13:16 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	387
Duplicated Lines	12.66 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	47
lcom	1
cbo	1
dl	49
loc	387
ccs	126
cts	126
cp	1
rs	8.64
c	0
b	0
f	0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	isCacheEnabled()	0	4	1
A	setCacheEnabled()	0	5	1
A	getCacheKey()	0	15	5
A	getFilter()	0	4	1
A	setFilter()	25	25	5
A	isIncludeAcls()	0	4	1
A	setIncludeAcls()	0	6	1
A	isIncludeAllowableActions()	0	4	1
A	setIncludeAllowableActions()	0	5	1
A	isIncludePathSegments()	0	4	1
A	setIncludePathSegments()	0	5	1
A	isIncludePolicies()	0	4	1
A	setIncludePolicies()	0	5	1
A	getIncludeRelationships()	0	4	1
A	setIncludeRelationships()	0	6	1
A	loadSecondaryTypeProperties()	0	4	1
A	setLoadSecondaryTypeProperties()	0	6	1
A	getMaxItemsPerPage()	0	4	1
A	setMaxItemsPerPage()	0	9	2
A	getOrderBy()	0	4	1
A	setOrderBy()	0	6	1
A	getRenditionFilter()	0	4	1
A	setRenditionFilter()	24	24	5
A	getQueryFilterString()	0	21	4
A	getRenditionFilterString()	0	8	2
A	setFilterString()	0	10	2
A	setRenditionFilterString()	0	10	2

How to fix Duplicated Code Complexity

Duplicated Code

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:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like OperationContext 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 OperationContext, and based on these observations, apply Extract Interface, too.

<?php
namespace Dkd\PhpCmis;

/*
 * This file is part of php-cmis-client.
 *
 * (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\Enum\IncludeRelationships;

/**
 * OperationContext implementation
 */
class OperationContext implements OperationContextInterface
{
    const PROPERTIES_WILDCARD = '*';

    /**
     * @var string[]
     */
    private $filter = [];

    /**
     * @var boolean
     */
    private $loadSecondaryTypeProperties = false;

    /**
     * @var boolean
     */
    private $includeAcls = false;

    /**
     * @var boolean
     */
    private $includeAllowableActions = true;

    /**
     * @var boolean
     */
    private $includePolicies = false;

    /**
     * @var IncludeRelationships
     */
    private $includeRelationships = null;

    /**
     * @var string[]
     */
    private $renditionFilter = [];

    /**
     * @var boolean
     */
    private $includePathSegments = true;

    /**
     * @var string
     */
    private $orderBy = null;

    /**
     * @var boolean
     */
    private $cacheEnabled = false;

    /**
     * @var integer
     */
    private $maxItemsPerPage = 100;

    /**
     * Creates new Operation Context
     */
    public function __construct()
    {
        $this->setRenditionFilter([]);
        $this->includeRelationships = IncludeRelationships::cast(IncludeRelationships::NONE);
    }

    /**
     * {@inheritdoc}
     */
    public function isCacheEnabled()
    {
        return $this->cacheEnabled;
    }

    /**
     * {@inheritdoc}
     */
    public function setCacheEnabled($cacheEnabled)
    {
        $this->cacheEnabled = (boolean) $cacheEnabled;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getCacheKey()
    {
        $cacheKey = $this->isIncludeAcls() ? '1' : '0';
        $cacheKey .= $this->isIncludeAllowableActions() ? '1' : '0';
        $cacheKey .= $this->isIncludePolicies() ? '1' : '0';
        $cacheKey .= $this->isIncludePathSegments() ? '1' : '0';
        $cacheKey .= '|';
        $cacheKey .= $this->getQueryFilterString();
        $cacheKey .= '|';
        $cacheKey .= (string) $this->getIncludeRelationships();
        $cacheKey .= '|';
        $cacheKey .= $this->getRenditionFilterString();

        return $cacheKey;
    }

    /**
     * {@inheritdoc}
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * {@inheritdoc}
     */
    public function setFilter(array $propertyFilters)

    {
        $filters = [];
        foreach ($propertyFilters as $filter) {
            $filter = trim((string) $filter);
            if ($filter === '') {
                continue;
            }

            if (self::PROPERTIES_WILDCARD === $filter) {
                $filters[] = self::PROPERTIES_WILDCARD;
                break;
            }

            if (stripos($filter, ',') !== false) {
                throw new \InvalidArgumentException('Filter must not contain a comma!');
            }

            $filters[] = $filter;
        }

        $this->filter = $filters;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isIncludeAcls()
    {
        return $this->includeAcls;
    }

    /**
     * {@inheritdoc}
     */
    public function setIncludeAcls($includeAcls)
    {
        $this->includeAcls = $includeAcls;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isIncludeAllowableActions()
    {
        return $this->includeAllowableActions;
    }

    /**
     * {@inheritdoc}
     */
    public function setIncludeAllowableActions($includeAllowableActions)
    {
        $this->includeAllowableActions = $includeAllowableActions;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isIncludePathSegments()
    {
        return $this->includePathSegments;
    }

    /**
     * {@inheritdoc}
     */
    public function setIncludePathSegments($includePathSegments)
    {
        $this->includePathSegments = $includePathSegments;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isIncludePolicies()
    {
        return $this->includePolicies;
    }

    /**
     * {@inheritdoc}
     */
    public function setIncludePolicies($includePolicies)
    {
        $this->includePolicies = $includePolicies;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getIncludeRelationships()
    {
        return $this->includeRelationships;
    }

    /**
     * {@inheritdoc}
     */
    public function setIncludeRelationships(IncludeRelationships $includeRelationships)
    {
        $this->includeRelationships = $includeRelationships;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function loadSecondaryTypeProperties()
    {
        return $this->loadSecondaryTypeProperties;
    }

    /**
     * {@inheritdoc}
     */
    public function setLoadSecondaryTypeProperties($loadSecondaryTypeProperties)
    {
        $this->loadSecondaryTypeProperties = (boolean) $loadSecondaryTypeProperties;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getMaxItemsPerPage()
    {
        return $this->maxItemsPerPage;
    }

    /**
     * {@inheritdoc}
     */
    public function setMaxItemsPerPage($maxItemsPerPage)
    {
        if ((int) $maxItemsPerPage < 1) {
            throw new \InvalidArgumentException('itemsPerPage must be > 0!');
        }
        $this->maxItemsPerPage = (int) $maxItemsPerPage;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getOrderBy()
    {
        return $this->orderBy;
    }

    /**
     * {@inheritdoc}
     */
    public function setOrderBy($orderBy)
    {
        $this->orderBy = $orderBy;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getRenditionFilter()
    {
        return $this->renditionFilter;
    }

    /**
     * {@inheritdoc}
     */
    public function setRenditionFilter(array $renditionFilter)

    {
        $filters = [];
        foreach ($renditionFilter as $filter) {
            $filter = trim((string) $filter);
            if ($filter === '') {
                continue;
            }

            if (stripos($filter, ',') !== false) {
                throw new \InvalidArgumentException('Rendition must not contain a comma!');
            }

            $filters[] = $filter;
        }

        if (count($filters) === 0) {
            $filters[] = Constants::RENDITION_NONE;
        }

        $this->renditionFilter = $filters;

        return $this;
    }


    /**
     * {@inheritdoc}
     */
    public function getQueryFilterString()
    {
        if (count($this->filter) === 0) {
            return null;
        }

        if (array_search(self::PROPERTIES_WILDCARD, $this->filter)) {
            return self::PROPERTIES_WILDCARD;
        }

        $filters = $this->filter;
        $filters[] = PropertyIds::OBJECT_ID;
        $filters[] = PropertyIds::BASE_TYPE_ID;
        $filters[] = PropertyIds::OBJECT_TYPE_ID;

        if ($this->loadSecondaryTypeProperties()) {
            $filters[] = PropertyIds::SECONDARY_OBJECT_TYPE_IDS;
        }

        return implode(',', array_unique($filters));
    }

    /**
     * {@inheritdoc}
     */
    public function getRenditionFilterString()
    {
        if (count($this->renditionFilter) === 0) {
            return null;
        }

        return implode(',', $this->renditionFilter);
    }

    /**
     * {@inheritdoc}
     */
    public function setFilterString($propertyFilter)
    {
        if (empty($propertyFilter)) {
            $this->setFilter([]);
        } else {
            $this->setFilter(explode(',', $propertyFilter));
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function setRenditionFilterString($renditionFilter)
    {
        if (empty($renditionFilter)) {
            $this->setRenditionFilter([]);
        } else {
            $this->setRenditionFilter(explode(',', $renditionFilter));
        }

        return $this;
    }
}


1			<?php
2			namespace Dkd\PhpCmis;
3
4			/*
5			* This file is part of php-cmis-client.
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\Enum\IncludeRelationships;
14
15			/**
16			* OperationContext implementation
17			*/
18			class OperationContext implements OperationContextInterface
19			{
20			const PROPERTIES_WILDCARD = '*';
21
22			/**
23			* @var string[]
24			*/
25			private $filter = [];
26
27			/**
28			* @var boolean
29			*/
30			private $loadSecondaryTypeProperties = false;
31
32			/**
33			* @var boolean
34			*/
35			private $includeAcls = false;
36
37			/**
38			* @var boolean
39			*/
40			private $includeAllowableActions = true;
41
42			/**
43			* @var boolean
44			*/
45			private $includePolicies = false;
46
47			/**
48			* @var IncludeRelationships
49			*/
50			private $includeRelationships = null;
51
52			/**
53			* @var string[]
54			*/
55			private $renditionFilter = [];
56
57			/**
58			* @var boolean
59			*/
60			private $includePathSegments = true;
61
62			/**
63			* @var string
64			*/
65			private $orderBy = null;
66
67			/**
68			* @var boolean
69			*/
70			private $cacheEnabled = false;
71
72			/**
73			* @var integer
74			*/
75			private $maxItemsPerPage = 100;
76
77			/**
78			* Creates new Operation Context
79			*/
80	61		public function __construct()
81			{
82	61		$this->setRenditionFilter([]);
83	61		$this->includeRelationships = IncludeRelationships::cast(IncludeRelationships::NONE);
84	61		}
85
86			/**
87			* {@inheritdoc}
88			*/
89	1		public function isCacheEnabled()
90			{
91	1		return $this->cacheEnabled;
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97	9		public function setCacheEnabled($cacheEnabled)
98			{
99	9		$this->cacheEnabled = (boolean) $cacheEnabled;
100	9		return $this;
101			}
102
103			/**
104			* {@inheritdoc}
105			*/
106	1		public function getCacheKey()
107			{
108	1		$cacheKey = $this->isIncludeAcls() ? '1' : '0';
109	1		$cacheKey .= $this->isIncludeAllowableActions() ? '1' : '0';
110	1		$cacheKey .= $this->isIncludePolicies() ? '1' : '0';
111	1		$cacheKey .= $this->isIncludePathSegments() ? '1' : '0';
112	1		$cacheKey .= '\|';
113	1		$cacheKey .= $this->getQueryFilterString();
114	1		$cacheKey .= '\|';
115	1		$cacheKey .= (string) $this->getIncludeRelationships();
116	1		$cacheKey .= '\|';
117	1		$cacheKey .= $this->getRenditionFilterString();
118
119	1		return $cacheKey;
120			}
121
122			/**
123			* {@inheritdoc}
124			*/
125	1		public function getFilter()
126			{
127	1		return $this->filter;
128			}
129
130			/**
131			* {@inheritdoc}
132			*/
133	8	View Code Duplication	public function setFilter(array $propertyFilters)
			0 ignored issues – show Duplication introduced 2017-09-06 15:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
134			{
135	8		$filters = [];
136	8		foreach ($propertyFilters as $filter) {
137	8		$filter = trim((string) $filter);
138	8		if ($filter === '') {
139	1		continue;
140			}
141
142	8		if (self::PROPERTIES_WILDCARD === $filter) {
143	1		$filters[] = self::PROPERTIES_WILDCARD;
144	1		break;
145			}
146
147	8		if (stripos($filter, ',') !== false) {
148	1		throw new \InvalidArgumentException('Filter must not contain a comma!');
149			}
150
151	8		$filters[] = $filter;
152	8		}
153
154	7		$this->filter = $filters;
155
156	7		return $this;
157			}
158
159			/**
160			* {@inheritdoc}
161			*/
162	2		public function isIncludeAcls()
163			{
164	2		return $this->includeAcls;
165			}
166
167			/**
168			* {@inheritdoc}
169			*/
170	2		public function setIncludeAcls($includeAcls)
171			{
172	2		$this->includeAcls = $includeAcls;
173
174	2		return $this;
175			}
176
177			/**
178			* {@inheritdoc}
179			*/
180	2		public function isIncludeAllowableActions()
181			{
182	2		return $this->includeAllowableActions;
183			}
184
185			/**
186			* {@inheritdoc}
187			*/
188	2		public function setIncludeAllowableActions($includeAllowableActions)
189			{
190	2		$this->includeAllowableActions = $includeAllowableActions;
191	2		return $this;
192			}
193
194			/**
195			* {@inheritdoc}
196			*/
197	2		public function isIncludePathSegments()
198			{
199	2		return $this->includePathSegments;
200			}
201
202			/**
203			* {@inheritdoc}
204			*/
205	2		public function setIncludePathSegments($includePathSegments)
206			{
207	2		$this->includePathSegments = $includePathSegments;
208	2		return $this;
209			}
210
211			/**
212			* {@inheritdoc}
213			*/
214	2		public function isIncludePolicies()
215			{
216	2		return $this->includePolicies;
217			}
218
219			/**
220			* {@inheritdoc}
221			*/
222	2		public function setIncludePolicies($includePolicies)
223			{
224	2		$this->includePolicies = $includePolicies;
225	2		return $this;
226			}
227
228			/**
229			* {@inheritdoc}
230			*/
231	2		public function getIncludeRelationships()
232			{
233	2		return $this->includeRelationships;
234			}
235
236			/**
237			* {@inheritdoc}
238			*/
239	2		public function setIncludeRelationships(IncludeRelationships $includeRelationships)
240			{
241	2		$this->includeRelationships = $includeRelationships;
242
243	2		return $this;
244			}
245
246			/**
247			* {@inheritdoc}
248			*/
249	3		public function loadSecondaryTypeProperties()
250			{
251	3		return $this->loadSecondaryTypeProperties;
252			}
253
254			/**
255			* {@inheritdoc}
256			*/
257	2		public function setLoadSecondaryTypeProperties($loadSecondaryTypeProperties)
258			{
259	2		$this->loadSecondaryTypeProperties = (boolean) $loadSecondaryTypeProperties;
260
261	2		return $this;
262			}
263
264			/**
265			* {@inheritdoc}
266			*/
267	1		public function getMaxItemsPerPage()
268			{
269	1		return $this->maxItemsPerPage;
270			}
271
272			/**
273			* {@inheritdoc}
274			*/
275	2		public function setMaxItemsPerPage($maxItemsPerPage)
276			{
277	2		if ((int) $maxItemsPerPage < 1) {
278	1		throw new \InvalidArgumentException('itemsPerPage must be > 0!');
279			}
280	1		$this->maxItemsPerPage = (int) $maxItemsPerPage;
281
282	1		return $this;
283			}
284
285			/**
286			* {@inheritdoc}
287			*/
288	1		public function getOrderBy()
289			{
290	1		return $this->orderBy;
291			}
292
293			/**
294			* {@inheritdoc}
295			*/
296	1		public function setOrderBy($orderBy)
297			{
298	1		$this->orderBy = $orderBy;
299
300	1		return $this;
301			}
302
303			/**
304			* {@inheritdoc}
305			*/
306	1		public function getRenditionFilter()
307			{
308	1		return $this->renditionFilter;
309			}
310
311			/**
312			* {@inheritdoc}
313			*/
314	61	View Code Duplication	public function setRenditionFilter(array $renditionFilter)
			0 ignored issues – show Duplication introduced 2017-09-06 15:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
315			{
316	61		$filters = [];
317	61		foreach ($renditionFilter as $filter) {
318	6		$filter = trim((string) $filter);
319	6		if ($filter === '') {
320	1		continue;
321			}
322
323	6		if (stripos($filter, ',') !== false) {
324	1		throw new \InvalidArgumentException('Rendition must not contain a comma!');
325			}
326
327	6		$filters[] = $filter;
328	61		}
329
330	61		if (count($filters) === 0) {
331	61		$filters[] = Constants::RENDITION_NONE;
332	61		}
333
334	61		$this->renditionFilter = $filters;
335
336	61		return $this;
337			}
338
339
340			/**
341			* {@inheritdoc}
342			*/
343	4		public function getQueryFilterString()
344			{
345	4		if (count($this->filter) === 0) {
346	2		return null;
347			}
348
349	3		if (array_search(self::PROPERTIES_WILDCARD, $this->filter)) {
350	1		return self::PROPERTIES_WILDCARD;
351			}
352
353	2		$filters = $this->filter;
354	2		$filters[] = PropertyIds::OBJECT_ID;
355	2		$filters[] = PropertyIds::BASE_TYPE_ID;
356	2		$filters[] = PropertyIds::OBJECT_TYPE_ID;
357
358	2		if ($this->loadSecondaryTypeProperties()) {
359	1		$filters[] = PropertyIds::SECONDARY_OBJECT_TYPE_IDS;
360	1		}
361
362	2		return implode(',', array_unique($filters));
363			}
364
365			/**
366			* {@inheritdoc}
367			*/
368	3		public function getRenditionFilterString()
369			{
370	3		if (count($this->renditionFilter) === 0) {
371	1		return null;
372			}
373
374	2		return implode(',', $this->renditionFilter);
375			}
376
377			/**
378			* {@inheritdoc}
379			*/
380	1		public function setFilterString($propertyFilter)
381			{
382	1		if (empty($propertyFilter)) {
383	1		$this->setFilter([]);
384	1		} else {
385	1		$this->setFilter(explode(',', $propertyFilter));
386			}
387
388	1		return $this;
389			}
390
391			/**
392			* {@inheritdoc}
393			*/
394	1		public function setRenditionFilterString($renditionFilter)
395			{
396	1		if (empty($renditionFilter)) {
397	1		$this->setRenditionFilter([]);
398	1		} else {
399	1		$this->setRenditionFilter(explode(',', $renditionFilter));
400			}
401
402	1		return $this;
403			}
404			}
405

dkd / php-cmis-client

GitHub Access Token became invalid

OperationContext B last analyzed 2019-11-19 13:16 UTC