API Documentation
Back to top  

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
author SICAM 20171025
copyright 2017 Cámara de Comercio de Santa Marta para el Magdalena
license PHP License 3.01
version 201712181018
link http://sicam.ccsm.org.co/docs/modelos/datos/Usuarios
inherited_from \ModeloDatos

 Methods

Devuelve los registros de usuarios en estado ACTIVO.

activos() : Array
Static

Returns

Arrayde Objetos usuarios

Recibe los todos los datos del registro para ser actualizados, junto con el identificador del registro que se va ha actualizar.

actualizar(integer $usuarioID, $aplicacionID, $usuarioNOMBRE, $usuarioADMINISTRADOR) : integer
Static

Parameters

$usuarioID

integer

Identificador del Registro de usuarios

$aplicacionID

$usuarioNOMBRE

$usuarioADMINISTRADOR

Returns

integercantidad de registros actualziados en la operacion

Recibe un identificador y el Estado y actualiza el estado del registro

cambiarEstado(String $usuarioESTADO, integer $usuarioID) : integer
Static

Parameters

$usuarioESTADO

String

Nuevo estado del registro.

$usuarioID

integer

Identificador del registro

Returns

integerCantidad de registros desactivados

Recibe el Identificador del registro de usuario y devuelve un objeto con sus datos.

datos(integer $usuarioID) : \Objeto
Static

Parameters

$usuarioID

integer

Returns

\Objetousuario

Recibe el Identificador del registro de usuario y devuelve un objeto con sus datos completos con todas sus relacion.

datosCompletos(integer $usuarioID) : \Objeto
Static

Parameters

$usuarioID

integer

Returns

\Objetousuario

Recibe un identificador de usuarios y desactiva el registro.

desactivar(integer $usuarioID) : integer
Static

Parameters

$usuarioID

integer

Identificador del registro

Returns

integerCantidad de registros desactivados

Recibe un identificador de usuarios y elimina el registro.

eliminar(integer $usuarioID) : integer
Static

Parameters

$usuarioID

integer

Identificador del registro ha eliminar.

Returns

integerCantidad de registros eliminados

Recibe Todos los datos de necesarios para la creación de un nuevo registro de usuarios.

guardar($aplicacionID, $usuarioNOMBRE, $usuarioCLAVE, String $usuarioESTADO, $usuarioADMINISTRADOR) : integer
Static

Parameters

$aplicacionID

$usuarioNOMBRE

$usuarioCLAVE

$usuarioESTADO

String

Estado del registro de usuarios

$usuarioADMINISTRADOR

Returns

integercon el Identificador del Registro usuarios

Recibe Todos los datos de necesarios para la creación de un nuevo registro de usuarios.

guardarApi($usuarioID, $apiCLAVESECRETA, $apiIP) : integer
Static

Parameters

$usuarioID

$apiCLAVESECRETA

$apiIP

Returns

integercon el Identificador del Registro usuarios

Recibe un identificador de usuarios y reactiva el registro.

reactivar(integer $usuarioID) : integer
Static

Parameters

$usuarioID

integer

Identificador del registro

Returns

integerCantidad de registros reactivados

Devuelve todos los registros de usuarios, según el estado.

todos(String $usuarioESTADO = null) : Array
Static

Si no se envia el estado devuelve todos los registros sin importar su estado.

Parameters

$usuarioESTADO

String

Returns

Arrayde Objetos usuarios

 Constants

 

ACTIVO

ACTIVO = 'ACTIVO' 
 

DESACTIVO

DESACTIVO = 'DESACTIVO' 
 

SUSPENDIDO

SUSPENDIDO = 'SUSPENDIDO'