Add support for using a custom Date class

ActiveRecord.php

@@ -10,6 +10,7 @@
 require __DIR__.'/lib/Singleton.php';
 require __DIR__.'/lib/Config.php';
 require __DIR__.'/lib/Utils.php';
+require __DIR__.'/lib/DateTimeLinkedModelInterface.php';
 require __DIR__.'/lib/DateTime.php';
 require __DIR__.'/lib/Model.php';
 require __DIR__.'/lib/Table.php';
@@ -46,4 +47,4 @@ function activerecord_autoload($class_name)
 
 	if (file_exists($file))
 		require_once $file;
-}
+}

lib/Column.php

@@ -165,11 +165,13 @@ public function cast($value, $connection)
 				if (!$value)
 					return null;
 
-				if ($value instanceof DateTime)
+				$date_class = Config::instance()->get_date_class();
+
+				if ($value instanceof $date_class)
 					return $value;
 
 				if ($value instanceof \DateTime)
-					return new DateTime($value->format('Y-m-d H:i:s T'));
+					return $date_class::createFromFormat('Y-m-d H:i:s T', $value->format('Y-m-d H:i:s T'));
 
 				return $connection->string_to_datetime($value);
 		}

lib/Config.php

@@ -72,6 +72,14 @@ class Config extends Singleton
 	 */
 	private $logger;
 
+	/**
+	 * Contains the class name for the Date class to use. Must have a public format() method and a
+	 * public static createFromFormat($format, $time) method
+	 *
+	 * @var string
+	 */
+	private $date_class = 'ActiveRecord\\DateTime';
+
 	/**
 	 * The format to serialize DateTime values into.
 	 *
@@ -262,6 +270,28 @@ public function get_logger()
 		return $this->logger;
 	}
 
+	public function set_date_class($date_class)
+	{
+		try {
+			$klass = Reflections::instance()->add($date_class)->get($date_class);
+		} catch (\ReflectionException $e) {
+			throw new ConfigException("Cannot find date class");
+		}
+
+		if (!$klass->hasMethod('format') || !$klass->getMethod('format')->isPublic())
+			throw new ConfigException('Given date class must have a "public format($format = null)" method');
+
+		if (!$klass->hasMethod('createFromFormat') || !$klass->getMethod('createFromFormat')->isPublic())
+			throw new ConfigException('Given date class must have a "public static createFromFormat($format, $time)" method');
+
+		$this->date_class = $date_class;
+	}
+
+	public function get_date_class()
+	{
+		return $this->date_class;
+	}
+
 	/**
 	 * @deprecated
 	 */
@@ -300,4 +330,4 @@ public function set_cache($url, $options=array())
 	{
 		Cache::initialize($url,$options);
 	}
-}
+}

lib/Connection.php

@@ -469,7 +469,7 @@ public function datetime_to_string($datetime)
 	 * Converts a string representation of a datetime into a DateTime object.
 	 *
 	 * @param string $string A datetime in the form accepted by date_create()
-	 * @return DateTime
+	 * @return object The date_class set in Config
 	 */
 	public function string_to_datetime($string)
 	{
@@ -479,7 +479,8 @@ public function string_to_datetime($string)
 		if ($errors['warning_count'] > 0 || $errors['error_count'] > 0)
 			return null;
 
-		return new DateTime($date->format(static::$datetime_format));
+		$date_class = Config::instance()->get_date_class();
+		return $date_class::createFromFormat(static::$datetime_format, $date->format(static::$datetime_format));
 	}
 
 	/**
@@ -530,4 +531,4 @@ public function accepts_limit_and_order_for_update_and_delete()
 		return false;
 	}
 
-}
+}

lib/DateTime.php

@@ -33,7 +33,7 @@
  * @package ActiveRecord
  * @see http://php.net/manual/en/class.datetime.php
  */
