Add option to configure collection on construction

Author: ilijastuden

src/Collection.php

@@ -13,6 +13,21 @@ abstract class Collection implements CollectionInterface
 {
     use EtagInterfaceImplementation;
 
+    /**
+     * Construct the collection instance
+     */
+    public function __construct()
+    {
+        $this->configure();
+    }
+
+    /**
+     * Pre-configure the collection when it is created
+     */
+    protected function configure()
+    {
+    }
+
     /**
      * @var string
      */

src/Collection/Type.php

@@ -33,6 +33,8 @@ public function __construct(ConnectionInterface &$connection, PoolInterface &$po
     {
         $this->connection = $connection;
         $this->pool = $pool;
+
+        parent::__construct();
     }
 
     /**

test/src/Fixtures/Writers/PreconfiguredCollection.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace ActiveCollab\DatabaseObject\Test\Fixtures\Writers;
+
+use ActiveCollab\DatabaseObject\Collection\Type;
+
+/**
+ * @package ActiveCollab\DatabaseObject\Test\Fixtures\Writers
+ */
+class PreconfiguredCollection extends Type
+{
+    /**
+     * Return type that this collection manages
+     *
+     * @return string
+     */
+    public function getType()
+    {
+        return Writer::class;
+    }
+
+    /**
+     * Configure the collection when it is created
+     */
+    protected function configure()
+    {
+        $this->where('`name` LIKE ?', 'A%')->orderBy('`name`');
+    }
+}

test/src/TypePreconfiguredCollectionTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace ActiveCollab\DatabaseObject\Test;
+
+use ActiveCollab\DatabaseObject\Test\Base\WritersTypeTestCase;
+use ActiveCollab\DatabaseObject\Test\Fixtures\Writers\PreconfiguredCollection;
+use ActiveCollab\DatabaseConnection\Result\ResultInterface;
+
+/**
+ * @package ActiveCollab\DatabaseObject\Test
+ */
+class TypePreconfiguredCollectionTest extends WritersTypeTestCase
+{
+    /**
+     * Test if configure() method is called when collection is constructed
+     */
+    public function testCollectionIsPreconfigured()
+    {
+        $collection = new PreconfiguredCollection($this->connection, $this->pool);
+
+        $this->assertEquals("`name` LIKE 'A%'", $collection->getConditions());
+        $this->assertEquals('`name`', $collection->getOrderBy());
+    }
+
+    /**
+     * Test if pre-configured collection works as expected
+     */
+    public function testExecutePreconfiguredCollection()
+    {
+        $writers = (new PreconfiguredCollection($this->connection, $this->pool))->execute();
+
+        $this->assertInstanceOf(ResultInterface::class, $writers);
+        $this->assertCount(1, $writers);
+        $this->assertEquals('Alexander Pushkin', $writers[0]->getName());
+    }
+}