Browse Source

Arreglo docstring y santaxis de funcion para obtener datos basicos.

Modifo la funcion extraerDatos para que tenga mejor nombre y mejor docstring, actualizo sus invocaciones.
Arreglo docstring de funcion para obtener direcciones
main
jirho 1 year ago
parent
commit
6d6c3e0270
  1. 53
      app/Http/Controllers/ApiPersonaController.php

53
app/Http/Controllers/ApiPersonaController.php

@ -3,7 +3,6 @@
namespace App\Http\Controllers; namespace App\Http\Controllers;
use App\Models\UaderMapuchePersona; use App\Models\UaderMapuchePersona;
use App\Models\UaderDjPersona;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use App\Constants\HttpStatus; use App\Constants\HttpStatus;
use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Log;
@ -11,18 +10,20 @@ use Illuminate\Support\Facades\Log;
class ApiPersonaController extends Controller class ApiPersonaController extends Controller
{ {
/**
* Funcion de la ruta getDatos.
* Devuelve los datos básicos de una persona en formato JSON.
*
* @param \Illuminate\Http\Request $request La solicitud HTTP que contiene los parámetros de búsqueda.
* @return \Illuminate\Http\JsonResponse La respuesta JSON con los datos de la persona encontrada, o un mensaje de error si no se encuentra.
*/
public function getDatos(Request $request){ public function getDatos(Request $request){
/**
* Obtiene datos de una persona según el DNI o el número de teléfono.
*
* @param \Illuminate\Http\Request $request La solicitud HTTP que contiene los parámetros de búsqueda.
* @return \Illuminate\Http\JsonResponse La respuesta JSON con los datos de la persona encontrada, o un mensaje de error si no se encuentra.
*/
if(!$request->has('dni') && !$request->has('telefono')){ if(!$request->has('dni') && !$request->has('telefono')){
return response()->json(
return response()->json(['error' => trans('persona.DEBE_INGRESAR_DNI_O_TELEFONO')], HttpStatus::BAD_REQUEST); ['error' => trans('persona.DEBE_INGRESAR_DNI_O_TELEFONO')],
HttpStatus::BAD_REQUEST
);
} }
try{ try{
@ -30,9 +31,8 @@ class ApiPersonaController extends Controller
if ($request->has('dni')) { if ($request->has('dni')) {
$persona = UaderMapuchePersona::buscarPersonaPorDni($request->get('dni')); $persona = UaderMapuchePersona::buscarPersonaPorDni($request->get('dni'));
if ($persona) { if ($persona) {
return ApiPersonaController::extraerDatos($persona); return ApiPersonaController::extraerDatosJson($persona);
} }
} }
@ -41,7 +41,7 @@ class ApiPersonaController extends Controller
$persona = UaderMapuchePersona::BuscarPersonaPorTelefono($request->get('telefono')); $persona = UaderMapuchePersona::BuscarPersonaPorTelefono($request->get('telefono'));
if ($persona) { if ($persona) {
return ApiPersonaController::extraerDatos($persona); return ApiPersonaController::extraerDatosJson($persona);
} }
} }
@ -276,16 +276,15 @@ class ApiPersonaController extends Controller
return response()->json($datos, HttpStatus::OK); return response()->json($datos, HttpStatus::OK);
} }
public static function extraerDatos($persona){ /**
/** * Extrae los datos de la declaracion jurada de una persona y los retorna como JSON.
* Extrae los datos necesarios de una persona para ser devueltos como respuesta JSON. *
* * @param mixed $persona La instancia de la persona de la cual se extraerán los datos.
* @param mixed $persona La instancia de la persona de la cual se extraerán los datos. * @return \Illuminate\Http\JsonResponse La respuesta JSON con los datos extraídos de la persona.
* @return \Illuminate\Http\JsonResponse La respuesta JSON con los datos extraídos de la persona. */
*/ public static function extraerDatosJson($persona){
$declaracion_jurada = $persona->declaracion_jurada; $declaracion_jurada = $persona->declaracion_jurada;
if(!$declaracion_jurada){ if(!$declaracion_jurada){
return response()->json(['error' => trans('persona.DECLARACION_JURADA_NO_ENCONTRADA')], HttpStatus::NOT_FOUND); return response()->json(['error' => trans('persona.DECLARACION_JURADA_NO_ENCONTRADA')], HttpStatus::NOT_FOUND);
@ -303,13 +302,13 @@ class ApiPersonaController extends Controller
return response()->json($datos, HttpStatus::OK); return response()->json($datos, HttpStatus::OK);
} }
/**
* Extrae los datos de la direccion de una persona para ser devueltos como respuesta JSON.
*
* @param App\Models\UaderMapuchePersona $persona La instancia de la persona de la cual se extraerán los datos.
* @return \Illuminate\Http\JsonResponse La respuesta JSON con los datos extraídos de la persona.
**/
public static function extraerDireccion($persona){ public static function extraerDireccion($persona){
/**
* Extrae los datos de la direccion de una persona para ser devueltos como respuesta JSON.
*
* @param App\Models\UaderMapuchePersona $persona La instancia de la persona de la cual se extraerán los datos.
* @return \Illuminate\Http\JsonResponse La respuesta JSON con los datos extraídos de la persona.
**/
$declaracion_jurada = $persona->declaracion_jurada; $declaracion_jurada = $persona->declaracion_jurada;

Loading…
Cancel
Save