InstallInfo::getModuleName() - Code Metrics - Inspection of "Merge pull request #50 from webmozart/rename-packa..." - puli/manager - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( d49c03...6343d0 )

by Bernhard

created 2016-01-28 11:08 UTC

InstallInfo::getModuleName() A

↳ Parent: InstallInfo

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the puli/manager 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\Manager\Api\Module;

use InvalidArgumentException;
use Puli\Manager\Api\Environment;
use Puli\Manager\Assert\Assert;
use Rhumsaa\Uuid\Uuid;

/**
 * Contains information about a module installation.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class InstallInfo
{
    /**
     * The default installer of modules.
     */
    const DEFAULT_INSTALLER_NAME = 'user';

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

    /**
     * @var string|null
     */
    private $moduleName;

    /**
     * @var string
     */
    private $env = Environment::PROD;

    /**
     * @var string
     */
    private $installerName = self::DEFAULT_INSTALLER_NAME;

    /**
     * @var Uuid[]
     */
    private $disabledBindingUuids = array();

    /**
     * Creates a new install info.
     *
     * @param string $moduleName  The module name. Must be a non-empty string.
     * @param string $installPath The path where the module is installed.
     *                            If a relative path is given, the path is
     *                            assumed to be relative to the install path
     *                            of the root module.
     *
     * @throws InvalidArgumentException If any of the arguments is invalid.
     */
    public function __construct($moduleName, $installPath)
    {
        Assert::moduleName($moduleName);
        Assert::systemPath($installPath);

        $this->moduleName = $moduleName;
        $this->installPath = $installPath;
    }

    /**
     * Returns the path where the module is installed.
     *
     * @return string The path where the module is installed. The path is
     *                either absolute or relative to the install path of the
     *                root module.
     */
    public function getInstallPath()
    {
        return $this->installPath;
    }

    /**
     * Returns the module name.
     *
     * @return null|string Returns the module name or `null` if the name is
     *                     read from the module's puli.json file.
     */
    public function getModuleName()
    {
        return $this->moduleName;
    }

    /**
     * Returns the name of the installer of the module.
     *
     * @return string The module's installer name.
     */
    public function getInstallerName()
    {
        return $this->installerName;
    }

    /**
     * Sets the name of the installer of the module.
     *
     * @param string $installerName The module's installer name.
     */
    public function setInstallerName($installerName)
    {
        $this->installerName = $installerName;
    }

    /**
     * Returns the disabled resource bindings of the module.
     *
     * @return Uuid[] The UUIDs of the disabled resource bindings.
     */
    public function getDisabledBindingUuids()
    {
        return array_values($this->disabledBindingUuids);
    }

    /**
     * Adds a disabled resource binding for the module.
     *
     * @param Uuid $uuid The UUID of the disabled resource binding.
     */
    public function addDisabledBindingUuid(Uuid $uuid)
    {
        $this->disabledBindingUuids[$uuid->toString()] = $uuid;
    }

    /**
     * Removes a disabled resource binding.
     *
     * If the resource binding is not disabled, this method does nothing.
     *
     * @param Uuid $uuid The UUID of the resource binding to remove.
     */
    public function removeDisabledBindingUuid(Uuid $uuid)
    {
        unset($this->disabledBindingUuids[$uuid->toString()]);
    }

    /**
     * Returns whether the resource binding is disabled.
     *
     * @param Uuid $uuid The UUID of the resource binding.
     *
     * @return bool Whether the resource binding is disabled.
     */
    public function hasDisabledBindingUuid(Uuid $uuid)
    {
        return isset($this->disabledBindingUuids[$uuid->toString()]);
    }

    /**
     * Returns whether the install info contains disabled bindings.
     *
     * @return bool Whether any bindings are disabled.
     */
    public function hasDisabledBindingUuids()
    {
        return count($this->disabledBindingUuids) > 0;
    }

    /**
     * Sets the environment that the module is installed in.
     *
     * @param string $env One of the {@link Environment} constants.
     */
    public function setEnvironment($env)
    {
        Assert::oneOf($env, Environment::all(), 'The environment must be one of: %2$s. Got: %s');

        $this->env = $env;
    }

    /**
     * Returns the environment that the module is installed in.
     *
     * @return string Returns one of the {@link Environment} constants.
     */
    public function getEnvironment()
    {
        return $this->env;
    }
}


