WMDE\Fundraising\Entities\Subscription

Complexity

Total Complexity

25

Size/Duplication

Total Lines	235
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

24.19%

Importance

Changes	3
Bugs	0	Features	0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	setFullName()	0	5	1
A	setExport()	0	5	1
A	getBackup()	0	3	1
A	getAddress()	0	3	1
A	getFullName()	0	3	1
A	setEmail()	0	5	1
A	getEmail()	0	3	1
A	getExport()	0	3	1
A	setBackup()	0	5	1
A	setStatus()	0	5	1
A	getStatus()	0	3	1
A	setConfirmationCode()	0	5	1
A	getConfirmationCode()	0	3	1
A	getId()	0	3	1
A	setAddress()	0	3	1
A	getCreatedAt()	0	3	1
A	setCreatedAt()	0	4	1
A	getTracking()	0	3	1
A	setTracking()	0	3	1
A	setSource()	0	5	1
A	getSource()	0	3	1
A	markAsConfirmed()	0	3	1
A	markForModeration()	0	3	1
A	isUnconfirmed()	0	3	1
A	needsModeration()	0	3	1

<?php

declare( strict_types = 1 );

namespace WMDE\Fundraising\Entities;

use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;

/**
 * @since 2.0
 *
 * @ORM\Table( name="subscription" )
 * @ORM\Entity
 */
class Subscription {

	/**
	 * @var string
	 *
	 * @ORM\Column(name="full_name", type="string", length=250, options={"default":""}, nullable=false)
	 */
	private $fullName = '';

	/**
	 * @var string
	 *
	 * @ORM\Column(name="email", type="string", length=250, options={"default":""}, nullable=false)
	 */
	private $email = '';

	/**
	 * @var \DateTime|null
	 *
	 * @ORM\Column(name="export", type="datetime", nullable=true)
	 */
	private $export;

	/**
	 * @var \DateTime|null
	 *
	 * @ORM\Column(name="backup", type="datetime", nullable=true)
	 */
	private $backup;

	/**
	 * @var integer
	 *
	 * @ORM\Column(name="status", type="smallint", options={"default":0}, nullable=true)
	 */
	private $status = 0;

	/**
	 * @var string
	 *
	 * @ORM\Column(name="confirmationCode", type="string", length=32, nullable=true)
	 */
	private $confirmationCode;

	/**
	 * @var integer
	 *
	 * @ORM\Column(name="id", type="integer")
	 * @ORM\Id
	 * @ORM\GeneratedValue(strategy="IDENTITY")
	 */
	private $id;

	/**
	 * @ORM\ManyToOne(targetEntity="Address")
	 * @ORM\JoinColumn(name="address_id", referencedColumnName="id")
	 */
	private $address;

	/**
	 * @var string
	 *
	 * @ORM\Column(name="tracking", type="string", length=50, nullable=true)
	 */
	private $tracking;

	/**
	 * @var string
	 *
	 * @ORM\Column(name="source", type="string", length=50, nullable=true)
	 */
	private $source;

	/**
	 * @var \DateTime
	 * @Gedmo\Timestampable(on="create")
	 * @ORM\Column(type="datetime")
	 */
	private $createdAt;

	// TODO: replace by private constants once using PHP 7.1+
	private $STATUS_NEW = 0;
	private $STATUS_CONFIRMED = 1;
	private $STATUS_MODERATION = 2;

	public function setFullName( string $fullName ): self {
		$this->fullName = $fullName;

		return $this;
	}

	public function getFullName(): string {
		return $this->fullName;
	}

	public function setEmail( string $email ): self {
		$this->email = $email;

		return $this;
	}

	public function getEmail(): string {
		return $this->email;
	}

	public function setExport( \DateTime $export = null ): self {
		$this->export = $export;

		return $this;
	}

	/**
	 * @return \DateTime|null
	 */
	public function getExport() {
		return $this->export;
	}

	public function setBackup( \DateTime $backup = null ): self {
		$this->backup = $backup;

		return $this;
	}

	/**
	 * @return \DateTime|null
	 */
	public function getBackup() {
		return $this->backup;
	}

	/**
	 * Usage of this method is discouraged, it's only for initialization with Doctrine.
	 * 
	 * @see Subscription::markAsConfirmed()
 	 * @see Subscription::markForModeration()
	 * @param int $status
	 * @return Subscription
	 */
	public function setStatus( int $status ): self {
		$this->status = $status;

		return $this;
	}

	/**
	 * Usage of this method is discouraged. Try using something like @see isUnconfirmed
	 *
	 * @return int
	 */
	public function getStatus(): int {
		return $this->status;
	}

	public function setConfirmationCode( string $confirmationCode ): self {
		$this->confirmationCode = $confirmationCode;

		return $this;
	}

	public function getConfirmationCode(): string {
		return $this->confirmationCode;
	}

	public function getId(): int {
		return $this->id;
	}

	public function getAddress(): Address {
		return $this->address;
	}

	public function setAddress( Address $address ) {
		$this->address = $address;
	}

	public function getCreatedAt(): \DateTime {
		return $this->createdAt;
	}

	public function setCreatedAt( \DateTime $createdAt ): self {
		$this->createdAt = $createdAt;
		return $this;
	}

	public function getTracking(): string {
		return $this->tracking;
	}

	public function setTracking( string $tracking ) {
		$this->tracking = $tracking;
	}

	/**
	 * @since 3.0
	 */
	public function setSource( string $source ): self {
		$this->source = $source;

		return $this;
	}

	/**
	 * @since 3.0
	 */
	public function getSource(): string {
		return $this->source;
	}

	/**
	 * @since 3.0
	 */
	public function markAsConfirmed() {
		$this->status = $this->STATUS_CONFIRMED;
	}

	/**
	 * @since 3.0
	 */
	public function markForModeration() {
		$this->status = $this->STATUS_MODERATION;
	}

	public function isUnconfirmed(): bool {
		return $this->status !== $this->STATUS_CONFIRMED;
	}

	/**
	 * @since 3.0
	 */
	public function needsModeration(): bool {
		return $this->status === $this->STATUS_MODERATION;
	}

}