Merge pull request #551 from creative-commoners/pulls/3.1/docblock

MNT Update @methods on class docblocks
This commit is contained in:
Guy Sartorelli 2023-12-15 12:55:03 +13:00 committed by GitHub
commit 226a68716e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 10 additions and 3 deletions

View File

@ -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
{

View File

@ -22,6 +22,7 @@ use SilverStripe\Subsites\State\SubsiteState;
* Extension for the Group object to add subsites support
*
* @package subsites
* @method SilverStripe\ORM\ManyManyList<Subsite> Subsites()
*/
class GroupSubsites extends DataExtension implements PermissionProvider
{

View File

@ -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
{

View File

@ -32,6 +32,8 @@ use SilverStripe\VersionedAdmin\Controllers\HistoryViewerController;
/**
* Extension for the SiteTree object to add subsites support
* @method SilverStripe\ORM\ManyManyList<SiteTree> CrossSubsiteLinkTracking()
* @method Subsite Subsite()
*/
class SiteTreeSubsites extends DataExtension
{

View File

@ -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()

View File

@ -38,6 +38,8 @@ use UnexpectedValueException;
* You can simulate subsite access without setting up virtual hosts by appending ?SubsiteID=<ID> to the request.
*
* @package subsites
* @method SilverStripe\ORM\HasManyList<SubsiteDomain> Domains()
* @method SilverStripe\ORM\ManyManyList<Group> Groups()
*/
class Subsite extends DataObject
{

View File

@ -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
{