Waca\DataObjects\EmailTemplate

Complexity

Total Complexity

31

Size/Duplication

Total Lines	306
Duplicated Lines	12.09 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	6
Bugs	1	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
B	getAllActiveTemplates()	0	26	4
A	getByName()	0	15	2
A	getDroppedTemplate()	0	9	1
B	save()	0	59	5
A	delete()	0	4	1
A	getName()	0	4	1
A	setName()	0	4	1
A	getText()	0	4	1
A	setText()	0	4	1
A	getJsquestion()	0	4	1
A	setJsquestion()	0	4	1
A	getDefaultAction()	0	4	1
A	setDefaultAction()	0	4	1
A	getActive()	0	4	1
A	setActive()	0	4	2
A	getPreloadOnly()	0	4	1
A	setPreloadOnly()	0	4	2
A	getActiveTemplates()	23	23	2
A	getAllInactiveTemplates()	14	14	2

<?php
namespace Waca\DataObjects;

use Exception;
use PDO;
use Waca\DataObject;
use Waca\Exceptions\OptimisticLockFailedException;
use Waca\PdoDatabase;

/**
 * Email template data object
 *
 * This is the close reasons thing.
 */
class EmailTemplate extends DataObject
{
	const CREATED = "created";
	const NOT_CREATED = "not created";
	const NONE = null;
	private $name;
	private $text;
	/** @var string|null */
	private $jsquestion;
	private $active = 1;
	private $preloadonly = 0;
	private $defaultaction = self::NOT_CREATED;

	/**
	 * Gets active non-preload templates
	 *
	 * @param string      $defaultAction Default action to take (EmailTemplate::CREATED or EmailTemplate::NOT_CREATED)
	 * @param PdoDatabase $database
	 *
	 * @return array|false
	 */
	public static function getActiveTemplates($defaultAction, PdoDatabase $database)

This method seems to be duplicated in your project.

	{
		global $createdid;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		$statement = $database->prepare(<<<SQL
SELECT * FROM `emailtemplate`
WHERE defaultaction = :forcreated AND active = 1 AND preloadonly = 0 AND id != :createdid;
SQL
		);
		$statement->bindValue(":createdid", $createdid);
		$statement->bindValue(":forcreated", $defaultAction);

		$statement->execute();

		$resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());

		/** @var EmailTemplate $t */
		foreach ($resultObject as $t) {
			$t->setDatabase($database);
		}

		return $resultObject;
	}

	/**
	 * Gets active non-preload and preload templates, optionally filtered by the default action.
	 *
	 * @param null|bool|string $defaultAction Default action to take (EmailTemplate::CREATED,
	 *                                        EmailTemplate::NOT_CREATED, or EmailTemplate::NONE), or optionally null to
	 *                                        just get everything.
	 * @param PdoDatabase      $database
	 *
	 * @return array|false
	 */
	public static function getAllActiveTemplates($defaultAction, PdoDatabase $database)
	{
		$statement = $database->prepare("SELECT * FROM `emailtemplate` WHERE defaultaction = :forcreated AND active = 1;");

		if ($defaultAction === false) {
			$statement = $database->prepare(
				"SELECT * FROM `emailtemplate` WHERE defaultaction NOT IN ('created', 'not created') AND active = 1;");
		}

		if ($defaultAction === null) {
			$statement = $database->prepare("SELECT * FROM `emailtemplate` WHERE  active = 1;");
		}

		$statement->bindValue(":forcreated", $defaultAction);

		$statement->execute();

		$resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());

		/** @var EmailTemplate $t */
		foreach ($resultObject as $t) {
			$t->setDatabase($database);
		}

		return $resultObject;
	}

	/**
	 * Gets all the unactive templates
	 *
	 * @param PdoDatabase $database
	 *
	 * @return array
	 */
	public static function getAllInactiveTemplates(PdoDatabase $database)

