Standard::toArray() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/aimeos..." - aimeos/aimeos-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 24a86a...771b97 )

by Aimeos

created 2018-06-24 08:06 UTC

Standard::toArray() A

↳ Parent: Standard

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2018
 * @package MShop
 * @subpackage Subscription
 */


namespace Aimeos\MShop\Subscription\Item;


/**
 * Default implementation of subscription item
 *
 * @package MShop
 * @subpackage Subscription
 */
class Standard
	extends \Aimeos\MShop\Common\Item\Base

	implements \Aimeos\MShop\Subscription\Item\Iface
{
	private $values;


	/**
	 * Initializes the object with the given values.
	 *
	 * @param array $values Associative list of values from database
	 */
	public function __construct( array $values = [] )
	{
		parent::__construct( 'subscription.', $values );

		$this->values = $values;
	}


	/**
	 * Returns the ID of the base order
	 *
	 * @return string ID of the base order

	 */
	public function getOrderBaseId()
	{
		if( isset( $this->values['subscription.ordbaseid'] ) ) {
			return (string) $this->values['subscription.ordbaseid'];
		}
	}


	/**
	 * Sets the ID of the base order item which the customer bought
	 *
	 * @param string $id ID of the base order
	 * @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
	 */
	public function setOrderBaseId( $id )
	{
		if( (string) $id !== $this->getOrderBaseId() )
		{
			$this->values['subscription.ordbaseid'] = (string) $id;
			$this->setModified();
		}

		return $this;
	}


	/**
	 * Returns the ID of the ordered product
	 *
	 * @return string ID of the ordered product

	 */
	public function getOrderProductId()
	{
		if( isset( $this->values['subscription.ordprodid'] ) ) {
			return (string) $this->values['subscription.ordprodid'];
		}
	}


	/**
	 * Sets the ID of the ordered product item which the customer subscribed for
	 *
	 * @param string $id ID of the ordered product
	 * @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
	 */
	public function setOrderProductId( $id )
	{
		if( (string) $id !== $this->getOrderProductId() )
		{
			$this->values['subscription.ordprodid'] = (string) $id;
			$this->setModified();
		}

		return $this;
	}


	/**
	 * Returns the date of the next subscription renewal
	 *
	 * @return string ISO date in "YYYY-MM-DD HH:mm:ss" format

	 */
	public function getDateNext()
	{
		if( isset( $this->values['subscription.datenext'] ) ) {
			return (string) $this->values['subscription.datenext'];
		}
	}


	/**
	 * Sets the date of the next subscription renewal
	 *
	 * @param string $date ISO date in "YYYY-MM-DD HH:mm:ss" format
	 * @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
	 */
	public function setDateNext( $date )
	{
		if( (string) $date !== $this->getDateNext() )
		{
			$this->values['subscription.datenext'] = $this->checkDateFormat( $date );
			$this->setModified();
		}

		return $this;
	}


	/**
	 * Returns the date when the subscription renewal ends
	 *
	 * @return string|null ISO date in "YYYY-MM-DD HH:mm:ss" format
	 */
	public function getDateEnd()
	{
		if( isset( $this->values['subscription.dateend'] ) ) {
			return (string) $this->values['subscription.dateend'];
		}
	}


	/**
	 * Sets the delivery date of the invoice.
	 *
	 * @param string|null $date ISO date in "YYYY-MM-DD HH:mm:ss" format
	 * @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
	 */
	public function setDateEnd( $date )
	{
		if( (string) $date !== $this->getDateEnd() )
		{
			$this->values['subscription.dateend'] = $this->checkDateFormat( $date );
			$this->setModified();
		}

		return $this;
	}


	/**
	 * Returns the time interval to pass between the subscription renewals
	 *
	 * @return string PHP time interval, e.g. "P1M2W"

	 */
	public function getInterval()
	{
		if( isset( $this->values['subscription.interval'] ) ) {
			return (string) $this->values['subscription.interval'];
		}
	}


	/**
	 * Sets the time interval to pass between the subscription renewals
	 *
	 * @param string $value PHP time interval, e.g. "P1M2W"
	 * @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
	 */
	public function setInterval( $value )
	{
		if( preg_match( '/^P[0-9]+Y[0-9]+M[0-9]+W[0-9]+D$/', $value ) !== 1 ) {
			throw new \Aimeos\MShop\Subscription\Exception( sprintf( 'Invalid time interval format "%1$s"', $value ) );
		}

		if( (string) $value !== $this->getInterval() )
		{
			$this->values['subscription.interval'] = (string) $value;
			$this->setModified();
		}

		return $this;
	}


	/**
	 * Returns the status of the subscriptions
	 *
	 * @return integer Subscription status, i.e. "1" for enabled, "0" for disabled

	 */
	public function getStatus()
	{
		if( isset( $this->values['subscription.status'] ) ) {
			return (int) $this->values['subscription.status'];
		}
	}


	/**
	 * Sets the status of the subscriptions
	 *
	 * @return integer Subscription status, i.e. "1" for enabled, "0" for disabled
	 * @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls

	 */
	public function setStatus( $status )
	{
		if( (string) $status !== $this->getStatus() )
		{
			$this->values['subscription.status'] = (int) $status;
			$this->setModified();
		}

		return $this;
	}


	/**
	 * Returns the item type
	 *
	 * @return string Item type, subtypes are separated by slashes
	 */
	public function getResourceType()
	{
		return 'subscription';
	}


	/**
	 * Sets the item values from the given array.
	 *
	 * @param array $list Associative list of item keys and their values
	 * @return array Associative list of keys and their values that are unknown
	 */
	public function fromArray( array $list )
	{
		$unknown = [];
		$list = parent::fromArray( $list );

		foreach( $list as $key => $value )
		{
			switch( $key )
			{
				case 'subscription.ordbaseid': $this->setOrderBaseId( $value ); break;
				case 'subscription.ordprodid': $this->setOrderProductId( $value ); break;
				case 'subscription.datenext': $this->setDateNext( $value ); break;
				case 'subscription.dateend': $this->setDateEnd( $value ); break;
				case 'subscription.interval': $this->setInterval( $value ); break;
				case 'subscription.status': $this->setStatus( $value ); break;
				default: $unknown[$key] = $value;
switch ($expr) {
    default:
        doSomething(); //right
        break;
}


switch ($expr) {
    default:

        doSomething(); //wrong
        break;
}
			}
		}

		return $unknown;
	}


	/**
	 * Returns the item values as associative list.
	 *
	 * @param boolean True to return private properties, false for public only
	 * @return array Associative list of item properties and their values
	 */
	public function toArray( $private = false )
	{
		$list = parent::toArray( $private );

		$list['subscription.ordbaseid'] = $this->getOrderBaseId();
		$list['subscription.ordprodid'] = $this->getOrderProductId();
		$list['subscription.datenext'] = $this->getDateNext();
		$list['subscription.dateend'] = $this->getDateEnd();
		$list['subscription.interval'] = $this->getInterval();
		$list['subscription.status'] = $this->getStatus();

		return $list;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2018
6			* @package MShop
7			* @subpackage Subscription
8			*/
9
10
11			namespace Aimeos\MShop\Subscription\Item;
12
13
14			/**
15			* Default implementation of subscription item
16			*
17			* @package MShop
18			* @subpackage Subscription
19			*/
20			class Standard
21			extends \Aimeos\MShop\Common\Item\Base
			0 ignored issues – show Coding Style introduced 2016-02-05 10:43 UTC by Report Bug Copy Issue Report Expected 0 spaces between "Base" and comma; 1 found Loading history...
22			implements \Aimeos\MShop\Subscription\Item\Iface
23			{
24			private $values;
25
26
27			/**
28			* Initializes the object with the given values.
29			*
30			* @param array $values Associative list of values from database
31			*/
32			public function __construct( array $values = [] )
33			{
34			parent::__construct( 'subscription.', $values );
35
36			$this->values = $values;
37			}
38
39
40			/**
41			* Returns the ID of the base order
42			*
43			* @return string ID of the base order
			0 ignored issues – show Documentation introduced 2018-03-01 13:19 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
44			*/
45			public function getOrderBaseId()
46			{
47			if( isset( $this->values['subscription.ordbaseid'] ) ) {
48			return (string) $this->values['subscription.ordbaseid'];
49			}
50			}
51
52
53			/**
54			* Sets the ID of the base order item which the customer bought
55			*
56			* @param string $id ID of the base order
57			* @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
58			*/
59			public function setOrderBaseId( $id )
60			{
61			if( (string) $id !== $this->getOrderBaseId() )
62			{
63			$this->values['subscription.ordbaseid'] = (string) $id;
64			$this->setModified();
65			}
66
67			return $this;
68			}
69
70
71			/**
72			* Returns the ID of the ordered product
73			*
74			* @return string ID of the ordered product
			0 ignored issues – show Documentation introduced 2015-11-24 10:49 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
75			*/
76			public function getOrderProductId()
77			{
78			if( isset( $this->values['subscription.ordprodid'] ) ) {
79			return (string) $this->values['subscription.ordprodid'];
80			}
81			}
82
83
84			/**
85			* Sets the ID of the ordered product item which the customer subscribed for
86			*
87			* @param string $id ID of the ordered product
88			* @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
89			*/
90			public function setOrderProductId( $id )
91			{
92			if( (string) $id !== $this->getOrderProductId() )
93			{
94			$this->values['subscription.ordprodid'] = (string) $id;
95			$this->setModified();
96			}
97
98			return $this;
99			}
100
101
102			/**
103			* Returns the date of the next subscription renewal
104			*
105			* @return string ISO date in "YYYY-MM-DD HH:mm:ss" format
			0 ignored issues – show Documentation introduced 2015-11-24 10:49 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
106			*/
107			public function getDateNext()
108			{
109			if( isset( $this->values['subscription.datenext'] ) ) {
110			return (string) $this->values['subscription.datenext'];
111			}
112			}
113
114
115			/**
116			* Sets the date of the next subscription renewal
117			*
118			* @param string $date ISO date in "YYYY-MM-DD HH:mm:ss" format
119			* @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
120			*/
121			public function setDateNext( $date )
122			{
123			if( (string) $date !== $this->getDateNext() )
124			{
125			$this->values['subscription.datenext'] = $this->checkDateFormat( $date );
126			$this->setModified();
127			}
128
129			return $this;
130			}
131
132
133			/**
134			* Returns the date when the subscription renewal ends
135			*
136			* @return string\|null ISO date in "YYYY-MM-DD HH:mm:ss" format
137			*/
138			public function getDateEnd()
139			{
140			if( isset( $this->values['subscription.dateend'] ) ) {
141			return (string) $this->values['subscription.dateend'];
142			}
143			}
144
145
146			/**
147			* Sets the delivery date of the invoice.
148			*
149			* @param string\|null $date ISO date in "YYYY-MM-DD HH:mm:ss" format
150			* @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
151			*/
152			public function setDateEnd( $date )
153			{
154			if( (string) $date !== $this->getDateEnd() )
155			{
156			$this->values['subscription.dateend'] = $this->checkDateFormat( $date );
157			$this->setModified();
158			}
159
160			return $this;
161			}
162
163
164			/**
165			* Returns the time interval to pass between the subscription renewals
166			*
167			* @return string PHP time interval, e.g. "P1M2W"
			0 ignored issues – show Documentation introduced 2018-02-03 17:43 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
168			*/
169			public function getInterval()
170			{
171			if( isset( $this->values['subscription.interval'] ) ) {
172			return (string) $this->values['subscription.interval'];
173			}
174			}
175
176
177			/**
178			* Sets the time interval to pass between the subscription renewals
179			*
180			* @param string $value PHP time interval, e.g. "P1M2W"
181			* @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
182			*/
183			public function setInterval( $value )
184			{
185			if( preg_match( '/^P[0-9]+Y[0-9]+M[0-9]+W[0-9]+D$/', $value ) !== 1 ) {
186			throw new \Aimeos\MShop\Subscription\Exception( sprintf( 'Invalid time interval format "%1$s"', $value ) );
187			}
188
189			if( (string) $value !== $this->getInterval() )
190			{
191			$this->values['subscription.interval'] = (string) $value;
192			$this->setModified();
193			}
194
195			return $this;
196			}
197
198
199			/**
200			* Returns the status of the subscriptions
201			*
202			* @return integer Subscription status, i.e. "1" for enabled, "0" for disabled
			0 ignored issues – show Documentation introduced 2018-02-03 17:43 UTC by Report Bug Copy Issue Report Should the return type not be `integer\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
203			*/
204			public function getStatus()
205			{
206			if( isset( $this->values['subscription.status'] ) ) {
207			return (int) $this->values['subscription.status'];
208			}
209			}
210
211
212			/**
213			* Sets the status of the subscriptions
214			*
215			* @return integer Subscription status, i.e. "1" for enabled, "0" for disabled
216			* @return \Aimeos\MShop\Subscription\Item\Iface Subscription item for chaining method calls
			0 ignored issues – show Documentation introduced 2018-02-03 17:43 UTC by Report Bug Copy Issue Report Should the return type not be `Standard`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
217			*/
218			public function setStatus( $status )
219			{
220			if( (string) $status !== $this->getStatus() )
221			{
222			$this->values['subscription.status'] = (int) $status;
223			$this->setModified();
224			}
225
226			return $this;
227			}
228
229
230			/**
231			* Returns the item type
232			*
233			* @return string Item type, subtypes are separated by slashes
234			*/
235			public function getResourceType()
236			{
237			return 'subscription';
238			}
239
240
241			/**
242			* Sets the item values from the given array.
243			*
244			* @param array $list Associative list of item keys and their values
245			* @return array Associative list of keys and their values that are unknown
246			*/
247			public function fromArray( array $list )
248			{
249			$unknown = [];
250			$list = parent::fromArray( $list );
251
252			foreach( $list as $key => $value )
253			{
254			switch( $key )
255			{
256			case 'subscription.ordbaseid': $this->setOrderBaseId( $value ); break;
257			case 'subscription.ordprodid': $this->setOrderProductId( $value ); break;
258			case 'subscription.datenext': $this->setDateNext( $value ); break;
259			case 'subscription.dateend': $this->setDateEnd( $value ); break;
260			case 'subscription.interval': $this->setInterval( $value ); break;
261			case 'subscription.status': $this->setStatus( $value ); break;
262			default: $unknown[$key] = $value;
			0 ignored issues – show Coding Style introduced 2016-02-26 18:19 UTC by Report Bug Copy Issue Report The default body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a default statement must start on the line immediately following the statement. switch ($expr) { default: doSomething(); //right break; } switch ($expr) { default: doSomething(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
263			}
264			}
265
266			return $unknown;
267			}
268
269
270			/**
271			* Returns the item values as associative list.
272			*
273			* @param boolean True to return private properties, false for public only
274			* @return array Associative list of item properties and their values
275			*/
276			public function toArray( $private = false )
277			{
278			$list = parent::toArray( $private );
279
280			$list['subscription.ordbaseid'] = $this->getOrderBaseId();
281			$list['subscription.ordprodid'] = $this->getOrderProductId();
282			$list['subscription.datenext'] = $this->getDateNext();
283			$list['subscription.dateend'] = $this->getDateEnd();
284			$list['subscription.interval'] = $this->getInterval();
285			$list['subscription.status'] = $this->getStatus();
286
287			return $list;
288			}
289			}
290

aimeos / aimeos-core

Push — master ( 24a86a...771b97 )

Standard::toArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like