Skip to content

Commit

Permalink
Merge pull request #551 from creative-commoners/pulls/3.1/docblock
Browse files Browse the repository at this point in the history
MNT Update @methods on class docblocks
  • Loading branch information
GuySartorelli committed Dec 14, 2023
2 parents 4a66c85 + bf51be2 commit 226a687
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 3 deletions.
1 change: 1 addition & 0 deletions src/Extensions/FileSubsites.php
Expand Up @@ -14,6 +14,7 @@
* Extension for the File object to add subsites support
*
* @package subsites
* @method Subsite Subsite()
*/
class FileSubsites extends DataExtension
{
Expand Down
1 change: 1 addition & 0 deletions src/Extensions/GroupSubsites.php
Expand Up @@ -22,6 +22,7 @@
* Extension for the Group object to add subsites support
*
* @package subsites
* @method SilverStripe\ORM\ManyManyList<Subsite> Subsites()
*/
class GroupSubsites extends DataExtension implements PermissionProvider
{
Expand Down
1 change: 1 addition & 0 deletions src/Extensions/SiteConfigSubsites.php
Expand Up @@ -13,6 +13,7 @@

/**
* Extension for the SiteConfig object to add subsites support
* @method Subsite Subsite()
*/
class SiteConfigSubsites extends DataExtension
{
Expand Down
2 changes: 2 additions & 0 deletions src/Extensions/SiteTreeSubsites.php
Expand Up @@ -32,6 +32,8 @@

/**
* Extension for the SiteTree object to add subsites support
* @method SilverStripe\ORM\ManyManyList<SiteTree> CrossSubsiteLinkTracking()
* @method Subsite Subsite()
*/
class SiteTreeSubsites extends DataExtension
{
Expand Down
5 changes: 2 additions & 3 deletions src/Extensions/SubsiteMenuExtension.php
Expand Up @@ -4,16 +4,15 @@

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()
Expand Down
2 changes: 2 additions & 0 deletions src/Model/Subsite.php
Expand Up @@ -38,6 +38,8 @@
* 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
{
Expand Down
1 change: 1 addition & 0 deletions src/Model/SubsiteDomain.php
Expand Up @@ -17,6 +17,7 @@
* @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
{
Expand Down

0 comments on commit 226a687

Please sign in to comment.