Jns\Bundle\XhprofBundle\EventListener\CommandListener

Complexity

Total Complexity

16

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setEnabled()	0	4	1
A	setOptionName()	0	4	1
A	setFilters()	0	4	1
A	setWebLocation()	0	4	1
A	isProfileOption()	0	13	1
C	onCommand()	0	34	8
A	onTerminate()	0	14	2

<?php

namespace Jns\Bundle\XhprofBundle\EventListener;

use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\Console\Event\ConsoleTerminateEvent;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Jns\Bundle\XhprofBundle\DataCollector\XhprofCollector;

/**
 * A command listener to profile command runs.
 *
 * The methods must be connected to the console.command and console.terminate
 * events.
 *
 * @author David Buchmann <mail@davidbu.ch>
 */
class CommandListener
{
    private $collector;
    private $container;
    private $optionName;
    private $mode;
    private $filters = array();
    private $webLocation;

    public function __construct(XhprofCollector $collector, ContainerInterface $container)
    {
        $this->collector = $collector;
        $this->container = $container;
    }

    /**
     * @param string $mode on|off|option
     */
    public function setEnabled($mode)
    {
        $this->mode = $mode;
    }

    /**
     * @param string $option name of the cli option for enabled mode "option"
     */
    public function setOptionName($option)
    {
        $this->optionName = $option;
    }

    /**
     * @param array $excludes List of regular expressions for command names to exclude
     */
    public function setFilters(array $excludes)
    {
        $this->filters = $excludes;
    }

    /**
     * Configure the base url to the xhprof web gui.
     *
     * @param string $webLocation
     */
    public function setWebLocation($webLocation)
    {
        $this->webLocation = $webLocation;
    }

    /**
     * We need to add the profile enable option to all commands if we are in
     * the parameter mode.
     *
     * Inspired by
     * http://php-and-symfony.matthiasnoback.nl/2013/11/symfony2-add-a-global-option-to-console-commands-and-generate-pid-file/
     *
     * @param ConsoleCommandEvent $event
     * @return mixed
     */
    private function isProfileOption(ConsoleCommandEvent $event)
    {
        $definition = $event->getCommand()->getDefinition();

        $definition->addOption(
            new InputOption($this->optionName, null, InputOption::VALUE_NONE, '<info>JnsXhprofBundle</info>: Whether to profile this command with xhprof', null)
        );

        $input = $event->getInput();
        $input->bind($definition);

        return $input->getOption($this->optionName);
    }

    /**
     * Start the profiler if
     * - we are not running the list or help command
     * - the command mode is on
     * - or the command mode if option and the option is specified
     *
     * @param ConsoleCommandEvent $event
     */
    public function onCommand(ConsoleCommandEvent $event)
    {
        $command = $event->getCommand()->getName();
        $system = array(
            'list',
            'help',
            'assetic:dump',
            'assets:install',
            'config:dump-reference',
            'container:debug',
            'router:debug',
            'cache:clear',
            'cache:warmup',
            'cache:create-cache-class',
        );
        if (in_array($command, $system)) {
            return;
        }
        if ('off' == $this->mode ||
            'option' == $this->mode && !$this->isProfileOption($event)) {
            return;
        }

        foreach ($this->filters as $exclude) {
            if (preg_match('@' . $exclude . '@', $command)) {
                return;
            }
        }


        if ($this->collector->startProfiling()) {
            $event->getOutput()->writeln("XHProf starting run\n---");
        }
    }

    /**
     * Trigger the collector to end the request and output the xhprof link if
     * we where collecting.
     *
     * @param ConsoleTerminateEvent $event
     */
    public function onTerminate(ConsoleTerminateEvent $event)
    {
        $command = $event->getCommand();
        $link = $this->collector->stopProfiling('cli', $command->getName());
        if (false === $link) {
            return;
        }


        $event->getOutput()->writeln(sprintf(
            "\n---\nXHProf run link <info>%s</info>",
            $this->collector->getXhprofUrl()
        ));
    }
}