Returns the Absolute URL of the site root.

• usedby: File::getURL()
• usedby: File::getAbsoluteURL()

Turns the given URL into an absolute URL.

• todo: Document how relativeToSiteBase works

• $url
• $relativeToSiteBase

Allows a module to register with the director to be run once

the controller is instantiated. The optional 'mode' parameter can be either 'site' or 'cms', as those are the two values currently set by controllers. The callback function will be run at the initialization of the relevant controller.

• $function $function: string PHP-function array based on http://php.net/call_user_func
• $mode $mode: string

Returns the root URL for the site.

It will be automatically calculated unless it is overridden with setBaseURL().

• usedby: Image::getURL()

Process the given URL, creating the appropriate controller and executing it.

Request processing is handled as folows:

• Director::direct() creates a new HTTPResponse object and passes this to Director::handleRequest().
• Director::handleRequest($request) checks each of the Director rules and identifies a controller to handle this request.
• Controller::handleRequest($request) is then called. This will find a rule to handle the URL, and call the rule handling method.
• RequestHandler::handleRequest($request) is recursively called whenever a rule handling method returns a RequestHandler object.

• uses: Director::handleRequest() - rule-lookup logic is handled by this.
• uses: Controller::run() - Controller::run() handles the page logic for a Director::direct() call.

• $url $url: String, the URL the user is visiting, without the querystring.

Force the site to run on SSL. To use, call from _config.php.

For example:

Given a filesystem reference relative to the site root, return the full file-system path.

• access: public

• string $file

• return: 'site' or 'cms'
• usedby: Translatable::choose_site_lang()

Handle an HTTP request, defined with a HTTPRequest object.

• access: protected
• usedby: Director::direct() - rule-lookup logic is handled by this.

• HTTPRequest $request
• Session $session

This function will return true if the site is in a development environment.

For information about environment types, see Director::set_environment_type().

This function will return true if the site is in a test environment.

For information about environment types, see Director::set_environment_type().

Checks if a given URL is absolute (e.g. starts with 'http://' etc.).

• access: public

• string $url

Returns true if this script is being run from the command line rather than the webserver.

• access: public

Checks if the given URL is belonging to this "site", as defined by makeRelative() and absoluteBaseUrl().

Useful to check before redirecting based on a URL from user submissions through $_GET or $_POST, and avoid phishing attacks by redirecting to an attackers server.

• access: public

• string $url

Turns an absolute URL or folder into one that's relative to the root of the site.

This is useful when turning a URL into a filesystem reference, or vice versa.

• return: Either a relative URL if the checks succeeded, or the original (possibly absolute) URL.
• todo: Implement checking across http/https protocols

• string $url: Accepts both a URL or a filesystem path

Redirect to another page.

• $url can be an absolute URL
• or it can be a URL relative to the "site base"
• if it is just a word without an slashes, then it redirects to another action on the current controller.

• $url
• $code

Tests whether a redirection has been requested.

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

Sets the root URL for the website.

If the site isn't accessible from the URL you provide, weird things will happen.

• $baseURL

Set the environment type of the current site.

Typically, a SilverStripe site have a number of environments:

• development environments, such a copy on your local machine.
• test sites, such as the one you show the client before going live.
• the live site itself.

To help with this, Sapphire support the notion of an environment type. The environment type can be dev, test, or live.

You can set it explicitly with Director::set_environment_tpye(). Or you can use Director::set_dev_servers() and Director::set_test_servers() to set it implicitly, based on the value of $_SERVER['HTTP_HOST']. If the HTTP_HOST value is one of the servers listed, then the environment type will be test or dev. Otherwise, the environment type will be live.

Dev mode can also be forced by putting ?isDev=1 in your URL, which will ask you to log in and then push the site into dev mode for the remainder of the session. Putting ?isDev=0 onto the URL can turn it back. Generally speaking, these methods will be called from your _config.php file.

Once the environment type is set, it can be checked with Director::isDev(), Director::isTest(), and Director::isLive().

• $et $et: string The environment type: dev, test, or live.

Sets the HTTP status code

• $code

Test a URL request, returning a response object.

This method is the counterpart of Director::direct() that is used in functional testing. It will execute the URL given,

• usedby: TestSession::post()
• usedby: TestSession::get()
• uses: Controller::run() - Controller::run() handles the page logic for a Director::direct() call.
• uses: getControllerForURL() - The rule-lookup logic is handled by this.

• string $url: The URL to visit
• array $postVars: The $_POST & $_FILES variables
• Session $session: The Session object representing the current session. By passing the same object to multiple calls of Director::test(), you can simulate a peristed session.
• string $httpMethod: The HTTP method, such as GET or POST. It will default to POST if postVars is set, GET otherwise. Overwritten by $postVars['_method'] if present.
• string $body: The HTTP body
• array $headers: HTTP headers with key-value pairs

Returns an array of urlParams