tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

PATCH: improving @return values in docblocks

Browse Source
This commit is contained in:
Nicolaas 2020-07-23 22:40:14 +12:00 committed by GitHub
parent abc702e63a
commit f264ff8616
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/Forms/FieldList.php
View File

@ -380,7 +380,7 @@ class FieldList extends ArrayList
* @param FormField $newField The field object to replace with * @param FormField $newField The field object to replace with
* @param boolean $dataFieldOnly If this is true, then a field will only be replaced if it's a data field. Dataless * @param boolean $dataFieldOnly If this is true, then a field will only be replaced if it's a data field. Dataless
* fields, such as tabs, will be not be considered for replacement. * fields, such as tabs, will be not be considered for replacement.
* @return boolean TRUE field was successfully replaced * @return bool TRUE field was successfully replaced
* FALSE field wasn't found, nothing changed * FALSE field wasn't found, nothing changed
*/ */
public function replaceField($fieldName, $newField, $dataFieldOnly = true) public function replaceField($fieldName, $newField, $dataFieldOnly = true)
@ -404,7 +404,7 @@ class FieldList extends ArrayList
* *
* @param string $fieldName Name of field to rename title of * @param string $fieldName Name of field to rename title of
* @param string $newFieldTitle New title of field * @param string $newFieldTitle New title of field
* @return boolean * @return bool
*/ */
public function renameField($fieldName, $newFieldTitle) public function renameField($fieldName, $newFieldTitle)
{ {
@ -419,7 +419,7 @@ class FieldList extends ArrayList
} }
/** /**
* @return boolean * @return bool
*/ */
public function hasTabSet() public function hasTabSet()
{ {
@ -512,7 +512,7 @@ class FieldList extends ArrayList
* @todo Implement similarly to dataFieldByName() to support nested sets - or merge with dataFields() * @todo Implement similarly to dataFieldByName() to support nested sets - or merge with dataFields()
* *
* @param string $name * @param string $name
* @return FormField * @return FormField|null
*/ */
public function fieldByName($name) public function fieldByName($name)
{ {
@ -548,7 +548,7 @@ class FieldList extends ArrayList
* Use this if you're using nested FormFields. * Use this if you're using nested FormFields.
* *
* @param string $name The name of the field to return * @param string $name The name of the field to return
* @return FormField instance * @return FormField|null
*/ */
public function dataFieldByName($name) public function dataFieldByName($name)
{ {