api/modelos/usuarios/UsuariosApi.php

Show:

inherited

Classes
- \UsuariosApi

Table of Contents

Package: Default

\UsuariosApi
jump to top

Package: Modelos\Datos\Usuarios

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.

Parent(s): \ModeloDatos
Author: LUIS ANTONIO MONTOYA CONTRERAS
Author: SICAM 20171025
Copyright: 2017 Cámara de Comercio de Santa Marta para el Magdalena
Inherited_from: \ModeloDatos
License: PHP License 3.01
Link: http://sicam.ccsm.org.co/docs/modelos/datos/Usuarios
Version: 201712181018

Constants

 
                ACTIVO
                = 'ACTIVO'

 
                DESACTIVO
                = 'DESACTIVO'

 
                SUSPENDIDO
                = 'SUSPENDIDO'

Methods

activos() : Array

static

Devuelve los registros de usuarios en estado ACTIVO.

Returns

Type	Description
Array	de Objetos usuarios

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

static

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

Parameters

Name	Type	Description
$usuarioID	integer	Identificador del Registro de usuarios
$aplicacionID
$usuarioNOMBRE
$usuarioADMINISTRADOR

Returns

Type	Description
integer	cantidad de registros actualziados en la operacion

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

static

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

Parameters

Name	Type	Description
$usuarioESTADO	String	Nuevo estado del registro.
$usuarioID	integer	Identificador del registro

Returns

Type	Description
integer	Cantidad de registros desactivados

datos(integer $usuarioID) : \Objeto

static

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

Parameters

Name	Type	Description
$usuarioID	integer

Returns

Type	Description
\Objeto	usuario

datosCompletos(integer $usuarioID) : \Objeto

static

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

Parameters

Name	Type	Description
$usuarioID	integer

Returns

Type	Description
\Objeto	usuario

desactivar(integer $usuarioID) : integer

static

Recibe un identificador de usuarios y desactiva el registro.

Parameters

Name	Type	Description
$usuarioID	integer	Identificador del registro

Returns

Type	Description
integer	Cantidad de registros desactivados

eliminar(integer $usuarioID) : integer

static

Recibe un identificador de usuarios y elimina el registro.

Parameters

Name	Type	Description
$usuarioID	integer	Identificador del registro ha eliminar.

Returns

Type	Description
integer	Cantidad de registros eliminados

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

static

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

Parameters

Name	Type	Description
$aplicacionID
$usuarioNOMBRE
$usuarioCLAVE
$usuarioESTADO	String	Estado del registro de usuarios
$usuarioADMINISTRADOR

Returns

Type	Description
integer	con el Identificador del Registro usuarios

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

static

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

Parameters

Name	Type	Description
$usuarioID
$apiCLAVESECRETA
$apiIP

Returns

Type	Description
integer	con el Identificador del Registro usuarios

reactivar(integer $usuarioID) : integer

static

Recibe un identificador de usuarios y reactiva el registro.

Parameters

Name	Type	Description
$usuarioID	integer	Identificador del registro

Returns

Type	Description
integer	Cantidad de registros reactivados

todos(String $usuarioESTADO = null) : Array

static

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

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

Parameters

Name	Type	Description
$usuarioESTADO	String

Returns

Type	Description
Array	de Objetos usuarios

api/modelos/usuarios/UsuariosApi.php

\UsuariosApijump to top

Constants

Methods

\UsuariosApi
jump to top