- Symphony 2.6.4
-
› assets
14 -
› boot
14 -
› core
23 -
› cryptography
4 -
› data-sources
6 -
› email-gateways
3 -
› events
3 -
› global
61 -
› interface
9 -
› toolkit
60 - Delegates92
- Deprecated26
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
public interface iDatasource
interface.datasource.php #12This interface describes the minimum a new Datasource type needs to provide to be able to be used by Symphony
Methods
static buildEditor(XMLElement $wrapper, $errors, $handle, $settings)
This function is invoked by the Datasource Editor and allows this Datasource to provide HTML so that it can be created or edited. It is expected that this function will also handle the display of error messages.
Parameters
See Also
XMLElement execute(
$param_pool)
This function is responsible for returning an XMLElement
so that the
FrontendPage
class can add to a page's XML. It is executed and passed
the current $param_pool
array.
Parameters
Returns
This Datasource should return an XMLElement
object.
static string getName()
Returns the human readable name of this Datasource type. This is displayed in the datasource selection options.
string getSource()
This function return the source of this datasource. It's an artefact
of old core objects and for the moment it should return the same
value as getClass
.
static string getTemplate()
Returns the absolute path to the template that this template will
use to save instances of this datasource in the DATASOURCES
folder.
static string prepare(
$fields, $parameters, $template)
Given the settings and any existing datasource parameters, return the contents of this datasource so that can be saved to the file system.
Parameters
Returns
The completed template, ready to be saved.
array settings()
This function returns all the settings of the current Datasource instance.
Returns
An associative array of settings for this datasource where the key is getClass
and the value is an associative array of settings, key being the setting name, value being, the value
static boolean validate(
$settings, $errors)
Given an array of settings, validate them, adding any errors
to the $errors
variable which is passed by reference. $errors
should be formatted as an associative array
Parameters
Returns
True if the datasource is valid, false otherwise. If false it is expected that $errors
are populated.