Merge pull request #1257 from creative-commoners/pulls/6.1/docblock

MNT Update @methods on class docblocks
silverstripe · Dec 17, 2023 · 5e62815 · 5e62815
2 parents 8cf7f90 + 70d9cd2
commit 5e62815
Show file tree

Hide file tree

Showing 12 changed files with 15 additions and 12 deletions.
diff --git a/code/Extension/UserFormFieldEditorExtension.php b/code/Extension/UserFormFieldEditorExtension.php
@@ -28,7 +28,7 @@
 use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
 
 /**
- * @method DataList|EditableFormField[] Fields()
+ * @method SilverStripe\ORM\HasManyList<EditableFormField> Fields()
  */
 class UserFormFieldEditorExtension extends DataExtension
 {

diff --git a/code/Extension/UserFormFileExtension.php b/code/Extension/UserFormFileExtension.php
@@ -14,7 +14,7 @@
 
 /**
  * @property string $UserFormUpload
- * @method File SubmittedFileField
+ * @method SubmittedFileField SubmittedFileField()
  */
 class UserFormFileExtension extends DataExtension
 {

diff --git a/code/Model/EditableCustomRule.php b/code/Model/EditableCustomRule.php
@@ -20,8 +20,8 @@
  * @property string $Display
  * @property string $FieldValue
  * @property int $ParentID
- * @method EditableFormField Parent()
  * @method EditableFormField ConditionField()
+ * @method EditableFormField Parent()
  */
 class EditableCustomRule extends DataObject
 {

diff --git a/code/Model/EditableFormField.php b/code/Model/EditableFormField.php
@@ -57,9 +57,9 @@
  * @property int $ShowInSummary
  * @property int $ShowOnLoad
  * @property int $Sort
- * @method UserDefinedForm Parent() Parent page
- * @method HasManyList|EditableCustomRule[] DisplayRules() List of EditableCustomRule objects
  * @mixin Versioned
+ * @method HasManyList<EditableCustomRule> DisplayRules()
+ * @method DataObject Parent()
  */
 class EditableFormField extends DataObject
 {

diff --git a/code/Model/EditableFormField/EditableFieldGroup.php b/code/Model/EditableFormField/EditableFieldGroup.php
@@ -12,7 +12,7 @@
  * Specifies that this ends a group of fields
  *
  * @property int $EditableFieldGroupEndID
- * @method EditableFieldGroupEnd EditableFieldGroupEnd()
+ * @method EditableFieldGroupEnd End()
  */
 class EditableFieldGroup extends EditableFormField
 {

diff --git a/code/Model/EditableFormField/EditableFileField.php b/code/Model/EditableFormField/EditableFileField.php
@@ -28,7 +28,7 @@
  * @property int $FolderConfirmed
  * @property int $FolderID
  * @property float $MaxFileSizeMB
- * @method Folder Folder
+ * @method Folder Folder()
  */
 class EditableFileField extends EditableFormField
 {

diff --git a/code/Model/EditableFormField/EditableMultipleOptionField.php b/code/Model/EditableFormField/EditableMultipleOptionField.php
@@ -31,7 +31,7 @@
  * @see EditableDropdownField
  *
  * @package userforms
- * @method HasManyList|EditableOption[] Options()
+ * @method HasManyList<EditableOption> Options()
  */
 class EditableMultipleOptionField extends EditableFormField
 {

diff --git a/code/Model/EditableFormField/EditableOption.php b/code/Model/EditableFormField/EditableOption.php
@@ -16,8 +16,8 @@
  * @property int $ParentID
  * @property int $Sort
  * @property string $Value
- * @method EditableMultipleOptionField Parent()
  * @mixin Versioned
+ * @method EditableMultipleOptionField Parent()
  */
 class EditableOption extends DataObject
 {

diff --git a/code/Model/Recipient/EmailRecipient.php b/code/Model/Recipient/EmailRecipient.php
@@ -62,7 +62,7 @@
  * @property int $SendEmailFromFieldID
  * @property int $SendEmailSubjectFieldID
  * @property int $SendEmailToFieldID
- * @method HasManyList|EmailRecipientCondition[] CustomRules()
+ * @method HasManyList<EmailRecipientCondition> CustomRules()
  * @method DataObject Form()
  * @method EditableFormField SendEmailFromField()
  * @method EditableFormField SendEmailSubjectField()

diff --git a/code/Model/Submission/SubmittedForm.php b/code/Model/Submission/SubmittedForm.php
@@ -19,9 +19,9 @@
  * @package userforms
  * @property int $SubmittedByID
  * @property int $ParentID
- * @method Member SubmittedBy()
  * @method DataObject Parent()
- * @method HasManyList|SubmittedFormField[] Values()
+ * @method Member SubmittedBy()
+ * @method HasManyList<SubmittedFormField> Values()
  */
 class SubmittedForm extends DataObject
 {

diff --git a/code/Model/Submission/SubmittedFormField.php b/code/Model/Submission/SubmittedFormField.php
@@ -13,6 +13,7 @@
  * @package userforms
  * @property string $Name
  * @property string $Value
+ * @method SubmittedForm Parent()
  */
 class SubmittedFormField extends DataObject
 {

diff --git a/code/Model/UserDefinedForm.php b/code/Model/UserDefinedForm.php
@@ -9,6 +9,8 @@
 
 /**
  * @package userforms
+ * @method SilverStripe\ORM\HasManyList<SilverStripe\UserForms\Model\Recipient\EmailRecipient> EmailRecipients()
+ * @method SilverStripe\ORM\HasManyList<SilverStripe\UserForms\Model\Submission\SubmittedForm> Submissions()
  */
 class UserDefinedForm extends Page
 {