YOURLS\Admin\Logger

Complexity

Total Complexity

11

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Test Coverage

Coverage

76.92%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	log()	0	2	1
A	addProfile()	0	12	4
A	pretty_format()	0	19	4
A	get_log()	0	2	1
A	__construct()	0	2	1

<?php

/**
 * YOURLS simple logger
 *
 * @since 1.7.3
 */

namespace YOURLS\Admin;

use YOURLS\Database\YDB;

class Logger extends \Aura\Sql\Profiler {

    /**
     * the YDB instance
     * @var YDB
     */
    protected $ydb;

    /**
     * Debug log where messages are stored
     * @var array
     */
    protected $debug_log = array();

    public function __construct(YDB $ydb) {
        $this->ydb = $ydb;
        /**

Block comments must be started with /*

         * @todo Extend this to allow calling an external logger
         */
    }

    /**
     * @param string $message
     */
    public function log($message) {
        $this->debug_log[] = $message;
    }

    public function get_log() {
        return $this->debug_log;
    }

    /**
     * Extends \Aura\Sql\Profiler::addProfile() to log queries in our YOURLS logger
     *
     * @since  1.7.3
     * @param  float  $duration     The query duration.
     * @param  string $function     The PDO method that made the entry.
     * @param  string $statement    The SQL query statement.
     * @param  array  $bind_values  The values bound to the statement.
     * @return void
     */
    public function addProfile($duration, $function, $statement, array $bind_values = array() ) {
        parent::addProfile($duration, $function, $statement, $bind_values);

        if($function == 'connect') {

Operator == prohibited; use === instead

            $this->log( sprintf('SQL: CONNECT (%s s)', number_format($duration, 5)) );
            return;
        }

        // If we are emulating prepare, don't log 'prepare' statement, as they are not actual queries sent to the server

This line exceeds maximum limit of 100 characters; contains 120 characters

        // See YDB::get_queries() for details
        if ($this->ydb->get_emulate_state() && $function !== 'prepare') {
            $this->log( sprintf('SQL: %s (%s s)', $this->pretty_format($statement, $bind_values), number_format($duration, 5) ) );

This line exceeds maximum limit of 100 characters; contains 130 characters

        }
    }

    /**
     * Format PDO statement with bind/values replacement
     *
     * This replaces PDO binds such as 'key_name = :name' with corresponding array values, eg array('name'=>'some value')

This line exceeds maximum limit of 100 characters; contains 121 characters

     * This is merely a cosmetic replacement to allow for readability: the result WILL NOT be valid SQL! (eg no proper quotes)

This line exceeds maximum limit of 100 characters; contains 126 characters

     *
     * @since  1.7.3
     * @param  string $statement  SQL query with PDO style named placeholders
     * @param  array  $values     Optional array of values corresponding to placeholders
     * @return string             Readable SQL query with placeholders replaced
     */
    public function pretty_format($statement, array $values = array() ) {
        if (!$values) {

The expression $values of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return $statement;
        }

        return preg_replace_callback(
            '/:([^\s;)]*)/',

            /**

Block comments must be started with /*

             * @param string $matches
             */
            function ($matches) use ($values) {
                $replacement = isset( $values[$matches[1]] ) ? $values[$matches[1]] : '';
                if(is_array($replacement)) {
                    $replacement = implode(",", $replacement);

The string literal , does not require double quotes, as per coding-style, please use single quotes.

                }
                return "'$replacement'";

As per coding-style, please use concatenation or sprintf for the variable $replacement instead of interpolation.

            },
            $statement
        );
    }

}