Dev 2.0

.gitignore

@@ -15,6 +15,7 @@ config/routing/*
 composer.phar
 composer.lock
 .vscode
+.idea
 public/*
 !public/index.php
 !public/console.php

config/config-example_mysql.json

@@ -1,8 +1,8 @@
 {
     "ROUTING_METHOD": "JSON",
     "FILE_STORAGE_MODE":"DB",
-    "DEFAULT_RIGHTS": "QN_R_CREATE | QN_R_READ | QN_R_DELETE | QN_R_WRITE",
-    "DEBUG_MODE": "QN_MODE_PHP | QN_MODE_ORM | QN_MODE_SQL",
+    "DEFAULT_RIGHTS": "EQ_R_CREATE | EQ_R_READ | EQ_R_DELETE | EQ_R_WRITE",
+    "DEBUG_MODE": "EQ_MODE_API | EQ_MODE_PHP | EQ_MODE_ORM | EQ_MODE_SQL",
     "DEBUG_LEVEL": "E_ALL | E_ALL",
     "DEFAULT_LANG": "en",
     "DB_REPLICATION": "NO",

config/config-example_sqlsrv.json

@@ -2,8 +2,8 @@
     "CIPHER_KEY": "xxxxxxxxxxxxxxxxxxxxxxxx",
     "ROUTING_METHOD": "JSON",
     "FILE_STORAGE_MODE":"DB",
-    "DEFAULT_RIGHTS": "QN_R_CREATE | QN_R_READ | QN_R_DELETE | QN_R_WRITE",
-    "DEBUG_MODE": "QN_MODE_PHP | QN_MODE_ORM | QN_MODE_SQL",
+    "DEFAULT_RIGHTS": "EQ_R_CREATE | EQ_R_READ | EQ_R_DELETE | EQ_R_WRITE",
+    "DEBUG_MODE": "EQ_MODE_PHP | EQ_MODE_ORM | EQ_MODE_SQL",
     "DEBUG_LEVEL": "E_ALL | E_ALL",
     "DEFAULT_LANG": "en",
     "DB_REPLICATION": "NO",

config/schema.json

@@ -15,7 +15,7 @@
     },
     "DEFAULT_LANG": {
         "type": "string",
-        "description": "The language in which the multilang content must be provided/stored by default (ISO 639-1).",
+        "description": "The language (ISO 639-1) in which the multilang content must be provided/stored by default.",
         "instant": true,
         "default": "en"
     },
@@ -50,8 +50,8 @@
         "default": 0,
         "examples": [
             0,
-            "QN_R_READ | QN_R_WRITE",
-            "QN_R_CREATE | QN_R_READ | QN_R_DELETE | QN_R_WRITE | QN_R_MANAGE"
+            "EQ_R_READ | EQ_R_WRITE",
+            "EQ_R_CREATE | EQ_R_READ | EQ_R_DELETE | EQ_R_WRITE | EQ_R_MANAGE"
         ]
     },
     "DEBUG_MODE": {
@@ -60,16 +60,18 @@
         "instant": true,
         "default": 0,
         "examples": [
-            "QN_MODE_PHP | QN_MODE_ORM | QN_MODE_SQL | QN_MODE_APP | QN_MODE_API"
+            "EQ_MODE_PHP | EQ_MODE_ORM | EQ_MODE_SQL | EQ_MODE_APP | EQ_MODE_API | EQ_MODE_AAA | EQ_MODE_NET"
         ]
     },
     "DEBUG_LEVEL": {
         "type": "integer",
-        "description": "Types of error to report (defaults to E_ALL = 32767, setting to 0 means no logs). Important: if logging level is set to E_ALL with all mode enabled, then the log file will grow quickly.",
+        "description": "Types of error to report (defaults to E_ALL = 32767, setting to 0 means no logs). Important: if logging level is set to E_ALL with all mode enabled, then the log file grows quite quickly.",
         "instant": true,
         "default": 0,
         "examples": [
-            "QN_REPORT_DEBUG | QN_REPORT_INFO | QN_REPORT_WARNING | QN_REPORT_ERROR | QN_REPORT_FATAL"
+            "EQ_REPORT_DEBUG | EQ_REPORT_INFO | EQ_REPORT_WARNING | EQ_REPORT_ERROR | EQ_REPORT_FATAL",
+            "EQ_REPORT_INFO | EQ_REPORT_WARNING | EQ_REPORT_ERROR",
+            "EQ_REPORT_DEBUG & E_ALL"
         ]
     },
     "HTTP_REQUEST_TIMEOUT": {
@@ -282,8 +284,12 @@
     },
     "USER_ACCOUNT_DISPLAYNAME": {
         "type": "string",
-        "description": "Strategy for displaying the user name to other users. The expected value is a string holding one or more of following references: 'id', 'nickname', 'mail', 'givenname', 'surname', 'initials' (Note: 'mail' is the email address and suits Apps restricted to users from a same organisation but should be avoided for non public profiles).",
-        "default": "mail"
+        "description": "Strategy for displaying the user name to other users. The expected value is a string holding one or more of following references: 'id', 'nickname', 'mail', 'firstname', 'lastname', 'initials' (Note: 'mail' is the email address and suits Apps restricted to users from a same organisation but should be avoided for non public profiles).",
+        "default": "mail",
+        "examples": [
+            "nickname",
+            "firstname lastname"
+        ]
     },
     "USER_ACCOUNT_REGISTRATION": {
         "type": "boolean",

lib/equal/db/DBConnection.class.php

@@ -1,139 +1,41 @@
 <?php
 /*
-    This file is part of the eQual framework <http://www.github.com/cedricfrancoys/equal>
-    Some Rights Reserved, Cedric Francoys, 2010-2021
-    Licensed under GNU LGPL 3 license <http://www.gnu.org/licenses/>
+    This file is part of the eQual framework <http://www.github.com/equalframework/equal>
+    Some Rights Reserved, eQual framework, 2010-2024
+    Original author(s): Cédric FRANCOYS
+    License: GNU LGPL 3 license <http://www.gnu.org/licenses/>
 */
 namespace equal\db;
 
