tonyair/silverstripe-cms
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-cms synced 2024-10-22 08:05:56 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #2909 from creative-commoners/pulls/5.1/docblock

Browse Source 
MNT Update @methods on class docblocks
This commit is contained in:
Guy Sartorelli 2023-12-15 12:45:22 +13:00 committed by GitHub
commit ab2cfa0b1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
code/Model/RedirectorPage.php
View File

@ -18,8 +18,8 @@ use SilverStripe\Versioned\Versioned;
* @property string $RedirectionType Either 'Internal','External' or 'File' * @property string $RedirectionType Either 'Internal','External' or 'File'
* @property string $ExternalURL URL to redirect to if $RedirectionType is 'External' * @property string $ExternalURL URL to redirect to if $RedirectionType is 'External'
* @property int $LinkToID * @property int $LinkToID
* @method SiteTree LinkTo() Page to link to if $RedirectionType is 'Internal' * @method SiteTree LinkTo()
* @method File LinkToFile() File to link to if $RedirectionType is 'File' * @method File LinkToFile()
*/ */
class RedirectorPage extends Page class RedirectorPage extends Page
{ {

7
code/Model/SiteTree.php
View File

@ -102,17 +102,14 @@ use SilverStripe\View\SSViewer;
* @property bool $HasBrokenFile True if this page has a broken file shortcode * @property bool $HasBrokenFile True if this page has a broken file shortcode
* @property bool $HasBrokenLink True if this page has a broken page 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 Hierarchy
* @mixin Versioned * @mixin Versioned
* @mixin RecursivePublishable * @mixin RecursivePublishable
* @mixin SiteTreeLinkTracking Added via linktracking.yml to DataObject directly * @mixin SiteTreeLinkTracking Added via linktracking.yml to DataObject directly
* @mixin FileLinkTracking Added via filetracking.yml in silverstripe/assets * @mixin FileLinkTracking Added via filetracking.yml in silverstripe/assets
* @mixin InheritedPermissionsExtension * @mixin InheritedPermissionsExtension
* @method HasManyList<SiteTreeLink> BackLinks()
* @method HasManyList<VirtualPage> VirtualPages()
*/ */
class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvider, CMSPreviewable, Resettable, Flushable, MemberCacheFlusher class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvider, CMSPreviewable, Resettable, Flushable, MemberCacheFlusher
{ {

4
code/Model/SiteTreeLink.php
View File

@ -7,8 +7,8 @@ use SilverStripe\ORM\DataObject;
/** /**
* Represents a link between a dataobject parent and a page in a HTML content area * Represents a link between a dataobject parent and a page in a HTML content area
* *
* @method DataObject Parent() Parent object * @method SiteTree Linked()
* @method SiteTree Linked() Page being linked to * @method DataObject Parent()
*/ */
class SiteTreeLink extends DataObject class SiteTreeLink extends DataObject
{ {

2
code/Model/SiteTreeLinkTracking.php
View File

@ -27,7 +27,7 @@ use SilverStripe\View\Parsers\HTMLValue;
* field to your `db` config and this extension will ensure it's flagged appropriately. * field to your `db` config and this extension will ensure it's flagged appropriately.
* *
* @property DataObject|SiteTreeLinkTracking $owner * @property DataObject|SiteTreeLinkTracking $owner
* @method ManyManyThroughList LinkTracking() List of site pages linked on this dataobject * @method ManyManyThroughList<SiteTree> LinkTracking()
*/ */
class SiteTreeLinkTracking extends DataExtension class SiteTreeLinkTracking extends DataExtension
{ {

2
code/Model/VirtualPage.php
View File

@ -21,8 +21,8 @@ use SilverStripe\View\HTML;
* *
* Note: This Only duplicates $db fields and not the $has_one etc.. * Note: This Only duplicates $db fields and not the $has_one etc..
* *
* @method SiteTree CopyContentFrom()
* @property int $CopyContentFromID * @property int $CopyContentFromID
* @method SiteTree CopyContentFrom()
*/ */
class VirtualPage extends Page class VirtualPage extends Page
{ {