From 3c66e56435359dc678048193e8ee239d06f79b64 Mon Sep 17 00:00:00 2001
From: VirtualTam <virtualtam@flibidi.net>
Date: Fri, 3 Mar 2017 23:06:12 +0100
Subject: application: introduce the Shaarli\Config namespace

Namespaces have been introduced with the REST API, and should be generalized
to the whole codebase to manage object scope and benefit from autoloading.

See:
- https://secure.php.net/manual/en/language.namespaces.php
- http://www.php-fig.org/psr/psr-4/

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
---
 application/Updater.php              |  2 ++
 application/api/ApiMiddleware.php    |  2 +-
 application/config/ConfigIO.php      |  1 +
 application/config/ConfigJson.php    |  5 +++--
 application/config/ConfigManager.php | 16 ++++++----------
 application/config/ConfigPhp.php     |  3 ++-
 application/config/ConfigPlugin.php  |  4 +++-
 7 files changed, 18 insertions(+), 15 deletions(-)

(limited to 'application')

diff --git a/application/Updater.php b/application/Updater.php
index f5ebf31a..27cb2f0a 100644
--- a/application/Updater.php
+++ b/application/Updater.php
@@ -1,4 +1,6 @@
 <?php
+use Shaarli\Config\ConfigJson;
+use Shaarli\Config\ConfigPhp;
 
 /**
  * Class Updater.
diff --git a/application/api/ApiMiddleware.php b/application/api/ApiMiddleware.php
index 522091ca..4120f7a9 100644
--- a/application/api/ApiMiddleware.php
+++ b/application/api/ApiMiddleware.php
@@ -1,9 +1,9 @@
 <?php
-
 namespace Shaarli\Api;
 
 use Shaarli\Api\Exceptions\ApiException;
 use Shaarli\Api\Exceptions\ApiAuthorizationException;
+
 use Slim\Container;
 use Slim\Http\Request;
 use Slim\Http\Response;
diff --git a/application/config/ConfigIO.php b/application/config/ConfigIO.php
index be78b1c7..3efe5b6f 100644
--- a/application/config/ConfigIO.php
+++ b/application/config/ConfigIO.php
@@ -1,4 +1,5 @@
 <?php
+namespace Shaarli\Config;
 
 /**
  * Interface ConfigIO
diff --git a/application/config/ConfigJson.php b/application/config/ConfigJson.php
index 6b5d73f1..30908d90 100644
--- a/application/config/ConfigJson.php
+++ b/application/config/ConfigJson.php
@@ -1,4 +1,5 @@
 <?php
+namespace Shaarli\Config;
 
 /**
  * Class ConfigJson (ConfigIO implementation)
@@ -21,7 +22,7 @@ class ConfigJson implements ConfigIO
         $data = json_decode($data, true);
         if ($data === null) {
             $error = json_last_error();
-            throw new Exception('An error occurred while parsing JSON file: error code #'. $error);
+            throw new \Exception('An error occurred while parsing JSON file: error code #'. $error);
         }
         return $data;
     }
@@ -35,7 +36,7 @@ class ConfigJson implements ConfigIO
         $print = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0;
         $data = self::getPhpHeaders() . json_encode($conf, $print) . self::getPhpSuffix();
         if (!file_put_contents($filepath, $data)) {
-            throw new IOException(
+            throw new \IOException(
                 $filepath,
                 'Shaarli could not create the config file.
                 Please make sure Shaarli has the right to write in the folder is it installed in.'
diff --git a/application/config/ConfigManager.php b/application/config/ConfigManager.php
index a401887c..679a75b3 100644
--- a/application/config/ConfigManager.php
+++ b/application/config/ConfigManager.php
@@ -1,9 +1,5 @@
 <?php
-
-// FIXME! Namespaces...
-require_once 'ConfigIO.php';
-require_once 'ConfigJson.php';
-require_once 'ConfigPhp.php';
+namespace Shaarli\Config;
 
 /**
  * Class ConfigManager
@@ -124,12 +120,12 @@ class ConfigManager
      * @param bool   $write      Write the new setting in the config file, default false.
      * @param bool   $isLoggedIn User login state, default false.
      *
-     * @throws Exception Invalid
+     * @throws \Exception Invalid
      */
     public function set($setting, $value, $write = false, $isLoggedIn = false)
     {
         if (empty($setting) || ! is_string($setting)) {
-            throw new Exception('Invalid setting key parameter. String expected, got: '. gettype($setting));
+            throw new \Exception('Invalid setting key parameter. String expected, got: '. gettype($setting));
         }
 
         // During the ConfigIO transition, map legacy settings to the new ones.
@@ -177,7 +173,7 @@ class ConfigManager
      *
      * @throws MissingFieldConfigException: a mandatory field has not been provided in $conf.
      * @throws UnauthorizedConfigException: user is not authorize to change configuration.
-     * @throws IOException: an error occurred while writing the new config file.
+     * @throws \IOException: an error occurred while writing the new config file.
      */
     public function write($isLoggedIn)
     {
@@ -366,7 +362,7 @@ class ConfigManager
 /**
  * Exception used if a mandatory field is missing in given configuration.
  */
-class MissingFieldConfigException extends Exception
+class MissingFieldConfigException extends \Exception
 {
     public $field;
 
@@ -385,7 +381,7 @@ class MissingFieldConfigException extends Exception
 /**
  * Exception used if an unauthorized attempt to edit configuration has been made.
  */
-class UnauthorizedConfigException extends Exception
+class UnauthorizedConfigException extends \Exception
 {
     /**
      * Construct exception.
diff --git a/application/config/ConfigPhp.php b/application/config/ConfigPhp.php
index d7fd4baf..2633824d 100644
--- a/application/config/ConfigPhp.php
+++ b/application/config/ConfigPhp.php
@@ -1,4 +1,5 @@
 <?php
+namespace Shaarli\Config;
 
 /**
  * Class ConfigPhp (ConfigIO implementation)
@@ -115,7 +116,7 @@ class ConfigPhp implements ConfigIO
         if (!file_put_contents($filepath, $configStr)
             || strcmp(file_get_contents($filepath), $configStr) != 0
         ) {
-            throw new IOException(
+            throw new \IOException(
                 $filepath,
                 'Shaarli could not create the config file.
                 Please make sure Shaarli has the right to write in the folder is it installed in.'
diff --git a/application/config/ConfigPlugin.php b/application/config/ConfigPlugin.php
index cb0b6fce..61a594d3 100644
--- a/application/config/ConfigPlugin.php
+++ b/application/config/ConfigPlugin.php
@@ -1,4 +1,6 @@
 <?php
+namespace Shaarli\Config;
+
 /**
  * Plugin configuration helper functions.
  *
@@ -112,7 +114,7 @@ function load_plugin_parameter_values($plugins, $conf)
 /**
  * Exception used if an error occur while saving plugin configuration.
  */
-class PluginConfigOrderException extends Exception
+class PluginConfigOrderException extends \Exception
 {
     /**
      * Construct exception.
-- 
cgit v1.2.3