Sofa\Revisionable\Laravel\DbLogger

Complexity

Total Complexity

13

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	1	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	revisionLog()	0	22	3
A	parseUser()	0	4	3
A	getCurrentConnection()	0	4	2
A	resetConnection()	0	4	1
A	getFromServer()	0	4	2
A	__construct()	0	5	1
A	on()	0	6	1

<?php namespace Sofa\Revisionable\Laravel;

use Sofa\Revisionable\Logger;
use Illuminate\Database\ConnectionInterface;
use DateTime;

class DbLogger implements Logger
{
    /**
     * Custom database connection.
     *
     * @var \Illuminate\Database\ConnectionInterface
     */
    protected $connection;

    /**
     * Default database connection.
     *
     * @var \Illuminate\Database\ConnectionInterface
     */
    protected $defaultConnection;

    /**
     * Revisions table name.
     *
     * @var string
     */
    protected $table;

    /**
     * Create a new DbLogger.
     *
     * @param \Illuminate\Database\ConnectionInterface $connection
     * @param string $table
     */
    public function __construct(ConnectionInterface $connection, $table)
    {
        $this->defaultConnection = $connection;
        $this->table             = $table;
    }

    /**
     * Log data revisions in the db.
     *
     * @param  string  $action
     * @param  string  $table
     * @param  int     $id
     * @param  array   $old
     * @param  array   $new
     * @param  string  $user
     * @return void
     */
    public function revisionLog($action, $table, $id, array $old = [], array $new = [], $user = null)
    {
        $user = $this->parseUser($user);

        $connection = $this->getCurrentConnection();

        $format = $connection->getQueryGrammar()->getDateFormat();

        $connection->table($this->table)->insert([
            'action'       => substr($action, 0, 255),
            'table_name'   => substr($table, 0, 255),
            'row_id'       => substr($id, 0, 255),
            'old'          => json_encode($old),
            'new'          => json_encode($new),
            'user'         => substr($user, 0, 255),
            'ip'           => substr($this->getFromServer('REMOTE_ADDR'), 0, 255) ?: null,
            'ip_forwarded' => substr($this->getFromServer('HTTP_X_FORWARDED_FOR'), 0, 255) ?: null,
            'created_at'   => (new DateTime)->format($format),
        ]);

        $this->resetConnection();
    }

    /**
     * Set custom connection for the next log.
     *
     * @param  \Illuminate\Database\ConnectionInterface $connection
     * @return static
     */
    public function on(ConnectionInterface $connection)
    {
        $this->connection = $connection;

        return $this;
    }

    /**
     * Translate provided user to appropriate string.
     *
     * @param  mixed  $user
     * @return string
     */
    protected function parseUser($user)
    {
        return (is_string($user) || is_numeric($user)) ? $user : ' -- ';
    }

    /**
     * Return current connection instance to use for next log.
     *
     * @return \Illuminate\Database\ConnectionInterface
     */
    protected function getCurrentConnection()
    {
        return ($this->connection) ?: $this->defaultConnection;
    }

    /**
     * Reset custom connection.
     *
     * @return void
     */
    protected function resetConnection()
    {
        $this->connection = null;
    }

    /**
     * Get Server variable.
     *
     * @param  string $key
     * @param  mixed  $default
     * @return string|array
     */
    protected function getFromServer($key, $default = null)
    {
        return (isset($_SERVER[$key])) ? $_SERVER[$key] : $default;
    }
}