Skip to content

Commit

Permalink
Merge branch '5.1' into 5.2
Browse files Browse the repository at this point in the history
  • Loading branch information
GuySartorelli committed Mar 18, 2024
2 parents c36df38 + c25922f commit dcd3331
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 46 deletions.
12 changes: 6 additions & 6 deletions src/Control/HTTPRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -463,9 +463,9 @@ public function offsetUnset(mixed $offset): void
* <code>$this->setResponse(HTTPRequest::send_file('the content', 'filename.txt'));</code>
*
* @static
* @param $fileData
* @param $fileName
* @param null $mimeType
* @param string $fileData
* @param string $fileName
* @param string|null $mimeType
* @return HTTPResponse
*/
public static function send_file($fileData, $fileName, $mimeType = null)
Expand Down Expand Up @@ -497,7 +497,7 @@ public static function send_file($fileData, $fileName, $mimeType = null)
* The pattern can optionally start with an HTTP method and a space. For example, "POST $Controller/$Action".
* This is used to define a rule that only matches on a specific HTTP method.
*
* @param $pattern
* @param string $pattern
* @param bool $shiftOnSuccess
* @return array|bool
*/
Expand Down Expand Up @@ -679,7 +679,7 @@ public function routeParams()
}

/**
* @param $params
* @param array $params
* @return HTTPRequest $this
*/
public function setRouteParams($params)
Expand Down Expand Up @@ -805,7 +805,7 @@ public function getIP()
* Sets the client IP address which originated this request.
* Use setIPFromHeaderValue if assigning from header value.
*
* @param $ip string
* @param string $ip
* @return $this
*/
public function setIP($ip)
Expand Down
4 changes: 2 additions & 2 deletions src/Forms/FileUploadReceiver.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ trait FileUploadReceiver
/**
* Parent data record. Will be inferred from parent form or controller if blank.
*
* @var DataObject
* @var ?DataObject
*/
protected $record;

