kj/duckbrain
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update comments to phpdoc compatible format.

Browse Source
This commit is contained in:
kj 2022-02-23 20:53:36 -04:00
parent 81f2d4d665
commit 503efef448
4 changed files with 77 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

143
src/Libs/ModelMySQL.php
View File

@ -1,13 +1,13 @@
<?php
/*
* DuckBrain - Microframework
/**
* 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
* Web: https://kj2.me
* Licencia: MIT
* @autor KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
@ -39,7 +39,7 @@ class ModelMySQL {
'sql_calc_found_rows' => false
];
/*
/**
* Sirve para obtener la instancia de la base de datos.
*
* @return mysqli
@ -51,7 +51,7 @@ class ModelMySQL {
return static::$db;
}
/*
/**
* Ejecuta una sentencia SQL en la base de datos.
*
* @param string $query
@ -80,7 +80,7 @@ class ModelMySQL {
return $result;
}
/*
/**
* Reinicia la configuración de la sentencia SQL.
*/
protected static function resetQuery() {
@ -99,7 +99,7 @@ class ModelMySQL {
];
}
/*
/**
* Construye la sentencia SQL a partir static::$querySelect y una vez
* construída, llama a resetQuery.
*
@ -159,7 +159,7 @@ class ModelMySQL {
return $sql;
}
/*
/**
* Crea una instancia del objeto actual a partir de un arreglo.
*
* @param mixed $elem
@ -180,7 +180,7 @@ class ModelMySQL {
return $instance;
}
/*
/**
* @return array
* Contiene los atributos indexados del objeto actual.
*/
@ -205,7 +205,7 @@ class ModelMySQL {
return $result;
}
/*
/**
* @return string
* Devuelve el nombre de la clase actual.
*/
@ -213,7 +213,7 @@ class ModelMySQL {
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.
@ -226,7 +226,7 @@ class ModelMySQL {
return static::className().static::$tableSufix;
}
/*
/**
* Actualiza los valores en la BD con los valores del objeto actual.
*/
protected function update() {
@ -252,7 +252,7 @@ class ModelMySQL {
static::query($sql);
}
/*
/**
* Inserta una nueva fila en la base de datos a partir del
* objeto actual.
*/
@ -275,7 +275,7 @@ class ModelMySQL {
$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.
*/
@ -287,7 +287,7 @@ class ModelMySQL {
$this->add();
}
/*
/**
* Elimina el objeto actual de la base de datos.
*/
public function delete() {
@ -305,7 +305,7 @@ class ModelMySQL {
static::query($sql);
}
/*
/**
* Define SELECT en la sentencia SQL.
*
* @param array $columns
@ -323,7 +323,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define FROM en la sentencia SQL.
*
* @param array $tables
@ -341,24 +341,21 @@ class ModelMySQL {
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 en la columna en caso de que eloperador sea "=".
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string $value
* El valor el valor a comparar en la columna.
* (opcional) El valor el valor a comparar en la columna.
*
* @param $no_quote
* Se usa cuando $value es una columna o un valor que no requiere comillas
* @param boolean $no_quote
* (opcional) Se usa cuando $value es una columna o un valor que no requiere comillas.
*
* Sintaxis posibles:
* - static::where(columna, operador, valor)
* - static::where(columna, valor) // Operador por defecto "="
*/
public static function where($column, $operator, $value=null, $no_quote = false) {
if (is_null($value)) {
@ -376,7 +373,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define WHERE usando IN en la sentencia SQL.
*
* @param string $column
@ -386,7 +383,7 @@ class ModelMySQL {
* Arreglo con todos los valores a comparar con la columna.
*
* @param boolean $in
* Define si se usará IN o NOT IN en la sentencia SQL.
* (opcional) Define si se usará IN o NOT IN en la sentencia SQL.
*/
public static function where_in($column, $arr, $in = true) {
foreach($arr as $index => $value) {
@ -401,7 +398,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define LEFT JOIN en la sentencia SQL.
*
* @param string $table
@ -411,14 +408,10 @@ class ModelMySQL {
* Columna a comparar para hacer el join.
*
* @param string $operador
* Operador o columna a comparar para hacer el join en caso de que el operador sea "=".
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string $columnB
* Columna a comparar para hacer el join.
*
* Sintaxis posibles:
* - static::leftJoin(tabla,columnaA, operador, columnB)
* - static::leftJoin(tabla,columnaA, columnB) // Operador por defecto "="
* (opcional) Columna a comparar para hacer el join.
*/
public static function leftJoin($table, $columnA, $operator, $columnB = null) {
if (is_null($columnB)) {
@ -435,7 +428,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define RIGHT JOIN en la sentencia SQL.
*
* @param string $table
@ -445,14 +438,11 @@ class ModelMySQL {
* Columna a comparar para hacer el join.
*
* @param string $operador
* Operador o columna a comparar para hacer el join en caso de que el operador sea "=".
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string $columnB
* Columna a comparar para hacer el join.
* (opcional) Columna a comparar para hacer el join.
*
* Sintaxis posibles:
* - static::rightJoin(tabla,columnaA, operador, columnB)
* - static::rightJoin(tabla,columnaA, columnB) // Operador por defecto "="
*/
public static function rightJoin($table, $columnA, $operator, $columnB = null) {
if (is_null($columnB)) {
@ -468,7 +458,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define INNER JOIN en la sentencia SQL.
*
* @param string $table
@ -478,14 +468,10 @@ class ModelMySQL {
* Columna a comparar para hacer el join.
*
* @param string $operador
* Operador o columna a comparar para hacer el join en caso de que el operador sea "=".
* Operador o columna a comparar como igual para hacer el join en caso de que $columnB no se defina.
*
* @param string $columnB
* Columna a comparar para hacer el join.
*
* Sintaxis posibles:
* - static::innerJoin(tabla,columnaA, operador, columnB)
* - static::innerJoin(tabla,columnaA, columnB) // Operador por defecto "="
* (opcional) Columna a comparar para hacer el join.
*/
public static function innerJoin($table, $columnA, $operator, $columnB = null) {
if (is_null($columnB)) {
@ -501,25 +487,21 @@ class ModelMySQL {
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 en la columna en caso de que eloperador sea "=".
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string $value
* El valor el valor a comparar en la columna.
* (opcional) El valor el valor a comparar en la columna.
*
* @param $no_quote
* Se usa cuando $value es una columna o un valor que no requiere comillas.
* (opcional) Se usa cuando $value es una columna o un valor que no requiere comillas.
*
* Sintaxis posibles:
* - static::and(columna, operador, valor).
* - static::and(columna, valor) // Operador por defecto "=".
* - static::and(columna, valor)->and(columna, valor)->and(columna, valor) // anidado.
*/
public static function and($column, $operator, $value=null, $no_quote = false) {
if (is_null($value)) {
@ -537,25 +519,20 @@ class ModelMySQL {
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 en la columna en caso de que eloperador sea "=".
* El operador o el valor a comparar como igual en caso de que $value no se defina.
*
* @param string $value
* El valor el valor a comparar en la columna.
* (opcional) El valor el valor a comparar en la columna.
*
* @param $no_quote
* Se usa cuando $value es una columna o un valor que no requiere comillas.
*
* Sintaxis posibles:
* - static::or(columna, operador, valor).
* - static::or(columna, valor) // Operador por defecto "=".
* - static::or(columna, valor)->or(columna, valor)->or(columna, valor) // anidado.
* (opcional) Se usa cuando $value es una columna o un valor que no requiere comillas.
*/
public static function or($column, $operator, $value=null, $no_quote = false) {
if (is_null($value)) {
@ -573,7 +550,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define GROUP BY en la sentencia SQL.
*
* @param array $arr
@ -596,14 +573,14 @@ class ModelMySQL {
return new static();
}
/*
/**
* Define ORDER BY en la sentencia SQL.
*
* @param string $value
* Columna por la que se ordenará.
*
* @param string $order
* Define si el orden será de manera ascendente (ASC),
* (opcional) Define si el orden será de manera ascendente (ASC),
* descendente (DESC) o aleatorio (RAND).
*/
public static function orderBy($value, $order = 'ASC') {
@ -622,14 +599,14 @@ class ModelMySQL {
return new static();
}
/*
/**
* Retorna la cantidad de filas que hay en un query.
*
* @param boolean $resetQuery
* Indica si el query debe reiniciarse o no (por defecto es true).
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @param boolean $useLimit
* Permite usar limit para estabecer un máximo inical y final para contar. Requiere que se haya definido antes el límite.
* (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
*/
@ -671,7 +648,7 @@ class ModelMySQL {
return $result;
}
/*
/**
* Retorna las filas contadas en el último query.
*
* @return int
@ -681,7 +658,7 @@ class ModelMySQL {
return $result['quantity'];
}
/*
/**
* Habilita el conteo de todos las coincidencias posibles incluso usando limit.
*
* @return ModelMySQL
@ -691,7 +668,7 @@ class ModelMySQL {
return new static();
}
/*
/**
* Obtiene una instancia según su primary key (generalmente id).
*
* @param mixed $id
@ -701,14 +678,14 @@ class 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
* Columnas en las que se va a buscar (null para buscar en todas).
* (opcional) Columnas en las que se va a buscar (null para buscar en todas).
*/
public static function search($search, $in = null) {
if ($in == null) {
@ -734,11 +711,11 @@ class ModelMySQL {
return new static();
}
/*
/**
* Obtener los resultados de la consulta SQL.
*
* @param boolean $resetQuery
* Indica si el query debe reiniciarse o no (por defecto es true).
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return ModelMySQL[]
*/
@ -755,11 +732,11 @@ class ModelMySQL {
return $instances;
}
/*
/**
* El primer elemento de la consulta SQL.
*
* @param boolean $resetQuery
* Indica si el query debe reiniciarse o no (por defecto es true).
* (opcional) Indica si el query debe reiniciarse o no (por defecto es true).
*
* @return mixed
* Puede retornar un objeto ModelMySQL o null.
@ -770,7 +747,7 @@ class ModelMySQL {
return empty($instances) ? null : $instances[0];
}
/*
/**
* Obtener todos los elementos del la tabla de la instancia actual.
*
* @return ModelMySQL[]
@ -789,7 +766,7 @@ class ModelMySQL {
return $instances;
}
/*
/**
* Permite definir como nulo el valor de un atributo.
* Sólo funciona para actualizar un elemento de la BD, no para insertar.
*

10
src/Libs/Neuron.php
View File

@ -1,6 +1,6 @@
<?php
/*
* DuckBrain - Microframework
/**
* Neuron - DuckBrain
*
* Neuron, sirve para crear un objeto que alojará valores, pero
* además tiene la característica especial de que al intentar
@ -11,9 +11,9 @@
* El constructor recibe un objeto o arreglo con los valores que
* sí estarán definidos.
*
* Autor: KJ
* Web: https://kj2.me
* Licencia: MIT
* @autor KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;

2
src/Libs/Router.php
View File

@ -1,6 +1,6 @@
<?php
/*
* DuckBrain - Microframework
* Router - DuckBrain
*
* Librería de Enrrutador.
* Depende de manera forzada de que la constante ROOT_DIR esté definida

18
src/Libs/View.php
View File

@ -1,29 +1,29 @@
<?php
/*
* DuckBrain - Microframework
/**
* View - DuckBrain
*
* Manejador de vistas simplificado.
*
* Autor: KJ
* Web: https://kj2.me
* Licencia: MIT
* @autor KJ
* @website https://kj2.me
* @licence MIT
*/
namespace Libs;
class View {
/*
* Función que "renderizar" las vistas
/**
* Función que "renderiza" las vistas
*
* @param string $viewName
* Ruta relativa y el nommbre sin extensión del archivo ubicado en src/Views
*
* @param array $params
* Arreglo que podrá ser usado en la vista mediante $view ($param['index'] se usaría así: $view->index)
* (opcional) Arreglo que podrá ser usado en la vista mediante $view ($param['index'] se usaría así: $view->index)
*
* @param string $viewPath
* 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/".
* (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($viewName, $params = [], $viewPath = null) {
$view = new Neuron($params);