Aimeos\MShop\Subscription\Item\Standard

Complexity

Total Complexity

36

Size/Duplication

Total Lines	270
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getOrderBaseId()	0	6	2
A	setOrderBaseId()	0	10	2
A	getOrderProductId()	0	6	2
A	setOrderProductId()	0	10	2
A	getDateNext()	0	6	2
A	setDateNext()	0	10	2
A	getDateEnd()	0	6	2
A	setDateEnd()	0	10	2
A	getInterval()	0	6	2
A	setInterval()	0	14	3
A	getStatus()	0	6	2
A	setStatus()	0	10	2
A	getResourceType()	0	4	1
B	fromArray()	0	21	8
A	toArray()	0	13	1

<?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

Expected 0 spaces between "Base" and comma; 1 found

	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

Should the return type not be string|null?

	 */
	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

Should the return type not be string|null?

	 */
	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

Should the return type not be string|null?

	 */
	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"

Should the return type not be string|null?

	 */
	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

Should the return type not be integer|null?

	 */
	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

Should the return type not be Standard?

	 */
	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;

The default body in a switch statement must start on the line following the statement.

			}
		}

		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;
	}
}