mirror of
https://github.com/silverstripe/silverstripe-cms
synced 2024-10-22 08:05:56 +02:00
Merge pull request #2909 from creative-commoners/pulls/5.1/docblock
MNT Update @methods on class docblocks
This commit is contained in:
commit
ab2cfa0b1d
@ -18,8 +18,8 @@ use SilverStripe\Versioned\Versioned;
|
||||
* @property string $RedirectionType Either 'Internal','External' or 'File'
|
||||
* @property string $ExternalURL URL to redirect to if $RedirectionType is 'External'
|
||||
* @property int $LinkToID
|
||||
* @method SiteTree LinkTo() Page to link to if $RedirectionType is 'Internal'
|
||||
* @method File LinkToFile() File to link to if $RedirectionType is 'File'
|
||||
* @method SiteTree LinkTo()
|
||||
* @method File LinkToFile()
|
||||
*/
|
||||
class RedirectorPage extends Page
|
||||
{
|
||||
|
@ -102,17 +102,14 @@ use SilverStripe\View\SSViewer;
|
||||
* @property bool $HasBrokenFile True if this page has a broken file shortcode
|
||||
* @property bool $HasBrokenLink True if this page has a broken page shortcode
|
||||
*
|
||||
* @method ManyManyList ViewerGroups() List of groups that can view this object.
|
||||
* @method ManyManyList EditorGroups() List of groups that can edit this object.
|
||||
* @method SiteTree Parent()
|
||||
* @method HasManyList|SiteTreeLink[] BackLinks() List of SiteTreeLink objects attached to this page
|
||||
*
|
||||
* @mixin Hierarchy
|
||||
* @mixin Versioned
|
||||
* @mixin RecursivePublishable
|
||||
* @mixin SiteTreeLinkTracking Added via linktracking.yml to DataObject directly
|
||||
* @mixin FileLinkTracking Added via filetracking.yml in silverstripe/assets
|
||||
* @mixin InheritedPermissionsExtension
|
||||
* @method HasManyList<SiteTreeLink> BackLinks()
|
||||
* @method HasManyList<VirtualPage> VirtualPages()
|
||||
*/
|
||||
class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvider, CMSPreviewable, Resettable, Flushable, MemberCacheFlusher
|
||||
{
|
||||
|
@ -7,8 +7,8 @@ use SilverStripe\ORM\DataObject;
|
||||
/**
|
||||
* Represents a link between a dataobject parent and a page in a HTML content area
|
||||
*
|
||||
* @method DataObject Parent() Parent object
|
||||
* @method SiteTree Linked() Page being linked to
|
||||
* @method SiteTree Linked()
|
||||
* @method DataObject Parent()
|
||||
*/
|
||||
class SiteTreeLink extends DataObject
|
||||
{
|
||||
|
@ -27,7 +27,7 @@ use SilverStripe\View\Parsers\HTMLValue;
|
||||
* field to your `db` config and this extension will ensure it's flagged appropriately.
|
||||
*
|
||||
* @property DataObject|SiteTreeLinkTracking $owner
|
||||
* @method ManyManyThroughList LinkTracking() List of site pages linked on this dataobject
|
||||
* @method ManyManyThroughList<SiteTree> LinkTracking()
|
||||
*/
|
||||
class SiteTreeLinkTracking extends DataExtension
|
||||
{
|
||||
|
@ -21,8 +21,8 @@ use SilverStripe\View\HTML;
|
||||
*
|
||||
* Note: This Only duplicates $db fields and not the $has_one etc..
|
||||
*
|
||||
* @method SiteTree CopyContentFrom()
|
||||
* @property int $CopyContentFromID
|
||||
* @method SiteTree CopyContentFrom()
|
||||
*/
|
||||
class VirtualPage extends Page
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user