From bf51be292855f8456e81aff48c17cf50cd5f9521 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Thu, 14 Dec 2023 15:21:15 +1300 Subject: [PATCH] MNT Update @methods on class docblocks --- src/Extensions/FileSubsites.php | 1 + src/Extensions/GroupSubsites.php | 1 + src/Extensions/SiteConfigSubsites.php | 1 + src/Extensions/SiteTreeSubsites.php | 2 ++ src/Extensions/SubsiteMenuExtension.php | 5 ++--- src/Model/Subsite.php | 2 ++ src/Model/SubsiteDomain.php | 1 + 7 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/Extensions/FileSubsites.php b/src/Extensions/FileSubsites.php index 7837182..03c6385 100644 --- a/src/Extensions/FileSubsites.php +++ b/src/Extensions/FileSubsites.php @@ -14,6 +14,7 @@ use SilverStripe\Subsites\State\SubsiteState; * Extension for the File object to add subsites support * * @package subsites + * @method Subsite Subsite() */ class FileSubsites extends DataExtension { diff --git a/src/Extensions/GroupSubsites.php b/src/Extensions/GroupSubsites.php index 4c02fce..9859b36 100644 --- a/src/Extensions/GroupSubsites.php +++ b/src/Extensions/GroupSubsites.php @@ -22,6 +22,7 @@ use SilverStripe\Subsites\State\SubsiteState; * Extension for the Group object to add subsites support * * @package subsites + * @method SilverStripe\ORM\ManyManyList Subsites() */ class GroupSubsites extends DataExtension implements PermissionProvider { diff --git a/src/Extensions/SiteConfigSubsites.php b/src/Extensions/SiteConfigSubsites.php index 7919e4b..dba76c0 100644 --- a/src/Extensions/SiteConfigSubsites.php +++ b/src/Extensions/SiteConfigSubsites.php @@ -13,6 +13,7 @@ use SilverStripe\Subsites\State\SubsiteState; /** * Extension for the SiteConfig object to add subsites support + * @method Subsite Subsite() */ class SiteConfigSubsites extends DataExtension { diff --git a/src/Extensions/SiteTreeSubsites.php b/src/Extensions/SiteTreeSubsites.php index 760eba0..99859cd 100644 --- a/src/Extensions/SiteTreeSubsites.php +++ b/src/Extensions/SiteTreeSubsites.php @@ -32,6 +32,8 @@ use SilverStripe\VersionedAdmin\Controllers\HistoryViewerController; /** * Extension for the SiteTree object to add subsites support + * @method SilverStripe\ORM\ManyManyList CrossSubsiteLinkTracking() + * @method Subsite Subsite() */ class SiteTreeSubsites extends DataExtension { diff --git a/src/Extensions/SubsiteMenuExtension.php b/src/Extensions/SubsiteMenuExtension.php index 422df27..bda651c 100644 --- a/src/Extensions/SubsiteMenuExtension.php +++ b/src/Extensions/SubsiteMenuExtension.php @@ -4,16 +4,15 @@ namespace SilverStripe\Subsites\Extensions; use SilverStripe\Core\Extension; -/* +/** * Simple extension to show admins in the menu of subsites. * If an admin area should be available to a subsite, you can attach * this class to your admin in config. eg: * - * MyAdmin::add_extension('SubsiteMenuExtension'); + * MyAdmin::add_extension('SubsiteMenuExtension'); * * Or you can include the subsiteCMSShowInMenu function in your admin class and have it return true */ - class SubsiteMenuExtension extends Extension { public function subsiteCMSShowInMenu() diff --git a/src/Model/Subsite.php b/src/Model/Subsite.php index a88e786..76f1e52 100644 --- a/src/Model/Subsite.php +++ b/src/Model/Subsite.php @@ -38,6 +38,8 @@ use UnexpectedValueException; * You can simulate subsite access without setting up virtual hosts by appending ?SubsiteID= to the request. * * @package subsites + * @method SilverStripe\ORM\HasManyList Domains() + * @method SilverStripe\ORM\ManyManyList Groups() */ class Subsite extends DataObject { diff --git a/src/Model/SubsiteDomain.php b/src/Model/SubsiteDomain.php index 843f3db..755f069 100644 --- a/src/Model/SubsiteDomain.php +++ b/src/Model/SubsiteDomain.php @@ -17,6 +17,7 @@ use SilverStripe\Subsites\Forms\WildcardDomainField; * @property string $SubstitutedDomain Domain name with all wildcards filled in * @property string $FullProtocol Full protocol including :// * @property bool $IsPrimary Is this the primary subdomain? + * @method Subsite Subsite() */ class SubsiteDomain extends DataObject {