Moved ActiveRecord class into Application namespace

crm/blocks/html/reports/activity.inc

@@ -4,7 +4,7 @@
  * @license http://www.gnu.org/licenses/agpl.txt GNU/AGPL, see LICENSE.txt
  */
 use Application\Models\Report;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Blossom\Classes\View;
 
 $h = $this->template->getHelper('formatDuration');

crm/blocks/html/reports/searchForm.inc

@@ -10,7 +10,7 @@ use Application\Models\DepartmentTable;
 use Application\Models\ClientTable;
 use Application\Models\Search;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 
 $this->template->addToAsset('scripts', JQUERY.'/jquery.min.js');
 $this->template->addToAsset('scripts', BASE_URI.'/js/collapsible.js');

crm/blocks/html/tickets/searchForm.inc

@@ -9,7 +9,7 @@ use Application\Models\Person;
 use Application\Models\Search;
 use Application\Models\TicketTable;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Blossom\Classes\Block;
 use Blossom\Classes\Url;
 

crm/src/Application/ActiveRecord.php

@@ -0,0 +1,235 @@
+<?php
+/**
+ * @copyright 2011-2016 City of Bloomington, Indiana
+ * @license http://www.gnu.org/licenses/agpl.txt GNU/AGPL, see LICENSE
+ */
+namespace Application;
+use Zend\Db\Sql\Sql;
+
+abstract class ActiveRecord
+{
+	protected $tablename;
+	protected $data = array();
+
+	const MYSQL_DATE_FORMAT     = 'Y-m-d';
+	const MYSQL_TIME_FORMAT     = 'H:i:s';
+	const MYSQL_DATETIME_FORMAT = 'Y-m-d H:i:s';
+
+	abstract public function validate();
+
+	/**
+	 * Callback from TableGateway
+	 */
+	public function exchangeArray($data)
+	{
+		$this->data = $data;
+	}
+
+	/**
+	 * Writes the database back to the database
+	 */
+	protected function save()
+	{
+		$this->validate();
+		$zend_db = Database::getConnection();
+		$sql = new Sql($zend_db, $this->tablename);
+		if ($this->getId()) {
+			$update = $sql->update()
+				->set($this->data)
+				->where(array('id'=>$this->getId()));
+			$sql->prepareStatementForSqlObject($update)->execute();
+		}
+		else {
+			$insert = $sql->insert()->values($this->data);
+			$sql->prepareStatementForSqlObject($insert)->execute();
+			$this->data['id'] = $zend_db->getDriver()->getLastGeneratedValue();
+		}
+	}
+
+	/**
+	 * Removes this record from the database
+	 */
+	protected function delete()
+	{
+		if ($this->getId()) {
+			$sql = new Sql(Database::getConnection(), $this->tablename);
+			$delete = $sql->delete()->where(['id'=>$this->getId()]);
+			$sql->prepareStatementForSqlObject($delete)->execute();
+		}
+	}
+
+	/**
+	 * Returns any field stored in $data
+	 *
+	 * @param string $fieldname
+	 */
+	protected function get($fieldname)
+	{
+		if (isset($this->data[$fieldname])) {
+			return $this->data[$fieldname];
+		}
+	}
+
+	/**
+	 * @param string $fieldname
+	 * @param string $value
+	 */
+	protected function set($fieldname, $value)
+	{
+		$value = trim($value);
+		$this->data[$fieldname] = $value ? $value : null;
+	}
+
+	/**
+	 * Returns the date/time in the desired format
+	 *
+	 * Format is specified using PHP's date() syntax
+	 * http://www.php.net/manual/en/function.date.php
+	 * If no format is given, the database's raw data is returned
+	 *
+	 * @param string $field
+	 * @param string $format
+	 * @param DateTimeZone $timezone
+	 * @return string
+	 */
+	protected function getDateData($dateField, $format=null, \DateTimeZone $timezone=null)
+	{
+		if (isset($this->data[$dateField])) {
+			if ($format) {
+				$date = new \DateTime($this->data[$dateField]);
+				if ($timezone) { $date->setTimezone($timezone); }
+				return $date->format($format);
+			}
+			else {
+				return $this->data[$dateField];
+			}
+		}
+	}
+
+	/**
+	 * Sets a date
+	 *
+	 * Dates should be in DATETIME_FORMAT, set in configuration.inc
+	 * If we cannot parse the string using DATETIME_FORMAT, we will
+	 * fall back to trying something strtotime() understands
+	 * http://www.php.net/manual/en/function.strtotime.php
+	 *
+	 * @param string $dateField
+	 * @param string $date
+	 * @param string $format
+	 * @param string $databaseFormat
+	 */
+	protected function setDateData($dateField, $date, $format=DATETIME_FORMAT, $databaseFormat=self::MYSQL_DATETIME_FORMAT)
+	{
+		$date = trim($date);
+		if ($date) {
+            try {
+                $d = self::parseDate($date, $format);
+                $this->data[$dateField] = $d->format($databaseFormat);
+            }
+            catch (\Exception $e) {
+                $class = strtolower((new \ReflectionClass($this))->getShortName());
+                throw new \Exception("$class/$dateField/invalidDate");
+            }
+		}
+		else {
+			$this->data[$dateField] = null;
+		}
+	}
+
+	/**
+	 * Return a DateTime object for a date string
+	 *
+	 * Dates should be in $format.
+	 * If we cannot parse the string using $format, we will
+	 * fall back to trying something strtotime() understands
+	 * http://www.php.net/manual/en/function.strtotime.php
+	 *
+	 * @param string $date
+	 * @param string $format
+	 * @throws Exception
+	 * @return DateTime
+	 */
+	public static function parseDate($date, $format=DATETIME_FORMAT)
+	{
+        $d = \DateTime::createFromFormat($format, $date);
+        if (!$d) {
+            $d = new \DateTime($date);
+        }
+        return $d;
+	}
+
+	/**
+	 * Loads and returns an object for a foreign key _id field
+	 *
+	 * Will cache the object in a protected variable to avoid multiple database
+	 * lookups. Make sure to declare a protected variable matching the class
+	 *
+	 * @param string $class Fully namespaced classname
+	 * @param string $field
+	 */
+	protected function getForeignKeyObject($class, $field)
+	{
+		$var = preg_replace('/_id$/', '', $field);
+		if (!$this->$var && isset($this->data[$field])) {
+			$this->$var = new $class($this->data[$field]);
+		}
+		return $this->$var;
+	}
+
+	/**
+	 * Verifies and saves the ID for a foreign key field
+	 *
+	 * Loads the object record for the foreign key and caches
+	 * the object in a private variable
+	 *
+	 * @param string $class Fully namespaced classname
+	 * @param string $field Name of field to set
+	 * @param string $id The value to set
+	 */
+	protected function setForeignKeyField($class, $field, $id)
+	{
+		$id = trim($id);
+		$var = preg_replace('/_id$/', '', $field);
+		if ($id) {
+			$this->$var = new $class($id);
+			$this->data[$field] = $this->$var->getId();
+		}
+		else {
+			$this->$field = null;
+			$this->data[$field] = null;
+		}
+	}
+
+	/**
+	 * Verifies and saves the ID for a foreign key object
+	 *
+	 * Caches the object in a private variable and sets
+	 * the ID value in the data
+	 *
+	 * @param string $class Fully namespaced classname
+	 * @param string $field Name of field to set
+	 * @param Object $object Value to set
+	 */
+	protected function setForeignKeyObject($class, $field, $object)
+	{
+		if ($object instanceof $class) {
+			$var = preg_replace('/_id$/', '', $field);
+			$this->data[$field] = $object->getId();
+			$this->$var = $object;
+		}
+		else {
+			throw new \Exception('Object does not match the given class');
+		}
+	}
+
+	/**
+	 * Returns whether the value can be an ID for a record
+	 *
+	 * return @bool
+	 */
+	public static function isId($id)
+	{
+		return ((is_int($id) && $id>0) || (is_string($id) && ctype_digit($id)));
+	}
+}

