GenericResource::listChildren() - Code Metrics - Inspection of "Merge pull request #79 from webmozart/json-repo" - puli/repository - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — 1.0 ( 9f5a0b...fe7a2f )

by Bernhard

created 2016-01-04 13:52 UTC

GenericResource::listChildren() A

↳ Parent: GenericResource

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	14
Ratio	100 %

Code Coverage

Tests	7
CRAP Score	3

Metric	Value
dl	14
loc	14
ccs	7
cts	7
cp	1
rs	9.4286
cc	3
eloc	7
nc	3
nop	0
crap	3

<?php

/*
 * This file is part of the puli/repository package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Repository\Resource;

use Puli\Repository\Api\ChangeStream\VersionList;
use Puli\Repository\Api\Resource\PuliResource;
use Puli\Repository\Api\Resource\ResourceMetadata;
use Puli\Repository\Api\ResourceNotFoundException;
use Puli\Repository\Api\ResourceRepository;
use Puli\Repository\Resource\Collection\ArrayResourceCollection;

/**
 * A generic resource.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class GenericResource implements PuliResource
{
    /**
     * @var ResourceRepository
     */
    private $repo;

    /**
     * @var string
     */
    private $path;

    /**
     * @var string
     */
    private $repoPath;

    /**
     * Creates a new resource.
     *
     * @param string|null $path The path of the resource.
     */
    public function __construct($path = null)
    {
        $this->path = $path;
        $this->repoPath = $path;
    }

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

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->path ? basename($this->path) : null;
    }

    /**
     * {@inheritdoc}
     */
    public function getChild($relPath)
    {
        if (!$this->getRepository()) {
            throw ResourceNotFoundException::forPath($this->getRepositoryPath().'/'.$relPath);
        }

        return $this->getRepository()->get($this->getRepositoryPath().'/'.$relPath);
    }

    /**
     * {@inheritdoc}
     */
    public function hasChild($relPath)
    {
        if (!$this->getRepository()) {
            return false;
        }

        return $this->getRepository()->contains($this->getRepositoryPath().'/'.$relPath);
    }

    /**
     * {@inheritdoc}
     */
    public function hasChildren()
    {
        if (!$this->getRepository()) {
            return false;
        }

        return $this->getRepository()->hasChildren($this->getRepositoryPath());
    }

    /**
     * {@inheritdoc}
     */
    public function listChildren()
    {
        $children = new ArrayResourceCollection();

        if (!$this->getRepository()) {
            return $children;
        }

        foreach ($this->getRepository()->listChildren($this->getRepositoryPath()) as $child) {
            $children[$child->getName()] = $child;
        }

        return $children;
    }

    /**
     * {@inheritdoc}
     */
    public function getVersions()
    {
        if (!$this->getRepository()) {
            return new VersionList($this->getRepositoryPath(), array($this));
        }

        return $this->getRepository()->getVersions($this->getRepositoryPath());
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata()
    {
        return new ResourceMetadata();
    }

    /**
     * {@inheritdoc}
     */
    public function attachTo(ResourceRepository $repo, $path = null)
    {
        $this->repo = $repo;

        if (null !== $path) {
            $this->path = $path;
            $this->repoPath = $path;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function detach()
    {
        $this->repo = null;
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function isAttached()
    {
        return null !== $this->repo;
    }

    /**
     * {@inheritdoc}
     */
    public function createReference($path)
    {
        $ref = clone $this;
        $ref->path = $path;

        return $ref;
    }

    /**
     * {@inheritdoc}
     */
    public function isReference()
    {
        return $this->path !== $this->repoPath;
    }

    /**
     * {@inheritdoc}
     */
    public function serialize()
    {
        $data = array();

        $this->preSerialize($data);

        return serialize($data);
    }

    /**
     * {@inheritdoc}
     */
    public function unserialize($string)
    {
        $data = unserialize($string);

        $this->postUnserialize($data);
    }

    /**
     * Invoked before serializing a resource.
     *
     * Override this method if you want to serialize custom data in subclasses.
     *
     * @param array $data The data to serialize. Add custom data at the end of
     *                    the array.
     */
    protected function preSerialize(array &$data)
    {
        $data[] = $this->path;
        $data[] = $this->repoPath;
    }

    /**
     * Invoked after unserializing a resource.
     *
     * Override this method if you want to unserialize custom data in
     * subclasses.
     *
     * @param array $data The unserialized data. Pop your custom data from the
     *                    end of the array before calling the parent method.
     */
    protected function postUnserialize(array $data)
    {
        $this->repoPath = array_pop($data);
        $this->path = array_pop($data);
    }
}


1			<?php
2
3			/*
4			* This file is part of the puli/repository package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Puli\Repository\Resource;
13
14			use Puli\Repository\Api\ChangeStream\VersionList;
15			use Puli\Repository\Api\Resource\PuliResource;
16			use Puli\Repository\Api\Resource\ResourceMetadata;
17			use Puli\Repository\Api\ResourceNotFoundException;
18			use Puli\Repository\Api\ResourceRepository;
19			use Puli\Repository\Resource\Collection\ArrayResourceCollection;
20
21			/**
22			* A generic resource.
23			*
24			* @since 1.0
25			*
26			* @author Bernhard Schussek <[email protected]>
27			*/
28			class GenericResource implements PuliResource
29			{
30			/**
31			* @var ResourceRepository
32			*/
33			private $repo;
34
35			/**
36			* @var string
37			*/
38			private $path;
39
40			/**
41			* @var string
42			*/
43			private $repoPath;
44
45			/**
46			* Creates a new resource.
47			*
48			* @param string\|null $path The path of the resource.
49			*/
50	1020		public function __construct($path = null)
51			{
52	1020		$this->path = $path;
53	1020		$this->repoPath = $path;
54	1020		}
55
56			/**
57			* {@inheritdoc}
58			*/
59	712		public function getPath()
60			{
61	712		return $this->path;
62			}
63
64			/**
65			* {@inheritdoc}
66			*/
67	438		public function getName()
68			{
69	438		return $this->path ? basename($this->path) : null;
70			}
71
72			/**
73			* {@inheritdoc}
74			*/
75	3	View Code Duplication	public function getChild($relPath)
76			{
77	3		if (!$this->getRepository()) {
78	1		throw ResourceNotFoundException::forPath($this->getRepositoryPath().'/'.$relPath);
79			}
80
81	2		return $this->getRepository()->get($this->getRepositoryPath().'/'.$relPath);
82			}
83
84			/**
85			* {@inheritdoc}
86			*/
87	3		public function hasChild($relPath)
88			{
89	3		if (!$this->getRepository()) {
90	1		return false;
91			}
92
93	2		return $this->getRepository()->contains($this->getRepositoryPath().'/'.$relPath);
94			}
95
96			/**
97			* {@inheritdoc}
98			*/
99	3		public function hasChildren()
100			{
101	3		if (!$this->getRepository()) {
102	1		return false;
103			}
104
105	2		return $this->getRepository()->hasChildren($this->getRepositoryPath());
106			}
107
108			/**
109			* {@inheritdoc}
110			*/
111	8	View Code Duplication	public function listChildren()
112			{
113	8		$children = new ArrayResourceCollection();
114
115	8		if (!$this->getRepository()) {
116	1		return $children;
117			}
118
119	7		foreach ($this->getRepository()->listChildren($this->getRepositoryPath()) as $child) {
120	2		$children[$child->getName()] = $child;
121			}
122
123	7		return $children;
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129	8		public function getVersions()
130			{
131	8		if (!$this->getRepository()) {
132	4		return new VersionList($this->getRepositoryPath(), array($this));
133			}
134
135	4		return $this->getRepository()->getVersions($this->getRepositoryPath());
136			}
137
138			/**
139			* {@inheritdoc}
140			*/
141			public function getMetadata()
142			{
143			return new ResourceMetadata();
144			}
145
146			/**
147			* {@inheritdoc}
148			*/
149	888		public function attachTo(ResourceRepository $repo, $path = null)
150			{
151	888		$this->repo = $repo;
152
153	888		if (null !== $path) {
154	812		$this->path = $path;
155	812		$this->repoPath = $path;
156			}
157	888		}
158
159			/**
160			* {@inheritdoc}
161			*/
162	28		public function detach()
163			{
164	28		$this->repo = null;
165	28		}
166
167			/**
168			* {@inheritdoc}
169			*/
170	402		public function getRepository()
171			{
172	402		return $this->repo;
173			}
174
175			/**
176			* {@inheritdoc}
177			*/
178	161		public function getRepositoryPath()
179			{
180	161		return $this->repoPath;
181			}
182
183			/**
184			* {@inheritdoc}
185			*/
186	840		public function isAttached()
187			{
188	840		return null !== $this->repo;
189			}
190
191			/**
192			* {@inheritdoc}
193			*/
194	56		public function createReference($path)
195			{
196	56		$ref = clone $this;
197	56		$ref->path = $path;
198
199	56		return $ref;
200			}
201
202			/**
203			* {@inheritdoc}
204			*/
205	84		public function isReference()
206			{
207	84		return $this->path !== $this->repoPath;
208			}
209
210			/**
211			* {@inheritdoc}
212			*/
213	27		public function serialize()
214			{
215	27		$data = array();
216
217	27		$this->preSerialize($data);
218
219	27		return serialize($data);
220			}
221
222			/**
223			* {@inheritdoc}
224			*/
225	27		public function unserialize($string)
226			{
227	27		$data = unserialize($string);
228
229	27		$this->postUnserialize($data);
230	27		}
231
232			/**
233			* Invoked before serializing a resource.
234			*
235			* Override this method if you want to serialize custom data in subclasses.
236			*
237			* @param array $data The data to serialize. Add custom data at the end of
238			* the array.
239			*/
240	27		protected function preSerialize(array &$data)
241			{
242	27		$data[] = $this->path;
243	27		$data[] = $this->repoPath;
244	27		}
245
246			/**
247			* Invoked after unserializing a resource.
248			*
249			* Override this method if you want to unserialize custom data in
250			* subclasses.
251			*
252			* @param array $data The unserialized data. Pop your custom data from the
253			* end of the array before calling the parent method.
254			*/
255	27		protected function postUnserialize(array $data)
256			{
257	27		$this->repoPath = array_pop($data);
258	27		$this->path = array_pop($data);
259	27		}
260			}
261

puli / repository

Push — 1.0 ( 9f5a0b...fe7a2f )

GenericResource::listChildren() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like