twistofreality / dilmun

src/Nabu/LoggerHandler/File.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
     }
 
     /**
-     * @return null|string  The file_path set for the File instance
+     * @return string  The file_path set for the File instance
      */
     public function getFilePath()
     {

Spacing +2 added lines, -2 removed lines

@@ -176,7 +176,7 @@ 
         $full_file = "";
 
         if (isset($this->file_path)) {
-            $full_file = $this->file_path . DIRECTORY_SEPARATOR;
+            $full_file = $this->file_path.DIRECTORY_SEPARATOR;
         }
 
         $full_file .= $this->file_name;
@@ -230,7 +230,7 @@ 
 
             if ($locked) {
                 $now = date('Y-m-d H:i:s');
-                $this->file_pointer->fwrite("$now : $message" . "\r\n");
+                $this->file_pointer->fwrite("$now : $message"."\r\n");
                 $this->file_pointer->flock(LOCK_UN);
 
                 return true;

app/config/app_constants.php

Spacing +6 added lines, -6 removed lines

@@ -2,29 +2,29 @@
 /**
  * @const DILMUN_BASE_DIR The base directory at which Dilmun resides
  */
-define('DILMUN_BASE_DIR', dirname(dirname(dirname(__FILE__))) . "/");
+define('DILMUN_BASE_DIR', dirname(dirname(dirname(__FILE__)))."/");
 
 /**
  * @const DILMUN_SOURCE_DIR The source directory
  */
-define('DILMUN_SOURCE_DIR', DILMUN_BASE_DIR . "src/");
+define('DILMUN_SOURCE_DIR', DILMUN_BASE_DIR."src/");
 
 /**
  * @const DILMUN_VENDOR_DIR The vendor directory
  */
-define('DILMUN_VENDOR_DIR', DILMUN_BASE_DIR . "vendor/");
+define('DILMUN_VENDOR_DIR', DILMUN_BASE_DIR."vendor/");
 
 /**
  * @const DILMUN_LOGS_DIR The log directory
  */
-define('DILMUN_LOGS_DIR', DILMUN_BASE_DIR . "app/logs/");
+define('DILMUN_LOGS_DIR', DILMUN_BASE_DIR."app/logs/");
 
 /**
  * @const DILMUN_CONFIG_DIR The configurations directory
  */
-define('DILMUN_CONFIG_DIR', DILMUN_BASE_DIR . "app/config/");
+define('DILMUN_CONFIG_DIR', DILMUN_BASE_DIR."app/config/");
 
 /**
  * @const DILMUN_TEST_DIR The tests directory
  */
-define('DILMUN_TEST_DIR', DILMUN_BASE_DIR . "tests/");
+define('DILMUN_TEST_DIR', DILMUN_BASE_DIR."tests/");

src/Nabu/StaticLogger.php

Spacing +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
         $replace = array();
 
         foreach ($context as $key => $value) {
-            $templated = "{" . $key . "}";
+            $templated = "{".$key."}";
             $replace[$templated] = $value;
         }
 

src/Nabu/Autoloader.php

Upper-Lower-Casing +3 added lines, -3 removed lines

@@ -42,7 +42,7 @@ 
      */
     public function registerPackages($package, $path)
     {
-        $this->logger->info("Preparing {$package} package for registration.");
+        $this->logger->info("preparing {$package} package for registration.");
         $this->logger->debug("Parameters: package = {$package}, path = {$path}");
 
         $package = trim($package, "\\");
@@ -125,7 +125,7 @@ 
                 $this->logger->debug("Set up class path as {$class_path}");
 
                 if (file_exists($class_path)) {
-                    $this->logger->debug("File {$class_path} exists");
+                    $this->logger->debug("file {$class_path} exists");
 
                     $this->logger->debug("Including " . $class_path);
                     /** @noinspection PhpIncludeInspection */
@@ -135,7 +135,7 @@ 
 
                     $this->logger->info("Completed loading {$path_loaded}");
                 } else {
-                    $this->logger->debug("File {$class_path} does not exist given {$package_name} package");
+                    $this->logger->debug("file {$class_path} does not exist given {$package_name} package");
 
                     $path_loaded = false;
                 }

Spacing +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
      */
     public function register()
     {
-        spl_autoload_register(array($this,"includeClass"));
+        spl_autoload_register(array($this, "includeClass"));
     }
 
     /**
@@ -46,10 +46,10 @@ 
         $this->logger->debug("Parameters: package = {$package}, path = {$path}");
 
         $package = trim($package, "\\");
-        $package = $package . "\\";
+        $package = $package."\\";
 
         $path = rtrim($path, "/");
-        $path = $path . "/";
+        $path = $path."/";
 
         $this->logger->debug("Registering index {$package} with {$path}");
         $this->packages[$package][] = $path;
@@ -118,14 +118,14 @@ 
 
             foreach ($this->packages[$package_name] as $path) {
                 $converted_class = str_replace('\\', '/', $class_name);
-                $class_path      = $path . $converted_class . ".php";
+                $class_path      = $path.$converted_class.".php";
 
                 $this->logger->debug("Set up class path as {$class_path}");
 
                 if (file_exists($class_path)) {
                     $this->logger->debug("File {$class_path} exists");
 
-                    $this->logger->debug("Including " . $class_path);
+                    $this->logger->debug("Including ".$class_path);
                     /** @noinspection PhpIncludeInspection */
                     include $class_path;
 

app/bootstrap.php

Spacing +7 added lines, -7 removed lines

@@ -4,18 +4,18 @@
  */
 
 require "config/app_constants.php";
-require DILMUN_VENDOR_DIR . "autoload.php";
-require DILMUN_SOURCE_DIR . "Nabu/Autoloader.php";
+require DILMUN_VENDOR_DIR."autoload.php";
+require DILMUN_SOURCE_DIR."Nabu/Autoloader.php";
 
 /**
  * @todo Pull this out somehow so that logging on bootstrap is more abstract
  */
 //Pre-load logger classes for autoloader logging!
-require DILMUN_SOURCE_DIR . "Nabu/Logger.php";
-require DILMUN_SOURCE_DIR . "Nabu/StaticLogger.php";
-require DILMUN_SOURCE_DIR . "Nabu/LoggerHandler/HandlerInterface.php";
-require DILMUN_SOURCE_DIR . "Nabu/LoggerHandler/File.php";
-require DILMUN_SOURCE_DIR . "Nabu/LoggerHandler/System.php";
+require DILMUN_SOURCE_DIR."Nabu/Logger.php";
+require DILMUN_SOURCE_DIR."Nabu/StaticLogger.php";
+require DILMUN_SOURCE_DIR."Nabu/LoggerHandler/HandlerInterface.php";
+require DILMUN_SOURCE_DIR."Nabu/LoggerHandler/File.php";
+require DILMUN_SOURCE_DIR."Nabu/LoggerHandler/System.php";
 
 use Subreality\Dilmun\Nabu\Autoloader;
 

src/Nabu/LoggerHandler/HandlerInterface.php

Doc Comments +9 added lines

@@ -9,6 +9,9 @@ 
  */
 interface HandlerInterface
 {
+    /**
+     * @return boolean
+     */
     public function initialize();
 
     /**
@@ -17,7 +20,13 @@ 
      */
     public function write($message);
 
+    /**
+     * @return void
+     */
     public function suppressOutput();
 
+    /**
+     * @return void
+     */
     public function allowOutput();
 }