mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
b269badfbe
API CHANGE: Pass Object::create() calls to Injector::create(). API CHANGE: Add "RequestProcessor" injection point in Director, that Director will call preRequest() and postRequest() on.
84 lines
3.7 KiB
Markdown
84 lines
3.7 KiB
Markdown
# Director
|
|
|
|
## Introduction
|
|
|
|
`[api:Director]` is the first step in the "execution pipeline". It parses the URL, matching it to one of a number of patterns,
|
|
and determines the controller, action and any argument to be used. It then runs the controller, which will finally run
|
|
the viewer and/or perform processing steps.
|
|
|
|
## Best Practices
|
|
|
|
* Checking for an Ajax-Request: Use Director::is_ajax() instead of checking for $_REQUEST['ajax'].
|
|
|
|
## Redirection
|
|
|
|
The `[api:Director]` class has a number of methods to facilitate 301 and 302 HTTP redirection.
|
|
|
|
* **Director::redirect("action-name")**: If there's no slash in the URL passed to redirect, then it is assumed that you
|
|
want to go to a different action on the current controller.
|
|
* **Director::redirect("relative/url")**: If there is a slash in the URL, it's taken to be a normal URL. Relative URLs
|
|
will are assumed to be relative to the site-root; so Director::redirect("home/") will work no matter what the current
|
|
URL is.
|
|
* **Director::redirect("http://www.absoluteurl.com")**: Of course, you can pass redirect() absolute URL s too.
|
|
* **Director::redirectPerm("any-url")**: redirectPerm takes the same arguments as redirect, but it will send a 301
|
|
(permanent) instead of a 302 (temporary) header. It improves search rankings, so this should be used whenever the
|
|
following two conditions are true:
|
|
* Nothing happens server-side prior to the redirection
|
|
* The redirection will always occur
|
|
* **Director::redirectBack()**: This will return you to the previous page. There's no permanent version of
|
|
redirectBack().
|
|
|
|
|
|
## Request processing
|
|
|
|
The `[api:Director]` is the entry point in Silverstring Framework for processing a request. You can read through
|
|
the execution steps in `[api:Director]``::direct()`, but in short
|
|
|
|
* File uploads are first analysed to remove potentially harmful uploads (this will likely change!)
|
|
* The `[api:SS_HTTPRequest]` object is created
|
|
* The session object is created
|
|
* The `[api:Injector]` is first referenced, and asks the registered `[api:RequestProcessor]` to pre-process
|
|
the request object. This allows for analysis of the current request, and allow filtering of parameters
|
|
etc before any of the core of the application executes
|
|
* The request is handled and response checked
|
|
* The `[api:RequestProcessor]` is called to post-process the request to allow further filtering before
|
|
content is sent to the end user.
|
|
* The response is output
|
|
|
|
The framework provides the ability to hook into the request both before and after it is handled to allow
|
|
developers to bind in their own custom pre- or post- request logic; see the `[api:RequestFilter]` to see how
|
|
this can be used to authenticate the request before the request is handled.
|
|
|
|
## Custom Rewrite Rules
|
|
|
|
You can influence the way URLs are resolved one of 2 ways
|
|
|
|
1. Adding rules to `[api:Director]` in `<yourproject>/_config.php` (See Default Rewrite Rules below for examples)
|
|
2. Adding rules in your extended `[api:Controller]` class via the *$url_handlers* static variable
|
|
|
|
See [controller](/topics/controller) for examples and explanations on how the rules get processed for both 1 and 2 above.
|
|
|
|
* Static redirect for specific URL
|
|
|
|
:::php
|
|
Director::addRules(100, array(
|
|
'myPermanentRedirect' => 'redirect:http://www.mysite.com'
|
|
));
|
|
|
|
|
|
## Default Rewrite Rules
|
|
|
|
SilverStripe comes with certain rewrite rules (e.g. for *admin/assets*).
|
|
|
|
* [framework/_config.php](https://github.com/silverstripe/sapphire/blob/master/_config.php)
|
|
* [cms/_config.php](https://github.com/silverstripe/silverstripe-cms/blob/master/_config.php)
|
|
|
|
|
|
## Links
|
|
|
|
* See `[api:ModelAsController]` class for details on controller/model-coupling
|
|
* See [execution-pipeline](/reference/execution-pipeline) for custom routing
|
|
|
|
## API Documentation
|
|
`[api:Director]`
|