- Symphony 2.5.2
-
› assets
14 -
› boot
13 -
› core
23 -
› cryptography
4 -
› data-sources
0 -
› email-gateways
3 -
› events
3 -
› global
44 -
› interface
8 -
› toolkit
71 - Delegates91
- Deprecated14
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 FieldUpload
public class FieldUpload extends Field
field.upload.php #13A simple Upload field that essentially maps to HTML's <input type='file '/>
.
Methods
void __construct()
Construct a new instance of this field.
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
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 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 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.
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 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)
Ensure the file exists in the WORKSPACE
directory
Parameters
See Also
boolean entryDataCleanup(
$entry_id, $data)
Remove the entry data of this field from the database.
Parameters
Returns
Returns true after the cleanup has been completed
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 getFilePath(
$filename)
void getImportModes()
static void getMetaInfo(
$file, $type)
boolean isSortable()
Test whether this field can be sorted. This default implementation returns false.
Returns
true if this field is sortable, false otherwise.
XMLElement prepareAssociationsDrawerXMLElement(Entry $e, $parent_association, $prepopulate)
Format this field value for display in the Associations Drawer publish index.
By default, Symphony will use the return value of the prepareReadableValue
function.
Parameters
Returns
The XMLElement must be a li node, since it will be added an ul node.
array|string|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 prepareTableValue(XMLElement $link, $entry_id)
$data,
Format this field value for display in the publish index tables.
Since Symphony 2.5.0, this function will call Field::prepareReadableValue
in order to get the field's human readable value.
Parameters
Returns
the formatted string summary of the values of this field instance.
void prepareTextValue(
$data, $entry_id)
array processRawFieldData(
$data, $status, $message, $simulate, $entry_id)
For information about PHPs upload error constants see:
Parameters
Returns
the processed field data.