-class DateTime extends \DateTime
+class DateTime extends \DateTime implements DateTimeLinkedModelInterface
 {
 	/**
 	 * Default format used for format() and __toString()
@@ -113,6 +113,21 @@ public static function get_format($format=null)
 		return $format;
 	}
 
+	/**
+	 * This needs to be overriden so it returns an instance of this class instead of PHP's \DateTime.
+	 * See http://php.net/manual/en/datetime.createfromformat.php
+	 */
+	public static function createFromFormat($format, $time, $tz = null)
+	{
+		$phpDate = $tz ? parent::createFromFormat($format, $time, $tz) : parent::createFromFormat($format, $time);
+		if (!$phpDate)
+			return false;
+		// convert to this class using the timestamp
+		$ourDate = new static;
+		$ourDate->setTimestamp($phpDate->getTimestamp());
+		return $ourDate;
+	}
+
 	public function __toString()
 	{
 		return $this->format();
@@ -147,4 +162,4 @@ public function setTimestamp($unixtimestamp)
 		$this->flag_dirty();
 		call_user_func_array(array($this,'parent::setTimestamp'),func_get_args());
 	}
-}
+}

lib/DateTimeLinkedModelInterface.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * @package ActiveRecord
+ */
+namespace ActiveRecord;
+
+/**
+ * Interface for Date classes that can be linked to to a model attribute. This is used by
+ * ActiveRecord\DateTime so it can flag the model as dirty via $model->flag_dirty() when one of its
+ * setters is called.
+ *
+ * @package ActiveRecord
+ * @see http://php.net/manual/en/class.datetime.php
+ */
+interface DateTimeLinkedModelInterface
+{
+	/**
+	 * Indicates this object is an attribute of the specified model, with the given attribute name.
+	 *
+	 * @param Model $model The model this object is an attribute of
+	 * @param string $attribute_name The attribute name 
+	 * @return void
+	 */
+	public function attribute_of($model, $attribute_name);
+}

lib/Model.php

@@ -460,12 +460,15 @@ public function assign_attribute($name, $value)
 		}
 
 		// convert php's \DateTime to ours
-		if (!($value instanceof DateTime) && $value instanceof \DateTime)
-			$value = new DateTime($value->format('Y-m-d H:i:s T'));
+		if (is_object($value) && get_class($value) === 'DateTime') {
+			$date_class = Config::instance()->get_date_class();
+			if ($date_class !== 'DateTime')
+				$value = $date_class::createFromFormat('Y-m-d H:i:s T', $value->format('Y-m-d H:i:s T'));
+		}
 
-		// make sure DateTime values know what model they belong to so
-		// dirty stuff works when calling set methods on the DateTime object
-		if ($value instanceof DateTime)
+		if ($value instanceof DateTimeLinkedModelInterface)
+			// Tell the Date object that it's associated with this model and attribute. This is so it
+			// has the ability to flag this model as dirty if a field in the Date object changes.
 			$value->attribute_of($this,$name);
 
 		$this->attributes[$name] = $value;

lib/Serialization.php

@@ -218,9 +218,10 @@ final protected function options_to_a($key)
 	 */
 	final public function to_a()
 	{
+		$date_class = Config::instance()->get_date_class();
 		foreach ($this->attributes as &$value)
 		{
-			if ($value instanceof \DateTime)
+			if ($value instanceof $date_class)
 				$value = $value->format(self::$DATETIME_FORMAT);
 		}
 		return $this->attributes;
@@ -372,4 +373,4 @@ private function to_csv($arr)
     fclose($outstream);
     return $buffer;
   }
-}
+}

lib/Table.php

@@ -428,9 +428,10 @@ private function &process_data($hash)
 		if (!$hash)
 			return $hash;
 
+		$date_class = Config::instance()->get_date_class();
 		foreach ($hash as $name => &$value)
 		{
-			if ($value instanceof \DateTime)
+			if ($value instanceof $date_class || $value instanceof \DateTime)
 			{
 				if (isset($this->columns[$name]) && $this->columns[$name]->type == Column::DATE)
 					$hash[$name] = $this->conn->date_to_string($value);

test/ActiveRecordTest.php

@@ -526,11 +526,20 @@ public function test_gh245_dirty_attribute_should_not_raise_php_notice_if_not_di
 		$this->assert_true($event->attribute_is_dirty('title'));
 	}
 
-	public function test_assigning_php_datetime_gets_converted_to_ar_datetime()
+	public function test_assigning_php_datetime_gets_converted_to_date_class_with_defaults()
 	{
 		$author = new Author();
 		$author->created_at = $now = new \DateTime();
-		$this->assert_is_a("ActiveRecord\\DateTime",$author->created_at);
+		$this->assert_is_a("ActiveRecord\\DateTime", $author->created_at);
+		$this->assert_datetime_equals($now,$author->created_at);
+	}
+
+	public function test_assigning_php_datetime_gets_converted_to_date_class_with_custom_date_class()
+	{
+		ActiveRecord\Config::instance()->set_date_class('\\DateTime'); // use PHP built-in DateTime
+		$author = new Author();
+		$author->created_at = $now = new \DateTime();
+		$this->assert_is_a("DateTime", $author->created_at);
 		$this->assert_datetime_equals($now,$author->created_at);
 	}
 

test/ConfigTest.php

@@ -8,6 +8,17 @@ class TestLogger
 	private function log() {}
 }
 
