Deprecated in Symphony 2.3.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.

Classes

class.md5.php #14
::MD5

MD5 is a cryptography class for hashing and comparing messages using the MD5-Algorithm

class.sha1.php #14
::SHA1

SHA1 is a cryptography class for hashing and comparing messages using the SHA1-Algorithm

Fields

class.entry.php #34
Entry::$creationDate

An ISO 8601 representation of when this Entry was created eg. 2004-02-12T15:19:21+00:00

class.field.php #103
Field::$_fields

An associative array of the settings for this Field instance

class.page.php #100
Page::$_status

The HTTP status code of the page using the HTTP_STATUSES constants

Methods

class.administration.php #509
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.

class.administrationpage.php #1160
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.

class.datetimeobj.php #318
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.

class.emailhelper.php #272
EmailHelper::getMimeType

Gets mime type of a file.

For email attachments, the mime type is very important. Uses the PHP 5.3 function finfo_open when available, otherwise falls back to using a mapping of known of common mimetypes. If no matches are found application/octet-stream will be returned.

class.extension.php #119
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'

class.extensionmanager.php #768
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.

class.field.php #1248
Field::buildDSRetrivalSQL
class.field.php #1182
Field::createSectionAssociation

Create an association between a section and a field.

class.field.php #1195
Field::removeSectionAssociation

Permanently remove a section association for this field in the database.

class.fieldmanager.php #602
FieldManager::fetchTypes

Returns an array of all available field handles discovered in the TOOLKIT . /fields or EXTENSIONS . /{}/fields.

class.frontendpage.php #987
FrontendPage::fetchPageTypes

Given a page ID, return it's type from tbl_pages

class.frontendpage.php #1007
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

class.general.php #283
General::sendEmail

Allows you to send emails. It initializes the core email class.

class.section.php #228
Section::fetchFilterableFields

Returns an array of all the fields that can be filtered.

class.symphony.php #622
Symphony::customError

A wrapper for throwing a new Symphony Error page.

class.symphony.php #255
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__.

class.symphony.php #688
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.

class.symphony.php #722
Symphony::resolvePagePath

Given the $page_id, return the complete path to the current page.

class.symphony.php #705
Symphony::resolvePageTitle

Given the $page_id, return the complete title of the current page.

class.widget.php #708
Widget::wrapFormElementWithError

Will wrap a <div> around a desired element to trigger the default Symphony error styling.

Constants

class.datasource.php #444
::DS_FILTER_AND

A constant that represents if this filter is an AND filter in which an Entry must match all these filters

class.datasource.php #454
::DS_FILTER_OR

A constant that represents if this filter is an OR filter in which an entry can match any or all of these filters

Functions

func.utilities.php #123
::mysql_date_diff

This function, give two DateTime objects, will return the difference between the two in hours and minutes, in a format suitable for MySQL.

This function does not provide full date_diff functionality, it's a stopgap for PHP5.2 support.

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