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

MNT Update @methods on class docblocks
This commit is contained in:
Guy Sartorelli 2023-12-15 12:38:38 +13:00 committed by GitHub
commit ad8cf9902c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 16 additions and 16 deletions

View File

@ -9,7 +9,6 @@ use SilverStripe\ORM\DatabaseAdmin;
/** /**
* Hook up static validation to the deb/build process * Hook up static validation to the deb/build process
* *
* @method DatabaseAdmin getOwner()
*/ */
class DatabaseAdminExtension extends Extension class DatabaseAdminExtension extends Extension
{ {

View File

@ -98,7 +98,6 @@ use stdClass;
* If any public method on this class is prefixed with an underscore, * If any public method on this class is prefixed with an underscore,
* the results are cached in memory through {@link cachedCall()}. * 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 $ID ID of the DataObject, 0 if the DataObject doesn't exist in database.
* @property int $OldID ID of object, if deleted * @property int $OldID ID of object, if deleted
* @property string $Title * @property string $Title

View File

@ -47,11 +47,12 @@ use SilverStripe\ORM\UnsavedRelationList;
* *
* @property int $ParentID ID of parent group * @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 * @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 class Group extends DataObject
{ {

View File

@ -10,10 +10,10 @@ use SilverStripe\ORM\ManyManyList;
* *
* @property string $CanViewType * @property string $CanViewType
* @property string $CanEditType * @property string $CanEditType
* @method ManyManyList ViewerGroups() * @method ManyManyList<Group> EditorGroups()
* @method ManyManyList EditorGroups() * @method ManyManyList<Member> EditorMembers()
* @method ManyManyList ViewerMembers() * @method ManyManyList<Group> ViewerGroups()
* @method ManyManyList EditorMembers() * @method ManyManyList<Member> ViewerMembers()
*/ */
class InheritedPermissionsExtension extends DataExtension class InheritedPermissionsExtension extends DataExtension
{ {

View File

@ -20,7 +20,7 @@ use SilverStripe\ORM\DataObject;
* @property string $IP IP address of user attempting to login * @property string $IP IP address of user attempting to login
* @property int $MemberID ID of the Member * @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 class LoginAttempt extends DataObject
{ {

View File

@ -42,8 +42,6 @@ use Symfony\Component\Mime\Exception\RfcComplianceException;
/** /**
* The member class which represents the users of the system * The member class which represents the users of the system
* *
* @method HasManyList LoggedPasswords()
* @method HasManyList RememberLoginHashes()
* @property string $FirstName * @property string $FirstName
* @property string $Surname * @property string $Surname
* @property string $Email * @property string $Email
@ -60,6 +58,9 @@ use Symfony\Component\Mime\Exception\RfcComplianceException;
* @property int $FailedLoginCount * @property int $FailedLoginCount
* @property string $DateFormat * @property string $DateFormat
* @property string $TimeFormat * @property string $TimeFormat
* @method ManyManyList<Group> Groups()
* @method HasManyList<MemberPassword> LoggedPasswords()
* @method HasManyList<RememberLoginHash> RememberLoginHashes()
*/ */
class Member extends DataObject class Member extends DataObject
{ {

View File

@ -11,7 +11,7 @@ use SilverStripe\ORM\DataObject;
* @property string $Salt * @property string $Salt
* @property string $PasswordEncryption * @property string $PasswordEncryption
* @property int $MemberID ID of the Member * @property int $MemberID ID of the Member
* @method Member Member() Owner of the password * @method Member Member()
*/ */
class MemberPassword extends DataObject class MemberPassword extends DataObject
{ {

View File

@ -20,8 +20,8 @@ use SilverStripe\ORM\ManyManyList;
* @property string Title * @property string Title
* @property string OnlyAdminCanApply * @property string OnlyAdminCanApply
* *
* @method HasManyList Codes() List of PermissionRoleCode objects * @method HasManyList<PermissionRoleCode> Codes()
* @method ManyManyList Groups() List of Group objects * @method ManyManyList<Group> Groups()
*/ */
class PermissionRole extends DataObject class PermissionRole extends DataObject
{ {