vendor/stripe/stripe-php/lib/Util/LoggerInterface.php

   1 <?php
   2
   3 namespace Stripe\Util;
   4
   5 /**
   6  * Describes a logger instance.
   7  *
   8  * This is a subset of the interface of the same name in the PSR-3 logger
   9  * interface. We guarantee to keep it compatible, but we'd redefined it here so
  10  * that we don't have to pull in the extra dependencies for users who don't want
  11  * it.
  12  *
  13  * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
  14  * for the full interface specification.
  15  *
  16  * The message MUST be a string or object implementing __toString().
  17  *
  18  * The message MAY contain placeholders in the form: {foo} where foo
  19  * will be replaced by the context data in key "foo".
  20  *
  21  * The context array can contain arbitrary data, the only assumption that
  22  * can be made by implementors is that if an Exception instance is given
  23  * to produce a stack trace, it MUST be in a key named "exception".
  24  */
  25 interface LoggerInterface
  26 {
  27     /**
  28      * Runtime errors that do not require immediate action but should typically
  29      * be logged and monitored.
  30      *
  31      * @param string $message
  32      * @param array $context
  33      * @return null
  34      */
  35     public function error($message, array $context = array());
  36 }