Class DateItem

Date item object

Model

Extended by

AppModel

Extended by

BEAppModel

Extended by

DateItem

Located at models/date_item.php

Methods summary

`public string`	# `getColumnType( string $column )` Returns the column type of a column in the model. Returns the column type of a column in the model. Parameters `$column` The name of the model column. Returns string Column type. See Model::getColumnType()
`protected array`	# `filterParams( array $params )` Filter out valid parameter keys. Filter out valid parameter keys. Parameters `$params` Array of potential parameters. Returns array Filtered array of parameters.
`public integer\|null`	# `stringToTimestamp( string $date )` Convert a string to timestamp. Convert a string to timestamp. This function is safe with years after 9999 or before -9999. Parameters `$date` Date to be converted. Returns integer\|null Timestamp.
`public mixed`	# `prepareDate( string $column, mixed $date )` Prepares one or more dates in the correct format for the underlying database structure (either `DATETIME` or `BIGINT`). Prepares one or more dates in the correct format for the underlying database structure (either `DATETIME` or `BIGINT`). Parameters `$column` The name of the model column. `$date` Date (or array of dates) to be prepared. Returns mixed Prepared date(s).
`private array`	# `prepareConditions( array $data )` Helper function to recursively prepare conditions. Helper function to recursively prepare conditions. Parameters `$data` Data to be prepared. Returns array Prepared data.
`public boolean`	# `beforeValidate( )` Runs actual validation rules. If supplied values aren't valid, they are silently removed. Runs actual validation rules. If supplied values aren't valid, they are silently removed. Returns boolean Returns `true`.
`public array`	# `beforeFind( array $queryData )` Before find condition formatting. Before find condition formatting. Parameters `$queryData` Array with query data. Returns array Array with modified query data.
`public array`	# `afterFind( mixed $results )` After find data formatting. After find data formatting. Parameters `$results` Found results. Returns array Formatted results.
`protected static`	# `addToCalendar( array & $calendar, array $dateItem )` Add a DateItem to the calendar with respect of time order. Add a DateItem to the calendar with respect of time order. Parameters `$calendar` Calendar. `$dateItem` DateItem to be added.
`public array,`	# `loadDateItemsCalendar( string $startDay, string $endDay )` Load calendar date items in the time window specified. Returns array containing a list of object IDs with matching date items, and a list of DateItems for each day. Load calendar date items in the time window specified. Returns array containing a list of object IDs with matching date items, and a list of DateItems for each day. Parameters `$startDay` Start date, using the format `YYYY-MM-DD`, i.e. `2014-02-28`. `$endDay` End date (not included), using the format `YYYY-MM-DD`, i.e. `2014-03-14`. Returns array, containing "objIds" => array of object id matched, "calendar" => associative array having "date" as key and date items as values
`public array`	# `apiTransformer( array $options = array() )` Return an array of column types to transform (cast) Used to build consistent REST APIs Return an array of column types to transform (cast) Used to build consistent REST APIs Force 'start_date' and 'end_date' to be formatted as dates also when those fields are defined as BIGINT for handle historical dates Add to table fields type 'days' as 'integerArray' to convert ["0", "1", ...] in [0, 1, ...] Possible options are: - 'castable' an array of fields that the rest api would be cast to Parameters `$options` Returns array See AppModel::apiTransformer() Overrides `AppModel::apiTransformer`

Methods inherited from BEAppModel

am(), buildQueryStatement(), checkDate(), checkDuration(), checkFloat(), checkNumber(), containLevel(), email(), fieldsString(), findObjects(), findObjectsAfterFilter(), findObjectsClauses(), findObjectsCount(), getBindingsLevel(), getDefaultDateFormat(), getDriver(), getEndQuote(), getLimitClausole(), getStartQuote(), setBindingsLevel(), setupDbParams(), toolbar()

Properties summary

`public integer`	`$recursive` Recursive find depth. Recursive find depth.	# `0`
`public array`	`$validate` Validation rules. Validation rules.	# `array()`

Properties inherited from BEAppModel

$actsAs, $driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions