phpkrond.modulos.calendario
[ class tree: phpkrond.modulos.calendario ] [ index: phpkrond.modulos.calendario ] [ all elements ]

Class: calendario_cita

Source Location: Program_Root/modulos/calendario/calendario.inc.php

Class Overview


Clase que gestiona las Citas en el calendario.


Author(s):

  • Francisco José Sánchez Sánchez

Version:

  • 200

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 312]
Clase que gestiona las Citas en el calendario.

Las citas son las fechas del calendario a recordar. La tabla que recoge esta información en la base de datos se llama 'calendario_citas'.




Tags:

version:  200
author:  Francisco José Sánchez Sánchez


[ Top ]


Class Variables

$db =

[line 332]

Contiene la conexion de la base de datos.

Este atributo es del tipo newADOconnection que pertenece a ADODB. Automaticamente es inicializado recogiendolo de la objeto $GLOBALS['KROND_CFG']. Este objeto tiene un atributo, $db, que inicializa la conexion con la base de datos.



Type:   mixed


[ Top ]

$idCita =

[line 321]

Atributo de la clase que guarda la clave de la Cita.

El atributo de la clase $idCita es el identificador utilizado como clave primaria en la tabla 'calendario_citas'.



Type:   mixed


[ Top ]



Class Methods


constructor calendario_cita [line 343]

calendario_cita calendario_cita( [$idCita $idCita = 0])

Contructor de la clase.

Inicializa el atributo $idCita de la clase. Este atributo se utiliza como clave primaria en la tabla 'calendario_citas'.




Parameters:

$idCita   $idCita   Identificador de la Cita.

[ Top ]

method borrar [line 574]

boolean borrar( )

Borra una cita del calendario

Elimina la entrada de la cita que se encuentra en la tabla 'calendario_citas'.




Tags:

return:  true si se completó la operación con exito.


[ Top ]

method check_datos [line 544]

boolean check_datos( $datos $datos)

Verifica que los datos son correctos

En principio solo comprueba que los datos son distintos de "". Util para comprobar la fecha

  • la descripción de una cita.




Tags:

return:  Devuelve true si los datos son válidos.


Parameters:

$datos   $datos   String que los datos a comprobar.

[ Top ]

method check_fecha [line 557]

boolean check_fecha( $fecha $fecha)

Verifica que la fecha es correcta.

Comprueba que la fecha dada es correcta. La fecha se pasa en formato 'AAAA-MM-DD'.




Tags:

return:  Devuelve true si la fecha es válida.


Parameters:

$fecha   $fecha   String que la fecha a comprobar.

[ Top ]

method crear [line 520]

boolean crear( $fecha $fecha, $nombre $nombre, $descripcion $descripcion, $idEvento $idEvento)

Crea una nueva cita en el calendario.

Crea una nueva entrada en la tabla 'calendario_citas' inicializando todos los campos con los datos de la nueva cita.




Tags:

return:  True si se completó la operación con exito.


Parameters:

$fecha   $fecha   Fecha de la nueva cita.
$nombre   $nombre   Nombre de la cita.
$descripcion   $descripcion   Descripción de la nueva cita.
$idEvento   $idEvento   Tipo de evento de la cita.

[ Top ]

method existe [line 497]

boolean existe( )

Verifica si la cita existe.

Comprueba que el identificador de la cita es correcto.




Tags:

return:  True si el identificador de cita existe.


[ Top ]

method get_all [line 437]

Array get_all( )

Devuelve las citas del calendario.

Los citas estan ordenadas por fecha en orden decreciente.




Tags:

return:  Objetos de calendario_cita con las citas.


[ Top ]

method get_citas_mes [line 460]

Array get_citas_mes( [$fecha $fecha = ""])

Devuelve un array con los dias del mes y las citas en ellos.

El array esta indexado por dias y si tiene citas en un dia particular, contiene un array de objetos 'calendario_cita' con las citas que se dan en ese dia.




Tags:

return:  Conteniene un array por dias del mes.


Parameters:

$fecha   $fecha   Fecha en la que mirar las citas. De esa fecha se toma el mes y el año para consultarlo con el sistema.

[ Top ]

method get_descripcion [line 404]

String get_descripcion( )

Devuelve la descripción de la cita.

La descripción contiene toda la información sobre la cita. Se almacena en el campo 'descripcion' de la tabla 'calendario_citas'.




Tags:

return:  Descripción de la cita.


[ Top ]

method get_evento [line 420]

calendario_evento get_evento( )

Devuelve el tipo de Evento de la cita.

Las citas se clasificas en tipos de eventos.




Tags:

return:  Tipo de Evento.


[ Top ]

method get_fecha [line 368]

String get_fecha( )

Devuelve la fecha de la cita.

La fecha esta en formato 'AAAA-MM-DD'.




Tags:

return:  Fecha de la Cita.


[ Top ]

method get_id [line 357]

Integer get_id( )

Devuelve el identificador de la cita.

El identificador de la cita se guarda en la variable $this->idCita de la clase. Se utiliza como clave primaria en la tabla 'calendario_citas'.




Tags:

return:  Identificador de la Cita.


[ Top ]

method get_nombre [line 386]

String get_nombre( )

Devuelve el nombre de la cita.

La nombre de la cita es una referencia corta de la cita. Se almacena en el campo 'nombre_cita' de la tabla 'calendario_citas'.




Tags:

return:  Nombre de la cita.


[ Top ]

method set [line 597]

Boolean set( $fecha $fecha, $nombre $nombre, $descripcion $descripcion, $idEvento $idEvento)

Modifica las propiedades de una cita.

Modifica la descripción, fecha y el tipo de evento asociado a la misma. Comprueba que los nuevos datos son correctos.




Tags:

return:  True si se modificaron las propiedades.


Parameters:

$fecha   $fecha   Nueva fecha de la cita.
$nombre   $nombre   Nuevo nombre de la cita.
$descripcion   $descripcion   Nueva descripción de la cita.
$idEvento   $idEvento   Nuevo tipo de evento de la cita.

[ Top ]


Documentation generated on Sun, 14 Sep 2003 01:54:34 +0200 by phpDocumentor 1.2.1