EuskadiTech/Axia4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Agregar API del Comedor para gestionar menús y tipos de menú

Browse Source
This commit is contained in:
Naiel
2026-02-18 13:45:37 +00:00
parent 1e6f6be18f
commit ce318a7322
2 changed files with 672 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

261
public_html/entreaulas/api/README.comedor.md Normal file
View File

@@ -0,0 +1,261 @@
# API del Comedor
Esta API permite acceder y gestionar los datos de menús del comedor de forma programática mediante JSON.
## Autenticación
La API utiliza el mismo sistema de autenticación que el resto de la aplicación. Todas las solicitudes deben estar autenticadas a través de la sesión PHP.
## Permisos
- **Lectura (GET)**: Requiere permiso `entreaulas:docente`
- **Escritura (POST)**: Requiere permisos `sysadmin:access` (además de `entreaulas:docente`)
## Endpoints
### 1. Obtener tipos de menú
**GET** `/entreaulas/api/comedor.php?action=get_menu_types&aulario={aulario_id}`
Devuelve todos los tipos de menú disponibles para un aulario.
**Parámetros:**
- `aulario` (requerido): ID del aulario
**Ejemplo de respuesta:**
```json
{
"success": true,
"menu_types": [
{
"id": "basal",
"label": "Menú basal",
"color": "#0d6efd"
},
{
"id": "vegetariano",
"label": "Menú vegetariano",
"color": "#198754"
},
{
"id": "alergias",
"label": "Menú alergias",
"color": "#dc3545"
}
]
}
```
---
### 2. Obtener menú de un día
**GET** `/entreauals/api/comedor.php?action=get_menu&aulario={aulario_id}&date={date}&menu={menu_type_id}`
Obtiene el menú de un día específico y tipo de menú.
**Parámetros:**
- `aulario` (requerido): ID del aulario
- `date` (opcional): Fecha en formato YYYY-MM-DD (por defecto: hoy)
- `menu` (opcional): ID del tipo de menú (por defecto: primer tipo disponible)
**Ejemplo de respuesta:**
```json
{
"success": true,
"date": "2026-02-18",
"menu_type": "basal",
"menu_types": [/* lista de tipos de menú */],
"menu": {
"plates": {
"primero": {
"name": "Lentejas",
"pictogram": ""
},
"segundo": {
"name": "Pollo asado",
"pictogram": "basal_segundo_pict.jpg"
},
"postre": {
"name": "Manzana",
"pictogram": ""
}
}
}
}
```
---
### 3. Guardar menú
**POST** `/entreaulas/api/comedor.php?action=save_menu&aulario={aulario_id}`
Guarda o actualiza un menú para un día específico.
**Parámetros (JSON):**
```json
{
"date": "2026-02-18",
"menu_type": "basal",
"plates": {
"primero": {
"name": "Lentejas"
},
"segundo": {
"name": "Pollo asado"
},
"postre": {
"name": "Manzana"
}
}
}
```
**Ejemplo de uso con curl:**
```bash
curl -X POST "http://localhost/entreaulas/api/comedor.php?action=save_menu&aulario=aulario_id" \
-H "Content-Type: application/json" \
-d '{
"date": "2026-02-18",
"menu_type": "basal",
"plates": {
"primero": {"name": "Sopa"},
"segundo": {"name": "Pescado"},
"postre": {"name": "Yogur"}
}
}'
```
---
### 4. Añadir nuevo tipo de menú
**POST** `/entreaulas/api/comedor.php?action=add_menu_type&aulario={aulario_id}`
Crea un nuevo tipo de menú.
**Parámetros (JSON):**
```json
{
"id": "celiaco",
"label": "Menú celíaco",
"color": "#ff9800"
}
```
**Ejemplo de uso con curl:**
```bash
curl -X POST "http://localhost/entreaulas/api/comedor.php?action=add_menu_type&aulario=aulario_id" \
-H "Content-Type: application/json" \
-d '{
"id": "celiaco",
"label": "Menú celíaco",
"color": "#ff9800"
}'
```
---
### 5. Renombrar tipo de menú
**POST** `/entreaulas/api/comedor.php?action=rename_menu_type&aulario={aulario_id}`
Cambia el nombre o color de un tipo de menú existente.
**Parámetros (JSON):**
```json
{
"id": "basal",
"label": "Menú estándar",
"color": "#0d6efd"
}
```
---
### 6. Eliminar tipo de menú
**POST** `/entreaulas/api/comedor.php?action=delete_menu_type&aulario={aulario_id}`
Elimina un tipo de menú.
**Parámetros (JSON o form-data):**
```json
{
"id": "celiaco"
}
```
---
## Códigos de error
| Código | Descripción |
|--------|-------------|
| `FORBIDDEN` (403) | Sin permisos suficientes |
| `INVALID_SESSION` (400) | Centro no encontrado en la sesión |
| `MISSING_PARAM` (400) | Parámetro requerido no proporcionado |
| `INVALID_FORMAT` (400) | Formato inválido (ej: fecha) |
| `INVALID_MENU_TYPE` (400) | Tipo de menú inválido |
| `DUPLICATE` (400) | El tipo de menú ya existe |
| `NOT_FOUND` (404) | Recurso no encontrado |
| `INVALID_ACTION` (400) | Acción no reconocida |
---
## Ejemplos en JavaScript
### Obtener menú actual
```javascript
async function obtenerMenu(aularioId) {
const response = await fetch(
`/entreaulas/api/comedor.php?action=get_menu&aulario=${aularioId}`
);
const data = await response.json();
return data.menu;
}
```
### Guardar menú
```javascript
async function guardarMenu(aularioId, fecha, tipoMenu, platos) {
const response = await fetch(
`/entreaulas/api/comedor.php?action=save_menu&aulario=${aularioId}`,
{
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
date: fecha,
menu_type: tipoMenu,
plates: platos
})
}
);
return await response.json();
}
```
### Obtener tipos de menú
```javascript
async function obtenerTiposMenu(aularioId) {
const response = await fetch(
`/entreaulas/api/comedor.php?action=get_menu_types&aulario=${aularioId}`
);
const data = await response.json();
return data.menu_types;
}
```
---
## Notas
- La API devuelve JSON con charset UTF-8
- Las fechas se usan en formato `YYYY-MM-DD`
- Los colores se especifican en formato hexadecimal (ej: `#0d6efd`)
- Las imágenes de pictogramas no se pueden subir directamente a través de la API JSON
- Para compartir datos de comedor entre aularios, usar la configuración de `shared_comedor_from` en el archivo del aulario

