In order to transform a HTTP request or a commandline exeuction into a response, Silverstripe CMS needs to boot its core and run through several stages of processing.
The first step in most environments is a rewrite of a request path into parameters passed to a PHP script. This allows writing friendly URLs instead of linking directly to PHP files. The implementation depends on your web server; we'll show you the most common one here: Apache with mod_rewrite. Check our installation guides on how other web servers like IIS or nginx handle rewriting.
The standard Silverstripe CMS project ships with a
.htaccess file in your webroot for this purpose.
By default, requests will be passed through for files existing on the filesystem.
Some access control is in place to deny access to potentially sensitive files in the webroot, such as YAML configuration files.
If no file can be directly matched, control is handed off to
constants.php file is included automatically in any project which requires silverstripe/framework.
This is included automatically when the composer
vendor/autoload.php is included, and performs its
tasks silently in the background.
- Tries to locate an
.envconfiguration file in the project root.
- Sets constants based on the filesystem structure (e.g.
- Construct HTTPRequest object from environment.
- Construct a
- Construct a
- Add any necessary middleware to this application
- Pass the request to the application, and request a response
While you usually don't need to modify the bootstrap on this level, some deeper customizations like adding your own manifests or a performance-optimized routing might require it. An example of this can be found in the "staticpublisher" module.
Routing and request handling
index.php script relies on Director to work out which controller
should handle this request. It parses the URL, matching it to one of a number of patterns,
and determines the controller, action and any argument to be used (Routing).
- Creates a HTTPRequest object containing all request and environment information
- The session holds an abstraction of PHP session
- Instantiates a controller object
- The Injector is first referenced, and asks the registered RequestFilter to pre-process the request object (see below)
Controllerexecutes the actual business logic and populates an HTTPResponse
Controllercan optionally hand off control to further nested controllers
Controlleroptionally renders a response body through
- The RequestProcessor is called to post-process the request to allow further filtering before content is sent to the end user
- The response is output to the client
See App Object and Kernel for details.
Request preprocessing and postprocessing
The framework provides the ability to hook into the request both before and after it is handled to allow binding custom logic. This can be used to transform or filter request data, instantiate helpers, execute global logic, or even short-circuit execution (e.g. to enforce custom authentication schemes). The "Request Filters" documentation shows you how.
?flush=1 query parameter is added to a URL, a call to
flush() will be triggered
on any classes that implement the Flushable interface.
This enables developers to clear manifest caches,
for example when adding new templates or PHP classes.
Note that you need to be in dev mode
or logged-in as an administrator for flushing to take effect.