League\Tactician\Logger\Formatter\ClassNameFormatter

Complexity

Total Complexity

4

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	4
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	commandReceived()	0	4	1
A	commandHandled()	0	4	1
A	propertiesUsed()	0	4	1
A	commandFailed()	0	8	1

<?php
namespace League\Tactician\Logger\Formatter;

use Exception;

/**
 * Returns log messages only dump the Command & Exception's class names.
 */
class ClassNameFormatter implements Formatter
{
    /**
     * @param object $command
     * @return string|null
     */
    public function commandReceived($command)
    {
        return 'Command received: ' . get_class($command);
    }

    /**
     * @param object $command
     * @return string|null
     */
    public function commandHandled($command)
    {
        return 'Command succeeded: ' . get_class($command);
    }

    public function propertiesUsed($command)
    {
        return [];
    }

    /**
     * @param object $command
     * @param Exception $e
     * @return string|null
     */
    public function commandFailed($command, Exception $e)
    {
        $commandClass = get_class($command);
        $exceptionClass = get_class($e);
        $exceptionMessage = $e->getMessage();

        return "Command failed: {$commandClass} threw the exception {$exceptionClass} ({$exceptionMessage})";
    }
}