RunOpts::getBoolOption() - Code Metrics - Inspection of "prepare 0.0.43 release" - ktomk/pipelines - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 800fb3...1ce7d0 )

by Tom

created 2020-07-05 08:33 UTC

RunOpts::getBoolOption() A

↳ Parent: RunOpts

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/* this file is part of pipelines */

namespace Ktomk\Pipelines\Runner;

use Ktomk\Pipelines\Utility\Options;
use Ktomk\Pipelines\Value\Prefix;

/**
 * Runner options parameter object
 */
class RunOpts
{
    /**
     * @var string
     */
    private $prefix;

    /**
     * @var Options
     */
    private $options;

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

    /**
     * @var null|string of step expression or null if not set
     */
    private $steps;

    /**
     * @var bool
     */
    private $noManual = false;

    /**
     * @var null|string --user $(id -u):$(id -g)
     */
    private $user;

    /**
     * @var null|true --ssh-auth
     */
    private $ssh;

    /**
     * Static factory method
     *
     * @param string $prefix [optional]
     * @param string $binaryPackage [optional] package name or path to binary (string)
     * @param Options $options [optional]
     *
     * @return RunOpts
     */
    public static function create($prefix = null, $binaryPackage = null, Options $options = null)
    {
        null === $options && $options = Options::create();

        return new self($prefix, $options, $binaryPackage);
    }

    /**
     * RunOpts constructor.
     *
     * NOTE: All run options are optional by design (pass NULL).
     *
     * @param string $prefix
     * @param null|Options $options
     * @param string $binaryPackage package name or path to binary (string)
     * @param null|string $user user option, non-null (string) if set
     * @param null|true $ssh
     */
    public function __construct($prefix = null, Options $options = null, $binaryPackage = null, $user = null, $ssh = null)
    {
        $this->prefix = null === $prefix ? $prefix : Prefix::verify($prefix);
        $this->options = $options;
        $this->binaryPackage = $binaryPackage;
        $this->user = $user;
        $this->ssh = $ssh;
    }

    /**
     * @param string $prefix
     *
     * @return void
     */
    public function setPrefix($prefix)
    {
        $this->prefix = $prefix;
    }

    /**
     * The prefix is used when creating containers for the container name.
     *
     * See --prefix option.
     *
     * @return string
     */
    public function getPrefix()
    {
        return $this->prefix;
    }

