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.

Sign up for GitHub

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

ENH Remove code that had been retained for backwards compatibility #11541

Merged
merged 1 commit into from
Jan 9, 2025
Merged

ENH Remove code that had been retained for backwards compatibility #11541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 2 additions & 26 deletions src/Forms/Form.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1338,32 +1338,8 @@ public function validate(): ValidationResult
* form that has some fields that save to one object, and some that save to another.
* @return $this
*/
public function loadDataFrom($data, $mergeStrategy = 0, $fieldList = null)
public function loadDataFrom(object|array $data, int $mergeStrategy = 0, array $fieldList = [])
{
if (!is_object($data) && !is_array($data)) {
user_error("Form::loadDataFrom() not passed an array or an object", E_USER_WARNING);
return $this;
}
Comment on lines -1341 to -1346
Copy link
Member Author

Choose a reason for hiding this comment

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

Adding strong typing here seems sensible.

  • object|array is already enforced for $data by the user_error.
  • int is now the only valid type for $mergeStrategy
  • array is already enforced for $fieldList by its use in in_array()


// Handle the backwards compatible case of passing "true" as the second argument
if ($mergeStrategy === true) {
Deprecation::notice(
'5.4.0',
'Passing `true` to the $mergeStrategy argument in ' . Form::class . '::loadDataFrom() is deprecated.'
. ' Pass ' . Form::class . '::MERGE_CLEAR_MISSING instead.',
Deprecation::SCOPE_GLOBAL
);
$mergeStrategy = Form::MERGE_CLEAR_MISSING;
} elseif ($mergeStrategy === false) {
Deprecation::notice(
'5.4.0',
'Passing `false` to the $mergeStrategy argument in ' . Form::class . '::loadDataFrom() is deprecated.'
. ' Pass 0 instead.',
Deprecation::SCOPE_GLOBAL
);
$mergeStrategy = 0;
}

// If an object is passed, save it for historical reference through {@link getRecord()}
// Also use this to determine if we are loading a submitted form, or loading
// from a record
Expand Down Expand Up @@ -1392,7 +1368,7 @@ public function loadDataFrom($data, $mergeStrategy = 0, $fieldList = null)
$name = $field->getName();

// Skip fields that have been excluded
if ($fieldList && !in_array($name, $fieldList ?? [])) {
if (!empty($fieldList) && !in_array($name, $fieldList)) {
continue;
}

Expand Down
11 changes: 2 additions & 9 deletions src/ORM/Connect/MySQLDatabase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,16 +207,9 @@ public function searchEngine(
}
}

// Always ensure that only pages with ShowInSearch = 1 can be searched
// Always ensure that only pages/files with ShowInSearch = 1 can be searched
$extraFilters[$pageClass] .= " AND ShowInSearch <> 0";

// File.ShowInSearch was added later, keep the database driver backwards compatible
// by checking for its existence first
$fileTable = DataObject::getSchema()->tableName($fileClass);
$fields = $this->getSchemaManager()->fieldList($fileTable);
if (array_key_exists('ShowInSearch', $fields ?? [])) {
$extraFilters[$fileClass] .= " AND ShowInSearch <> 0";
}
$extraFilters[$fileClass] .= " AND ShowInSearch <> 0";
Comment on lines -210 to +212
Copy link
Member Author

Choose a reason for hiding this comment

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

That db column will always be present now.


$limit = (int)$start . ", " . (int)$pageLength;

Expand Down
Loading