- Symphony 2.7.9
-
› assets
14 -
› boot
15 -
› core
24 -
› cryptography
4 -
› data-sources
6 -
› email-gateways
3 -
› events
3 -
› global
62 -
› interface
9 -
› toolkit
60 - Delegates101
- Deprecated28
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
Deprecated in Symphony 2.7.9
References in the API marked as deprecated should not be used for new integrations. Existing implementations should seek to find alternative methods/functions where possible.
Classes
::AjaxPage
AjaxPage extends the Page class to provide an object representation of a Symphony backend AJAX page.
::DynamicXMLDatasource
The DynamicXMLDatasource
allows a user to retrieve XML from an URL.
This datasource supports namespaces, partial results using XPath and
caching the result for a number of minutes.
::MD5
MD5 is a cryptography class for hashing and comparing messages using the MD5-Algorithm
::SHA1
SHA1 is a cryptography class for hashing and comparing messages using the SHA1-Algorithm
Fields
Entry::$creationDate
An ISO 8601 representation of when this Entry was created
eg. 2004-02-12T15:19:21+00:00
Page::$_status
The HTTP status code of the page using the HTTP_STATUSES
constants
Methods
Cacheable::forceExpiry
Datasource::__determineFilterType
By default, all Symphony filters are considering to be OR and "+" filters are used for AND. They are all used and Entries must match each filter to be included. It is possible to use OR filtering in a field by using an "," to separate the values. eg. If the filter is "test1, test2", this will match any entries where this field is test1 OR test2. If the filter is "test1 + test2", this will match entries where this field is test1 AND test2. Not all fields supports this feature. This function is run on each filter (ie. each field) in a datasource.
Field::fetchAssociatedEntryIDs
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.
FieldTagList::fetchAssociatedEntryIDs
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.
FieldTagList::findAllTags
General::checkFile
Checks that the file and its folder are readable and writable.
Section::fetchAssociatedSections
Returns any section associations this section has with other sections
linked using fields. Has an optional parameter, $respect_visibility
that
will only return associations that are deemed visible by a field that
created the association. eg. An articles section may link to the authors
section, but the field that links these sections has hidden this association
so an Articles column will not appear on the Author's Publish Index
SectionManager::fetchAssociatedSections
Returns any section associations this section has with other sections
linked using fields. Has an optional parameter, $respect_visibility
that
will only return associations that are deemed visible by a field that
created the association. eg. An articles section may link to the authors
section, but the field that links these sections has hidden this association
so an Articles column will not appear on the Author's Publish Index
Symphony::initialiseCookie
Setter for $Cookie
. This will use PHP's parseurl
function on the current URL to set a cookie using the cookieprefix
defined in the Symphony configuration. The cookie will last two
weeks.
This function also defines two constants, __SYM_COOKIE_PATH__
and __SYM_COOKIE_PREFIX__
.
Constants
::EXTENSION_NOT_COMPATIBLE
Status when the extension is not compatible with the current version of Symphony
::EXTENSION_NOT_INSTALLED
Status when an extension is in the file system, but has not been installed.
::EXTENSION_REQUIRES_UPDATE
Status when an extension version in the file system is different to the version stored in the database for the extension
::__ENTRY_FIELD_ERROR__
The constant for an Entry if there is an error is raised by any of it's Fields.
::__ENTRY_OK__
The constant for when an Entry is ok, that is, no errors have been raised by any of it's Fields.