- Symphony 2.3.4
-
› assets
14 -
› boot
11 -
› core
23 -
› cryptography
4 -
› email-gateways
3 -
› global
37 -
› interface
6 -
› toolkit
68 - Delegates94
- Deprecated29
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
Symphony Administration
public class Administration extends Symphony
class.administration.php #16The Administration class is an instance of Symphony that controls all backend pages. These pages are HTMLPages are usually generated using XMLElement before being rendered as HTML. These pages do not use XSLT. The Administration is only accessible by logged in Authors
Properties
HTMLPage $Page
The class representation of the current Symphony backend page,
which is a subclass of the HTMLPage
class. Symphony uses a convention
of prefixing backend page classes with 'content'. ie. 'contentBlueprintsSections'
Methods
string display(
$page)
Called by index.php, this function is responsible for rendering the current page on the Frontend. Two delegates are fired, AdminPagePreGenerate and AdminPagePostGenerate. This function runs the Profiler for the page build process.
Uses
Parameters
Returns
The HTML of the page to return
See Also
void errorPageNotFound(
$context, $output)
If a page is not found in the Symphony backend, this function should be called which will raise a customError to display the default Symphony page not found template
string getCurrentPageURL()
Returns the current Page path, excluding the domain and Symphony path.
Returns
The path of the current page, ie. '/blueprints/sections/'
array|boolean getPageCallback(
$page)
This function resolves the string of the page to the relevant backend page class. The path to the backend page is split on the slashes and the resulting pieces used to determine if the page is provided by an extension, is a section (index or entry creation) or finally a standard Symphony content page. If no page driver can be found, this function will return false.
Uses
Parameters
Returns
If successful, this function will return an associative array that at the very least will return the page's classname, pageroot, driver, driver_location and context, otherwise this will return false.
static Administration instance()
This function returns an instance of the Administration class. It is the only way to create a new Administration, as it implements the Singleton interface
boolean isLoggedIn()
Overrides the Symphony isLoggedIn function to allow Authors
to become logged into the backend when $_REQUEST['auth-token']
is present. This logs an Author in using the loginFromToken function.
A token may be 6 or 8 characters in length in the backend. A 6 or 16 character token
is used for forget password requests, whereas the 8 character token is used to login
an Author into the page
See Also
boolean 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.
Returns
True if the Configuration object was successfully written, false otherwise
See Also
Deprecated
This function is deprecated in Symphony 2.3 and will be removed in Symphony 2.4. Use Configuration->write()
instead.