Kohana_Jam_Field_Timestamp

Complexity

Total Complexity

30

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

96.43%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	5
B	get()	0	22	11
C	convert()	0	34	14

<?php defined('SYSPATH') OR die('No direct script access.');
/**
 * Handles timestamps and conversions to and from different formats
 *
 * All timestamps are represented internally by UNIX timestamps, regardless
 * of their format in the database. When the model is saved, the value is
 * converted back to the format specified by $format (which is a valid
 * date() string).
 *
 * This means that you can have timestamp logic exist relatively independently
 * of your database's format. If, one day, you wish to change the format used
 * to represent dates in the database, you just have to update the $format
 * property for the field.
 *
 * @package    Jam
 * @category   Fields
 * @author     Jonathan Geiger
 * @copyright  (c) 2010-2011 Jonathan Geiger
 * @license    http://www.opensource.org/licenses/isc-license.txt
 */
abstract class Kohana_Jam_Field_Timestamp extends Jam_Field {

	/**
	 * @var  int  default is NULL, which implies no date
	 */
	public $default = NULL;

	/**
	 * @var  boolean  whether or not to automatically set now() on creation
	 */
	public $auto_now_create = FALSE;

	/**
	 * @var  boolean  whether or not to automatically set now() on update
	 */
	public $auto_now_update = FALSE;

	/**
	 * @var  string  a date formula representing the time in the database
	 */
	public $format = NULL;

	/**
	 * Jam_Timezone object for manipulating timezones
	 * @var Jam_Timezone
	 */
	public $timezone = NULL;

	/**
	 * Convert empty values by default because some DB's
	 * will convert empty strings to zero timestamps
	 */
	public $convert_empty = TRUE;

	/**
	 * Sets the default to 0 if we have no format, or an empty string otherwise.
	 *
	 * @param  array  $options
	 */
	public function __construct($options = array())
	{
		parent::__construct($options);

		if ( ! isset($options['default']) AND ! $this->allow_null)
		{
			// Having a implies saving we're format a string, so we want a proper default
			$this->default = $this->format ? '' : 0;

It seems like $this->format ? '' : 0 can also be of type string. However, the property $default is declared as type integer. Maybe add an additional type check?

		}

		if ($this->timezone === NULL)
		{
			$this->timezone = Jam_Timezone::instance();
		}
	}


	public function get(Jam_Validated $model, $value, $is_loaded)
	{
		if ($this->timezone !== FALSE AND $this->timezone->is_active() AND ! $is_loaded)
		{
			if ( ! is_numeric($value) AND FALSE !== strtotime($value))
			{
				$value = strtotime($value);
			}

			if (is_numeric($value) AND $value AND $this->timezone !== FALSE)
			{
				$value = $this->timezone->convert($value, Jam_Timezone::MASTER_TIMEZONE, Jam_Timezone::USER_TIMEZONE);
			}

			if ($this->format AND is_numeric($value))
			{
				$value = date($this->format, $value);
			}
		}

		return $value;
	}

	/**
	 * Automatically creates or updates the time and
	 * converts it, if necessary.
	 *
	 * @param   Jam_Model  $model
	 * @param   mixed        $value
	 * @param   boolean      $is_loaded
	 * @return  int|string
	 */
	public function convert(Jam_Validated $model, $value, $is_loaded)
	{
		// Do we need to provide a default since we're creating or updating
		if ((empty($value) AND ! $is_loaded AND $this->auto_now_create) OR ($is_loaded AND $this->auto_now_update))
		{
			$value = ($this->timezone !== FALSE) ? $this->timezone->time() : time();
		}
		else
		{
			// Convert to UNIX timestamp
			if (is_numeric($value))
			{
				$value = (int) $value;
			}
			elseif (FALSE !== ($to_time = strtotime($value)))
			{
				$value = $to_time;
			}

			if (is_numeric($value) AND $value AND $this->timezone !== FALSE)
			{
				$value = $this->timezone->convert($value, Jam_Timezone::USER_TIMEZONE, Jam_Timezone::MASTER_TIMEZONE);
			}
		}

		// Convert if necessary
		if ($this->format AND is_numeric($value))
		{
			$value = date($this->format, $value);
		}


		return $value;
	}

} // End Kohana_Jam_Field_Timestamp