Documentation

Horde_Form_Type_monthdayyear extends Horde_Form_Type
in package

Horde_Form_Type Class

Table of Contents

$_end_year  : mixed
$_format_in  : mixed
$_format_out  : mixed
$_picker  : mixed
$_start_year  : mixed
__get()  : mixed
__set()  : mixed
_validateAndFormat()  : mixed
Validate/format a date submission.
about()  : mixed
Return info about field type.
emptyDateArray()  : int
Determine if the provided date value is completely empty, partially empty or non-empty.
formatDate()  : string
Return the date supplied as a Horde_Date object.
getDateOb()  : Horde_Date
Return the date supplied as a Horde_Date object.
getDateParts()  : array<string|int, mixed>
Return the date supplied split up into an array.
getInfo()  : mixed
Insert the date input through the form into $info array, in the format specified by the $format_in parameter when setting up monthdayyear field.
getProperty()  : mixed
getTypeName()  : mixed
getValues()  : mixed
init()  : mixed
Return the date supplied as a Horde_Date object.
isValid()  : mixed
onSubmit()  : mixed
setProperty()  : mixed

Properties

$_end_year

public mixed $_end_year

$_format_in

public mixed $_format_in = \null

$_format_out

public mixed $_format_out = '%x'

$_picker

public mixed $_picker

$_start_year

public mixed $_start_year

Methods

__get()

public __get(mixed $property) : mixed
Parameters
$property : mixed
Return values
mixed

__set()

public __set(mixed $property, mixed $value) : mixed
Parameters
$property : mixed
$value : mixed
Return values
mixed

_validateAndFormat()

Validate/format a date submission.

public _validateAndFormat(mixed $value, mixed &$var) : mixed
Parameters
$value : mixed
$var : mixed
Return values
mixed

about()

Return info about field type.

public about() : mixed
Return values
mixed

emptyDateArray()

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

public emptyDateArray(mixed $date) : int
Parameters
$date : mixed

String or date part array representation of date.

Return values
int

0 for non-empty, 1 for completely empty or -1 for partially empty.

formatDate()

Return the date supplied as a Horde_Date object.

public formatDate(string $date) : string
Parameters
$date : string

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.

Return values
string

The date formatted according to the $format_out parameter when setting up the monthdayyear field.

getDateOb()

Return the date supplied as a Horde_Date object.

public getDateOb(string $date_in) : Horde_Date
Parameters
$date_in : 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.

Return values
Horde_Date

The date object.

getDateParts()

Return the date supplied split up into an array.

public getDateParts(string $date_in) : array<string|int, mixed>
Parameters
$date_in : 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.

Return values
array<string|int, mixed>

Array with three elements - year, month and day.

getInfo()

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

public getInfo(mixed &$vars, mixed &$var, mixed &$info) : mixed
Parameters
$vars : mixed
$var : mixed
$info : mixed
Return values
mixed

getProperty()

public getProperty(mixed $property) : mixed
Parameters
$property : mixed
Return values
mixed

getTypeName()

public getTypeName() : mixed
Return values
mixed

getValues()

public getValues(mixed ...$params) : mixed
Parameters
$params : mixed
Return values
mixed

init()

Return the date supplied as a Horde_Date object.

public init(mixed ...$params) : mixed

function init($start_year = '', $end_year = '', $picker = true, $format_in = null, $format_out = '%x')

Parameters
$params : mixed
Return values
mixed

isValid()

public isValid(mixed &$var, mixed &$vars, mixed $value, mixed &$message) : mixed
Parameters
$var : mixed
$vars : mixed
$value : mixed
$message : mixed
Return values
mixed

onSubmit()

public onSubmit(mixed ...$params) : mixed
Parameters
$params : mixed
Return values
mixed

setProperty()

public setProperty(mixed $property, mixed $value) : mixed
Parameters
$property : mixed
$value : mixed
Return values
mixed

Search results