NatRule::setDescription() - Code Metrics - Inspection of "Adding exception for wrong format" - devgiants/livebox - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 725e32...761ac2 )

by Nicolas

created 2021-11-10 15:24 UTC

NatRule::setDescription() A

↳ Parent: NatRule

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	2
rs	10

<?php

namespace Devgiants\Model;

class NatRule {

	const ORIGIN = 'webui';

	const PROTOCOL_TCP = 6;
	const PROTOCOL_UDP = 17;
	const PROTOCOL_BOTH = '6,17';
	const PROTOCOL_BOTH_INTERNAL = 1000;

	/**
	 * @var string
	 */
	private $id;
	/**
	 * @var boolean
	 */
	private $enable = true;
	/**
	 * @var string
	 */
	private $description;
	/**
	 * @var string
	 */
	private $destinationIPAddress;
	/**
	 * @var string
	 */
	private $externalPort;
	/**
	 * @var string
	 */
	private $internalPort;
	/**
	 * @var string
	 */
	private $origin = self::ORIGIN;
	/**
	 * @var boolean
	 */
	private $persistent = true;
	/**
	 * @var int|string
	 */
	private $protocol = self::PROTOCOL_TCP;
	/**
	 * @var string
	 */
	private $sourceInterface = 'data';

	/**
	 * NatRule constructor.
	 */
	public function __construct() {
	}

	/**
	 * @return string
	 */
	public function getId() : string {
		return $this->id;
	}

	/**
	 * @return boolean
	 */
	public function getEnable() : bool {
		return $this->enable;
	}

	/**
	 * @param string $id
	 * @return void
	 */
	public function setId(string $id) {
		$this->id = str_replace(self::ORIGIN.'_', '', $id);
	}
	/**
	 * @param boolean $enabled
	 * @return void
	 */
	public function setEnable(bool $enabled) {
		$this->enable = $enabled;
	}
	/**
	 * @param string $description
	 * @return void
	 */
	public function setDescription(string $description) {
		$this->description = $description;
	}
	/**
	 * @param string $destinationIPAddress
	 * @return void
	 */
	public function setDestinationIPAddress(string $destinationIPAddress) {
		$this->destinationIPAddress = $destinationIPAddress;
	}
	/**
	 * @param integer $externalPort
	 * @return void
	 */
	public function setExternalPort(int $externalPort) {
		$this->externalPort = $externalPort;
	}
	/**
	 * @param integer $internalPort
	 * @return void
	 */
	public function setInternalPort(int $internalPort) {
		$this->internalPort = $internalPort;
	}
	/**
	 * @param string $origin
	 * @return void
	 */
	public function setOrigin(string $origin) {
		$this->origin = $origin;
	}
	/**
	 * @param boolean $persistent
	 * @return void
	 */
	public function setPersistent(bool $persistent) {
		$this->persistent = $persistent;
	}
	/**
	 * Set protocol
	 *
	 * @param integer $protocol
	 * @return void
	 */
	public function setProtocol(int $protocol) {
		if (self::PROTOCOL_BOTH_INTERNAL === $protocol) {
			$protocol = self::PROTOCOL_BOTH;
		}
		$this->protocol = $protocol;
	}
	/**
	 * Set source interface
	 *
	 * @param string $sourceInterface
	 * @return void
	 */
	public function setSourceInterface(string $sourceInterface) {
		$this->sourceInterface = $sourceInterface;
	}

	/**
	 * Get the output for create rule
	 *
	 * @return array
	 */
	public function getOutput() : array {
		$fieldsOutput = [
			'id',
			'enable',
			'description',
			'destinationIPAddress',
			'externalPort',
			'internalPort',
			'origin',
			'persistent',
			'protocol',
			'sourceInterface'
		];
		return $this->buildOutput($fieldsOutput);
	}

	/**
	 * Get the output for delete rule
	 *
	 * @return array
	 */
	public function getOutputForDelete() : array {
		$fieldsOutput = [
			'id',
			'destinationIPAddress',
			'origin'
		];
		return $this->buildOutput($fieldsOutput);
	}

	/**
	 * Build array output from needed fields
	 *
	 * @param array $fieldsOutput
	 * @return array
	 */
	protected function buildOutput(array $fieldsOutput) : array {
        $output = [];
        foreach ($fieldsOutput as $field) {
            $method = 'get'.ucfirst($field);
            $output[$field] = method_exists($this, $method) ? $this->$method() : $this->$field;
        }
        return $output;
    }

	/**
	 * Build object from command output
	 *
	 * @param object $input
	 * @return NatRule
	 */
	public static function buildFrom($input) {
		$natRule = new self();
		$natRule->setId($input->Id);
		$natRule->setEnable($input->Enable);
		$natRule->setDescription($input->Description);
		$natRule->setDestinationIPAddress($input->DestinationIPAddress);
		$natRule->setExternalPort((int) $input->ExternalPort);
		$natRule->setInternalPort((int) $input->InternalPort);
		$natRule->setOrigin($input->Origin);
		$natRule->setPersistent((bool) $input->Persistent);
		$natRule->setProtocol((int) $input->Protocol);
		$natRule->setSourceInterface($input->SourceInterface);
		return $natRule;
	}

}

