<?php

/**
 * Descripción del Controlador Plan de Ingresos
 * 
 * Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec odio. 
 * Quisque volutpat mattis eros. Nullam malesuada erat ut turpis. 
 * 
 * @package Constructor\Controlador
 * @license GPL
 * @author Generado por SICAM
 */
class PlanIngresosControlador extends Controladores {

    /**
     * Función para ser consumida desde la API
     * @api
     * @return JSON Datos de todos los PlanIngresos
     */
    function todos($request, $response, $args = array()) {
        Api::ejecutarGet($request, PlanIngresos::todos());
    }

    /**
     * Vista que se encarga de organizar la forma de presentar 
     * los registros de PlanIngresos al usuario.
     * @return HTML Listado de PlanIngresos.
     */
    function mostrarTodos() {
        Vistas::mostrar('planeador', 'planingresos/listado');
    }

    /**
     * Permite mostrar en forma de tabla los registros de PlanIngresos.  
     * @return HTML Formulario solo con datos inciales o necesarios.
     */
    function tablaListado() {
        $PlanIngresos = PlanIngresos::todos();
        Vistas::mostrar('plnaeador', 'planingresos/tbl-PlanIngresos', array(
          'PlanIngresos' => $PlanIngresos));
    }

    /**
     * Responde con el formulario de PlanIngresos vacio, solo datos necesarios.
     * LLama a la función que devuleve el formulario pero 
     * sin enviarle los datos de PlanIngresos.  
     * Esta función se crea para poder gestionar el permiso de NUEVO PlanIngresos
     * @return HTML Formulario solo con datos inciales o necesarios.
     */
    function mostrarFormularioNuevo() {
        $this->mostrarFormulario();
    }

    /**
     * Recibe el ID del PlanIngresos y obtiene sus datos para ser enviados 
     * al formulario, y asi cargar los datos en los inputs.
     * Esta función se crea para poder gestionar el permiso de EDITAR PlanIngresos
     * @return HTML Formulario con los datos del PlanIngresos a editar.
     */
    function mostrarFormularioEditar() {
        $PlanIngresos = PlanIngresos::datos($this->PlanIngresosID);
        $this->mostrarFormulario($PlanIngresos);
    }

    /**
     * Muestra el Formulario procesado para ser mostrado al usuario.
     * Se le envian unos datos inciales para la carga de la vista, y
     * se envia los datos del PlanIngresos cuando se esta editando.
     * @return HTML Vista del Formulario de PlanIngresos
     */
    private function mostrarFormulario($PlanIngresos = null) {
        Vistas::mostrar('plnaeador', 'planingresos/form-PlanIngresos', array(
          'PlanIngresos' => $PlanIngresos
        ));
    }

    /**
     * Guardar Datos Recibidos, bien sea como un registro nuevo, o como una actualización.
     * Despues imprime las Respuesta del Sistema a la ejecución de la operacion
     */
    function guardarDatos() {
        $carpetaPlanIngresos = 'planeador/PlanIngresos/';
        $this->urlARCHIVO    = $this->recibirArchivos(
            $this->archivoENVIADO, DIR_ARCHIVOS . $carpetaPlanIngresos, uniqid('PlanIngresos-') . "." . Archivos::extension($this->archivoENVIADO)
        );
        if (empty($this->PlanIngresosID)) {
            echo $this->guardarNuevo();
        } else {
            echo $this->guardarCambios();
        }
    }

    /**
     * Función que toma los datos enviados y crea un nuevo registro
     * @return RespuestasSistema 
     */
    private function guardarNuevo() {
        $creadoID = PlanIngresos::guardar(
                $this->PlanIngresosCATEGORIA, $this->PlanIngresosCODIGO, $this->PlanIngresosTITULO, $urlARCHIVO, $this->PlanIngresosESTADO
        );
        if ($creadoID) {
            return Respuestassistema::exito("Nuevo Registro CREADO con EXITO");
        } else {
            return Respuestassistema::fallo("No se pudo CREAR el nuevo Plan de Ingresos. Si vuelve a suceder, contacte con el Centro TICS.");
        }
    }

