Zone::iterateRecords() - Code Metrics - Inspection of "clean code" - LTD-Beget/dns-zone-configurator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e9839e...f54444 )

by Sergey

created 2016-04-12 10:41 UTC

Zone::iterateRecords() A

↳ Parent: Zone

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Metric	Value
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
cc	3
eloc	4
nc	3
nop	1
crap	3

<?php
/**
 * @author: Viskov Sergey
 * @date  : 4/12/16
 * @time  : 1:00 PM
 */

namespace LTDBeget\dns\configurator;

use LTDBeget\dns\configurator\deserializer\ArrayDeserializer;
use LTDBeget\dns\configurator\deserializer\PlainDeserializer;
use LTDBeget\dns\configurator\errors\ErrorsStore;
use LTDBeget\dns\configurator\errors\ValidationError;
use LTDBeget\dns\configurator\traits\RecordsIterateTrait;
use LTDBeget\dns\configurator\validators\OriginValidator;
use LTDBeget\dns\configurator\validators\SoaNumberCheck;
use LTDBeget\dns\configurator\zoneEntities\Node;
use LTDBeget\dns\configurator\zoneEntities\record\AaaaRecord;
use LTDBeget\dns\configurator\zoneEntities\record\ARecord;
use LTDBeget\dns\configurator\zoneEntities\record\base\Record;
use LTDBeget\dns\configurator\zoneEntities\record\CnameRecord;
use LTDBeget\dns\configurator\zoneEntities\record\MxRecord;
use LTDBeget\dns\configurator\zoneEntities\record\NsRecord;
use LTDBeget\dns\configurator\zoneEntities\record\PtrRecord;
use LTDBeget\dns\configurator\zoneEntities\record\SoaRecord;
use LTDBeget\dns\configurator\zoneEntities\record\SrvRecord;
use LTDBeget\dns\configurator\zoneEntities\record\TxtRecord;
use LTDBeget\dns\enums\eErrorCode;
use LTDBeget\dns\enums\eRecordType;

/**
 * Class Zone
 *
 * @package LTDBeget\dns\configurator
 * @method ARecord[] iterateA()
 * @method AaaaRecord[] iterateAaaa()
 * @method CnameRecord[] iterateCname()
 * @method MxRecord[] iterateMx()
 * @method NsRecord[] iterateNs()
 * @method PtrRecord[] iteratePtr()
 * @method SoaRecord[] iterateSoa()
 * @method SrvRecord[] iterateSrv()
 * @method TxtRecord[] iterateTxt()
 */
class Zone
{
    use RecordsIterateTrait;

    /**
     * @var String
     */
    private $origin;
    /**
     * @var Node[] $nodes
     */
    private $nodes = [];
    /**
     * @var ErrorsStore
     */
    private $errorsStore;

    /**
     * @param $origin
     */
    public function __construct(string $origin)
    {
        $this->origin      = mb_strtolower(trim($origin));
        $this->errorsStore = new ErrorsStore();
    }

    /**
     * @param string $origin
     * @param string $plainData
     * @return Zone
     */
    public static function fromString(string $origin, string $plainData) : Zone
    {
        return PlainDeserializer::deserialize(new self($origin), $plainData);
    }

    /**
     * @param string $origin
     * @param array  $arrayData
     * @return Zone
     */
    public static function fromArray(string $origin, array $arrayData) : Zone
    {
        return ArrayDeserializer::deserialize(new self($origin), $arrayData);
    }

    /**
     * @return string
     */
    public function __toString() : string
    {
        $this->sort();
        $records = [];
        foreach ($this->iterateRecords() as $record) {
            $records[] = (string) $record;
        }

        return implode("\n", $records);
    }

    /**
     * Sort zone by node names and record types
     */
    public function sort()
    {
        $nodes = $this->nodes;
        /** @var Node[] $_nodes */
        $_nodes = [];
        foreach (['@', 'www', '*'] as $node_name) {
            if (isset($nodes[$node_name])) {
                $_nodes[$node_name] = $nodes[$node_name];
                unset($nodes[$node_name]);
            }
        }

        ksort($nodes);
        $this->nodes = array_merge($_nodes, $nodes);


        foreach ($this->iterateNodes() as $node) {
            $node->sort();
        }
    }

    /**
     * @return Node[]
     */
    public function iterateNodes()
    {
        foreach ($this->nodes as $node) {
            yield $node;
        }
    }

    /**
     * @param eRecordType|null $type
     * @return Record[]
     */
    public function iterateRecords(eRecordType $type = NULL)
    {
        foreach ($this->iterateNodes() as $node) {
            foreach ($node->iterateRecords($type) as $record) {
                yield $record;
            }
        }
    }

