- Symphony 2.6.9
-
› assets
14 -
› boot
14 -
› core
23 -
› cryptography
4 -
› data-sources
6 -
› email-gateways
3 -
› events
3 -
› global
59 -
› interface
9 -
› toolkit
59 - Delegates92
- 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 FieldTagList
public class FieldTagList extends Field
field.taglist.php #12The 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()
Construct a new instance of this field.
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
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.
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 displayFilteringOptions(XMLElement $wrapper)
Inserts tags at the bottom of the filter panel
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
void|integer fetchAssociatedEntryCount(
$value)
Fetch the count of the associated entries given a $value
.
Parameters
Returns
this default implementation returns void. overriding implementations should return an integer.
See Also
void|array fetchAssociatedEntryIDs(
$value)
Fetch the Entry ID's associated with this field instance given a $value
,
where the $value
can be anything. This function is unused by Symphony core
but should be implemented by Fields that maintain relationships.
Parameters
Returns
this default implementation returns void. overriding implementations should return an array of the associated entry ids.
Deprecated
Since Symphony 2.5.0 this method is not called anymore in the core. Please use Field::findRelatedEntries
and Field::findParentRelatedEntries
instead. This method will be removed in Symphony 3.0
array|string fetchAssociatedEntrySearchValue(
$data, $field_id, $parent_entry_id)
Accessor to the associated entry search value for this field
instance. This default implementation simply returns $data
Parameters
Returns
Defaults to returning $data
, but overriding implementation should return a string
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 findAllTags()
Deprecated
Will be removed in Symphony 3.0, use getToggleStates()
instead
void findDefaults(
$settings)
Allows a field to set default settings.
Parameters
array findParentRelatedEntries(
$field_id, $entry_id)
Find all the entries that contain the tags that have been referenced from this field own entry.
array findRelatedEntries(
$entry_id, $parent_field_id)
Find all the entries that reference this entry's tags.
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.
array getToggleStates()
Accessor to the toggle states. This default implementation returns an empty array.
Returns
the array of toggle states.
array|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.
boolean requiresSQLGrouping()
Test whether this field requires grouping. If this function returns true
SQL statements generated in the EntryManager
will include the DISTINCT
keyword
to only return a single row for an entry regardless of how many 'matches' it
might have. 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 table etc. 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