Made trait FormattedException compatible with PHP 5.4.

Author: prwater

.gitignore

@@ -1,4 +1,5 @@
 .idea/
 bin/
 composer.lock
+doc/
 vendor/

build.xml

@@ -3,6 +3,11 @@
     <target name="build">
     </target>
 
+    <!-- Runs ApiGen -->
+    <target name="apigen">
+        <exec command="apigen generate --todo --tree --source src --destination doc" passthru="true" checkreturn="true"/>
+    </target>
+
     <!-- Runs all unit tests -->
     <target name="unit">
         <exec command="bin/phpunit --bootstrap=test/bootstrap.php test" passthru="true" checkreturn="true"/>

src/FormattedException.php

@@ -3,25 +3,60 @@
 namespace SetBased\Exception;
 
 //----------------------------------------------------------------------------------------------------------------------
+/**
+ * Trait for exception classes with format string in constructor.
+ *
+ * Example:
+ * ```
+ * class MyException extends \Exception
+ * {
+ *   use FormattedException;
+ *
+ *   public function __construct()
+ *   {
+ *     list($message, $code, $previous) = self::formattedConstruct(func_get_args());
+ *
+ *     parent::__construct($message, $code, $previous);
+ *   }
+ * }
+ * ```
+ */
 trait FormattedException
 {
+  /* PHP 5.4: doesn't allow us to use __construct in traits. This possible from PHP 5.5 and higher. */
   //--------------------------------------------------------------------------------------------------------------------
   /**
-   * Object constructor.
+   * Returns a list of arguments for \Exception::_construct.
    *
-   * @param string|array $format    The format string of the error message, see
-   *                                [sprintf](http://php.net/manual/function.sprintf.php).
-   * @param mixed        $param,... The arguments for the format string. However, if the first argument is an exception
-   *                                it will be used as the [previous](http://php.net/manual/exception.construct.php)
-   *                                exception for the exception chaining.
+   * @param \array $args The arguments for __construct.
+   *
+   * Below we give same samples of valid combinations for arguments for __construct.
+   * ```
+   * // Exception with message
+   * new MyException('Something went wrong');
+   *
+   * // Exception with a format string
+   * new MyException('There are %d monkeys in the %s', 5, 'tree');
+   *
+   * // Exception with an exception code
+   * new MyException([$code], 'There are %d monkeys in the %s', 5, 'tree');
+   *
+   * // Exception with q previous exception
+   * new MyException([$previous], 'There are %d monkeys in the %s', 5, 'tree');
+   *
+   * // Exception with an exception code and a previous exception
+   * new MyException([$code,$previous], 'There are %d monkeys in the %s', 5, 'tree');
+   * // or
+   * new MyException([$previous,$code], 'There are %d monkeys in the %s', 5, 'tree');
+   * ```
+   *
+   * @return \array[string,int,\Exception|null]
    */
-  public function __construct($format)
+  public static function formattedConstruct($args)
   {
     $code     = 0;
     $previous = null;
-
-    $args = func_get_args();
-    array_shift($args);
+    $format   = array_shift($args);
 
     if (is_array($format))
     {
@@ -41,7 +76,7 @@ public function __construct($format)
       }
     }
 
-    parent::__construct(vsprintf($format, $args), $code, $previous);
+    return [vsprintf($format, $args), $code, $previous];
   }
 
   //--------------------------------------------------------------------------------------------------------------------

src/LogicException.php

@@ -4,13 +4,26 @@
 
 //----------------------------------------------------------------------------------------------------------------------
 /**
- * Parent class for errors in the program logic.
+ * Class for errors in program logic.
  */
 class LogicException extends \LogicException implements NamedException
 {
   //--------------------------------------------------------------------------------------------------------------------
   use FormattedException;
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Object constructor.
+   *
+   * @param mixed ... The arguments, see {@see \SetBased\Exception\FormattedException::formattedConstruct}.
+   */
+  public function __construct()
+  {
+    list($message, $code, $previous) = self::formattedConstruct(func_get_args());
+
+    parent::__construct($message, $code, $previous);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * {@inheritdoc}

src/RuntimeException.php

@@ -11,6 +11,21 @@ class RuntimeException extends \RuntimeException implements NamedException
   //--------------------------------------------------------------------------------------------------------------------
   use FormattedException;
 
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Object constructor.
+   *
+   * See {@see \SetBased\Exception\FormattedException::formattedConstruct()} for argument list.
+   *
+   * @param mixed ... The arguments, see {@see \SetBased\Exception\FormattedException::formattedConstruct()}.
+   */
+  public function __construct()
+  {
+    list($message, $code, $previous) = self::formattedConstruct(func_get_args());
+
+    parent::__construct($message, $code, $previous);
+  }
+
   //--------------------------------------------------------------------------------------------------------------------
   /**
    * {@inheritdoc}

test/ExceptionTestBase.php test/FormattedExceptionTestBase.phptest/ExceptionTestBase.php renamed to test/FormattedExceptionTestBase.php

@@ -3,7 +3,7 @@
 use SetBased\Exception\NamedException;
 
 //----------------------------------------------------------------------------------------------------------------------
-class ExceptionTestBase extends PHPUnit_Framework_TestCase
+class FormattedExceptionTestBase extends PHPUnit_Framework_TestCase
 {
   //--------------------------------------------------------------------------------------------------------------------
   static $class;

test/LogicExceptionTest.php

@@ -1,6 +1,6 @@
 <?php
 //----------------------------------------------------------------------------------------------------------------------
-class LogicExceptionTest extends \ExceptionTestBase
+class LogicFormattedExceptionTest extends \FormattedExceptionTestBase
 {
   //--------------------------------------------------------------------------------------------------------------------
   public function setUp()

test/RuntimeExceptionTest.php

@@ -1,6 +1,6 @@
 <?php
 //----------------------------------------------------------------------------------------------------------------------
-class RuntimeExceptionTest extends \ExceptionTestBase
+class RuntimeFormattedExceptionTest extends \FormattedExceptionTestBase
 {
   //--------------------------------------------------------------------------------------------------------------------
   public function setUp()

test/bootstrap.php

@@ -3,6 +3,6 @@
 date_default_timezone_set( 'Europe/Amsterdam' );
 
 require_once( __DIR__.'/../vendor/autoload.php' );
-require_once('ExceptionTestBase.php' );
+require_once('FormattedExceptionTestBase.php' );
 
 //----------------------------------------------------------------------------------------------------------------------