- Symphony 2.3
-
› assets
8 -
› boot
9 -
› core
22 -
› email-gateways
3 -
› global
34 -
› interface
1 -
› toolkit
69 - Delegates89
- 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
Deprecated in Symphony 2.3
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.
Fields
Methods
Administration::saveConfig
Writes the current Symphony Configuration object to a file in the CONFIG directory. This will overwrite any existing configuration file every time this function is called.
AdministrationPage::__fetchAvailablePageTypes
Returns all the page types that exist in this Symphony install. There are 5 default system page types, and new types can be added by Developers via the Page Editor.
DateTimeObj::getTimeAgo
A wrapper for get, this function will return a HTML string representing
an <abbr>
element which contained the formatted date of now, and an
RFC 2822 formatted date (Thu, 21 Dec 2000 16:01:07 +0200) as the title
attribute. Symphony uses this in it's status messages so that it can
dynamically update how long ago the action took place using Javascript.
Extension::about
The about method allows an extension to provide
information about itself as an associative array. eg.
'name' => 'Name of Extension',
'version' => '1.8',
'release-date' => 'YYYY-MM-DD',
'author' => array(
'name' => 'Author Name',
'website' => 'Author Website',
'email' => 'Author Email'
),
'description' => 'A description about this extension'
ExtensionManager::about
This function will load an extension's meta information given the extension
$name
. Since Symphony 2.3, this function will look for an extension.meta.xml
file inside the extension's folder. If this is not found, it will initialise
the extension and invoke the about()
function. By default this extension will
return an associative array display the basic meta data about the given extension.
If the $rawXML
parameter is passed true, and the extension has a extension.meta.xml
file, this function will return DOMDocument
of the file.
Field::buildDSRetrivalSQL
Field::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
Field::createSectionAssociation
Create an association between a section and a field.
Field::removeSectionAssociation
Permanently remove a section association for this field in the database.
FieldManager::fetchTypes
Returns an array of all available field handles discovered in the
TOOLKIT . /fields
or EXTENSIONS . /{}/fields
.
FrontendPage::fetchPageTypes
Given a page ID, return it's type from tbl_pages
FrontendPage::resolvePageFileLocation
Resolves the path to this page's XSLT file. The Symphony convention
is that they are stored in the PAGES
folder. If this page has a parent
it will be as if all the / in the URL have been replaced with _. ie.
/articles/read/ will produce a file articles_read.xsl
General::sendEmail
Allows you to send emails. It initializes the core email class.
Section::fetchFilterableFields
Returns an array of all the fields that can be filtered.
Symphony::resolvePage
Given the $page_id
and a $column
, this function will return an
array of the given $column
for the Page, including all parents.
Symphony::resolvePagePath
Given the $page_id
, return the complete path to the
current page.
Symphony::resolvePageTitle
Given the $page_id
, return the complete title of the
current page.
Widget::wrapFormElementWithError
Will wrap a <div>
around a desired element to trigger the default
Symphony error styling.
fieldAuthor::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldCheckbox::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldDate::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldInput::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldSelect::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldTagList::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldTextarea::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.
fieldUpload::canImport
Test whether this field can be imported. This default implementation prohibits importing. Subclasses should override this is importing is supported.