Elchroy\PotatoORM\PotatoModel

Complexity

Total Complexity

18

Size/Duplication

Total Lines	170
Duplicated Lines	8.82 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	16
Bugs	6	Features	6

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	__set()	0	4	1
A	__get()	0	8	2
A	__isset()	0	4	1
A	getAll()	0	7	2
A	find()	7	7	2
A	save()	0	4	2
A	isStored()	0	4	1
A	insert()	0	6	1
A	update()	0	6	1
A	destroy()	8	8	2
A	getClassTableName()	0	7	1

<?php

namespace Elchroy\PotatoORM;

class PotatoModel
{
    /**
     * [$queryTo The query (instance of PotatoQuery) to handle all database queries.
     *
     * @var [type] Instance of potatoQuery class, to be difined during construction.
     */
    public $queryTo;

    /**
     * [$dataToSave The properties of a object of theis class to be saved in the database.
     *
     * @var array This is an array of property names to be saved in to the database.
     */
    public $dataToSave = [];

    /**
     * [__construct The constructor to initialize public variables].
     *
     * @param PotatoQuery|null $potatoQuery The query to be used for the communication with the databse.
     */
    public function __construct(PotatoQuery $potatoQuery = null)
    {
        $this->queryTo = $potatoQuery == null ? new PotatoQuery() : $potatoQuery;
    }

    /**
     * [__set magic Property to set put of the object into the arary of properties to be saved in the database.].
     *
     * @param [type] $property [The property of the object to be saved.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param [type] $value    [The value of given property to be saved.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function __set($property, $value)
    {
        $this->dataToSave[$property] = $value;
    }

    /**
     * [__get Magic function to get the property from the dataToSave array, the array of properties.].
     *
     * @param [type] $property [The property to be gotten from the data to save array of propoerties.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return [type] [If the property is cound, return the value of that property. Otherwise throw an exception]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function __get($property)
    {
        if (array_key_exists($property, $this->dataToSave)) {
            return $this->dataToSave[$property];
        }

        return "$property not found.";
    }

    /**
     * [__isset Magic function to check if the given propertyh of the object is set.].
     *
     * @param [type] $property [The property in question]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return bool True if the property exists. False otherwise.
     */
    public function __isset($property)
    {
        return isset($this->dataToSave[$property]);
    }

    /**
     * [getAll Get all records of database table corresponding the the called class name.
     *
     * @param [type] $query [The query to be used to communicated with the databse.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return [type] Return the returned value of the query's query. The return value is an array of records represented as objects.

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public static function getAll($query = null)
    {
        $query = $query == null ? new PotatoQuery() : $query;
        $table = self::getClassTableName();

        return $query->getFrom($table);
    }

    /**
     * [find Find on record or row in the table given by an ID.
     *
     * @param [type] $id    [the ID of the row record to be fetched.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param [type] $query [The query to be used for the database communication.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return [type] [The returned value of finding the record with the given ID.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public static function find($id, $query = null)

This method seems to be duplicated in your project.

    {
        $query = $query == null ? new PotatoQuery() : $query;
        $table = self::getClassTableName();

        return $query->getOne($table, $id);
    }

    /**
     * SAve a recrd into the database. Saveing is either inserting or updating.
     *
     * @return [type] [A newly inserted record ot a recently updated record in the database.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function save()
    {
        return $this->isStored() ? $this->update() : $this->insert();
    }

    /**
     * Check if the object to be saved has an ID.
     *
     * @return bool [description]
     */
    public function isStored()
    {
        return isset($this->id);
    }

    /**
     * Insert a new record into the database while communicating with the qury handler.
     *
     * @return [type] [The returned value of the quering the databse.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function insert()
    {
        $table = self::getClassTableName();

        return $this->queryTo->storeIn($table, $this->dataToSave);

$this->dataToSave is of type array, but the function expects a string.

    }

    /**
     * Update a record in a database. The record must have an ID before it can be updated.
     *
     * @return [type] [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function update()
    {
        $table = self::getClassTableName();

        return $this->queryTo->updateAt($table, $this->dataToSave);
    }

    /**
     * Destroy a recored or row from a database table.
     *
     * @param [type] $id    [The ID of the record to be deleted.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @param [type] $query [The query to handle to deleting operation]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     *
     * @return [type] [An array of all the records in that table without the deleted recode.]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public static function destroy($id, $query = null)

This method seems to be duplicated in your project.

    {
        $query = $query == null ? new PotatoQuery() : $query;
        $table = self::getClassTableName();
        $query->deleteFrom($table, $id);

        return self::getAll($query); // return all the items after the previous item has been deleted.
    }

    /**
     * [getClassTableName Get the name of the class from which this function is called, including classes that inherit from this class.].
     *
     * @return [type] [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public static function getClassTableName()
    {
        $tableWithNameSpance = strtolower(get_called_class());
        $table = explode('\\', $tableWithNameSpance);

        return end($table);
    }
}