I want to do an API or contract in laravel focus when one person wanna contract or credit, but honestly it's for a schoolarship but the process it's similar when i got a credit from a bank. Honestly i wrote this code and work pretty nice, but i would like to improve my code, because i want to become a professional. In my Class ConsultaSivi.php there are differente methods there are setters and getters, validation and it's pass everything that can become a contract or credit. I want to mention there are two data source one it's a database and second it's a API. ConsultaSivi get information from another api and ConsultaCreded get information from database.
My question is how can i improve my class ConsultaSivi and ConsultaCreded ? in some part of the code.
Class Codeudor and Deudor extends from Class Persona
here's my class persona <?php
namespace App\Libs\Domain;
/**
* clase que contiene los datos de una persona dentro de un credito
*/
class Persona
{
/**
* contiene el numero de cedula de la persona
* @var [string]
*/
public $cedula;
/**
* contine el nombre de la persona
* @var [string]
*/
public $nombreCompleto;
}
my class credito or credit <?php
namespace App\Libs\Domain;
/**
* clase que alamacenara los daos de un prestamo/credito perteneciente a un prestatario
*/
class Credito
{
/**
* variable destinada a contener el obj de la clase deudor
* @var [obj]
*/
public $deudor;
/**
* variable destinada a contener el obj de la clase codeudores
* @var [obj]
*/
public $codeudores;
/**
* contiene el numero de un contrato o credito
* @var [string]
*/
public $numeroContrato;
/**
* contiene el monto total del prestamo
* @var [float]
*/
public $montoCredito;
/**
* contiene el monto de los pagos trimestrales
* @var [float]
*/
public $pagoTrimestral;
/**
* contiene la relacion de pago para el cobro del cheque
* @var [string]
*/
public $relacionPago;
/**
* almacena el numero del memo-resolucion del contrato
* @var [string]
*/
public $memo;
/**
* almacena el año inicial cuando empezo el contrato
* @var [string]
*/
public $anioInicial;
/**
* almacena el año final cuando finaliza el contrato
* @var [string]
*/
public $anioFinal;
}
this is my class ConsultaSivi <?php
namespace App\Libs;
use App\Libs\Domain\Codeudor;
use App\Libs\Domain\Credito;
use App\Libs\Domain\Deudor;
use App\Libs\Domain\Persona;
use App\Libs\Exceptions\SystemExceptions;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use Validator;
class ConsultaSivi implements ConsultaInterface
{
/**
* Número de cédula del deudor del principal
* @var [string]
*/
public $cedulaDeudor;
/**
* Números de cédulas de los codeudores del credito
* @var [string]
*/
public $cedulasCodeudores;
/**
* Credito que esta siendo construido
* @var [obj]
*/
public $credito;
/**
* Usuario que inicio sesion
*/
public $user;
/**
* Ip de máquina para hacer la consulta al servicio
*/
public $ip;
/**
* método que asigna la cédula del deudor recibida por parametro
* @param [string] $cedulaDeudor [recibe la cédula por entrada en teclado]
*/
public function setCedulaDeudor($cedulaDeudor)
{
$isValid = $this->validarCedula($cedulaDeudor);
if ($isValid) {
$this->cedulaDeudor = $cedulaDeudor;
}
}
/**
* método que asigna la/s cédula/s del /los deudor/res recibida por parametro
* @param [string] $cedulasCodeudores [recibe cédulas por entrada en teclado]
*/
public function setCedulasCodeudores($cedulasCodeudores)
{
$cedulas = [];
if (is_array($cedulasCodeudores)) {
$isValid = $this->validarCedula($cedulasCodeudores);
if ($isValid) {
$this->cedulasCodeudores = $cedulasCodeudores;
}
} else {
new SystemExceptions(401);
}
}
/**
* método que realiza la consulta al api de sivi-linux y lo retorna a la ruta
* @return [type] [description]
*/
public function consultar()
{
$this->credito = new Credito();
$this->consultarDeudor();
$this->consultarCodeudores();
}
/**
* método que crea Deudor
* @return [type] [obj]
*/
public function consultarDeudor()
{
$deudor = new Deudor();
$deudor = $this->api($this->cedulaDeudor);
$deudor = $this->concatenarNombreCompleto($deudor);
return $this->credito->deudor = $deudor;
}
/**
* método que crea codeudor
* @return [type] [obj]
*/
public function consultarCodeudores()
{
$codeudor = [];
$codeudores = new Codeudor();
foreach ($this->cedulasCodeudores as $cedulas) {
$codeudores = $this->api($cedulas);
$codeudores = $this->concatenarNombreCompleto($codeudores);
array_push($codeudor, $codeudores);
}
return $this->credito->codeudores = $codeudor;
}
public function validarCedula($cedula)
{
$cedula = (array) $cedula;
$rules = ['cedula' => 'required|required'];
$i = 0;
$isValidCedula = true;
$cedulaCounter = count($cedula);
while ($i < $cedulaCounter && $isValidCedula) {
$input = ['cedula' => $cedula[$i]];
$validator = Validator::make($input, $rules);
if ($validator->fails()) {
$isValidCedula = false;
}
$i++;
}
return $isValidCedula;
}
public function requestApi($method, $cedula, $user, $ip)
{
return new Request(
'GET',
$method,
[
'query' => [
'cedula' => $cedula,
'usuario' => $user,
'ip' => $ip,
],
]
);
}
/**
* Método que realiza la consulta a Sivi
* @return [type] [obj]
*/
public function api($cedula)
{
$url = \Config::get('app.sivi_api');
$metodo = \Config::get('app.sivi_api_method');
try {
$client = new Client([
'base_uri' => $url,
'timeout' => 3.14,
]);
$request = $this->requestApi($metodo, $cedula, $this->user, $this->ip);
$response = $client->send($request);
return $this->parseJson($response->getBody());
} catch (\Exception $e) {
new SystemExceptions($e);
}
}
/**
* método que realiza la conversion de json a una array de php
* @return [type] [obj]
*/
public function parseJson($response)
{
return json_decode($response, true);
}
/**
* método que concatena nombre completo
* @return [type] [obj]
*/
public function concatenarNombreCompleto($data)
{
$persona = new Persona();
$persona->cedula = $data['cedula'];
$apellido = $this->obtenerApellidoMaternoPaterno($data);
$persona->nombreCompleto = $data['primer_nombre'] . ' ' . $apellido;
$persona->nombreCompleto = $this->limpiarNombreCompleto($persona->nombreCompleto);
return $persona;
}
public function obtenerApellidoMaternoPaterno($apellidos)
{
$paterno = $apellidos['apellido_paterno'];
$materno = $apellidos['apellido_materno'];
return (!isset($paterno) || trim($paterno === '') && !isset($materno)) ? $materno : $paterno;
}
/**
* método que limpia nombre completo del deudor o codeudor de caracteres especiales y espacios
* @return [type] [obj]
*/
public function limpiarNombreCompleto($input)
{
return preg_replace("/[\d,\W,\s]+/", " ", $input);
}
/**
* método que retorna el obj de credito
* @return [obj] [credito]
*/
public function getCredito()
{
$consultaSivi = new ConsultaSivi();
if ($this->credito) {
dd($this->credito);
return $this->credito;
}
}
}
i am sending from my route
<?php
use App\Libs\ConsultaCreded;
use App\Libs\ConsultaSivi;
/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/
Auth::routes();
// Planilla
Route::resource('planilla', 'PlanillaController');
// Home
Route::get('/', 'HomeController@index')->name('home');
// Tests
Route::get('/creded', function () {
$consultaCreded = new ConsultaCreded();
$consultaCreded->setCedulaDeudor('5-78-68');
$consultaCreded->consultar();
$credito = $consultaCreded->getCredito();
dd($credito);
});
Route::get('/sivi', function () {
$consultaSivi = new ConsultaSivi();
$consultaSivi->user = \Auth::user()->username;
$consultaSivi->ip = \Request::ip();
$consultaSivi->setCedulaDeudor('1-728-2208');
$consultaSivi->setCedulasCodeudores(['3-728-2208','1-728-2208']);
$consultaSivi->consultar();
$credito = $consultaSivi->getCredito();
});
my interface here
<?php
namespace App\Libs;
/**
* [Interfaz que desarrolla un punto en comun para la comunicacion con las diferentes fuentes de informacion del sistema]
*/
interface ConsultaInterface
{
/**
* [consultar Metodo que hace la consulta a la fuente de informacion]
*/
public function consultar();
/**
* [setCedulaDeudor description]
* @param [type] $cedula [description]
*/
public function setCedulaDeudor($cedula);
/**
* [setCedulasCodeudores description]
* @param [type] $cedulas [description]
*/
public function setCedulasCodeudores($cedulas);
/**
* [getCredito description]
* @return [type] [description]
*/
public function getCredito();
}
class consulta creded this is from my other parnert <?php
namespace App\Libs;
use Illuminate\Support\Facades\DB;
use App\Libs\Domain\Credito;
use App\Libs\Domain\Deudor;
use App\Libs\Domain\Codeudor;
use App\Libs\Exceptions\SystemExceptions;
/**
* Clase para consultar a la DB CREDED que implementa la interface consulta
*/
class ConsultaCreded implements ConsultaInterface
{
/**
* Numero de cedula del deudor principal del credito
* @var [string]
*/
public $cedulaDeudor;
/**
* almacena datos de la consulta a la base de datos
* @var [obj]
*/
public $consulta;
/**
* Credito que esta siendo construido
* @var [obj]
*/
public $credito;
/**
* Numeros de cedulas de los codeudores del credito
* @var [string]
*/
public $cedulasCodeudores;
/**
* metodo que asigna la cedula del deudor recibida por parametro
* @param [string] $cedulaDeudor [recibe la cedula por entrada en teclado]
*/
public function setCedulaDeudor($cedulaDeudor)
{
if (!$cedulaDeudor) {
new SystemExceptions(101);
}
$this->cedulaDeudor = $cedulaDeudor;
}
/**
* Metodo que realiza la consulta a la Fuente de Dato de CREDED
*/
public function consultar()
{
try {
$this->consulta = DB::connection('creded')
->table(env('CREDED_DB_TABLE'))
->where('cedula', '=', $this->cedulaDeudor)
->first();
} catch (\Exception $e) {
new SystemExceptions(103);
}
return $this->consulta;
}
/**
* metodo que retorna el obj de credito
* @return [obj] [credito]
*/
public function getCredito()
{
if (!$this->configurarCredito()) {
new SystemExceptions(104);
}
return $this->credito;
}
/**
* asigna los valores de la consulta en sus respectivas variables dentro de sus clases
* @return [type] [description]
*/
public function configurarCredito()
{
if ($this->consulta) {
$credito = $this->generarCredito($this->consulta);
$credito->deudor = $this->generarDeudor($this->consulta);
$credito->codeudores = $this->generarCodeudor($this->consulta);
return $this->credito = $credito;
}
}
public function generarCredito($consulta)
{
$credito = new Credito();
$credito->numeroContrato = $consulta->sol_contracnum;
$credito->montoCredito = $consulta->cal_montot;
$credito->pagoTrimestral = $this->calcularPagoTrimestral($consulta->cal_totmes);
$credito->anioInicial = $consulta->cal_fecini;
$credito->anioFinal = $consulta->cal_fecfin;
return $credito;
}
public function calcularPagoTrimestral($pagoMensual)
{
return $pagoMensual * 3;
}
/**
* metodo que retorna el obj del Deudor
* @return [obj] [deudor]
*/
public function generarDeudor($consulta)
{
$deudor = new Deudor();
$deudor->cedula = $consulta->cedula;
$deudor->nombreCompleto = $this->limpiarNombre($this->consulta->nombre);
return $deudor;
}
/**
* metodo que retorna el obj del Codeudor
* @return [obj] [deudor]
*/
public function generarCodeudor($consulta)
{
$codeudor = new Codeudor();
$codeudor->cedula = $this->consulta->sol_cedu_repre;
$codeudor->nombreCompleto = $this->limpiarNombre($this->consulta->nomrepre);
return $codeudor;
}
/**
* reemplaza los espacios en blanco dobles del nombre por uno solo espacio y luego la funcion Trim() los elimina
* @param [string] $nombre [recibe el nombre de la persona]
* @return [string] [retorna el nombre sin espacios dobles]
*/
public function limpiarNombre($nombreCompleto)
{
return preg_replace('/[\d,\W,\s]+/', ' ', trim($nombreCompleto));
}
/**
* asigna la/s cedula/s del /los deudor/res recibida por parametro
* @param [string] $cedulasCodeudores [recibe cedulas por entrada en teclado]
*/
public function setCedulasCodeudores($cedulasCodeudores)
{
}
}