SecurityTxt::__construct() - Code Metrics - Inspection of "unit tests" - austinheap/php-security-txt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e17d9a...f8eac8 )

by Austin

created 2017-11-21 20:13 UTC

SecurityTxt::__construct() B

↳ Parent: SecurityTxt

Complexity

Conditions	6
Paths	4

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	9
nc	4
nop	1
dl	0
loc	17
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * src/SecurityTxt.php
 *
 * @package     php-security-txt
 * @author      Austin Heap <[email protected]>
 * @version     v0.4.0
 */

declare(strict_types = 1);

namespace AustinHeap\Security\Txt;

use AustinHeap\Security\Txt\Directives\Acknowledgement;
use AustinHeap\Security\Txt\Directives\Contact;
use AustinHeap\Security\Txt\Directives\Disclosure;
use AustinHeap\Security\Txt\Directives\Encryption;
use Exception;

/**
 * SecurityTxt
 *
 * @link        https://github.com/austinheap/php-security-txt
 * @link        https://packagist.org/packages/austinheap/php-security-txt
 * @link        https://austinheap.github.io/php-security-txt/classes/AustinHeap.Security.Txt.SecurityTxt.html
 */
class SecurityTxt implements SecurityTxtInterface
{
    /**
     * Directive trait: Contact
     */
    use Contact;

    /**
     * Directive trait: Encryption
     */
    use Encryption;

    /**
     * Directive trait: Disclosure
     */
    use Disclosure;

    /**
     * Directive trait: Acknowledgement
     */
    use Acknowledgement;

    /**
     * Internal version number.
     *
     * @var string
     */
    const VERSION = '0.4.0';

    /**
     * Internal parent object.
     *
     * @var \AustinHeap\Security\Txt\Writer|\AustinHeap\Security\Txt\Reader
     */
    private $parent = null;

    /**
     * Internal Writer object.
     *
     * @var \AustinHeap\Security\Txt\Writer
     */
    protected $writer = null;

    /**
     * Internal Reader object.
     *
     * @var \AustinHeap\Security\Txt\Reader
     */
    protected $reader = null;

    /**
     * Internal text cache.
     *
     * @var string
     */
    protected $text = null;

    /**
     * Enable debug output.
     *
     * @var bool
     */
    protected $debug = false;

    /**
     * Enable built-in comments.
     *
     * @var bool
     */
    protected $comments = true;

    /**
     * Create a new SecurityTxt instance.
     *
     * @param  Writer|Reader $parent
     *
     * @return SecurityTxt|Writer|Reader
     */
    public function __construct(&$parent = null)
    {
        if (!defined('PHP_SECURITY_TXT_VERSION')) {
            define('PHP_SECURITY_TXT_VERSION', self::VERSION);
        }

        $this->parent = $parent;

        if (func_num_args() == 1) {
            if (is_null($this->parent)) {
                throw new Exception('Cannot create ' . __CLASS__ . ' with explicitly null $parent class.');
            } else if (!$this->parent instanceof Reader && !$this->parent instanceof Writer) {
                throw new Exception('Cannot create ' . __CLASS__ . ' with $parent class: ' . get_class($this->parent));
            }
        }

        return $this;
    }

    /**
     * Returns the parent's class if it exists.
     *
     * @return string
     */
    public function getParentClass(): string
    {
        return get_class($this->getParent());
    }

    /**
     * Returns the parent object if it exists.
     *
     * @return Reader|Writer
     */
    public function getParent()
    {
        if (!$this->hasParent()) {
            throw new Exception('Parent object is not set.');
        }

        return $this->parent;
    }

    /**
     * Determines if the parent object was set.
     *
     * @return bool
     */
    public function hasParent(): bool
    {
        return !is_null($this->parent);
    }

    /**
     * Enable the comments flag.
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function enableComments(): SecurityTxt
    {
        return $this->setComments(true);
    }

    /**
     * Disable the comments flag.
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function disableComments(): SecurityTxt
    {
        return $this->setComments(false);
    }

    /**
     * Set the comments flag.
     *
     * @param  string $comments
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function setComments(bool $comments): SecurityTxt
    {
        $this->comments = $comments;

        return $this;
    }

    /**
     * Get the comments flag.
     *
     * @return bool
     */
    public function getComments(): bool
    {
        return $this->comments;
    }

    /**
     * Enable the debug flag.
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function enableDebug(): SecurityTxt
    {
        return $this->setDebug(true);
    }

    /**
     * Disable the debug flag.
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function disableDebug(): SecurityTxt
    {
        return $this->setDebug(false);
    }

    /**
     * Set the debug flag.
     *
     * @param  bool $debug
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function setDebug(bool $debug): SecurityTxt
    {
        $this->debug = $debug;

        return $this;
    }

    /**
     * Get the debug flag.
     *
     * @return bool
     */
    public function getDebug(): bool
    {
        return $this->debug;
    }

