Merge pull request #6 from manusreload/1.2.8

1.2.8

Author: manusreload

README.md

@@ -0,0 +1,147 @@
+# GLFramework
+## GestionLan PHP Framework
+
+
+- [GLFramework](#glframework)
+  - [GestionLan PHP Framework](#gestionlan-php-framework)
+    - [Tecnología utilizada en el desarrollo.](#tecnología-utilizada-en-el-desarrollo)
+    - [Creación de una aplicación.](#creación-de-una-aplicación)
+    - [Archivo "config.yml"](#archivo-configyml)
+      - [Listado de los módulos internos](#listado-de-los-módulos-internos)
+    - [Controlador](#controlador)
+    - [Vista](#vista)
+    - [Modelo](#modelo)
+      - [Ejemplo de Modelo:](#ejemplo-de-modelo)
+
+En este documento se explica el funcionamiento y como utilizar este conjunto de funciones para realizar software.
+
+
+### Tecnología utilizada en el desarrollo.
+
+Para que este framework funcione es necesario que se ejecute bajo un entorno PHP. El framework tiene varias rutas de entrada, y en función de lo que se desee hacer se utilizan unas u otras. Bajo PHP se han utilizado varias librerías gestionadas por "composer". Entre otras destacan:
+
+- Twig: Se utiliza en el renderizado de las vistas.
+- Yaml: Para los archivos de configuración.
+- AltoRouter: Para el enrutamiento de las peticiones.
+
+El framework también incluye un sistema de módulos, que junto con los eventos permiten redefinir partes de lo que ya se ha creado. Estos módulos tienen que ser habilitados por la propia aplicación en su archivo de configuración.
+
+### Creación de una aplicación.
+
+Para comenzar a crear una aplicación es necesario tener instalado "composer" (https://getcomposer.org/). Nos vamos al repositorio del código fuente (https://gitlab.com/gestionlan/framework) y nos descargamos la carpeta "example"
+
+
+### Archivo "config.yml"
+
+Manual del formato Yaml: http://symfony.com/doc/current/components/yaml/yaml_format.html
+En este archivo se define la configuración de la aplicación.
+
+
+```yaml
+app:
+  basepath: [Ruta base de la aplicación:/beta,]
+  index: [Nombre del archivo de inicio:index,home]
+  name: [Nombre de la aplicación:Demo]
+  banner: [Banner de la aplicación:/img/banner.png]
+  favicon: [Icono de navegador:/images/logo.jpg]
+
+  controllers: [Directorio de los controladores:pages,controller]
+  model: [Directorio de los modelos:model]
+  views: [Directorio de las vistas:views]
+  upload: [Directorio de subida de archivos:uploads]
+
+
+  routes: [Rutas especiales a controladores]
+    - [NombreClaseControlador]: [[URL de destino], [METODO:GET|POST,GET,POST]]
+    - MyNameSpace\home: ["/home/example/[i:id]", GET]
+    - home: ["/home/example/[i:id]", GET]
+    - sub_home: ["/home/sub/example/[i:id]"]
+
+database: [Configuración de la base de datos]
+  hostname: 127.0.0.1
+  username: root
+  password:
+  database: dbdemo
+modules: [Módulos activos para la aplicación]
+  internal: [Modulos internos de framework]
+    - admin
+    - group_permissions
+  modules:  [Modulos de la aplicación, se encuentran en la carpeta modules]
+
+```
+
+
+#### Listado de los módulos internos
+
+- admin: Conjunto de utilidades para la administración interna de la aplicación.
+- group_permissions: Añade la posibilidad de asignar páginas por grupos de usuarios
+
+
+### Controlador
+
+Para definir un controlador es necesario crear un archivo que siga un cierto patrón. Crearemos un archivo sobre una de las carpetas que hemos definido como controlador en el archivo de configuración. En este archivo vamos a definir una clase con el siguiente nombre: `[< nombre directorio >_]< nombre del archivo >` y extenderá a la clase Controller o a alguna de sus descendientes como puede ser AuthController. Podemos situarla con un espacio de nombres, el framework se encarga de detectar estos matices.
+
+### Vista
+
+La vista se programa con plantillas Twig, y existen algunas variables globales a las cuales se pueden acceder en las plantillas.
+
+- `this` Es el controlador que se esta ejecutando. Se pueden acceder a todas las propiedades públicas con `{{ this.public_var }}`
+- `config` Es un array con la configuración del framework, se puede acceder como: `{{ config.app.name }}`
+- `_GET` Array con las varibles de petición $_GET
+- `_POST` Array con las varibles de petición $_POST
+- `_REQUEST` Array con las varibles de petición $_REQUEST
+- `render` Objeto que contiene el motor de renderizado para las vistas Twig.
+- `manager` Objeto de la clase ModuleManager. Ser puede utilizar para ver si hay módulos activos: `{% if manager.exists("admin") %}`
+
+
+### Modelo
+
+Aquí se define como se tratan los datos de la base de datos. Las columnas se definen en una lista, en la que se indica el índice y los campos de la tabla. También se define el nombre de la tabla.
+
+#### Ejemplo de Modelo:
+
+```php
+class User extends Model
+{
+    var $id;
+    var $user_name;
+    var $password;
+    var $privilegios;
+    var $nombre;
+    var $email;
+    var $admin;
+    protected $table_name = "user";
+    protected $definition = array(
+        'index' => 'id',
+        'fields' => array(
+            'user_name' => "varchar(20)",
+            'password' => "varchar(200)",
+            'privilegios' => "text",
+            'admin' => "int(11)",
+            'nombre' => "text",
+            'email' => "text",
+        )
+    );
+    public function getByUserPassword($user, $password)
+    {
+        return $this->db->select_first("SELECT * FROM {$this->table_name} WHERE user_name = '$user' AND password = '$password'");
+    }
+    public function encrypt($pass)
+    {
+        return md5($pass);
+    }
+    public function getPages()
+    {
+        $pages = new Page();
+        $userPages = new UserPage();
+        $sql = "SELECT * FROM " . $userPages->getTableName() . " as up
+        LEFT JOIN {$pages->getTableName()} as p ON up.id_page = p.id
+        WHERE up.id_user = " . $this->id;
+        return $this->db->select($sql);
+    }
+}
+
+```
+
+
+Para comprobar los cambios en las tablas, acceda a http://example.com/install.php Allí se indican los cambio que se van a realizar en la base de datos. Pulse en el enlace de abajo para realizar estos cambios en la base de datos.

composer.json

@@ -20,9 +20,9 @@
   "bin": ["bin/gl"],
   "require": {
     "twig/twig": "~1.0",
-    "symfony/yaml": "^3.0",
+    "symfony/yaml": "~6.1",
     "altorouter/altorouter": "2.0.1",
-    "phpmailer/phpmailer": "~5.2",
+    "phpmailer/phpmailer": "~6.5",
     "wikimedia/composer-merge-plugin": "v2.0.0",
     "nuovo/spreadsheet-reader": "*",
     "tijsverkoyen/css-to-inline-styles": "^1.5",
@@ -37,13 +37,18 @@
     "symfony/translation": "*"
   },
   "require-dev": {
-    "phpunit/phpunit": "9.5.4"
+    "phpunit/phpunit": "^9.5"
   },
   "extra": {
     "merge-plugin": {
       "include": [
         "modules/*/composer.json"
       ]
     }
+  },
+  "config": {
+    "allow-plugins": {
+      "wikimedia/composer-merge-plugin": true
+    }
   }
 }

docu/Actualizar PHP8.md

@@ -0,0 +1,13 @@
+# Actualizar framework a la version PHP8
+
+1º Eliminar el archivo `composer.lock` para que se pueda instalar las dependencias sin restricciones.
+
+2º Instalar la última version del framework (https://github.com/manusreload/GLFramework/tags)
+
+```bash
+composer require gestionlan/framework "~1.2.8.x-dev"
+```
+
+3º Comprobar que los paquetes de nuestro proyecto están en la última versión.
+
+

documentación.odt

@@ -92,7 +92,7 @@ public function getVariables()
                 } else if(is_string($value)) {
                     $array[$item->name] = $value;
                 } else {
-                    $array[$item->name] = (string) ($value);
+                    $array[$item->name] = (string) ('object');
                 }
             }
         }

modules/debugbar/src/Collectors/ControllerCollector.php

@@ -38,7 +38,7 @@
  */
 class Bootstrap
 {
-    public static $VERSION = '0.2.7';
+    public static $VERSION = '1.2.8';
     private static $singelton;
     private static $errorLevel = 0;
     /**
@@ -550,7 +550,7 @@ public function log($message, $level = 1, $nl = true)
     /**
      * TODO
      */
-    function fatal_handler($errno, $errstr, $errfile, $errline, $errorContext)
+    function fatal_handler($errno, $errstr = null, $errfile = null, $errline = null, $errorContext = null)
     {
 
         if(!$errno) {
@@ -570,7 +570,7 @@ function fatal_handler($errno, $errstr, $errfile, $errline, $errorContext)
             }
         }
         if ($errno) {
-
+            error_log(("$errno $errstr at $errfile:$errline"));
             if ($errno === E_ERROR) {
                 Log::getInstance()->error($errstr . " " . $errfile . " " . $errline);
                 if (isset($this->config['app']['ignore_errors'])) {
@@ -581,7 +581,7 @@ function fatal_handler($errno, $errstr, $errfile, $errline, $errorContext)
 
                 if (isset($this->config['app']['debug']) && $this->config['app']['debug']) {
                     error_log(("ERROR: $errstr at $errfile:$errfile ($errno)"));
-                    ($this->format_error($errno, $errstr, $errfile, $errline));
+                    echo ($this->format_error($errno, $errstr, $errfile, $errline));
                 }
             }
         }

src/Bootstrap.php

@@ -535,7 +535,7 @@ public function getAddKey($table, $index) {
 
 
     public function getDropKey($table, $index) {
-        return "ALTER TABLE `$table` DROP INDEX `{$index['field']}`";
+        return "ALTER TABLE `$table` DROP INDEX `{$index}`";
     }
 
     public function getAddUnique($table, $field)

src/DBStructure.php

@@ -61,6 +61,11 @@ class DatabaseManager
 
     private $config;
 
+    private $enableTimerLog = false;
+
+    private $timers = [];
+
+
     /**
      * DBConnection constructor.
      *
@@ -76,6 +81,8 @@ public function __construct($config = null)
         'before' init the framework!");
 
         $this->config = $config;
+        $this->enableTimerLog = isset($this->config['database']) && isset($this->config['database']['profiler']) 
+            ? $this->config['database']['profiler'] : false ;
 //        $this->connect();
     }
 
@@ -165,31 +172,8 @@ public function connect()
             throw new \Exception(sprintf('Can not establish connection to database! {host=%s, user=%s, database=%s} Error: %s',
                         $config['database']['hostname'], $config['database']['username'], $config['database']['database'], $err));
         }
-
+        
         return false;
-
-//        if (!$this->connection) {
-//
-//            if ($conn->connect()
-//            ) {
-//                if ($conn->select_database($config['database']['database'])) {
-//                    $this->connection = $conn;
-//                    self::$selected = true;
-//                    $this->createCache();
-////
-////                    if (!defined("GL_INSTALL") || !GL_INSTALL) {
-////                        $this->checkDatabaseStructure();
-////                    }
-//                    return true;
-//                }
-//                return false;
-//            } else {
-//                $err =$conn->getLastError();
-//                throw new \Exception(sprintf('Can not establish connection to database! {host=%s, user=%s, database=%s} Error: %s',
-//                    $config['database']['hostname'], $config['database']['username'], $config['database']['database'], $err));
-//            }
-//        }
-//        return true;
     }
 
     public function connectAndSelect() {
@@ -291,10 +275,22 @@ public function select($query, $args = array(), $cache = null, $duration = null)
             if ($this->pre_cache($result, $cache)) {
                 return $result;
             }
+            $timer = null;
+            if($this->enableTimerLog) {
+                $timer = ['start' => microtime(true), 'query' => $query, 'args' => $args];
+            }
 
             Profiler::start('query', 'database');
             $result = $this->connection->select($query, $args, true);
             Profiler::stop('query');
+
+            if($this->enableTimerLog) {
+                $timer['end']  = microtime(true);
+                $timer['duration'] = $timer['end'] - $timer['start'];
+                $timer['results'] = count($result);
+                $this->timers[] = $timer;
+            }
+
             return $this->cache($result, $cache, $duration);
         }
         throw new \Exception('Database connection is not open!');
@@ -496,4 +492,8 @@ public function sql_to_int($col_name)
     public function date_style() {
         return "Y-m-d";
     }
+
+    public function getTimers() {
+        return $this->timers;
+    }
 }