Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MNT Update @methods on class docblocks #2909

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions code/Model/RedirectorPage.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
* @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
{
Expand Down
7 changes: 2 additions & 5 deletions code/Model/SiteTree.php
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,14 @@
* @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
{
Expand Down
4 changes: 2 additions & 2 deletions code/Model/SiteTreeLink.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
/**
* 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
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/SiteTreeLinkTracking.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* 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
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/VirtualPage.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
*
* 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
{
Expand Down