IndexObject::__construct() - Code Metrics - Inspection of "Codestyle" - storeman-io/storeman - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ad9675...44a00f )

by Arne

created 2018-07-11 23:53 UTC

IndexObject::__construct() A

↳ Parent: IndexObject

Complexity

Conditions	2
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	2
nc	1
nop	10

How to fix Many Parameters

<?php

namespace Storeman\Index;

use Storeman\Hash\HashContainer;

/**
 * An index object is the representation of one of this filesystem primitives contained in the index.
 */
class IndexObject implements \ArrayAccess
{
    public const TYPE_DIR = 1;
    public const TYPE_FILE = 2;
    public const TYPE_LINK = 3;

    public const CMP_IGNORE_BLOBID = 1;
    public const CMP_IGNORE_INODE = 2;
    public const CMP_IGNORE_CTIME = 4;


    /**
     * @var string
     */
    protected $relativePath;

    /**
     * @var int
     */
    protected $type;

    /**
     * @var float
     */
    protected $mtime;

    /**
     * @var float
     */
    protected $ctime;

    /**
     * mode & 0777
     *
     * @var int
     */
    protected $permissions;

    /**
     * @var int
     */
    protected $size;

    /**
     * @var int
     */
    protected $inode;

    /**
     * @var string
     */
    protected $linkTarget;

    /**
     * Content hashes for file index objects.
     *
     * @var HashContainer
     */
    protected $hashes;

    /**
     * @var string
     */
    protected $blobId;

    public function __construct(string $relativePath, int $type, float $mtime, float $ctime, int $permissions, ?int $size, ?int $inode, ?string $linkTarget, ?string $blobId, ?HashContainer $hashContainer)
    {
        assert(($type === static::TYPE_FILE) ^ ($size === null));
        assert(($type === static::TYPE_FILE) || ($blobId === null));
        assert(($type === static::TYPE_FILE) ^ ($hashContainer === null));
        assert(($type === static::TYPE_LINK) ^ ($linkTarget === null));
        assert(!($permissions & ~0777));

        $this->relativePath = $relativePath;
        $this->type = $type;
        $this->mtime = $mtime;
        $this->ctime = $ctime;
        $this->permissions = $permissions;
        $this->size = $size;
        $this->inode = $inode;
        $this->linkTarget = $linkTarget;
        $this->blobId = $blobId;
        $this->hashes = $hashContainer;
    }

    public function getRelativePath(): string
    {
        return $this->relativePath;
    }

    public function getBasename(): string
    {
        $pos = strrpos($this->relativePath, '/');

        return ($pos === false) ? $this->relativePath : substr($this->relativePath, $pos + 1);
    }

    public function getType(): int
    {
        return $this->type;
    }

    public function getTypeName(): string
    {
        return static::getTypeNameMap()[$this->type];
    }

    public function isDirectory(): bool
    {
        return $this->type === static::TYPE_DIR;
    }

    public function isFile(): bool
    {
        return $this->type === static::TYPE_FILE;
    }

    public function isLink(): bool
    {
        return $this->type === static::TYPE_LINK;
    }

    public function getMtime(): float
    {
        return $this->mtime;
    }

    public function getCtime(): float
    {
        return $this->ctime;
    }

    public function getPermissions(): int
    {
        return $this->permissions;
    }

    public function getPermissionsString(): string
    {
        return decoct($this->permissions);
    }

    public function getSize(): ?int
    {
        return $this->size;
    }

    public function getInode(): ?int
    {
        return $this->inode;
    }

    public function getLinkTarget(): ?string
    {
        return $this->linkTarget;
    }

    public function getHashes(): ?HashContainer
    {
        return $this->hashes;
    }

    public function getBlobId(): ?string
    {
        return $this->blobId;
    }

    public function setBlobId(string $blobId): IndexObject
    {
        assert($this->blobId === null);

        $this->blobId = $blobId;

        return $this;
    }

    /**
     * Equality check with all attributes.
     *
     * @param IndexObject $other
     * @param int $options
     * @return bool
     */
    public function equals(?IndexObject $other, int $options = 0): bool
    {
        if ($other === null)
        {
            return false;
        }

        $equals = true;
        $equals &= $this->relativePath === $other->relativePath;
        $equals &= $this->type === $other->type;
        $equals &= $this->mtime === $other->mtime;
        $equals &= ($options & static::CMP_IGNORE_CTIME) || ($this->ctime === $other->ctime);
        $equals &= $this->permissions === $other->permissions;
        $equals &= $this->size === $other->size;
        $equals &= ($options & static::CMP_IGNORE_INODE) || ($this->inode === $other->inode);
        $equals &= $this->linkTarget === $other->linkTarget;
        $equals &= ($options & static::CMP_IGNORE_BLOBID) || ($this->blobId === $other->blobId);

        if ($this->hashes && $other->hashes)
        {
            $equals &= $this->hashes->equals($other->hashes);
        }

        return $equals;
    }

