<?php

/**
 * Descripción del Modelo de Datos Usuarios
 *
 * %%DESC_MODELO%%
 *
 * Licenciado bajo la Licencia Apache, Versión 2.0;
 * Usted no puede usar este archivo excepto en conformidad con la Licencia.
 * Usted puede obtener una copia de la Licencia en:
 *      http://www.php.net/license/3_01.txt. 
 * A menos que sea requerido por la ley aplicable o acordado por escrito, el software
 * Distribuido bajo la licencia se distribuye en una "AS IS" o  "COMO ESTA" BASE,
 * SIN GARANTÍAS NI CONDICIONES DE NINGÚN TIPO, expresas o implícitas.
 * Consulte la Licencia para los permisos y Limitaciones bajo la Licencia.
 *
 * @package    Modelos\Datos\Usuarios
 * @author     LUIS ANTONIO MONTOYA CONTRERAS <lmontoya@ccsm.org.co>
 * @author     SICAM 20171025 <sicam32@ccsm.org.co>
 * @copyright  2017 Cámara de Comercio de Santa Marta para el Magdalena
 * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
 * @version    201712181018
 * @link       http://sicam.ccsm.org.co/docs/modelos/datos/Usuarios
 */
 
class UsuariosApi extends ModeloDatos {

    const ACTIVO     = 'ACTIVO';
    const DESACTIVO  = 'DESACTIVO';
    const SUSPENDIDO = 'SUSPENDIDO';
    /**
     * Recibe el Identificador del registro de usuario y 
     * devuelve un objeto con sus datos.
     * @param int $usuarioID
     * @return Objeto usuario
     */
    public static function datos($usuarioID) {
        $sqlQuery = UsuariosApiSQL::DATOS_BASICOS . " WHERE Usuarios.usuarioID =  ? ; ";
        return SicamDB::selectUnaFila($sqlQuery, array($usuarioID));
    }
    /**
     * Recibe el Identificador del registro de usuario y 
     * devuelve un objeto con sus datos completos con todas sus relacion.
     * @param int $usuarioID
     * @return Objeto usuario
     */
    public static function datosCompletos($usuarioID) {
        $sqlQuery = UsuariosApiSQL::DATOS_COMPLETOS . " WHERE Usuarios.usuarioID =  ? ; ";
        $usuario = SicamDB::selectUnaFila($sqlQuery, array($usuarioID));
        $usuario->roles = Usuarios::roles($usuarioID);
        $usuario->permisos = Usuarios::permisos($usuarioID);
        return $usuario;
    }
    /**
     * Devuelve todos los registros de usuarios, según el estado.
     * Si no se envia el estado devuelve todos los registros 
     * sin importar su estado.
     * @param String $usuarioESTADO
     * @return Array de Objetos usuarios
     */
    public static function todos($usuarioESTADO = null) {
        $datos    = array();
        $sqlQuery = UsuariosApiSQL::DATOS_BASICOS;
        if (!is_null($usuarioESTADO)) {
            $sqlQuery .= " WHERE usuarioESTADO = ? ";
            array_push($datos, $usuarioESTADO);
        }
        return SicamDB::selectVariasFilas($sqlQuery, $datos);
    }
    /**
     * Devuelve los registros de usuarios en estado ACTIVO.
     * @return Array de Objetos usuarios
     */
    public static function activos() {
        return self::todos(self::ACTIVO);
    }  
    /**
     * Recibe Todos los datos de necesarios para la creación de un nuevo 
     * registro de usuarios.
     * @param int $categoriaID Identificador de la Categoria
     * @param String $usuarioCODIGO Código de usuarios 
     * @param String $usuarioTITULO Titulo de usuarios 
     * @param Texto $usuarioDESCRIPCION Descripción de usuarios
     * @param Url $usuarioURL Url del archivo asociado al usuarios
     * @param String $usuarioESTADO Estado del registro de usuarios
     * @return int con el Identificador del Registro usuarios 
     */
    public static function guardar($aplicacionID, $usuarioNOMBRE, $usuarioCLAVE, $usuarioESTADO, $usuarioADMINISTRADOR) {
        $sqlQuery = UsuariosApiSQL::CREAR_REGISTRO;
        return SicamDB::insertFila($sqlQuery, array(
              $aplicacionID, $usuarioNOMBRE, $usuarioCLAVE,
              $usuarioESTADO, Cliente::usuarioID(), $usuarioADMINISTRADOR
            )
        );
    }
    /**
     * Recibe Todos los datos de necesarios para la creación de un nuevo 
     * registro de usuarios.
     * @param int $categoriaID Identificador de la Categoria
     * @param String $usuarioCODIGO Código de usuarios 
     * @param String $usuarioTITULO Titulo de usuarios 
     * @param Texto $usuarioDESCRIPCION Descripción de usuarios
     * @param Url $usuarioURL Url del archivo asociado al usuarios
     * @param String $usuarioESTADO Estado del registro de usuarios
     * @return int con el Identificador del Registro usuarios 
     */
    public static function guardarApi($usuarioID, $apiCLAVESECRETA, $apiIP) {
        $sqlQuery = UsuariosApiSQL::CREAR_REGISTRO_API;
        return SicamDB::insertFila($sqlQuery, array(
              $usuarioID, $apiCLAVESECRETA, $apiIP
            )
        );
    }
    
