Skip to content

Commit

Permalink
DOC Rename FormField method
Browse files Browse the repository at this point in the history
  • Loading branch information
emteknetnz committed Jan 21, 2025
1 parent b778111 commit 6ed834b
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion en/02_Developer_Guides/03_Forms/00_Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ class MyFormPageController extends PageController
echo $data['Email'];

// You can also fetch the value from the field.
echo $form->Fields()->dataFieldByName('Email')->Value();
echo $form->Fields()->dataFieldByName('Email')->getValue();

// Using the Form instance you can get / set status such as error messages.
$form->sessionMessage('Successful!', 'good');
Expand Down
4 changes: 2 additions & 2 deletions en/02_Developer_Guides/03_Forms/01_Validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ class FormFieldValidationExtension extends Extension
{
protected function updateValidate(ValidationResult $result): void
{
if (str_ends_with($this->owner->Value(), '@example.com')) {
if (str_ends_with($this->owner->getValue(), '@example.com')) {
$result->addFieldError(
$this->getOwner()->Name(),
'Please provide a valid email address which does not end with @example.com'
Expand Down Expand Up @@ -118,7 +118,7 @@ class CustomNumberField extends NumericField
public function validate(): ValidationResult
{
$this->beforeExtending('updateValidate', function (ValidationResult $result) {
if ((int) $this->Value() === 20) {
if ((int) $this->getValue() === 20) {
$result->addFieldError($this->Name(), 'This value cannot be 20');
}
});
Expand Down
2 changes: 1 addition & 1 deletion en/02_Developer_Guides/09_Security/05_Secure_Coding.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ class MyForm extends Form
}
```

- `FormField->Value()`
- `FormField->getValue()`
- URLParams passed to a Controller-method

Example:
Expand Down
1 change: 1 addition & 0 deletions en/08_Changelogs/6.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -1069,6 +1069,7 @@ As part of these changes [`ArrayList::find()`](api:SilverStripe\Model\List\Array
- `SilverStripe\ORM\DataExtension`, `SilverStripe\CMS\Model\SiteTreeExtension`, and `SilverStripe\Admin\LeftAndMainExtension` have been removed. If you subclass any of these classes, you must now subclass [`Extension`](api:SilverStripe\Core\Extension) directly instead.
- [`DBCurrency`](api:SilverStripe\ORM\FieldType\DBCurrency) will no longer parse numeric values contained in a string when calling `setValue()`. For instance "this is 50.29 dollars" will no longer be converted to "$50.29", instead its value will remain as "this is 50.29 dollars" and it will throw a validation exception if attempted to be written to the database.
- The `SilverStripe\Model\List\ArrayList.default_case_sensitive` configuration property has been removed. This means the default case sensitivity of `ArrayList` is now the same as any other list which uses search filters. If you were using that configuration property, or you were relying on `ArrayList` being case sensitive by default, you should double check that your list filters are working the way you expect. See [search filters](/developer_guides/model/searchfilters/#modifiers) for details about case sensitivity in search filters.
- `SilverStripe\Forms\FormField::Value()` has been split into to [`FormField::getValue()`](api:SilverStripe\Forms\FormField::getValue()) and [`FormField::getFormattedValue()`](api:SilverStripe\Forms\FormField::getFormattedValue()). If you have overridden this method in a subclass, you will need to update the method name, probably to `getFormattedValue()` as that's used for the frontend value, while `getValue()` is used for the internal form field value. If you have use `$Value` in a template to get the value of a form field, you will need to update it to `$FormattedValue` instead.

## Other changes

Expand Down

0 comments on commit 6ed834b

Please sign in to comment.