ErrorPage

class ErrorPage extends Page

ErrorPage holds the content for the page of an error response.

Renders the page on each publish action into a static HTML file within the assets directory, after the naming convention /assets/error-.html. This enables us to show errors even if PHP experiences a recoverable error. ErrorPages

Config options

static_filepath

Methods

boolean
canAddChildren($member = null)

No description

static SS_HTTPResponse
response_for(int $statusCode)

Get a {@link SS_HTTPResponse} to response to a HTTP error code if an {@link ErrorPage} for that code is present. First tries to serve it through the standard SilverStripe request method. Falls back to a static file generated when the user hit's save and publish in the CMS

requireDefaultRecords()

Ensures that there is always a 404 page by checking if there's an instance of ErrorPage with a 404 and 500 error code. If there is not, one is created when the DB is built.

FieldList
getCMSFields()

No description

bool
doPublish()

When an error page is published, create a static HTML page with its content, so the page can be shown even when SilverStripe is not functioning correctly before publishing this page normally.

mixed
writeStaticPage()

Write out the published version of the page to the filesystem

array
fieldLabels(boolean $includerelations = true)

No description

static string
get_filepath_for_errorcode(int $statusCode, string $locale = null)

Returns an absolute filesystem path to a static error file which is generated through {@link publish()}.

static 
set_static_filepath(string $path) deprecated

Set the path where static error files are saved through {@link publish()}.

static string
get_static_filepath() deprecated

No description

Details

at line 39
boolean canAddChildren($member = null)

Parameters

$member

Return Value

boolean

at line 53
static SS_HTTPResponse response_for(int $statusCode)

Get a {@link SS_HTTPResponse} to response to a HTTP error code if an {@link ErrorPage} for that code is present. First tries to serve it through the standard SilverStripe request method. Falls back to a static file generated when the user hit's save and publish in the CMS

Parameters

int $statusCode

Return Value

SS_HTTPResponse

at line 89
requireDefaultRecords()

Ensures that there is always a 404 page by checking if there's an instance of ErrorPage with a 404 and 500 error code. If there is not, one is created when the DB is built.

at line 194
FieldList getCMSFields()

Return Value

FieldList

at line 243
bool doPublish()

When an error page is published, create a static HTML page with its content, so the page can be shown even when SilverStripe is not functioning correctly before publishing this page normally.

Return Value

bool

at line 253
mixed writeStaticPage()

Write out the published version of the page to the filesystem

Return Value

mixed Either true, or an error

at line 286
array fieldLabels(boolean $includerelations = true)

Parameters

boolean $includerelations a boolean value to indicate if the labels returned include relation fields

Return Value

array

at line 302
static string get_filepath_for_errorcode(int $statusCode, string $locale = null)

Returns an absolute filesystem path to a static error file which is generated through {@link publish()}.

Parameters

int $statusCode A HTTP Statuscode, mostly 404 or 500
string $locale A locale, e.g. 'de_DE' (Optional)

Return Value

string

at line 321
static set_static_filepath(string $path) deprecated

deprecated 4.0 Use "ErrorPage.static_file_path" instead

Set the path where static error files are saved through {@link publish()}.

Defaults to /assets.

Parameters

string $path

at line 330
static string get_static_filepath() deprecated

deprecated 4.0 Use "ErrorPage.static_file_path" instead

Return Value

string