+class TestDateTimeWithoutCreateFromFormat
+{
+   public function format($format=null) {}
+}
+
+class TestDateTime
+{
+   public function format($format=null) {}
+   public static function createFromFormat($format, $time) {}
+}
+
 class ConfigTest extends SnakeCase_PHPUnit_Framework_TestCase
 {
 	public function set_up()
@@ -71,6 +82,41 @@ public function test_set_connections_with_default()
 		$this->assert_equals('test',$this->config->get_default_connection());
 	}
 
+	public function test_get_date_class_with_default()
+	{
+		$this->assert_equals('ActiveRecord\\DateTime', $this->config->get_date_class());
+	}
+
+	/**
+	 * @expectedException ActiveRecord\ConfigException
+	 */
+	public function test_set_date_class_when_class_doesnt_exist()
+	{
+		$this->config->set_date_class('doesntexist');
+	}
+
+	/**
+	 * @expectedException ActiveRecord\ConfigException
+	 */
+	public function test_set_date_class_when_class_doesnt_have_format_or_createfromformat()
+	{
+		$this->config->set_date_class('TestLogger');
+	}
+
+	/**
+	 * @expectedException ActiveRecord\ConfigException
+	 */
+	public function test_set_date_class_when_class_doesnt_have_createfromformat()
+	{
+		$this->config->set_date_class('TestDateTimeWithoutCreateFromFormat');
+	}
+
+	public function test_set_date_class_with_valid_class()
+	{
+		$this->config->set_date_class('TestDateTime');
+		$this->assert_equals('TestDateTime', $this->config->get_date_class());
+	}
+
 	public function test_initialize_closure()
 	{
 		$test = $this;

test/DateTimeTest.php

@@ -123,5 +123,23 @@ public function test_to_string()
 	{
 		$this->assert_equals(date(DateTime::get_format()), "" . $this->date);
 	}
+
+	public function test_create_from_format_error_handling()
+	{
+		$d = DateTime::createFromFormat('H:i:s Y-d-m', '!!!');
+		$this->assert_false($d);
+	}
+
+	public function test_create_from_format_without_tz()
+	{
+		$d = DateTime::createFromFormat('H:i:s Y-d-m', '03:04:05 2000-02-01');
+		$this->assert_equals(new DateTime('2000-01-02 03:04:05'), $d);
+	}
+
+	public function test_create_from_format_with_tz()
+	{
+		$d = DateTime::createFromFormat('Y-m-d H:i:s', '2000-02-01 03:04:05', new \DateTimeZone('Etc/GMT-10'));
+		$this->assert_equals(new DateTime('2000-01-31 17:04:05'), $d);
+	}
 }
 ?>

test/helpers/DatabaseTest.php

@@ -14,6 +14,8 @@ public function set_up($connection_name=null)
 		$config = ActiveRecord\Config::instance();
 		$this->original_default_connection = $config->get_default_connection();
 
+		$this->original_date_class = $config->get_date_class();
+
 		if ($connection_name)
 			$config->set_default_connection($connection_name);
 
@@ -42,6 +44,7 @@ public function set_up($connection_name=null)
 
 	public function tear_down()
 	{
+		ActiveRecord\Config::instance()->set_date_class($this->original_date_class);
 		if ($this->original_default_connection)
 			ActiveRecord\Config::instance()->set_default_connection($this->original_default_connection);
 	}

test/helpers/config.php

@@ -82,4 +82,4 @@
 });
 
 error_reporting(E_ALL | E_STRICT);
-?>
+?>