miBadger / miBadger.ActiveRecord

src/AbstractActiveRecord.php

Doc Comments +12 added lines, -1 removed lines

@@ -216,7 +216,7 @@ 
 	 * @param array $orderBy = []
 	 * @param int $limit = -1
 	 * @param int $offset = 0
-	 * @return Query the search query result with the given where, order by, limit and offset clauses.
+	 * @return \miBadger\Query\QueryResult the search query result with the given where, order by, limit and offset clauses.
 	 */
 	private function getSearchQueryResult(array $where = [], array $orderBy = [], $limit = -1, $offset = 0)
 	{
@@ -230,6 +230,9 @@ 
 		return $query->execute();
 	}
 
+	/**
+	 * @param Query $query
+	 */
 	private function getSearchQueryWhere($query, $where)
 	{
 		foreach ($where as $key => $value) {
@@ -239,6 +242,9 @@ 
 		return $query;
 	}
 
+	/**
+	 * @param Query $query
+	 */
 	private function getSearchQueryOrderBy($query, $orderBy)
 	{
 		foreach ($orderBy as $key => $value) {
@@ -248,6 +254,11 @@ 
 		return $query;
 	}
 
+	/**
+	 * @param Query $query
+	 * @param integer $limit
+	 * @param integer $offset
+	 */
 	private function getSearchQueryLimit($query, $limit, $offset)
 	{
 		if ($limit > -1) {

Indentation +298 added lines, -298 removed lines

@@ -19,302 +19,302 @@
  */
 abstract class AbstractActiveRecord implements ActiveRecordInterface
 {
-	/** @var \PDO The PDO object. */
-	private $pdo;
-
-	/** @var null|int The ID. */
-	private $id;
-
-	/**
-	 * Construct an abstract pdo active record with the given pdo.
-	 *
-	 * @param \PDO $pdo
-	 */
-	public function __construct(\PDO $pdo)
-	{
-		$pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
-		$pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
-
-		$this->setPdo($pdo);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function create()
-	{
-		try {
-			$queryResult = (new Query($this->getPdo(), $this->getActiveRecordTable()))
-				->insert($this->getActiveRecordColumns())
-				->execute();
-
-			$this->setId(intval($this->getPdo()->lastInsertId()));
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function read($id)
-	{
-		try {
-			$result = (new Query($this->getPdo(), $this->getActiveRecordTable()))
-				->select()
-				->where('id', '=', $id)
-				->execute()
-				->fetch();
-
-			if ($result === false) {
-				throw new ActiveRecordException(sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getActiveRecordTable()));
-			}
-
-			$this->fill($result);
-			$this->setId($id);
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function update()
-	{
-		if (!$this->exists()) {
-			throw new ActiveRecordException(sprintf('Can not update a non-existent active record entry to the `%s` table.', $this->getActiveRecordTable()));
-		}
-
-		try {
-			$queryResult = (new Query($this->getPdo(), $this->getActiveRecordTable()))
-				->update($this->getActiveRecordColumns())
-				->where('id', '=', $this->getId())
-				->execute();
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function delete()
-	{
-		if (!$this->exists()) {
-			throw new ActiveRecordException(sprintf('Can not delete a non-existent active record entry from the `%s` table.', $this->getActiveRecordTable()));
-		}
-
-		try {
-			$queryResult = (new Query($this->getPdo(), $this->getActiveRecordTable()))
-				->delete()
-				->where('id', '=', $this->getId())
-				->execute();
-
-			$this->setId(null);
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function sync()
-	{
-		if (!$this->exists()) {
-			return $this->create();
-		}
-
-		return $this->update();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function exists()
-	{
-		return $this->getId() !== null;
-	}
-
-	/**
-	 * Fill the active record
-	 *
-	 * @param array $fetch
-	 * @return null
-	 */
-	public function fill(array $fetch)
-	{
-		$data = $this->getActiveRecordColumns();
-
-		foreach ($data as $key => &$value) {
-			if (!array_key_exists($key, $fetch)) {
-				throw new ActiveRecordException(sprintf('Can not read the expected column `%s`. It\'s not returnd by the `%s` table', $key, $this->getActiveRecordTable()));
-			}
-
-			$value = $fetch[$key];
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function searchOne(array $where = [], array $orderBy = [])
-	{
-		try {
-			$result = $this->getSearchQueryResult($where, $orderBy, 1)->fetch();
-
-			if ($result === false) {
-				throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->getActiveRecordTable()));
-			}
-
-			$this->fill($result);
-			$this->setId(intval($result['id']));
-
-			return $this;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function search(array $where = [], array $orderBy = [], $limit = -1, $offset = 0)
-	{
-		try {
-			$queryResult = $this->getSearchQueryResult($where, $orderBy, $limit, $offset);
-			$result = [];
-
-			foreach ($queryResult as $fetch) {
-				$new = new static($this->getPdo());
-
-				$new->setId(intval($fetch['id']));
-				$new->fill($fetch);
-
-				$result[] = $new;
-			}
-
-			return $result;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-	/**
-	 * Returns the search query result with the given where, order by, limit and offset clauses.
-	 *
-	 * @param array $where = []
-	 * @param array $orderBy = []
-	 * @param int $limit = -1
-	 * @param int $offset = 0
-	 * @return Query the search query result with the given where, order by, limit and offset clauses.
-	 */
-	private function getSearchQueryResult(array $where = [], array $orderBy = [], $limit = -1, $offset = 0)
-	{
-		$query = (new Query($this->getPdo(), $this->getActiveRecordTable()))
-			->select();
-
-		$this->getSearchQueryWhere($query, $where);
-		$this->getSearchQueryOrderBy($query, $orderBy);
-		$this->getSearchQueryLimit($query, $limit, $offset);
-
-		return $query->execute();
-	}
-
-	private function getSearchQueryWhere($query, $where)
-	{
-		foreach ($where as $key => $value) {
-			$query->where($value[0], $value[1], $value[2]);
-		}
-
-		return $query;
-	}
-
-	private function getSearchQueryOrderBy($query, $orderBy)
-	{
-		foreach ($orderBy as $key => $value) {
-			$query->orderBy($key, $value);
-		}
-
-		return $query;
-	}
-
-	private function getSearchQueryLimit($query, $limit, $offset)
-	{
-		if ($limit > -1) {
-			$query->limit($limit);
-			$query->offset($offset);
-		}
-
-		return $query;
-	}
-
-	/**
-	 * Returns the PDO.
-	 *
-	 * @return \PDO the PDO.
-	 */
-	public function getPdo()
-	{
-		return $this->pdo;
-	}
-
-	/**
-	 * Set the PDO.
-	 *
-	 * @param \PDO $pdo
-	 * @return $this
-	 */
-	protected function setPdo($pdo)
-	{
-		$this->pdo = $pdo;
-
-		return $this;
-	}
-
-	/**
-	 * Returns the ID.
-	 *
-	 * @return null|int The ID.
-	 */
-	public function getId()
-	{
-		return $this->id;
-	}
-
-	/**
-	 * Set the ID.
-	 *
-	 * @param int $id
-	 * @return $this
-	 */
-	protected function setId($id)
-	{
-		$this->id = $id;
-
-		return $this;
-	}
-
-	/**
-	 * Returns the active record table.
-	 *
-	 * @return string the active record table.
-	 */
-	abstract protected function getActiveRecordTable();
-
-	/**
-	 * Returns the active record columns.
-	 *
-	 * @return array the active record columns.
-	 */
-	abstract protected function getActiveRecordColumns();
+    /** @var \PDO The PDO object. */
+    private $pdo;
+
+    /** @var null|int The ID. */
+    private $id;
+
+    /**
+     * Construct an abstract pdo active record with the given pdo.
+     *
+     * @param \PDO $pdo
+     */
+    public function __construct(\PDO $pdo)
+    {
+        $pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
+        $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
+
+        $this->setPdo($pdo);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create()
+    {
+        try {
+            $queryResult = (new Query($this->getPdo(), $this->getActiveRecordTable()))
+                ->insert($this->getActiveRecordColumns())
+                ->execute();
+
+            $this->setId(intval($this->getPdo()->lastInsertId()));
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($id)
+    {
+        try {
+            $result = (new Query($this->getPdo(), $this->getActiveRecordTable()))
+                ->select()
+                ->where('id', '=', $id)
+                ->execute()
+                ->fetch();
+
+            if ($result === false) {
+                throw new ActiveRecordException(sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getActiveRecordTable()));
+            }
+
+            $this->fill($result);
+            $this->setId($id);
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function update()
+    {
+        if (!$this->exists()) {
+            throw new ActiveRecordException(sprintf('Can not update a non-existent active record entry to the `%s` table.', $this->getActiveRecordTable()));
+        }
+
+        try {
+            $queryResult = (new Query($this->getPdo(), $this->getActiveRecordTable()))
+                ->update($this->getActiveRecordColumns())
+                ->where('id', '=', $this->getId())
+                ->execute();
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete()
+    {
+        if (!$this->exists()) {
+            throw new ActiveRecordException(sprintf('Can not delete a non-existent active record entry from the `%s` table.', $this->getActiveRecordTable()));
+        }
+
+        try {
+            $queryResult = (new Query($this->getPdo(), $this->getActiveRecordTable()))
+                ->delete()
+                ->where('id', '=', $this->getId())
+                ->execute();
+
+            $this->setId(null);
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sync()
+    {
+        if (!$this->exists()) {
+            return $this->create();
+        }
+
+        return $this->update();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function exists()
+    {
+        return $this->getId() !== null;
+    }
+
+    /**
+     * Fill the active record
+     *
+     * @param array $fetch
+     * @return null
+     */
+    public function fill(array $fetch)
+    {
+        $data = $this->getActiveRecordColumns();
+
+        foreach ($data as $key => &$value) {
+            if (!array_key_exists($key, $fetch)) {
+                throw new ActiveRecordException(sprintf('Can not read the expected column `%s`. It\'s not returnd by the `%s` table', $key, $this->getActiveRecordTable()));
+            }
+
+            $value = $fetch[$key];
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function searchOne(array $where = [], array $orderBy = [])
+    {
+        try {
+            $result = $this->getSearchQueryResult($where, $orderBy, 1)->fetch();
+
+            if ($result === false) {
+                throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->getActiveRecordTable()));
+            }
+
+            $this->fill($result);
+            $this->setId(intval($result['id']));
+
+            return $this;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function search(array $where = [], array $orderBy = [], $limit = -1, $offset = 0)
+    {
+        try {
+            $queryResult = $this->getSearchQueryResult($where, $orderBy, $limit, $offset);
+            $result = [];
+
+            foreach ($queryResult as $fetch) {
+                $new = new static($this->getPdo());
+
+                $new->setId(intval($fetch['id']));
+                $new->fill($fetch);
+
+                $result[] = $new;
+            }
+
+            return $result;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+    /**
+     * Returns the search query result with the given where, order by, limit and offset clauses.
+     *
+     * @param array $where = []
+     * @param array $orderBy = []
+     * @param int $limit = -1
+     * @param int $offset = 0
+     * @return Query the search query result with the given where, order by, limit and offset clauses.
+     */
+    private function getSearchQueryResult(array $where = [], array $orderBy = [], $limit = -1, $offset = 0)
+    {
+        $query = (new Query($this->getPdo(), $this->getActiveRecordTable()))
+            ->select();
+
+        $this->getSearchQueryWhere($query, $where);
+        $this->getSearchQueryOrderBy($query, $orderBy);
+        $this->getSearchQueryLimit($query, $limit, $offset);
+
+        return $query->execute();
+    }
+
+    private function getSearchQueryWhere($query, $where)
+    {
+        foreach ($where as $key => $value) {
+            $query->where($value[0], $value[1], $value[2]);
+        }
+
+        return $query;
+    }
+
+    private function getSearchQueryOrderBy($query, $orderBy)
+    {
+        foreach ($orderBy as $key => $value) {
+            $query->orderBy($key, $value);
+        }
+
+        return $query;
+    }
+
+    private function getSearchQueryLimit($query, $limit, $offset)
+    {
+        if ($limit > -1) {
+            $query->limit($limit);
+            $query->offset($offset);
+        }
+
+        return $query;
+    }
+
+    /**
+     * Returns the PDO.
+     *
+     * @return \PDO the PDO.
+     */
+    public function getPdo()
+    {
+        return $this->pdo;
+    }
+
+    /**
+     * Set the PDO.
+     *
+     * @param \PDO $pdo
+     * @return $this
+     */
+    protected function setPdo($pdo)
+    {
+        $this->pdo = $pdo;
+
+        return $this;
+    }
+
+    /**
+     * Returns the ID.
+     *
+     * @return null|int The ID.
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * Set the ID.
+     *
+     * @param int $id
+     * @return $this
+     */
+    protected function setId($id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    /**
+     * Returns the active record table.
+     *
+     * @return string the active record table.
+     */
+    abstract protected function getActiveRecordTable();
+
+    /**
+     * Returns the active record columns.
+     *
+     * @return array the active record columns.
+     */
+    abstract protected function getActiveRecordColumns();
 }

src/ActiveRecordInterface.php

Indentation +71 added lines, -71 removed lines

@@ -19,83 +19,83 @@
  */
 interface ActiveRecordInterface
 {
-	/**
-	 * Returns this active record after creating an entry with the records attributes.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function create();
+    /**
+     * Returns this active record after creating an entry with the records attributes.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function create();
 
-	/**
-	 * Returns this active record after reading the attributes from the entry with the given identifier.
-	 *
-	 * @param mixed $id
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function read($id);
+    /**
+     * Returns this active record after reading the attributes from the entry with the given identifier.
+     *
+     * @param mixed $id
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function read($id);
 
-	/**
-	 * Returns this active record after updating the attributes to the corresponding entry.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function update();
+    /**
+     * Returns this active record after updating the attributes to the corresponding entry.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function update();
 
-	/**
-	 * Returns this record after deleting the corresponding entry.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function delete();
+    /**
+     * Returns this record after deleting the corresponding entry.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function delete();
 
-	/**
-	 * Returns this record after synchronizing it with the corresponding entry.
-	 * A new entry is created if this active record does not have a corresponding entry.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function sync();
+    /**
+     * Returns this record after synchronizing it with the corresponding entry.
+     * A new entry is created if this active record does not have a corresponding entry.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function sync();
 
-	/**
-	 * Returns true if this active record has a corresponding entry.
-	 *
-	 * @return bool true if this active record has a corresponding entry.
-	 */
-	public function exists();
+    /**
+     * Returns true if this active record has a corresponding entry.
+     *
+     * @return bool true if this active record has a corresponding entry.
+     */
+    public function exists();
 
-	/**
-	 * Returns this record after filling it with the given attributes.
-	 *
-	 * @param array $attributes = []
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function fill(array $attributes);
+    /**
+     * Returns this record after filling it with the given attributes.
+     *
+     * @param array $attributes = []
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function fill(array $attributes);
 
-	/**
-	 * Returns this record after filling it with the attributes of the first entry with the given where and order by clauses.
-	 *
-	 * @param array $where = []
-	 * @param array $orderBy = []
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function searchOne(array $where = [], array $orderBy = []);
+    /**
+     * Returns this record after filling it with the attributes of the first entry with the given where and order by clauses.
+     *
+     * @param array $where = []
+     * @param array $orderBy = []
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function searchOne(array $where = [], array $orderBy = []);
 
-	/**
-	 * Returns the records with the given where, order by, limit and offset clauses.
-	 *
-	 * @param array $where = []
-	 * @param array $orderBy = []
-	 * @param int $limit = -1
-	 * @param int $offset = 0
-	 * @return static[] the records with the given where, order by, limit and offset clauses.
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function search(array $where = [], array $orderBy = [], $limit = -1, $offset = 0);
+    /**
+     * Returns the records with the given where, order by, limit and offset clauses.
+     *
+     * @param array $where = []
+     * @param array $orderBy = []
+     * @param int $limit = -1
+     * @param int $offset = 0
+     * @return static[] the records with the given where, order by, limit and offset clauses.
+     * @throws ActiveRecordException on failure.
+     */
+    public function search(array $where = [], array $orderBy = [], $limit = -1, $offset = 0);
 }