From 503efef4487ce309f1d9f170090f22c4d856f15a Mon Sep 17 00:00:00 2001 From: kj Date: Wed, 23 Feb 2022 20:53:36 -0400 Subject: [PATCH] Update comments to phpdoc compatible format. --- src/Libs/ModelMySQL.php | 145 +++++++++++++++++----------------------- src/Libs/Neuron.php | 10 +-- src/Libs/Router.php | 2 +- src/Libs/View.php | 20 +++--- 4 files changed, 77 insertions(+), 100 deletions(-) diff --git a/src/Libs/ModelMySQL.php b/src/Libs/ModelMySQL.php index 8929f31..e9ae67f 100644 --- a/src/Libs/ModelMySQL.php +++ b/src/Libs/ModelMySQL.php @@ -1,13 +1,13 @@ 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,9 +383,9 @@ 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) { + public static function where_in($column, $arr, $in = true) { foreach($arr as $index => $value) { $arr[$index] = static::db()->real_escape_string($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. * diff --git a/src/Libs/Neuron.php b/src/Libs/Neuron.php index 46414d7..b03283c 100644 --- a/src/Libs/Neuron.php +++ b/src/Libs/Neuron.php @@ -1,6 +1,6 @@ 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);