class JSTestRunner extends Controller

Controller that executes QUnit tests via jQuery.

Finds all htm/html files located in /javascript/tests and includes them as iFrames.

To create your own tests, please use this template: jQuery - Validation Test Suite

jQuery Validation Plugin Test Suite

    Properties

    string $class from SS_Object

    Methods

    static Config_ForClass|null
    config()

    Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

    from SS_Object
    static SS_Object
    create()

    An implementation of the factory method, allows you to create an instance of a class

    from SS_Object
    static SS_Object
    singleton()

    Creates a class instance by the "singleton" design pattern.

    from SS_Object
    static 
    create_from_string($classSpec, $firstArg = null)

    Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

    from SS_Object
    static 
    parse_class_spec($classSpec)

    Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

    from SS_Object
    static SS_Object
    strong_create()

    Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}

    from SS_Object
    static 
    useCustomClass(string $oldClass, string $newClass, bool $strong = false)

    This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}

    from SS_Object
    static string
    getCustomClass(string $class)

    If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

    from SS_Object
    static any
    static_lookup($class, $name, null $default = null)

    Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

    from SS_Object
    static 
    get_static($class, $name, $uncached = false) deprecated

    No description

    from SS_Object
    static 
    set_static($class, $name, $value) deprecated

    No description

    from SS_Object
    static 
    uninherited_static($class, $name, $uncached = false) deprecated

    No description

    from SS_Object
    static 
    combined_static($class, $name, $ceiling = false) deprecated

    No description

    from SS_Object
    static 
    addStaticVars($class, $properties, $replace = false) deprecated

    No description

    from SS_Object
    static 
    add_static_var($class, $name, $value, $replace = false) deprecated

    No description

    from SS_Object
    static 
    has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

    Return TRUE if a class has a specified extension.

    from SS_Object
    static 
    add_extension(string $classOrExtension, string $extension = null)

    Add an extension to a specific class.

    from SS_Object
    static 
    remove_extension(string $extension)

    Remove an extension from a class.

    from SS_Object
    static array
    get_extensions(string $class, bool $includeArgumentString = false)

    No description

    from SS_Object
    static 
    get_extra_config_sources($class = null)

    No description

    from SS_Object
    __construct()

    No description

    mixed
    __call(string $method, array $arguments)

    Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

    from SS_Object
    bool
    hasMethod(string $method)

    Return TRUE if a method exists on this object

    from SS_Object
    array
    allMethodNames(bool $custom = false)

    Return the names of all the methods available on this object

    from SS_Object
    stat($name, $uncached = false)

    No description

    from SS_Object
    set_stat($name, $value)

    No description

    from SS_Object
    uninherited($name)

    No description

    from SS_Object
    bool
    exists()

    Return true if this object "exists" i.e. has a sensible value

    from SS_Object
    string
    parentClass()

    No description

    from SS_Object
    bool
    is_a(string $class)

    Check if this class is an instance of a specific class, or has that class as one of its parents

    from SS_Object
    string
    __toString()

    No description

    from SS_Object
    mixed
    invokeWithExtensions(string $method, mixed $argument = null)

    Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

    from SS_Object
    array
    extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

    Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

    from SS_Object
    getExtensionInstance(string $extension)

    Get an extension instance attached to this object by name.

    from SS_Object
    bool
    hasExtension(string $extension)

    Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

    from SS_Object
    array
    getExtensionInstances()

    Get all extension instances for this specific object instance.

    from SS_Object
    mixed
    cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

    Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

    from SS_Object
    clearCache($method, $ID = false, $arguments = array())

    Clears the cache for the given cacheToFile call

    from SS_Object
    static string
    castingObjectCreator(string $fieldSchema)

    Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

    static array
    castingObjectCreatorPair(string $fieldSchema)

    Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.

    bool
    __isset(string $property)

    Check if a field exists on this object or its failover.

    mixed
    __get(string $property)

    Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.

    __set(string $property, mixed $value)

    Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.

    setFailover(ViewableData $failover)

    Set a failover object to attempt to get data from if it is not present on this object.

    getFailover()

    Get the current failover object if set

    bool
    hasField(string $field)

    Check if a field exists on this object. This should be overloaded in child classes.

    mixed
    getField(string $field)

    Get the value of a field on this object. This should be overloaded in child classes.

    setField(string $field, mixed $value)

    Set a field on this object. This should be overloaded in child classes.

    defineMethods()

    Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

    unknown
    deprecatedCachedCall($method, $args = null, $identifier = null)

    Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

    customise(array|ViewableData $data)

    Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.

    getCustomisedObj()

    No description

    setCustomisedObj(ViewableData $object)

    No description

    array
    castingHelperPair(string $field)

    Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).

    string
    castingHelper(string $field)

    Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.

    string
    castingClass(string $field)

    Get the class name a field on this object will be casted to

    string
    escapeTypeForField(string $field)

    Return the string-format type for the given field.

    buildCastingCache(reference $cache)

    Save the casting cache for this object (including data from any failovers) into a variable

    renderWith(string|array|SSViewer $template, array $customFields = null)

    Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance

    obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

    Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

    cachedCall(string $field, array $arguments = null, string $identifier = null)

    A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

    bool
    hasValue(string $field, array $arguments = null, bool $cache = true)

    Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

    XML_val($field, $arguments = null, $cache = false)

    Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.

    RAW_val($field, $arguments = null, $cache = true)

    Return the value of the field without any escaping being applied.

    SQL_val($field, $arguments = null, $cache = true)

    Return the value of a field in an SQL-safe format.

    JS_val($field, $arguments = null, $cache = true)

    Return the value of a field in a JavaScript-save format.

    ATT_val($field, $arguments = null, $cache = true)

    Return the value of a field escaped suitable to be inserted into an XML node attribute.

    array
    getXMLValues($fields)

    Get an array of XML-escaped values by field name

    getIterator()

    Return a single-item iterator so you can iterate over the fields of a single record.

    Me()

    When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

    string
    ThemeDir(string $subtheme = false)

    Return the directory if the current active theme (relative to the site root).

    string
    CSSClasses(string $stopAtClass = 'ViewableData')

    Get part of the current classes ancestry to be used as a CSS class.

    Debug()

    Return debug information about this object that can be rendered into a template

    setDataModel($model)

    Set the DataModel for this request.

    handleRequest(SS_HTTPRequest $request, DataModel $model)

    Executes this controller, and return an {@link SS_HTTPResponse} object with the result.

    array|null
    allowedActions(String $limitToClass = null)

    Get a array of allowed actions defined on this controller, any parent classes or extensions.

    bool
    hasAction(string $action)

    Checks if this request handler has a specific action, even if the current user cannot access it.

    checkAccessAction($action)

    Check that the given action is allowed to be called from a URL.

    httpError(int $errorCode, string $errorMessage = null)

    Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

    getRequest()

    Returns the SS_HTTPRequest object that this controller is using.

    setRequest(SS_HTTPRequest $request)

    Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.

    string
    Link()

    Returns a link to this controller. Overload with your own Link rules if they exist.

    init()

    Initialisation function that is run before any action on the controller is called.

    setURLParams($urlParams)

    No description

    array
    getURLParams()

    No description

    getResponse()

    Returns the SS_HTTPResponse object that this controller is building up.

    setResponse(SS_HTTPResponse $response)

    Sets the SS_HTTPResponse object that this controller is building up.

    getFormOwner()

    Return the object that is going to own a form that's being processed, and handle its execution.

    defaultAction($action)

    This is the default action handler used if a method doesn't exist.

    getAction()

    Returns the action that is being executed on this controller.

    getViewer($action)

    Return an SSViewer object to process the data

    String
    removeAction($fullURL, $action = null)

    Removes all the "action" part of the current URL and returns the result.

    bool
    hasActionTemplate(string $action)

    Returns TRUE if this controller has a template that is specifically designed to handle a specific action.

    string
    render(array $params = null)

    Render the current controller with the templates determined by {@link getViewer()}.

    disableBasicAuth()

    Call this to disable site-wide basic authentication for a specific contoller.

    static Controller
    curr()

    Returns the current controller

    static boolean
    has_curr()

    Tests whether we have a currently active controller or not

    boolean
    can(perm $perm, member $member = null)

    Returns true if the member is allowed to do the given action.

    pushCurrent()

    Pushes this controller onto the stack of current controllers.

    popCurrent()

    Pop this controller off the top of the stack.

    redirect($url, $code = 302)

    Redirect to the given URL.

    redirectBack()

    Redirect back. Uses either the HTTP_REFERER or a manually set request-variable called "BackURL".

    string
    redirectedTo()

    Tests whether a redirection has been requested.

    getSession()

    Get the Session object representing this Controller's session

    setSession(Session $session)

    Set the Session object.

    static String
    join_links()

    Joins two or more link segments together, putting a slash between them if necessary.

    static array
    get_template_global_variables()

    Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template

    static 
    set_reporter(string $reporter)

    Override the default reporter with a custom configured subclass.

    all()

    Run all test classes

    browse()

    Browse all enabled test cases in the environment

    only($request)

    Run only a single test class

    runTests($tests)

    No description

    setUp()

    No description

    tearDown()

    No description

    Details

    in SS_Object at line 60
    static Config_ForClass|null config()

    Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

    ....).

    Return Value

    Config_ForClass|null

    in SS_Object at line 132
    static SS_Object create()

    An implementation of the factory method, allows you to create an instance of a class

    This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}

    This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

    Return Value

    SS_Object

    in SS_Object at line 155
    static SS_Object singleton()

    Creates a class instance by the "singleton" design pattern.

    It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

    Return Value

    SS_Object The singleton instance

    in SS_Object at line 190
    static create_from_string($classSpec, $firstArg = null)

    Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

    Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

    Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

    It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

    If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

    Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

    Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

    Parameters

    $classSpec
    $firstArg

    in SS_Object at line 215
    static parse_class_spec($classSpec)

    Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

    Returns a 2-elemnent array, with classname and arguments

    Parameters

    $classSpec

    in SS_Object at line 341
    static SS_Object strong_create()

    Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}

    Return Value

    SS_Object

    in SS_Object at line 361
    static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

    This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}

    Parameters

    string $oldClass the class to replace
    string $newClass the class to replace it with
    bool $strong allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

    in SS_Object at line 375
    static string getCustomClass(string $class)

    If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

    Parameters

    string $class the class to check

    Return Value

    string the class that would be created if you called {@link Object::create()} with the class

    in SS_Object at line 396
    static any static_lookup($class, $name, null $default = null)

    Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

    Parameters

    $class
    • The class to get the static from
    $name
    • The property to get from the class
    null $default
    • The value to return if property doesn't exist on class

    Return Value

    any
    • The value of the static property $name on class $class, or $default if that property is not defined

    in SS_Object at line 436
    static get_static($class, $name, $uncached = false) deprecated

    deprecated

    Parameters

    $class
    $name
    $uncached

    in SS_Object at line 444
    static set_static($class, $name, $value) deprecated

    deprecated

    Parameters

    $class
    $name
    $value

    in SS_Object at line 452
    static uninherited_static($class, $name, $uncached = false) deprecated

    deprecated

    Parameters

    $class
    $name
    $uncached

    in SS_Object at line 460
    static combined_static($class, $name, $ceiling = false) deprecated

    deprecated

    Parameters

    $class
    $name
    $ceiling

    in SS_Object at line 470
    static addStaticVars($class, $properties, $replace = false) deprecated

    deprecated

    Parameters

    $class
    $properties
    $replace

    in SS_Object at line 478
    static add_static_var($class, $name, $value, $replace = false) deprecated

    deprecated

    Parameters

    $class
    $name
    $value
    $replace

    in SS_Object at line 494
    static has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

    Return TRUE if a class has a specified extension.

    This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

    Parameters

    string $classOrExtension if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test
    string $requiredExtension used only if 2 arguments supplied
    boolean $strict if the extension has to match the required extension and not be a subclass

    in SS_Object at line 536
    static add_extension(string $classOrExtension, string $extension = null)

    Add an extension to a specific class.

    The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

    As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

    Parameters

    string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
    string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

    See also

    http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

    in SS_Object at line 594
    static remove_extension(string $extension)

    Remove an extension from a class.

    Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

    Parameters

    string $extension Classname of an {@link Extension} subclass, without parameters

    in SS_Object at line 633
    static array get_extensions(string $class, bool $includeArgumentString = false)

    Parameters

    string $class
    bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

    Return Value

    array Numeric array of either {@link DataExtension} classnames, or eval'ed classname strings with constructor arguments.

    in SS_Object at line 655
    static get_extra_config_sources($class = null)

    Parameters

    $class

    in RequestHandler at line 118
    __construct()

    in SS_Object at line 725
    mixed __call(string $method, array $arguments)

    Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

    You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

    Parameters

    string $method
    array $arguments

    Return Value

    mixed

    in SS_Object at line 792
    bool hasMethod(string $method)

    Return TRUE if a method exists on this object

    This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

    Parameters

    string $method

    Return Value

    bool

    in SS_Object at line 802
    array allMethodNames(bool $custom = false)

    Return the names of all the methods available on this object

    Parameters

    bool $custom include methods added dynamically at runtime

    Return Value

    array

    in SS_Object at line 963
    stat($name, $uncached = false)

    Parameters

    $name
    $uncached

    See also

    SS_Object::get_static()

    in SS_Object at line 970
    set_stat($name, $value)

    Parameters

    $name
    $value

    See also

    SS_Object::set_static()

    in SS_Object at line 977
    uninherited($name)

    Parameters

    $name

    See also

    SS_Object::uninherited_static()

    in SS_Object at line 991
    bool exists()

    Return true if this object "exists" i.e. has a sensible value

    This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database

    Return Value

    bool

    in SS_Object at line 998
    string parentClass()

    Return Value

    string this classes parent class

    in SS_Object at line 1008
    bool is_a(string $class)

    Check if this class is an instance of a specific class, or has that class as one of its parents

    Parameters

    string $class

    Return Value

    bool

    in SS_Object at line 1015
    string __toString()

    Return Value

    string the class name

    in SS_Object at line 1030
    mixed invokeWithExtensions(string $method, mixed $argument = null)

    Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

    Parameters

    string $method the method name to call
    mixed $argument a single argument to pass

    Return Value

    mixed

    in SS_Object at line 1058
    array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

    Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

    Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

    The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

    Parameters

    string $method the name of the method to call on each extension
    mixed $a1
    mixed $a2
    mixed $a3
    mixed $a4
    mixed $a5
    mixed $a6
    mixed $a7

    Return Value

    array

    in SS_Object at line 1097
    Extension getExtensionInstance(string $extension)

    Get an extension instance attached to this object by name.

    Parameters

    string $extension

    Return Value

    Extension

    in SS_Object at line 1115
    bool hasExtension(string $extension)

    Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

    Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

    Parameters

    string $extension Classname of an {@link Extension} subclass without parameters

    Return Value

    bool

    in SS_Object at line 1126
    array getExtensionInstances()

    Get all extension instances for this specific object instance.

    See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

    Return Value

    array Map of {@link DataExtension} instances, keyed by classname.

    in SS_Object at line 1142
    mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

    Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

    Parameters

    string $method the method name to cache
    int $lifetime the cache lifetime in seconds
    string $ID custom cache ID to use
    array $arguments an optional array of arguments

    Return Value

    mixed the cached data

    in SS_Object at line 1171
    clearCache($method, $ID = false, $arguments = array())

    Clears the cache for the given cacheToFile call

    Parameters

    $method
    $ID
    $arguments

    in ViewableData at line 72
    static string castingObjectCreator(string $fieldSchema)

    Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

    Parameters

    string $fieldSchema The field spec

    Return Value

    string

    in ViewableData at line 83
    static array castingObjectCreatorPair(string $fieldSchema)

    Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See {@link castingObjectCreator} for more information about the constructor.

    Parameters

    string $fieldSchema

    Return Value

    array

    in ViewableData at line 95
    bool __isset(string $property)

    Check if a field exists on this object or its failover.

    Parameters

    string $property

    Return Value

    bool

    in ViewableData at line 117
    mixed __get(string $property)

    Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.

    Parameters

    string $property

    Return Value

    mixed

    in ViewableData at line 138
    __set(string $property, mixed $value)

    Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.

    Parameters

    string $property
    mixed $value

    in ViewableData at line 151
    setFailover(ViewableData $failover)

    Set a failover object to attempt to get data from if it is not present on this object.

    Parameters

    ViewableData $failover

    in ViewableData at line 166
    ViewableData|null getFailover()

    Get the current failover object if set

    Return Value

    ViewableData|null

    in ViewableData at line 176
    bool hasField(string $field)

    Check if a field exists on this object. This should be overloaded in child classes.

    Parameters

    string $field

    Return Value

    bool

    in ViewableData at line 186
    mixed getField(string $field)

    Get the value of a field on this object. This should be overloaded in child classes.

    Parameters

    string $field

    Return Value

    mixed

    in ViewableData at line 196
    setField(string $field, mixed $value)

    Set a field on this object. This should be overloaded in child classes.

    Parameters

    string $field
    mixed $value

    in ViewableData at line 206
    defineMethods()

    Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.

    in ViewableData at line 236
    unknown deprecatedCachedCall($method, $args = null, $identifier = null)

    Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

    Parameters

    $method
    $args
    $identifier

    Return Value

    unknown

    in ViewableData at line 255
    ViewableData_Customised customise(array|ViewableData $data)

    Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.

    Note that any fields you specify will take precedence over the fields on this object.

    Parameters

    array|ViewableData $data

    Return Value

    ViewableData_Customised

    in ViewableData at line 272
    ViewableData getCustomisedObj()

    Return Value

    ViewableData

    in ViewableData at line 279
    setCustomisedObj(ViewableData $object)

    Parameters

    ViewableData $object

    in ViewableData at line 296
    array castingHelperPair(string $field)

    Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see {@link ViewableData::castingHelper()} for information on casting helpers).

    The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

    Parameters

    string $field

    Return Value

    array

    in ViewableData at line 308
    string castingHelper(string $field)

    Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.

    Parameters

    string $field

    Return Value

    string

    in ViewableData at line 331
    string castingClass(string $field)

    Get the class name a field on this object will be casted to

    Parameters

    string $field

    Return Value

    string

    in ViewableData at line 346
    string escapeTypeForField(string $field)

    Return the string-format type for the given field.

    Parameters

    string $field

    Return Value

    string 'xml'|'raw'

    in ViewableData at line 357
    buildCastingCache(reference $cache)

    Save the casting cache for this object (including data from any failovers) into a variable

    Parameters

    reference $cache

    in ViewableData at line 394
    HTMLText renderWith(string|array|SSViewer $template, array $customFields = null)

    Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance

    Parameters

    string|array|SSViewer $template the template to render into
    array $customFields fields to customise() the object with before rendering

    Return Value

    HTMLText

    in ViewableData at line 456
    obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

    Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

    Parameters

    string $fieldName
    array $arguments
    bool $forceReturnedObject if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information
    bool $cache Cache this object
    string $cacheName a custom cache name

    in ViewableData at line 503
    cachedCall(string $field, array $arguments = null, string $identifier = null)

    A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

    Parameters

    string $field
    array $arguments
    string $identifier an optional custom cache identifier

    in ViewableData at line 516
    bool hasValue(string $field, array $arguments = null, bool $cache = true)

    Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

    Parameters

    string $field
    array $arguments
    bool $cache

    Return Value

    bool

    in ViewableData at line 538
    XML_val($field, $arguments = null, $cache = false)

    Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.

    Parameters

    $field
    $arguments
    $cache

    in ViewableData at line 546
    RAW_val($field, $arguments = null, $cache = true)

    Return the value of the field without any escaping being applied.

    Parameters

    $field
    $arguments
    $cache

    in ViewableData at line 553
    SQL_val($field, $arguments = null, $cache = true)

    Return the value of a field in an SQL-safe format.

    Parameters

    $field
    $arguments
    $cache

    in ViewableData at line 560
    JS_val($field, $arguments = null, $cache = true)

    Return the value of a field in a JavaScript-save format.

    Parameters

    $field
    $arguments
    $cache

    in ViewableData at line 567
    ATT_val($field, $arguments = null, $cache = true)

    Return the value of a field escaped suitable to be inserted into an XML node attribute.

    Parameters

    $field
    $arguments
    $cache

    in ViewableData at line 579
    array getXMLValues($fields)

    Get an array of XML-escaped values by field name

    Parameters

    $fields

    Return Value

    array

    in ViewableData at line 599
    ArrayIterator getIterator()

    Return a single-item iterator so you can iterate over the fields of a single record.

    This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.

    Return Value

    ArrayIterator

    in ViewableData at line 611
    ViewableData Me()

    When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

    Return Value

    ViewableData

    in ViewableData at line 627
    string ThemeDir(string $subtheme = false)

    Return the directory if the current active theme (relative to the site root).

    This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. .

    This method should only be used when a theme is currently active. However, it will fall over to the current project directory.

    Parameters

    string $subtheme the subtheme path to get

    Return Value

    string

    in ViewableData at line 648
    string CSSClasses(string $stopAtClass = 'ViewableData')

    Get part of the current classes ancestry to be used as a CSS class.

    This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".

    Parameters

    string $stopAtClass the class to stop at (default: ViewableData)

    Return Value

    string

    in ViewableData at line 671
    ViewableData_Debugger Debug()

    Return debug information about this object that can be rendered into a template

    Return Value

    ViewableData_Debugger

    in RequestHandler at line 133
    setDataModel($model)

    Set the DataModel for this request.

    Parameters

    $model

    in Controller at line 123
    SS_HTTPResponse|RequestHandler|string|array handleRequest(SS_HTTPRequest $request, DataModel $model)

    Executes this controller, and return an {@link SS_HTTPResponse} object with the result.

    This method first does a few set-up activities: - Push this controller ont to the controller stack - see {@link Controller::curr()} for information about this. - Call {@link init()} - Defer to {@link RequestHandler->handleRequest()} to determine which action should be executed

    Note: $requestParams['executeForm'] support was removed, make the following change in your URLs: "/?executeForm=FooBar" -> "/FooBar" Also make sure "FooBar" is in the $allowed_actions of your controller class.

    Note: You should rarely need to overload run() - this kind of change is only really appropriate for things like nested controllers - {@link ModelAsController} and {@link RootURLController} are two examples here. If you want to make more orthodox functionality, it's better to overload {@link init()} or {@link index()}.

    Important: If you are going to overload handleRequest, make sure that you start the method with $this->pushCurrent() and end the method with $this->popCurrent(). Failure to do this will create weird session errors.

    Parameters

    SS_HTTPRequest $request
    DataModel $model

    Return Value

    SS_HTTPResponse|RequestHandler|string|array

    in RequestHandler at line 316
    array|null allowedActions(String $limitToClass = null)

    Get a array of allowed actions defined on this controller, any parent classes or extensions.

    Caution: Since 3.1, allowed_actions definitions only apply to methods on the controller they're defined on, so it is recommended to use the $class argument when invoking this method.

    Parameters

    String $limitToClass

    Return Value

    array|null

    in Controller at line 315
    bool hasAction(string $action)

    Checks if this request handler has a specific action, even if the current user cannot access it.

    Includes class ancestry and extensions in the checks.

    Parameters

    string $action

    Return Value

    bool

    in RequestHandler at line 413
    checkAccessAction($action)

    Check that the given action is allowed to be called from a URL.

    It will interrogate {@link self::$allowed_actions} to determine this.

    Parameters

    $action

    in RequestHandler at line 472
    httpError(int $errorCode, string $errorMessage = null)

    Throws a HTTP error response encased in a {@link SS_HTTPResponse_Exception}, which is later caught in {@link RequestHandler::handleAction()} and returned to the user.

    Parameters

    int $errorCode
    string $errorMessage Plaintext error message

    in RequestHandler at line 494
    SS_HTTPRequest|NullHTTPRequest getRequest()

    Returns the SS_HTTPRequest object that this controller is using.

    Returns a placeholder {@link NullHTTPRequest} object unless {@link handleAction()} or {@link handleRequest()} have been called, which adds a reference to an actual {@link SS_HTTPRequest} object.

    in RequestHandler at line 504
    setRequest(SS_HTTPRequest $request)

    Typically the request is set through {@link handleAction()} or {@link handleRequest()}, but in some based we want to set it manually.

    Parameters

    SS_HTTPRequest $request

    Returns a link to this controller. Overload with your own Link rules if they exist.

    Return Value

    string

    at line 68
    init()

    Initialisation function that is run before any action on the controller is called.

    in Controller at line 205
    setURLParams($urlParams)

    Parameters

    $urlParams

    in Controller at line 212
    array getURLParams()

    Return Value

    array The parameters extracted from the URL by the {@link Director}.

    in Controller at line 220
    getResponse()

    Returns the SS_HTTPResponse object that this controller is building up.

    Can be used to set the status code and headers

    in Controller at line 233
    Controller setResponse(SS_HTTPResponse $response)

    Sets the SS_HTTPResponse object that this controller is building up.

    Parameters

    SS_HTTPResponse $response

    Return Value

    Controller

    in Controller at line 244
    getFormOwner()

    Return the object that is going to own a form that's being processed, and handle its execution.

    Note that the result needn't be an actual controller object.

    in Controller at line 263
    defaultAction($action)

    This is the default action handler used if a method doesn't exist.

    It will process the controller object with the template returned by {@link getViewer()}

    Parameters

    $action

    in Controller at line 270
    getAction()

    Returns the action that is being executed on this controller.

    in Controller at line 278
    SSViewer getViewer($action)

    Return an SSViewer object to process the data

    Parameters

    $action

    Return Value

    SSViewer The viewer identified being the default handler for this Controller/Action combination

    in Controller at line 325
    String removeAction($fullURL, $action = null)

    Removes all the "action" part of the current URL and returns the result.

    If no action parameter is present, returns the full URL

    Parameters

    $fullURL
    $action

    Return Value

    String

    in Controller at line 359
    bool hasActionTemplate(string $action)

    Returns TRUE if this controller has a template that is specifically designed to handle a specific action.

    Parameters

    string $action

    Return Value

    bool

    in Controller at line 380
    string render(array $params = null)

    Render the current controller with the templates determined by {@link getViewer()}.

    Parameters

    array $params Key-value array for custom template variables (Optional)

    Return Value

    string Parsed template content

    in Controller at line 396
    disableBasicAuth()

    Call this to disable site-wide basic authentication for a specific contoller.

    This must be called before Controller::init(). That is, you must call it in your controller's init method before it calls parent::init().

    in Controller at line 404
    static Controller curr()

    Returns the current controller

    Return Value

    Controller

    in Controller at line 416
    static boolean has_curr()

    Tests whether we have a currently active controller or not

    Return Value

    boolean True if there is at least 1 controller in the stack.

    in Controller at line 427
    boolean can(perm $perm, member $member = null)

    Returns true if the member is allowed to do the given action.

    Parameters

    perm $perm The permission to be checked, such as 'View'.
    member $member The member whose permissions need checking. Defaults to the currently logged in user.

    Return Value

    boolean

    in Controller at line 447
    pushCurrent()

    Pushes this controller onto the stack of current controllers.

    This means that any redirection, session setting, or other things that rely on Controller::curr() will now write to this controller object.

    in Controller at line 462
    popCurrent()

    Pop this controller off the top of the stack.

    in Controller at line 476
    SS_HTTPResponse redirect($url, $code = 302)

    Redirect to the given URL.

    Parameters

    $url
    $code

    Return Value

    SS_HTTPResponse

    in Controller at line 500
    redirectBack()

    Redirect back. Uses either the HTTP_REFERER or a manually set request-variable called "BackURL".

    This variable is needed in scenarios where not HTTP-Referer is sent ( e.g when calling a page by location.href in IE). If none of the two variables is available, it will redirect to the base URL (see {@link Director::baseURL()}).

    in Controller at line 536
    string redirectedTo()

    Tests whether a redirection has been requested.

    Return Value

    string If redirect() has been called, it will return the URL redirected to. Otherwise, it will return null;

    in Controller at line 544
    Session getSession()

    Get the Session object representing this Controller's session

    Return Value

    Session

    in Controller at line 551
    setSession(Session $session)

    Set the Session object.

    Parameters

    Session $session

    Joins two or more link segments together, putting a slash between them if necessary.

    Use this for building the results of {@link Link()} methods. If either of the links have query strings, then they will be combined and put at the end of the resulting url.

    Caution: All parameters are expected to be URI-encoded already.

    Return Value

    String

    in Controller at line 597
    static array get_template_global_variables()

    Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template

    If the method to call is not included for a particular template variable, a method named the same as the template variable will be called

    If the casting class is not specified for a particular template variable, ViewableData::$default_cast is used

    The first letter of the template variable is case-insensitive. However the method name is always case sensitive.

    Return Value

    array Returns an array of items. Each key => value pair is one of three forms: - template name (no key) - template name => method name - template name => array(), where the array can contain these key => value pairs - "method" => method name - "casting" => casting class to use (i.e., Varchar, HTMLText, etc)

    at line 63
    static set_reporter(string $reporter)

    Override the default reporter with a custom configured subclass.

    Parameters

    string $reporter

    at line 86
    all()

    Run all test classes

    at line 93
    browse()

    Browse all enabled test cases in the environment

    at line 112
    only($request)

    Run only a single test class

    Parameters

    $request

    at line 128
    runTests($tests)

    Parameters

    $tests

    at line 146
    setUp()

    at line 149
    tearDown()