    /**
     * Función que toma los datos enviados y actualiza el registro
     * @return RespuestasSistema 
     */
    private function guardarCambios() {
        $PlanIngresos = PlanIngresos::datos($this->PlanIngresosID);
        if (is_null($this->urlARCHIVO)) {
            $this->urlARCHIVO = $PlanIngresos->PlanIngresosURLARCHIVO;
        }
        $actualizado = PlanIngresos::actualizar(
                $this->PlanIngresosID, $this->PlanIngresosCATEGORIA, $this->PlanIngresosCODIGO, $this->PlanIngresosTITULO, $this->PlanIngresosDESCRIPCION, $urlARCHIVO, $this->PlanIngresosESTADO
        );
        if ($actualizado) {
            return RespuestasSistema::exito("Registro ACTUALIZADO con EXITO.");
        } else {
            return RespuestasSistema::fallo("No se actualizó el PlanIngresos. Verifique los datos, o contacte al Centro TICS.");
        }
    }

    /**
     * Toma el archivo enviado y lo mueve a la ubicacion y con el nombre enviado.
     * @param String $archivoRECIBIDO archivo enviado por POST
     * @param String $carpetaMOVIDO Carpeta donde se debe guardar el archivo
     * @param String $nuevoNOMBRE   Nombre con el que se va ha lamacenar el archivo
     * @return String Ruta WEB o URL de donde fue guardado el archivo recibido.
     * 
     * @author [Juan Pablo Llinás Ramírez] [jpllinas@ccsm.org.co]
     */
    private function recibirArchivos($archivoRECIBIDO, $carpetaMOVIDO, $nuevoNOMBRE) {
        if (!empty($archivoRECIBIDO)) {
            $archivoMovido = Archivos::moverArchivoRecibido($archivoRECIBIDO, $carpetaMOVIDO, $nuevoNOMBRE);
            if ($archivoMovido) {
                return URL_ARCHIVOS . $carpetaMOVIDO . $nuevoNOMBRE;
            }
        }
        return null;
    }

    /**
     * Eliminar un registro de la base de datos.
     * Esta operación es irreversible.
     * Si se tiene la referencia integral activada, la base de datos no va 
     * dejar eliminar si tiene otros registros asociados.
     * @return RespuestasSistema Resultado de la Operacion que se envia al cliente
     */
    function eliminar() {
        $this->operacionConSoloID('eliminar');
    }

    /**
     * Cambiar el estado de un registro de la base de datos.
     * Esta operacion cambia a estado ACTIVO el registro.     
     * @return RespuestasSistema Resultado de la Operacion
     */
    function reactivar() {
        $this->operacionConSoloID('reactivar');
    }

    /**
     * Cambiar el estado de un registro de la base de datos.
     * Esta operacion cambia a estado DESACTIVO / SUSPENDIDO / CANCELADO el registro.     
     * @return RespuestasSistema Resultado de la Operacion
     */
    function desactivar() {
        $this->operacionConSoloID('desactivar');
    }

    /**
     * Se identificó que la forma de tratar las operaciones que solo necesitan 
     * un id para ejecutar se pueden todas tratar como en esta funcion
     * @return RespuestasSistema Resultado de la Operacion que se envia al cliente
     */
    private function operacionConSoloID($operacionMODELO) {
        $PlanIngresosParaEliminar = $this->checks_PlanIngresos;
        if (count($PlanIngresosParaEliminar)) {
            $n = 0;
            foreach ($PlanIngresosParaEliminar as $PlanIngresosELIMINAR):
                if (PlanIngresos::$operacionMODELO($PlanIngresosELIMINAR)) {
                    $n++;
                }
            endforeach;
            if ($n == 0) {
                echo RespuestasSistema::error('No fue posible realizar la OPERACION [' . strtoupper($operacionMODELO) . ']. Contacte al centro TICS.');
            } else if ($n == count($PlanIngresosParaEliminar)) {
                echo RespuestasSistema::exito('Se realizó la OPERACION [' . strtoupper($operacionMODELO) . '] exitosamente!');
            } else {
                echo RespuestasSistema::error('Hubo un error al  [' . strtoupper($operacionMODELO) . '] alguno de los registros. Verifica los datos, o contacta al centro TICS.');
            }
        } else {
            echo RespuestasSistema::error('No llegarón los datos para  [' . strtoupper($operacionMODELO) . ']. Contacta al centro TICS');
        }
    }

    /**
     * Vista que se encarga de mostrar todos los detalles/datos asociados a 
     * los registros de PlanIngresos.
     * @return HTML Datos e información de PlanIngresos.
     */
    function verDetalles() {
        $PlanIngresos = PlanIngresos::datos($this->PlanIngresosID);
        Vistas::mostrar('planeador', 'PlanIngresoss/ver-PlanIngresos', array(
          'PlanIngresos' => $PlanIngresos));
    }

}