Moved TableGateway class into Application namespace

crm/scripts/solr/generateTicketClusters.php

@@ -5,7 +5,7 @@
  */
 use Application\Models\Ticket;
 use Application\Models\GeoCluster;
-use Blossom\Classes\Database;
+use Application\Database;
 
 include '../../bootstrap.inc';
 

crm/scripts/solr/indexSearch.php

@@ -5,7 +5,7 @@
  */
 use Application\Models\Search;
 use Application\Models\Ticket;
-use Blossom\Classes\Database;
+use Application\Database;
 
 include '../../bootstrap.inc';
 $search = new Search();

crm/src/Application/Models/ActionTable.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class ActionTable extends TableGateway

crm/src/Application/Models/AddressTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class AddressTable extends TableGateway

crm/src/Application/Models/Bookmark.php

@@ -48,7 +48,9 @@ public function __construct($id=null)
 		else {
 			// This is where the code goes to generate a new, empty instance.
 			// Set any default values for properties that need it here
-			$this->setPerson_id($_SESSION['USER']->getId());
+			if (isset($_SESSION['USER'])) {
+                $this->setPerson_id($_SESSION['USER']->getId());
+            }
 		}
 	}
 

crm/src/Application/Models/BookmarkTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class BookmarkTable extends TableGateway

crm/src/Application/Models/CategoryGroupTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class CategoryGroupTable extends TableGateway

crm/src/Application/Models/CategoryTable.php

@@ -7,7 +7,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class CategoryTable extends TableGateway

crm/src/Application/Models/ClientTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class ClientTable extends TableGateway

crm/src/Application/Models/ContactMethodTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class ContactMethodTable extends TableGateway

crm/src/Application/Models/DepartmentTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class DepartmentTable extends TableGateway

crm/src/Application/Models/EmailTable.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class EmailTable extends TableGateway

crm/src/Application/Models/IssueTypeTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class IssueTypeTable extends TableGateway

crm/src/Application/Models/MediaTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class MediaTable extends TableGateway

crm/src/Application/Models/PersonTable.php

@@ -5,7 +5,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 use Zend\Db\Sql\Where;
 

crm/src/Application/Models/PhoneTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class PhoneTable extends TableGateway

crm/src/Application/Models/ResponseTemplateTable.php

@@ -5,10 +5,10 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class ResponseTemplateTable extends TableGateway
 {
 	public function __construct() { parent::__construct('category_action_responses', __namespace__.'\ResponseTemplate'); }
-}
+}

crm/src/Application/Models/SubstatusTable.php

@@ -6,7 +6,7 @@
  */
 namespace Application\Models;
 
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class SubstatusTable extends TableGateway

crm/src/Application/Models/TicketTable.php

@@ -6,7 +6,7 @@
 namespace Application\Models;
 
 use Blossom\Classes\ActiveRecord;
-use Blossom\Classes\TableGateway;
+use Application\TableGateway;
 use Zend\Db\Sql\Select;
 
 class TicketTable extends TableGateway

crm/src/Application/TableGateway.php

