- Symphony 2.2.1
-
› boot
9 -
› core
22 -
› email-gateways
3 -
› toolkit
66 -
› Unknown
33 - Delegates83
- Deprecated30
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 fieldTagList
public class fieldTagList extends Field
field.taglist.php #13The Tag List field is really a different interface for the Select Box field, offering a tag interface that can have static suggestions, suggestions from another field or a dynamic list based on what an Author has previously used for this field.
Methods
void __construct(
$parent)
Construct a new instance of this field.
Parameters
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.
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.
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 displayDatasourceFilterPanel(XMLElement $wrapper, $data, $errors, $fieldnamePrefix, $fieldnamePostfix, $fieldNamePrefix, $fieldNameSuffix)
Display the default data-source filter panel.
Parameters
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 findAllTags()
void findDefaults(
$fields, $settings)
Allows a field to set default settings.
Parameters
string prepareTableValue(XMLElement $link)
$data,
Format this field value for display in the publish index tables. By default,
Symphony will truncate the value to the configuration setting cell_truncation_length
.
This function will attempt to use PHP's mbstring
functions if they are available.
Parameters
Returns
the formatted string summary of the values of this field instance.
array processRawFieldData(
$data, $status, $simulate, $entry_id)
Process the raw field data.
Parameters
Returns
the processed field data.
boolean requiresSQLGrouping()
Test whether this field requires grouping. This default implementation returns false.
Returns
true if this field requires grouping, false otherwise.
void set(
$field, $value, $setting)
Fields have settings that define how that field will act in a section, including if it's required, any validators, if it can be shown on the entries tableetc. This function will set a setting to a value. This function will set a setting to a value overwriting any existing value for this setting