From 70d9cd27b22e13ec5dd01d2a4a9d6c8e5842b3d1 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Fri, 15 Dec 2023 17:04:35 +1300 Subject: [PATCH] MNT Update @methods on class docblocks --- code/Extension/UserFormFieldEditorExtension.php | 2 +- code/Extension/UserFormFileExtension.php | 2 +- code/Model/EditableCustomRule.php | 2 +- code/Model/EditableFormField.php | 4 ++-- code/Model/EditableFormField/EditableFieldGroup.php | 2 +- code/Model/EditableFormField/EditableFileField.php | 2 +- code/Model/EditableFormField/EditableMultipleOptionField.php | 2 +- code/Model/EditableFormField/EditableOption.php | 2 +- code/Model/Recipient/EmailRecipient.php | 2 +- code/Model/Submission/SubmittedForm.php | 4 ++-- code/Model/Submission/SubmittedFormField.php | 1 + code/Model/UserDefinedForm.php | 2 ++ 12 files changed, 15 insertions(+), 12 deletions(-) diff --git a/code/Extension/UserFormFieldEditorExtension.php b/code/Extension/UserFormFieldEditorExtension.php index ee08921..a1ede83 100644 --- a/code/Extension/UserFormFieldEditorExtension.php +++ b/code/Extension/UserFormFieldEditorExtension.php @@ -28,7 +28,7 @@ use Symbiote\GridFieldExtensions\GridFieldEditableColumns; use Symbiote\GridFieldExtensions\GridFieldOrderableRows; /** - * @method DataList|EditableFormField[] Fields() + * @method SilverStripe\ORM\HasManyList Fields() */ class UserFormFieldEditorExtension extends DataExtension { diff --git a/code/Extension/UserFormFileExtension.php b/code/Extension/UserFormFileExtension.php index d7fd482..3e00d65 100644 --- a/code/Extension/UserFormFileExtension.php +++ b/code/Extension/UserFormFileExtension.php @@ -14,7 +14,7 @@ use SilverStripe\Versioned\Versioned; /** * @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 index 272bd56..66afe78 100644 --- a/code/Model/EditableCustomRule.php +++ b/code/Model/EditableCustomRule.php @@ -20,8 +20,8 @@ use SilverStripe\Versioned\Versioned; * @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 index 4dc2f77..9f0799a 100755 --- a/code/Model/EditableFormField.php +++ b/code/Model/EditableFormField.php @@ -57,9 +57,9 @@ use Symbiote\GridFieldExtensions\GridFieldEditableColumns; * @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 DisplayRules() + * @method DataObject Parent() */ class EditableFormField extends DataObject { diff --git a/code/Model/EditableFormField/EditableFieldGroup.php b/code/Model/EditableFormField/EditableFieldGroup.php index 93d46c3..7f1012f 100644 --- a/code/Model/EditableFormField/EditableFieldGroup.php +++ b/code/Model/EditableFormField/EditableFieldGroup.php @@ -12,7 +12,7 @@ use SilverStripe\UserForms\Model\EditableFormField; * 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 index 4d17949..536502a 100755 --- a/code/Model/EditableFormField/EditableFileField.php +++ b/code/Model/EditableFormField/EditableFileField.php @@ -28,7 +28,7 @@ use SilverStripe\UserForms\Model\Submission\SubmittedFileField; * @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 index e424642..ab28482 100644 --- a/code/Model/EditableFormField/EditableMultipleOptionField.php +++ b/code/Model/EditableFormField/EditableMultipleOptionField.php @@ -31,7 +31,7 @@ use Symbiote\GridFieldExtensions\GridFieldTitleHeader; * @see EditableDropdownField * * @package userforms - * @method HasManyList|EditableOption[] Options() + * @method HasManyList Options() */ class EditableMultipleOptionField extends EditableFormField { diff --git a/code/Model/EditableFormField/EditableOption.php b/code/Model/EditableFormField/EditableOption.php index 3ad087a..944e368 100644 --- a/code/Model/EditableFormField/EditableOption.php +++ b/code/Model/EditableFormField/EditableOption.php @@ -16,8 +16,8 @@ use SilverStripe\Versioned\Versioned; * @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 index 26ff6fe..dbf39f5 100644 --- a/code/Model/Recipient/EmailRecipient.php +++ b/code/Model/Recipient/EmailRecipient.php @@ -62,7 +62,7 @@ use Symbiote\GridFieldExtensions\GridFieldEditableColumns; * @property int $SendEmailFromFieldID * @property int $SendEmailSubjectFieldID * @property int $SendEmailToFieldID - * @method HasManyList|EmailRecipientCondition[] CustomRules() + * @method HasManyList CustomRules() * @method DataObject Form() * @method EditableFormField SendEmailFromField() * @method EditableFormField SendEmailSubjectField() diff --git a/code/Model/Submission/SubmittedForm.php b/code/Model/Submission/SubmittedForm.php index 32df390..df9b959 100755 --- a/code/Model/Submission/SubmittedForm.php +++ b/code/Model/Submission/SubmittedForm.php @@ -19,9 +19,9 @@ use SilverStripe\Security\Member; * @package userforms * @property int $SubmittedByID * @property int $ParentID - * @method Member SubmittedBy() * @method DataObject Parent() - * @method HasManyList|SubmittedFormField[] Values() + * @method Member SubmittedBy() + * @method HasManyList Values() */ class SubmittedForm extends DataObject { diff --git a/code/Model/Submission/SubmittedFormField.php b/code/Model/Submission/SubmittedFormField.php index cf7b703..7d68ac1 100755 --- a/code/Model/Submission/SubmittedFormField.php +++ b/code/Model/Submission/SubmittedFormField.php @@ -13,6 +13,7 @@ use SilverStripe\UserForms\Model\EditableFormField; * @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 index 4a62799..eaa2c20 100755 --- a/code/Model/UserDefinedForm.php +++ b/code/Model/UserDefinedForm.php @@ -9,6 +9,8 @@ use SilverStripe\UserForms\Control\UserDefinedFormController; /** * @package userforms + * @method SilverStripe\ORM\HasManyList EmailRecipients() + * @method SilverStripe\ORM\HasManyList Submissions() */ class UserDefinedForm extends Page {