This method seems to be duplicated in your project.

	{
		$statement = $database->prepare("SELECT * FROM `emailtemplate` WHERE  active = 0;");
		$statement->execute();

		$resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());

		/** @var EmailTemplate $t */
		foreach ($resultObject as $t) {
			$t->setDatabase($database);
		}

		return $resultObject;
	}

	/**
	 * @param string      $name
	 * @param PdoDatabase $database
	 *
	 * @return EmailTemplate|false
	 */
	public static function getByName($name, PdoDatabase $database)
	{
		$statement = $database->prepare("SELECT * FROM `emailtemplate` WHERE name = :name LIMIT 1;");
		$statement->bindValue(":name", $name);

		$statement->execute();

		$resultObject = $statement->fetchObject(get_called_class());

		if ($resultObject != false) {
			$resultObject->setDatabase($database);
		}

		return $resultObject;
	}

	/**
	 * @return EmailTemplate
	 */
	public static function getDroppedTemplate()
	{
		$t = new EmailTemplate();
		$t->id = 0;
		$t->active = 1;
		$t->name = 'Dropped';

		return $t;
	}

	/**
	 * @throws Exception
	 */
	public function save()
	{
		if ($this->isNew()) {
			// insert
			$statement = $this->dbObject->prepare(<<<SQL
INSERT INTO `emailtemplate` (name, text, jsquestion, defaultaction, active, preloadonly)
VALUES (:name, :text, :jsquestion, :defaultaction, :active, :preloadonly);
SQL
			);
			$statement->bindValue(":name", $this->name);
			$statement->bindValue(":text", $this->text);
			$statement->bindValue(":jsquestion", $this->jsquestion);
			$statement->bindValue(":defaultaction", $this->defaultaction);
			$statement->bindValue(":active", $this->active);
			$statement->bindValue(":preloadonly", $this->preloadonly);

			if ($statement->execute()) {
				$this->id = $this->dbObject->lastInsertId();

The property $id was declared of type integer, but $this->dbObject->lastInsertId() is of type string. Maybe add a type cast?

			}
			else {
				throw new Exception($statement->errorInfo());
			}
		}
		else {
			// update
			$statement = $this->dbObject->prepare(<<<SQL
UPDATE `emailtemplate`
SET name = :name,
	text = :text,
	jsquestion = :jsquestion,
	defaultaction = :defaultaction,
	active = :active,
	preloadonly = :preloadonly,
	updateversion = updateversion + 1
WHERE id = :id AND updateversion = :updateversion
LIMIT 1;
SQL
			);
			$statement->bindValue(':id', $this->id);
			$statement->bindValue(':updateversion', $this->updateversion);

			$statement->bindValue(':name', $this->name);
			$statement->bindValue(":text", $this->text);
			$statement->bindValue(":jsquestion", $this->jsquestion);
			$statement->bindValue(":defaultaction", $this->defaultaction);
			$statement->bindValue(":active", $this->active);
			$statement->bindValue(":preloadonly", $this->preloadonly);

			if (!$statement->execute()) {
				throw new Exception($statement->errorInfo());
			}

			if ($statement->rowCount() !== 1) {
				throw new OptimisticLockFailedException();
			}

			$this->updateversion++;
		}
	}

	/**
	 * Override delete() from DataObject
	 */
	public function delete()
	{
		throw new Exception("You shouldn't be doing that, you'll break logs.");
	}

	/**
	 * @return string
	 */
	public function getName()
	{
		return $this->name;
	}

	/**
	 * @param string $name
	 */
	public function setName($name)
	{
		$this->name = $name;
	}

	/**
	 * @return string
	 */
	public function getText()
	{
		return $this->text;
	}

	/**
	 * @param string $text
	 */
	public function setText($text)
	{
		$this->text = $text;
	}

	/**
	 * @return string|null
	 */
	public function getJsquestion()
	{
		return $this->jsquestion;
	}

	/**
	 * @param string $jsquestion
	 */
	public function setJsquestion($jsquestion)
	{
		$this->jsquestion = $jsquestion;
	}

	/**
	 * @return string
	 */
	public function getDefaultAction()
	{
		return $this->defaultaction;
	}

	/**
	 * @param string $defaultAction
	 */
	public function setDefaultAction($defaultAction)
	{
		$this->defaultaction = $defaultAction;
	}

	/**
	 * @return bool
	 */
	public function getActive()
	{
		return $this->active == 1;
	}

	/**
	 * @param bool $active
	 */
	public function setActive($active)
	{
		$this->active = $active ? 1 : 0;
	}

	/**
	 * @return bool
	 */
	public function getPreloadOnly()
	{
		return $this->preloadonly == 1;
	}

	/**
	 * @param bool $preloadonly
	 */
	public function setPreloadOnly($preloadonly)
	{
		$this->preloadonly = $preloadonly ? 1 : 0;
	}
}