Revisión dummy de estilo y formato de código en directorio 'core'.

Author: estebandelaf

Doxyfile

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * SowerPHP: Simple and Open Web Ecosystem Reimagined for PHP.
  * Copyright (C) SowerPHP <https://www.sowerphp.org>

config/layers.php

@@ -35,17 +35,6 @@
  */
 class Controller_Usuarios extends \sowerphp\autoload\Controller_Model
 {
-
-    protected $columnsView = [
-        'listar' => [
-            'id',
-            'nombre',
-            'usuario',
-            'email',
-            'activo',
-            'ultimo_ingreso_fecha_hora',
-        ],
-    ]; ///< Columnas que se deben mostrar en las vistas
     protected $deleteRecord = false; ///< Indica si se permite o no borrar registros
     protected $changeUsername = true; ///< Indica si se permite que se cambie el nombre de usuario
 

src/app/Module/Sistema/Module/Usuarios/Controller/Usuarios.php

@@ -34,7 +34,6 @@
  */
 class Model_Usuario extends Model implements Authenticatable
 {
-
     /**
      * Metadatos del modelo.
      *
@@ -197,9 +196,19 @@ class Model_Usuario extends Model implements Authenticatable
         ],
     ];
 
-    // atributos para caché
-    protected $groups = null; ///< Grupos a los que pertenece el usuario
-    protected $auths = null; ///< Permisos que tiene el usuario
+    /**
+     * Grupos a los que pertenece el usuario.
+     *
+     * @var array
+     */
+    protected $groups = null;
+
+    /**
+     * Permisos que tiene el usuario.
+     *
+     * @var array
+     */
+    protected $auths = null;
 
     /**
      * Obtiene el usuario solicitado.
@@ -210,9 +219,11 @@ class Model_Usuario extends Model implements Authenticatable
     protected function retrieve(array $id, array $options = []): ?stdClass
     {
         $realId = $this->getPluralInstance()->getIdFromCredentials($id);
+
         if ($realId === null) {
             return null;
         }
+
         return parent::retrieve(['id' => $realId]);
     }
 
@@ -242,7 +253,7 @@ protected function retrieve(array $id, array $options = []): ?stdClass
 
     /**
      * Método que revisa si el nombre de usuario ya existe en la base de datos.
-     * @return bool =true si el nombre de usuario ya existe.
+     * @return bool `true` si el nombre de usuario ya existe.
      */
     public function checkIfUserAlreadyExists(): bool
     {
@@ -269,7 +280,7 @@ public function checkIfUserAlreadyExists(): bool
     /**
      * Método que revisa si el email ya existe en la base de datos.
      *
-     * @return bool =true si el correo ya existe.
+     * @return bool `true` si el correo ya existe.
      */
     public function checkIfEmailAlreadyExists(): bool
     {
@@ -295,7 +306,7 @@ public function checkIfEmailAlreadyExists(): bool
 
     /**
      * Método que revisa si el hash del usuario ya existe en la base de datos.
-     * @return bool =true si el hash ya existe.
+     * @return bool `true` si el hash ya existe.
      */
     public function checkIfHashAlreadyExists(): bool
     {
@@ -324,7 +335,7 @@ public function checkIfHashAlreadyExists(): bool
      *
      * @param string $new Contraseña nueva en texto plano.
      * @param string|null $old Contraseña actual en texto plano.
-     * @return bool =true si la contraseña pudo ser cambiada.
+     * @return bool `true` si la contraseña pudo ser cambiada.
      */
     public function savePassword(string $new, string $old = null): bool
     {
@@ -335,7 +346,7 @@ public function savePassword(string $new, string $old = null): bool
      * Método que cambia la contraseña del usuario en la base de datos.
      *
      * @param string $new Contraseña nueva en texto plano.
-     * @return bool =true si la contraseña pudo ser cambiada.
+     * @return bool `true` si la contraseña pudo ser cambiada.
      */
     private function savePasswordLocal(string $new): bool
     {
@@ -368,7 +379,7 @@ public function hashPassword(string $password): string
      * del usuario almacenada en la base de datos.
      *
      * @param string $password Contrasela que se desea verificar.
-     * @return bool =true si la contraseña coincide con la de la base de datos.
+     * @return bool `true` si la contraseña coincide con la de la base de datos.
      */
     public function checkPassword(string $password): bool
     {
@@ -385,7 +396,7 @@ public function checkPassword(string $password): bool
     /**
      * Método que indica si el usuario está o no activo.
      *
-     * @return bool =true si el usuario está activo.
+     * @return bool `true` si el usuario está activo.
      */
     public function isActive(): bool
     {
@@ -495,7 +506,7 @@ public function inGroup($grupos = []): int
      * que están en la consulta.
      *
      * @param array $grupos Arreglo con los grupos que se desean revisar.
-     * @return bool =true si pertenece a todos los grupos que se solicitaron.
+     * @return bool `true` si pertenece a todos los grupos que se solicitaron.
      */
     public function inAllGroups(array $grupos = []): bool
     {
@@ -625,7 +636,7 @@ public function setAuths(array $auths = []): void
      * Método que verifica si el usuario tiene permiso para acceder a cierto
      * recurso.
      *
-     * @return bool =true si tiene permiso.
+     * @return bool `true` si tiene permiso.
      */
     public function auth($recurso): bool
     {
@@ -709,7 +720,7 @@ public function getAuth2()
      * Método que crea el token para el usuario.
      *
      * @param array $data Datos que se usarán para crear el token.
-     * @return bool =true si el token pudo ser creado.
+     * @return bool `true` si el token pudo ser creado.
      */
     public function createAuth2(array $data = []): bool
     {
@@ -722,7 +733,7 @@ public function createAuth2(array $data = []): bool
     /**
      * Método que destruye el token en la autorización secundaria.
      *
-     * @return bool =true si el token pudo ser destruído.
+     * @return bool `true` si el token pudo ser destruído.
      */
     public function destroyAuth2(array $data = []): bool
     {
@@ -736,7 +747,7 @@ public function destroyAuth2(array $data = []): bool
      * Método que valida el estado de todas las autorizaciones secundarias
      * que el usuario pudiese tener habilitadas.
      *
-     * @return bool =true si todo está ok o Exception con el error si falla.
+     * @return bool `true` si todo está ok o Exception con el error si falla.
      */
     public function checkAuth2($token): bool
     {

src/app/Module/Sistema/Module/Usuarios/Model/Usuario.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * SowerPHP: Simple and Open Web Ecosystem Reimagined for PHP.
  * Copyright (C) SowerPHP <https://www.sowerphp.org>
@@ -33,7 +35,6 @@
  */
 class Adapter_CacheItemPool implements CacheItemPoolInterface
 {
-
     /**
      * El repositorio de caché de Illuminate.
      *
@@ -60,6 +61,7 @@ public function __construct(CacheRepository $cache)
     public function getItem($key): CacheItemInterface
     {
         $value = $this->cache->get($key);
+
         return new CacheItem($key, $value, $value !== null);
     }
 
@@ -75,6 +77,7 @@ public function getItems(array $keys = array()): iterable
         foreach ($keys as $key) {
             $items[$key] = $this->getItem($key);
         }
+
         return $items;
     }
 
@@ -124,6 +127,7 @@ public function deleteItems(array $keys): bool
         foreach ($keys as $key) {
             $this->deleteItem($key);
         }
+
         return true;
     }
 
@@ -140,6 +144,7 @@ public function save(CacheItemInterface $item): bool
             ? $item->getExpiresAt()->getTimestamp() - time()
             : null
         ;
+
         return $this->cache->put($item->getKey(), $item->get(), $expiration);
     }
 
@@ -167,15 +172,13 @@ public function commit(): bool
         // Implementación de commit si es necesario.
         return true;
     }
-
 }
 
 /**
  * Representa un ítem de la caché.
  */
 class CacheItem implements CacheItemInterface
 {
-
     /**
      * La clave del ítem de la caché.
      *
@@ -303,5 +306,4 @@ public function getExpiresAt()
     {
         return $this->expiresAt;
     }
-
 }

src/core/Adapter/CacheItemPool.php

@@ -24,7 +24,6 @@
 namespace sowerphp\core;
 
 use Illuminate\Container\Container;
-use stdClass;
 
 /**
  * Clase principal de la aplicación.
@@ -36,7 +35,6 @@
  */
 class App
 {
-
     /**
      * Instancia única de la clase App.
      *
@@ -86,8 +84,8 @@ class App
     ];
 
     /**
-     * Servicios cuando la aplicación se ejecuta en modo HTTP que son
-     * cargados por defecto.
+     * Servicios cuando la aplicación se ejecuta en modo HTTP que son cargados
+     * por defecto.
      *
      * @var array
      */
@@ -147,6 +145,7 @@ public static function getInstance(?string $type = null, bool $fullBoot = true):
                 return null;
             }
         }
+
         return self::$instance;
     }
 
@@ -162,6 +161,7 @@ protected function setType(?string $type = null): string
         } else {
             $this->type = php_sapi_name() === 'cli' ? 'console' : 'http';
         }
+
         return $this->type;
     }
 
@@ -188,6 +188,7 @@ public function run(): int
         } catch (\Throwable $throwable) {
             $result = $kernel->handleThrowable($throwable);
         }
+
         return $result;
     }
 
@@ -225,6 +226,7 @@ public function getService(string $key, array $parameters = [])
                 $key
             ));
         }
+
         return $this->container->make($key, $parameters);
     }
 
@@ -249,6 +251,7 @@ protected function handleThrowable(\Throwable $throwable): int
         $file = $throwable->getFile();
         $line = $throwable->getLine();
         $trace = $throwable->getTraceAsString();
+
         // Armar mensaje con el detalle del error o excepción.
         $error = sprintf(
             'Se capturó %s (%s de nivel %s):' . "\n\n"
@@ -258,6 +261,7 @@ protected function handleThrowable(\Throwable $throwable): int
                 . '%s'
             , $class, $type, $severity, $message, $file, $line, $trace
         );
+
         // Generar mensaje con el error o excepción.
         header('Content-Type: text/plain; charset=UTF-8');
         echo $error;
@@ -479,6 +483,7 @@ public function registerService($key, $service): void
                 $this->container->instance(get_class($service), $service);
             }
         }
+
         // Si $service es una clase, usar singleton para registrar.
         else if (is_string($service)) {
             // Verificar que la clase del servicio exista.
@@ -489,12 +494,14 @@ public function registerService($key, $service): void
                     $key
                 ));
             }
+
             // Registrar.
             $this->container->singleton($key, $service);
             if ($service != $key) {
                 $this->container->singleton($service, $service);
             }
         }
+
         // Si $service es otra cosa, lanzar una excepción.
         else {
             throw new \InvalidArgumentException(sprintf(
@@ -534,8 +541,8 @@ public function getStats(): array
                 'cache' => cache()->getStats(),
             ];
         }
+
         // Entregar estadísticas.
         return $this->stats;
     }
-
 }