    /**
     * @param string $name
     *
     * @return null|string
     */
    public function getOption($name)
    {
        if (!isset($this->options)) {
            return null;
        }

        return $this->options->get($name);
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function getBoolOption($name)
    {
        return (bool)$this->getOption($name);
    }

    /**
     * @param string $binaryPackage
     *
     * @return void
     */
    public function setBinaryPackage($binaryPackage)
    {
        $this->binaryPackage = $binaryPackage;
    }

    /**
     * @return string
     */
    public function getBinaryPackage()
    {
        return $this->binaryPackage;
    }

    /**
     * @return null|string
     */
    public function getSteps()
    {
        return $this->steps;
    }

    /**
     * @param null|string $steps
     *
     * @return void
     */
    public function setSteps($steps)
    {
        $this->steps = $steps;
    }

    /**
     * @return bool
     */
    public function isNoManual()
    {
        return $this->noManual;
    }

    /**
     * @param bool $noManual
     *
     * @return void
     */
    public function setNoManual($noManual)
    {
        $this->noManual = (bool)$noManual;
    }

    /**
     * @return null|string
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * @param null|string $user
     */
    public function setUser($user)
    {
        $this->user = $user;
    }

    /**
     * @return null|true
     */
    public function getSsh()
    {
        return $this->ssh ? true : null;
    }

    /**
     * @param null|true $ssh
     */
    public function setSsh($ssh)
    {
        $this->ssh = $ssh ? true : null;
    }
}


1		<?php
2
3		/* this file is part of pipelines */
4
5		namespace Ktomk\Pipelines\Runner;
6
7		use Ktomk\Pipelines\Utility\Options;
8		use Ktomk\Pipelines\Value\Prefix;
9
10		/**
11		* Runner options parameter object
12		*/
13		class RunOpts
14		{
15		/**
16		* @var string
17		*/
18		private $prefix;
19
20		/**
21		* @var Options
22		*/
23		private $options;
24
25		/**
26		* @var string
27		*/
28		private $binaryPackage;
29
30		/**
31		* @var null\|string of step expression or null if not set
32		*/
33		private $steps;
34
35		/**
36		* @var bool
37		*/
38		private $noManual = false;
39
40		/**
41		* @var null\|string --user $(id -u):$(id -g)
42		*/
43		private $user;
44
45		/**
46		* @var null\|true --ssh-auth
47		*/
48		private $ssh;
49
50		/**
51		* Static factory method
52		*
53		* @param string $prefix [optional]
54		* @param string $binaryPackage [optional] package name or path to binary (string)
55		* @param Options $options [optional]
56		*
57		* @return RunOpts
58		*/
59	1	public static function create($prefix = null, $binaryPackage = null, Options $options = null)
60		{
61	1	null === $options && $options = Options::create();
62
63	1	return new self($prefix, $options, $binaryPackage);
64		}
65
66		/**
67		* RunOpts constructor.
68		*
69		* NOTE: All run options are optional by design (pass NULL).
70		*
71		* @param string $prefix
72		* @param null\|Options $options
73		* @param string $binaryPackage package name or path to binary (string)
74		* @param null\|string $user user option, non-null (string) if set
75		* @param null\|true $ssh
76		*/
77	2	public function __construct($prefix = null, Options $options = null, $binaryPackage = null, $user = null, $ssh = null)
78		{
79	2	$this->prefix = null === $prefix ? $prefix : Prefix::verify($prefix);
80	2	$this->options = $options;
81	2	$this->binaryPackage = $binaryPackage;
82	2	$this->user = $user;
83	2	$this->ssh = $ssh;
84	2	}
85
86		/**
87		* @param string $prefix
88		*
89		* @return void
90		*/
91	1	public function setPrefix($prefix)
92		{
93	1	$this->prefix = $prefix;
94	1	}
95
96		/**
97		* The prefix is used when creating containers for the container name.
98		*
99		* See --prefix option.
100		*
101		* @return string
102		*/
103	1	public function getPrefix()
104		{
105	1	return $this->prefix;
106		}
107
108		/**
109		* @param string $name
110		*
111		* @return null\|string
112		*/
113	2	public function getOption($name)
114		{
115	2	if (!isset($this->options)) {
116	1	return null;
117		}
118
119	1	return $this->options->get($name);
120		}
121
122		/**
123		* @param string $name
124		*
125		* @return bool
126		*/
127	1	public function getBoolOption($name)
128		{
129	1	return (bool)$this->getOption($name);
130		}
131
132		/**
133		* @param string $binaryPackage
134		*
135		* @return void
136		*/
137	1	public function setBinaryPackage($binaryPackage)
138		{
139	1	$this->binaryPackage = $binaryPackage;
140	1	}
141
142		/**
143		* @return string
144		*/
145	1	public function getBinaryPackage()
146		{
147	1	return $this->binaryPackage;
148		}
149
150		/**
151		* @return null\|string
152		*/
153	1	public function getSteps()
154		{
155	1	return $this->steps;
156		}
157
158		/**
159		* @param null\|string $steps
160		*
161		* @return void
162		*/
163	1	public function setSteps($steps)
164		{
165	1	$this->steps = $steps;
166	1	}
167
168		/**
169		* @return bool
170		*/
171	1	public function isNoManual()
172		{
173	1	return $this->noManual;
174		}
175
176		/**
177		* @param bool $noManual
178		*
179		* @return void
180		*/
181	1	public function setNoManual($noManual)
182		{
183	1	$this->noManual = (bool)$noManual;
184	1	}
185
186		/**
187		* @return null\|string
188		*/
189	1	public function getUser()
190		{
191	1	return $this->user;
192		}
193
194		/**
195		* @param null\|string $user
196		*/
197	1	public function setUser($user)
198		{
199	1	$this->user = $user;
200	1	}
201
202		/**
203		* @return null\|true
204		*/
205	1	public function getSsh()
206		{
207	1	return $this->ssh ? true : null;
208		}
209
210		/**
211		* @param null\|true $ssh
212		*/
213	1	public function setSsh($ssh)
214		{
215	1	$this->ssh = $ssh ? true : null;
216	1	}
217		}
218

ktomk / pipelines

Push — master ( 800fb3...1ce7d0 )

RunOpts::getBoolOption() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like