SiteAliasTrait - Code Metrics - Inspection of "Rename AliasRecord to SiteAlias for consistency (#..." - consolidation/site-alias - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cbf66c...6440bc )

by Greg

created 2019-03-03 20:18 UTC

SiteAliasTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

Metric	Value
wmc	23
lcom	2
cbo	1
dl	0
loc	143
rs	10
c	0
b	0
f	0

14 Methods

Rating	Name	Size	Complexity
A	hasRoot()	4	1
A	root()	11	3
A	uri()	4	1
A	setUri()	4	1
A	remoteHostWithUser()	8	3
A	remoteUser()	4	1
A	hasRemoteUser()	4	1
A	remoteHost()	4	1
A	isRemote()	4	1
A	isLocal()	4	2
A	isContainer()	4	1
A	isNone()	4	2
A	localRoot()	8	3
A	os()	7	2

<?php
namespace Consolidation\SiteAlias;

use Consolidation\Config\Config;
use Consolidation\Config\ConfigInterface;
use Consolidation\Config\Util\ArrayUtil;
use Consolidation\SiteAlias\Util\FsUtils;

/**
 * Common implementation of some SiteAlias methods.
 */
trait SiteAliasTrait
{
    /**
     * @inheritdoc
     */
    public function hasRoot()
    {
        return $this->has('root');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     *
     * @throws \Exception when the alias does not specify a root.
     */
    public function root()
    {
        if (!$this->hasRoot()) {
            throw new \Exception('Site alias ' . $this->name . ' does not specify a root.');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        $root = $this->get('root');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        if ($this->isLocal()) {
            return FsUtils::realpath($root);
        }
        return $root;
    }

    /**
     * @inheritdoc
     */
    public function uri()
    {
        return $this->get('uri');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function setUri($uri)
    {
        return $this->set('uri', $uri);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function remoteHostWithUser()
    {
        $result = $this->remoteHost();
        if (!empty($result) && $this->hasRemoteUser()) {
            $result = $this->remoteUser() . '@' . $result;
        }
        return $result;
    }

    /**
     * @inheritdoc
     */
    public function remoteUser()
    {
        return $this->get('user');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function hasRemoteUser()
    {
        return $this->has('user');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function remoteHost()
    {
        return $this->get('host');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function isRemote()
    {
        return $this->has('host');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function isLocal()
    {
        return !$this->isRemote() && !$this->isContainer();
    }

    /**
     * @inheritdoc
     */
    public function isContainer()
    {
        return $this->has('docker');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @inheritdoc
     */
    public function isNone()
    {
        return empty($this->root()) && $this->isLocal();
    }

    /**
     * @inheritdoc
     */
    public function localRoot()
    {
        if ($this->isLocal() && $this->hasRoot()) {
            return $this->root();
        }

        return false;
    }

    /**
     * os returns the OS that this alias record points to. For local alias
     * records, PHP_OS will be returned. For remote alias records, the
     * value from the `os` element will be returned. If there is no `os`
     * element, then the default assumption is that the remote system is Linux.
     *
     * @return string
     *   Linux
     *   WIN* (e.g. WINNT)
     *   CYGWIN
     *   MINGW* (e.g. MINGW32)
     */
    public function os()
    {
        if ($this->isLocal()) {
            return PHP_OS;
        }
        return $this->get('os', 'Linux');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1			<?php
2			namespace Consolidation\SiteAlias;
3
4			use Consolidation\Config\Config;
5			use Consolidation\Config\ConfigInterface;
6			use Consolidation\Config\Util\ArrayUtil;
7			use Consolidation\SiteAlias\Util\FsUtils;
8
9			/**
10			* Common implementation of some SiteAlias methods.
11			*/
12			trait SiteAliasTrait
13			{
14			/**
15			* @inheritdoc
16			*/
17			public function hasRoot()
18			{
19			return $this->has('root');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `has()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
20			}
21
22			/**
23			* @inheritdoc
24			*
25			* @throws \Exception when the alias does not specify a root.
26			*/
27			public function root()
28			{
29			if (!$this->hasRoot()) {
30			throw new \Exception('Site alias ' . $this->name . ' does not specify a root.');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report The property `name` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
31			}
32			$root = $this->get('root');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
33			if ($this->isLocal()) {
34			return FsUtils::realpath($root);
35			}
36			return $root;
37			}
38
39			/**
40			* @inheritdoc
41			*/
42			public function uri()
43			{
44			return $this->get('uri');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
45			}
46
47			/**
48			* @inheritdoc
49			*/
50			public function setUri($uri)
51			{
52			return $this->set('uri', $uri);
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `set()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
53			}
54
55			/**
56			* @inheritdoc
57			*/
58			public function remoteHostWithUser()
59			{
60			$result = $this->remoteHost();
61			if (!empty($result) && $this->hasRemoteUser()) {
62			$result = $this->remoteUser() . '@' . $result;
63			}
64			return $result;
65			}
66
67			/**
68			* @inheritdoc
69			*/
70			public function remoteUser()
71			{
72			return $this->get('user');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
73			}
74
75			/**
76			* @inheritdoc
77			*/
78			public function hasRemoteUser()
79			{
80			return $this->has('user');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `has()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
81			}
82
83			/**
84			* @inheritdoc
85			*/
86			public function remoteHost()
87			{
88			return $this->get('host');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
89			}
90
91			/**
92			* @inheritdoc
93			*/
94			public function isRemote()
95			{
96			return $this->has('host');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `has()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
97			}
98
99			/**
100			* @inheritdoc
101			*/
102			public function isLocal()
103			{
104			return !$this->isRemote() && !$this->isContainer();
105			}
106
107			/**
108			* @inheritdoc
109			*/
110			public function isContainer()
111			{
112			return $this->has('docker');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `has()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
113			}
114
115			/**
116			* @inheritdoc
117			*/
118			public function isNone()
119			{
120			return empty($this->root()) && $this->isLocal();
121			}
122
123			/**
124			* @inheritdoc
125			*/
126			public function localRoot()
127			{
128			if ($this->isLocal() && $this->hasRoot()) {
129			return $this->root();
130			}
131
132			return false;
133			}
134
135			/**
136			* os returns the OS that this alias record points to. For local alias
137			* records, PHP_OS will be returned. For remote alias records, the
138			* value from the `os` element will be returned. If there is no `os`
139			* element, then the default assumption is that the remote system is Linux.
140			*
141			* @return string
142			* Linux
143			* WIN* (e.g. WINNT)
144			* CYGWIN
145			* MINGW* (e.g. MINGW32)
146			*/
147			public function os()
148			{
149			if ($this->isLocal()) {
150			return PHP_OS;
151			}
152			return $this->get('os', 'Linux');
			0 ignored issues – show Bug introduced 2019-03-02 02:02 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
153			}
154			}
155

consolidation / site-alias

Push — master ( cbf66c...6440bc )

SiteAliasTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

Duplication Side-by-Side

Filter issues like