MNT Update @methods on class docblocks #11092
Conversation
| @@ -24,7 +24,6 @@ | |||
| * | |||
| * @property int $ParentID | |||
| * @property DataObject|Hierarchy $owner | |||
| * @method DataObject Parent() | |||
There was a problem hiding this comment.
This one needs to stay - see the (non-standard) get_extra_config() method which is adding the has_one relation.
| * @method Group Parent() Return parent group | ||
| * @method HasManyList Permissions() List of group permissions | ||
| * @method HasManyList Groups() List of child groups | ||
| * @method ManyManyList Roles() List of PermissionRoles | ||
| * @mixin Hierarchy | ||
| * @method SilverStripe\ORM\HasManyList<Group> Groups() | ||
| * @method SilverStripe\ORM\ManyManyList<Member> Members() | ||
| * @method Group Parent() | ||
| * @method SilverStripe\ORM\HasManyList<Permission> Permissions() | ||
| * @method SilverStripe\ORM\ManyManyList<PermissionRole> Roles() |
There was a problem hiding this comment.
HasManyList and ManyManyList are imported as use statements above (presumably specifically for the @method annotations)
If those use statements aren't used elsewhere, they should be removed.
Otherwise, we should probably just use the short form here in the @method annotations.
Since having extra use statements doesn't really cause any problems, it's just a little untidy - and same with unnecessary FQCN, I'll also accept it if you decide it's not worth changing the way your code writer handles this - in which case you can just mark this and the related items as resolved.
| * @method ManyManyList ViewerGroups() | ||
| * @method ManyManyList EditorGroups() | ||
| * @method ManyManyList ViewerMembers() | ||
| * @method ManyManyList EditorMembers() | ||
| * @method SilverStripe\ORM\ManyManyList<Group> EditorGroups() | ||
| * @method SilverStripe\ORM\ManyManyList<Member> EditorMembers() | ||
| * @method SilverStripe\ORM\ManyManyList<Group> ViewerGroups() | ||
| * @method SilverStripe\ORM\ManyManyList<Member> ViewerMembers() |
There was a problem hiding this comment.
See above comment and perform the same actions here as you will there.
| * @method SilverStripe\ORM\ManyManyList<Group> Groups() | ||
| * @method SilverStripe\ORM\HasManyList<MemberPassword> LoggedPasswords() | ||
| * @method SilverStripe\ORM\HasManyList<RememberLoginHash> RememberLoginHashes() |
There was a problem hiding this comment.
See above comment and perform the same actions here as you will there.
| * @method HasManyList Codes() List of PermissionRoleCode objects | ||
| * @method ManyManyList Groups() List of Group objects | ||
| * @method SilverStripe\ORM\HasManyList<PermissionRoleCode> Codes() | ||
| * @method SilverStripe\ORM\ManyManyList<Group> Groups() |
There was a problem hiding this comment.
See above comment and perform the same actions here as you will there.
|
Closed in favor of #11093 (this branch was accidentally pushed to silverstripe account instead of creative-commoners |
Issue silverstripe/.github#163