Skip to content

Commit

Permalink
Ajustes a los tags para que se reconozcan en PHPDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
enfoqueNativo committed May 2, 2023
1 parent a4e3f26 commit 6a1c95f
Show file tree
Hide file tree
Showing 17 changed files with 68 additions and 67 deletions.
18 changes: 8 additions & 10 deletions php/lib/registro/toba_registro.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,13 @@ abstract class toba_registro {
const registro_delete = 'registro_delete';

protected $tipo;

protected $tabla; // La tabla a la que pertenece el registro

protected $columnas = array(); // Las columnas del registro

// La tabla a la que pertenece el registro
protected $tabla;

// Las columnas del registro
protected $columnas = array();

protected $conversion_auto_latin1 = true;
protected $conversion_auto_latin1 = true;
/**
* La bd donde se tiene que guardar el registro
* @var toba_db_postgres7
*/
protected $db;
Expand All @@ -37,9 +34,10 @@ 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 boolean $param
*/
function set_conversion_auto_latin1($param)
function set_conversion_auto_latin1(Boolean $param)
{
$this->conversion_auto_latin1 = $param;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ protected function get_path_componente($path_inicial, $tipo, $id)
}

/**
* @param <type> $componente
* @param <type> $path
* @param mixed $componente
* @param string $path
*/
private function generar_componente_borrada(&$componente, $path)
{
Expand Down Expand Up @@ -138,8 +138,8 @@ private function generar_componente_borrada(&$componente, $path)
}

/**
* @param <type> $componente
* @param <type> $path
* @param mixed $componente
* @param string $path
*/
private function generar_componente_modificada(&$componente, $path)
{
Expand Down
12 changes: 6 additions & 6 deletions php/nucleo/componentes/interface/toba_ei_cuadro.php
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ function get_datos()

/**
* @ignore
* @return <type>
* @return mixed
*/
function get_estructura_datos()
{
Expand Down Expand Up @@ -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 int $clave_fila
* @return boolean
*/
function es_clave_fila_seleccionada($clave_fila)
{
Expand Down Expand Up @@ -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)
{
Expand Down
10 changes: 5 additions & 5 deletions php/nucleo/componentes/interface/toba_ei_cuadro_salida_html.php
Original file line number Diff line number Diff line change
Expand Up @@ -424,8 +424,8 @@ function html_pie_corte_control(&$nodo, $es_ultimo)

/**
* @ignore
* @param <type> $nodo
* @param <type> $total_columnas
* @param array $nodo
* @param mixed $total_columnas
*/
function html_cabecera_pie($indice, $nodo, $total_columnas)
{
Expand All @@ -444,8 +444,8 @@ function html_cabecera_pie($indice, $nodo, $total_columnas)

/**
* @ignore
* @param <type> $nodo
* @param <type> $total_columnas
* @param array $nodo
* @param mixed $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)
Expand All @@ -462,7 +462,7 @@ function html_pie_pie($nodo, $total_columnas, $es_ultimo)

/**
* @ignore
* @param <type> $nodo
* @param array $nodo
*/
function html_sumarizacion_usuario($nodo, $total_columnas)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 int $id_fila
* @param toba_formateo $formateo
* @return string
*/
function generar_layout_fila($columnas, $datos_cuadro, $id_fila, $formateo)
Expand Down
2 changes: 1 addition & 1 deletion php/nucleo/componentes/interface/toba_ei_firma.php
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ function set_alto_pdf($alto)

/**
* Servicio que se ejecuta cuando el applet busca/envia el PDF
* @param <type> $parametros
* @param mixed $parametros
* @ignore
*/
function servicio__ejecutar($parametros = null)
Expand Down
8 changes: 4 additions & 4 deletions php/nucleo/componentes/interface/toba_ei_mapa.php
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ function set_extent_activo($xmin, $ymin, $xmax, $ymax)

/**
* @ignore
* @param <type> $datos
* @param mixed $datos
*/
function set_datos($datos)
{
Expand Down Expand Up @@ -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|null
*/
protected function get_url_mapa()
{
Expand All @@ -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 mixed $parametros
* @ignore
*/
function servicio__ejecutar($parametros = null)
Expand Down Expand Up @@ -559,7 +559,7 @@ protected function enviar_archivo($archivo)
/**
* Devuelve la lista de scripts JS utilizados por este componente
* @ignore
* @return <type>
* @return string[]
*/
function get_consumo_javascript()
{
Expand Down
12 changes: 8 additions & 4 deletions php/nucleo/componentes/persistencia/toba_datos_tabla.php
Original file line number Diff line number Diff line change
Expand Up @@ -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}
* @link toba_relacion_entre_tablas toba_relacion_entre_tablas
* @return array
* @ignore
*/
function get_relaciones_con_padres()
Expand All @@ -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}
* @link toba_relacion_entre_tablas toba_relacion_entre_tablas
* @return toba_relacion_entre_tablas
* @ignore
*/
function get_relacion_con_padre($id_tabla_padre)
Expand Down Expand Up @@ -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 relacion que contiene a esta tabla, si existe
* @link toba_datos_relacion relacion
* @return toba_datos_relacion
*/
function get_relacion()
Expand Down Expand Up @@ -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 fuente de datos utilizado por este componente
* @link toba_fuente_datos fuente de datos
* @return string
*/
function get_fuente()
Expand Down
2 changes: 1 addition & 1 deletion php/nucleo/componentes/toba_cargador.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion php/nucleo/lib/autenticacion/toba_autenticacion_ldap.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,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)
{
Expand Down
2 changes: 1 addition & 1 deletion php/nucleo/lib/toba_instancia.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
12 changes: 6 additions & 6 deletions php/nucleo/lib/toba_perfil_datos.php
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ function indexar_gatillos($fuente)

/**
* retorna el perfil de datos del usuario
* @return $value string. Si el usuario no posee un perfil devuelve NULL
* @return string $value. Si el usuario no posee un perfil devuelve NULL
*/
function get_id()
{
Expand All @@ -128,7 +128,7 @@ function get_id()

/**
* retorna un arreglo con los perfiles de datos del usuario
* @return $value array. Si el usuario no posee un perfil devuelve NULL
* @return array $value. Si el usuario no posee un perfil devuelve NULL
*/
function get_ids()
{
Expand All @@ -137,7 +137,7 @@ function get_ids()

/**
* Indica si el perfil de datos del usuario posee restricciones
* @return $value boolean
* @return boolean $value
*/
function posee_restricciones($fuente)
{
Expand All @@ -150,7 +150,7 @@ function posee_restricciones($fuente)

/**
* Retorna un array con las restricciones aplicadas sobre las dimensiones
* @return $value Retorna un array de dimensiones con un subarray de restricciones
* @return array $value Retorna un array de dimensiones con un subarray de restricciones
*/
function get_restricciones( $fuente )
{
Expand All @@ -164,7 +164,7 @@ function get_restricciones( $fuente )
*
* @param varchar $dimension nombre de la dimension a consultar.
* @param unknown_type $fuente_datos fuente de datos donde deberia estar la dimension.
* @return $value boolean
* @return boolean $value
*/
function posee_dimension($dimension, $fuente_datos=null)
{
Expand Down Expand Up @@ -238,7 +238,7 @@ function get_restricciones_dimension_agrupado_perfil($fuente, $nombre)

/**
* Retorna un array con las dimensiones sobre las que se establecieron restricciones
* @return $value Retorna un array de dimensiones
* @return array $value Retorna un array de dimensiones
*/
function get_lista_dimensiones_restringidas($fuente)
{
Expand Down
2 changes: 1 addition & 1 deletion php/nucleo/lib/toba_proyecto.php
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,7 @@ function get_gadgets_proyecto($usuario, $proyecto=null)
/**
* Instancia el objeto correspondiente de acuerdo a la informacion recibida
* ademas asigna los valores de las propiedades existentes
* @param <type> $info
* @param mixed $info
* @ignore
*/
private function get_objeto_gadget($info)
Expand Down
16 changes: 8 additions & 8 deletions php/nucleo/lib/toba_puntos_control.php
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class toba_puntos_control
// ------------------------------------------------------------------------------------

/**
* @ignore.
* @ignore
* @return toba_puntos_control
*/
static function instancia()
Expand All @@ -72,15 +72,15 @@ static function instancia()
// ------------------------------------------------------------------------------------

/**
* @ignore. Retorna el bloque de memoria de trabajo de los puntos de control
* @ignore Retorna el bloque de memoria de trabajo de los puntos de control
*/
private function &get_bloque()
{
return toba::manejador_sesiones()->segmento_memoria_puntos_control();
}

/**
* @ignore. Establece el valor de un parametro de un punto de control en particular.
* @ignore Establece el valor de un parametro de un punto de control en particular.
*/
private function set_valor($punto_control, $parametro, $valor)
{
Expand All @@ -99,7 +99,7 @@ private function set_valor($punto_control, $parametro, $valor)
}

/**
* @ignore. Crea un punto de control.
* @ignore Crea un punto de control.
*/
private function crear_punto_control($punto_control, &$valores_item)
{
Expand Down Expand Up @@ -152,7 +152,7 @@ private function crear_punto_control($punto_control, &$valores_item)
}

/**
* @ignore. Retorna los controles de un punto de control.
* @ignore Retorna los controles de un punto de control.
*/
private function &get_controles($punto_control)
{
Expand All @@ -165,7 +165,7 @@ private function &get_controles($punto_control)
}

/**
* @ignore. Ejecuta un control de un punto de control.
* @ignore Ejecuta un control de un punto de control.
*/
private function ejecutar_control($componente, $punto_control, $control)
{
Expand All @@ -184,7 +184,7 @@ private function ejecutar_control($componente, $punto_control, $control)
}

/**
* @ignore. Almacena el resultado de la ejecucion del control.
* @ignore Almacena el resultado de la ejecucion del control.
*/
private function set_resultado_control($punto_control, $control)
{
Expand All @@ -202,7 +202,7 @@ private function set_resultado_control($punto_control, $control)
}

/**
* @ignore. Actualiza el resultado de la ejecucion del punto de control.
* @ignore Actualiza el resultado de la ejecucion del punto de control.
*/
private function set_resultado($control)
{
Expand Down

0 comments on commit 6a1c95f

Please sign in to comment.