Merge pull request #335 from creative-commoners/pulls/3.0/docblock

MNT Update @methods on class docblocks

Author: GuySartorelli

src/Extensions/TaxonomyTermExtension.php

@@ -7,6 +7,9 @@
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\GridField\GridFieldAddNewButton;
 
+/**
+ * @method SilverStripe\ORM\ManyManyList<BasePage> Pages()
+ */
 class TaxonomyTermExtension extends DataExtension
 {
 

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
 {

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';

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<Quicklink> Quicklinks()
  */
 class BaseHomePage extends Page
 {

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<BasePage> RelatedPagesThrough()
+ * @method SilverStripe\ORM\ManyManyList<BasePage> SimilarPages()
+ * @method SilverStripe\ORM\ManyManyList<TaxonomyTerm> Terms()
  */
 
 class BasePage extends SiteTree

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';