    /**
     * @return array
     */
    public function toArray() : array
    {
        $records = [];
        foreach ($this->iterateRecords() as $record) {
            $records[] = $record->toArray();
        }

        return $records;
    }

    /**
     * @return array
     */
    public function getNodeNames() : array
    {
        return array_keys($this->nodes);
    }

    /**
     * @param $name
     * @return Node
     */
    public function getNode(string $name) : Node
    {
        $name = mb_strtolower(trim($name));

        if (!$this->isNodeExist($name)) {
            $this->nodes[$name] = new Node($this, $name);
        }

        return $this->nodes[$name];
    }

    /**
     * Check is node by given name already exists
     *
     * @param $name
     * @return bool
     */
    public function isNodeExist($name) : bool
    {
        return array_key_exists(mb_strtolower(trim($name)), $this->nodes);
    }

    /**
     * Full validate zone via build in validators
     *
     * @return bool
     */
    public function validate() : bool
    {
        $errorsStore = $this->getErrorsStore();
        $errorsStore->clear();

        foreach ($this->iterateNodes() as $node) {
            /** @noinspection PhpInternalEntityUsedInspection */
            $node->validate();
        }

        if (!SoaNumberCheck::validate($this)) {
            $errorsStore->add(ValidationError::makeZoneError($this, eErrorCode::SOA_ERROR()));
        }

        if (!OriginValidator::validate($this->getOrigin())) {
            $errorsStore->add(ValidationError::makeZoneError($this, eErrorCode::WRONG_ORIGIN()));
        }

        return !$errorsStore->isHasErrors();
    }

    /**
     * @return ErrorsStore
     */
    public function getErrorsStore()
    {
        return $this->errorsStore;
    }

    /**
     * @return String
     */
    public function getOrigin() : string
    {
        return $this->origin;
    }
}

