Add the interface for all entities

Author: na2axl

src/LightQL/Entities/IEntity.php

@@ -0,0 +1,73 @@
+<?php
+
+/**
+ * LightQL - The lightweight PHP ORM
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * @category  Library
+ * @package   LightQL
+ * @author    Axel Nana <ax.lnana@outlook.com>
+ * @copyright 2018 Aliens Group, Inc.
+ * @license   MIT <https://github.com/ElementaryFramework/LightQL/blob/master/LICENSE>
+ * @version   GIT: 0.0.1
+ * @link      http://lightql.na2axl.tk
+ */
+
+namespace ElementaryFramework\LightQL\Entities;
+
+/**
+ * IEntity
+ *
+ * Provides default methods for all entities.
+ *
+ * @abstract
+ * @category Interfaces
+ * @package  LightQL
+ * @author   Nana Axel <ax.lnana@outlook.com>
+ * @link     http://lightql.na2axl.tk/docs/api/LightQL/Entities/IDatabaseEntity
+ */
+interface IEntity
+{
+
+    /**
+     * Populates data in the entity.
+     *
+     * @param array $data The raw database data.
+     */
+    function hydrate(array $data);
+
+    /**
+     * Gets the raw value of a table column.
+     *
+     * @param string $column The table column name.
+     *
+     * @return mixed
+     */
+    function get(string $column);
+
+    /**
+     * Sets the raw value of a table column.
+     *
+     * @param string $column The table column name.
+     * @param mixed  $value  The table column value.
+     */
+    function set(string $column, $value);
+
+}