O2System\Reactor\Models\Sql\Traits\FinderTrait

Complexity

Total Complexity

26

Size/Duplication

Total Lines	197
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	findIn()	0	17	3
A	find()	0	26	6
A	findNotIn()	0	17	3
A	findWhere()	0	18	3
A	page()	0	25	6
A	all()	0	22	5

<?php
/**
 * This file is part of the O2System PHP Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Reactor\Models\Sql\Traits;

// ------------------------------------------------------------------------

use O2System\Database\DataObjects\Result;
use O2System\Reactor\Models\Sql\DataObjects;

/**
 * Class FinderTrait
 *
 * @package O2System\Reactor\Models\Sql\Traits
 */
trait FinderTrait
{
    /**
     * FinderTrait::all
     *
     * @param null $fields

Are you sure the doc-type for parameter $fields is correct as it would always require null to be passed?

     * @param null $limit

Are you sure the doc-type for parameter $limit is correct as it would always require null to be passed?

     *
     * @return bool|DataObjects\Result
     */
    public function all($fields = null, $limit = null)
    {
        if (isset($fields)) {
            $this->qb->select($fields);
        }

        if (isset($limit)) {
            $this->qb->limit($limit);
        }

        $result = $this->qb->from($this->table)->get();

        if ($result instanceof Result) {
            if ($result->count() > 0) {
                $this->result = new DataObjects\Result($result, $this);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                $this->result->setInfo($result->getInfo());

                return $this->result;
            }
        }

        return false;
    }
    // ------------------------------------------------------------------------

    /**
     * FinderTrait::page
     *
     * Find record by page.
     *
     * @param int $page
     */
    public function page($fields = null, $page = 1, $entries = 5)
    {
        $page = empty($page) ? 1 : $page;
        $entries = empty($entries) ? 5 : $entries;

        if (isset($fields)) {
            if (is_numeric($fields)) {
                $page = $fields;
            } else {
                $this->qb->select($fields);
            }
        }

        $this->qb->page($page, $entries);

        $result = $this->qb->from($this->table)->get();

        if ($result->count() > 0) {
            $this->result = new DataObjects\Result($result, $this);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->result->setInfo($result->getInfo());

            return $this->result;
        }

        return false;
    }
    // ------------------------------------------------------------------------

    /**
     * Find
     *
     * Find single or many record base on criteria by specific field
     *
     * @param   string      $criteria Criteria value
     * @param   string|null $field    Table column field name | set to primary key by default
     *
     * @return  DataObjects\Result|DataObjects\Result\Row|bool Returns FALSE if failed.
     */
    public function find($criteria, $field = null, $limit = null)
    {
        if (is_array($criteria)) {

The condition is_array($criteria) is always false.

            return $this->findIn($criteria, $field);
        }

        $field = isset($field) ? $field : $this->primaryKey;

        $result = $this->qb
            ->from($this->table)
            ->getWhere([$field => $criteria], $limit);

        if ($result instanceof Result) {
            if ($result->count() > 0) {
                $this->result = new DataObjects\Result($result, $this);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                $this->result->setInfo($result->getInfo());

                if ($this->result->count() == 1) {
                    return $this->result->first();
                }

                return $this->result;
            }
        }

        return false;
    }
    // ------------------------------------------------------------------------

    /**
     * Find In
     *
     * Find many records within criteria on specific field
     *
     * @param   array  $inCriteria List of criteria
     * @param   string $field      Table column field name | set to primary key by default
     *
     * @return  DataObjects\Result|bool Returns FALSE if failed.
     */
    public function findIn(array $inCriteria, $field = null)
    {
        $field = isset($field) ? $field : $this->primaryKey;

        $result = $this->qb
            ->from($this->table)
            ->whereIn($field, $inCriteria)
            ->get();

        if ($result->count() > 0) {
            $this->result = new DataObjects\Result($result, $this);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->result->setInfo($result->getInfo());

            return $this->result;
        }

        return false;
    }
    // ------------------------------------------------------------------------

    /**
     * Find By
     *
     * Find single record based on certain conditions
     *
     * @param   array $conditions List of conditions with criteria
     *
     * @access  protected
     * @return  DataObjects\Result|bool Returns FALSE if failed.
     */
    public function findWhere(array $conditions, $limit = null)
    {
        $result = $this->qb
            ->from($this->table)
            ->getWhere($conditions, $limit);

        if ($result->count() > 0) {
            $this->result = new DataObjects\Result($result, $this);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->result->setInfo($result->getInfo());

            if ($limit == 1) {
                return $this->result->first();
            }

            return $this->result;
        }

        return false;
    }
    // ------------------------------------------------------------------------

    /**
     * Find In
     *
     * Find many records not within criteria on specific field
     *
     * @param   array  $notInCriteria List of criteria
     * @param   string $field         Table column field name | set to primary key by default
     *
     * @return  DataObjects\Result|bool Returns FALSE if failed.
     */
    public function findNotIn(array $notInCriteria, $field = null)
    {
        $field = isset($field) ? $field : $this->primaryKey;

        $result = $this->qb
            ->from($this->table)
            ->whereNotIn($field, $notInCriteria)
            ->get();

        if ($result->count() > 0) {
            $this->result = new DataObjects\Result($result, $this);

The property result does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->result->setInfo($result->getInfo());

            return $this->result;
        }

        return false;
    }
}