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

Packages

  • 1c
    • exchange
      • catalog
  • auth
  • Booking
  • building
    • company
  • cart
    • shipping
    • steppedcheckout
  • Catalog
    • monument
  • 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 SubsitesSelectorPage

Basic data-object representing all pages within the site tree. This data-object takes care of the heirachy. All page types that live within the heirachy should inherit from this.

In addition, it contains a number of static methods for querying the site tree.

Object
Extended by ViewableData implements IteratorAggregate
Extended by DataObject implements DataObjectInterface, i18nEntityProvider
Extended by SiteTree implements PermissionProvider, i18nEntityProvider
Extended by Page
Extended by SubsitesSelectorPage
Package: cms
Located at subsites/code/SubsitesSelectorPage.php

Methods summary

public boolean
# canCreate( )

This function should return true if the current user can create new pages of this class. It can be overloaded to customise the security model for an application.

This function should return true if the current user can create new pages of this class. It can be overloaded to customise the security model for an application.

Denies permission if any of the following conditions is TRUE:

  • canCreate() returns FALSE on any decorator
  • $can_create is set to FALSE and the site is not in "dev mode"

Use Page::canAddChildren() to control behaviour of creating children under this page.

Returns

boolean
True if the current user can create pages on this class.

Uses

mixed
DataObjectDecorator::canCreate()

Overrides

SiteTree::canCreate
public boolean
# canDelete( )

This function should return true if the current user can delete this page. It can be overloaded to customise the security model for an application.

This function should return true if the current user can delete this page. It can be overloaded to customise the security model for an application.

Denies permission if any of the following conditions is TRUE:

  • canDelete() returns FALSE on any decorator
  • canEdit() returns FALSE
  • any descendant page returns FALSE for canDelete()

Returns

boolean
True if the current user can delete this page.

Uses

SubsitesSelectorPage::canDelete()
DataObjectDecorator::canDelete()
Page::canEdit()

Used by

SubsitesSelectorPage::canDelete()

Overrides

Page::canDelete
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

Methods inherited from Page

AdminEmail(), DevMode(), FinalParent(), Lang(), Locale(), MetaTags(), NestedValue(), allowComments(), canAddChildren(), 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(), 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(), 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 string|array $icon
#

Icon to use in the CMS

Icon to use in the CMS

This should be the base filename. The suffixes -file.gif,

  • openfolder.gif and -closedfolder.gif will be appended to the base name

that you provide there. If you prefer, you can pass an array: array("sapphire\thirdparty\tree\images\page", $option). $option can be either "file" or "folder" to force the icon to always be a file or folder, regardless of whether the page has children or not

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.

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, $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.2 API Docs API documentation generated by ApiGen 2.8.0