Skip to main content

1. Introducción

Este documento describe la API interna del sistema de gestión de árbitros Sprint-3, documentada siguiendo los estándares PHPDoc para el código PHP y JSDoc para el código JavaScript. La documentación incluye:
  • Descripción de clases y métodos
  • Parámetros de entrada y tipos de retorno
  • Ejemplos de uso cuando es pertinente
  • Relaciones entre componentes

2. Documentación PHP (PHPDoc)

2.1 Modelos

Los modelos se encuentran en src/www/modelos/ y extienden de ModeloBase.

ModeloBase


ModeloUsuario


ModeloArbitro


ModeloPartido


ModeloCategoria


ModeloDisponibilidad


ModeloLicencia


ModeloLiquidacion


2.2 Controladores

Los controladores se encuentran en src/www/controladores/.

ControladorAutenticacion


ControladorUsuario


ControladorArbitro


ControladorPartido


ControladorDisponibilidad


ControladorPerfil


ControladorLicencia


ControladorLiquidacion


3. Documentación JavaScript (JSDoc)

Los archivos JavaScript se encuentran en src/www/js/.

3.1 Módulo Principal (app.js)


3.2 Módulo de Usuarios (usuarios.js)


3.3 Módulo de Partidos (partidos.js)


3.4 Módulo de Árbitros (arbitros.js)


3.5 Módulo de Disponibilidad (disponibilidad.js)


3.6 Módulo de Liquidaciones (liquidaciones.js)


3.7 Módulo de Licencias (licencias.js)


3.8 Módulo de Modales (modales.js)


3.9 Módulo Cambiar Contraseña (cambiar_password.js)


3.10 Módulo WCAG AAA (wcag-aaa.js)


3.11 Módulo Nielsen (nielsen.js)


4. Convenciones de Documentación

4.1 PHPDoc

4.2 JSDoc


Antonio Gat Fernández | [email protected]
Last modified on June 3, 2026