make a separate Logger class

and move the logging interface into Main

README.md

@@ -139,7 +139,7 @@ libvips properties as properties of the PHP `Vips\Image` class.
 
 ```
 $ phpcs --standard=PSR2 src
-$ php ~/package/php/composer.phar install
+$ php ~/packages/php/composer.phar install
 $ vendor/bin/phpunit
 $ vendor/bin/phpdoc
 ```

examples/class.php

@@ -5,7 +5,7 @@
 
 use Jcupitt\Vips;
 
- public static function setLogger(LoggerInterface $logger)
+Vips\Main::setLogger(new Vips\Logger);
 
 $image = Vips\Image::newFromFile($argv[1]);
 

src/Image.php

@@ -41,9 +41,6 @@
 
 use Psr\Log\LoggerInterface;
 
-const LOG_FORMAT = "[%datetime%] %level_name%: %message% %context%\n";
-const DATE_FORMAT = "Y-m-d\TH:i:sP";
-
 /**
  * This class represents a Vips image object.
  *
@@ -416,99 +413,71 @@ class Image extends ImageAutodoc implements \ArrayAccess
 {
 
  /**
- * The logger instance.
+ * The resource for the underlying VipsImage.
  *
- * @var LoggerInterface
+ * @internal
  */
- private static $logger; 
+ private $image;
 
  /**
- * A basic logger, handy for debugging. 
+ * Wrap a Image around an underlying vips resource.
  *
- * @var LoggerInterface
- */
- public static $debugLogger = new class implements Psr\Log\LoggerInterface {
- // Use the LoggerTrait so that we only have to implement the generic
- // log method.
- use Psr\Log\LoggerTrait;
-
- /**
- * Logs with an arbitrary level.
- *
- * @param mixed $level
- * @param string $message
- * @param array $context
- *
- * @return void
- */
- public function log($level, $message, array $context = [])
- {
- // `Vips\Image` to string convert
- array_walk_recursive($context, function (&$value) {
- if ($value instanceof Vips\Image) {
- $value = (string) $value;
- }
- });
-
- $strParams = [
- '%datetime%' => date(DATE_FORMAT),
- '%level_name%' => $level,
- '%message%' => $message,
- '%context%' => json_encode(
- $context,
- JSON_UNESCAPED_SLASHES |
- JSON_UNESCAPED_UNICODE |
- JSON_PRESERVE_ZERO_FRACTION
- ),
- ];
-
- echo strtr(LOG_FORMAT, $strParams);
- }
- });
-
- /**
- * Sets a logger.
+ * Don't call this yourself, users should stick to (for example)
+ * Image::newFromFile().
  *
- * @param LoggerInterface $logger
+ * @param resource $image The underlying vips image resource that this
+ * class should wrap.
  *
- * @return void
+ * @internal
  */
- public static function setLogger(LoggerInterface $logger)
+ public function __construct($image)
  {
- self::$logger = $logger;
+ $this->image = $image;
  }
 
  /**
- * Gets a logger.
+ * Log a debug message.
  *
- * @return LoggerInterface $logger|null
- */
- public static function getLogger()
- {
- return self::$logger;
- }
-
- /**
- * The resource for the underlying VipsImage.
+ * @param string $name The method creating the messages.
+ * @param Image|null $instance Optionally, the instance that created the
+ * message.
+ * @param array $arguments The method arguments.
+ *
+ * @return void
  *
  * @internal
  */
- private $image;
+ private static function debug(
+ string $name,
+ $instance,
+ array $arguments
+ ): void {
+ $logger = Main::getLogger();
+ if ($logger) {
+ if ($instance) {
+ $arguments = array_merge(['instance' => $instance], $arguments);
+ }
+ $arguments = array_merge(['name' => $name], $arguments);
+ $logger->debug('Image', $arguments);
+ }
+ }
 
  /**
- * Wrap a Image around an underlying vips resource.
+ * Log an error message.
  *
- * Don't call this yourself, users should stick to (for example)
- * Image::newFromFile().
+ * @param string $message The error message.
+ * @param \Exception $exception The exception.
  *
- * @param resource $image The underlying vips image resource that this
- * class should wrap.
+ * @return void
  *
  * @internal
  */
