Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MNT Update @methods on class docblocks #1257

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion code/Extension/UserFormFieldEditorExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**
* @method DataList|EditableFormField[] Fields()
* @method SilverStripe\ORM\HasManyList<EditableFormField> Fields()
*/
class UserFormFieldEditorExtension extends DataExtension
{
Expand Down
2 changes: 1 addition & 1 deletion code/Extension/UserFormFileExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

/**
* @property string $UserFormUpload
* @method File SubmittedFileField
* @method SubmittedFileField SubmittedFileField()
*/
class UserFormFileExtension extends DataExtension
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/EditableCustomRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
4 changes: 2 additions & 2 deletions code/Model/EditableFormField.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/EditableFormField/EditableFieldGroup.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/EditableFormField/EditableFileField.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* @property int $FolderConfirmed
* @property int $FolderID
* @property float $MaxFileSizeMB
* @method Folder Folder
* @method Folder Folder()
*/
class EditableFileField extends EditableFormField
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @see EditableDropdownField
*
* @package userforms
* @method HasManyList|EditableOption[] Options()
* @method HasManyList<EditableOption> Options()
*/
class EditableMultipleOptionField extends EditableFormField
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/EditableFormField/EditableOption.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion code/Model/Recipient/EmailRecipient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
4 changes: 2 additions & 2 deletions code/Model/Submission/SubmittedForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
1 change: 1 addition & 0 deletions code/Model/Submission/SubmittedFormField.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* @package userforms
* @property string $Name
* @property string $Value
* @method SubmittedForm Parent()
*/
class SubmittedFormField extends DataObject
{
Expand Down
2 changes: 2 additions & 0 deletions code/Model/UserDefinedForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down