- Symphony 2.3.1
-
› assets
11 -
› boot
9 -
› core
22 -
› cryptography
4 -
› email-gateways
3 -
› interface
6 -
› toolkit
72 -
› Unknown
38 - Delegates91
- Deprecated28
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 fieldTextarea
public class fieldTextarea extends Field
field.textarea.php #13A simple Textarea field that essentially maps to HTML's <textarea/>
.
Methods
void __construct()
Construct a new instance of this field.
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
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.
integer checkPostFieldData(Field $field, Widget $label, Widget $textarea)
$data, $message, $entry_id, $context,
Allows developers modify the textarea before it is rendered in the publish forms
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
array fetchIncludableElements()
Default accessor for the includable elements of this field. This array
will populate the Datasource
included elements. Fields that have
different modes will override this and add new items to the array.
The Symphony convention is element_name : mode. Modes allow Fields to
output different XML in datasources.
Returns
the array of includable elements from this field.
void findDefaults(
$settings)
Allows a field to set default settings.
Parameters
XMLElement getExampleFormMarkup()
The default method for constructing the example form markup containing this
field when utilized as part of an event. This displays in the event documentation
and serves as a basic guide for how markup should be constructed on the
Frontend
to save this field
Returns
a label widget containing the formatted field element name of this.
array getExportModes()
Return a list of supported export modes for use with prepareExportValue
.
string|null prepareExportValue(
$data, $mode, $entry_id)
Give the field some data and ask it to return a value using one of many possible modes.
array prepareImportValue(
$data, $entry_id)
Give the field some data and ask it to return a value.
array processRawFieldData(
$data, $status, $message, $simulate, $entry_id)
Process the raw field data.
Parameters
Returns
the processed field data.