Field FieldTagList

public class FieldTagList extends Field

field.taglist.php #12

The 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, 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)

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
  • $data arraythe input data to check.

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

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

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 displayFilteringOptions(XMLElement $wrapper)

Inserts tags at the bottom of the filter panel

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
void|integer fetchAssociatedEntryCount(mixed $value)

Fetch the count of the associated entries given a $value.

Parameters
  • $value mixedthe value to find the associated entry count for, this usually comes from the fetchAssociatedEntrySearchValue function.

Returns

this default implementation returns void. overriding implementations should return an integer.

See Also
void|array fetchAssociatedEntryIDs(mixed $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
  • $value mixedthe value to find the associated entry ID's for.

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(array $data, integer $field_id, integer $parent_entry_id)

Accessor to the associated entry search value for this field instance. This default implementation simply returns $data

Parameters
  • $data arraythe data from which to construct the associated search entry value, this is usually Entry with the $parent_entry_id value's data.

  • $field_id integer(optional) the ID of the field that is the parent in the relationship

  • $parent_entry_id integer(optional) the ID of the entry from the parent section in the relationship

Returns

Defaults to returning $data, but overriding implementation should return a string

array fetchFilterableOperators()

Returns the keywords that this field supports for filtering. Note that no filter will do a simple 'straight' match on the value.

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 section
  • association for searching entries in associated sections
  • static for searching static values
  • date for searching in a calendar
  • parameters for searching in parameters

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

Allows a field to set default settings.

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

array findParentRelatedEntries(integer $field_id, integer $entry_id, integer $parent_field_id)

Find all the entries that contain the tags that have been referenced from this field own entry.

array findRelatedEntries(integer $entry_id, integer $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(array $data, integer $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
  • $data arrayThe data for this field from it's tbl_entry_data_{id} table

  • $entry_id integerThe optional id of this field entry instance

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(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)
string prepareTextValue(array $data, integer $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
  • $data arrayan associative array of data for this string. At minimum this requires a key of 'value'.

  • $entry_id integer(optional) An option entry ID for more intelligent processing. defaults to null

Returns

the complete text representation of the values of this field instance.

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.

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(mixed $field, mixed $value, string $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

Parameters
  • $setting stringthe setting key.

  • $value mixedthe value of the setting.

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