tonyair
/
silverstripe-reports
mirror of https://github.com/silverstripe/silverstripe-reports
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Documented magic properties/methods of SiteTree and SiteConfig.

This commit is contained in:
Gus King 2014-02-09 18:20:55 -05:00
parent 5e79e66ccc
commit 457cadb103
2 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
code/model/SiteConfig.php
View File

@ -2,7 +2,18 @@
/**
* Sitewide configuration.
*
*
* @property string Title Title of the website.
* @property string Tagline Tagline of the website.
* @property string Theme Current theme.
* @property string CanViewType Type of restriction used for view permissions.
* @property string CanEditType Type of restriction used for edit permissions.
* @property string CanCreateTopLevelType Type of restriction used for creation of root-level pages.
*
* @method ManyManyList ViewerGroups() List of groups that can view SiteConfig.
* @method ManyManyList EditorGroups() List of groups that can edit SiteConfig.
* @method ManyManyList CreateTopLevelGroups() List of groups that can create root-level pages.
*
* @author Tom Rix
* @package cms
*/

24
code/model/SiteTree.php
View File

@ -10,7 +10,29 @@
* 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}.
*
*
* @property integer ID ID of the SiteTree object.
* @property string URLSegment
* @property string Title
* @property string MenuTitle
* @property string Content HTML content of the page.
* @property string MetaDescription
* @property string ExtraMeta
* @property string ShowInMenus
* @property string ShowInSearch
* @property string Sort Integer value denoting the sort order.
* @property string HasBrokenFile
* @property string HasBrokenLink
* @property string ReportClass
* @property string CanViewType Type of restriction for viewing this object.
* @property string CanEditType Type of restriction for editing this object.
*
* @method ManyManyList LinkTracking() List of site pages linked on this page.
* @method ManyManyList ImageTracking() List of Images linked on this page.
* @method ManyManyList ViewerGroups() List of groups that can view this object.
* @method ManyManyList EditorGroups() List of groups that can edit this object.
* @method ManyManyList BackLinkTracking() List of site pages that link to this page.
*
* @package cms
*/
class SiteTree extends DataObject implements PermissionProvider,i18nEntityProvider,CMSPreviewable {