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

Merge release 3.6.2 into 3.7.x #41

Merged
merged 8 commits into from
Dec 8, 2021
Merged

Merge release 3.6.2 into 3.7.x #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e463a45
[3.6] Regression: ArrayObject with protected ARRAY_AS_PROPS cannot be…
Slamdunk Nov 29, 2021
e330333
Tests green again
Slamdunk Nov 29, 2021
1751b3f
CI happy again?
Slamdunk Nov 29, 2021
9149326
Finally
Slamdunk Nov 29, 2021
17ff7fc
Update src/ArrayObject.php
Slamdunk Dec 1, 2021
d844fcf
Fix syntax errors
Slamdunk Dec 1, 2021
724894b
PHPCS
Slamdunk Dec 1, 2021
6fe0842
Merge pull request #39 from Slamdunk/array_object_as_props_bug
weierophinney Dec 7, 2021
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
72 changes: 67 additions & 5 deletions psalm-baseline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@
<code>$this-&gt;storage[$key]</code>
<code>$this-&gt;storage[$key]</code>
</MixedArrayOffset>
<MixedAssignment occurrences="2">
<MixedAssignment occurrences="4">
<code>$flag</code>
<code>$ret</code>
<code>$ret</code>
<code>$v</code>
</MixedAssignment>
<MoreSpecificReturnType occurrences="1">
<code>Iterator</code>
Expand All @@ -58,6 +60,14 @@
<code>is_callable($function)</code>
<code>is_callable($function)</code>
</RedundantConditionGivenDocblockType>
<UndefinedAttributeClass occurrences="6">
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/ArrayUtils.php">
<DocblockTypeContradiction occurrences="1">
Expand Down Expand Up @@ -158,6 +168,14 @@
<code>$this-&gt;values</code>
<code>$this-&gt;values</code>
</PossiblyNullArrayOffset>
<UndefinedAttributeClass occurrences="6">
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/Glob.php">
<InvalidOperand occurrences="2">
Expand Down Expand Up @@ -205,6 +223,9 @@
<MixedAssignment occurrences="1">
<code>$this[$name]</code>
</MixedAssignment>
<UndefinedAttributeClass occurrences="1">
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/PriorityList.php">
<InvalidReturnStatement occurrences="1">
Expand All @@ -223,6 +244,14 @@
<code>(int) $priority</code>
<code>(int) $priority</code>
</RedundantCastGivenDocblockType>
<UndefinedAttributeClass occurrences="6">
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/PriorityQueue.php">
<DocblockTypeContradiction occurrences="1">
Expand Down Expand Up @@ -292,6 +321,10 @@
<RedundantConditionGivenDocblockType occurrences="1">
<code>null !== $this-&gt;queue</code>
</RedundantConditionGivenDocblockType>
<UndefinedAttributeClass occurrences="2">
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/SplPriorityQueue.php">
<ImplementedReturnTypeMismatch occurrences="1">
Expand All @@ -305,7 +338,6 @@
<code>$data[]</code>
<code>$item</code>
<code>$item</code>
<code>$item</code>
</MixedAssignment>
</file>
<file src="src/SplQueue.php">
Expand All @@ -314,13 +346,25 @@
<code>$item</code>
<code>$item</code>
</MixedAssignment>
<UndefinedAttributeClass occurrences="4">
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/SplStack.php">
<MixedAssignment occurrences="3">
<code>$array[]</code>
<code>$item</code>
<code>$item</code>
</MixedAssignment>
<UndefinedAttributeClass occurrences="4">
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
<code>ReturnTypeWillChange</code>
</UndefinedAttributeClass>
</file>
<file src="src/StringUtils.php">
<DocblockTypeContradiction occurrences="2">
Expand Down Expand Up @@ -377,9 +421,7 @@
</RedundantCastGivenDocblockType>
</file>
<file src="src/StringWrapper/Iconv.php">
<PossiblyNullArgument occurrences="4">
<code>$length</code>
<code>$this-&gt;getEncoding()</code>
<PossiblyNullArgument occurrences="2">
<code>$this-&gt;getEncoding()</code>
<code>$this-&gt;getEncoding()</code>
</PossiblyNullArgument>
Expand Down Expand Up @@ -424,6 +466,12 @@
<code>$ar['foo']['bar']</code>
<code>$ar['foo']['bar']</code>
</MixedArrayAccess>
<MixedAssignment occurrences="1">
<code>$unserialized</code>
</MixedAssignment>
<MixedMethodCall occurrences="1">
<code>isImmutable</code>
</MixedMethodCall>
<RedundantConditionGivenDocblockType occurrences="1">
<code>assertSame</code>
</RedundantConditionGivenDocblockType>
Expand Down Expand Up @@ -500,6 +548,20 @@
<code>$this-&gt;helper</code>
</UndefinedThisPropertyFetch>
</file>
<file src="test/CustomArrayObject.php">
<MissingPropertyType occurrences="1">
<code>$isImmutable</code>
</MissingPropertyType>
<MixedInferredReturnType occurrences="1">
<code>bool</code>
</MixedInferredReturnType>
<MixedReturnStatement occurrences="1">
<code>$this-&gt;isImmutable</code>
</MixedReturnStatement>
<PropertyNotSetInConstructor occurrences="1">
<code>CustomArrayObject</code>
</PropertyNotSetInConstructor>
</file>
<file src="test/ErrorHandlerTest.php">
<ArgumentTypeCoercion occurrences="3">
<code>'ErrorException'</code>
Expand Down
81 changes: 41 additions & 40 deletions src/ArrayObject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Serializable;
use UnexpectedValueException;