    /**
     * @inheritdoc
     */
    public function offsetExists($offset)
    {
        return method_exists($this, 'get' . ucfirst($offset));
    }

    /**
     * @inheritdoc
     */
    public function offsetGet($offset)
    {
        assert(method_exists($this, 'get' . ucfirst($offset)));

        return call_user_func([$this, 'get' . ucfirst($offset)]);
    }

    /**
     * @inheritdoc
     */
    public function offsetSet($offset, $value)
    {
        throw new \LogicException();
    }

    /**
     * @inheritdoc
     */
    public function offsetUnset($offset)
    {
        throw new \LogicException();
    }

    public function __clone()
    {
        if ($this->hashes !== null)
        {
            $this->hashes = clone $this->hashes;
        }
    }

    public function __toString(): string
    {
        $inode = $this->inode ?: '-';

        $parts = [
            $this->getTypeName(),
            "mtime: {$this->mtime}",
            "ctime: {$this->ctime}",
            "permissions: {$this->getPermissionsString()}",
            "inode: {$inode}"
        ];

        if ($this->isFile())
        {
            $blobId = $this->blobId ?: '-';

            $parts = array_merge($parts, [
                "size: {$this->size}",
                "blobId: {$blobId}",
            ]);
        }
        elseif ($this->isLink())
        {
            $parts = array_merge($parts, [
                "target: {$this->linkTarget}",
            ]);
        }

        $attributesString = implode(', ', $parts);

        return "{$this->relativePath} ({$attributesString})";
    }

    public static function getTypeNameMap(): array
    {
        return [
            static::TYPE_DIR => 'DIR',
            static::TYPE_FILE => 'FILE',
            static::TYPE_LINK => 'LINK',
        ];
    }
}