crm/src/Application/Models/Action.php

@@ -4,7 +4,7 @@
  * @license http://www.gnu.org/licenses/agpl.txt GNU/AGPL, see LICENSE.txt
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Action extends ActiveRecord

crm/src/Application/Models/Address.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Address extends ActiveRecord

crm/src/Application/Models/Bookmark.php

@@ -7,7 +7,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Bookmark extends ActiveRecord

crm/src/Application/Models/Category.php

@@ -4,7 +4,7 @@
  * @license http://www.gnu.org/licenses/agpl.txt GNU/AGPL, see LICENSE.txt
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Category extends ActiveRecord

crm/src/Application/Models/CategoryGroup.php

@@ -5,7 +5,7 @@
  * @author Cliff Ingham <inghamn@bloomington.in.gov>
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class CategoryGroup extends ActiveRecord

crm/src/Application/Models/Client.php

@@ -7,7 +7,7 @@
  * @author Cliff Ingham <inghamn@bloomington.in.gov>
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Client extends ActiveRecord

crm/src/Application/Models/ContactMethod.php

@@ -5,7 +5,7 @@
  * @author Cliff Ingham <inghamn@bloomington.in.gov>
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class ContactMethod extends ActiveRecord

crm/src/Application/Models/Department.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Department extends ActiveRecord

crm/src/Application/Models/Email.php

@@ -5,7 +5,7 @@
  * @author Cliff Ingham <inghamn@bloomington.in.gov>
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Email extends ActiveRecord

crm/src/Application/Models/GeoCluster.php

@@ -5,7 +5,7 @@
  * @author Cliff Ingham <inghamn@bloomington.in.gov>
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 use Zend\Db\Sql\Sql;
 

crm/src/Application/Models/Image.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Image extends Media

crm/src/Application/Models/IssueType.php

@@ -5,7 +5,7 @@
  * @author Cliff Ingham <inghamn@bloomington.in.gov>
  */
 namespace Application\Models;
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class IssueType extends ActiveRecord

crm/src/Application/Models/Media.php

@@ -10,7 +10,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Media extends ActiveRecord

crm/src/Application/Models/Metrics.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 
 class Metrics

crm/src/Application/Models/Person.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\ActiveRecord;
+use Application\ActiveRecord;
 use Application\Database;
 use Blossom\Classes\ExternalIdentity;