Subreality\Dilmun\Enki\MySql

Complexity

Total Complexity

18

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	connect()	0	20	2
A	disconnect()	0	12	2
B	getPrimaryKeys()	0	29	3
B	getRowById()	0	33	5
A	tableExists()	0	16	2
A	processPrimaryKeyResult()	0	18	4

<?php

namespace Subreality\Dilmun\Enki;

use Subreality\Dilmun\LoggedClassTrait;

/**
 * Class MySql
 * @package Subreality\Dilmun\Enki
 */
class MySql implements EnkiInterface
{
    use LoggedClassTrait;

    /**
     * @var \PDO
     */
    private $pdo;

    /**
     * Provides a MySQL connection interface that catches a PDOException on failure.
     *
     * @param string $host  The host name for the MySQL connection
     * @param string $user  The username for the MySQL connection
     * @param string $pass  The password for the MySQL connection
     * @param string $name  The database name for the MySQL connection
     *
     * @return bool         Returns true if the connection was successful; returns false otherwise
     */
    public function connect($host, $user, $pass, $name)
    {
        $dsn = "mysql:host={$host};dbname={$name}";

        try {
            $this->pdo = new \PDO($dsn, $user, $pass);
            $this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);

            $connected = true;
        } catch (\PDOException $pdo_e) {
            $context = array();

Equals sign not aligned with surrounding assignments; expected 14 spaces but found 1 space

            $context["exception"] = $pdo_e;

            $this->updateLog("error", "MySQL connection failed with the following message: {message}", $context);
            
            $connected = false;
        }

        return $connected;
    }

    /**
     * Destroys an existing PDO connection
     *
     * @return bool Returns true if the connection existed and was destroyed; returns false otherwise
     */
    public function disconnect()
    {
        if ($this->pdo instanceof \PDO) {
            $this->pdo = null;

            $disconnected = true;
        } else {
            $disconnected = false;
        }

        return $disconnected;
    }

    /**
     * Gets the column names for all primary keys for a table or returns false if no keys exist
     *
     * @param string $table The table from which keys will be retrieved
     *
     * @return array|false  Returns an array of column names representing primary keys;
     *                      returns false if the table has no primary keys
     */
    public function getPrimaryKeys($table)
    {
        $table_exists = $this->tableExists($table);
        
        if (!$table_exists) {

This if statement is empty and can be removed.

//            return false;
        }

        $keys_query = "SHOW KEYS FROM {$table} WHERE Key_name='PRIMARY'";

        $statement = $this->pdo->prepare($keys_query);

        try {
            $statement->execute();
        } catch (\PDOException $pdo_e) {
            $context = array();

Equals sign not aligned with surrounding assignments; expected 14 spaces but found 1 space

            $context["exception"] = $pdo_e;

            $this->updateLog("error", "Trying to get keys failed with the following message: {message}", $context);

            return false;
        }

        $result = $statement->fetchAll();

        $keys = $this->processPrimaryKeyResult($result);

        return $keys;
    }

    /**
     * Retrieves a row represented by a single primary key
     *
     * @param int|string $id    A unique id for a table
     * @param string $table     The table from which a row will be retrieved
     *
     * @return array|false      Returns an associative array representing the row corresponding with the primary key;
     *                          returns false if the table does not exist, if the provided id does not correspond with a
     *                          record, or if the table has a compound primary key
     */
    public function getRowById($id, $table)
    {
        $key = $this->getPrimaryKeys($table);

        if (is_string($id)) {
            $query_id = "'{$id}'";
        } else {
            $query_id = $id;
        }

        if ($key === false) {
            $row = false;
        } elseif (count($key) > 1) {
            $row = false;
        } else {
            $query = "SELECT * FROM {$table}
                        WHERE {$key} = {$query_id}";

            $statement = $this->pdo->prepare($query);

            $statement->execute();

            $result = $statement->fetchAll(\PDO::FETCH_ASSOC);

            if (empty($result)) {
                $row = false;
            } else {
                $row = $result[0];
            }
        }

        return $row;
    }

    /**
     * Determines whether a given table exists
     *
     * @param string $table The table that will be checked for existence
     * @return bool         Returns true if the table exists; returns false otherwise
     */
    public function tableExists($table)
    {
        $table_query = "SHOW TABLES LIKE '{$table}'";

        $statement = $this->pdo->prepare($table_query);

        $statement->execute();

        $row_count = $statement->rowCount();

        if ($row_count == 0) {

The if-else statement can be simplified to return !($row_count == 0);.

            return false;
        } else {
            return true;
        }
    }

    /**
     * Processes the result set from a primary key query
     *
     * @see MySql::getPrimaryKeys()
     *
     * @param array $result An array representing the result of a primary key query
     *
     * @return mixed        Returns a string column name if the result set contains only one key; returns an array of
     *                      string column names if the result set contains a compound key; returns false if the result
     *                      set was empty
     */
    private function processPrimaryKeyResult($result)
    {
        $row_count = count($result);

        if ($row_count > 1) {
            $keys = array();

            foreach ($result as $row) {
                $keys[] = $row['Column_name'];
            }
        } elseif ($row_count == 1) {
            $keys = $result[0]['Column_name'];
        } else {
            $keys = false;
        }

        return $keys;
    }
}