- public function __construct($image)
+ private static function error(string $message, \Exception $exception): void
  {
- $this->image = $image;
+ $logger = Main::getLogger();
+ if ($logger) {
+ $logger->error($message, ['exception' => $exception]);
+ }
  }
 
  /**
@@ -697,9 +666,7 @@ private static function errorVips()
  {
  $message = vips_error_buffer();
  $exception = new Exception($message);
- if (self::$logger) {
- self::$logger->error($message, ['exception' => $exception]);
- }
+ self::error($message, $exception);
  throw $exception;
  }
 
@@ -958,13 +925,7 @@ public static function callBase(
  $instance,
  array $arguments
  ) {
- if (self::$logger) {
- self::$logger->debug('Called \'callBase\'', [
- 'name' => $name,
- 'instance' => $instance,
- 'arguments' => $arguments
- ]);
- }
+ self::debug($name, $instance, $arguments);
 
  $arguments = array_merge([$name, $instance], $arguments);
 
@@ -978,12 +939,7 @@ public static function callBase(
  self::errorIsArray($result);
  $result = self::wrapResult($result);
 
- if (self::$logger) {
- self::$logger->debug('Result \'callBase\'', [
- 'name' => $name,
- 'result' => $result,
- ]);
- }
+ self::debug($name, $instance, ['result' => $result]);
 
  return $result;
  }

src/Logger.php

@@ -0,0 +1,105 @@
+<?php
+
+/**
+ * Vips is a php binding for the vips image processing library
+ *
+ * PHP version 7
+ *
+ * LICENSE:
+ *
+ * Copyright (c) 2016 John Cupitt
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * @category Images
+ * @package Jcupitt\Vips
+ * @author John Cupitt <jcupitt@gmail.com>
+ * @copyright 2016 John Cupitt
+ * @license https://opensource.org/licenses/MIT MIT
+ * @version GIT:ad44dfdd31056a41cbf217244ce62e7a702e0282
+ * @link https://github.com/jcupitt/php-vips
+ */
+
+namespace Jcupitt\Vips;
+
+use \Psr\Log\LoggerInterface;
+
+const LOG_FORMAT = "[%datetime%] %level_name%: %message% %context%\n";
+const DATE_FORMAT = "Y-m-d\TH:i:sP";
+
+/**
+ * A simple logger, handy for debugging. See Main::setLogger().
+ *
+ * @category Images
+ * @package Jcupitt\Vips
+ * @author John Cupitt <jcupitt@gmail.com>
+ * @copyright 2016 John Cupitt
+ * @license https://opensource.org/licenses/MIT MIT
+ * @version Release:0.9.0
+ * @link https://github.com/jcupitt/php-vips
+ */
+class Logger implements LoggerInterface
+{
+ // Use the LoggerTrait so that we only have to implement the generic
+ // log method.
+ use \Psr\Log\LoggerTrait;
+
+ /**
+ * Logs with an arbitrary level.
+ *
+ * @param mixed $level
+ * @param string $message
+ * @param array $context
+ *
+ * @return void
+ */
+ public function log($level, $message, array $context = [])
+ {
+ // `Vips\Image` to string convert
+ array_walk_recursive($context, function (&$value) {
+ if ($value instanceof Vips\Image) {
+ $value = (string) $value;
+ }
+ });
+
+ $strParams = [
+ '%datetime%' => date(DATE_FORMAT),
+ '%level_name%' => $level,
+ '%message%' => $message,
+ '%context%' => json_encode(
+ $context,
+ JSON_UNESCAPED_SLASHES |
+ JSON_UNESCAPED_UNICODE |
+ JSON_PRESERVE_ZERO_FRACTION
+ ),
+ ];
+
+ echo strtr(LOG_FORMAT, $strParams);
+ }
+}
+
+/*
+ * Local variables:
+ * tab-width: 4
+ * c-basic-offset: 4
+ * End:
+ * vim600: expandtab sw=4 ts=4 fdm=marker
+ * vim<600: expandtab sw=4 ts=4
+ */

src/Main.php

@@ -39,6 +39,8 @@
 
 namespace Jcupitt\Vips;
 
+use \Psr\Log\LoggerInterface;
+
 /**
  * This class contains the top-level libvips control methods.
  *
@@ -52,6 +54,36 @@
  */
 class Main
 {
+
+ /**
+ * The logger instance.
+ *
+ * @var LoggerInterface
+ */
+ private static $logger;
+
+ /**
+ * Sets a logger.
+ *
+ * @param LoggerInterface $logger
+ *
+ * @return void
+ */
+ public static function setLogger(LoggerInterface $logger)
+ {
+ self::$logger = $logger;
+ }
+
+ /**
+ * Gets a logger.
+ *
+ * @return LoggerInterface $logger|null
+ */
+ public static function getLogger()
+ {
+ return self::$logger;
+ }
+
  /**
  * Set the maximum number of operations to hold in the libvips operation
  * cache.

tests/logger.php

@@ -8,14 +8,14 @@ public function testGetLoggerCall()
  {
  // Asserts that getLogger without setting it should
  // return a null value.
- $logger = Vips\Image::getLogger();
+ $logger = Vips\Main::getLogger();
 
  $this->assertNull($logger);
  }
 
  public function testSetLoggerCall()
  {
- Vips\Image::setLogger(new class implements Psr\Log\LoggerInterface {
+ Vips\Main::setLogger(new class implements Psr\Log\LoggerInterface {
  use Psr\Log\LoggerTrait;
 
  public function log($level, $message, array $context = array())
@@ -24,7 +24,7 @@ public function log($level, $message, array $context = array())
  }
  });
 
- $logger = Vips\Image::getLogger();
+ $logger = Vips\Main::getLogger();
 
  // Asserts that getLogger should return an instance of Psr\Log\LoggerInterface
  $this->assertInstanceOf(Psr\Log\LoggerInterface::class, $logger);