Permalink
Browse files

MINOR Documentation

  • Loading branch information...
chillu committed Feb 6, 2012
1 parent 08a7bf0 commit 63536af8753ae77b9038c36945bda8c14fda50a4
Showing with 9 additions and 3 deletions.
  1. +9 −3 code/model/SiteTree.php
View
@@ -1,10 +1,16 @@
<?php
/**
* 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.
- *
+ * This data-object takes care of the heirachy. All page types that live within the hierarchy should inherit from this.
* In addition, it contains a number of static methods for querying the site tree.
+ *
+ * <h2>URLs</h2>
+ * A page is identified during request handling via its "URLSegment" database column.
+ * As pages can be nested, the full path of a URL might contain multiple segments.
+ * Each segment is stored in its filtered representation (through {@link URLSegmentFilter}).
+ * The full path is constructed via {@link Link()}, {@link RelativeLink()} and {@link AbsoluteLink()}.
+ * You can allow these segments to contain multibyte characters through {@link URLSegmentFilter::$default_allow_multibyte}.
+ *
* @package cms
*/
class SiteTree extends DataObject implements PermissionProvider,i18nEntityProvider,CMSPreviewable {

0 comments on commit 63536af

Please sign in to comment.