Merge pull request #11093 from creative-commoners/pulls/5.1/docblock

MNT Update @methods on class docblocks
silverstripe · Dec 14, 2023 · ad8cf99 · ad8cf99
2 parents 3311794 + db69a1f
commit ad8cf99
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/src/Dev/Validation/DatabaseAdminExtension.php b/src/Dev/Validation/DatabaseAdminExtension.php
@@ -9,7 +9,6 @@
 /**
  * Hook up static validation to the deb/build process
  *
- * @method DatabaseAdmin getOwner()
  */
 class DatabaseAdminExtension extends Extension
 {

diff --git a/src/ORM/DataObject.php b/src/ORM/DataObject.php
@@ -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

diff --git a/src/Security/Group.php b/src/Security/Group.php
@@ -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
 {

diff --git a/src/Security/InheritedPermissionsExtension.php b/src/Security/InheritedPermissionsExtension.php
@@ -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
 {

diff --git a/src/Security/LoginAttempt.php b/src/Security/LoginAttempt.php
@@ -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
 {

diff --git a/src/Security/Member.php b/src/Security/Member.php
@@ -42,8 +42,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
@@ -60,6 +58,9 @@
  * @property int $FailedLoginCount
  * @property string $DateFormat
  * @property string $TimeFormat
+ * @method ManyManyList<Group> Groups()
+ * @method HasManyList<MemberPassword> LoggedPasswords()
+ * @method HasManyList<RememberLoginHash> RememberLoginHashes()
  */
 class Member extends DataObject
 {

diff --git a/src/Security/MemberPassword.php b/src/Security/MemberPassword.php
@@ -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
 {

diff --git a/src/Security/PermissionRole.php b/src/Security/PermissionRole.php
@@ -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 ManyManyList<Group> Groups()
  */
 class PermissionRole extends DataObject
 {
-Original file 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 @@