Battis\SharedLogs\Database\Bindings\EntriesBinding

Complexity

Total Complexity

13

Size/Duplication

Total Lines	129
Duplicated Lines	18.6 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	get()	0	4	1
B	instantiateObject()	6	14	5
A	instantiateListedObject()	0	4	1
A	listByLog()	18	18	3
A	recent()	0	16	2

<?php
/** EntriesBinding */

namespace Battis\SharedLogs\Database\Bindings;

use Battis\SharedLogs\Database\Binding;
use Battis\SharedLogs\Database\Bindings\Traits\EntriesBindingTrait;
use Battis\SharedLogs\Database\Bindings\Traits\LogsBindingTrait;
use Battis\SharedLogs\Database\Bindings\Traits\UsersBindingTrait;
use Battis\SharedLogs\Exceptions\BindingException;
use Battis\SharedLogs\Objects\Entry;
use Battis\SharedLogs\Objects\Log;
use Battis\SharedLogs\Objects\User;
use PDO;

/**
 * A binding between `Entry` objects and the `entries` database table
 *
 * @author Seth Battis <seth@battis.net>
 */
class EntriesBinding extends Binding
{
    use EntriesBindingTrait, LogsBindingTrait, UsersBindingTrait;

    const INCLUDE_USER = 'user';
    const INCLUDE_LOG = 'log';

    /**
     * Constuct an entries binding from a database connector
     *
     * @param PDO $database
     *
     * @throws BindingException
     */
    public function __construct(PDO $database)
    {
        parent::__construct($database, 'entries', Entry::class);
    }

    /**
     * Retrieve an entry by ID
     *
     * By default, entries contain both log and user sub-objects.
     *
     * @param int|string $id
     * @param array $params
     *
     * @return Entry|null
     */
    public function get($id, $params = [self::INCLUDE => [self::INCLUDE_LOG, self::INCLUDE_USER]])
    {
        return parent::get($id, $params);
    }

    /**
     * Instantiate an entry retrieved via `get()`
     *
     * @used-by EntriesBinding::instantiateListedObject()
     *
     * @param array $databaseRow
     * @param array $params
     *
     * @return Entry
     */
    protected function instantiateObject($databaseRow, $params)
    {
        $log = Entry::SUPPRESS_LOG;
        $user = Entry::SUPPRESS_USER;
        if (!empty($params[self::INCLUDE]) && is_array($params[self::INCLUDE])) {
            if (in_array(self::INCLUDE_LOG, $params[self::INCLUDE])) {

This code seems to be duplicated across your project.

                $log = $this->logs()->get($databaseRow[Log::ID], [self::INCLUDE => []]);
            }
            if (in_array(self::INCLUDE_USER, $params[self::INCLUDE])) {

This code seems to be duplicated across your project.

                $user = $this->users()->get($databaseRow[User::ID], [self::INCLUDE => []]);
            }
        }
        return $this->object($databaseRow, $log, $user);
    }

    /**
     * Instantiate an entry retrieved via `all()`
     *
     * @param array $databaseRow
     * @param array $params
     *
     * @uses EntriesBinding::instantiateObject()
     *
     * @return Entry
     */
    protected function instantiateListedObject($databaseRow, $params)
    {
        return $this->instantiateObject($databaseRow, $params);
    }

    /**
     * Retrieve all entries in a specific log, by log ID
     *
     * By default, entries retrieved by this method contain user sub-object, but _not_ a log sub-object.
     *
     * @param integer|string $id Numeric log ID
     * @param array $params (Optional) Associative array of additional request parameters
     * @return Entry[]
     */
    public function listByLog($id, $params = [self::INCLUDE => [self::INCLUDE_USER]])

This method seems to be duplicated in your project.

    {
        $statement = $this->database()->prepare("
            SELECT *
                FROM `" . $this->databaseTable() . "`
                WHERE
                  `" . Log::ID . "` = :id
                ORDER BY
                    " . $this->listOrder() . "
        ");
        $list = [];
        if ($statement->execute(['id' => $id])) {
            while ($row = $statement->fetch()) {
                $list[] = $this->instantiateListedObject($row, $params);
            }
        }
        return $list;
    }

    /**
     * Retrieve most recent entry of a specific log
     *
     * "Most recent" is detemermined by the listOrder() method, which defaults to descending creation date. By default,
     * entries retrieved by this method contain user sub-object, but _not_ a log sub-object.
     *
     * @param integer|string $id Numeric log ID
     * @param array $params (Optional) Associative array of additional request parameters
     * @return Entry|null
     */
    public function recent($id, $params = [self::INCLUDE => [self::INCLUDE_USER]])
    {
        $statement = $this->database()->prepare("
            SELECT *
                FROM `" . $this->databaseTable() . "`
                WHERE
                    `" . Log::ID . "` = :id
                ORDER BY
                    " . $this->listOrder() . "
                LIMIT 1
        ");
        if ($statement->execute(['id' => $id])) {
            return $this->instantiateObject($statement->fetch(), $params);
        }
        return null;
    }
}