Class RedirectorPage
A redirector page redirects when the page is visited.
- Object
-
ViewableData
implements
IteratorAggregate
-
DataObject
implements
DataObjectInterface,
i18nEntityProvider
-
SiteTree
implements
PermissionProvider,
i18nEntityProvider
-
Page
-
RedirectorPage
Methods summary
public
|
#
ContentSource( )
Returns this page if the redirect is external, otherwise returns the target page. |
public
string
|
#
Link( )
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. |
public
|
#
regularLink( mixed $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
|
#
redirectionLink( )
Return the link that we should redirect to. Only return a value if there is a legal redirection destination. |
public
|
|
public
|
#
onBeforeWrite( )
Event handler called before writing to the database. You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though! |
public
|
|
public
|
Methods inherited from Page
AdminEmail(),
DevMode(),
FinalParent(),
Lang(),
Locale(),
MetaTags(),
NestedValue(),
allowComments(),
canAddChildren(),
canDelete(),
canDeleteFromLive(),
canEdit(),
canPublish(),
checkDevPermisson(),
hiddenCMSFields(),
hide_cms_fields(),
onAfterDelete(),
onAfterWrite(),
populateDefaults(),
set_hidden_cms_fields()
Methods inherited from SiteTree
AbsoluteLink(),
Breadcrumbs(),
CMSTreeClasses(),
Comments(),
DependentPages(),
DependentPagesCount(),
ElementName(),
InSection(),
Level(),
LinkOrCurrent(),
LinkOrSection(),
LinkingMode(),
NestedTitle(),
RelativeLink(),
TreeTitle(),
VirtualPages(),
allowedChildren(),
batch_permission_check(),
can(),
canCreate(),
canView(),
can_delete_multiple(),
can_edit_multiple(),
cmsCleanup_parentChanged(),
collateDescendants(),
defaultChild(),
defaultParent(),
disableCMSFieldsExtensions(),
disable_nested_urls(),
doDeleteFromLive(),
doPublish(),
doRestoreToStage(),
doRevertToLive(),
doRollbackTo(),
doUnpublish(),
duplicate(),
duplicateAsChild(),
duplicateWithChildren(),
enableCMSFieldsExtensions(),
enable_nested_urls(),
fieldLabels(),
generateURLSegment(),
generate_homepage_domain_map(),
getAbsoluteLiveLink(),
getCMSActions(),
getClassDropdown(),
getExistsOnLive(),
getIsAddedToStage(),
getIsDeletedFromStage(),
getIsModifiedOnStage(),
getMenuTitle(),
getParent(),
getParentType(),
getSiteConfig(),
get_by_link(),
get_enforce_strict_hierarchy(),
i18n_singular_name(),
isCurrent(),
isNew(),
isPublished(),
isSection(),
link_shortcode_handler(),
nested_urls(),
onBeforeDelete(),
page_type_classes(),
prepopuplate_permission_cache(),
provideI18nEntities(),
providePermissions(),
requireDefaultRecords(),
reset(),
rewriteFileURL(),
setMenuTitle(),
setParent(),
set_enforce_strict_hierarchy(),
validURLSegment()
Methods inherited from DataObject
Aggregate(),
RelationshipAggregate(),
__construct(),
baseTable(),
belongs_to(),
buildDataObjectSet(),
buildSQL(),
castedUpdate(),
composite_fields(),
context_obj(),
customDatabaseFields(),
custom_database_fields(),
data(),
databaseFields(),
databaseIndexes(),
database_extensions(),
database_fields(),
db(),
dbObject(),
debug(),
defaultSearchFilters(),
defineMethods(),
delete(),
delete_by_id(),
destroy(),
disable_subclass_access(),
enable_subclass_access(),
exists(),
extendedSQL(),
fieldLabel(),
flushCache(),
flush_and_destroy_cache(),
forceChange(),
get(),
getAllFields(),
getChangedFields(),
getClassAncestry(),
getComponent(),
getComponents(),
getComponentsQuery(),
getDefaultSearchContext(),
getField(),
getFrontEndFields(),
getManyManyComponents(),
getManyManyComponentsQuery(),
getManyManyFilter(),
getManyManyJoin(),
getRemoteJoinField(),
getReverseAssociation(),
getTitle(),
get_by_id(),
get_one(),
get_validation_enabled(),
hasDatabaseField(),
hasField(),
hasOwnTableDatabaseField(),
hasValue(),
has_many(),
has_one(),
has_own_table(),
i18n_plural_name(),
inheritedDatabaseFields(),
instance_get(),
instance_get_one(),
isChanged(),
isEmpty(),
isInDB(),
is_composite_field(),
many_many(),
many_many_extraFields(),
merge(),
newClassInstance(),
plural_name(),
relObject(),
requireTable(),
scaffoldFormFields(),
scaffoldSearchFields(),
searchableFields(),
setCastedField(),
setClassName(),
setComponent(),
setField(),
set_context_obj(),
set_validation_enabled(),
singular_name(),
summaryFields(),
toMap(),
update(),
validate(),
write(),
writeComponents(),
writeWithoutVersion()
Methods inherited from ViewableData
ATT_val(),
BaseHref(),
CSSClasses(),
ColumnBreak(),
ColumnCalc(),
ColumnNumber(),
ColumnPad(),
ColumnPos(),
CurrentMember(),
CurrentPage(),
Debug(),
Even(),
EvenOdd(),
First(),
FirstLast(),
HasPerm(),
IsAjax(),
JS_val(),
Last(),
Me(),
Middle(),
MiddleString(),
Modulus(),
MultipleOf(),
Odd(),
Pos(),
RAW_val(),
SQL_val(),
ThemeDir(),
ThemeName(),
Top(),
TotalItems(),
XML_val(),
__get(),
__isset(),
__set(),
buildCastingCache(),
cachedCall(),
castingClass(),
castingHelper(),
castingHelperPair(),
castingObjectCreator(),
castingObjectCreatorPair(),
customise(),
escapeTypeForField(),
getIterator(),
getSecurityID(),
getXMLValues(),
i18nLocale(),
iteratorProperties(),
obj(),
renderWith(),
setCustomisedObj()
Methods inherited from Object
__call(),
__toString(),
__wakeup(),
addMethodsFrom(),
addStaticVars(),
addWrapperMethod(),
add_extension(),
add_static_var(),
allMethodNames(),
cacheToFile(),
cacheToFileWithArgs(),
clearCache(),
combined_static(),
create(),
createMethod(),
create_from_string(),
extInstance(),
extend(),
getCustomClass(),
getExtensionInstance(),
getExtensionInstances(),
get_extensions(),
get_static(),
hasExtension(),
hasMethod(),
has_extension(),
invokeWithExtensions(),
is_a(),
loadCache(),
parentClass(),
parse_class_spec(),
remove_extension(),
sanitiseCachename(),
saveCache(),
set_stat(),
set_static(),
set_uninherited(),
stat(),
strong_create(),
uninherited(),
uninherited_static(),
useCustomClass()
Magic methods summary
Properties summary
public static
string|array
|
$icon |
#
Icon to use in the CMS |
public static
array
|
$db |
#
Database field definitions. This is a map from field names to field type. The field type should be a class that extends . |
public static
array
|
$defaults |
#
Inserts standard column-values when a DataObject is instanciated. Does not
insert default records |
public static
array
|
$has_one |
#
One-to-zero relationship defintion. This is a map of component name to data
type. In order to turn this into a true one-to-one relationship you can add a
|
public static
array
|
$many_many |
#
many-many relationship definitions. This is a map from component name to data type. |
Properties inherited from Page
$default_child,
$hidden_cms_fields,
$summary_fields
Properties inherited from SiteTree
$allowed_children,
$belongs_many_many,
$breadcrumbs_delimiter,
$cache_permissions,
$can_be_root,
$can_create,
$casting,
$default_parent,
$default_sort,
$extensions,
$has_many,
$hide_ancestor,
$indexes,
$many_many_extraFields,
$need_permission,
$searchable_fields,
$versioning,
$write_homepage_map
Properties inherited from DataObject
$allowed_actions,
$ancestry,
$api_access,
$belongs_to,
$brokenOnDelete,
$brokenOnWrite,
$cache_get_one,
$cache_has_own_table,
$cache_has_own_table_field,
$componentCache,
$components,
$create_table_options,
$default_records,
$destroyed,
$field_labels,
$original,
$plural_name,
$record,
$singular_name
Properties inherited from ViewableData
$customisedObject,
$default_cast,
$failover,
$iteratorPos,
$iteratorTotalItems