Skip to content

Commit

Permalink
MNT Update @methods on class docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
emteknetnz committed Dec 13, 2023
1 parent eb245a1 commit 910623b
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 17 deletions.
1 change: 0 additions & 1 deletion src/Dev/Validation/DatabaseAdminExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
/**
* Hook up static validation to the deb/build process
*
* @method DatabaseAdmin getOwner()
*/
class DatabaseAdminExtension extends Extension
{
Expand Down
1 change: 0 additions & 1 deletion src/ORM/DataObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@
* If any public method on this class is prefixed with an underscore,
* the results are cached in memory through {@link cachedCall()}.
*
*
* @property int $ID ID of the DataObject, 0 if the DataObject doesn't exist in database.
* @property int $OldID ID of object, if deleted
* @property string $Title
Expand Down
1 change: 0 additions & 1 deletion src/ORM/Hierarchy/Hierarchy.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
*
* @property int $ParentID
* @property DataObject|Hierarchy $owner
* @method DataObject Parent()
*/
class Hierarchy extends DataExtension
{
Expand Down
9 changes: 5 additions & 4 deletions src/Security/Group.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@
*
* @property int $ParentID ID of parent group
*
* @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 HasManyList<Group> Groups()
* @method ManyManyList<Member> Members()
* @method Group Parent()
* @method HasManyList<Permission> Permissions()
* @method ManyManyList<PermissionRole> Roles()
*/
class Group extends DataObject
{
Expand Down
8 changes: 4 additions & 4 deletions src/Security/InheritedPermissionsExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
*
* @property string $CanViewType
* @property string $CanEditType
* @method ManyManyList ViewerGroups()
* @method ManyManyList EditorGroups()
* @method ManyManyList ViewerMembers()
* @method ManyManyList EditorMembers()
* @method ManyManyList<Group> EditorGroups()
* @method ManyManyList<Member> EditorMembers()
* @method ManyManyList<Group> ViewerGroups()
* @method ManyManyList<Member> ViewerMembers()
*/
class InheritedPermissionsExtension extends DataExtension
{
Expand Down
2 changes: 1 addition & 1 deletion src/Security/LoginAttempt.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* @property string $IP IP address of user attempting to login
* @property int $MemberID ID of the Member
*
* @method Member Member() Member object of the user trying to log in
* @method Member Member()
*/
class LoginAttempt extends DataObject
{
Expand Down
5 changes: 3 additions & 2 deletions src/Security/Member.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@
/**
* The member class which represents the users of the system
*
* @method HasManyList LoggedPasswords()
* @method HasManyList RememberLoginHashes()
* @property string $FirstName
* @property string $Surname
* @property string $Email
Expand All @@ -57,6 +55,9 @@
* @property int $FailedLoginCount
* @property string $DateFormat
* @property string $TimeFormat
* @method SilverStripe\ORM\ManyManyList<Group> Groups()
* @method HasManyList<MemberPassword> LoggedPasswords()
* @method HasManyList<RememberLoginHash> RememberLoginHashes()
*/
class Member extends DataObject
{
Expand Down
2 changes: 1 addition & 1 deletion src/Security/MemberPassword.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* @property string $Salt
* @property string $PasswordEncryption
* @property int $MemberID ID of the Member
* @method Member Member() Owner of the password
* @method Member Member()
*/
class MemberPassword extends DataObject
{
Expand Down
4 changes: 2 additions & 2 deletions src/Security/PermissionRole.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
* @property string Title
* @property string OnlyAdminCanApply
*
* @method HasManyList Codes() List of PermissionRoleCode objects
* @method ManyManyList Groups() List of Group objects
* @method HasManyList<PermissionRoleCode> Codes()
* @method SilverStripe\ORM\ManyManyList<Group> Groups()
*/
class PermissionRole extends DataObject
{
Expand Down

0 comments on commit 910623b

Please sign in to comment.