Documentación GVHIDRA 3.1.5
Referencia de la Clase gvHidraDate
Diagrama de herencias de gvHidraDate
gvHidraTypeBase

Métodos públicos

 __construct ($required=false)
 setCalendar ($value)
 getCalendar ()
 setDayOfWeek ($value)
 setDayOfYear ($value)
 getDayOfWeek ()
 getDayOfYear ()
 validate ($value)

Atributos privados

 $calendar
 $dayOfWeek
 $dayOfYear

Descripción detallada

Definición en la línea 44 del archivo gvHidraDate.php.


Documentación del constructor y destructor

__construct ( required = false)

Crear un tipo gvHidraDate (fecha). public

Parámetros:
requiredboolean true campo obligatorio, false campo no obligatorio
Devuelve:
none

Definición en la línea 57 del archivo gvHidraDate.php.

                                                {
        parent::__construct($required,10);
        //Inicializamos atributos de la clase
        $this->setCalendar(false);
        $this->setDayOfWeek('none');
        $this->setDayOfYear(false);
    }//Fin de constructor

Documentación de las funciones miembro

getCalendar ( ) [final]

Definición en la línea 75 del archivo gvHidraDate.php.

                                       {
        return $this->calendar;
    }
getDayOfWeek ( ) [final]

Definición en la línea 103 del archivo gvHidraDate.php.

                                            {
                return $this->dayOfWeek;
        }
getDayOfYear ( ) [final]

Definición en la línea 107 del archivo gvHidraDate.php.

                                            {
                return $this->dayOfYear;
        }
setCalendar ( value) [final]

Indica que si se quiere mostrar o no el objeto calendario public

Parámetros:
booleantrue activa calendario, false desactiva el calendario
Devuelve:
none

Definición en la línea 71 del archivo gvHidraDate.php.

                                             {
        $this->calendar = $value;
    }
setDayOfWeek ( value) [final]

Indica si se quiere mostrar una etiqueta al lado del campo con el da de la semana. public

Parámetros:
string'short' formato corto, 'long' formato extendido, 'none' no se muestra la etiqueta
Devuelve:
none

Definición en la línea 85 del archivo gvHidraDate.php.

                                                  {
                if($value!='short' and $value!='long' and $value!='none'){
                        throw new Exception("Error al definir el type gvHidraDate. La propiedad dayOfWeek slo puede tener valores 'none','short' o 'long'.");
                        $this->dayOfWeek = null;
                        return;
                }
                $this->dayOfWeek = $value;
        }
setDayOfYear ( value) [final]

Indica si se quiere mostrar una etiqueta con el da del ao public

Parámetros:
booltrue muestra etiqueta, false no muestra la etiqueta
Devuelve:
none

Definición en la línea 99 del archivo gvHidraDate.php.

                                                  {
                $this->dayOfYear = $value;
        }
validate ( value)

Recibe un objeto gvHidraTimestamp, que es una fecha-hora vlida TODO: Si recibe un null puede ser porque no se hayan introducido valores o porque no sean vlidos, por lo que siempre que salga entrada incorrecta tambien dir campo obligatorio

Reimplementado de gvHidraTypeBase.

Definición en la línea 116 del archivo gvHidraDate.php.

                                    {
                if (empty($value))
                        $strValue = '';
                elseif (is_object($value) and method_exists($value, 'formatFW'))
                        $strValue = $value->formatFW();
                else {
                        IgepDebug::setDebug(ERROR,'Validacin en gvHidraDate recibe valor desconocido: '.var_export($value,true));
                        throw new Exception('No se recibe una fecha vlida.');
                }
                parent::validate($strValue);
                if (!empty($value) and method_exists($value, 'format')) {
                        if ($value->format('His') != '000000')
                        throw new Exception('No puede tener hora.');                    
                }                       
        return 0;
    }

Documentación de los campos

$calendar [private]

Definición en la línea 47 del archivo gvHidraDate.php.

$dayOfWeek [private]

Definición en la línea 48 del archivo gvHidraDate.php.

$dayOfYear [private]

Definición en la línea 49 del archivo gvHidraDate.php.


La documentación para esta clase fue generada a partir del siguiente fichero: