Skip to content

Separates XML attribute and child element lookup #72

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

Closed
NickSdot wants to merge 2 commits into from
Closed

Separates XML attribute and child element lookup #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea0523d
fix: separate XML attribute and child element lookup
NickSdot Oct 13, 2026
d58069b
fix: exclude legacy attribute aliases from child decoding
NickSdot Oct 13, 2026
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
35 changes: 34 additions & 1 deletion src/Encoder/ObjectAccess.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Soap\Engine\Metadata\Model\Type;
use Soap\Engine\Metadata\Model\TypeMeta;
use VeeWee\Reflecta\Iso\IsoInterface;
use VeeWee\Reflecta\Lens\Lens;
use VeeWee\Reflecta\Lens\LensInterface;
use function Psl\Vec\sort_by;
use function VeeWee\Reflecta\Lens\index;
Expand Down Expand Up @@ -137,12 +138,44 @@ private static function createDecoderLensForType(
$lens = match(true) {
$encoder instanceof Feature\DecoratingEncoder => self::createDecoderLensForType($shouldLensBeOptional, $name, $encoder->decoratedEncoder(), $type, $property),
$encoder instanceof Feature\ProvidesObjectDecoderLens => $encoder::createObjectDecoderLens($type, $property),
default => index($name),
default => $property->getType()->getMeta()->isAttribute()->unwrapOr(false)
? self::createAttributeDecoderLens($property)
: self::createElementDecoderLens($name),
};

return $shouldLensBeOptional ? optional($lens) : $lens;
}

/**
* @return LensInterface<array<array-key, mixed>|null, array<array-key, mixed>|null, mixed, mixed>
*/
private static function createAttributeDecoderLens(Property $property): LensInterface
{
$type = $property->getType();
$namespace = $type->getMeta()->isQualified()->unwrapOr(false)
? $type->getXmlTargetNamespace()
: '';

return index('@{' . $namespace . '}' . $property->getName());
}

/**
* @return LensInterface<array<array-key, mixed>|null, array<array-key, mixed>|null, mixed, mixed>
*/
private static function createElementDecoderLens(string $name): LensInterface
{
if ($name === '_') {
return index($name);
}

return Lens::readonly(static function (array $nodes) use ($name): Element|ElementList|null {
/** @var mixed $value */
$value = $nodes[$name] ?? null;

return $value instanceof Element || $value instanceof ElementList ? $value : null;
});
}

