Webylon 3.1 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
  • Download
Version: current
  • 3.2
  • 3.1

Packages

  • auth
  • Booking
  • cart
    • shipping
    • steppedcheckout
  • Catalog
  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • newsletter
    • publishers
    • reports
    • security
    • tasks
  • Dashboard
  • DataObjectManager
  • event
  • faq
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • googlesitemaps
  • guestbook
  • installer
  • newsletter
  • None
  • photo
    • gallery
  • PHP
  • polls
  • recaptcha
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets
  • seo
    • open
      • graph
  • sfDateTimePlugin
  • spamprotection
  • stealth
    • captha
  • subsites
  • userform
    • pagetypes
  • userforms
  • webylon
  • widgets

Classes

  • BaseObjectCategory
  • BookingAdminPage
  • BookingPage
  • ErrorPage
  • ErrorPage_Controller
  • MediawebPage
  • Notifications
  • Page
  • Room
  • RoomCatalog
  • SiteConfig
  • SiteTree
  • SubsitesSelectorPage
  • SubsitesVirtualPage
  • SubsitesVirtualPage_Controller
  • VideoBankPage
  • VirtualPage
  • VirtualPage_Controller
  • VirtualProduct_Controller

Interfaces

  • HiddenClass

Class ErrorPage

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-<statuscode>.html. This enables us to show errors even if PHP experiences a recoverable error. ErrorPages

Object
Extended by ViewableData implements IteratorAggregate
Extended by DataObject implements DataObjectInterface, i18nEntityProvider
Extended by SiteTree implements PermissionProvider, i18nEntityProvider
Extended by Page
Extended by ErrorPage
Package: cms
See: Debug::friendlyError()
Used by: Debug::friendlyError()
Located at sapphire/core/model/ErrorPage.php

Methods summary

public static SS_HTTPResponse
# response_for( integer $statusCode )

Get a SS_HTTPResponse to response to a HTTP error code if an ErrorPage for that code is present.

Get a SS_HTTPResponse to response to a HTTP error code if an ErrorPage for that code is present.

Parameters

$statusCode
int $statusCode

Returns

SS_HTTPResponse
SS_HTTPResponse

Used by

ContentController::httpError()
public
# requireDefaultRecords( )

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

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

Overrides

SiteTree::requireDefaultRecords
public FieldSet
# getCMSFields( )

Returns a FieldSet with which to create the CMS editing form.

Returns a FieldSet with which to create the CMS editing form.

You can override this in your child classes to add extra fields - first get the parent fields using parent::getCMSFields(), then use addFieldToTab() on the FieldSet.

Returns

FieldSet
The fields to be displayed in the CMS.

Overrides

Page::getCMSFields
public
# 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.

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.

Overrides

SiteTree::doPublish
public array|string
# fieldLabels( boolean $includerelations = true )

Parameters

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

Returns

array|string
Array of all element labels if no argument given, otherwise the label of the field

Overrides

SiteTree::fieldLabels
public static String
# get_filepath_for_errorcode( integer $statusCode, String $locale = null )

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

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

Parameters

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

Returns

String
String
public static
# set_static_filepath( string $path )

Set the path where static error files are saved through publish(). Defaults to /assets.

Set the path where static error files are saved through publish(). Defaults to /assets.

Parameters

$path
string $path
public static string
# get_static_filepath( )

Returns

string
string

Methods inherited from Page

AdminEmail(), DevMode(), FinalParent(), Lang(), Locale(), MetaTags(), NestedValue(), allowComments(), canAddChildren(), canDelete(), canDeleteFromLive(), canEdit(), canPublish(), checkDevPermisson(), hiddenCMSFields(), hide_cms_fields(), onAfterDelete(), onAfterWrite(), onBeforeWrite(), populateDefaults(), set_hidden_cms_fields()

Methods inherited from SiteTree

AbsoluteLink(), Breadcrumbs(), CMSTreeClasses(), Comments(), ContentSource(), DependentPages(), DependentPagesCount(), ElementName(), InSection(), Level(), Link(), 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(), doRestoreToStage(), doRevertToLive(), doRollbackTo(), doUnpublish(), duplicate(), duplicateAsChild(), duplicateWithChildren(), enableCMSFieldsExtensions(), enable_nested_urls(), 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(), reset(), rewriteFileURL(), setMenuTitle(), setParent(), set_enforce_strict_hierarchy(), syncLinkTracking(), 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 array $db
#

Database field definitions. This is a map from field names to field type. The field type should be a class that extends .

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 DataObject::$default_records. This is a map from fieldname to default value.

Inserts standard column-values when a DataObject is instanciated. Does not insert default records DataObject::$default_records. This is a map from fieldname to default value.

  • If you would like to change a default value in a sub-class, just specify it. - If you would like to disable the default value given by a parent class, set the default value to 0,'',or false in your subclass. Setting it to null won't work.
protected static mixed $static_filepath
#

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, $has_one, $hide_ancestor, $icon, $indexes, $many_many, $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

Properties inherited from Object

$class, $extension_instances

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -
Webylon 3.1 API Docs API documentation generated by ApiGen 2.8.0