Member::getResource() - Code Metrics - Inspection of "Merge pull request #109 from max-kovpak/patch-1" - alchemy-fr/Zippy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e73255...01c7e6 )

by Thibaud

created 2016-06-29 15:53 UTC

Member::getResource() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

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

namespace Alchemy\Zippy\Archive;

use Alchemy\Zippy\Adapter\AdapterInterface;
use Alchemy\Zippy\Adapter\Resource\ResourceInterface;

/**
 * Represents a member of an archive.
 */
class Member implements MemberInterface
{
    /**
     * The location of the file
     *
     * @var string
     */
    private $location;

    /**
     * Tells whether the archive member is a directory or not
     *
     * @var bool
     */
    private $isDir;

    /**
     * The uncompressed size of the file
     *
     * @var int
     */
    private $size;

    /**
     * The last modified date of the file
     *
     * @var \DateTime
     */
    private $lastModifiedDate;

    /**
     * The resource to the actual archive
     *
     * @var string
     */
    private $resource;

    /**
     * An adapter
     *
     * @var AdapterInterface
     */
    private $adapter;

    /**
     * Constructor
     *
     * @param ResourceInterface $resource The path of the archive which contain the member
     * @param AdapterInterface $adapter The archive adapter interface
     * @param string $location The path of the archive member
     * @param int $fileSize The uncompressed file size
     * @param \DateTime $lastModifiedDate The last modified date of the member
     * @param bool $isDir Tells whether the member is a directory or not
     */
    public function __construct(
        ResourceInterface $resource,
        AdapterInterface $adapter,
        $location,
        $fileSize,
        \DateTime $lastModifiedDate,
        $isDir
    ) {
        $this->resource = $resource;

        $this->adapter = $adapter;
        $this->location = $location;
        $this->isDir = $isDir;
        $this->size = $fileSize;
        $this->lastModifiedDate = $lastModifiedDate;
    }

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

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

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

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

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

    /**
     * {@inheritdoc}
     */
    public function extract($to = null, $overwrite = false)
    {
        $this->adapter->extractMembers($this->resource, $this->location, $to, (bool) $overwrite);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return new \SplFileInfo(sprintf('%s%s', rtrim(null === $to ? getcwd() : $to, '/'), $this->location));
    }

    /**
     * @inheritdoc
     * */
    public function getResource()
    {
        return $this->resource;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php
2
3			/*
4			* This file is part of Zippy.
5			*
6			* (c) Alchemy <[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 Alchemy\Zippy\Archive;
13
14			use Alchemy\Zippy\Adapter\AdapterInterface;
15			use Alchemy\Zippy\Adapter\Resource\ResourceInterface;
16
17			/**
18			* Represents a member of an archive.
19			*/
20			class Member implements MemberInterface
21			{
22			/**
23			* The location of the file
24			*
25			* @var string
26			*/
27			private $location;
28
29			/**
30			* Tells whether the archive member is a directory or not
31			*
32			* @var bool
33			*/
34			private $isDir;
35
36			/**
37			* The uncompressed size of the file
38			*
39			* @var int
40			*/
41			private $size;
42
43			/**
44			* The last modified date of the file
45			*
46			* @var \DateTime
47			*/
48			private $lastModifiedDate;
49
50			/**
51			* The resource to the actual archive
52			*
53			* @var string
54			*/
55			private $resource;
56
57			/**
58			* An adapter
59			*
60			* @var AdapterInterface
61			*/
62			private $adapter;
63
64			/**
65			* Constructor
66			*
67			* @param ResourceInterface $resource The path of the archive which contain the member
68			* @param AdapterInterface $adapter The archive adapter interface
69			* @param string $location The path of the archive member
70			* @param int $fileSize The uncompressed file size
71			* @param \DateTime $lastModifiedDate The last modified date of the member
72			* @param bool $isDir Tells whether the member is a directory or not
73			*/
74			public function __construct(
75			ResourceInterface $resource,
76			AdapterInterface $adapter,
77			$location,
78			$fileSize,
79			\DateTime $lastModifiedDate,
80			$isDir
81			) {
82			$this->resource = $resource;
			0 ignored issues – show Documentation Bug introduced 2016-02-12 10:17 UTC by Report Bug Copy Issue Report It seems like `$resource` of type `object<Alchemy\Zippy\Ada...urce\ResourceInterface>` is incompatible with the declared type `string` of property `$resource`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
83			$this->adapter = $adapter;
84			$this->location = $location;
85			$this->isDir = $isDir;
86			$this->size = $fileSize;
87			$this->lastModifiedDate = $lastModifiedDate;
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93			public function getLocation()
94			{
95			return $this->location;
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101			public function isDir()
102			{
103			return $this->isDir;
104			}
105
106			/**
107			* {@inheritdoc}
108			*/
109			public function getLastModifiedDate()
110			{
111			return $this->lastModifiedDate;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function getSize()
118			{
119			return $this->size;
120			}
121
122			/**
123			* {@inheritdoc}
124			*/
125			public function __toString()
126			{
127			return $this->location;
128			}
129
130			/**
131			* {@inheritdoc}
132			*/
133			public function extract($to = null, $overwrite = false)
134			{
135			$this->adapter->extractMembers($this->resource, $this->location, $to, (bool) $overwrite);
			0 ignored issues – show Documentation introduced 2016-02-12 10:17 UTC by Report Bug Copy Issue Report `$this->resource` is of type `string`, but the function expects a `object<Alchemy\Zippy\Ada...urce\ResourceInterface>`. 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...
136
137			return new \SplFileInfo(sprintf('%s%s', rtrim(null === $to ? getcwd() : $to, '/'), $this->location));
138			}
139
140			/**
141			* @inheritdoc
142			* */
143			public function getResource()
144			{
145			return $this->resource;
			0 ignored issues – show Bug Best Practice introduced 2016-06-27 23:52 UTC by Report Bug Copy Issue Report The return type of `return $this->resource;` (`string`) is incompatible with the return type declared by the interface `Alchemy\Zippy\Archive\MemberInterface::getResource` of type `Alchemy\Zippy\Adapter\Resource\ResourceInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
146			}
147			}
148

alchemy-fr / Zippy

Push — master ( e73255...01c7e6 )

Member::getResource() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like