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

DOC Rename FormField method #670

Open
wants to merge 1 commit into
base: 6.0
Choose a base branch
from
Open
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 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 @@ -1088,6 +1088,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()) which usually returns an unmodified version of the field, and [`FormField::getFormattedValue()`](api:SilverStripe\Forms\FormField::getFormattedValue()) which is intended to be modified with things like localisation formatting. If you have overridden the `Value()` method in a subclass, you will need to update the method name, usuall to `getFormattedValue()`. If you have use `$Value` in a template to get the value of a form field, you will also need to update it to `$FormattedValue`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `SilverStripe\Forms\FormField::Value()` has been split into to [`FormField::getValue()`](api:SilverStripe\Forms\FormField::getValue()) which usually returns an unmodified version of the field, and [`FormField::getFormattedValue()`](api:SilverStripe\Forms\FormField::getFormattedValue()) which is intended to be modified with things like localisation formatting. If you have overridden the `Value()` method in a subclass, you will need to update the method name, usuall to `getFormattedValue()`. If you have use `$Value` in a template to get the value of a form field, you will also need to update it to `$FormattedValue`.
- `SilverStripe\Forms\FormField::Value()` has been split into to [`FormField::getValue()`](api:SilverStripe\Forms\FormField::getValue()) which usually returns an unmodified version of the value, and [`FormField::getFormattedValue()`](api:SilverStripe\Forms\FormField::getFormattedValue()) which is intended to be modified with things like localisation formatting and will be displayed to users. If you have overridden the `Value()` method in a subclass, you will need to update the method name to one of these, depending on the purpose of the custom functionality. If you use `$Value` in a template to get the value of a form field, you will need to update it to `$FormattedValue`.

This feels like it probably deserves its own section (I'd guess it's a fairly high-traffic method, and this is a fairly substantial amount of information) - but I won't block merging if you think it should stay here as a footnote.


## Other changes

Expand Down