private static function shouldLensBeOptional(TypeMeta $meta): bool
{
if ($meta->isNullable()->unwrapOr(false)) {
Expand Down
16 changes: 15 additions & 1 deletion src/Xml/Reader/DocumentToLookupArrayReader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
use Soap\Encoding\Xml\Node\Element;
use Soap\Encoding\Xml\Node\ElementList;
use VeeWee\Xml\Xmlns\Xmlns;
use function array_key_exists;
use function in_array;
use function VeeWee\Xml\Dom\Predicate\is_element;

/**
Expand Down Expand Up @@ -61,7 +63,19 @@ public function __invoke(Element $xml): array
$attributes = $root->attributes;
foreach ($attributes as $attribute) {
$key = $attribute->localName;
$nodes[$key] = $attribute->value;
$namespace = $attribute->namespaceURI ?? '';
$nodes['@{' . $namespace . '}' . $key] = $attribute->value;

// Retain legacy custom-lens keys without replacing child elements.
// Protocol attributes must not masquerade as schema element values.
if (!array_key_exists($key, $nodes) && !in_array($namespace, [
Xmlns::xsi()->value(),
'http://www.w3.org/2000/xmlns/',
'http://schemas.xmlsoap.org/soap/encoding/',
'http://www.w3.org/2003/05/soap-encoding',
], true)) {
$nodes[$key] = $attribute->value;
}
}

return $nodes;
Expand Down
129 changes: 129 additions & 0 deletions tests/Unit/Encoder/ObjectXmlLookupTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<?php
declare(strict_types=1);

namespace Soap\Encoding\Test\Unit\Encoder;

use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
use Soap\Encoding\Encoder\ObjectAccess;
use Soap\Encoding\Encoder\ObjectEncoder;
use Soap\Encoding\Test\Unit\ContextCreatorTrait;
use Soap\Encoding\Xml\Node\Element;
use Soap\Encoding\Xml\Node\ElementList;
use Soap\Encoding\Xml\Reader\DocumentToLookupArrayReader;
use Soap\WsdlReader\Model\Definitions\BindingUse;
use stdClass;

#[CoversClass(ObjectEncoder::class), CoversClass(ObjectAccess::class), CoversClass(DocumentToLookupArrayReader::class)]
final class ObjectXmlLookupTest extends TestCase
{
use ContextCreatorTrait;

/** @return iterable<string, array{string, string, object}> */
public static function lookup_cases(): iterable
{
yield 'child type survives xsi:type' => [
'<sequence><element name="type" type="xsd:string" minOccurs="0"/></sequence>',
'<testType xmlns:tns="https://test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="tns:testType"><type>child</type></testType>',
(object) ['type' => 'child'],
];
yield 'protocol type does not invent missing child' => [
'<sequence><element name="type" type="xsd:string" minOccurs="0"/></sequence>',
'<testType xmlns:tns="https://test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="tns:testType"/>',
(object) ['type' => null],
];
yield 'ordinary attribute does not invent missing child' => [
'<sequence><element name="type" type="xsd:string" minOccurs="0"/></sequence>',
'<testType type="attribute"/>',
(object) ['type' => null],
];
yield 'simple content remains available' => [
'<simpleContent><extension base="xsd:string"><attribute name="label" type="xsd:string"/></extension></simpleContent>',
'<testType label="attribute">content</testType>',
(object) ['_' => 'content', 'label' => 'attribute'],
];
yield 'unqualified schema type attribute survives xsi:type' => [
'<attribute name="type" type="xsd:string" use="required"/>',
'<testType xmlns:tns="https://test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" type="schema" xsi:type="tns:testType"/>',
(object) ['type' => 'schema'],
];
yield 'qualified schema attribute ignores unqualified namesake' => [
'<attribute name="label" type="xsd:string" form="qualified" use="required"/>',
'<testType xmlns:t="https://test" t:label="correct" label="wrong"/>',
(object) ['label' => 'correct'],
];
yield 'unqualified schema attribute ignores qualified namesake' => [
'<attribute name="label" type="xsd:string" use="required"/>',
'<testType xmlns:t="https://test" label="correct" t:label="wrong"/>',
(object) ['label' => 'correct'],
];
}

#[Test, DataProvider('lookup_cases')]
public function default_decoder_lenses_distinguish_children_and_attribute_namespaces(string $properties, string $xml, object $expected): void
{
$schema = '<complexType name="testType">' . $properties . '</complexType>';
$metadata = self::createMetadataFromWsdl($schema, 'type="tns:testType"');
$context = self::createContextFromMetadata($metadata, 'testType')->withBindingUse(BindingUse::LITERAL);
$iso = new ObjectEncoder(stdClass::class)->iso($context);

$actual = $iso->from($xml);

static::assertEquals($expected, $actual);
}

#[Test]
public function nested_repeated_type_children_survive_protocol_type_attributes(): void
{
$schema = <<<'XML'
<complexType name="Child"><sequence>
<element name="type" type="xsd:string"/>
</sequence></complexType>
<complexType name="testType"><sequence>
<element name="child" type="tns:Child" maxOccurs="unbounded"/>
</sequence></complexType>
XML;
$metadata = self::createMetadataFromWsdl($schema, 'type="tns:testType"');
$context = self::createContextFromMetadata($metadata, 'testType')->withBindingUse(BindingUse::LITERAL);
$iso = new ObjectEncoder(stdClass::class)->iso($context);
$xml = <<<'XML'
<testType xmlns:tns="https://test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<child xsi:type="tns:Child"><type>first</type></child>
<child xsi:type="tns:Child"><type>second</type></child>
</testType>
XML;

$actual = $iso->from($xml);

static::assertEquals((object) [
'child' => [(object) ['type' => 'first'], (object) ['type' => 'second']],
], $actual);
}

#[Test]
public function lookup_keeps_repeated_children_and_qualified_attribute_keys(): void
{
$reader = new DocumentToLookupArrayReader();
$xml = Element::fromString('<item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Record" type="attribute"><type>first</type><type>second</type></item>');

$lookup = $reader($xml);

static::assertInstanceOf(ElementList::class, $lookup['type']);
static::assertCount(2, $lookup['type']);
static::assertSame('attribute', $lookup['@{}type']);
static::assertSame('Record', $lookup['@{http://www.w3.org/2001/XMLSchema-instance}type']);
}

#[Test]
public function nonconflicting_legacy_attribute_keys_remain_available_for_custom_lenses(): void
{
$reader = new DocumentToLookupArrayReader();

$lookup = $reader(Element::fromString('<item label="text"/>'));

static::assertSame('text', $lookup['label']);
static::assertSame('text', $lookup['@{}label']);
}
}