Code style updates

Author: Ayesh

src/Stopwatch.php

@@ -1,42 +1,45 @@
 <?php
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Ayesh\PHP_Timer;
 
 class Stopwatch {
+
   private $accrued = 0;
+
   private $timestamp;
+
   private $running = false;
 
   public function __construct() {
     $this->start();
   }
 
-  private function getTimestamp(): float {
-    return microtime(true);
-  }
-
-  private function accrue(): void {
-    $this->accrued = $this->read();
-  }
-
   public function start(): void {
     if ($this->running) {
       return;
     }
 
     $this->accrue();
-    $this->running = true;
+    $this->running   = true;
     $this->timestamp = $this->getTimestamp();
   }
 
+  private function accrue(): void {
+    $this->accrued = $this->read();
+  }
+
   public function read(): float {
     if ($this->running) {
       return $this->accrued + ($this->getTimestamp() - $this->timestamp);
     }
     return $this->accrued;
   }
 
+  private function getTimestamp(): float {
+    return microtime(true);
+  }
+
   public function stop(): float {
     $this->accrue();
     $this->running = false;

src/Timer.php

@@ -1,5 +1,5 @@
 <?php
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Ayesh\PHP_Timer;
 
@@ -12,9 +12,13 @@
  * @package Ayesh\PHP_Timer
  */
 class Timer {
-  public const FORMAT_PRECISE = FALSE;
+
+  public const FORMAT_PRECISE = false;
+
   public const FORMAT_MILLISECONDS = 'ms';
+
   public const FORMAT_SECONDS = 's';
+
   public const FORMAT_HUMAN = 'h';
 
   private const TIMES = [
@@ -25,6 +29,7 @@ class Timer {
 
   /**
    * Stores all the timers statically.
+   *
    * @var Stopwatch[]
    */
   static private $timers = [];
@@ -33,13 +38,14 @@ class Timer {
    * Start or resume the timer.
    *
    * Call this method to start the timer with a given key. The default key
-   * is "default", and used in @see \Ayesh\PHP_Timer\Timer::read() and reset()
+   * is "default", and used in @param string $key
+   *
+   * @see \Ayesh\PHP_Timer\Timer::read() and reset()
    * methods as well
    *
    * Calling this with the same $key will not restart the timer if it has already
    * started.
    *
-   * @param string $key
    */
   public static function start(string $key = 'default'): void {
     if (isset(self::$timers[$key])) {
@@ -52,8 +58,9 @@ public static function start(string $key = 'default'): void {
 
   /**
    * Resets a specific timer, or default timer if not passed the $key parameter.
-   * To reset all timers, call @see \Ayesh\PHP_Timer\Timer::resetAll().
-   * @param string $key
+   * To reset all timers, call @param string $key
+   *
+   * @see \Ayesh\PHP_Timer\Timer::resetAll().
    */
   public static function reset(string $key = 'default'): void {
     unset(self::$timers[$key]);
@@ -67,10 +74,36 @@ public static function resetAll(): void {
     self::$timers = [];
   }
 
+  /**
+   * Returns the time elapsed in the format requested in the $format parameter.
+   * To access a specific timer, pass the same key that
+   *
+   * @param string $key The key that the timer was started with. Default value is
+   *   "default" throughout the class.
+   * @param string $format
+   *
+   * @return mixed The formatted time.
+   * @throws \LogicException
+   * @see \Ayesh\PHP_Timer\Timer::start() was called with. If the timer was not
+   * started, a \LogicException will be thrown.
+   *
+   * The default format is milliseconds. See the class constants for additional
+   * formats.
+   *
+   */
+  public static function read(string $key = 'default', $format = self::FORMAT_MILLISECONDS) {
+    if (isset(self::$timers[$key])) {
+      return self::formatTime(self::$timers[$key]->read(), $format);
+    }
+    throw new \LogicException('Reading timer when the given key timer was not initialized.');
+  }
+
   /**
    * Formats the given time the processor into the given format.
+   *
    * @param float $value
    * @param string|bool $format
+   *
    * @return string
    */
   private static function formatTime(float $value, $format): string {
@@ -103,28 +136,6 @@ private static function secondsToTimeString(float $time): string {
     return $ms . ' ms';
   }
 
-  /**
-   * Returns the time elapsed in the format requested in the $format parameter.
-   * To access a specific timer, pass the same key that
-   * @see \Ayesh\PHP_Timer\Timer::start() was called with. If the timer was not
-   * started, a \LogicException will be thrown.
-   *
-   * The default format is milliseconds. See the class constants for additional
-   * formats.
-   *
-   * @param string $key The key that the timer was started with. Default value is
-   *   "default" throughout the class.
-   * @param string $format
-   * @return mixed The formatted time.
-   * @throws \LogicException
-   */
-  public static function read(string $key = 'default', $format = self::FORMAT_MILLISECONDS) {
-    if (isset(self::$timers[$key])) {
-      return self::formatTime(self::$timers[$key]->read(), $format);
-    }
-    throw new \LogicException('Reading timer when the given key timer was not initialized.');
-  }
-
   /**
    * Stops the timer with the given key. Default key is "default"
    *
@@ -135,13 +146,15 @@ public static function read(string $key = 'default', $format = self::FORMAT_MILL
   public static function stop($key = 'default'): void {
     if (isset(self::$timers[$key])) {
       self::$timers[$key]->stop();
-    } else {
+    }
+    else {
       throw new \LogicException('Stopping timer when the given key timer was not initialized.');
     }
   }
 
   /**
    * Return a list of timer names. Note that resetting a timer removes the timer.
+   *
    * @return string[]
    */
   public static function getTimers(): array {

tests/StopwatchTest.php

@@ -9,20 +9,21 @@
  * @group time-sensitive
  */
 class StopwatchTest extends TestCase {
+
   public function testTimerStoppedValueRetention(): void {
     $stopwatch = new Stopwatch();
     $stopwatch->stop();
     $time_1 = $stopwatch->read();
     $this->assertIsFloat($time_1);
     sleep(20);
     $time_2 = $stopwatch->read();
-    $this->assertIsFloat( $time_2);
+    $this->assertIsFloat($time_2);
     $this->assertSame($time_1, $time_2);
   }
 
   public function testTimerContiniuous(): void {
     $stopwatch = new Stopwatch();
-    $time_1 = $stopwatch->read();
+    $time_1    = $stopwatch->read();
     $this->assertIsFloat($time_1);
     sleep(20);
     $time_2 = $stopwatch->read();

tests/TimerFormatterTest.php

@@ -10,6 +10,7 @@
  * @group time-sensitive
  */
 class TimerFormatterTest extends TestCase {
+
   public function testTimerFormat_Human(): void {
     Timer::start(__FUNCTION__);
 

tests/TimerTest.php

@@ -17,10 +17,6 @@ public function testUnsupportedKeyType(): void {
     Timer::start(new \stdClass());
   }
 
-  private function sleepHalfSec(int $count = 1): void {
-    usleep(500000 * $count);
-  }
-
   public function testStopValuesRetained(): void {
     Timer::start(__FUNCTION__);
     Timer::stop(__FUNCTION__);
@@ -29,6 +25,10 @@ public function testStopValuesRetained(): void {
     $this->assertEquals(Timer::read(__FUNCTION__, Timer::FORMAT_PRECISE), $stopped_at);
   }
 
+  private function sleepHalfSec(int $count = 1): void {
+    usleep(500000 * $count);
+  }
+
   public function testUnstoppedValuesContinue(): void {
     Timer::start(__FUNCTION__);
     $stopped_at = Timer::read(__FUNCTION__);

tests/TimerTest2.php

@@ -10,6 +10,7 @@
  * @group time-sensitive
  */
 class TimerTest2 extends TestCase {
+
   public function testTimerDefaultRunning() {
     Timer::start();
     sleep(20);