Db3v4l\Core\SqlExecutor\Forked\TimedExecutor

Complexity

Total Complexity

8

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getExecuteFileProcess()	0	11	1
A	getExecuteStatementProcess()	0	10	1
A	resultSetToArray()	0	3	1
A	getTimingData()	0	22	4

<?php

Missing file doc comment

namespace Db3v4l\Core\SqlExecutor\Forked;

use Db3v4l\API\Interfaces\SqlExecutor\Forked\CommandExecutor;
use Db3v4l\API\Interfaces\SqlExecutor\Forked\FileExecutor;
use Db3v4l\API\Interfaces\TimedExecutor as TimedExecutorInterface;

class TimedExecutor implements CommandExecutor, FileExecutor, TimedExecutorInterface

Missing doc comment for class TimedExecutor

{
    /** @var CommandExecutor|FileExecutor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    protected $wrappedExecutor;
    protected $timingFile;

    protected $timeCmd = '/usr/bin/time';

    /**

Missing short description in doc comment

     * @param CommandExecutor|FileExecutor $wrappedExecutor

Missing parameter comment

     */
    public function __construct($wrappedExecutor)
    {
        $this->wrappedExecutor = $wrappedExecutor;
    }

    public function getExecuteStatementProcess($sql)

Missing doc comment for function getExecuteStatementProcess()

    {
        $process = $this->wrappedExecutor->getExecuteStatementProcess($sql);

The method getExecuteStatementProcess() does not exist on Db3v4l\API\Interfaces\SqlExecutor\Forked\FileExecutor. Since it exists in all sub-types, consider adding an abstract or default implementation to Db3v4l\API\Interfaces\SqlExecutor\Forked\FileExecutor.

        // wrap in a `time` call
        $this->timingFile = tempnam(sys_get_temp_dir(), 'db3v4l_');
        $process->setCommandLine(
            $this->timeCmd . ' ' . escapeshellarg('--output=' . $this->timingFile) . ' ' . escapeshellarg('--format=%M %e') . ' '
            . $process->getCommandLine());

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

For multi-line function calls, the closing parenthesis should be on a new line.

        return $process;
    }

    public function getExecuteFileProcess($sql)

Missing doc comment for function getExecuteFileProcess()

    {
        $process = $this->wrappedExecutor->getExecuteFileProcess($sql);

The method getExecuteFileProcess() does not exist on Db3v4l\API\Interfaces\SqlExecutor\Forked\CommandExecutor. Since it exists in all sub-types, consider adding an abstract or default implementation to Db3v4l\API\Interfaces\SqlExecutor\Forked\CommandExecutor.

        // wrap in a `time` call
        $this->timingFile = tempnam(sys_get_temp_dir(), 'db3v4l_');
        $process->setCommandLine(
            $this->timeCmd . ' ' . escapeshellarg('--output=' . $this->timingFile) . ' ' . escapeshellarg('--format=%M %e') . ' '
            . $process->getCommandLine());

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

For multi-line function calls, the closing parenthesis should be on a new line.

        return $process;
    }

    public function resultSetToArray($data)

Missing doc comment for function resultSetToArray()

    {
        return $this->wrappedExecutor->resultSetToArray($data);
    }

    public function getTimingData($onceIsEnough = true)

Missing doc comment for function getTimingData()

    {
        if (!is_file($this->timingFile)) {
            throw new \Exception("File with timing data gone missing: '{$this->timingFile}'");
        }

        $timingData = file_get_contents($this->timingFile);
        if ($timingData != '') {
            $timingData = preg_replace('/Command exited with non-zero status [0-9]+/', '', $timingData);
            $timingData = explode(' ', trim($timingData), 2);
            $results['time'] = $timingData[1];

$results was never initialized. Although not strictly required by PHP, it is generally a good practice to add $results = array(); before regardless.

            $results['memory'] = $timingData[0];
        } else {
            // happens eg. if `time` command is not available
            throw new \Exception("File with timing data empty: '{$this->timingFile}'");
        }

        if ($onceIsEnough) {
            unlink ($this->timingFile);

Space before opening parenthesis of function call prohibited

        }

        return $results;
    }
}