    /**
     * Recibe los todos los datos del registro para ser actualizados, junto con
     * el identificador del registro que se va ha actualizar.
     * @param int $usuarioID Identificador del Registro de usuarios
     * @param int $categoriaID Identificador de la Categoria
     * @param String $usuarioCODIGO Código de usuarios 
     * @param String $usuarioTITULO Titulo de usuarios 
     * @param Texto $usuarioDESCRIPCION Descripción de usuarios
     * @param Url $usuarioURL Url del archivo asociado al usuarios
     * @param String $usuarioESTADO Estado del registro de usuarios
     * @return int cantidad de registros actualziados en la operacion
     */
    public static function actualizar($usuarioID, $aplicacionID, $usuarioNOMBRE, $usuarioADMINISTRADOR) {
        $sqlQuery = UsuariosApiSQL::ACTUALIZAR_REGISTRO;
        return SicamDB::actualizarFila($sqlQuery, array(
             $aplicacionID, $usuarioNOMBRE,  
             $usuarioADMINISTRADOR, $usuarioID
            )
        );
    }
        /**
     * Recibe un identificador de usuarios y elimina el registro.
     * @param int $usuarioID Identificador del registro
     * ha eliminar.
     * @return int Cantidad de registros eliminados
     */
    public static function eliminar($usuarioID) {
        $sqlQuery = UsuariosApiSQL::ELIMINAR_REGISTRO;
        return SicamDB::actualizarFila($sqlQuery, array($usuarioID));
    }
    /**
     * Recibe un identificador de usuarios y reactiva el registro.
     * @param int $usuarioID Identificador del registro
     * @return int Cantidad de registros reactivados
     */
    public static function reactivar($usuarioID) {
        return self::cambiarEstado(self::ACTIVO, $usuarioID);
    }
    /**
     * Recibe un identificador y el Estado y actualiza el estado del registro
     * @param String $usuarioESTADO Nuevo estado del registro.
     * @param int $usuarioID Identificador del registro
     * @return int Cantidad de registros desactivados
     */
    public static function cambiarEstado($usuarioESTADO, $usuarioID) {
        $sqlQuery = UsuariosApiSQL::ACUALIZAR_ESTADO;
        return SicamDB::actualizarFila($sqlQuery, array($usuarioESTADO, $usuarioID));
    }
    /**
     * Recibe un identificador de usuarios y desactiva el registro.
     * @param int $usuarioID Identificador del registro
     * @return int Cantidad de registros desactivados
     */
    public static function desactivar($usuarioID) {
        return self::cambiarEstado(self::DESACTIVO, $usuarioID);
    }
    
}
// Generado el 2017-12-18 10:18:50:000000