use function array_key_exists;
use function array_keys;
use function asort;
use function class_exists;
Expand Down Expand Up @@ -92,7 +93,7 @@ public function __isset($key)
}

if (in_array($key, $this->protectedProperties)) {
throw new Exception\InvalidArgumentException('$key is a protected property, use a different key');
throw new Exception\InvalidArgumentException("$key is a protected property, use a different key");
}

return isset($this->$key);
Expand All @@ -113,7 +114,7 @@ public function __set($key, $value)
}

if (in_array($key, $this->protectedProperties)) {
throw new Exception\InvalidArgumentException('$key is a protected property, use a different key');
throw new Exception\InvalidArgumentException("$key is a protected property, use a different key");
}

$this->$key = $value;
Expand All @@ -133,7 +134,7 @@ public function __unset($key)
}

if (in_array($key, $this->protectedProperties)) {
throw new Exception\InvalidArgumentException('$key is a protected property, use a different key');
throw new Exception\InvalidArgumentException("$key is a protected property, use a different key");
}

unset($this->$key);
Expand All @@ -154,7 +155,7 @@ public function &__get($key)
}

if (in_array($key, $this->protectedProperties, true)) {
throw new Exception\InvalidArgumentException('$key is a protected property, use a different key');
throw new Exception\InvalidArgumentException("$key is a protected property, use a different key");
}

return $this->$key;
Expand Down Expand Up @@ -462,43 +463,43 @@ public function __unserialize($data)
{
$this->protectedProperties = array_keys(get_object_vars($this));

foreach ($data as $k => $v) {
switch ($k) {
case 'flag':
$this->setFlags((int) $v);
break;

case 'storage':
if (! is_array($v) && ! is_object($v)) {
throw new UnexpectedValueException(sprintf(
'Cannot deserialize %s instance: corrupt storage data;'
. ' expected array or object, received %s',
self::class,
gettype($v)
));
}

$this->exchangeArray($v);
break;

case 'iteratorClass':
if (! is_string($v)) {
throw new UnexpectedValueException(sprintf(
'Cannot deserialize %s instance: invalid iteratorClass; expected string, received %s',
self::class,
is_object($v) ? get_class($v) : gettype($v)
));
}

$this->setIteratorClass($v);
break;

case 'protectedProperties':
break;

default:
$this->__set($k, $v);
// Unserialize protected internal properties first
if (array_key_exists('flag', $data)) {
$this->setFlags((int) $data['flag']);
unset($data['flag']);
}

if (array_key_exists('storage', $data)) {
if (! is_array($data['storage']) && ! is_object($data['storage'])) {
throw new UnexpectedValueException(sprintf(
'Cannot deserialize %s instance: corrupt storage data; expected array or object, received %s',
self::class,
gettype($data['storage'])
));
}
$this->exchangeArray($data['storage']);
unset($data['storage']);
}

if (array_key_exists('iteratorClass', $data)) {
if (! is_string($data['iteratorClass'])) {
throw new UnexpectedValueException(sprintf(
'Cannot deserialize %s instance: invalid iteratorClass; expected string, received %s',
self::class,
is_object($data['iteratorClass'])
? get_class($data['iteratorClass'])
: gettype($data['iteratorClass'])
));
}
$this->setIteratorClass($data['iteratorClass']);
unset($data['iteratorClass']);
}

unset($data['protectedProperties']);

// Unserialize array keys after resolving protected properties to ensure configuration is used.
foreach ($data as $k => $v) {
$this->__set($k, $v);
}
}
}
11 changes: 11 additions & 0 deletions test/ArrayObjectTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,4 +401,15 @@ public function testSerializationRestoresProperties(): void

self::assertEquals($ar, unserialize(serialize($ar)));
}

public function testSerializationRestoresProtectedProperties(): void
{
$ar = new CustomArrayObject([], ArrayObject::ARRAY_AS_PROPS);
self::assertTrue($ar->isImmutable());

$serialized = serialize($ar);
$unserialized = unserialize($serialized);

self::assertTrue($unserialized->isImmutable());
}
}
18 changes: 18 additions & 0 deletions test/CustomArrayObject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

declare(strict_types=1);

namespace LaminasTest\Stdlib;

use Laminas\Stdlib\ArrayObject;

final class CustomArrayObject extends ArrayObject
{
/** @var bool */
protected $isImmutable = true;

public function isImmutable(): bool
{
return $this->isImmutable;
}
}