Compare commits

..

1 Commits

Author SHA1 Message Date
kj
d37d5e10e8 Migrate to strong type (compatible only with PHP 7.0+). 2022-03-17 17:18:53 -04:00
13 changed files with 1045 additions and 1852 deletions

View File

@ -1,14 +1,10 @@
<?php <?php
// Configuración de la base de datos define('dbhost', 'localhost');
define('DB_TYPE', 'mysql'); define('dbname', '');
define('DB_HOST', 'localhost'); define('dbuser', '');
define('DB_NAME', ''); define('dbpass', '');
define('DB_USER', '');
define('DB_PASS', '');
// Configuración del sitio
define('SITE_URL', ''); define('SITE_URL', '');
// Configuración avanzada
define('ROOT_DIR', __DIR__); define('ROOT_DIR', __DIR__);
define('ROOT_CORE', ROOT_DIR.'/src'); ?>

View File

@ -6,15 +6,19 @@ spl_autoload_register(function ($className) {
$fp = str_replace('\\','/',$className); $fp = str_replace('\\','/',$className);
$name = basename($fp); $name = basename($fp);
$dir = dirname($fp); $dir = dirname($fp);
$file = ROOT_CORE.'/'.$dir.'/'.$name.'.php'; $file = ROOT_DIR.'/src/'.$dir.'/'.$name.'.php';
if (file_exists($file)) if (file_exists($file)) {
require_once $file; require_once $file;
return;
}
}); });
// Incluir routers // Incluir routers
$routers = glob(ROOT_CORE.'/Routers/*.php'); $routers = glob(ROOT_DIR.'/src/Routers/*.php');
foreach($routers as $file) foreach($routers as $file){
require_once($file); require_once($file);
}
\Libs\Router::apply(); \Libs\Router::apply();
?>

21
readme.md Normal file
View File