Expand Down Expand Up @@ -78,7 +78,7 @@ public function setRecord($record)
* Get the record to use as "Parent" for uploaded Files (eg a Page with a has_one to File) If none is set, it will
* use Form->getRecord() or Form->Controller()->data()
*
* @return DataObject
* @return ?DataObject
*/
public function getRecord()
{
Expand Down
8 changes: 4 additions & 4 deletions src/Forms/Form.php
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ public function clearFormState()
/**
* Helper to get current request for this form
*
* @return HTTPRequest
* @return HTTPRequest|null
*/
protected function getRequest()
{
Expand Down Expand Up @@ -425,7 +425,7 @@ public function setSessionData($data)
/**
* Return any ValidationResult instance stored for this object
*
* @return ValidationResult The ValidationResult object stored in the session
* @return ValidationResult|null The ValidationResult object stored in the session
*/
public function getSessionValidationResult()
{
Expand Down Expand Up @@ -1479,7 +1479,7 @@ public function loadDataFrom($data, $mergeStrategy = 0, $fieldList = null)
* It will make use of setCastedField() to do this.
*
* @param ViewableData&DataObjectInterface $dataObject The object to save data into
* @param FieldList $fieldList An optional list of fields to process. This can be useful when you have a
* @param array<string>|null $fieldList An optional list of fields to process. This can be useful when you have a
* form that has some fields that save to one object, and some that save to another.
*/
public function saveInto(DataObjectInterface $dataObject, $fieldList = null)
Expand Down Expand Up @@ -1610,7 +1610,7 @@ public function renderWithoutActionButton($template)
* Return the default button that should be clicked when another one isn't
* available.
*
* @return FormAction
* @return FormAction|null
*/
public function defaultAction()
{
Expand Down
12 changes: 11 additions & 1 deletion src/Forms/NumericField.php
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,20 @@ protected function getNumberType()
return NumberFormatter::TYPE_DOUBLE;
}

/**
* In some cases and locales, validation expects non-breaking spaces.
* This homogenises regular, narrow and thin non-breaking spaces to a regular space character.
*
*/
private function clean(?string $value): string
{
return trim(str_replace(["\u{00A0}", "\u{202F}", "\u{2009}"], ' ', $value ?? ''));
}

public function setSubmittedValue($value, $data = null)
{
// Save original value in case parse fails
$value = trim($value ?? '');
$value = $this->clean($value);
$this->originalValue = $value;

// Empty string is no-number (not 0)
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/DataList.php
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ public function distinct($value)
*
* Raw SQL is not accepted, only actual field names can be passed
*
* @param string|array $args
* @param string|array|null $args
* @example $list = $list->sort('Name'); // default ASC sorting
* @example $list = $list->sort('"Name"'); // field names can have double quotes around them
* @example $list = $list->sort('Name ASC, Age DESC');
Expand Down
43 changes: 11 additions & 32 deletions tests/php/Forms/NumericFieldTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,6 @@ class NumericFieldTest extends SapphireTest
{
protected $usesDatabase = false;

/**
* In some cases and locales, validation expects non-breaking spaces.
* This homogenises narrow and regular NBSPs to a regular space character
*
* Duplicates non-public NumericField::clean method
*
* @param string $input
* @return string The input value, with all non-breaking spaces replaced with spaces
*/
protected function clean($input)
{
return str_replace(
[
html_entity_decode('&nbsp;', 0, 'UTF-8'),
html_entity_decode('&#8239;', 0, 'UTF-8'), // narrow non-breaking space
],
' ',
trim($input ?? '')
);
}

/**
* Test that data loaded in via Form::loadDataFrom(DataObject) will populate the field correctly,
* and can format the database value appropriately for the frontend
Expand Down Expand Up @@ -64,8 +43,8 @@ public function testSetValue($locale, $scale, $input, $output)

// Test expected formatted value
$this->assertEquals(
$this->clean($output),
$this->clean($field->Value()),
(string) $output,
$field->Value(),
"Expected $input to be formatted as $output in locale $locale"
);

Expand All @@ -92,11 +71,11 @@ public function dataForTestSetValue()
['nl_NL', null, '12.1', '12,1'],
['nl_NL', 1, '14000.5', "14.000,5"],
// fr
['fr_FR', 0, '13000', "13 000"],
['fr_FR', 0, '13000', "13000"], // With a narrow non breaking space
['fr_FR', 0, '15', '15'],
['fr_FR', null, '12.0', '12,0'],
['fr_FR', null, '12.1', '12,1'],
['fr_FR', 1, '14000.5', "14 000,5"],
['fr_FR', 1, '14000.5', "14000,5"], // With a narrow non breaking space
// us
['en_US', 0, '13000', "13,000"],
['en_US', 0, '15', '15'],
Expand Down Expand Up @@ -172,15 +151,15 @@ public function dataForTestSubmittedValue()
['nl_NL', 1, '15,000.5', false],

// fr
['fr_FR', 0, '13000', 13000, '13 000'],
['fr_FR', 0, '13000', 13000, '13000'], // With a narrow non breaking space
['fr_FR', 2, '12,00', 12.0],
['fr_FR', 2, '12.00', false],
['fr_FR', 1, '11 000', 11000, '11 000,0'],
['fr_FR', 0, '11.000', 11000, '11 000'],
['fr_FR', 1, '11 000', 11000, '11000,0'], // With a narrow non breaking space
['fr_FR', 0, '11.000', 11000, '11000'], // With a narrow non breaking space
['fr_FR', null, '11,000', 11.000, '11,0'],
['fr_FR', 1, '15 000,5', 15000.5],
['fr_FR', 1, '15 000,5', 15000.5, '15 000,5'], // With a narrow non breaking space
['fr_FR', 1, '15 000.5', false],
['fr_FR', 1, '15.000,5', 15000.5, '15 000,5'],
['fr_FR', 1, '15.000,5', 15000.5, '15000,5'], // With a narrow non breaking space
['fr_FR', 1, '15,000.5', false],
// us
['en_US', 0, '13000', 13000, '13,000'],
Expand Down Expand Up @@ -257,8 +236,8 @@ public function testSetSubmittedValue($locale, $scale, $submittedValue, $dataVal
$cleanedInput = $submittedValue;
}
$this->assertEquals(
$this->clean($cleanedInput),
$this->clean($field->Value()),
$cleanedInput,
$field->Value(),
"Expected input $submittedValue to be cleaned up as $cleanedInput in locale $locale"
);
}
Expand Down

0 comments on commit dcd3331

Please sign in to comment.