1		<?php
2
3		/*
4		* This file is part of the puli/manager 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\Manager\Api\Module;
13
14		use InvalidArgumentException;
15		use Puli\Manager\Api\Environment;
16		use Puli\Manager\Assert\Assert;
17		use Rhumsaa\Uuid\Uuid;
18
19		/**
20		* Contains information about a module installation.
21		*
22		* @since 1.0
23		*
24		* @author Bernhard Schussek <[email protected]>
25		*/
26		class InstallInfo
27		{
28		/**
29		* The default installer of modules.
30		*/
31		const DEFAULT_INSTALLER_NAME = 'user';
32
33		/**
34		* @var string
35		*/
36		private $installPath;
37
38		/**
39		* @var string\|null
40		*/
41		private $moduleName;
42
43		/**
44		* @var string
45		*/
46		private $env = Environment::PROD;
47
48		/**
49		* @var string
50		*/
51		private $installerName = self::DEFAULT_INSTALLER_NAME;
52
53		/**
54		* @var Uuid[]
55		*/
56		private $disabledBindingUuids = array();
57
58		/**
59		* Creates a new install info.
60		*
61		* @param string $moduleName The module name. Must be a non-empty string.
62		* @param string $installPath The path where the module is installed.
63		* If a relative path is given, the path is
64		* assumed to be relative to the install path
65		* of the root module.
66		*
67		* @throws InvalidArgumentException If any of the arguments is invalid.
68		*/
69	208	public function __construct($moduleName, $installPath)
70		{
71	208	Assert::moduleName($moduleName);
72	206	Assert::systemPath($installPath);
73
74	204	$this->moduleName = $moduleName;
75	204	$this->installPath = $installPath;
76	204	}
77
78		/**
79		* Returns the path where the module is installed.
80		*
81		* @return string The path where the module is installed. The path is
82		* either absolute or relative to the install path of the
83		* root module.
84		*/
85	56	public function getInstallPath()
86		{
87	56	return $this->installPath;
88		}
89
90		/**
91		* Returns the module name.
92		*
93		* @return null\|string Returns the module name or `null` if the name is
94		* read from the module's puli.json file.
95		*/
96	198	public function getModuleName()
97		{
98	198	return $this->moduleName;
99		}
100
101		/**
102		* Returns the name of the installer of the module.
103		*
104		* @return string The module's installer name.
105		*/
106	8	public function getInstallerName()
107		{
108	8	return $this->installerName;
109		}
110
111		/**
112		* Sets the name of the installer of the module.
113		*
114		* @param string $installerName The module's installer name.
115		*/
116	12	public function setInstallerName($installerName)
117		{
118	12	$this->installerName = $installerName;
119	12	}
120
121		/**
122		* Returns the disabled resource bindings of the module.
123		*
124		* @return Uuid[] The UUIDs of the disabled resource bindings.
125		*/
126	16	public function getDisabledBindingUuids()
127		{
128	16	return array_values($this->disabledBindingUuids);
129		}
130
131		/**
132		* Adds a disabled resource binding for the module.
133		*
134		* @param Uuid $uuid The UUID of the disabled resource binding.
135		*/
136	19	public function addDisabledBindingUuid(Uuid $uuid)
137		{
138	19	$this->disabledBindingUuids[$uuid->toString()] = $uuid;
139	19	}
140
141		/**
142		* Removes a disabled resource binding.
143		*
144		* If the resource binding is not disabled, this method does nothing.
145		*
146		* @param Uuid $uuid The UUID of the resource binding to remove.
147		*/
148	9	public function removeDisabledBindingUuid(Uuid $uuid)
149		{
150	9	unset($this->disabledBindingUuids[$uuid->toString()]);
151	9	}
152
153		/**
154		* Returns whether the resource binding is disabled.
155		*
156		* @param Uuid $uuid The UUID of the resource binding.
157		*
158		* @return bool Whether the resource binding is disabled.
159		*/
160	24	public function hasDisabledBindingUuid(Uuid $uuid)
161		{
162	24	return isset($this->disabledBindingUuids[$uuid->toString()]);
163		}
164
165		/**
166		* Returns whether the install info contains disabled bindings.
167		*
168		* @return bool Whether any bindings are disabled.
169		*/
170	3	public function hasDisabledBindingUuids()
171		{
172	3	return count($this->disabledBindingUuids) > 0;
173		}
174
175		/**
176		* Sets the environment that the module is installed in.
177		*
178		* @param string $env One of the {@link Environment} constants.
179		*/
180	10	public function setEnvironment($env)
181		{
182	10	Assert::oneOf($env, Environment::all(), 'The environment must be one of: %2$s. Got: %s');
183
184	9	$this->env = $env;
185	9	}
186
187		/**
188		* Returns the environment that the module is installed in.
189		*
190		* @return string Returns one of the {@link Environment} constants.
191		*/
192	6	public function getEnvironment()
193		{
194	6	return $this->env;
195		}
196		}
197

puli / manager

Push — master ( d49c03...6343d0 )

InstallInfo::getModuleName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like