Skip to content

Commit

Permalink
DOC Document changes to when Flushable gets flushed (#607)
Browse files Browse the repository at this point in the history
  • Loading branch information
GuySartorelli authored Oct 25, 2024
1 parent f9a94c7 commit 436c4c9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Many of them are in the [`SilverStripe\Control\Middleware`](api:SilverStripe\Con
| [`ConfirmationMiddleware`](api:SilverStripe\Control\Middleware\ConfirmationMiddleware) | Checks whether user manual confirmation is required for HTTPRequest |
| [`DevelopmentAdminConfirmationMiddleware`](api:SilverStripe\Control\Middleware\DevelopmentAdminConfirmationMiddleware) | A specific subclass of `ConfirmationMiddleware` which handles the `/dev/*` routes. |
| [`ExecMetricMiddleware`](api:SilverStripe\Control\Middleware\ExecMetricMiddleware) | Display execution metrics in DEV mode |
| [`FlushMiddleware`](api:SilverStripe\Control\Middleware\FlushMiddleware) | Triggers a call to flush() on all [Flushable](api:SilverStripe\Core\Flushable) implementors |
| [`HTTPCacheControlMiddleware`](api:SilverStripe\Control\Middleware\HTTPCacheControlMiddleware) | Controls HTTP response cache headers |
| [`PasswordExpirationMiddleware`](api:SilverStripe\Security\PasswordExpirationMiddleware) | Check if authenticated user has password expired |
| [`RateLimitMiddleware`](api:SilverStripe\Control\Middleware\RateLimitMiddleware) | Access throttling, controls HTTP Retry-After header |
Expand Down
9 changes: 4 additions & 5 deletions en/02_Developer_Guides/16_Execution_Pipeline/01_Flushable.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ summary: Allows a class to define it's own flush functionality.

## Introduction

Allows a class to define it's own flush functionality, which is triggered when `flush=1` is requested in the URL.
[FlushMiddleware](api:SilverStripe\Control\Middleware\FlushMiddleware) is run before a request is made, calling `flush()` statically on all
implementors of [Flushable](api:SilverStripe\Core\Flushable).
Allows a class to define it's own flush functionality, which is triggered when flushing the kernel by calling `flush()` statically on all
implementors of [`Flushable`](api:SilverStripe\Core\Flushable).

> [!WARNING]
> Flushable implementers might also be triggered automatically on deploy if you have `SS_FLUSH_ON_DEPLOY` [environment
> variable](../configuration/environment_variables) defined. In that case even if you don't manually pass `flush=1` parameter, the first request after deploy
> will still be calling `Flushable::flush` on those entities.
> variable](../configuration/environment_variables) defined. In that case even if you don't manually flush the kernel, the first request after deploy
> will still be calling `flush()` on those entities.
## Usage

Expand Down

0 comments on commit 436c4c9

Please sign in to comment.