Class Room
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
-
ViewableData
implements
IteratorAggregate
-
DataObject
implements
DataObjectInterface,
i18nEntityProvider
-
SiteTree
implements
PermissionProvider,
i18nEntityProvider
-
Page
-
MediawebPage
-
Room
Methods summary
public static
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
<type>
|
|
public
|
|
public
|
Methods inherited from MediawebPage
FileCount(),
Identify(),
ImageCount(),
duplicate(),
onAfterDelete()
Methods inherited from Page
AdminEmail(),
DevMode(),
FinalParent(),
Lang(),
Locale(),
MetaTags(),
NestedValue(),
allowComments(),
canAddChildren(),
canDelete(),
canDeleteFromLive(),
canEdit(),
canPublish(),
checkDevPermisson(),
hiddenCMSFields(),
hide_cms_fields(),
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(),
doPublish(),
doRestoreToStage(),
doRevertToLive(),
doRollbackTo(),
doUnpublish(),
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
array
|
$allowed_children |
#
Indicates what kind of children this page type can have. This can be an array of allowed child classes, or the string "none" - indicating that this page type can't have children. If a classname is prefixed by "*", such as "*Page", then only that class is allowed - no subclasses. Otherwise, the class and all its subclasses are allowed. |
public static
string
|
$default_parent |
#
The default parent class for this page. |
public static
boolean
|
$can_be_root |
#
Controls whether a page can be in the root of the site tree. |
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
|
$casting |
#
Use a casting object for a field. This is a map from field name to class name of the casting object. |
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
|
$has_many |
#
This defines a one-to-many relationship. It is a map of component name to the remote data class. |
public static
array
|
$many_many |
#
many-many relationship definitions. This is a map from component name to data type. |
Properties inherited from MediawebPage
Properties inherited from Page
$default_child,
$hidden_cms_fields,
$summary_fields
Properties inherited from SiteTree
$belongs_many_many,
$breadcrumbs_delimiter,
$cache_permissions,
$can_create,
$default_sort,
$extensions,
$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