1			<?php
2
3			namespace Devgiants\Model;
4
5			class NatRule {
6
7			const ORIGIN = 'webui';
8
9			const PROTOCOL_TCP = 6;
10			const PROTOCOL_UDP = 17;
11			const PROTOCOL_BOTH = '6,17';
12			const PROTOCOL_BOTH_INTERNAL = 1000;
13
14			/**
15			* @var string
16			*/
17			private $id;
18			/**
19			* @var boolean
20			*/
21			private $enable = true;
22			/**
23			* @var string
24			*/
25			private $description;
26			/**
27			* @var string
28			*/
29			private $destinationIPAddress;
30			/**
31			* @var string
32			*/
33			private $externalPort;
34			/**
35			* @var string
36			*/
37			private $internalPort;
38			/**
39			* @var string
40			*/
41			private $origin = self::ORIGIN;
42			/**
43			* @var boolean
44			*/
45			private $persistent = true;
46			/**
47			* @var int\|string
48			*/
49			private $protocol = self::PROTOCOL_TCP;
50			/**
51			* @var string
52			*/
53			private $sourceInterface = 'data';
54
55			/**
56			* NatRule constructor.
57			*/
58			public function __construct() {
59			}
60
61			/**
62			* @return string
63			*/
64			public function getId() : string {
65			return $this->id;
66			}
67
68			/**
69			* @return boolean
70			*/
71			public function getEnable() : bool {
72			return $this->enable;
73			}
74
75			/**
76			* @param string $id
77			* @return void
78			*/
79			public function setId(string $id) {
80			$this->id = str_replace(self::ORIGIN.'_', '', $id);
81			}
82			/**
83			* @param boolean $enabled
84			* @return void
85			*/
86			public function setEnable(bool $enabled) {
87			$this->enable = $enabled;
88			}
89			/**
90			* @param string $description
91			* @return void
92			*/
93			public function setDescription(string $description) {
94			$this->description = $description;
95			}
96			/**
97			* @param string $destinationIPAddress
98			* @return void
99			*/
100			public function setDestinationIPAddress(string $destinationIPAddress) {
101			$this->destinationIPAddress = $destinationIPAddress;
102			}
103			/**
104			* @param integer $externalPort
105			* @return void
106			*/
107			public function setExternalPort(int $externalPort) {
108			$this->externalPort = $externalPort;
109			}
110			/**
111			* @param integer $internalPort
112			* @return void
113			*/
114			public function setInternalPort(int $internalPort) {
115			$this->internalPort = $internalPort;
116			}
117			/**
118			* @param string $origin
119			* @return void
120			*/
121			public function setOrigin(string $origin) {
122			$this->origin = $origin;
123			}
124			/**
125			* @param boolean $persistent
126			* @return void
127			*/
128			public function setPersistent(bool $persistent) {
129			$this->persistent = $persistent;
130			}
131			/**
132			* Set protocol
133			*
134			* @param integer $protocol
135			* @return void
136			*/
137			public function setProtocol(int $protocol) {
138			if (self::PROTOCOL_BOTH_INTERNAL === $protocol) {
139			$protocol = self::PROTOCOL_BOTH;
140			}
141			$this->protocol = $protocol;
142			}
143			/**
144			* Set source interface
145			*
146			* @param string $sourceInterface
147			* @return void
148			*/
149			public function setSourceInterface(string $sourceInterface) {
150			$this->sourceInterface = $sourceInterface;
151			}
152
153			/**
154			* Get the output for create rule
155			*
156			* @return array
157			*/
158			public function getOutput() : array {
159			$fieldsOutput = [
160			'id',
161			'enable',
162			'description',
163			'destinationIPAddress',
164			'externalPort',
165			'internalPort',
166			'origin',
167			'persistent',
168			'protocol',
169			'sourceInterface'
170			];
171			return $this->buildOutput($fieldsOutput);
172			}
173
174			/**
175			* Get the output for delete rule
176			*
177			* @return array
178			*/
179			public function getOutputForDelete() : array {
180			$fieldsOutput = [
181			'id',
182			'destinationIPAddress',
183			'origin'
184			];
185			return $this->buildOutput($fieldsOutput);
186			}
187
188			/**
189			* Build array output from needed fields
190			*
191			* @param array $fieldsOutput
192			* @return array
193			*/
194			protected function buildOutput(array $fieldsOutput) : array {
195			$output = [];
196			foreach ($fieldsOutput as $field) {
197			$method = 'get'.ucfirst($field);
198			$output[$field] = method_exists($this, $method) ? $this->$method() : $this->$field;
199			}
200			return $output;
201			}
202
203			/**
204			* Build object from command output
205			*
206			* @param object $input
207			* @return NatRule
208			*/
209			public static function buildFrom($input) {
210			$natRule = new self();
211			$natRule->setId($input->Id);
212			$natRule->setEnable($input->Enable);
213			$natRule->setDescription($input->Description);
214			$natRule->setDestinationIPAddress($input->DestinationIPAddress);
215			$natRule->setExternalPort((int) $input->ExternalPort);
216			$natRule->setInternalPort((int) $input->InternalPort);
217			$natRule->setOrigin($input->Origin);
218			$natRule->setPersistent((bool) $input->Persistent);
219			$natRule->setProtocol((int) $input->Protocol);
220			$natRule->setSourceInterface($input->SourceInterface);
221			return $natRule;
222			}
223
224			}

devgiants / livebox

Push — master ( 725e32...761ac2 )

NatRule::setDescription() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like