From db69a1f83ce9de3808dd23f4ec0383a08488d7ed Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Thu, 14 Dec 2023 11:04:08 +1300 Subject: [PATCH] MNT Update @methods on class docblocks --- src/Dev/Validation/DatabaseAdminExtension.php | 1 - src/ORM/DataObject.php | 1 - src/Security/Group.php | 9 +++++---- src/Security/InheritedPermissionsExtension.php | 8 ++++---- src/Security/LoginAttempt.php | 2 +- src/Security/Member.php | 5 +++-- src/Security/MemberPassword.php | 2 +- src/Security/PermissionRole.php | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/Dev/Validation/DatabaseAdminExtension.php b/src/Dev/Validation/DatabaseAdminExtension.php index e8abf24df..9907f1d3c 100644 --- a/src/Dev/Validation/DatabaseAdminExtension.php +++ b/src/Dev/Validation/DatabaseAdminExtension.php @@ -9,7 +9,6 @@ use SilverStripe\ORM\DatabaseAdmin; /** * 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 index 3e978eb05..f380f158b 100644 --- a/src/ORM/DataObject.php +++ b/src/ORM/DataObject.php @@ -98,7 +98,6 @@ use stdClass; * 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 index 7bf3ed7c9..06b283d39 100755 --- a/src/Security/Group.php +++ b/src/Security/Group.php @@ -47,11 +47,12 @@ use SilverStripe\ORM\UnsavedRelationList; * * @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 Groups() + * @method ManyManyList Members() + * @method Group Parent() + * @method HasManyList Permissions() + * @method ManyManyList Roles() */ class Group extends DataObject { diff --git a/src/Security/InheritedPermissionsExtension.php b/src/Security/InheritedPermissionsExtension.php index 291e84bcd..5240246c7 100644 --- a/src/Security/InheritedPermissionsExtension.php +++ b/src/Security/InheritedPermissionsExtension.php @@ -10,10 +10,10 @@ use SilverStripe\ORM\ManyManyList; * * @property string $CanViewType * @property string $CanEditType - * @method ManyManyList ViewerGroups() - * @method ManyManyList EditorGroups() - * @method ManyManyList ViewerMembers() - * @method ManyManyList EditorMembers() + * @method ManyManyList EditorGroups() + * @method ManyManyList EditorMembers() + * @method ManyManyList ViewerGroups() + * @method ManyManyList ViewerMembers() */ class InheritedPermissionsExtension extends DataExtension { diff --git a/src/Security/LoginAttempt.php b/src/Security/LoginAttempt.php index 95eb30f1e..4ffda5c76 100644 --- a/src/Security/LoginAttempt.php +++ b/src/Security/LoginAttempt.php @@ -20,7 +20,7 @@ use SilverStripe\ORM\DataObject; * @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 index dc309b0da..07e15c84d 100644 --- a/src/Security/Member.php +++ b/src/Security/Member.php @@ -39,8 +39,6 @@ use Symfony\Component\Mailer\MailerInterface; /** * 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 @@ -57,6 +55,9 @@ use Symfony\Component\Mailer\MailerInterface; * @property int $FailedLoginCount * @property string $DateFormat * @property string $TimeFormat + * @method ManyManyList Groups() + * @method HasManyList LoggedPasswords() + * @method HasManyList RememberLoginHashes() */ class Member extends DataObject { diff --git a/src/Security/MemberPassword.php b/src/Security/MemberPassword.php index 751fcd858..8488671f6 100644 --- a/src/Security/MemberPassword.php +++ b/src/Security/MemberPassword.php @@ -11,7 +11,7 @@ use SilverStripe\ORM\DataObject; * @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 index 92d8a6333..5f96f8770 100644 --- a/src/Security/PermissionRole.php +++ b/src/Security/PermissionRole.php @@ -20,8 +20,8 @@ use SilverStripe\ORM\ManyManyList; * @property string Title * @property string OnlyAdminCanApply * - * @method HasManyList Codes() List of PermissionRoleCode objects - * @method ManyManyList Groups() List of Group objects + * @method HasManyList Codes() + * @method ManyManyList Groups() */ class PermissionRole extends DataObject {