- Symphony 2.3.6
-
› assets
14 -
› boot
11 -
› content
24 -
› core
23 -
› cryptography
4 -
› email-gateways
3 -
› global
39 -
› interface
6 -
› toolkit
68 - Delegates94
- 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 FieldAuthor
public class FieldAuthor extends Field
field.author.php #17The Author field allows Symphony Authors to be selected in your entries. It is a read only field, new Authors cannot be added from the Frontend using events.
The Author field allows filtering by Author ID or Username. Sorting is done based on the Author's first name and last name.
Methods
void __construct()
Construct a new instance of this field.
boolean allowDatasourceOutputGrouping()
Test whether this field supports data-source output grouping. This default implementation prohibits grouping. Data-source grouping allows clients of this field to group the XML output according to this field. Subclasses should override this if grouping is supported.
Returns
true if this field does support data-source grouping, false otherwise.
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.
See Also
void buildSortingSQL(
$joins, $where, $sort, $order)
Build the SQL command to append to the default query to enable sorting of this field. By default this will sort the results by the entry id in ascending order.
Parameters
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 canToggle()
Test whether this field can be toggled using the With Selected menu on the Publish Index.
Returns
true if it can be toggled, false otherwise.
integer checkFields(
$errors, $checkForDuplicates)
Check the field's settings to ensure they are valid on the section editor
Parameters
Returns
returns the status of the checking. if errors has been populated with any errors self::__ERROR__
, 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
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|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
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.
void groupRecords(
$records)
Default implementation of record grouping. This default implementation
will throw an Exception
. Thus, clients must overload this method
for grouping to be successful.
Parameters
boolean isSortable()
Test whether this field can be sorted. This default implementation returns false.
Returns
true if this field is sortable, false otherwise.
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.
string prepareTableValue(XMLElement $link, $entry_id)
$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, $message, $simulate, $entry_id)
Process the raw field data.
Parameters
Returns
the processed field data.
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
Parameters
array toggleFieldData(
$data, $newState, $entry_id)
Toggle the field data. This default implementation always returns the input data.
Parameters
Returns
the toggled data.