- Symphony 2.6.5
-
› assets
14 -
› boot
14 -
› core
23 -
› cryptography
4 -
› data-sources
6 -
› email-gateways
3 -
› events
3 -
› global
61 -
› interface
9 -
› toolkit
60 - Delegates92
- Deprecated26
Versions
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.3
- 2.7.2
- 2.7.10
- 2.7.1
- 2.7.0
- 2.6.9
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.11
- 2.6.10
- 2.6.1
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2
Options
Field FieldDate
public class FieldDate extends Field
field.date.php #13A simple Date field that stores a full ISO date. Symphony will attempt
to localize the date on a per Author basis. The field essentially maps to
PHP's strtotime
, so it is very flexible in terms of what an Author can
input into it.
Constants
static int ERROR = 4
static int RANGE = 3
static int REGEXP = 1
static int $SIMPLE
Methods
void __construct()
Construct a new instance of this field.
boolean allowDatasourceOutputGrouping()
Test whether this field supports data-source output grouping. This default implementation prohibits grouping. Data-source grouping allows clients of this field to group the XML output according to this field. Subclasses should override this if grouping is supported.
Returns
true if this field does support data-source grouping, false otherwise.
boolean allowDatasourceParamOutput()
Test whether this field supports data-source parameter output. This default implementation prohibits parameter output. Data-source parameter output allows this field to be provided as a parameter to other data-sources or XSLT. Subclasses should override this if parameter output is supported.
Returns
true if this supports data-source parameter output, false otherwise.
void appendFormattedElement(XMLElement $wrapper, $data, $encode, $mode, $entry_id)
Append the formatted XML output of this field as utilized as a data source.
Since Symphony 2.5.0, it will defaults to prepareReadableValue
return value.
Parameters
boolean buildDSRetrievalSQL(
$data, $joins, $where, $andOperation)
Construct the SQL statement fragments to use to retrieve the data of this field when utilized as a data source.
Parameters
Returns
True if the construction of the SQL was successful, false otherwise.
See Also
void buildRangeFilterSQL(
$data, $joins, $where, $andOperation)
void buildSortingSQL(
$joins, $where, $sort, $order)
Build the SQL command to append to the default query to enable sorting of this field. By default this will sort the results by the entry id in ascending order.
Parameters
boolean canFilter()
Test whether this field can be filtered. This default implementation prohibits filtering. Filtering allows the XML output results to be limited according to an input parameter. Subclasses should override this if filtering is supported.
Returns
true if this can be filtered, false otherwise.
boolean canPrePopulate()
Test whether this field can be prepopulated with data. This default implementation does not support pre-population and, thus, returns false.
Returns
true if this can be pre-populated, false otherwise.
integer checkPostFieldData(
$data, $message, $entry_id)
Check the field data that has been posted from a form. This will set the input message to the error message or to null if there is none. Any existing message value will be overwritten.
Parameters
Returns
self::__MISSING_FIELDS__
if there are any missing required fields, self::__OK__
otherwise.
static void cleanFilterString(
$string)
boolean commit()
Commit the settings of this field from the section editor to create an instance of this field in a section.
Returns
true if the commit was successful, false otherwise.
boolean createTable()
The default field table construction method. This constructs the bare minimum set of columns for a valid field table. Subclasses are expected to overload this method to create a table structure that contains additional columns to store the specific data created by the field.
void displayPublishPanel(XMLElement $wrapper, $data, $flagWithError, $fieldnamePrefix, $fieldnamePostfix, $entry_id)
Display the publish panel for this field. The display panel is the
interface shown to Authors that allow them to input data into this
field for an Entry
.
Parameters
void displaySettingsPanel(XMLElement $wrapper, $errors)
Display the default settings panel, calls the buildSummaryBlock
function after basic field settings are added to the wrapper.
Parameters
See Also
array fetchFilterableOperators()
Returns the keywords that this field supports for filtering. Note that no filter will do a simple 'straight' match on the value.
array fetchSuggestionTypes()
Returns the types of filter suggestion this field supports. The array may contain the following values:
entry
for searching entries in the current sectionassociation
for searching entries in associated sectionsstatic
for searching static valuesdate
for searching in a calendarparameters
for searching in parametersIf the date type is set, only the calendar will be shown in the suggestion dropdown.
void findDefaults(
$settings)
Allows a field to set default settings.
Parameters
string formatDate(
$date)
Format the $data parameter according to this field's settings.
Parameters
array getExportModes()
Return a list of supported export modes for use with prepareExportValue
.
void getImportModes()
string|array getParameterPoolValue(
$data, $entry_id)
Function to format this field if it chosen in a data-source to be output as a parameter in the XML.
Since Symphony 2.5.0, it will defaults to prepareReadableValue
return value.
Parameters
Returns
The formatted value to be used as the parameter. Note that this can be an array or a string. When returning multiple values use array, otherwise use string.
void groupRecords(
$records)
Default implementation of record grouping. This default implementation
will throw an Exception
. Thus, clients must overload this method
for grouping to be successful.
Parameters
static array isEqualTo(
$parts, $direction, $equal_to)
Builds the correct date array depending if the filter should include the filter as well, ie. later than 2011, is effectively the same as equal to or later than 2012.
Parameters
boolean isSortable()
Test whether this field can be sorted. This default implementation returns false.
Returns
true if this field is sortable, false otherwise.
static array parseDate(
$string, $direction, $equal_to)
Given a string, this function builds the range of dates that match it. The strings should be in ISO8601 style format, or a natural date, such as 'last week' etc.
Parameters
Returns
An associative array containing a date in ISO8601 format (or natural) with two keys, start and end.
static void parseFilter(
$string)
DateTime|null prepareExportValue(
$data, $mode, $entry_id)
Give the field some data and ask it to return a value using one of many possible modes.
void prepareImportValue(
$data, $mode, $entry_id)
string prepareTextValue(
$data, $entry_id)
Format this field value for complete display as text (string). By default, it looks for the 'value' key in the $data array and strip tags from it.
Parameters
Returns
the complete text representation of the values of this field instance.
array processRawFieldData(
$data, $status, $message, $simulate, $entry_id)
Process the raw field data.
Parameters
Returns
the processed field data.