api/modelos/planeador/Planes.php
Classes
- Package
- Default
\Planes
%%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
- RONALD ANDRES FABRA JIMENEZ
- 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/Planes
- Version
- 201711200924
Constants
PENDIENTE
= 'PENDIENTE'
PLANEACION
= 'EN PLANEACION'
APROBADO
= 'APROBADO'
EJECUCION
= 'EN EJECUCION'
TERMINADO
= 'TERMINADO'Methods
activos() : ArrayDevuelve los registros de planes en estado ACTIVO.
| Type | Description |
|---|---|
| Array | de Objetos planes |
actualizar(integer $planID, $vigenciaID, String $planCODIGO, \Texto $planDESCRIPCION, $planEstadoID) : integerRecibe los todos los datos del registro para ser actualizados, junto con el identificador del registro que se va ha actualizar.
| Name | Type | Description |
|---|---|---|
| $planID | integer | Identificador del Registro de planes |
| $vigenciaID | ||
| $planCODIGO | String | Código de planes |
| $planDESCRIPCION | \Texto | Descripción de planes |
| $planEstadoID |
| Type | Description |
|---|---|
| integer | cantidad de registros actualziados en la operacion |
cambiarEstado(String $planESTADO, integer $planID) : integerRecibe un identificador y el Estado y actualiza el estado del registro
| Name | Type | Description |
|---|---|---|
| $planESTADO | String | Nuevo estado del registro. |
| $planID | integer | Identificador del registro |
| Type | Description |
|---|---|
| integer | Cantidad de registros desactivados |
datos(integer $planID) : \ObjetoRecibe el Identificador del registro de plan y devuelve un objeto con sus datos.
| Name | Type | Description |
|---|---|---|
| $planID | integer |
| Type | Description |
|---|---|
| \Objeto | plan |
datosCompletos(integer $planID) : \ObjetoRecibe el Identificador del registro de plan y devuelve un objeto con sus datos completos con todas sus relacion.
| Name | Type | Description |
|---|---|---|
| $planID | integer |
| Type | Description |
|---|---|
| \Objeto | plan |
datosCompletosTodos(integer $planID) : \ObjetoRecibe el Identificador del registro de plan y devuelve un objeto con sus datos completos con todas sus relaciones.
| Name | Type | Description |
|---|---|---|
| $planID | integer |
| Type | Description |
|---|---|
| \Objeto | plan |
desactivar(integer $planID) : integerRecibe un identificador de planes y desactiva el registro.
| Name | Type | Description |
|---|---|---|
| $planID | integer | Identificador del registro |
| Type | Description |
|---|---|
| integer | Cantidad de registros desactivados |
eliminar(integer $planID) : integerRecibe un identificador de planes y elimina el registro.
| Name | Type | Description |
|---|---|---|
| $planID | integer | Identificador del registro ha eliminar. |
| Type | Description |
|---|---|
| integer | Cantidad de registros eliminados |
guardar( $vigenciaID, String $planCODIGO, \Texto $planDESCRIPCION, $planEstadoID) : integerRecibe Todos los datos de necesarios para la creación de un nuevo registro de planes.
| Name | Type | Description |
|---|---|---|
| $vigenciaID | ||
| $planCODIGO | String | Código de planes |
| $planDESCRIPCION | \Texto | Descripción de planes |
| $planEstadoID |
| Type | Description |
|---|---|
| integer | con el Identificador del Registro planes |
reactivar(integer $planID) : integerRecibe un identificador de planes y reactiva el registro.
| Name | Type | Description |
|---|---|---|
| $planID | integer | Identificador del registro |
| Type | Description |
|---|---|
| integer | Cantidad de registros reactivados |
todos( $planesESTADOS = null) : ArrayDevuelve todos los registros de planes, según el estado.
Si no se envia el estado devuelve todos los registros sin importar su estado.
| Name | Type | Description |
|---|---|---|
| $planesESTADOS |
| Type | Description |
|---|---|
| Array | de Objetos planes |