Merge branch 'release/v3.4.1'

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 [CURRENT](https://github.com/SIU-Toba/framework/compare/master...develop)
 
+[3.4.1](https://github.com/SIU-Toba/framework/releases/tag/v3.4.1) (2024-01-19)
+- Se corrige problema en la clase `toba_logger_ws` que impedia visualizar la documentación de las APIs Rest.
+
 [3.4.0](https://github.com/SIU-Toba/framework/releases/tag/v3.4.0) (2023-12-06)
 - Se incrementa el requerimiento de plataforma a PHP 8.1+
 - Se actualizan los siguientes paquetes 

VERSION

@@ -1 +1 @@
-3.4.0
+3.4.1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "siu-toba-framework",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Framework para desarrollo rápido de aplicaciones web",
   "license": "SEE LICENSE IN licencia.txt",
   "repository": "https://github.com/SIU-Toba/framework.git",

php/consola/comandos/comando_base.php

@@ -5,7 +5,9 @@
  * Class comando_base.
  * @package consola
  */
+
 require_once('comando_toba.php');
+
 class comando_base extends comando_toba
 {
         /**

php/lib/registro/convertible_registro.php

@@ -1,8 +1,7 @@
 <?php
-/* 
+/**
  * Si una clase implementa esta interfaz se dice que es convertible a toba_registro
  */
-
 interface convertible_registro
 {
 	/**

php/lib/registro/toba_registro.php

@@ -1,10 +1,12 @@
 <?php
 /**
- * Clase que representa un registro interviniente en la personalizacion
+ * Clase que representa un registro interviniente en la personalizacion.
+ * 
  * @package Centrales
  * @subpackage Personalizacion
  */
-abstract class toba_registro {
+abstract class toba_registro 
+{
 	const registro_insert = 'registro_insert';
 	const registro_update = 'registro_update';
 	const registro_delete = 'registro_delete';
@@ -37,7 +39,7 @@ function  __construct($db, $nombre_tabla)
 	 * Si es verdadero todos los strings que se pasen como parametro $valor a
 	 * add_columna van a ser convertidos automáticamente a latin1 si están en
 	 * utf8
-	 * @param <type> $param
+	 * @param string $param
 	 */
 	function set_conversion_auto_latin1($param)
 	{
@@ -186,4 +188,4 @@ function get_conflictos_solubles()
 	abstract function to_sql();
 
 }
-?>
+?>

php/modelo/personalizacion/xml/toba_pers_xml_generador.php

@@ -1,6 +1,7 @@
 <?php
 /**
- * Esta clase representa un plan de la personalizacion
+ * Esta clase representa un plan de la personalizacion.
+ * 
  * @package Centrales
  * @subpackage Personalizacion
  */

php/modelo/personalizacion/xml/toba_pers_xml_generador_componentes.php

@@ -6,7 +6,6 @@
  */	
 class toba_pers_xml_generador_componentes extends toba_pers_xml_generador
 {
-
 	/**
 	 *
 	 * @param string $path path del directorio de componentes
@@ -101,8 +100,8 @@ protected function get_path_componente($path_inicial, $tipo, $id)
 	}
 
 	/**
-	 * @param <type> $componente
-	 * @param <type> $path
+	 * @param array $componente
+	 * @param string $path
 	 */
 	private function generar_componente_borrada(&$componente, $path)
 	{
@@ -138,8 +137,8 @@ private function generar_componente_borrada(&$componente, $path)
 	}
 
 	/**
-	 * @param <type> $componente
-	 * @param <type> $path
+	 * @param array $componente
+	 * @param string $path
 	 */
 	private function generar_componente_modificada(&$componente, $path)
 	{

php/modelo/personalizacion/xml/toba_pers_xml_generador_tablas.php

@@ -66,7 +66,5 @@ protected function generar_tabla($path, $nombre_tabla, &$tabla)
 		$xml->cerrar_elemento();
 		$xml->cerrar_documento();
 	}
-
-
 }
 ?>

php/nucleo/componentes/interface/efs/toba_ef.php

@@ -597,7 +597,8 @@ function es_solo_lectura()
 	/**
 	 * Cambia la obligatoriedad de un ef
 	 * Notar que este cambio no se persiste para el siguiente pedido.
-	 * Para cambiar la obligatoriedad durante todo un ciclo cliente-servidor usar {@link toba_ei_formulario::set_efs_obligatorios() set_efs_obligatorios del formulario}
+	 * Para cambiar la obligatoriedad durante todo un ciclo cliente-servidor usar @see toba_ei_formulario::set_efs_obligatorios()
+     * 
 	 * @param boolean $obligatorio
 	 */
 	function set_obligatorio($obligatorio = true)

php/nucleo/componentes/interface/efs/toba_ef_upload.php

@@ -111,7 +111,8 @@ function tiene_estado()
 
 	/**
 	 * Valida que cumpla con la lista de extensiones válidas definidas.
-	 * También chequea los {@link http://www.php.net/manual/en/features.file-upload.errors.php mensajes de error de upload} de php
+	 * También chequea los http://www.php.net/manual/en/features.file-upload.errors.php mensajes de error de upload de php
+     * 
 	 * @return unknown
 	 */
 	function validar_estado()

php/nucleo/componentes/interface/toba_ei_cuadro.php

@@ -524,7 +524,7 @@ function get_datos()
 
 	/**
 	 * @ignore
-	 * @return <type>
+	 * @return array
 	 */
 	function get_estructura_datos()
 	{
@@ -897,8 +897,8 @@ function get_clave_seleccionada()
 
 	/**
 	 * Indica si la clave que se pasa por parametro es igual a la fila actualmente seleccionada.
-	 * @param <type> $clave_fila
-	 * @return <type>
+	 * @param string $clave_fila
+	 * @return boolean
 	 */
 	function es_clave_fila_seleccionada($clave_fila)
 	{
@@ -1791,9 +1791,9 @@ protected function finalizar_ordenamiento()
 
 	/**
 	 * @ignore
-	 * @param <type> $columna
-	 * @param <type> $sentido
-	 * @return <type>
+	 * @param string $columna
+	 * @param string $sentido
+	 * @return boolean
 	 */
 	function es_sentido_ordenamiento_seleccionado($columna, $sentido)
 	{

php/nucleo/componentes/interface/toba_ei_cuadro_salida_html.php

@@ -424,8 +424,8 @@ function html_pie_corte_control(&$nodo, $es_ultimo)
 
 	/**
 	 * @ignore
-	 * @param <type> $nodo
-	 * @param <type> $total_columnas
+	 * @param array $nodo
+	 * @param integer $total_columnas
 	 */
 	function html_cabecera_pie($indice, $nodo, $total_columnas)
 	{
@@ -444,8 +444,8 @@ function html_cabecera_pie($indice, $nodo, $total_columnas)
 
 	/**
 	 * @ignore
-	 * @param <type> $nodo
-	 * @param <type> $total_columnas
+	 * @param array $nodo
+	 * @param integer $total_columnas
 	 * @todo Por el momento no se estaria usando y no se como se usa
 	 */
 	function html_pie_pie($nodo, $total_columnas, $es_ultimo)
@@ -462,7 +462,8 @@ function html_pie_pie($nodo, $total_columnas, $es_ultimo)
 
 	/**
 	 * @ignore
-	 * @param <type> $nodo
+	 * @param array $nodo
+     * @param integer $total_columnas 
 	 */
 	function html_sumarizacion_usuario($nodo, $total_columnas)
 	{

php/nucleo/componentes/interface/toba_ei_cuadro_salida_pdf.php

@@ -112,10 +112,10 @@ function get_opciones_columnas()
 
 	/**
 	 * @ignore
-	 * @param <type> $columnas
-	 * @param <type> $datos_cuadro
-	 * @param <type> $id_fila
-	 * @param <type> $formateo
+	 * @param array $columnas
+	 * @param array $datos_cuadro
+	 * @param string $id_fila
+	 * @param string $formateo
 	 * @return string
 	 */
 	function generar_layout_fila($columnas, $datos_cuadro, $id_fila, $formateo)

php/nucleo/componentes/interface/toba_ei_firma.php

@@ -187,7 +187,7 @@ function set_alto_pdf($alto)
 
 	 /**
 	 * Servicio que se ejecuta cuando el applet busca/envia el PDF
-	 * @param <type> $parametros
+	 * @param array $parametros
 	 * @ignore
 	 */
 	function servicio__ejecutar($parametros = null)

php/nucleo/componentes/interface/toba_ei_formulario.php

@@ -566,7 +566,8 @@ function desactivar_validacion_ef($ef)
 
 	/**
 	 * Establece que un conjunto de efs NO seran enviados al cliente durante una interacción
-	 * Para hacer un ef solo_lectura ver {@link toba_ef::set_solo_lectura() set_solo_lectura del ef}
+	 * Para hacer un ef solo_lectura ver @see toba_ef::set_solo_lectura()
+     * 
 	 * @param array $efs Uno o mas efs, si es nulo se asume todos
 	 */
 	function desactivar_efs($efs=null)

php/nucleo/componentes/interface/toba_ei_mapa.php

@@ -209,7 +209,7 @@ function set_extent_activo($xmin, $ymin, $xmax, $ymax)
 
 	/**
 	 * @ignore
-	 * @param <type> $datos
+	 * @param array $datos
 	 */
 	function set_datos($datos)
 	{
@@ -432,7 +432,7 @@ function generar_botones($clase = '', $extra='')
 	//-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------//
 	/**
 	 * Devuelve el vinculo con la direccion a la que se le pedira el servicio para el grafico del mapa.
-	 * @return <type>
+	 * @return string
 	 */
 	protected function get_url_mapa()
 	{
@@ -445,7 +445,7 @@ protected function get_url_mapa()
 
 	/**
 	 * Servicio que se ejecuta cuando el cliente pide el mapa por URL
-	 * @param <type> $parametros
+	 * @param array $parametros
 	 * @ignore
 	 */
 	function servicio__ejecutar($parametros = null)
@@ -559,7 +559,7 @@ protected function enviar_archivo($archivo)
 	/**
 	 * Devuelve la lista de scripts JS utilizados por este componente
 	 * @ignore
-	 * @return <type>
+	 * @return array
 	 */
 	function get_consumo_javascript()
 	{

php/nucleo/componentes/negocio/toba_cn.php

@@ -73,8 +73,8 @@ function cancelar()
 	/**
 	 * El procesamiento se dispara cuando la entrega de datos ci->cn ha finalizado
 	 * Se inicia una transaccion de base de datos y dentro de ella se llama a :
-	 *  - {@link evt__validar_datos() evt__validar_datos} 
-	 *  - {@link evt__procesar_especifico() evt__procesar_especifico}
+	 * @see evt__validar_datos()
+	 * @see evt__procesar_especifico()
 	 *  Una vez terminada la transacción se invoca a la limpieza de memoria
 	 * 
 	 * @todo Ver la posibilidad de usar ignore_user_abort() para evitar problemas con medios no transaccionales

php/nucleo/componentes/persistencia/toba_ap_tabla_db.php

@@ -2,7 +2,7 @@
 define("apex_db_registros_separador","%");
 
 /**
- * Administrador de persistencia a una tabla de DB desde un {@link toba_datos_tabla datos_tabla}
+ * Administrador de persistencia a una tabla de DB desde un @see toba_datos_tabla
  * Supone que la tabla de datos se va a mapear a algun tipo de estructura en una base de datos
  *
  * TODO Poder desactivar el control de sincronizacion (¿se necesita esto?)
@@ -765,7 +765,7 @@ protected function evt__post_delete($id_registro){}
 	//-------------------------------------------------------------------------------
 
 	/**
-	 * Shortcut de {@link toba_db::ejecutar() toba::db()->ejecutar}
+	 * Shortcut de @see toba_db::ejecutar()
 	 */
 	protected function ejecutar_sql($sql, $id_fila=null)
 	{

php/nucleo/componentes/persistencia/toba_datos_relacion.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Mantiene un conjunto relacionado de {@link toba_datos_tabla datos_tabla}, brindando servicios para cargar y sincronizar esta relación con algún medio de persistencia (general una BD relacional)
+ * Mantiene un conjunto relacionado de @see toba_datos_tabla , brindando servicios para cargar y sincronizar esta relación con algún medio de persistencia (general una BD relacional)
  * 
  * TODO En el dump_esquema incluir la posición actual de los cursores
  * @package Componentes\Persistencia

php/nucleo/componentes/persistencia/toba_datos_tabla.php

@@ -227,7 +227,8 @@ function agregar_relacion_con_padre($relacion, $id_padre)
 
 	/**
 	 * Retorna las relaciones con las tablas padre
-	 * @return array de {@link toba_relacion_entre_tablas toba_relacion_entre_tablas}
+	 * @return array 
+     * @see toba_relacion_entre_tablas
 	 * @ignore 
 	 */
 	function get_relaciones_con_padres()
@@ -237,7 +238,8 @@ function get_relaciones_con_padres()
 
 	/**
 	 * Retorna la relación con una tabla padre
-	 * @return {@link toba_relacion_entre_tablas toba_relacion_entre_tablas}
+	 * @return object 
+     * @see toba_relacion_entre_tablas
 	 * @ignore 
 	 */	
 	function get_relacion_con_padre($id_tabla_padre)
@@ -294,7 +296,8 @@ function notificar_hijos_sincronizacion($filas=array())
 
 
 	/**
-	 * Retorna la {@link toba_datos_relacion relacion} que contiene a esta tabla, si existe
+	 * Retorna la @see toba_datos_relacion que contiene a esta tabla, si existe
+     * 
 	 * @return toba_datos_relacion
 	 */
 	function get_relacion()
@@ -1665,7 +1668,8 @@ function get_columnas()
 	}
 
 	/**
-	 * Retorna el nombre de la {@link toba_fuente_datos fuente de datos} utilizado por este componente
+	 * Retorna el nombre de la @see toba_fuente_datos utilizado por este componente
+     * 
 	 * @return string
 	 */
 	function get_fuente()

php/nucleo/componentes/toba_cargador.php

@@ -181,7 +181,7 @@ protected function armar_clave($db, $tabla, &$definicion, $cant_registros)
 	 *
 	 * @param array $registros
 	 * @param string $claves es un string separado por ; con las claves del registro.
-	 * @return <type>
+	 * @return array
 	 */
 	protected function reorganizar_tablas($tabla, &$registros, $claves)
 	{

php/nucleo/componentes/toba_componente.php

@@ -137,7 +137,7 @@ function get_clave_memoria_global()
 	}
 
 	/**
-	 * Shortcut de {@link toba_logger::debug() toba::logger()->debug} que incluye información básica del componente actual
+	 * Shortcut de @see toba_logger::debug() que incluye información básica del componente actual
 	 */
 	protected function log($txt)
 	{

php/nucleo/lib/autenticacion/toba_autenticacion_ldap.php

@@ -36,7 +36,7 @@ function __construct($server=null, $dn=null) {
 
 	/**
 	*	Realiza la autentificacion utilizando un servidor LDAP
-	*	@return $value	Retorna TRUE o FALSE de acuerdo al estado de la autentifiacion
+	*	@return boolean Retorna TRUE o FALSE de acuerdo al estado de la autentifiacion
 	*/
 	function autenticar($id_usuario, $clave, $datos_iniciales=null)
 	{	

php/nucleo/lib/toba_instancia.php

@@ -497,7 +497,7 @@ function get_datos_perfiles_funcionales_usuario_proyecto($usuario, $proyecto)
 
 	/**
 	*	Retorna los perfiles funcionales que tiene asociado un usuario a un proyecto
-	*	@return $value	Retorna un array de grupos de acceso
+	*	@return array Retorna un array de grupos de acceso
 	*/
 	function get_perfiles_funcionales($usuario, $proyecto)
 	{

php/nucleo/lib/toba_logger_ws.php

@@ -54,7 +54,7 @@ public function set_log_handler($log_handler)
 		$this->modo_archivo = false;
 	}
 
-	public function log($level, $message, array $context = array())
+	public function log($level, $message, array $context = array()): void
 	{
 		if (! $this->activo) {			//Si no estoy logueando ni me gasto.
 			return;