@ -0,0 +1,21 @@
# DuckBrain - PHP Microframework
Este microframework PHP tiene el objetivo de presentar un framework sencillo y potente que sea válido especialmente para proyectos pequeños o simples, sin limitar demasiado, ni depender de cosas que agranden innecesariamente proyectos.
Esto no es un intento de mi parte de reinventar la rueda, de hecho los primeros commits los hice con la intención de que solo fuera una prueba de concepto, pero me gustó como quedó y decidí darle continuidad hasta hacerlo usable para mi mismo.
Tuve la idea de hacer este conjunto de librerías/microframework luego de ver como proyectos relativamente pequeños eran hechos con frameworks demasiado pesados para lo que eran.
También revisé otros microframeworks y si bien me parecen una buena opción para hacer los trabajos, aún me quedaba la espinita de que seguían siendo muy grandes para que un programador novato pudiera leerlo, entenderlo y modificarlo, así que intenté hacer algo más simple aún y de ahí salió este proyecto.
Lo ideal sería mantener el código sencillo, lo suficiente como para que cualquier novato que sepa POO y PHP pueda leerlo rápido, entenderlo y modificarlo a gusto. Por este motivo también he decidido desligarlo en lo posible de composer o cualquier cosa similar, ya que no pocos programadores en etapa de aprendizaje al encontrarse con frameworks más complicados o con herramientas como composer, terminan trabajando con cosas que no comprenden ni pueden arreglar por si mismos en caso de fallo, ya que son completamente dependientes de dichas herramientas.
El código no es perfecto, pero lo iré perfeccionando, ya que es algo que estoy usando actualmente para mis trabajos, de modo que puedo ir viendo que cosas se pueden ir mejorando.
## Uso / Documentación
Queda pendiente, si quieres usarlo ya mismo, puedes leer los comeentarios que he colocado en el código.
## Contacto
Puedes encontrame en telegram como [@keyjay](https://telegram.me/keyjay) o contactarme mi correo: webmaster@outcontrol.net

View File

@ -1,107 +0,0 @@
#+TITLE: Duckbrain
#+AUTHOR: KJ
#+OPTIONS: toc:nil
Este conjunto de librerías (microframework, si así lo prefieres) tiene el objetivo de presentar una herramienta de trabajo sencilla y potente que sea válida especialmente para proyectos pequeños o simples, sin limitar, ni depender de cosas que agranden innecesariamente dichos proyectos.
Tuve la idea de hacer esta herramienta luego de ver como proyectos relativamente pequeños eran hechos con frameworks demasiado grandes para la envergadura de dichos proyectos. No es bueno matar moscas a cañonazos.
Del mismo modo revisé algunos microframeworks y si bien me parecen una buena opción, aún me quedaba la espinita de que seguían siendo muy complejos para que un programador novato pudiera leer su código, entenderlo y modificarlo, así que intenté hacer algo más simple
Lo que busco es mantener un código sencillo, lo suficiente como para que cualquier novato que sepa POO y PHP pueda leer su código rápidamente, entenderlo y modificarlo a gusto. Por este motivo también he decidido desligarlo en lo posible de composer o cualquier cosa similar, ya que no pocos programadores en etapa de aprendizaje al encontrarse con frameworks más complicados o con herramientas como composer, terminan trabajando con cosas que no comprenden ni pueden arreglar por si mismos en caso de fallo, llevándolos a la dependencia total de dichas herramientas.
* Uso / Documentación
Actualmente existe un manual de inicio que puedes leerlo desde [[https://tools.kj2.me/duckbrain/starting-manual.html][aquí]] o desde [[https://git.kj2.me/kj/duckbrain-docs/src/branch/master/starting-manual.org][aquí]].
Si quieres leer el manual de inicio en su formato original (necesitas un editor/lector que soporte org-mode) puedes descargarla desde [[https://tools.kj2.me/duckbrain/starting-manual.org][aquí]].
Para el resto de la documentación, el código usa [[https://www.phpdoc.org/][phpdoc]], por lo que puedes tener toda la documentación API desde tu IDE o Editor de texto preferido siempre que soporte dicha característica. O si lo prefieres, puedes generarla en unbonito htm local usando la herramienta [[https://docs.phpdoc.org/3.0/packages/phpDocumentor.html][phpDocumentor]].
* Soporte de gestores de bases de datos
En la siguiente tabla se encuentra la lista de estados de los gestores de bases de datos que he probado o que planeo probar para asegurarme de que sean realmente compatibles.
*Entiéndase*:
+ *ok* como que ha sido probado y funciona.
+ *En blanco* como que no ha sido probado aún.
+ *error* como que fue probado, no funciona y no ha sido aún arreglado.
+ *not supported* como no soportado por el gestor de bases de datos.
+ *fixed* para aquello que no existe en el gestor de DB, pero la librería lo traduce a un equivalente.
|------------------+---------------+---------------+------------|
| method | MySQL/MariaDB | sqlite3 | postgreSQL |
|------------------+---------------+---------------+------------|
| db | ok | ok | |
|------------------+---------------+---------------+------------|
| query | ok | ok | |
|------------------+---------------+---------------+------------|
| resetQuery | ok | ok | |
|------------------+---------------+---------------+------------|
| buildQuery | ok | ok | |
|------------------+---------------+---------------+------------|
| getInstance | ok | ok | |
|------------------+---------------+---------------+------------|
| getVars | ok | ok | |
|------------------+---------------+---------------+------------|
| className | ok | ok | |
|------------------+---------------+---------------+------------|
| table | ok | ok | |
|------------------+---------------+---------------+------------|
| update | ok | ok | |
|------------------+---------------+---------------+------------|
| beginTransaction | ok | ok | |
|------------------+---------------+---------------+------------|
| rollBack | ok | ok | |
|------------------+---------------+---------------+------------|
| commit | ok | ok | |
|------------------+---------------+---------------+------------|
| add | ok | ok | |
|------------------+---------------+---------------+------------|
| save | ok | ok | |
|------------------+---------------+---------------+------------|
| delete | ok | ok | |
|------------------+---------------+---------------+------------|
| select | ok | ok | |
|------------------+---------------+---------------+------------|
| from | ok | ok | |
|------------------+---------------+---------------+------------|
| where | ok | ok | |
|------------------+---------------+---------------+------------|
| where_in | ok | ok | |
|------------------+---------------+---------------+------------|
| leftJoin | ok | ok | |
|------------------+---------------+---------------+------------|
| rightJoin | ok | not supported | |
|------------------+---------------+---------------+------------|
| innerJoin | ok | ok | |
|------------------+---------------+---------------+------------|
| and | ok | ok | |
|------------------+---------------+---------------+------------|
| or | ok | ok | |
|------------------+---------------+---------------+------------|
| groupBy | ok | ok | |
|------------------+---------------+---------------+------------|
| limit | ok | ok | |
|------------------+---------------+---------------+------------|
| orderBy | ok | ok | |
|------------------+---------------+---------------+------------|
| count | ok | ok | |
|------------------+---------------+---------------+------------|
| getById | ok | ok | |
|------------------+---------------+---------------+------------|
| search | ok | ok | |
|------------------+---------------+---------------+------------|
| get | ok | ok | |
|------------------+---------------+---------------+------------|
| getFirst | ok | ok | |
|------------------+---------------+---------------+------------|
| all | ok | ok | |
|------------------+---------------+---------------+------------|
| setNull | ok | ok | |
|------------------+---------------+---------------+------------|
* Contacto
Puedes encontrame en telegram como [[https://telegram.me/keyjay][@keyjay]] o contactarme mi correo: webmaster@outcontrol.net

View File

@ -1,58 +1,38 @@
<?php <?php
/** /*
* Database - DuckBrain * DuckBrain - Microframework
* *
* Clase diseñada para crear y devolver una única instancia PDO (database). * Clase diseñada para crear y devolver una única instancia mysqli (database).
* Depende de manera forzada de que estén definidas las constantes:
* dbhost, dbname, dbpass y dbuser
* *
* @author KJ * Autor: KJ
* @website https://kj2.me * Web: https://kj2.me
* @licence MIT * Licencia: MIT
*/ */
namespace Libs; namespace Libs;
use mysqli;
use PDO; class Database extends \mysqli {
use PDOException; static private $db;
use Exception;
class Database extends PDO {
static private array $databases = [];
private function __construct() {} private function __construct() {}
/** /**
* Devuelve una instancia homogénea (singlenton) de la base de datos (PDO). * Devuelve una instancia homogénea (singlenton) a la base de datos.
* *
* @return PDO * @return mysqli
*/ */
static public function getInstance( static public function getConnection() : mysqli {
string $type = 'mysql', if (!isset(self::$db)) {
string $host = 'localhost', self::$db = new mysqli(dbhost, dbuser, dbpass, dbname);
string $name = '', if (self::$db->connect_errno) {
string $user = '', echo '<style>body{white-space: pre-line;}</style>';
string $pass = '', throw new \Exception('No se ha podido conectar a la base de datos.');
): PDO
{
$key = $type.'/'.$host.'/'.$name.'/'.$user;
if (empty(static::$databases[$key])) {
if ($type == 'sqlite') {
$dsn = $type .':'. $name;
} else
$dsn = $type.':dbname='.$name.';host='.$host;
try {
static::$databases[$key] = new PDO($dsn, $user, $pass);
} catch (PDOException $e) {
throw new Exception(
'Error at connect to database: ' . $e->getMessage()
);
} }
static::$databases[$key]->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
static::$databases[$key]->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
} }
return static::$databases[$key]; return self::$db;
} }
} }
?> ?>

View File

@ -1,28 +0,0 @@
<?php
/**
* Middleware - DuckBrain
*
* Librería base para middlewares.
*
* @author KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
class Middleware {
/**
* Llama al siguiente callback.
*
* @param Neuron $req
*
* @return mixed
*/
public static function next(Neuron $req): mixed
{
$next = array_pop($req->next);
return call_user_func_array($next, [$req]);
}
}

View File

@ -1,937 +0,0 @@
<?php
/**
* Model - DuckBrain
*
* Modelo ORM para objetos que hagan uso de una base de datos.
* Depende de Libs\Database y hace uso de las constantes
* DB_TYPE, DB_HOST, DB_NAME, DB_USER y DB_PASS.
*
* @author KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
use Libs\Database;
use PDO;
use PDOException;
use Exception;
use ReflectionClass;
use ReflectionProperty;
use AllowDynamicProperties;
#[AllowDynamicProperties]
class Model {
public ?int $id = null;
protected array $toNull = [];
static protected string $primaryKey = 'id';
static protected array $ignoreSave = ['id'];
static protected array $forceSave = [];
static protected string $table;
static protected string $tableSufix = 's';
static protected array $queryVars = [];
static protected array $querySelect = [
'select' => ['*'],
'where' => '',
'from' => '',
'leftJoin' => '',
'rightJoin' => '',
'innerJoin' => '',
'orderBy' => '',
'groupBy' => '',
'limit' => ''
];
/**
* Sirve para obtener la instancia de la base de datos.
*
* @return PDO
*/
protected static function db(): PDO
{
if (DB_TYPE == 'sqlite')
return Database::getInstance(
type: DB_TYPE,
name: DB_NAME
);
else
return Database::getInstance(
DB_TYPE,
DB_HOST,
DB_NAME,
DB_USER,
DB_PASS
);
}
/**
* Ejecuta PDO::beginTransaction para iniciar una transacción.
* Más info: https://www.php.net/manual/es/pdo.begintransaction.php
*
* @return bool
*/
public function beginTransaction(): bool
{
return static::db()->beginTransaction();
}
/**
* Ejecuta PDO::rollBack para deshacher los cambios de una transacción.
* Más info: https://www.php.net/manual/es/pdo.rollback.php
*
* @return bool
*/
public function rollBack(): bool
{
if ( static::db()->inTransaction())
return static::db()->rollBack();
else
return true;
}
/**
* Ejecuta PDO::commit para consignar una transacción.
* Más info: https://www.php.net/manual/es/pdo.commit.php
*
* @return bool
*/
public function commit(): bool
{
if (static::db()->inTransaction())
return static::db()->commit();
else
return true;
}
/**
* Ejecuta una sentencia SQL en la base de datos.
*
* @param string $query
* Contiene la sentencia SQL que se desea ejecutar.
*
* @throws Exception
* En caso de que la sentencia SQL falle, devolverá un error en
* pantalla y hará rolllback en caso de estar dentro de una
* transacción (ver método beginTransacction).
*
* @param bool $resetQuery
* Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return array
* Contiene el resultado de la llamada SQL .
*/
protected static function query(string $query, bool $resetQuery = true): array
{
$db = static::db();
try {
$prepared = $db->prepare($query);
$prepared->execute(static::$queryVars);
} catch (PDOException $e) {
if ($db->inTransaction())
$db->rollBack();
$vars = json_encode(static::$queryVars);
throw new Exception(
"\nError at query to database.\n" .
"Query: $query\n" .
"Vars: $vars\n" .
"Error:\n" . $e->getMessage()
);
}
$result = $prepared->fetchAll();
if ($resetQuery)
static::resetQuery();
return $result;
}
/**
* Reinicia la configuración de la sentencia SQL.
* @return void
*/
protected static function resetQuery(): void
{
static::$querySelect = [
'select' => ['*'],
'where' => '',
'from' => '',
'leftJoin' => '',
'rightJoin' => '',
'innerJoin' => '',
'orderBy' => '',
'groupBy' => '',
'limit' => ''
];
static::$queryVars = [];
}
/**
* Construye la sentencia SQL a partir static::$querySelect y una vez
* construída, llama a resetQuery.
*
* @return string
* Contiene la sentencia SQL.
*/
protected static function buildQuery(): string
{
$sql = 'SELECT '.join(', ', static::$querySelect['select']);
if (static::$querySelect['from'] != '')
$sql .= ' FROM '.static::$querySelect['from'];
else
$sql .= ' FROM '.static::table();
if(static::$querySelect['innerJoin'] != '')
$sql .= static::$querySelect['innerJoin'];
if (static::$querySelect['leftJoin'] != '')
$sql .= static::$querySelect['leftJoin'];
if(static::$querySelect['rightJoin'] != '')
$sql .= static::$querySelect['rightJoin'];
if (static::$querySelect['where'] != '')
$sql .= ' WHERE '.static::$querySelect['where'];
if (static::$querySelect['groupBy'] != '')
$sql .= ' GROUP BY '.static::$querySelect['groupBy'];
if (static::$querySelect['orderBy'] != '')
$sql .= ' ORDER BY '.static::$querySelect['orderBy'];
if (static::$querySelect['limit'] != '')
$sql .= ' LIMIT '.static::$querySelect['limit'];
return $sql;
}
/**
* Configura $queryVars para vincular un valor a un
* parámetro de sustitución y devuelve este último.
*
* @param string $value
* Valor a vincular.
*
* @return string
* Parámetro de sustitución.
*/
private static function bindValue(string $value): string
{
$index = ':v_'.count(static::$queryVars);
static::$queryVars[$index] = $value;
return $index;
}
/**
* Crea una instancia del objeto actual a partir de un arreglo.
*
* @param mixed $elem
* Puede recibir un arreglo o un objeto que contiene los valores
* que tendrán sus atributos.
*
* @return static
* Retorna un objeto de la clase actual.
*/
protected static function getInstance(array $elem = []): static
{
$class = get_called_class();
$instance = new $class;
$reflection = new ReflectionClass($instance);
$properties = $reflection->getProperties();
$propertyNames = array_column($properties, 'name');
foreach ($elem as $key => $value) {
$index = array_search($key, $propertyNames);
if (is_numeric($index) && enum_exists($properties[$index]->getType()->getName()))
$instance->$key = $properties[$index]->getType()->getName()::tryfrom($value);
else
$instance->$key = $value;
}
return $instance;
}
/**
* Devuelve los atributos a guardar de la case actual.
* Los atributos serán aquellos que seran public y
* no esten excluidos en static::$ignoresave y aquellos
* que sean private o protected pero estén en static::$forceSave.
*
* @return array
* Contiene los atributos indexados del objeto actual.
*/
protected function getVars(): array
{
$reflection = new ReflectionClass($this);
$properties = $reflection->getProperties(ReflectionProperty::IS_PUBLIC);
$result = [];
foreach($properties as $property)
$result[$property->name] = isset($this->{$property->name})
? $this->{$property->name} : null;
foreach (static::$ignoreSave as $del)
unset($result[$del]);
foreach (static::$forceSave as $value)
$result[$value] = isset($this->$value)
? $this->$value: null;
foreach ($result as $i => $property) {
if (gettype($property) == 'boolean')
$result[$i] = $property ? '1' : '0';
if ($property instanceof \UnitEnum)
$result[$i] = $property->value;
}
return $result;
}
/**
* Devuelve el nombre de la clase actual aunque sea una clase extendida.
*
* @return string
* Devuelve el nombre de la clase actual.
*/
public static function className(): string
{
return substr(
strrchr(get_called_class(), '\\'), 1
);
}
/**
* Construye (a partir del nombre de la clase y el sufijo en static::$tableSufix)
* y/o develve el nombre de la tabla de la BD en la que se alojará o
* se aloja el objeto actual.
*
* @return string
*/
protected static function table(): string
{
if (isset(static::$table))
return static::$table;
return strtolower(
preg_replace(
'/(?<!^)[A-Z]/', '_$0',
static::className()
)
).static::$tableSufix;
}
/**
* Actualiza los valores en la BD con los valores del objeto actual.
* @return void
*/
protected function update(): void
{
$atts = $this->getVars();
foreach ($atts as $key => $value) {
if (isset($value)) {
if (in_array($key, $this->toNull))
$set[]="$key=NULL";
else {
$set[]="$key=:$key";
static::$queryVars[':'.$key] = $value;
}
} else {
if (in_array($key, $this->toNull))
$set[]="$key=NULL";
}
}
$table = static::table();
$pk = static::$primaryKey;
$pkv = $this->$pk;
$sql = "UPDATE $table SET ".join(', ', $set)." WHERE $pk='$pkv'";
static::query($sql);
}
/**
* Inserta una nueva fila en la base de datos a partir del
* objeto actual.
* @return void
*/
protected function add(): void
{
$db = static::db();
$atts = $this->getVars();
foreach ($atts as $key => $value) {
if (isset($value)) {
$into[] = "`$key`";
$values[] = ":$key";
static::$queryVars[":$key"] = $value;
}
}
$table = static::table();
$sql = "INSERT INTO $table (".join(', ', $into).") VALUES (".join(', ', $values).")";
static::query($sql);
$pk = static::$primaryKey;
$this->$pk = $db->lastInsertId();
}
/**
* Revisa si el objeto a guardar es nuevo o no y según el resultado
* llama a update para actualizar o add para insertar una nueva fila.
* @return void
*/
public function save(): void
{
$pk = static::$primaryKey;
if (isset($this->$pk))
$this->update();
else
$this->add();
}
/**
* Elimina el objeto actual de la base de datos.
* @return void
*/
public function delete(): void {
$table = static::table();
$pk = static::$primaryKey;
$sql = "DELETE FROM $table WHERE $pk=:$pk";
static::$queryVars[":$pk"] = $this->$pk;
static::query($sql);
}
/**
* Define SELECT en la sentencia SQL.
*
* @param array $columns
* Columnas que se selecionarán en la consulta SQL.
*
* @return static
*/
public static function select(array $columns): static
{
static::$querySelect['select'] = $columns;
return new static();
}
/**
* Define FROM en la sentencia SQL.
*
* @param array $tables
* Tablas que se selecionarán en la consulta SQL.
*
* @return static
*/
public static function from(array $tables): static
{
static::$querySelect['from'] = join(', ', $tables);
return new static();
}
/**
* Define el WHERE en la sentencia SQL.
*
* @param string $column
* La columna a comparar.
*
* @param string $operatorOrValue
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string|null $value
* (opcional) El valor a comparar en la columna.
*
* @param bool $no_filter
* (opcional) Se usa cuando $value es una columna o un valor que no requiere filtros
* contra ataques SQLI (por defeco es false).
*
* @return static
*/
public static function where(
string $column,
string $operatorOrValue,
?string $value = null,
bool $no_filter = false
): static
{
return static::and(
$column,
$operatorOrValue,
$value,
$no_filter
);
}
/**
* Define AND en la sentencia SQL (se puede anidar).
*
* @param string $column
* La columna a comparar.
*
* @param string $operatorOrValue
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string|null $value
* (opcional) El valor el valor a comparar en la columna.
*
* @param bool $no_filter
* (opcional) Se usa cuando $value es una columna o un valor que no requiere filtros
* contra ataques SQLI (por defecto es false).
*
* @return static
*/
public static function and(
string $column,
string $operatorOrValue,
?string $value = null,
bool $no_filter = false
): static
{
if (is_null($value)) {
$value = $operatorOrValue;
$operatorOrValue = '=';
}
if (!$no_filter)
$value = static::bindValue($value);
if (static::$querySelect['where'] == '')
static::$querySelect['where'] = "$column $operatorOrValue $value";
else
static::$querySelect['where'] .= " AND $column $operatorOrValue $value";
return new static();
}
/**
* Define OR en la sentencia SQL (se puede anidar).
*
* @param string $column
* La columna a comparar.
*
* @param string $operatorOrValue
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string|null $value
* (opcional) El valor el valor a comparar en la columna.
*
* @param bool $no_filter
* (opcional) Se usa cuando $value es una columna o un valor que no requiere filtros
* contra ataques SQLI (por defecto es false).
*
* @return static
*/
public static function or(
string $column,
string $operatorOrValue,
?string $value = null,
bool $no_filter = false
): static
{
if (is_null($value)) {
$value = $operatorOrValue;
$operatorOrValue = '=';
}
if (!$no_filter)
$value = static::bindValue($value);
if (static::$querySelect['where'] == '')
static::$querySelect['where'] = "$column $operatorOrValue $value";
else
static::$querySelect['where'] .= " OR $column $operatorOrValue $value";
return new static();
}
/**
* Define WHERE usando IN en la sentencia SQL.
*
* @param string $column
* La columna a comparar.
*
* @param array $arr
* Arreglo con todos los valores a comparar con la columna.
*
* @param bool $in
* Define si se tienen que comprobar negativa o positivamente.
*
* @return static
*/
public static function where_in(
string $column,
array $arr,
bool $in = true
): static
{
$arrIn = [];
foreach($arr as $value) {
$arrIn[] = static::bindValue($value);
}
if ($in)
$where_in = "$column IN (".join(', ', $arrIn).")";
else
$where_in = "$column NOT IN (".join(', ', $arrIn).")";
if (static::$querySelect['where'] == '')
static::$querySelect['where'] = $where_in;
else
static::$querySelect['where'] .= " AND $where_in";
return new static();
}
/**
* Define LEFT JOIN en la sentencia SQL.
*
* @param string $table
* Tabla que se va a juntar a la del objeto actual.
*
* @param string $columnA
* Columna a comparar para hacer el join.
*
* @param string $operatorOrColumnB
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string|null $columnB
* (opcional) Columna a comparar para hacer el join.
*
* @return static
*/
public static function leftJoin(
string $table,
string $columnA,
string $operatorOrColumnB,
?string $columnB = null
): static
{
if (is_null($columnB)) {
$columnB = $operatorOrColumnB;
$operatorOrColumnB = '=';
}
static::$querySelect['leftJoin'] .= ' LEFT JOIN ' . $table . ' ON ' . "$columnA$operatorOrColumnB$columnB";
return new static();
}
/**
* Define RIGHT JOIN en la sentencia SQL.
*
* @param string $table
* Tabla que se va a juntar a la del objeto actual.
*
* @param string $columnA
* Columna a comparar para hacer el join.
*
* @param string $operatorOrColumnB
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string|null $columnB
* (opcional) Columna a comparar para hacer el join.
*
* @return static
*/
public static function rightJoin(
string $table,
string $columnA,
string $operatorOrColumnB,
?string $columnB = null
): static
{
if (is_null($columnB)) {
$columnB = $operatorOrColumnB;
$operatorOrColumnB = '=';
}
static::$querySelect['rightJoin'] .= ' RIGHT JOIN ' . $table . ' ON ' . "$columnA$operatorOrColumnB$columnB";
return new static();
}
/**
* Define INNER JOIN en la sentencia SQL.
*
* @param string $table
* Tabla que se va a juntar a la del objeto actual.
*
* @param string $columnA
* Columna a comparar para hacer el join.
*
* @param string $operatorOrColumnB
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string|null $columnB
* (opcional) Columna a comparar para hacer el join.
*
* @return static
*/
public static function innerJoin(
string $table,
string $columnA,
string $operatorOrColumnB,
?string $columnB = null
): static
{
if (is_null($columnB)) {
$columnB = $operatorOrColumnB;
$operatorOrColumnB = '=';
}
static::$querySelect['innerJoin'] .= ' INNER JOIN ' . $table . ' ON ' . "$columnA$operatorOrColumnB$columnB";
return new static();
}
/**
* Define GROUP BY en la sentencia SQL.
*
* @param array $arr
* Columnas por las que se agrupará.
*
* @return static
*/
public static function groupBy(array $arr): static
{
static::$querySelect['groupBy'] = join(', ', $arr);
return new static();
}
/**
* Define LIMIT en la sentencia SQL.
*
* @param int $offsetOrQuantity
* Define el las filas a ignorar o la cantidad a tomar en
* caso de que $quantity no esté definido.
* @param int $quantity
* Define la cantidad máxima de filas a tomar.
*
* @return static
*/
public static function limit(int $offsetOrQuantity, ?int $quantity = null): static
{
if (is_null($quantity))
static::$querySelect['limit'] = $offsetOrQuantity;
else
static::$querySelect['limit'] = $offsetOrQuantity.', '.$quantity;
return new static();
}
/**
* Define ORDER BY en la sentencia SQL.
*
* @param string $value
* Columna por la que se ordenará.
*
* @param string $order
* (opcional) Define si el orden será de manera ascendente (ASC),
* descendente (DESC) o aleatorio (RAND).
*
* @return static
*/
public static function orderBy(string $value, string $order = 'ASC'): static
{
if ($value == "RAND") {
static::$querySelect['orderBy'] = 'RAND()';
return new static();
}
if (!(strtoupper($order) == 'ASC' || strtoupper($order) == 'DESC'))
$order = 'ASC';
static::$querySelect['orderBy'] = $value.' '.$order;
return new static();
}
/**
* Retorna la cantidad de filas que hay en un query.
*
* @param bool $resetQuery
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @param bool $useLimit
* (opcional) Permite usar limit para estabecer un máximo inical y final para contar.
* Requiere que se haya definido antes el límite (por defecto en false).
*
* @return int
*/
public static function count(bool $resetQuery = true, bool $useLimit = false): int
{
if (!$resetQuery)
$backup = [
'select' => static::$querySelect['select'],
'limit' => static::$querySelect['limit'],
'orderBy' => static::$querySelect['orderBy']
];
if ($useLimit && static::$querySelect['limit'] != '') {
static::$querySelect['select'] = ['1'];
static::$querySelect['orderBy'] = '';
$sql = 'SELECT COUNT(1) AS quantity FROM ('.static::buildQuery().') AS counted';
$queryResult = static::query($sql, $resetQuery);
$result = $queryResult[0]['quantity'];
} else {
static::$querySelect['select'] = ["COUNT(".static::table().".".static::$primaryKey.") as quantity"];
static::$querySelect['limit'] = '1';
static::$querySelect['orderBy'] = '';
$sql = static::buildQuery();
$queryResult = static::query($sql, $resetQuery);
$result = $queryResult[0]['quantity'];
}
if (!$resetQuery) {
static::$querySelect['select'] = $backup['select'];
static::$querySelect['limit'] = $backup['limit'];
static::$querySelect['orderBy'] = $backup['orderBy'];
}
return $result;
}
/**
* Obtiene una instancia según su primary key (generalmente id).
* Si no encuentra una instancia, devuelve nulo.
*
* @param mixed $id
*
* @return static|null
*/
public static function getById(mixed $id): ?static
{
return static::where(static::$primaryKey, $id)->getFirst();
}
/**
* Realiza una búsqueda en la tabla de la instancia actual.
*
* @param string $search
* Contenido a buscar.
*
* @param array|null $in
* (opcional) Columnas en las que se va a buscar (null para buscar en todas).
*
* @return static
*/
public static function search(string $search, ?array $in = null): static
{
if ($in == null) {
$className = get_called_class();
$in = array_keys((new $className())->getVars());
}
$search = static::bindValue($search);
$where = [];
if (DB_TYPE == 'sqlite')
foreach($in as $row)
$where[] = "$row LIKE '%' || $search || '%'";
else
foreach($in as $row)
$where[] = "$row LIKE CONCAT('%', $search, '%')";
if (static::$querySelect['where']=='')
static::$querySelect['where'] = join(' OR ', $where);
else
static::$querySelect['where'] = static::$querySelect['where'] .' AND ('.join(' OR ', $where).')';
return new static();
}
/**
* Obtener los resultados de la consulta SQL.
*
* @param bool $resetQuery
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return array<static>
* Arreglo con instancias del la clase actual resultantes del query.
*/
public static function get(bool $resetQuery = true): array
{
$sql = static::buildQuery();
$result = static::query($sql, $resetQuery);
$instances = [];
foreach ($result as $row) {
$instances[] = static::getInstance($row);
}
return $instances;
}
/**
* El primer elemento de la consulta SQL.
*
* @param bool $resetQuery
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return static|null
* Puede retornar una instancia de la clase actual o null.
*/
public static function getFirst(bool $resetQuery = true): ?static
{
static::limit(1);
$instances = static::get($resetQuery);
return empty($instances) ? null : $instances[0];
}
/**
* Obtener todos los elementos del la tabla de la instancia actual.
*
* @return array<static>
* Contiene un arreglo de instancias de la clase actual.
*/
public static function all(): array
{
$sql = 'SELECT * FROM '.static::table();
$result = static::query($sql);
$instances = [];
foreach ($result as $row)
$instances[] = static::getInstance($row);
return $instances;
}
/**
* Permite definir como nulo el valor de un atributo.
* Sólo funciona para actualizar un elemento de la BD, no para insertar.
*
* @param string|array $atts
* Atributo o arreglo de atributos que se definirán como nulos.
*
* @return void
*/
public function setNull(string|array $atts): void
{
if (is_array($atts)) {
foreach ($atts as $att)
if (!in_array($att, $this->toNull))
$this->toNull[] = $att;
return;
}
if (!in_array($atts, $this->toNull))
$this->toNull[] = $atts;
}
}
?>

826
src/Libs/ModelMySQL.php Normal file
View File

@ -0,0 +1,826 @@
<?php
/**
* ModelMysql - DuckBrain
*
* Modelo ORM para objetos que hagan uso de una base de datos MySQL.
* Depende de que exista Libs\Database para poder funcionar.
*
* @autor KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
use Libs\Database;
use mysqli;
class ModelMySQL {
public $id;
protected $toNull = [];
static protected $primaryKey = 'id';
static protected $ignoreSave = ['id'];
static protected $forceSave = [];
static protected $table;
static protected $tableSufix = 's';
static protected $db;
static protected $querySelect = [
'select' => ['*'],
'where' => '',
'from' => '',
'leftJoin' => '',
'rightJoin' => '',
'innerJoin' => '',
'AndOr' => '',
'orderBy' => '',
'groupBy' => '',
'limit' => '',
'sql_calc_found_rows' => false
];
/**
* Sirve para obtener la instancia de la base de datos.
*
* @return mysqli
*/
protected static function db() : mysqli {
if (is_null(static::$db))
static::$db = Database::getConnection();
return static::$db;
}
/**
* Ejecuta una sentencia SQL en la base de datos.
*
* @param string $query
* Contiene la sentencia SQL que se desea ejecutar.
*
* @throws \Exception
* En caso de que la sentencia SQL falle, devolverá un error en pantalla.
*
* @return mysqli_result
* Contiene el resultado de la llamada SQL.
*/
protected static function query($query) : mysqli_result {
$db = static::db();
$result = $db->query($query);
if ($db->errno) {
echo '<style>body{white-space: pre-line;}</style>';
throw new \Exception(
"\nFallo al consultar la base de datos\n" .
"Errno: $db->errno\n" .
"Error: $db->error\n" .
"Query: $query\n"
);
}
return $result;
}
/**
* Reinicia la configuración de la sentencia SQL.
*/
protected static function resetQuery() {
static::$querySelect = [
'select' => ['*'],
'where' => '',
'from' => '',
'leftJoin' => '',
'rightJoin' => '',
'innerJoin' => '',
'AndOr' => '',
'orderBy' => '',
'groupBy' => '',
'limit' => '',
'sql_calc_found_rows' => false
];
}
/**
* Construye la sentencia SQL a partir static::$querySelect y una vez
* construída, llama a resetQuery.
*
* @param bool $resetQuery
* Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return string
* Contiene la sentencia SQL.
*/
protected static function buildQuery(bool $resetQuery = true) : string {
if (static::$querySelect['sql_calc_found_rows'])
$sql = 'SELECT SQL_CALC_FOUND_ROWS '.join(', ', static::$querySelect['select']);
else
$sql = 'SELECT '.join(', ', static::$querySelect['select']);
if (static::$querySelect['from'] != '') {
$sql .= ' FROM '.static::$querySelect['from'];
} else {
$sql .= ' FROM '.static::table();
}
if(static::$querySelect['innerJoin'] != '') {
$sql .= static::$querySelect['innerJoin'];
}
if (static::$querySelect['leftJoin'] != '') {
$sql .= static::$querySelect['leftJoin'];
}
if(static::$querySelect['rightJoin'] != '') {
$sql .= static::$querySelect['rightJoin'];
}
if (static::$querySelect['where'] != '') {
$sql .= ' WHERE '.static::$querySelect['where'];
if (static::$querySelect['AndOr'] != '') {
$sql .= static::$querySelect['AndOr'];
}
}
if (static::$querySelect['groupBy'] != '') {
$sql .= ' GROUP BY '.static::$querySelect['groupBy'];
}
if (static::$querySelect['orderBy'] != '') {
$sql .= ' ORDER BY '.static::$querySelect['orderBy'];
}
if (static::$querySelect['limit'] != '') {
$sql .= ' LIMIT '.static::$querySelect['limit'];
}
if ($resetQuery)
static::resetQuery();
return $sql;
}
/**
* Crea una instancia del objeto actual a partir de un arreglo.
*
* @param mixed $elem
* Puede recibir un arreglo o un objeto que contiene los valores
* que tendrán sus atributos.
*
* @return ModelMySQL
* Retorna un objeto de la clase actual.
*/
protected static function getInstance(array $elem = []) : ModelMySQL {
$class = get_called_class();
$instance = new $class;
foreach ($elem as $key => $value) {
$instance->$key = $value;
}
return $instance;
}
/**
* Devuelve los atributos a guardar de la case actual.
* Los atributos serán aquellos que seran public y
* no esten excluidos en static::$ignoresave y aquellos
* que sean private o protected pero estén en static::$forceSave.
*
* @return array
* Contiene los atributos indexados del objeto actual.
*/
protected function getVars() : array {
$reflection = new \ReflectionClass($this);
$properties = $reflection->getProperties(\ReflectionProperty::IS_PUBLIC);
$result = [];
foreach($properties as $property) {
$att = $property->name;
$result[$att] = $this->$att;
}
foreach (static::$ignoreSave as $del) {
unset($result[$del]);
}
foreach (static::$forceSave as $value) {
$result[$value] = $this->$value;
}
return $result;
}
/**
* Devuelve el nombre de la clase actual aunque sea una clase extendida.
*
* @return string
* Devuelve el nombre de la clase actual.
*/
public static function className() : string {
return strtolower(substr(strrchr(get_called_class(), '\\'), 1));
}
/**
* Construye (a partir del nombre de la clase y el sufijo en static::$tableSufix)
* y/o develve el nombre de la tabla de la BD en la que se alojará o
* se aloja el objeto actual.
*
* @return string
*/
protected static function table() : string {
if (isset(static::$table))
return static::$table;
return static::className().static::$tableSufix;
}
/**
* Actualiza los valores en la BD con los valores del objeto actual.
*/
protected function update() {
$atts = $this->getVars();
foreach ($atts as $key => $value) {
if (isset($value)) {
$value = static::db()->real_escape_string($value);
if (in_array($key, $this->toNull))
$set[]="$key=NULL";
else
$set[]="$key='$value'";
} else {
if (in_array($key, $this->toNull))
$set[]="$key=NULL";
}
}
$table = static::table();
$pk = static::$primaryKey;
$pkv = $this->$pk;
$sql = "UPDATE $table SET ".join(', ', $set)." WHERE $pk='$pkv'";
static::query($sql);
}
/**
* Inserta una nueva fila en la base de datos a partir del
* objeto actual.
*/
protected function add() {
$db = static::db();
$atts = $this->getVars();
foreach ($atts as $key => $value) {
if (isset($value)) {
$into[] = "`$key`";
$values[] = "'".$db->real_escape_string($value)."'";
}
}
$table = static::table();
$sql = "INSERT INTO $table (".join(', ', $into).") VALUES (".join(', ', $values).")";
static::query($sql);
$pk = static::$primaryKey;
$this->$pk = $db->insert_id;
}
/**
* Revisa si el objeto a guardar es nuevo o no y según el resultado
* llama a update para actualizar o add para insertar una nueva fila.
*/
public function save() {
$pk = static::$primaryKey;
if (isset($this->$pk))
$this->update();
else
$this->add();
}
/**
* Elimina el objeto actual de la base de datos.
*/
public function delete() {
$atts = $this->getVars();
foreach ($atts as $key => $value) {
$value = static::db()->real_escape_string($value);
$set[]="$key='$value'";
}
$table = static::table();
$pk = static::$primaryKey;
$pkv = $this->$pk;
$sql = "DELETE FROM $table WHERE $pk='$pkv'";
static::query($sql);
}
/**
* Define SELECT en la sentencia SQL.
*
* @param array $columns
* Columnas que se selecionarán en la consulta SQL.
*
* @return ModelMySQL
*/
public static function select(array $columns) : ModelMySQL {
$db = static::db();
$select = [];
foreach($columns as $column) {
$select[] = $db->real_escape_string($column);
}
static::$querySelect['select'] = $select;
return new static();
}
/**
* Define FROM en la sentencia SQL.
*
* @param array $tables
* Tablas que se selecionarán en la consulta SQL.
*
* @return ModelMySQL
*/
public static function from(array $tables) : ModelMySQL {
$db = static::db();
$from = [];
foreach($tables as $table) {
$from[] = $db->real_escape_string($table);
}
static::$querySelect['from'] = join(', ', $from);
return new static();
}
/**
* Define el WHERE en la sentencia SQL.
*
* @param string $column
* La columna a comparar.
*
* @param string $operador
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string $value
* (opcional) El valor el valor a comparar en la columna.
*
* @param bool $no_quote
* (opcional) Se usa cuando $value es una columna o un valor que no requiere comillas.
*
* @return ModelMySQL
*/
public static function where(string $column, string $operator, string $value=null, bool $no_quote = false) : ModelMySQL {
if (is_null($value)) {
$value = $operator;
$operator = '=';
}
$value = static::db()->real_escape_string($value);
if ($no_quote)
static::$querySelect['where'] = "$column$operator$value";
else
static::$querySelect['where'] = "$column$operator'$value'";
return new static();
}
/**
* Define WHERE usando IN en la sentencia SQL.
*
* @param string $column
* La columna a comparar.
*
* @param array $arr
* Arreglo con todos los valores a comparar con la columna.
*
* @param bool $in
* Define si se tienen que comprobar negativa o positivamente.
*
* @return ModelMySQL
*/
public static function where_in(string $column, array $arr, bool $in = true) : ModelMySQL {
foreach($arr as $index => $value) {
$arr[$index] = static::db()->real_escape_string($value);
}
if ($in)
static::$querySelect['where'] = "$column IN (".join(', ',$arr).")";
else
static::$querySelect['where'] = "$column NOT IN (".join(', ',$arr).")";
return new static();
}
/**
* Define LEFT JOIN en la sentencia SQL.
*
* @param string $table
* Tabla que se va a juntar a la del objeto actual.
*
* @param string $columnA
* Columna a comparar para hacer el join.
*
* @param string $operador
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string $columnB
* (opcional) Columna a comparar para hacer el join.
*
* @return ModelMySQL
*/
public static function leftJoin(string $table, string $columnA, string $operator, string $columnB = null) : ModelMySQL {
if (is_null($columnB)) {
$columnB = $operator;
$operator = '=';
}
$columnA = static::db()->real_escape_string($columnA);
$columnB = static::db()->real_escape_string($columnB);
static::$querySelect['leftJoin'] .= ' LEFT JOIN ' . $table . ' ON ' . "$columnA$operator$columnB";
return new static();
}
/**
* Define RIGHT JOIN en la sentencia SQL.
*
* @param string $table
* Tabla que se va a juntar a la del objeto actual.
*
* @param string $columnA
* Columna a comparar para hacer el join.
*
* @param string $operador
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string $columnB
* (opcional) Columna a comparar para hacer el join.
*
* @return ModelMySQL
*/
public static function rightJoin(string $table, string $columnA, string $operator, string $columnB = null) : ModelMySQL {
if (is_null($columnB)) {
$columnB = $operator;
$operator = '=';
}
$columnA = static::db()->real_escape_string($columnA);
$columnB = static::db()->real_escape_string($columnB);
static::$querySelect['rightJoin'] .= ' RIGHT JOIN ' . $table . ' ON ' . "$columnA$operator$columnB";
return new static();
}
/**
* Define INNER JOIN en la sentencia SQL.
*
* @param string $table
* Tabla que se va a juntar a la del objeto actual.
*
* @param string $columnA
* Columna a comparar para hacer el join.
*
* @param string $operador
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string $columnB
* (opcional) Columna a comparar para hacer el join.
*
* @return ModelMySQL
*/
public static function innerJoin(string $table, string $columnA, string $operator, string $columnB = null) : ModelMySQL {
if (is_null($columnB)) {
$columnB = $operator;
$operator = '=';
}
$columnA = static::db()->real_escape_string($columnA);
$columnB = static::db()->real_escape_string($columnB);
static::$querySelect['innerJoin'] .= ' INNER JOIN ' . $table . ' ON ' . "$columnA$operator$columnB";
return new static();
}
/**
* Define AND en la sentencia SQL (se puede anidar).
*
* @param string $column
* La columna a comparar.
*
* @param string $operador
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string $value
* (opcional) El valor el valor a comparar en la columna.
*
* @param bool $no_quote
* (opcional) Se usa cuando $value es una columna o un valor que no requiere comillas.
*
* @return ModelMySQL
*/
public static function and(string $column, string $operator, string $value=null, bool $no_quote = false) : ModelMySQL {
if (is_null($value)) {
$value = $operator;
$operator = '=';
}
$value = static::db()->real_escape_string($value);
if ($no_quote)
static::$querySelect['AndOr'] .= " AND $column$operator$value";
else
static::$querySelect['AndOr'] .= " AND $column$operator'$value'";
return new static();
}
/**
* Define OR en la sentencia SQL (se puede anidar).
*
* @param string $column
* La columna a comparar.
*
* @param string $operador
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string $value
* (opcional) El valor el valor a comparar en la columna.
*
* @param bool $no_quote
* (opcional) Se usa cuando $value es una columna o un valor que no requiere comillas.
*
* @return ModelMySQL
*/
public static function or(string $column, string $operator, string $value=null, bool $no_quote = false) : ModelMySQL {
if (is_null($value)) {
$value = $operator;
$operator = '=';
}
$value = static::db()->real_escape_string($value);
if ($no_quote)
static::$querySelect['AndOr'] .= " OR $column$operator$value";
else
static::$querySelect['AndOr'] .= " OR $column$operator'$value'";
return new static();
}
/**
* Define GROUP BY en la sentencia SQL.
*
* @param array $arr
* Columnas por las que se agrupará.
*
* @return ModelMySQL
*/
public static function groupBy(array $arr) : ModelMySQL {
static::$querySelect['groupBy'] = join(', ', $arr);
return new static();
}
/**
* Define LIMIT en la sentencia SQL.
*
* @param int $initial
* @param int $final
*
* @return ModelMySQL
*/
public static function limit(int $initial, int $final = 0) : ModelMySQL {
if ($final==0)
static::$querySelect['limit'] = $initial;
else
static::$querySelect['limit'] = $initial.', '.$final;
return new static();
}
/**
* Define ORDER BY en la sentencia SQL.
*
* @param string $value
* Columna por la que se ordenará.
*
* @param string $order
* (opcional) Define si el orden será de manera ascendente (ASC),
* descendente (DESC) o aleatorio (RAND).
*
* @return ModelMySQL
*/
public static function orderBy(string $value, string $order = 'ASC') : ModelMySQL {
if ($value == "RAND") {
static::$querySelect['orderBy'] = 'RAND()';
return new static();
}
$value = static::db()->real_escape_string($value);
if (!(strtoupper($order) == 'ASC' || strtoupper($order) == 'DESC'))
$order = 'ASC';
static::$querySelect['orderBy'] = $value.' '.$order;
return new static();
}
/**
* Retorna la cantidad de filas que hay en un query.
*
* @param bool $resetQuery
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @param bool $useLimit
* (opcional) Permite usar limit para estabecer un máximo inical y final para contar. Requiere que se haya definido antes el límite (por defecto en false).
*
* @return int
*/
public static function count(bool $resetQuery = true, bool $useLimit = false) : int {
if (!$resetQuery)
$backup = [
'select' => static::$querySelect['select'],
'sql_calc_found_rows' => static::$querySelect['sql_calc_found_rows'],
'limit' => static::$querySelect['limit'],
'orderBy' => static::$querySelect['orderBy']
];
if ($useLimit && static::$querySelect['limit'] != '') {
static::$querySelect['select'] = ['1'];
static::$querySelect['sql_calc_found_rows'] = false;
static::$querySelect['orderBy'] = '';
$sql = 'SELECT COUNT(1) AS quantity FROM ('.static::buildQuery($resetQuery).') AS counted';
$queryResult = static::query($sql)->fetch_assoc();
$result = $queryResult['quantity'];
} else {
static::$querySelect['select'] = ['1'];
static::$querySelect['sql_calc_found_rows'] = true;
static::$querySelect['limit'] = '1';
static::$querySelect['orderBy'] = '';
$sql = static::buildQuery($resetQuery);
static::query($sql);
$result = static::found_row();
}
if (!$resetQuery) {
static::$querySelect['select'] = $backup['select'];
static::$querySelect['sql_calc_found_rows'] = $backup['sql_calc_found_rows'];
static::$querySelect['limit'] = $backup['limit'];
static::$querySelect['orderBy'] = $backup['orderBy'];
}
return $result;
}
/**
* Retorna las filas contadas en el último query.
*
* @return int
*/
public static function found_row() : int {
$result = static::query('SELECT FOUND_ROWS() AS quantity')->fetch_assoc();
return $result['quantity'];
}
/**
* Habilita el conteo de todos las coincidencias posibles incluso usando limit.
*
* @return ModelMySQL
*/
public static function sql_calc_found_rows() : ModelMySQL {
static::$querySelect['sql_calc_found_rows'] = true;
return new static();
}
/**
* Obtiene una instancia según su primary key (generalmente id).
*
* @param mixed $id
* @return ModelMySQL
*/
public static function getById($id) : ModelMySQL {
return static::where(static::$primaryKey, $id)->getFirst();
}
/**
* Realiza una búsqueda en la tabla de la instancia actual.
*
* @param string $search
* Contenido a buscar.
*
* @param array $in
* (opcional) Columnas en las que se va a buscar (null para buscar en todas).
*
* @return ModelMySQL
*/
public static function search(string $search, array $in = null) : ModelMySQL {
if ($in == null) {
$className = get_called_class();
$in = array_keys((new $className())->getVars());
}
$db = static::db();
$search = $db->real_escape_string($search);
$where = [];
foreach($in as $row) {
$where[] = "$row LIKE '%$search%'";
}
if (static::$querySelect['where']=='')
static::$querySelect['where'] = join(' OR ', $where);
else
static::$querySelect['where'] = static::$querySelect['where'] .' AND ('.join(' OR ', $where).')';
return new static();
}
/**
* Obtener los resultados de la consulta SQL.
*
* @param bool $resetQuery
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return array
* Contiene un arreglo de instancias de la clase actual.
*/
public static function get(bool $resetQuery = true) : array { // Devuelve array vacío si no encuentra nada.
$sql = static::buildQuery($resetQuery);
$result = static::query($sql);
$instances = [];
while ($row = $result->fetch_assoc()) {
$instances[] = static::getInstance($row);
}
return $instances;
}
/**
* El primer elemento de la consulta SQL.
*
* @param bool $resetQuery
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return mixed
* Puede retornar un objeto ModelMySQL o null.
*/
public static function getFirst(bool $resetQuery = true) { // Devuelve null si no encuentra nada.
static::limit(1);
$instances = static::get($resetQuery);
return empty($instances) ? null : $instances[0];
}
/**
* Obtener todos los elementos del la tabla de la instancia actual.
*
* @return array
* Contiene un arreglo de instancias de la clase actual.
*/
public static function all() : array {
$sql = 'SELECT * FROM '.static::table();
$result = static::query($sql);
$instances = [];
while ($row = $result->fetch_assoc()) {
$instances[] = static::getInstance($row);
}
return $instances;
}
/**
* Permite definir como nulo el valor de un atributo.
* Sólo funciona para actualizar un elemento de la BD, no para insertar.
*
* @trows \Exception
* Devolverá un error en caso de usarse en un insert.
*
* @param array $atts
*/
public function setNull(array $atts) {
if (!isset($this->id))
throw new \Exception(
"\nEl método setNull sólo funciona para actualizar, no al insertar."
);
foreach ($atts as $att) {
if (!in_array($att, $this->toNull))
$this->toNull[] = $att;
}
}
}
?>

View File

@ -11,43 +11,28 @@
* El constructor recibe un objeto o arreglo con los valores que * El constructor recibe un objeto o arreglo con los valores que
* sí estarán definidos. * sí estarán definidos.
* *
* @author KJ * @autor KJ
* @website https://kj2.me * @website https://kj2.me
* @licence MIT * @licence MIT
*/ */
namespace Libs; namespace Libs;
use AllowDynamicProperties;
#[AllowDynamicProperties]
class Neuron { class Neuron {
/** private $data;
* __construct
*
* @param array $data
*/
public function __construct(...$data)
{
if (count($data) === 1 &&
isset($data[0]) &&
(is_array($data[0]) ||
is_object($data[0])))
$data = $data[0];
foreach($data as $key => $value) public function __construct($data = []){
$this->{$key} = $value; $this->data = (array) $data;
} }
/** public function __isset($index) {
* __get return isset($this->data[$index]);
* }
* @param string $index
* @return null public function __get($index){
*/ return (isset($this->data[$index]) && $this->data[$index] != '')
public function __get(string $index): null ? $this->data[$index] : null;
{
return null;
} }
} }

View File

@ -1,149 +0,0 @@
<?php
/**
* Request - DuckBrain
*
* Libería complementaria de la libería Router.
* Contiene el cuerpo básico de la petición http (POST, GET, JSON, etc).
*
* @author KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
class Request extends Neuron {
public Neuron $get;
public Neuron $post;
public Neuron $put;
public Neuron $patch;
public Neuron $delete;
public Neuron $json;
public Neuron $params;
public string $path;
public string $error;
public string $body;
public array $next;
/**
* __construct
*
* @param string $path Ruta actual tomando como raíz la instalación de DuckBrain.
*/
public function __construct()
{
$this->path = Router::currentPath();
$this->get = new Neuron($_GET);
$this->post = new Neuron($_POST);
$this->put = new Neuron();
$this->patch = new Neuron();
$this->delete = new Neuron();
$this->body = file_get_contents("php://input");
$contentType = isset($_SERVER["CONTENT_TYPE"]) ? trim($_SERVER["CONTENT_TYPE"]) : '';
if ($contentType === "application/json")
$this->json = new Neuron(
(object) json_decode(trim($this->body), false)
);
else {
$this->json = new Neuron();
if (in_array($_SERVER['REQUEST_METHOD'], ['PUT', 'PATCH', 'DELETE']) &&
preg_match('/^[^;?\/:@&=+$,]{1,255}[=]/', $this->body, $matches)) { // Con la expresión regular verificamos que sea un http query string válido y evitamos errores de memoria en caso de que el body tenga algo más grande que eso.
parse_str($this->body, $input_vars);
$this->{strtolower($_SERVER['REQUEST_METHOD'])} = new Neuron($input_vars);
}
}
$this->params = new Neuron();
}
/**
* Corre las validaciones e intenta continuar con la pila de callbacks.
*
* @return mixed
*/
public function handle(): mixed
{
if ($this->validate())
return Middleware::next($this);
return null;
}
/**
* Inicia la validación que se haya configurado.
*
* @return bool
*/
public function validate(): bool
{
$actual = match($_SERVER['REQUEST_METHOD']) {
'POST', 'PUT', 'PATCH', 'DELETE' => $this->{strtolower($_SERVER['REQUEST_METHOD'])},
default => $this->get
};
if (Validator::validateList(static::paramRules(), $this->params) &&
Validator::validateList(static::getRules(), $this->get ) &&
Validator::validateList(static::rules(), $actual))
return true;
if (isset(static::messages()[Validator::$lastFailed]))
$error = static::messages()[Validator::$lastFailed];
else {
$error = 'Error: validation failed of '.preg_replace('/\./', ' as ', Validator::$lastFailed, 1);
}
static::onInvalid($error);
return false;
}
/**
* Reglas para el método actual.
*
* @return array
*/
public function rules(): array {
return [];
}
/**
* Reglas para los parámetros por URL.
*
* @return array
*/
public function paramRules(): array {
return [];
}
/**
* Reglas para los parámetros GET.
*
* @return array
*/
public function getRules(): array {
return [];
}
/**
* Mensajes de error en caso de fallar una validación.
*
* @return array
*/
public function messages(): array {
return [];
}
/**
* Función a ejecutar cuando se ha detectado un valor no válido.
*
* @param string $error
*
* @return void
*/
public function onInvalid(string $error): void
{
http_response_code(422);
print($error);
}
}

View File

@ -1,51 +1,40 @@
<?php <?php
/** /*
* Router - DuckBrain * Router - DuckBrain
* *
* Librería de Enrrutador. * Librería de Enrrutador.
* Depende de manera forzada de que la constante ROOT_DIR esté definida * Depende de manera forzada de que la constante ROOT_DIR esté definida
* y de manera optativa de que la constante SITE_URL lo esté también. * y de manera optativa de que la constante SITE_URL lo esté también.
* *
* @author KJ * Autor: KJ
* @website https://kj2.me * Web: https://kj2.me
* @licence MIT * Licencia: MIT
*/ */
namespace Libs; namespace Libs;
class Router { class Router {
private static $get = []; private static $get = [];
private static $post = []; private static $post = [];
private static $put = []; private static $put = [];
private static $patch = [];
private static $delete = []; private static $delete = [];
private static $last; private static $last;
public static $notFoundCallback = 'Libs\Router::defaultNotFound'; public static $notFoundCallback = 'Libs\Router::defaultNotFound';
/** private static function defaultNotFound () {
* Función callback por defectio para cuando
* no se encuentra configurada la ruta.
*
* @return void
*/
public static function defaultNotFound (): void
{
header("HTTP/1.0 404 Not Found"); header("HTTP/1.0 404 Not Found");
echo '<h2 style="text-align: center;margin: 25px 0px;">Error 404 - Página no encontrada</h2>'; echo '<h2 style="text-align: center;margin: 25px 0px;">Error 404 - Página no encontrada</h2>';
} }
/**
* __construct
*/
private function __construct() {} private function __construct() {}
/** /*
* Parsea para deectar las pseudovariables (ej: {variable}) * Parsea para deectar las pseudovariables (ej: {variable})
* *
* @param string $path * @param string $path
* Ruta con pseudovariables. * Ruta con pseudovariables.
* *
* @param callable $callback * @param mixed $callback
* Callback que será llamado cuando la ruta configurada en $path coincida. * Callback que será llamado cuando la ruta configurada en $path coincida.
* *
* @return array * @return array
@ -53,8 +42,7 @@ class Router {
* path - Contiene la ruta con las pseudovariables reeplazadas por expresiones regulares. * path - Contiene la ruta con las pseudovariables reeplazadas por expresiones regulares.
* callback - Contiene el callback en formato Namespace\Clase::Método. * callback - Contiene el callback en formato Namespace\Clase::Método.
*/ */
private static function parse(string $path, callable $callback): array private static function parse(string $path, $callback) : array {
{
preg_match_all('/{(\w+)}/s', $path, $matches, PREG_PATTERN_ORDER); preg_match_all('/{(\w+)}/s', $path, $matches, PREG_PATTERN_ORDER);
$paramNames = $matches[1]; $paramNames = $matches[1];
@ -64,15 +52,19 @@ class Router {
['([^\/]+)'], ['([^\/]+)'],
$path); $path);
if (!is_callable($callback)) {
$callback = 'Controllers\\'.$callback;
}
return [ return [
'path' => $path, 'path' => $path,
'callback' => [$callback], 'callback' => $callback,
'paramNames' => $paramNames 'paramNames' => $paramNames
]; ];
} }
/** /*
* Devuelve el ruta base o raiz del proyecto sobre la que trabajará el router. * Devuelve el ruta base o raiz del proyecto sobre la que trabajará el router.
* *
* Ej: Si la url del sistema está en "https://ejemplo.com/duckbrain" * Ej: Si la url del sistema está en "https://ejemplo.com/duckbrain"
@ -80,14 +72,13 @@ class Router {
* *
* @return string * @return string
*/ */
public static function basePath(): string public static function basePath() : string {
{ if (defined('SITE_URL'))
if (defined('SITE_URL') && !empty(SITE_URL)) return parse_url(SITE_URL, PHP_URL_PATH);
return rtrim(parse_url(SITE_URL, PHP_URL_PATH), '/').'/';
return str_replace($_SERVER['DOCUMENT_ROOT'], '/', ROOT_DIR); return str_replace($_SERVER['DOCUMENT_ROOT'], '/', ROOT_DIR);
} }
/** /*
* Redirije a una ruta relativa interna. * Redirije a una ruta relativa interna.
* *
* @param string $path * @param string $path
@ -96,269 +87,206 @@ class Router {
* Ej: Si nuesto sistema está en "https://ejemplo.com/duckbrain" * Ej: Si nuesto sistema está en "https://ejemplo.com/duckbrain"
* llamamos a Router::redirect('/docs'), entonces seremos * llamamos a Router::redirect('/docs'), entonces seremos
* redirigidos a "https://ejemplo.com/duckbrain/docs". * redirigidos a "https://ejemplo.com/duckbrain/docs".
* @return void
*/ */
public static function redirect(string $path): void public static function redirect(string $path) {
{ header('Location: '.static::basePath().substr($path,1));
header('Location: '.static::basePath().ltrim($path, '/'));
exit;
} }
/** /*
* Añade un middleware a la última ruta usada. * Añade un middleware a la última ruta usada.
* Solo se puede usar un middleware a la vez. * Solo se puede usar un middleware a la vez.
* *
* @param callable $callback * @param mixed $callback
* @param int $prioriry
* *
* @return static * @return Router
* Devuelve la instancia actual. * Devuelve un enlace estático.
*/ */
public static function middleware(callable $callback, ?int $priority = null): static public static function middleware($callback) : Router{
{
if (!isset(static::$last)) if (!isset(static::$last))
return new static(); return new static();
$method = static::$last[0]; $method = static::$last[0];
$index = static::$last[1]; $index = static::$last[1];
if (isset($priority) && $priority <= 0) if (!is_callable($callback)) {
$priority = 1; $callback = 'Middlewares\\'.$callback;
if (is_null($priority) || $priority >= count(static::$$method[$index]['callback']))
static::$$method[$index]['callback'][] = $callback;
else {
static::$$method[$index]['callback'] = array_merge(
array_slice(static::$$method[$index]['callback'], 0, $priority),
[$callback],
array_slice(static::$$method[$index]['callback'], $priority)
);
} }
return new static(); static::$$method[$index]['middleware'] = $callback;
}
/**
* Reconfigura el callback final de la última ruta.
*
* @param callable $callback
*
* @return static
*/
public static function reconfigure(callable $callback): static
{
if (empty(static::$last))
return new static();
$method = static::$last[0];
$index = static::$last[1];
static::$$method[$index]['callback'][0] = $callback;
return new static(); return new static();
} }
/** /*
* Configura calquier método para todas las rutas. * @return Neuron
* Devuelve un objeto que contiene los atributos:
* post - Donde se encuentran los valores enviados por $_POST.
* get - Donde se encuentran los valores enviados por $_GET.
* json - Donde se encuentran los valores JSON enviados en el body.
* *
* En caso de no recibir un callback, busca la ruta actual
* solo configura la ruta como la última configurada
* siempre y cuando la misma haya sido configurada previamente.
*
* @param string $method
* Método http.
* @param string $path
* Ruta con pseudovariables.
* @param callable|null $callback
*
* @return
* Devuelve la instancia actual.
*/ */
public static function configure(string $method, string $path, ?callable $callback = null): static private static function getReq() : Neuron {
{ $req = new Neuron();
if (is_null($callback)) { $req->get = new Neuron($_GET);
$path = preg_quote($path, '/'); $req->post = new Neuron($_POST);
$path = preg_replace( $req->json = new Neuron(static::get_json());
['/\\\{\w+\\\}/s'], $req->params = new Neuron();
['([^\/]+)'], $req->path = static::currentPath();
$path); return $req;
}
foreach(static::$$method as $index => $router) /*
if ($router['path'] == $path) { * @return object
static::$last = [$method, $index]; * Devuelve un objeto con los datos recibidos en JSON.
break; */
} private static function get_json() : object {
$contentType = isset($_SERVER["CONTENT_TYPE"]) ? trim($_SERVER["CONTENT_TYPE"]) : '';
return new static(); if ($contentType === "application/json") {
return json_decode(trim(file_get_contents("php://input")));
} }
return (object) '';
static::$$method[] = static::parse($path, $callback);
static::$last = [$method, count(static::$$method)-1];
return new static();
} }
/** /*
* Define los routers para el método GET. * Define los routers para el método GET.
* *
* @param string $path * @param string $path
* Ruta con pseudovariables. * Ruta con pseudovariables.
* @param callable|null $callback *
* @param mixed $callback
* Callback que será llamado cuando la ruta configurada en $path coincida. * Callback que será llamado cuando la ruta configurada en $path coincida.
* *
* @return static * @return Router
* Devuelve la instancia actual. * Devuelve un enlace estático.
*/ */
public static function get(string $path, ?callable $callback = null): static public static function get(string $path, $callback) {
{ static::$get[] = static::parse($path, $callback);
return static::configure('get', $path, $callback); static::$last = ['get', count(static::$get)-1];
return new static();
} }
/** /*
* Define los routers para el método POST. * Define los routers para el método POST.
* *
* @param string $path * @param string $path
* Ruta con pseudovariables. * Ruta con pseudovariables.
* @param callable|null $callback *
* @param mixed $callback
* Callback que será llamado cuando la ruta configurada en $path coincida. * Callback que será llamado cuando la ruta configurada en $path coincida.
* *
* @return static * @return Router
* Devuelve la instancia actual. * Devuelve un enlace estático.
*/ */
public static function post(string $path, ?callable $callback = null): static public static function post(string $path, $callback) : Router {
{ static::$post[] = static::parse($path, $callback);
return static::configure('post', $path, $callback); static::$last = ['post', count(static::$post)-1];
return new static();
} }
/** /*
* Define los routers para el método PUT. * Define los routers para el método PUT.
* *
* @param string $path * @param string $path
* Ruta con pseudovariables. * Ruta con pseudovariables.
* @param callable|null $callback *
* @param mixed $callback
* Callback que será llamado cuando la ruta configurada en $path coincida. * Callback que será llamado cuando la ruta configurada en $path coincida.
* *
* @return static * @return Router
* Devuelve la instancia actual * Devuelve un enlace estático
*/ */
public static function put(string $path, ?callable $callback = null): static public static function put(string $path, $callback) : Router {
{ static::$put[] = static::parse($path, $callback);
return static::configure('put', $path, $callback); static::$last = ['put', count(static::$put)-1];
return new static();
} }
/** /*
* Define los routers para el método PATCH.
*
* @param string $path
* Ruta con pseudovariables.
* @param callable|null $callback
* Callback que será llamado cuando la ruta configurada en $path coincida.
*
* @return static
* Devuelve la instancia actual
*/
public static function patch(string $path, ?callable $callback = null): static
{
return static::configure('patch', $path, $callback);
}
/**
* Define los routers para el método DELETE. * Define los routers para el método DELETE.
* *
* @param string $path * @param string $path
* Ruta con pseudovariables * Ruta con pseudovariables
* @param callable|null $callback *
* @param callable $callback
* Callback que será llamado cuando la ruta configurada en $path coincida. * Callback que será llamado cuando la ruta configurada en $path coincida.
* *
* @return static * @return static
* Devuelve la instancia actual * Devuelve un enlace estático
*/ */
public static function delete(string $path, ?callable $callback = null): static public static function delete(string $path, $callback) : Router {
{ static::$delete[] = static::parse($path, $callback);
return static::configure('delete', $path, $callback); static::$last = ['delete', count(static::$delete)-1];
return new static();
} }
/** /*
* Devuelve la ruta actual tomando como raíz la ruta de instalación de DuckBrain. * Devuelve la ruta actual.
* *
* @return string * @return string
*/ */
public static function currentPath() : string public static function currentPath() : string {
{
return preg_replace('/'.preg_quote(static::basePath(), '/').'/', return preg_replace('/'.preg_quote(static::basePath(), '/').'/',
'/', strtok($_SERVER['REQUEST_URI'], '?'), 1); '/', strtok($_SERVER['REQUEST_URI'], '?'), 1);
} }
/** /*
* Aplica la configuración de rutas. * Aplica los routers.
* *
* @param string|null $path (opcional) Ruta a usar. Si no se define, detecta la ruta actual. * Este método ha de ser llamado luego de que todos los routers hayan sido configurados.
* *
* @return void * En caso que la ruta actual coincida con un router configurado, se comprueba si hay middleware; Si hay
* middleware, se enviará el callback y los datos de la petición como un Neuron. Caso contrario, se enviarán
* los datos directamente al callback.
*
* Con middleware:
* $middleware($callback, $req)
*
* Sin middleware:
* $callback($req)
*
* $req es una instancia de Neuron que tiene los datos de la petición.
*
* Si no la ruta no coincide con ninguna de las rutas configuradas, ejecutará el callback $notFoundCallback
*/ */
public static function apply(?string $path = null): void public static function apply() {
{ $path = static::currentPath();
$path = $path ?? static::currentPath(); $routers = [];
$routers = match($_SERVER['REQUEST_METHOD']) { // Según el método selecciona un arreglo de routers switch ($_SERVER['REQUEST_METHOD']){ // Según el método selecciona un arreglo de routers configurados
'POST' => static::$post, case 'POST':
'PUT' => static::$put, $routers = static::$post;
'PATCH' => static::$patch, break;
'DELETE' => static::$delete, case 'PUT':
default => static::$get $routers = static::$put;
}; break;
case 'DELETE':
$routers = static::$delete;
break;
default:
$routers = static::$get;
break;
}
$args = static::getReq();
foreach ($routers as $router) { // revisa todos los routers para ver si coinciden con la ruta actual foreach ($routers as $router) { // revisa todos los routers para ver si coinciden con la ruta actual
if (preg_match_all('/^'.$router['path'].'\/?$/si',$path, $matches, PREG_PATTERN_ORDER)) { if (preg_match_all('/^'.$router['path'].'\/?$/si',$path, $matches, PREG_PATTERN_ORDER)) {
unset($matches[0]); unset($matches[0]);
// Objtener un reflection del callback // Comprobando pseudo variables en la ruta
$lastCallback = $router['callback'][0];
if ($lastCallback instanceof \Closure) { // si es función anónima
$reflectionCallback = new \ReflectionFunction($lastCallback);
} else {
if (is_string($lastCallback))
$lastCallback = preg_split('/::/', $lastCallback);
// Revisamos su es un método o solo una función
if (count($lastCallback) == 2)
$reflectionCallback = new \ReflectionMethod($lastCallback[0], $lastCallback[1]);
else
$reflectionCallback = new \ReflectionFunction($lastCallback[0]);
}
// Obtener los parámetros
$arguments = $reflectionCallback->getParameters();
if (isset($arguments[0])) {
// Obtenemos la clase del primer parámetro
$argumentClass = strval($arguments[0]->getType());
// Verificamos si la clase está o no tipada
if (empty($argumentClass)) {
$request = new Request;
} else {
$request = new $argumentClass;
// Verificamos que sea instancia de Request (requerimiento)
if (!($request instanceof Request))
throw new \Exception('Bad argument type on router callback.');
}
} else {
$request = new Request;
}
// Comprobando y guardando los parámetros variables de la ruta
if (isset($matches[1])) { if (isset($matches[1])) {
foreach ($matches as $index => $match) { foreach ($matches as $index => $match) {
$paramName = $router['paramNames'][$index-1]; $paramName = $router['paramNames'][$index-1];
$request->params->$paramName = urldecode($match[0]); $args->params->$paramName = urldecode($match[0]);
} }
} }
// Llama a la validación y luego procesa la cola de callbacks // Comprobando si hay middleware
$request->next = $router['callback']; if (isset($router['middleware']))
$data = $request->handle(); $data = call_user_func_array($router['middleware'], [$router['callback'], $args]);
else
$data = call_user_func_array($router['callback'], [$args]);
// Por defecto imprime como JSON si se retorna algo
if (isset($data)) { if (isset($data)) {
header('Content-Type: application/json'); header('Content-Type: application/json');
print(json_encode($data)); print(json_encode($data));
@ -369,6 +297,7 @@ class Router {
} }
// Si no hay router que coincida llamamos a $notFoundCallBack // Si no hay router que coincida llamamos a $notFoundCallBack
call_user_func_array(static::$notFoundCallback, [new Request]); call_user_func_array(static::$notFoundCallback, [$args]);
} }
} }
?>

View File

@ -1,201 +0,0 @@
<?php
/**
* Validator - DuckBrain
*
* Libería complementaria de la libería Request.
* Sirve para simplpificar la verificación de valores.
*
* Tiene la posibilida de verificar tanto reglas individuales como en lote.
*
* |----------+--------------------------------------------------------|
* | Regla | Descripción |
* |----------+--------------------------------------------------------|
* | not | Niega la siguiente regla. Ej: not:float |
* | exists | Es requerido; debe estar definido y puede estar vacío |
* | required | Es requerido; debe estar definido y no vacío |
* | number | Es numérico |
* | int | Es entero |
* | float | Es un float |
* | bool | Es booleano |
* | email | Es un correo |
* | enum | Esta en un lista ve valores. Ej: enum:admin,user,guest |
* | url | Es una url válida |
* |----------+--------------------------------------------------------|
*
* Las listas de reglas están separadas por |, Ej: required|email
*
* @author KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
class Validator {
public static string $lastFailed = '';
/**
* Validar lista de reglas sobre las propiedades de un objeto.
*
* @param array $rulesList Lista de reglas.
* @param Neuron $haystack Objeto al que se le verificarán las reglas.
*
* @return bool Retorna true solo si todas las reglas se cumplen y false en cuanto una falle.
*/
public static function validateList(array $rulesList, Neuron $haystack): bool
{
foreach ($rulesList as $target => $rules) {
$rules = preg_split('/\|/', $rules);
foreach ($rules as $rule) {
if (static::checkRule($haystack->{$target}, $rule))
continue;
static::$lastFailed = $target.'.'.$rule;
return false;
}
}
return true;
}
/**
* Revisa si una regla se cumple.
*
* @param mixed $subject Lo que se va a verfificar.
* @param string $rule La regla a probar.
*
* @return bool
*/
public static function checkRule(mixed $subject, string $rule): bool
{
$arguments = preg_split('/[:,]/', $rule);
$rule = [static::class, $arguments[0]];
$arguments[0] = $subject;
if (is_callable($rule))
return call_user_func_array($rule, $arguments);
throw new \Exception('Bad rule: "'.preg_split('/::/', $rule)[1].'"' );
}
/**
* Verifica la regla de manera negativa.
*
* @param mixed $subject Lo que se va a verfificar.
* @param mixed $rule La regla a probar.
*
* @return bool
*/
public static function not(mixed $subject, ...$rule): bool
{
return !static::checkRule($subject, join(':', $rule));
}
/**
* Comprueba que que esté definido/exista.
*
* @param mixed $subject
*
* @return bool
*/
public static function exists(mixed $subject): bool
{
return isset($subject);
}
/**
* Comprueba que que esté definido y no esté vacío.
*
* @param mixed $subject
*
* @return bool
*/
public static function required(mixed $subject): bool
{
return isset($subject) && !empty($subject);
}
/**
* number
*
* @param mixed $subject
*
* @return bool
*/
public static function number(mixed $subject): bool
{
return is_numeric($subject);
}
/**
* int
*
* @param mixed $subject
*
* @return bool
*/
public static function int(mixed $subject): bool
{
return filter_var($subject, FILTER_VALIDATE_INT);
}
/**
* float
*
* @param mixed $subject
*
* @return bool
*/
public static function float(mixed $subject): bool
{
return filter_var($subject, FILTER_VALIDATE_FLOAT);
}
/**
* bool
*
* @param mixed $subject
*
* @return bool
*/
public static function bool(mixed $subject): bool
{
return filter_var($subject, FILTER_VALIDATE_BOOLEAN);
}
/**
* email
*
* @param mixed $subject
*
* @return bool
*/
public static function email(mixed $subject): bool
{
return filter_var($subject, FILTER_VALIDATE_EMAIL);
}
/**
* url
*
* @param mixed $subject
*
* @return bool
*/
public static function url(mixed $subject): bool
{
return filter_var($subject, FILTER_VALIDATE_URL);
}
/**
* enum
*
* @param mixed $subject
* @param mixed $values
*
* @return bool
*/
public static function enum(mixed $subject, ...$values): bool
{
return in_array($subject, $values);
}
}

View File

@ -4,161 +4,35 @@
* *
* Manejador de vistas simplificado. * Manejador de vistas simplificado.
* *
* @author KJ * @autor KJ
* @website https://kj2.me * @website https://kj2.me
* @licence MIT * @licence MIT
*/ */
namespace Libs; namespace Libs;
class View extends Neuron { class View {
/**
* Incluye el archivo.
*
* @param string $viewName Ruta relativa y el nommbre sin extensión del archivo.
* @param string|null $viewPath (opcional) Ruta donde se encuentra la vista.
* @param string $extension (opcional) Extensión del archivo.
*
* @return void
*/
protected function include(
string $viewName,
?string $viewPath = null,
string $extension = 'php'
): void
{
$view = $this;
if (isset($viewPath) &&
file_exists("$viewPath$viewName.$extension")) {
include("$viewPath$viewName.$extension");
return;
}
include(ROOT_CORE."/Views/$viewName.$extension");
}
/** /**
* Función que "renderiza" las vistas * Función que "renderiza" las vistas
* *
* @param string $viewName Ruta relativa y el nommbre sin extensión del archivo. * @param string $viewName
* @param array|Neuron $params (opcional) Arreglo que podrá ser usado en la vista mediante $view ($param['index'] se usaría así: $view->index) * Ruta relativa y el nommbre sin extensión del archivo ubicado en src/Views
* @param string|null $viewPath (opcional) Ruta donde se encuentra la vista. En caso de que la vista no se encuentre en esa ruta, se usará la ruta por defecto "src/Views/".
* @param string $extension (opcional) Extensión del archivo.
* *
* @return void * @param array $params
* (opcional) Arreglo que podrá ser usado en la vista mediante $view ($param['index'] se usaría así: $view->index)
*
* @param string $viewPath
* (opcional) Ruta donde se encuentra la vista. En caso de que la vista no se encuentre en esa ruta, se usará la ruta por defecto "src/Views/".
*/ */
public static function render( public static function render(string $viewName, array $params = [], string $viewPath = null) {
string $viewName, $view = new Neuron($params);
array|Neuron $params = [], unset($params);
?string $viewPath = null,
string $extension = 'php'
): void
{
$instance = new View($params);
$instance->html($viewName, $viewPath, $extension);
}
/** if (isset($viewPath) && file_exists($viewPath.$viewName.'.php'))
* Renderiza las vistas HTML return include($viewPath.$viewName.'.php');
*
* @param string $viewName Ruta relativa y el nommbre sin extensión del archivo ubicado en src/Views
* @param string|null $viewPath (opcional) Ruta donde se encuentra la vista. En caso de que la vista no se encuentre en esa ruta, se usará la ruta por defecto "src/Views/".
* @param string $extension (opcional) Extensión del archivo.
*
* @return void
*/
public function html(
string $viewName,
?string $viewPath = null,
string $extension = 'php'
): void
{
$this->include(
$viewName,
$viewPath,
$extension
);
}
/** include(ROOT_DIR.'/src/Views/'.$viewName.'.php');
* Renderiza código CSS.
*
* @param string $viewName Ruta relativa y el nommbre sin extensión del archivo ubicado en src/Views
* @param string|null $viewPath (opcional) Ruta donde se encuentra la vista. En caso de que la vista no se encuentre en esa ruta, se usará la ruta por defecto "src/Views/".
* @param string $extension (opcional) Extensión del archivo.
*
* @return void
*/
public function css(
string $viewName,
?string $viewPath = null,
string $extension = 'css'
): void
{
header("Content-type: text/css");
$this->include($viewName, $viewPath, $extension);
}
/**
* Renderiza código Javascript.
*
* @param string $viewName Ruta relativa y el nommbre sin extensión del archivo ubicado en src/Views
* @param string|null $viewPath (opcional) Ruta donde se encuentra la vista. En caso de que la vista no se encuentre en esa ruta, se usará la ruta por defecto "src/Views/".
* @param string $extension (opcional) Extensión del archivo.
*
* @return void
*/
public function js(
string $viewName,
?string $viewPath = null,
string $extension = 'js'
): void
{
header("Content-type: application/javascript");
$this->include($viewName, $viewPath, $extension);
}
/**
* Imprime los datos en Json.
*
* @param object|array $data Objeto o array que se imprimirá a JSON.
*
* @return void
*/
public function json(object|array $data): void
{
header('Content-Type: application/json; charset=utf-8');
print(json_encode($data));
}
/**
* Imprime los datos en texto plano
*
* @param string $txt Contenido de texto.
*
* @return void
*/
public function text(string $txt): void
{
header('Content-Type: text/plain; charset=utf-8');
print($txt);
}
/**
* Intenta devolver la url absoluta a partir de una ruta relativa.
*
* @param string $path
*
* @return string
*/
public static function route(string $path = '/'): string
{
if (defined('SITE_URL') && !empty(SITE_URL))
return rtrim(SITE_URL, '/').'/'.ltrim($path, '/');
return $path;
} }
} }
?> ?>