TPS
/
ORIENT
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use old signature for `where` method in CmsObjectCollection. 

Refs: https://github.com/octobercms/october/pull/4893#discussion_r368408407
This commit is contained in:
Ben Thomson 2020-01-20 16:25:50 +08:00
parent 0a63720335
commit 11b7111413
1 changed files with 14 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
modules/cms/classes/CmsObjectCollection.php
View File

@ -39,38 +39,31 @@ class CmsObjectCollection extends CollectionBase
/**
* Returns objects whose properties match the supplied value.
*
* This is a wrapper for our custom `applyWhereFilter` method, as the signature of this method changed in Laravel 6.
* Note that this deviates from Laravel 6's Illuminate\Support\Traits\EnumeratesValues::where() method signature,
* which uses ($key, $operator = null, $value = null) as parameters and that this class extends.
*
* @param string $key
* @param mixed $operator
* @param mixed $value
* To ensure backwards compatibility with our current Halcyon functionality, this method retains the original
* parameters and functions the same way as before, with handling for the $value and $strict parameters to ensure
* they match the previously expected formats. This means that you cannot use operators for "where" queries on
* CMS object collections.
*
* @param string $property
* @param string $value
* @param bool $strict
* @return static
*/
public function where($key, $operator = null, $value = null)
public function where($property, $value = null, $strict = null)
{
if (empty($operator) || !is_string($operator)) {
if (empty($value) || !is_string($value)) {
throw new ApplicationException('You must provide a string value to compare with when executing a "where" '
. 'query for CMS object collections.');
}
if (!isset($value) || !is_bool($value)) {
$value = true;
if (!isset($strict) || !is_bool($strict)) {
$strict = true;
}
return $this->applyWhereFilter($key, $operator, $value);
}
/**
* Returns objects whose properties match the supplied value.
* @param string $property
* @param string $value
* @param bool $strict
* @return static
*/
protected function applyWhereFilter($property, $value, $strict = true)
{
return $this->filter(function ($object) use ($property, $value, $strict) {
if (!array_key_exists($property, $object->settings)) {
return false;
}