miBadger\ActiveRecord\Traits\Datefields

Complexity

Total Complexity

5

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	initDatefields()	0	24	1
A	DatefieldsCreateHook()	0	6	1
A	DatefieldsUpdateHook()	0	4	1
A	getLastModifiedDate()	0	4	1
A	getCreationDate()	0	4	1

<?php

namespace miBadger\ActiveRecord\Traits;

use miBadger\Query\Query;
use miBadger\ActiveRecord\ColumnProperty;

const TRAIT_DATEFIELDS_LAST_MODIFIED = "last_modified";
const TRAIT_DATEFIELDS_CREATED = "created";

trait Datefields
{
	/** @var string The timestamp representing the moment this record was created */
	protected $created;

	/** @var string The timestamp representing the moment this record was last updated */
	protected $lastModified;

	/**
	 * this method is required to be called in the constructor for each class that uses this trait. 
	 * It adds the datefields to the table definition and registers the callback hooks
	 */
	protected function initDatefields()
	{
		$this->extendTableDefinition(TRAIT_DATEFIELDS_CREATED, [

It seems like extendTableDefinition() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			'value' => &$this->created,
			'validate' => null,
			'type' => 'DATETIME',
			'default' => 'CURRENT_TIMESTAMP',
			'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
		]);

		$this->extendTableDefinition(TRAIT_DATEFIELDS_LAST_MODIFIED, [

It seems like extendTableDefinition() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			'value' => &$this->lastModified,
			'validate' => null,
			'type' => 'DATETIME',
			'default' => 'CURRENT_TIMESTAMP',
			'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
		]);
		
		$this->registerUpdateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsUpdateHook');

It seems like registerUpdateHook() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		$this->registerCreateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsCreateHook');

It seems like registerCreateHook() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		$this->created = null;
		$this->lastModified = null;
	}

	/**
	 * The hook that gets called to set the timestamp whenever a new record is created
	 */
	protected function DatefieldsCreateHook()
	{
		// @TODO: Should this be split up to seperate hooks for "last_modified" and "created" for consistency?
		$this->created = (new \DateTime('now'))->format('Y-m-d H:i:s');
		$this->lastModified = (new \DateTime('now'))->format('Y-m-d H:i:s');
	}

	/**
	 * The hook that gets called to set the timestamp whenever a record gets updated
	 */
	protected function DatefieldsUpdateHook()
	{
		$this->lastModified = (new \DateTime('now'))->format('Y-m-d H:i:s');
	}

	/**
	 * Returns the timestamp of last update for this record
	 * @return DateTime

Should the return type not be \DateTime?

	 */
	public function getLastModifiedDate()
	{
		return new \DateTime($this->lastModified);
	}

	/**
	 * Returns the timestamp of when this record was created
	 * @return DateTime

Should the return type not be \DateTime?

	 */
	public function getCreationDate()
	{
		return new \DateTime($this->created);
	}
}