KnpLabs / KnpSnappyBundle

src/Snappy/Generator/LoggableGenerator.php

<?php

namespace Knp\Bundle\SnappyBundle\Snappy\Generator;

@trigger_error('Logging capability is now directly integrated in Snappy. You should call setLogger on your generator rather than using this decorator.', E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

use Knp\Snappy\GeneratorInterface;
use Psr\Log\LoggerInterface;

/**
 * Wraps a GeneratorInterface instance to log the media generations using the
 * configured logger.
 *
 * @deprecated Logging capability is now directly integrated in Snappy. You should use it rather than this Decorator.
 */
class LoggableGenerator implements GeneratorInterface
{
    private $generator;
    private $logger;

    /**
     * Constructor.
     *
     * @param GeneratorInterface $generator
     * @param LoggerInterface    $logger

Should the type for parameter $logger not be null|LoggerInterface?

     */
    public function __construct(GeneratorInterface $generator, LoggerInterface $logger = null)
    {
        $this->generator = $generator;
        $this->logger = $logger;
    }

    /**
     * Returns the underlying generator instance.
     *
     * @return GeneratorInterface
     */
    public function getInternalGenerator()
    {
        return $this->generator;
    }

    /**
     * {@inheritdoc}
     */
    public function generate($input, $output, array $options = [], $overwrite = false)
    {
        if (is_array($input)) {
            $debug_input = implode(', ', $input);
        } else {
            $debug_input = $input;
        }
        $this->logDebug(sprintf('Generate from file (%s) to file (%s).', $debug_input, $output));

        $this->generator->generate($input, $output, $options, $overwrite);
    }

    /**
     * {@inheritdoc}
     */
    public function generateFromHtml($html, $output, array $options = [], $overwrite = false)
    {
        $debugHtml = is_array($html) ? implode(', ', $html) : $html;

        $this->logDebug(sprintf('Generate from HTML (%s) to file (%s).', substr($debugHtml, 0, 100), $output));

        $this->generator->generateFromHtml($html, $output, $options, $overwrite);
    }

    /**
     * {@inheritdoc}
     */
    public function getOutput($input, array $options = [])
    {
        if (is_array($input)) {
            $debug_input = implode(', ', $input);
        } else {
            $debug_input = $input;
        }
        $this->logDebug(sprintf('Output from file (%s).', $debug_input));

        return $this->generator->getOutput($input, $options);
    }

    /**
     * {@inheritdoc}
     */
    public function getOutputFromHtml($html, array $options = [])
    {
        $debugHtml = is_array($html) ? implode(', ', $html) : $html;

        $this->logDebug(sprintf('Output from HTML (%s).', substr($debugHtml, 0, 100)));

        return $this->generator->getOutputFromHtml($html, $options);
    }

    /**
     * {@inheritdoc}
     */
    public function setOption($name, $value)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $this->logDebug(sprintf('Set option %s = %s.', $name, var_export($value, true)));

        return $this->generator->setOption($name, $value);
    }

    /**
     * Logs the given debug message if the logger is configured or do nothing
     * otherwise.
     *
     * @param string $message
     */
    private function logDebug($message)
    {
        if (null === $this->logger) {
            return;
        }

        $this->logger->debug($message);
    }
}