class RedirectorPage extends Page (View source)

A redirector page redirects when the page is visited.

Properties

string $RedirectionType

Either 'Internal','External' or 'File'

string $ExternalURL

URL to redirect to if $RedirectionType is 'External'

int $LinkToID

Methods

public
ContentSource()

Returns this page if the redirect is external, otherwise returns the target page or file.

public
string
Link(string $action = null)

Return the the link that should be used for this redirector page, in navigation, etc.

public
string
regularLink(string $action = null)

Return the normal link directly to this page. Once you visit this link, a 30x redirection will take you to your final destination.

public
string
redirectionLink()

Return the link that we should redirect to.

public
syncLinkTracking()

No description

protected
onBeforeWrite()

No description

public
getCMSFields()

No description

public
subPagesToCache()

No description

LinkTo()

Page to link to if $RedirectionType is 'Internal'

LinkToFile()

File to link to if $RedirectionType is 'File'

Details

SiteTree|File ContentSource()

Returns this page if the redirect is external, otherwise returns the target page or file.

Return Value

SiteTree|File

Return the the link that should be used for this redirector page, in navigation, etc.

If the redirectorpage has been appropriately configured, then it will return the redirection destination, to prevent unnecessary 30x redirections. However, if it's misconfigured, then it will return a link to itself, which will then display an error message.

Parameters

string $action

Return Value

string

Return the normal link directly to this page. Once you visit this link, a 30x redirection will take you to your final destination.

Parameters

string $action

Return Value

string

Return the link that we should redirect to.

Only return a value if there is a legal redirection destination.

Return Value

string

syncLinkTracking()

No description

protected onBeforeWrite()

No description

getCMSFields()

No description

subPagesToCache()

No description

SiteTree LinkTo()

Page to link to if $RedirectionType is 'Internal'

Return Value

SiteTree

File LinkToFile()

File to link to if $RedirectionType is 'File'

Return Value

File