    /**
     * Set the text.
     *
     * @param  string $text
     *
     * @return \AustinHeap\Security\Txt\SecurityTxt
     */
    public function setText(string $text): SecurityTxt
    {
        $this->text = $text;

        return $this;
    }

    /**
     * Get the text.
     *
     * @return string
     */
    public function getText(): string
    {
        return $this->text === null ? '' : $this->text;
    }

    /**
     * Stub generate function. Must be overridden by inheriting class that implements SecurityTxtInterface.
     *
     * @param bool $test_case
     *
     * @return Reader|Writer|null
     * @throws Exception
     */
    public function execute(bool $test_case = false)
    {
        return $this->overrideMissing(__FUNCTION__, $test_case);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * Stub reset function. Must be overridden by inheriting class that implements SecurityTxtInterface.
     *
     * @param bool $test_case
     *
     * @return Reader|Writer|null
     * @throws Exception
     */
    public function reset(bool $test_case = false)
    {
        return $this->overrideMissing(__FUNCTION__, $test_case);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * Throws an exception when the inheriting class did not correctly implement SecurityTxtInterface.
     *
     * @param string $function
     * @param bool   $test_case
     *
     * @return null
     * @throws Exception
     */
    public function overrideMissing(string $function, bool $test_case = false)
    {
        if ($test_case) {
            return null;
        }

        throw new Exception('Function "' . $function . '" must be overridden by parent SecurityTxtInterface before being called.');
    }
}


1			<?php
2			/**
3			* src/SecurityTxt.php
4			*
5			* @package php-security-txt
6			* @author Austin Heap <[email protected]>
7			* @version v0.4.0
8			*/
9
10			declare(strict_types = 1);
11
12			namespace AustinHeap\Security\Txt;
13
14			use AustinHeap\Security\Txt\Directives\Acknowledgement;
15			use AustinHeap\Security\Txt\Directives\Contact;
16			use AustinHeap\Security\Txt\Directives\Disclosure;
17			use AustinHeap\Security\Txt\Directives\Encryption;
18			use Exception;
19
20			/**
21			* SecurityTxt
22			*
23			* @link https://github.com/austinheap/php-security-txt
24			* @link https://packagist.org/packages/austinheap/php-security-txt
25			* @link https://austinheap.github.io/php-security-txt/classes/AustinHeap.Security.Txt.SecurityTxt.html
26			*/
27			class SecurityTxt implements SecurityTxtInterface
28			{
29			/**
30			* Directive trait: Contact
31			*/
32			use Contact;
33
34			/**
35			* Directive trait: Encryption
36			*/
37			use Encryption;
38
39			/**
40			* Directive trait: Disclosure
41			*/
42			use Disclosure;
43
44			/**
45			* Directive trait: Acknowledgement
46			*/
47			use Acknowledgement;
48
49			/**
50			* Internal version number.
51			*
52			* @var string
53			*/
54			const VERSION = '0.4.0';
55
56			/**
57			* Internal parent object.
58			*
59			* @var \AustinHeap\Security\Txt\Writer\|\AustinHeap\Security\Txt\Reader
60			*/
61			private $parent = null;
62
63			/**
64			* Internal Writer object.
65			*
66			* @var \AustinHeap\Security\Txt\Writer
67			*/
68			protected $writer = null;
69
70			/**
71			* Internal Reader object.
72			*
73			* @var \AustinHeap\Security\Txt\Reader
74			*/
75			protected $reader = null;
76
77			/**
78			* Internal text cache.
79			*
80			* @var string
81			*/
82			protected $text = null;
83
84			/**
85			* Enable debug output.
86			*
87			* @var bool
88			*/
89			protected $debug = false;
90
91			/**
92			* Enable built-in comments.
93			*
94			* @var bool
95			*/
96			protected $comments = true;
97
98			/**
99			* Create a new SecurityTxt instance.
100			*
101			* @param Writer\|Reader $parent
102			*
103			* @return SecurityTxt\|Writer\|Reader
104			*/
105			public function __construct(&$parent = null)
106			{
107			if (!defined('PHP_SECURITY_TXT_VERSION')) {
108			define('PHP_SECURITY_TXT_VERSION', self::VERSION);
109			}
110
111			$this->parent = $parent;
112
113			if (func_num_args() == 1) {
114			if (is_null($this->parent)) {
115			throw new Exception('Cannot create ' . __CLASS__ . ' with explicitly null $parent class.');
116			} else if (!$this->parent instanceof Reader && !$this->parent instanceof Writer) {
117			throw new Exception('Cannot create ' . __CLASS__ . ' with $parent class: ' . get_class($this->parent));
118			}
119			}
120
121			return $this;
122			}
123
124			/**
125			* Returns the parent's class if it exists.
126			*
127			* @return string
128			*/
129			public function getParentClass(): string
130			{
131			return get_class($this->getParent());
132			}
133
134			/**
135			* Returns the parent object if it exists.
136			*
137			* @return Reader\|Writer
138			*/
139			public function getParent()
140			{
141			if (!$this->hasParent()) {
142			throw new Exception('Parent object is not set.');
143			}
144
145			return $this->parent;
146			}
147
148			/**
149			* Determines if the parent object was set.
150			*
151			* @return bool
152			*/
153			public function hasParent(): bool
154			{
155			return !is_null($this->parent);
156			}
157
158			/**
159			* Enable the comments flag.
160			*
161			* @return \AustinHeap\Security\Txt\SecurityTxt
162			*/
163			public function enableComments(): SecurityTxt
164			{
165			return $this->setComments(true);
166			}
167
168			/**
169			* Disable the comments flag.
170			*
171			* @return \AustinHeap\Security\Txt\SecurityTxt
172			*/
173			public function disableComments(): SecurityTxt
174			{
175			return $this->setComments(false);
176			}
177
178			/**
179			* Set the comments flag.
180			*
181			* @param string $comments
182			*
183			* @return \AustinHeap\Security\Txt\SecurityTxt
184			*/
185			public function setComments(bool $comments): SecurityTxt
186			{
187			$this->comments = $comments;
188
189			return $this;
190			}
191
192			/**
193			* Get the comments flag.
194			*
195			* @return bool
196			*/
197			public function getComments(): bool
198			{
199			return $this->comments;
200			}
201
202			/**
203			* Enable the debug flag.
204			*
205			* @return \AustinHeap\Security\Txt\SecurityTxt
206			*/
207			public function enableDebug(): SecurityTxt
208			{
209			return $this->setDebug(true);
210			}
211
212			/**
213			* Disable the debug flag.
214			*
215			* @return \AustinHeap\Security\Txt\SecurityTxt
216			*/
217			public function disableDebug(): SecurityTxt
218			{
219			return $this->setDebug(false);
220			}
221
222			/**
223			* Set the debug flag.
224			*
225			* @param bool $debug
226			*
227			* @return \AustinHeap\Security\Txt\SecurityTxt
228			*/
229			public function setDebug(bool $debug): SecurityTxt
230			{
231			$this->debug = $debug;
232
233			return $this;
234			}
235
236			/**
237			* Get the debug flag.
238			*
239			* @return bool
240			*/
241			public function getDebug(): bool
242			{
243			return $this->debug;
244			}
245
246			/**
247			* Set the text.
248			*
249			* @param string $text
250			*
251			* @return \AustinHeap\Security\Txt\SecurityTxt
252			*/
253			public function setText(string $text): SecurityTxt
254			{
255			$this->text = $text;
256
257			return $this;
258			}
259
260			/**
261			* Get the text.
262			*
263			* @return string
264			*/
265			public function getText(): string
266			{
267			return $this->text === null ? '' : $this->text;
268			}
269
270			/**
271			* Stub generate function. Must be overridden by inheriting class that implements SecurityTxtInterface.
272			*
273			* @param bool $test_case
274			*
275			* @return Reader\|Writer\|null
276			* @throws Exception
277			*/
278			public function execute(bool $test_case = false)
279			{
280			return $this->overrideMissing(__FUNCTION__, $test_case);
			0 ignored issues – show Bug introduced 2017-11-21 20:15 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->overrideMissing(__FUNCTION__, $test_case)` targeting `AustinHeap\Security\Txt\...yTxt::overrideMissing()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
281			}
282
283			/**
284			* Stub reset function. Must be overridden by inheriting class that implements SecurityTxtInterface.
285			*
286			* @param bool $test_case
287			*
288			* @return Reader\|Writer\|null
289			* @throws Exception
290			*/
291			public function reset(bool $test_case = false)
292			{
293			return $this->overrideMissing(__FUNCTION__, $test_case);
			0 ignored issues – show Bug introduced 2017-11-21 20:15 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->overrideMissing(__FUNCTION__, $test_case)` targeting `AustinHeap\Security\Txt\...yTxt::overrideMissing()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
294			}
295
296			/**
297			* Throws an exception when the inheriting class did not correctly implement SecurityTxtInterface.
298			*
299			* @param string $function
300			* @param bool $test_case
301			*
302			* @return null
303			* @throws Exception
304			*/
305			public function overrideMissing(string $function, bool $test_case = false)
306			{
307			if ($test_case) {
308			return null;
309			}
310
311			throw new Exception('Function "' . $function . '" must be overridden by parent SecurityTxtInterface before being called.');
312			}
313			}
314

austinheap / php-security-txt

Push — master ( e17d9a...f8eac8 )

SecurityTxt::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like