1 files changed, 143 insertions, 0 deletions
diff --git a/vendor/ipl/orm/src/Model.php b/vendor/ipl/orm/src/Model.php
new file mode 100644
index 0000000..44baff7
--- /dev/null
+++ b/vendor/ipl/orm/src/Model.php
@@ -0,0 +1,143 @@
+<?php
+
+namespace ipl\Orm;
+
+use ipl\Orm\Common\PropertiesWithDefaults;
+use ipl\Sql\Connection;
+use ipl\Sql\ExpressionInterface;
+
+/**
+ * Models represent single database tables or parts of it.
+ * They are also used to interact with the tables, i.e. in order to query for data.
+ */
+abstract class Model implements \ArrayAccess, \IteratorAggregate
+{
+    use PropertiesWithDefaults;
+
+    final public function __construct(array $properties = null)
+    {
+        if ($this->hasProperties()) {
+            $this->setProperties($properties);
+        }
+
+        $this->init();
+    }
+
+    /**
+     * Get the related database table's name
+     *
+     * @return string
+     */
+    abstract public function getTableName();
+
+    /**
+     * Get the column name(s) of the primary key
+     *
+     * @return string|array<string> Array if the primary key is compound, string otherwise
+     */
+    abstract public function getKeyName();
+
+    /**
+     * Get the model's queryable columns
+     *
+     * @return array<int|string, string|ExpressionInterface>
+     */
+    abstract public function getColumns();
+
+    /**
+     * Get the configured table alias. (Default {@see static::getTableName()})
+     *
+     * @return string
+     */
+    public function getTableAlias(): string
+    {
+        return $this->getTableName();
+    }
+
+    /**
+     * Get the model's column definitions
+     *
+     * The array is indexed by column names, values are either strings (labels) or arrays of this format:
+     *
+     * [
+     *  'label' => 'A Column',
+     *  'type'  => 'enum(y,n)'
+     * ]
+     *
+     * @return array
+     */
+    public function getColumnDefinitions()
+    {
+        return [];
+    }
+
+    /**
+     * Get a query which is tied to this model and the given database connection
+     *
+     * @param Connection $db
+     *
+     * @return Query
+     */
+    public static function on(Connection $db)
+    {
+        return (new Query())
+            ->setDb($db)
+            ->setModel(new static());
+    }
+
+    /**
+     * Get the model's default sort
+     *
+     * @return array|string
+     */
+    public function getDefaultSort()
+    {
+        return [];
+    }
+
+    /**
+     * Get the model's search columns
+     *
+     * @return array
+     */
+    public function getSearchColumns()
+    {
+        return [];
+    }
+
+    /**
+     * Create the model's behaviors
+     *
+     * @param Behaviors $behaviors
+     */
+    public function createBehaviors(Behaviors $behaviors)
+    {
+    }
+
+    /**
+     * Create the model's defaults
+     *
+     * @param Defaults $defaults
+     */
+    public function createDefaults(Defaults $defaults)
+    {
+    }
+
+    /**
+     * Create the model's relations
+     *
+     * If your model should be associated to other models, override this method and create the model's relations.
+     */
+    public function createRelations(Relations $relations)
+    {
+    }
+
+    /**
+     * Initialize the model
+     *
+     * If you want to adjust the model after construction, override this method.
+     */
+    protected function init()
+    {
+    }
+}