@@ -0,0 +1,123 @@
+<?php
+/**
+ * A base class that streamlines creation of ZF2 TableGateway
+ *
+ * @copyright 2014-2019 City of Bloomington, Indiana
+ * @license http://www.gnu.org/licenses/agpl.txt GNU/AGPL, see LICENSE
+ */
+namespace Application;
+
+use Zend\Db\TableGateway\TableGateway as ZendTableGateway;
+use Zend\Db\ResultSet\ResultSet;
+use Zend\Db\Sql\Select;
+use Zend\Paginator\Adapter\DbSelect;
+use Zend\Paginator\Paginator;
+
+abstract class TableGateway
+{
+	protected $resultSetPrototype;
+	protected $tableGateway;
+
+	/**
+	 * @param string $table The name of the database table
+	 * @param string $class The class model to use as a resultSetPrototype
+	 *
+	 * You must pass in the fully namespaced classname.  We do not assume
+	 * any particular namespace for the models.
+	 */
+	public function __construct($table, $class)
+	{
+		$this->resultSetPrototype = new ResultSet();
+		$this->resultSetPrototype->setArrayObjectPrototype(new $class());
+		$this->tableGateway = new ZendTableGateway(
+			$table,
+			Database::getConnection(),
+			null,
+			$this->resultSetPrototype
+		);
+	}
+
+	/**
+	 * Simple, default implementation for find
+	 *
+	 * This will allow you to do queries for rows in the table,
+	 * where you provide field=>values for the where clause.
+	 * Only fields actually in the table can be included this way.
+	 *
+	 * You generally want to override this implementation with your own
+	 * However, this basic implementation will allow you to get up and
+	 * running quicker.
+	 *
+	 * @param array $fields Key value pairs to select on
+	 * @param string $order The default ordering to use for select
+	 * @param boolean $paginated If set to true, will return a paginator
+	 * @param int $limit
+	 */
+	public function find($fields=null, $order=null, $paginated=false, $limit=null)
+	{
+		$select = new Select($this->tableGateway->getTable());
+		if ($fields) {
+			foreach ($fields as $key=>$value) {
+                if (isset($this->columns)) {
+                    if (in_array($key, $this->columns)) {
+                        $select->where([$key=>$value]);
+                    }
+                }
+                else {
+                    $select->where([$key=>$value]);
+                }
+			}
+		}
+		return $this->performSelect($select, $order, $paginated, $limit);
+	}
+
+	/**
+	 * @param Zend\Db\Sql\Select $select
+	 * @return Zend\Db\ResultSet
+	 */
+	public function performSelect(Select $select, $order, $paginated=false, $limit=null)
+	{
+		if ($order) { $select->order($order); }
+		if ($limit) { $select->limit($limit); }
+
+		if ($paginated) {
+			$adapter = new DbSelect($select, $this->tableGateway->getAdapter(), $this->resultSetPrototype);
+			$paginator = new Paginator($adapter);
+			return $paginator;
+		}
+		else {
+			return $this->tableGateway->selectWith($select);
+		}
+	}
+
+	/**
+	 * @param Zend\Db\ResultSet
+	 * @return array
+	 */
+	public static function hydrateResults(ResultSet $results)
+	{
+        $output = [];
+        foreach ($results as $object) {
+            $output[] = $object;
+        }
+        return $output;
+	}
+
+	/**
+	 * Returns the generated sql
+	 *
+	 * @param Zend\Db\Sql\Select
+	 */
+	public function getSqlForSelect(Select $select)
+	{
+		return $select->getSqlString($this->tableGateway->getAdapter()->getPlatform());
+	}
+
+	/**
+	 * @param Zend\Db\ResultSet
+	 */
+	public static function getSqlForResult(ResultSet $result)
+	{
+		return $result->getDataSource()->getResource()->queryString;
+	}
+}

crm/src/Test/Integration/ModelTest.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * @copyright 2019 City of Bloomington, Indiana
+ * @license https://www.gnu.org/licenses/agpl.txt GNU/AGPL, see LICENSE
+ */
+declare (strict_types=1);
+namespace Test\Integration;
+
+use PHPUnit\Framework\TestCase;
+
+class ModelTest extends TestCase
+{
+    public function classProvider()
+    {
+        $classes = [];
+        foreach (glob(APPLICATION_HOME.'/src/Application/Models/*Table.php') as $f) {
+            preg_match('/(^.*)\.([^\.]+)$/', $f, $matches);
+            $file      = basename($matches[1]);
+            $classes[] = ["Application\Models\\".basename($matches[1])];
+        }
+        return $classes;
+    }
+
+    /**
+     * @dataProvider classProvider
+     */
+    public function testTableClasses(string $class)
+    {
+        $o = new $class();
+        $this->assertEquals($class, get_class($o));
+    }
+}