From ea7601d6a06eb0551ec4b843314fb94f188a8e88 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Fri, 15 Dec 2023 11:56:52 +1300 Subject: [PATCH] MNT Update @methods on class docblocks --- src/Extensions/TaxonomyTermExtension.php | 3 +++ src/Model/Quicklink.php | 2 +- src/Model/RelatedPageLink.php | 4 ++++ src/PageTypes/BaseHomePage.php | 4 ++++ src/PageTypes/BasePage.php | 3 +++ src/PageTypes/NewsPage.php | 3 +++ 6 files changed, 18 insertions(+), 1 deletion(-) diff --git a/src/Extensions/TaxonomyTermExtension.php b/src/Extensions/TaxonomyTermExtension.php index 3567f382..554dc740 100644 --- a/src/Extensions/TaxonomyTermExtension.php +++ b/src/Extensions/TaxonomyTermExtension.php @@ -7,6 +7,9 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\GridField\GridFieldAddNewButton; +/** + * @method SilverStripe\ORM\ManyManyList Pages() + */ class TaxonomyTermExtension extends DataExtension { diff --git a/src/Model/Quicklink.php b/src/Model/Quicklink.php index faeb86bb..dbc6f448 100644 --- a/src/Model/Quicklink.php +++ b/src/Model/Quicklink.php @@ -10,8 +10,8 @@ use SilverStripe\ORM\DataObject; /** - * @method BaseHomePage Parent() * @method SiteTree InternalLink() + * @method BaseHomePage Parent() */ class Quicklink extends DataObject { diff --git a/src/Model/RelatedPageLink.php b/src/Model/RelatedPageLink.php index 914df3e6..c6a6fe05 100644 --- a/src/Model/RelatedPageLink.php +++ b/src/Model/RelatedPageLink.php @@ -6,6 +6,10 @@ use SilverStripe\ORM\DataObject; use SilverStripe\Versioned\Versioned; +/** + * @method BasePage BasePage() + * @method BasePage Child() + */ class RelatedPageLink extends DataObject { private static $table_name = 'BasePage_RelatedPages'; diff --git a/src/PageTypes/BaseHomePage.php b/src/PageTypes/BaseHomePage.php index af37f1ed..16fa7dc8 100644 --- a/src/PageTypes/BaseHomePage.php +++ b/src/PageTypes/BaseHomePage.php @@ -23,6 +23,10 @@ * **BaseHomePage** is the basic home page. * By default it is hidden from the CMS - we rely on developers creating their own * `HomePage` class in the `mysite/code` which will extend from the **BaseHomePage**. + * @method SiteTree FeatureOneLink() + * @method SiteTree FeatureTwoLink() + * @method SiteTree LearnMorePage() + * @method SilverStripe\ORM\HasManyList Quicklinks() */ class BaseHomePage extends Page { diff --git a/src/PageTypes/BasePage.php b/src/PageTypes/BasePage.php index e51eccf1..76c417d8 100644 --- a/src/PageTypes/BasePage.php +++ b/src/PageTypes/BasePage.php @@ -26,6 +26,9 @@ * Please note: you should generally always extend `Page` with your custom page types. Refrain from subclassing * `BasePage` directly. Doing so will omit `Page` from your custom class's hierarchy, and this can have unintended * side effects where modules rely on modifying things on the `Page` class, as well as with templates and themes. + * @method SilverStripe\ORM\ManyManyThroughList RelatedPagesThrough() + * @method SilverStripe\ORM\ManyManyList SimilarPages() + * @method SilverStripe\ORM\ManyManyList Terms() */ class BasePage extends SiteTree diff --git a/src/PageTypes/NewsPage.php b/src/PageTypes/NewsPage.php index 2f262c88..0b788870 100644 --- a/src/PageTypes/NewsPage.php +++ b/src/PageTypes/NewsPage.php @@ -8,6 +8,9 @@ use SilverStripe\Forms\TextField; use SilverStripe\ORM\FieldType\DBField; +/** + * @method Image FeaturedImage() + */ class NewsPage extends DatedUpdatePage { private static $description = 'Describes an item of news';