1		<?php
2		/**
3		* @author: Viskov Sergey
4		* @date : 4/12/16
5		* @time : 1:00 PM
6		*/
7
8		namespace LTDBeget\dns\configurator;
9
10		use LTDBeget\dns\configurator\deserializer\ArrayDeserializer;
11		use LTDBeget\dns\configurator\deserializer\PlainDeserializer;
12		use LTDBeget\dns\configurator\errors\ErrorsStore;
13		use LTDBeget\dns\configurator\errors\ValidationError;
14		use LTDBeget\dns\configurator\traits\RecordsIterateTrait;
15		use LTDBeget\dns\configurator\validators\OriginValidator;
16		use LTDBeget\dns\configurator\validators\SoaNumberCheck;
17		use LTDBeget\dns\configurator\zoneEntities\Node;
18		use LTDBeget\dns\configurator\zoneEntities\record\AaaaRecord;
19		use LTDBeget\dns\configurator\zoneEntities\record\ARecord;
20		use LTDBeget\dns\configurator\zoneEntities\record\base\Record;
21		use LTDBeget\dns\configurator\zoneEntities\record\CnameRecord;
22		use LTDBeget\dns\configurator\zoneEntities\record\MxRecord;
23		use LTDBeget\dns\configurator\zoneEntities\record\NsRecord;
24		use LTDBeget\dns\configurator\zoneEntities\record\PtrRecord;
25		use LTDBeget\dns\configurator\zoneEntities\record\SoaRecord;
26		use LTDBeget\dns\configurator\zoneEntities\record\SrvRecord;
27		use LTDBeget\dns\configurator\zoneEntities\record\TxtRecord;
28		use LTDBeget\dns\enums\eErrorCode;
29		use LTDBeget\dns\enums\eRecordType;
30
31		/**
32		* Class Zone
33		*
34		* @package LTDBeget\dns\configurator
35		* @method ARecord[] iterateA()
36		* @method AaaaRecord[] iterateAaaa()
37		* @method CnameRecord[] iterateCname()
38		* @method MxRecord[] iterateMx()
39		* @method NsRecord[] iterateNs()
40		* @method PtrRecord[] iteratePtr()
41		* @method SoaRecord[] iterateSoa()
42		* @method SrvRecord[] iterateSrv()
43		* @method TxtRecord[] iterateTxt()
44		*/
45		class Zone
46		{
47		use RecordsIterateTrait;
48
49		/**
50		* @var String
51		*/
52		private $origin;
53		/**
54		* @var Node[] $nodes
55		*/
56		private $nodes = [];
57		/**
58		* @var ErrorsStore
59		*/
60		private $errorsStore;
61
62		/**
63		* @param $origin
64		*/
65	1	public function __construct(string $origin)
66		{
67	1	$this->origin = mb_strtolower(trim($origin));
68	1	$this->errorsStore = new ErrorsStore();
69	1	}
70
71		/**
72		* @param string $origin
73		* @param string $plainData
74		* @return Zone
75		*/
76	1	public static function fromString(string $origin, string $plainData) : Zone
77		{
78	1	return PlainDeserializer::deserialize(new self($origin), $plainData);
79		}
80
81		/**
82		* @param string $origin
83		* @param array $arrayData
84		* @return Zone
85		*/
86		public static function fromArray(string $origin, array $arrayData) : Zone
87		{
88		return ArrayDeserializer::deserialize(new self($origin), $arrayData);
89		}
90
91		/**
92		* @return string
93		*/
94	1	public function __toString() : string
95		{
96	1	$this->sort();
97	1	$records = [];
98	1	foreach ($this->iterateRecords() as $record) {
99	1	$records[] = (string) $record;
100		}
101
102	1	return implode("\n", $records);
103		}
104
105		/**
106		* Sort zone by node names and record types
107		*/
108	1	public function sort()
109		{
110	1	$nodes = $this->nodes;
111		/** @var Node[] $_nodes */
112	1	$_nodes = [];
113	1	foreach (['@', 'www', '*'] as $node_name) {
114	1	if (isset($nodes[$node_name])) {
115	1	$_nodes[$node_name] = $nodes[$node_name];
116	1	unset($nodes[$node_name]);
117		}
118		}
119
120	1	ksort($nodes);
121	1	$this->nodes = array_merge($_nodes, $nodes);
		1 ignored issue – show Documentation Bug introduced 2016-04-12 00:10 UTC by Report Bug Copy Issue Report It seems like `array_merge($_nodes, $nodes)` of type `array` is incompatible with the declared type `array<integer,object<LTD...tor\zoneEntities\Node>>` of property `$nodes`. 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...
122
123	1	foreach ($this->iterateNodes() as $node) {
124	1	$node->sort();
125		}
126	1	}
127
128		/**
129		* @return Node[]
130		*/
131	1	public function iterateNodes()
132		{
133	1	foreach ($this->nodes as $node) {
134	1	yield $node;
135		}
136	1	}
137
138		/**
139		* @param eRecordType\|null $type
140		* @return Record[]
141		*/
142	1	public function iterateRecords(eRecordType $type = NULL)
143		{
144	1	foreach ($this->iterateNodes() as $node) {
145	1	foreach ($node->iterateRecords($type) as $record) {
146	1	yield $record;
147		}
148		}
149	1	}
150
151		/**
152		* @return array
153		*/
154	1	public function toArray() : array
155		{
156	1	$records = [];
157	1	foreach ($this->iterateRecords() as $record) {
158	1	$records[] = $record->toArray();
159		}
160
161	1	return $records;
162		}
163
164		/**
165		* @return array
166		*/
167		public function getNodeNames() : array
168		{
169		return array_keys($this->nodes);
170		}
171
172		/**
173		* @param $name
174		* @return Node
175		*/
176	1	public function getNode(string $name) : Node
177		{
178	1	$name = mb_strtolower(trim($name));
179
180	1	if (!$this->isNodeExist($name)) {
181	1	$this->nodes[$name] = new Node($this, $name);
182		}
183
184	1	return $this->nodes[$name];
185		}
186
187		/**
188		* Check is node by given name already exists
189		*
190		* @param $name
191		* @return bool
192		*/
193	1	public function isNodeExist($name) : bool
194		{
195	1	return array_key_exists(mb_strtolower(trim($name)), $this->nodes);
196		}
197
198		/**
199		* Full validate zone via build in validators
200		*
201		* @return bool
202		*/
203	1	public function validate() : bool
204		{
205	1	$errorsStore = $this->getErrorsStore();
206	1	$errorsStore->clear();
207
208	1	foreach ($this->iterateNodes() as $node) {
209		/** @noinspection PhpInternalEntityUsedInspection */
210	1	$node->validate();
211		}
212
213	1	if (!SoaNumberCheck::validate($this)) {
214		$errorsStore->add(ValidationError::makeZoneError($this, eErrorCode::SOA_ERROR()));
215		}
216
217	1	if (!OriginValidator::validate($this->getOrigin())) {
218	1	$errorsStore->add(ValidationError::makeZoneError($this, eErrorCode::WRONG_ORIGIN()));
219		}
220
221	1	return !$errorsStore->isHasErrors();
222		}
223
224		/**
225		* @return ErrorsStore
226		*/
227	1	public function getErrorsStore()
228		{
229	1	return $this->errorsStore;
230		}
231
232		/**
233		* @return String
234		*/
235	1	public function getOrigin() : string
236		{
237	1	return $this->origin;
238		}
239		}

LTD-Beget / dns-zone-configurator

Push — master ( e9839e...f54444 )

Zone::iterateRecords() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like