1			<?php
2
3			namespace Storeman\Index;
4
5			use Storeman\Hash\HashContainer;
6
7			/**
8			* An index object is the representation of one of this filesystem primitives contained in the index.
9			*/
10			class IndexObject implements \ArrayAccess
11			{
12			public const TYPE_DIR = 1;
13			public const TYPE_FILE = 2;
14			public const TYPE_LINK = 3;
15
16			public const CMP_IGNORE_BLOBID = 1;
17			public const CMP_IGNORE_INODE = 2;
18			public const CMP_IGNORE_CTIME = 4;
19
20
21			/**
22			* @var string
23			*/
24			protected $relativePath;
25
26			/**
27			* @var int
28			*/
29			protected $type;
30
31			/**
32			* @var float
33			*/
34			protected $mtime;
35
36			/**
37			* @var float
38			*/
39			protected $ctime;
40
41			/**
42			* mode & 0777
43			*
44			* @var int
45			*/
46			protected $permissions;
47
48			/**
49			* @var int
50			*/
51			protected $size;
52
53			/**
54			* @var int
55			*/
56			protected $inode;
57
58			/**
59			* @var string
60			*/
61			protected $linkTarget;
62
63			/**
64			* Content hashes for file index objects.
65			*
66			* @var HashContainer
67			*/
68			protected $hashes;
69
70			/**
71			* @var string
72			*/
73			protected $blobId;
74
75			public function __construct(string $relativePath, int $type, float $mtime, float $ctime, int $permissions, ?int $size, ?int $inode, ?string $linkTarget, ?string $blobId, ?HashContainer $hashContainer)
76			{
77			assert(($type === static::TYPE_FILE) ^ ($size === null));
78			assert(($type === static::TYPE_FILE) \|\| ($blobId === null));
79			assert(($type === static::TYPE_FILE) ^ ($hashContainer === null));
80			assert(($type === static::TYPE_LINK) ^ ($linkTarget === null));
81			assert(!($permissions & ~0777));
82
83			$this->relativePath = $relativePath;
84			$this->type = $type;
85			$this->mtime = $mtime;
86			$this->ctime = $ctime;
87			$this->permissions = $permissions;
88			$this->size = $size;
89			$this->inode = $inode;
90			$this->linkTarget = $linkTarget;
91			$this->blobId = $blobId;
92			$this->hashes = $hashContainer;
93			}
94
95			public function getRelativePath(): string
96			{
97			return $this->relativePath;
98			}
99
100			public function getBasename(): string
101			{
102			$pos = strrpos($this->relativePath, '/');
103
104			return ($pos === false) ? $this->relativePath : substr($this->relativePath, $pos + 1);
105			}
106
107			public function getType(): int
108			{
109			return $this->type;
110			}
111
112			public function getTypeName(): string
113			{
114			return static::getTypeNameMap()[$this->type];
115			}
116
117			public function isDirectory(): bool
118			{
119			return $this->type === static::TYPE_DIR;
120			}
121
122			public function isFile(): bool
123			{
124			return $this->type === static::TYPE_FILE;
125			}
126
127			public function isLink(): bool
128			{
129			return $this->type === static::TYPE_LINK;
130			}
131
132			public function getMtime(): float
133			{
134			return $this->mtime;
135			}
136
137			public function getCtime(): float
138			{
139			return $this->ctime;
140			}
141
142			public function getPermissions(): int
143			{
144			return $this->permissions;
145			}
146
147			public function getPermissionsString(): string
148			{
149			return decoct($this->permissions);
150			}
151
152			public function getSize(): ?int
153			{
154			return $this->size;
155			}
156
157			public function getInode(): ?int
158			{
159			return $this->inode;
160			}
161
162			public function getLinkTarget(): ?string
163			{
164			return $this->linkTarget;
165			}
166
167			public function getHashes(): ?HashContainer
168			{
169			return $this->hashes;
170			}
171
172			public function getBlobId(): ?string
173			{
174			return $this->blobId;
175			}
176
177			public function setBlobId(string $blobId): IndexObject
178			{
179			assert($this->blobId === null);
180
181			$this->blobId = $blobId;
182
183			return $this;
184			}
185
186			/**
187			* Equality check with all attributes.
188			*
189			* @param IndexObject $other
190			* @param int $options
191			* @return bool
192			*/
193			public function equals(?IndexObject $other, int $options = 0): bool
194			{
195			if ($other === null)
196			{
197			return false;
198			}
199
200			$equals = true;
201			$equals &= $this->relativePath === $other->relativePath;
202			$equals &= $this->type === $other->type;
203			$equals &= $this->mtime === $other->mtime;
204			$equals &= ($options & static::CMP_IGNORE_CTIME) \|\| ($this->ctime === $other->ctime);
205			$equals &= $this->permissions === $other->permissions;
206			$equals &= $this->size === $other->size;
207			$equals &= ($options & static::CMP_IGNORE_INODE) \|\| ($this->inode === $other->inode);
208			$equals &= $this->linkTarget === $other->linkTarget;
209			$equals &= ($options & static::CMP_IGNORE_BLOBID) \|\| ($this->blobId === $other->blobId);
210
211			if ($this->hashes && $other->hashes)
212			{
213			$equals &= $this->hashes->equals($other->hashes);
214			}
215
216			return $equals;
217			}
218
219			/**
220			* @inheritdoc
221			*/
222			public function offsetExists($offset)
223			{
224			return method_exists($this, 'get' . ucfirst($offset));
225			}
226
227			/**
228			* @inheritdoc
229			*/
230			public function offsetGet($offset)
231			{
232			assert(method_exists($this, 'get' . ucfirst($offset)));
233
234			return call_user_func([$this, 'get' . ucfirst($offset)]);
235			}
236
237			/**
238			* @inheritdoc
239			*/
240			public function offsetSet($offset, $value)
241			{
242			throw new \LogicException();
243			}
244
245			/**
246			* @inheritdoc
247			*/
248			public function offsetUnset($offset)
249			{
250			throw new \LogicException();
251			}
252
253			public function __clone()
254			{
255			if ($this->hashes !== null)
256			{
257			$this->hashes = clone $this->hashes;
258			}
259			}
260
261			public function __toString(): string
262			{
263			$inode = $this->inode ?: '-';
264
265			$parts = [
266			$this->getTypeName(),
267			"mtime: {$this->mtime}",
268			"ctime: {$this->ctime}",
269			"permissions: {$this->getPermissionsString()}",
270			"inode: {$inode}"
271			];
272
273			if ($this->isFile())
274			{
275			$blobId = $this->blobId ?: '-';
276
277			$parts = array_merge($parts, [
278			"size: {$this->size}",
279			"blobId: {$blobId}",
280			]);
281			}
282			elseif ($this->isLink())
283			{
284			$parts = array_merge($parts, [
285			"target: {$this->linkTarget}",
286			]);
287			}
288
289			$attributesString = implode(', ', $parts);
290
291			return "{$this->relativePath} ({$attributesString})";
292			}
293
294			public static function getTypeNameMap(): array
295			{
296			return [
297			static::TYPE_DIR => 'DIR',
298			static::TYPE_FILE => 'FILE',
299			static::TYPE_LINK => 'LINK',
300			];
301			}
302			}
303

storeman-io / storeman

Push — master ( ad9675...44a00f )

IndexObject::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like