-use equal\organic\Service;
 
 /**
- * Service implementing factory pattern for DBManipulator instances.
+ * This class uses factory pattern for providing DBManipulator instances.
  */
-class DBConnection extends Service {
+class DBConnection {
 
-    /**
-     * @var DBManipulator
-     */
-    private $dbConnection;
+    public static function create(string $dbms='', string $host='', int $port=null, string $name='', string $user='', string $password='', string $charset='', string $collation='') {
+        /** @var DBManipulator */
+        $dbConnection = null;
 
-    protected function __construct() {
-        switch(constant('DB_DBMS')) {
+        switch($dbms) {
             case 'MARIADB':
             case 'MYSQL' :
-                $this->dbConnection = new DBManipulatorMySQL(
-                        constant('DB_HOST'),
-                        constant('DB_PORT'),
-                        constant('DB_NAME'),
-                        constant('DB_USER'),
-                        constant('DB_PASSWORD'),
-                        constant('DB_CHARSET'),
-                        constant('DB_COLLATION')
-                    );
+                $dbConnection = new DBManipulatorMySQL($host, $port, $name, $user, $password, $charset, $collation);
                 break;
             case 'SQLSRV' :
-                $this->dbConnection = new DBManipulatorSqlSrv(
-                        constant('DB_HOST'),
-                        constant('DB_PORT'),
-                        constant('DB_NAME'),
-                        constant('DB_USER'),
-                        constant('DB_PASSWORD'),
-                        constant('DB_CHARSET'),
-                        constant('DB_COLLATION')
-                    );
+                $dbConnection = new DBManipulatorSqlSrv($host, $port, $name, $user, $password, $charset, $collation);
                 break;
             case 'SQLITE' :
-                $this->dbConnection = new DBManipulatorSQLite(
-                        constant('DB_HOST'),
-                        constant('DB_PORT'),
-                        constant('DB_NAME'),
-                        constant('DB_USER'),
-                        constant('DB_PASSWORD'),
-                        constant('DB_CHARSET'),
-                        constant('DB_COLLATION')
-                    );
+                $dbConnection = new DBManipulatorSQLite($host, $port, $name, $user, $password, $charset, $collation);
                 break;
             case 'POSTGRESQL' :
                 // #todo
                 break;
             case 'ORACLE' :
                 // #todo
                 break;
-            default:
-                $this->dbConnection = null;
         }
-
-        if(defined('DB_REPLICATION') && constant('DB_REPLICATION') != 'NO') {
-            // add replica members, if any
-            $i = 1;
-
-            while(defined('DB_'.$i.'_HOST')
-                && defined('DB_'.$i.'_PORT')
-                && defined('DB_'.$i.'_USER')
-                && defined('DB_'.$i.'_PASSWORD')
-                && defined('DB_'.$i.'_NAME')) {
-
-                $this->addReplicaMember(
-                    constant('DB_'.$i.'_HOST'),
-                    constant('DB_'.$i.'_PORT'),
-                    constant('DB_'.$i.'_NAME'),
-                    constant('DB_'.$i.'_USER'),
-                    constant('DB_'.$i.'_PASSWORD')
-                );
-                ++$i;
-            }
-        }
-    }
-
-    public static function constants() {
-        return ['DB_HOST', 'DB_PORT', 'DB_NAME', 'DB_USER', 'DB_PASSWORD', 'DB_DBMS', 'DB_CHARSET', 'DB_COLLATION'];
-    }
-
-    public function addReplicaMember($host, $port, $db, $user, $pass) {
-        $member = null;
-        switch(constant('DB_DBMS')) {
-            case 'MYSQL' :
-                $member = new DBManipulatorMySQL($host, $port, $db, $user, $pass);
-                break;
-            /*
-            // insert handling of other DBMS here
-            case 'XYZ' :
-                $this->dbConnection = new DBManipulatorXyz(DB_HOST, DB_PORT, DB_NAME, DB_USER, DB_PASSWORD);
-                break;
-            */
-            default:
-                break;
-        }
-        if($member && $this->dbConnection) {
-            $this->dbConnection->addMember($member);
-        }
-    }
-
-    public function connect($auto_select=true) {
-        if(!isset($this->dbConnection)) return false;
-        return $this->dbConnection->connect($auto_select);
-    }
-
-    public function disconnect() {
-        if(!isset($this->dbConnection)) return true;
-        return $this->dbConnection->disconnect();
-    }
-
-    /**
-     * Magic overloading method: catch any call and relay it to DBConnection object
-     *
-     * @param  string                 $name
-     * @param  array                  $arguments
-     * @return mixed
-     */
-    public function __call($name, $arguments) {
-
-        if (!$this->dbConnection) {
-            return null;
-        }
-
-        return call_user_func_array([$this->dbConnection, $name], $arguments);
+        return $dbConnection;
     }
 
 }

lib/equal/db/DBConnector.class.php

@@ -0,0 +1,89 @@
+<?php
+/*
+    This file is part of the eQual framework <http://www.github.com/equalframework/equal>
+    Some Rights Reserved, eQual framework, 2010-2024
+    Original author(s): Cédric FRANCOYS
+    License: GNU LGPL 3 license <http://www.gnu.org/licenses/>
+*/
+namespace equal\db;
+
+use equal\organic\Service;
+
+/**
+ * Service for connecting to the DBMS holding the database of the current installation.
+ * This service acts as a facade for DB interactions.
+ */
+class DBConnector extends Service {
+
+    /** @var DBManipulator */
+    private $connection;
+
+    public static function constants() {
+        return ['DB_DBMS', 'DB_HOST', 'DB_PORT', 'DB_NAME', 'DB_USER', 'DB_PASSWORD', 'DB_CHARSET', 'DB_COLLATION'];
+    }
+
+    protected function __construct() {
+        $this->connection = DBConnection::create(
+                constant('DB_DBMS'),
+                constant('DB_HOST'),
+                constant('DB_PORT'),
+                constant('DB_NAME'),
+                constant('DB_USER'),
+                constant('DB_PASSWORD'),
+                constant('DB_CHARSET'),
+                constant('DB_COLLATION')
+            );
+
+        if(defined('DB_REPLICATION') && constant('DB_REPLICATION') != 'NO') {
+            // add replica members, if any
+            $i = 1;
+
+            while(defined('DB_'.$i.'_HOST')
+                && defined('DB_'.$i.'_PORT')
+                && defined('DB_'.$i.'_USER')
+                && defined('DB_'.$i.'_PASSWORD')
+                && defined('DB_'.$i.'_NAME')) {
+
+                $this->addReplicaMember(
+                    constant('DB_'.$i.'_HOST'),
+                    constant('DB_'.$i.'_PORT'),
+                    constant('DB_'.$i.'_NAME'),
+                    constant('DB_'.$i.'_USER'),
+                    constant('DB_'.$i.'_PASSWORD')
+                );
+                ++$i;
+            }
+        }
+    }
+
+    public function addReplicaMember($host, $port, $db, $user, $pass) {
+        /** @var DBManipulator */
+        $member = DBConnection::create(constant('DB_DBMS'), $host, $port, $db, $user, $pass);
+        if($member && $this->connection) {
+            $this->connection->addMember($member);
+        }
+    }
+
+    public function connect($auto_select=true) {
+        return isset($this->connection)?$this->connection->connect($auto_select):false;
+    }
+
+    public function disconnect() {
+        return !isset($this->connection) || $this->connection->disconnect();
+    }
+
+    /**
+     * Magic overloading method: catch any call and relay it to DBManipulator object
+     *
+     * @param  string                 $name
+     * @param  array                  $arguments
+     * @return mixed
+     */
+    public function __call($name, $arguments) {
+        if (!$this->connection) {
+            return null;
+        }
+        return call_user_func_array([$this->connection, $name], $arguments);
+    }
+
+}