Field fieldTextarea

public class fieldTextarea extends Field

field.textarea.php #10

A simple Textarea field that essentially maps to HTML's <textarea/>.

Methods

void __construct()

Construct a new instance of this field.

void appendFormattedElement(XMLElement $wrapper, array $data, bool $encode, string $mode, integer $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
  • $wrapper XMLElementthe XML element to append the XML representation of this to.

  • $data arraythe current set of values for this field. the values are structured as for displayPublishPanel.

  • $encode bool(optional) flag as to whether this should be html encoded prior to output. this defaults to false.

  • $mode stringA field can provide ways to output this field's data. For instance a mode could be 'items' or 'full' and then the function would display the data in a different way depending on what was selected in the datasource included elements.

  • $entry_id integer(optional) the identifier of this field entry instance. defaults to null.

boolean buildDSRetrievalSQL(array $data, string $joins, string $where, bool $andOperation)

Construct the SQL statement fragments to use to retrieve the data of this field when utilized as a data source.

Parameters
  • $data arrayAn array of the data that contains the values for the filter as specified in the datasource editor. The value that is entered in the datasource editor is made into an array by using + or , to separate the filter.

  • $joins stringA string containing any table joins for the current SQL fragment. By default Datasources will always join to the tbl_entries table, which has an alias of e. This parameter is passed by reference.

  • $where stringA string containing the WHERE conditions for the current SQL fragment. This is passed by reference and is expected to be used to add additional conditions specific to this field

  • $andOperation bool(optional) This parameter defines whether the $data provided should be treated as AND or OR conditions. This parameter will be set to true if $data used a + to separate the values, otherwise it will be false. It is false by default.

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.

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(array $data, string $message, integer $entry_id, string $context, Field $field, Widget $label, Widget $textarea)

Allows developers modify the textarea before it is rendered in the publish forms

Parameters
  • $context string'/backend/'

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.

See Also
void displayPublishPanel(XMLElement $wrapper, array $data, mixed $flagWithError, string $fieldnamePrefix, string $fieldnamePostfix, integer $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
  • $wrapper XMLElementthe XML element to append the html defined user interface to this field.

  • $data array(optional) any existing data that has been supplied for this field instance. this is encoded as an array of columns, each column maps to an array of row indexes to the contents of that column. this defaults to null.

  • $flagWithError mixed(optional) flag with error defaults to null.

  • $fieldnamePrefix string(optional) the string to be prepended to the display of the name of this field. this defaults to null.

  • $fieldnamePostfix string(optional) the string to be appended to the display of the name of this field. this defaults to null.

  • $entry_id integer(optional) the entry id of this field. this defaults to null.

void displaySettingsPanel(XMLElement $wrapper, mixed $errors)

Display the default settings panel, calls the buildSummaryBlock function after basic field settings are added to the wrapper.

Parameters
  • $wrapper XMLElementthe input XMLElement to which the display of this will be appended.

  • $errors mixedthe input error collection. this defaults to null.

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(array $settings)

Allows a field to set default settings.

Parameters
  • $settings arraythe array of settings to populate with their defaults.

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.

void getImportModes()
string|null prepareExportValue(mixed $data, integer $mode, integer $entry_id)

Give the field some data and ask it to return a value using one of many possible modes.

void prepareImportValue(mixed $data, mixed $mode, mixed $entry_id)
array processRawFieldData(mixed $data, integer $status, string $message, bool $simulate, mixed $entry_id)

Process the raw field data.

Parameters
  • $data mixedpost data from the entry form

  • $status integerthe status code resultant from processing the data.

  • $message stringthe place to set any generated error message. any previous value for this variable will be overwritten.

  • $simulate bool(optional) true if this will tell the CF's to simulate data creation, false otherwise. this defaults to false. this is important if clients will be deleting or adding data outside of the main entry object commit function.

  • $entry_id mixed(optional) the current entry. defaults to null.

Returns

the processed field data.

Symphony • Open Source XSLT CMS

Server Requirements

  • PHP 5.3-5.6 or 7.0-7.3
  • PHP's LibXML module, with the XSLT extension enabled (--with-xsl)
  • MySQL 5.5 or above
  • An Apache or Litespeed webserver
  • Apache's mod_rewrite module or equivalent

Compatible Hosts

Sign in

Login details