411
public_html/entreaulas/api/comedor.php Normal file
View File

@@ -0,0 +1,411 @@
<?php
header("Content-Type: application/json; charset=utf-8");
require_once __DIR__ . "/../_incl/auth_redir.php";
// Check permissions
if (!in_array("entreaulas:docente", $_SESSION["auth_data"]["permissions"] ?? [])) {
http_response_code(403);
die(json_encode(["error" => "Access denied", "code" => "FORBIDDEN"]));
}
$centro_id = $_SESSION["auth_data"]["entreaulas"]["centro"] ?? "";
if ($centro_id === "") {
http_response_code(400);
die(json_encode(["error" => "Centro not found in session", "code" => "INVALID_SESSION"]));
}
$action = $_GET["action"] ?? ($_POST["action"] ?? "");
$aulario_id = $_GET["aulario"] ?? $_POST["aulario"] ?? "";
// Validate aulario_id
if ($aulario_id === "") {
http_response_code(400);
die(json_encode(["error" => "aulario parameter is required", "code" => "MISSING_PARAM"]));
}
// Verify that the user has access to this aulario
$userAulas = $_SESSION["auth_data"]["entreaulas"]["aulas"] ?? [];
if (!in_array($aulario_id, $userAulas)) {
http_response_code(403);
die(json_encode(["error" => "Access denied to this aulario", "code" => "FORBIDDEN"]));
}
$aulario_path = "/DATA/entreaulas/Centros/$centro_id/Aularios/$aulario_id.json";
$aulario = file_exists($aulario_path) ? json_decode(file_get_contents($aulario_path), true) : null;
// Handle shared comedor data
$source_aulario_id = $aulario_id;
$is_shared = false;
if ($aulario && !empty($aulario["shared_comedor_from"])) {
$shared_from = $aulario["shared_comedor_from"];
$shared_aulario_path = "/DATA/entreaulas/Centros/$centro_id/Aularios/$shared_from.json";
if (file_exists($shared_aulario_path)) {
$source_aulario_id = $shared_from;
$is_shared = true;
}
}
// Check edit permissions (must be sysadmin and not shared)
$canEdit = in_array("sysadmin:access", $_SESSION["auth_data"]["permissions"] ?? []) && !$is_shared;
// Helper functions
function get_menu_types($centro_id, $source_aulario_id) {
$menuTypesPath = "/DATA/entreaulas/Centros/$centro_id/Aularios/$source_aulario_id/Comedor-MenuTypes.json";
$defaultMenuTypes = [
["id" => "basal", "label" => "Menú basal", "color" => "#0d6efd"],
["id" => "vegetariano", "label" => "Menú vegetariano", "color" => "#198754"],
["id" => "alergias", "label" => "Menú alergias", "color" => "#dc3545"],
];
if (!file_exists($menuTypesPath)) {
if (!is_dir(dirname($menuTypesPath))) {
mkdir(dirname($menuTypesPath), 0777, true);
}
file_put_contents($menuTypesPath, json_encode($defaultMenuTypes, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
return $defaultMenuTypes;
}
$menuTypes = json_decode(@file_get_contents($menuTypesPath), true);
return (is_array($menuTypes) && count($menuTypes) > 0) ? $menuTypes : $defaultMenuTypes;
}
function blank_menu() {
return [
"plates" => [
"primero" => ["name" => "", "pictogram" => ""],
"segundo" => ["name" => "", "pictogram" => ""],
"postre" => ["name" => "", "pictogram" => ""],
]
];
}
function safe_filename($name) {
$name = basename($name);
return preg_replace("/[^a-zA-Z0-9._-]/", "_", $name);
}
// Routes
switch ($action) {
case "get_menu_types":
handle_get_menu_types();
break;
case "get_menu":
handle_get_menu();
break;
case "save_menu":
if (!$canEdit) {
http_response_code(403);
die(json_encode(["error" => "Insufficient permissions to edit", "code" => "FORBIDDEN"]));
}
handle_save_menu();
break;
case "add_menu_type":
if (!$canEdit) {
http_response_code(403);
die(json_encode(["error" => "Insufficient permissions to edit", "code" => "FORBIDDEN"]));
}
handle_add_menu_type();
break;
case "delete_menu_type":
if (!$canEdit) {
http_response_code(403);
die(json_encode(["error" => "Insufficient permissions to edit", "code" => "FORBIDDEN"]));
}
handle_delete_menu_type();
break;
case "rename_menu_type":
if (!$canEdit) {
http_response_code(403);
die(json_encode(["error" => "Insufficient permissions to edit", "code" => "FORBIDDEN"]));
}
handle_rename_menu_type();
break;
default:
http_response_code(400);
die(json_encode(["error" => "Invalid action", "code" => "INVALID_ACTION"]));
}
function handle_get_menu_types() {
global $centro_id, $source_aulario_id;
$menuTypes = get_menu_types($centro_id, $source_aulario_id);
echo json_encode([
"success" => true,
"menu_types" => $menuTypes
]);
}
function handle_get_menu() {
global $centro_id, $source_aulario_id;
$date = $_GET["date"] ?? date("Y-m-d");
$menuTypeId = $_GET["menu"] ?? "";
// Validate date
$dateObj = DateTime::createFromFormat("Y-m-d", $date);
if (!$dateObj) {
http_response_code(400);
die(json_encode(["error" => "Invalid date format", "code" => "INVALID_FORMAT"]));
}
$date = $dateObj->format("Y-m-d");
// Get menu types
$menuTypes = get_menu_types($centro_id, $source_aulario_id);
$menuTypeIds = [];
foreach ($menuTypes as $t) {
if (!empty($t["id"])) {
$menuTypeIds[] = $t["id"];
}
}
if ($menuTypeId === "" || !in_array($menuTypeId, $menuTypeIds)) {
$menuTypeId = $menuTypeIds[0] ?? "basal";
}
// Get menu data
$ym = $dateObj->format("Y-m");
$day = $dateObj->format("d");
$baseDir = "/DATA/entreaulas/Centros/$centro_id/Aularios/$source_aulario_id/Comedor/$ym/$day";
$dataPath = "$baseDir/_datos.json";
$menuData = [
"date" => $date,
"menus" => []
];
if (file_exists($dataPath)) {
$existing = json_decode(file_get_contents($dataPath), true);
if (is_array($existing)) {
$menuData = array_merge($menuData, $existing);
}
}
if (!isset($menuData["menus"][$menuTypeId])) {
$menuData["menus"][$menuTypeId] = blank_menu();
}
$menuForType = $menuData["menus"][$menuTypeId];
echo json_encode([
"success" => true,
"date" => $date,
"menu_type" => $menuTypeId,
"menu_types" => $menuTypes,
"menu" => $menuForType
]);
}
function handle_save_menu() {
global $centro_id, $source_aulario_id;
// Parse JSON body
$input = json_decode(file_get_contents("php://input"), true);
if (!$input) {
$input = $_POST;
}
$date = $input["date"] ?? date("Y-m-d");
$menuTypeId = $input["menu_type"] ?? "";
$plates = $input["plates"] ?? [];
// Validate date
$dateObj = DateTime::createFromFormat("Y-m-d", $date);
if (!$dateObj) {
http_response_code(400);
die(json_encode(["error" => "Invalid date format", "code" => "INVALID_FORMAT"]));
}
$date = $dateObj->format("Y-m-d");
// Validate menu type
$menuTypes = get_menu_types($centro_id, $source_aulario_id);
$validMenuTypeIds = [];
foreach ($menuTypes as $t) {
if (!empty($t["id"])) {
$validMenuTypeIds[] = $t["id"];
}
}
if (!in_array($menuTypeId, $validMenuTypeIds)) {
http_response_code(400);
die(json_encode(["error" => "Invalid menu type", "code" => "INVALID_MENU_TYPE"]));
}
// Get existing menu data
$ym = $dateObj->format("Y-m");
$day = $dateObj->format("d");
$baseDir = "/DATA/entreaulas/Centros/$centro_id/Aularios/$source_aulario_id/Comedor/$ym/$day";
$dataPath = "$baseDir/_datos.json";
$menuData = [
"date" => $date,
"menus" => []
];
if (file_exists($dataPath)) {
$existing = json_decode(file_get_contents($dataPath), true);
if (is_array($existing)) {
$menuData = array_merge($menuData, $existing);
}
}
if (!isset($menuData["menus"][$menuTypeId])) {
$menuData["menus"][$menuTypeId] = blank_menu();
}
// Update plates
$validPlates = ["primero", "segundo", "postre"];
foreach ($validPlates as $plateKey) {
if (isset($plates[$plateKey])) {
if (isset($plates[$plateKey]["name"])) {
$menuData["menus"][$menuTypeId]["plates"][$plateKey]["name"] = trim($plates[$plateKey]["name"]);
}
// Note: pictogram upload not supported via JSON API - use form-data instead
}
}
// Save menu
if (!is_dir($baseDir)) {
mkdir($baseDir, 0777, true);
}
file_put_contents($dataPath, json_encode($menuData, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
echo json_encode([
"success" => true,
"date" => $date,
"menu_type" => $menuTypeId,
"menu" => $menuData["menus"][$menuTypeId]
]);
}
function handle_add_menu_type() {
global $centro_id, $source_aulario_id;
$input = json_decode(file_get_contents("php://input"), true);
if (!$input) {
$input = $_POST;
}
$newId = strtolower(trim($input["id"] ?? ""));
$newLabel = trim($input["label"] ?? "");
$newColor = trim($input["color"] ?? "#0d6efd");
if ($newId === "" || $newLabel === "") {
http_response_code(400);
die(json_encode(["error" => "id and label are required", "code" => "MISSING_PARAM"]));
}
$menuTypesPath = "/DATA/entreaulas/Centros/$centro_id/Aularios/$source_aulario_id/Comedor-MenuTypes.json";
$menuTypes = get_menu_types($centro_id, $source_aulario_id);
// Check if already exists
foreach ($menuTypes as $t) {
if (($t["id"] ?? "") === $newId) {
http_response_code(400);
die(json_encode(["error" => "Menu type already exists", "code" => "DUPLICATE"]));
}
}
$menuTypes[] = ["id" => $newId, "label" => $newLabel, "color" => $newColor];
file_put_contents($menuTypesPath, json_encode($menuTypes, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
echo json_encode([
"success" => true,
"menu_type" => ["id" => $newId, "label" => $newLabel, "color" => $newColor],
"message" => "Menu type added successfully"
]);
}
function handle_delete_menu_type() {
global $centro_id, $source_aulario_id;
$input = json_decode(file_get_contents("php://input"), true);
if (!$input) {
$input = $_POST;
}
$deleteId = trim($input["id"] ?? "");
if ($deleteId === "") {
http_response_code(400);
die(json_encode(["error" => "id is required", "code" => "MISSING_PARAM"]));
}
$menuTypesPath = "/DATA/entreaulas/Centros/$centro_id/Aularios/$source_aulario_id/Comedor-MenuTypes.json";
$menuTypes = get_menu_types($centro_id, $source_aulario_id);
$deleted = false;
$newMenuTypes = [];
foreach ($menuTypes as $t) {
if (($t["id"] ?? "") === $deleteId) {
$deleted = true;
} else {
$newMenuTypes[] = $t;
}
}
if (!$deleted) {
http_response_code(404);
die(json_encode(["error" => "Menu type not found", "code" => "NOT_FOUND"]));
}
file_put_contents($menuTypesPath, json_encode($newMenuTypes, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
echo json_encode([
"success" => true,
"message" => "Menu type deleted successfully"
]);
}
function handle_rename_menu_type() {
global $centro_id, $source_aulario_id;
$input = json_decode(file_get_contents("php://input"), true);
if (!$input) {
$input = $_POST;
}
$renameId = trim($input["id"] ?? "");
$newLabel = trim($input["label"] ?? "");
$newColor = trim($input["color"] ?? "");
if ($renameId === "" || $newLabel === "") {
http_response_code(400);
die(json_encode(["error" => "id and label are required", "code" => "MISSING_PARAM"]));
}
$menuTypesPath = "/DATA/entreaulas/Centros/$centro_id/Aularios/$source_aulario_id/Comedor-MenuTypes.json";
$menuTypes = get_menu_types($centro_id, $source_aulario_id);
$found = false;
foreach ($menuTypes as &$t) {
if (($t["id"] ?? "") === $renameId) {
$t["label"] = $newLabel;
if ($newColor !== "") {
$t["color"] = $newColor;
}
$found = true;
break;
}
}
unset($t);
if (!$found) {
http_response_code(404);
die(json_encode(["error" => "Menu type not found", "code" => "NOT_FOUND"]));
}
file_put_contents($menuTypesPath, json_encode($menuTypes, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
echo json_encode([
"success" => true,
"menu_type" => ["id" => $renameId, "label" => $newLabel, "color" => $newColor],
"message" => "Menu type renamed successfully"
]);
}