Skip to content

Deprecate many ArrayIterator methods that are aliases to ArrayObject ones #7345

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Deprecate many ArrayIterator methods that are aliases to ArrayObject ones #7345

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
10 changes: 10 additions & 0 deletions ext/spl/spl_array.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,60 +126,70 @@ public function getArrayCopy(): array {}
public function count(): int {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::getFlags
*/
public function getFlags(): int {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::setFlags
*/
public function setFlags(int $flags): void {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::asort
*/
public function asort(int $flags = SORT_REGULAR): bool {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::ksort
*/
public function ksort(int $flags = SORT_REGULAR): bool {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::uasort
*/
public function uasort(callable $callback): bool {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::uksort
*/
public function uksort(callable $callback): bool {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::natsort
*/
public function natsort(): bool {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::natcasesort
*/
public function natcasesort(): bool {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::unserialize
*/
public function unserialize(string $data): void {}

/**
* @deprecated
* @tentative-return-type
* @implementation-alias ArrayObject::serialize
*/
Expand Down
22 changes: 11 additions & 11 deletions ext/spl/spl_array_arginfo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* This is a generated file, edit the .stub.php file instead.
* Stub hash: e8e9909c2548a2259ba58ecf9f2ad6fe5add70f4 */
* Stub hash: aea359465f8fd8c8c5eabc998a36e90628432db9 */

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_ArrayObject___construct, 0, 0, 0)
ZEND_ARG_TYPE_MASK(0, array, MAY_BE_ARRAY|MAY_BE_OBJECT, "[]")
Expand Down Expand Up @@ -228,16 +228,16 @@ static const zend_function_entry class_ArrayIterator_methods[] = {
ZEND_MALIAS(ArrayObject, append, append, arginfo_class_ArrayIterator_append, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, getArrayCopy, getArrayCopy, arginfo_class_ArrayIterator_getArrayCopy, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, count, count, arginfo_class_ArrayIterator_count, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, getFlags, getFlags, arginfo_class_ArrayIterator_getFlags, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, setFlags, setFlags, arginfo_class_ArrayIterator_setFlags, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, asort, asort, arginfo_class_ArrayIterator_asort, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, ksort, ksort, arginfo_class_ArrayIterator_ksort, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, uasort, uasort, arginfo_class_ArrayIterator_uasort, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, uksort, uksort, arginfo_class_ArrayIterator_uksort, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, natsort, natsort, arginfo_class_ArrayIterator_natsort, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, natcasesort, natcasesort, arginfo_class_ArrayIterator_natcasesort, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, unserialize, unserialize, arginfo_class_ArrayIterator_unserialize, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, serialize, serialize, arginfo_class_ArrayIterator_serialize, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, getFlags, getFlags, arginfo_class_ArrayIterator_getFlags, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, setFlags, setFlags, arginfo_class_ArrayIterator_setFlags, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, asort, asort, arginfo_class_ArrayIterator_asort, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, ksort, ksort, arginfo_class_ArrayIterator_ksort, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, uasort, uasort, arginfo_class_ArrayIterator_uasort, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, uksort, uksort, arginfo_class_ArrayIterator_uksort, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, natsort, natsort, arginfo_class_ArrayIterator_natsort, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, natcasesort, natcasesort, arginfo_class_ArrayIterator_natcasesort, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, unserialize, unserialize, arginfo_class_ArrayIterator_unserialize, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, serialize, serialize, arginfo_class_ArrayIterator_serialize, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
ZEND_MALIAS(ArrayObject, __serialize, __serialize, arginfo_class_ArrayIterator___serialize, ZEND_ACC_PUBLIC)
ZEND_MALIAS(ArrayObject, __unserialize, __unserialize, arginfo_class_ArrayIterator___unserialize, ZEND_ACC_PUBLIC)
ZEND_ME(ArrayIterator, rewind, arginfo_class_ArrayIterator_rewind, ZEND_ACC_PUBLIC)
Expand Down
5 changes: 3 additions & 2 deletions ext/spl/tests/arrayIterator_ksort_basic1.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ var_dump($arrIter->ksort());
var_dump($arrIter);

?>
--EXPECT--
--EXPECTF--
Deprecated: Method ArrayIterator::ksort() is deprecated in %s on line %d
bool(true)
object(ArrayIterator)#1 (1) {
object(ArrayIterator)#%d (1) {
["storage":"ArrayIterator":private]=>
array(3) {
[1]=>
Expand Down
4 changes: 2 additions & 2 deletions ext/spl/tests/arrayObject_getFlags_basic2.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ var_dump($ao->getFlags());

$ao2 = new ArrayObject($ao);
var_dump($ao2->getFlags());
var_dump($ao2->getIterator()->getFlags());
Copy link
Member

Choose a reason for hiding this comment

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

I'd prefer to just switch off E-DEPRECATED in ini settings instead of using error_reporting(0). Is there a problem in fixing the test cases to avoid the deprecation warning or just silencing E_DEPRECATED?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ignoring E_DEPRECATED is fine with me.

@var_dump($ao2->getIterator()->getFlags());

$ai = new ArrayIterator($ao);
var_dump($ai->getFlags());
@var_dump($ai->getFlags());

$ao2 = new ArrayObject($ao, 0);
var_dump($ao2->getFlags());
Expand Down
10 changes: 6 additions & 4 deletions ext/spl/tests/array_017.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,17 @@ class ArrayIteratorEx extends ArrayIterator
function dump()
{
echo __METHOD__ . "()\n";
var_dump(array('Flags'=>$this->getFlags()
,'OVars'=>get_object_vars($this)
,'$this'=>$this));
var_dump([
'Flags' => @$this->getFlags(),
'OVars' => get_object_vars($this),
'$this' => $this,
]);
}

function setFlags($flags): void
{
echo __METHOD__ . "($flags)\n";
ArrayIterator::setFlags($flags);
@ArrayIterator::setFlags($flags);
}
}

Expand Down
3 changes: 2 additions & 1 deletion ext/spl/tests/bug46115.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ $x = new reflectionmethod('RecursiveArrayIterator', 'asort');
$z = $x->invoke($h);
?>
DONE
--EXPECT--
--EXPECTF--
Deprecated: Method ArrayIterator::asort() is deprecated in %s on line %d
DONE
7 changes: 6 additions & 1 deletion ext/spl/tests/bug67539.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,10 @@ function badsort($a, $b) {

$it->uksort('badsort');
?>
--EXPECT--
--EXPECTF--
Deprecated: Method ArrayIterator::uksort() is deprecated in %s on line %d

Deprecated: Method ArrayIterator::serialize() is deprecated in %s on line %d

Deprecated: Method ArrayIterator::unserialize() is deprecated in %s on line %d
Modification of ArrayObject during sorting is prohibited