Class Horde_Form_Type_monthdayyear

Description

Horde_Form_Type Class

Located in /Form/Form.php (line 3357)

Horde_Form_Type
   |
   --Horde_Form_Type_monthdayyear
Variable Summary
 mixed $_end_year
 mixed $_format_in
 mixed $_format_out
 mixed $_picker
 mixed $_start_year
Method Summary
 void about ()
 integer emptyDateArray (mixed $date)
 string formatDate (string $date)
 Date getDateOb (string $date_in)
 array getDateParts (string $date_in)
 void getInfo ( &$vars,  &$var,  &$info)
 void init ([integer $start_year = ''], [integer $end_year = ''], [boolean $picker = true], [integer $format_in = null], [integer $format_out = '%x'])
 void isValid ( &$var,  &$vars,  $value,  &$message)
 void _validateAndFormat ( $value,  &$var)
Variables
mixed $_end_year (line 3360)
mixed $_format_in = null (line 3362)
mixed $_format_out = '%x' (line 3363)
mixed $_picker (line 3361)
mixed $_start_year (line 3359)
Methods
about (line 3560)

Return info about field type.

void about ()
emptyDateArray (line 3424)

Determine if the provided date value is completely empty, partially empty or non-empty.

  • return: 0 for non-empty, 1 for completely empty or -1 for partially empty.
integer emptyDateArray (mixed $date)
  • mixed $date: String or date part array representation of date.
formatDate (line 3519)

Return the date supplied as a Horde_Date object.

  • return: The date formatted according to the $format_out parameter when setting up the monthdayyear field.
string formatDate (string $date)
  • string $date: Either an already set up Horde_Date object or a string date in one of the three formats supported by Horde_Form and Horde_Date (ISO format YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS and UNIX epoch) plus the fourth YYYY-MM-DD.
getDateOb (line 3487)

Return the date supplied as a Horde_Date object.

  • return: The date object.
Date getDateOb (string $date_in)
  • string $date_in: Date in one of the three formats supported by Horde_Form and Horde_Date (ISO format YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS and UNIX epoch) plus the fourth YYYY-MM-DD.
getDateParts (line 3460)

Return the date supplied split up into an array.

  • return: Array with three elements - year, month and day.
array getDateParts (string $date_in)
  • string $date_in: Date in one of the three formats supported by Horde_Form and Horde_Date (ISO format YYYY-MM-DD HH:MM:SS, timestamp YYYYMMDDHHMMSS and UNIX epoch) plus the fourth YYYY-MM-DD.
getInfo (line 3533)

Insert the date input through the form into $info array, in the format specified by the $format_in parameter when setting up monthdayyear field.

void getInfo ( &$vars,  &$var,  &$info)
  • &$vars
  • &$var
  • &$info

Redefinition of:
Horde_Form_Type::getInfo()
init (line 3377)

Return the date supplied as a Horde_Date object.

void init ([integer $start_year = ''], [integer $end_year = ''], [boolean $picker = true], [integer $format_in = null], [integer $format_out = '%x'])
  • integer $start_year: The first available year for input.
  • integer $end_year: The last available year for input.
  • boolean $picker: Do we show the DHTML calendar?
  • integer $format_in: The format to use when sending the date for storage. Defaults to Unix epoch. Similar to the strftime() function.
  • integer $format_out: The format to use when displaying the date. Similar to the strftime() function.

Redefinition of:
Horde_Form_Type::init()
isValid (line 3394)
void isValid ( &$var,  &$vars,  $value,  &$message)
  • &$var
  • &$vars
  • $value
  • &$message

Redefinition of:
Horde_Form_Type::isValid()
_validateAndFormat (line 3541)

Validate/format a date submission.

void _validateAndFormat ( $value,  &$var)
  • $value
  • &$var

Inherited Methods

Inherited From Horde_Form_Type

 Horde_Form_Type::Horde_Form_Type()
 Horde_Form_Type::getInfo()
 Horde_Form_Type::getProperty()
 Horde_Form_Type::getTypeName()
 Horde_Form_Type::getValues()
 Horde_Form_Type::init()
 Horde_Form_Type::isValid()
 Horde_Form_Type::onSubmit()
 Horde_Form_Type::setProperty()
 Horde_Form_Type::__get()
 Horde_Form_Type::__set()

Documentation generated on Sun, 30 Jan 2011 05:17:31 +0000 by phpDocumentor 1.4.3