- Symphony 2.3
-
› assets
8 -
› boot
9 -
› core
22 -
› email-gateways
3 -
› global
34 -
› interface
1 -
› toolkit
69 - Delegates89
- Deprecated27
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 fieldInput
public class fieldInput extends Field
field.input.php #13A simple Input field that essentially maps to HTML's <input type='text'/>
.
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.
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 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 canImport()
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
Returns
true if this can be imported, false otherwise.
Deprecated
This function will be removed in the next major release. It is unused by Symphony.
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.
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, $fieldnameSuffix)
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
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
boolean isSortable()
Test whether this field can be sorted. This default implementation returns false.
Returns
true if this field is sortable, false otherwise.
array processRawFieldData(
$data, $status, $message, $simulate, $entry_id)
Process the raw field data.
Parameters
Returns
the processed field data.
void setFromPOST(
$settings)
Fill the input data array with default values for known keys provided these settings are not already set. The input array is then used to set the values of the corresponding settings for this field. This function is called when a section is saved.