Decoding exception from valid(?) parameter

[Harkonn]

Bug Report

Q	A
BC Break	yes/no
Version	4.5.0

Summary

The mapping for Code inside of FristtypErweiterbar throws an exception:

Phpro\SoapClient\Exception\SoapException: Failed decoding type Soap\Encoding\Xml\Node\Element as {http://xoev.de/schemata/xzufi/2_2_0:leistungen.antwort.leistung.040104}. Failed at path "parameters.antwort.ergebnis.leistung.modulFrist.frist.typ.code". in Phpro\SoapClient\Exception\SoapException::fromThrowable() (line 19 of projectpath/vendor/phpro/soap-client/src/Phpro/SoapClient/Exception/SoapException.php).

Snipped SOAP responce code for struktur (full code is below):

<xzufi:modulFrist>
	<xzufi:frist>
		<xzufi:typ>
			<xzufi:code listURI="urn:xoev-de:fim:codeliste:xzufi.fristtyp" listVersionID="1.2">
				<code>005</code>
			</xzufi:code>
		</xzufi:typ>

Current behavior

The mapped hierarchy looks good to me. Maybe something is off that i just don't see and understand from the thrown exception. Maybe a type is not getting mapped properly.

class Code
{
    private string $code;
    private ?string $name = null;
    private ?string $listURI = null;
    private ?string $listVersionID = null;

    // more code

class FristtypErweiterbar
{
    private ?namespace\Type\Code $code = null;

    // more code

class FristMitTyp
{
    private namespace\Type\FristtypErweiterbar $typ;

    // more code
}

class Fristmodul extends Leistungsmodul
{
    /**
     * Strukturiert erfasste Fristen zur Leistung
     *
     * @var array<int<0,max>, namespace\Type\FristMitTyp>
     */
    private array $frist;

    // more code

class Leistung
{
    private ?namespace\Type\Fristmodul $modulFrist = null;

    // more code

The generated classmap contains these types, although code is written in lowercase. I don't know if this is important, but changing it to Code did not do anything for me:

    // stripped classmap code
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'FristMitTyp', Type\FristMitTyp::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'FristOhneTyp', Type\FristOhneTyp::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'FristStichtag', Type\FristStichtag::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'von', Type\Von::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'bis', Type\Bis::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'Fristmodul', Type\Fristmodul::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'Fristtyp_Erweiterbar', Type\FristtypErweiterbar::class),
	new ClassMap('http://xoev.de/schemata/xzufi/2_2_0', 'code', Type\Code::class),

How to reproduce

1. Configure soap-client.php with setTypeReplacementStrategy from Generated types that use enums have wrong parameters #594.
2. Run ./vendor/bin/soap-client generate:types --config config/soap-client.php for https://xzufi-v2-2-0-nw-schul.infodienste.de/?wsdl (warning: it will generate 1400 files...)
3. Run ./vendor/bin/soap-client generate:classmap --config config/soap-client.php for https://xzufi-v2-2-0-nw-schul.infodienste.de/?wsdl
4. Use this snipped Response to start the mapping process:

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<xzufi:leistungen.antwort.leistung.040104 xmlns:ns8="http://www.isotc211.org/2005/gts" xmlns:ns7="http://www.isotc211.org/2005/gmd" xmlns:ns6="http://www.isotc211.org/2005/gco" xmlns:ns5="http://www.w3.org/1999/xlink" xmlns:ns4="http://www.opengis.net/gml/3.2" xmlns:xzufi="http://xoev.de/schemata/xzufi/2_2_0" produktbezeichnung="XZufi" produkthersteller="Test" produktversion="3.18.005" xzufiVersion="2.2.0">
			<xzufi:nachrichtenkopf>
				<xzufi:nachrichtUUID>4f04238b-9479-49a3-9618-b464a137b268</xzufi:nachrichtUUID>
				<xzufi:erstelltDatumZeit>2025-11-26T08:58:44.269+01:00</xzufi:erstelltDatumZeit>
				<xzufi:sender>Infodienste Nordrhein-Westfalen (Schul)</xzufi:sender>
			</xzufi:nachrichtenkopf>
			<xzufi:antwort>
				<xzufi:antwortnummer>REQ-TEST-0001</xzufi:antwortnummer>
				<xzufi:antwortrueckgabecode listURI="urn:xoev-de:fim:codeliste:xzufi.nachrichtantwortcode" listVersionID="1.1">
					<code>000</code>
				</xzufi:antwortrueckgabecode>
				<xzufi:anfrage>
					<xzufi:anfragenummer>REQ-TEST-0001</xzufi:anfragenummer>
					<xzufi:zusatzinformation>Manueller Test</xzufi:zusatzinformation>
					<xzufi:suchprofil>
						<xzufi:id schemeAgencyID="GK_LEIKA" schemeID="LEIKA_LEISTUNG_SCHLUESSEL">99085001012000</xzufi:id>
						<xzufi:elementfilterSprache>de</xzufi:elementfilterSprache>
						<xzufi:kennzeichenNurBasisinformation>false</xzufi:kennzeichenNurBasisinformation>
					</xzufi:suchprofil>
				</xzufi:anfrage>
				<xzufi:ergebnis>
					<xzufi:leistung>
						<xzufi:id schemeAgencyID="Test_schemeAgencyID" schemeAgencyName="Test_schemeAgencyName" schemeID="Test_schemeID" schemeName="Test_schemeName">121370768</xzufi:id>
						<xzufi:struktur xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xzufi:LeistungsstrukturObjektMitVerrichtung">
							<xzufi:leistungsgruppierung>
								<xzufi:leistungsgruppierungIndividuell>
									<xzufi:klasse>
										<xzufi:id>LEISTUNGSGRUPPIERUNG</xzufi:id>
										<xzufi:bezeichnung languageCode="de-DE">Individuelle Leistungsgruppierung</xzufi:bezeichnung>
									</xzufi:klasse>
									<xzufi:id schemeID="LEISTUNGSGRUPPIERUNG">085</xzufi:id>
									<xzufi:bezeichnung languageCode="de-DE">Reisepass</xzufi:bezeichnung>
								</xzufi:leistungsgruppierungIndividuell>
							</xzufi:leistungsgruppierung>
							<xzufi:leistungsobjektID>121178548</xzufi:leistungsobjektID>
							<xzufi:verrichtung>
								<xzufi:verrichtungLeiKa listURI="urn:de:fim:leika:verrichtung" listVersionID="20230523">
									<code>012</code>
									<name>Ausstellung</name>
								</xzufi:verrichtungLeiKa>
							</xzufi:verrichtung>
						</xzufi:struktur>
						<xzufi:referenzLeiKa listURI="urn:de:fim:leika:leistung" listVersionID="20240721">
							<code>99085001012000</code>
							<name>Reisepass Ausstellung</name>
						</xzufi:referenzLeiKa>
						<xzufi:modulFrist>
							<xzufi:frist>
								<xzufi:typ>
									<xzufi:code listURI="urn:xoev-de:fim:codeliste:xzufi.fristtyp" listVersionID="1.2">
										<code>005</code>
									</xzufi:code>
								</xzufi:typ>
								<xzufi:fristauswahl>
									<xzufi:fristDauer>
										<xzufi:dauer>6</xzufi:dauer>
										<xzufi:einheit listURI="urn:xoev-de:fim:codeliste:xzufi.zeiteinheit" listVersionID="1.1">
											<code>JAHR</code>
										</xzufi:einheit>
										<xzufi:dauerBis>10</xzufi:dauerBis>
										<xzufi:einheitBis listURI="urn:xoev-de:fim:codeliste:xzufi.zeiteinheit" listVersionID="1.1">
											<code>JAHR</code>
										</xzufi:einheitBis>
									</xzufi:fristDauer>
								</xzufi:fristauswahl>
								<xzufi:beschreibung languageCode="de-DE">- Antragsteller unter 24 Jahre: 6 Jahre
Antragsteller ab 24 Jahre: 10 Jahre</xzufi:beschreibung>
								<xzufi:positionDarstellung>0</xzufi:positionDarstellung>
							</xzufi:frist>
						</xzufi:modulFrist>
					</xzufi:leistung>
				</xzufi:ergebnis>
			</xzufi:antwort>
		</xzufi:leistungen.antwort.leistung.040104>
	</soap:Body>
</soap:Envelope>

Expected behavior

There should be no exception :)

[veewee]

This seems to be a bug indeed.
I'll have to take a deeper look into why the encoder doesn't detect it is an enum.

[veewee]

Allright ... so what is going on here :)

<xs:complexType name="Fristtyp_Erweiterbar">
    <xs:choice>
        <xs:element name="code">
            <xs:complexType>
                <xs:complexContent>
                    <xs:restriction base="xoev-code:Code">
                        <xs:sequence>
                            <xs:element form="unqualified" name="code" type="xzufi:Codeliste.Fristtyp" />
                        </xs:sequence>
                        <xs:attribute fixed="urn:xoev-de:fim:codeliste:xzufi.fristtyp" name="listURI" type="xs:anyURI" use="optional" />
                        <xs:attribute fixed="1.2" name="listVersionID" type="xs:normalizedString" use="optional" />
                    </xs:restriction>
                </xs:complexContent>
            </xs:complexType>
        </xs:element>
        <xs:element name="nichtGelisteterWert" type="xoev-lc:String.Latin" />
    </xs:choice>
</xs:complexType>

The Fristtyp_Erweiterbar has a code element that extends the base Code type inline.
The wsdl reader parses this as any code implementation, meaning it expects a string as code instead of the enum that was provided. (See #495)

I think in order to get this right, we need to actually parse the extended internal version of the code class and generate code for that one specifically as well. So instead of using the base Code class, use something new like FristtypErweiterbarCode (which is an extension of the Code class that can deal with the enumeration). Given your type replacer, this approach would work and would be more correct as what we have now.

Next up : We'll need to figure out how we can add this internally extended type.

[veewee]

@Harkonn

Can you try out php-soap/wsdl-reader#52 and see how that goes for your application?
You'll need to regenerate the types in order for it to have effect on your application.

❗ The logic for detecting nested inline elements was already present, but now I made the name of those elements more unique by prefixing the root element. In this case: FristtypErweiterbarCode. However, this will impact a lot more class names, so hopefully the change is not too breaking for your application code. I'm thinking about just tagging the change, but if this breaks existing applications too much I'm not sure how to continue yet :)

^ App\Type\LeistungenAntwortLeistung040104^ {#63412
  -nachrichtenkopf: App\Type\Nachrichtenkopf^ {#65260
    -nachrichtUUID: "4f04238b-9479-49a3-9618-b464a137b268"
    -erstelltDatumZeit: DateTimeImmutable @1764143924 {#65247
      date: 2025-11-26 08:58:44.269 +01:00
    }
    -empfaenger: null
    -sender: "Infodienste Nordrhein-Westfalen (Schul)"
  }
  -produktbezeichnung: "XZufi"
  -produkthersteller: "Test"
  -produktversion: "3.18.005"
  -xzufiVersion: "2.2.0"
  -antwort: array:1 [
    0 => App\Type\AntwortLeistung^ {#64363
      -antwortnummer: "REQ-TEST-0001"
      -antwortrueckgabecode: App\Type\CodeNachrichtAntwortCode^ {#64964
        -code: App\Type\CodelisteNachrichtAntwortCode^ {#64976
          +name: "Value_000"
          +value: "000"
        }
        -name: null
        -listURI: "urn:xoev-de:fim:codeliste:xzufi.nachrichtantwortcode"
        -listVersionID: "1.1"
      }
      -antwortrueckgabezusatz: null
      -anfrage: App\Type\AnfrageLeistung^ {#64212
        -anfragenummer: "REQ-TEST-0001"
        -zusatzinformation: "Manueller Test"
        -suchprofil: App\Type\SuchprofilLeistung^ {#64257
          -id: array:1 [
            0 => App\Type\Identifikator^ {#64207
              -_: "99085001012000"
              -schemeAgencyID: "GK_LEIKA"
              -schemeAgencyName: null
              -schemeDataURI: null
              -schemeID: "LEIKA_LEISTUNG_SCHLUESSEL"
              -schemeName: null
              -schemeURI: null
              -schemeVersionID: null
            }
          ]
          -suchbegriff: null
          -kennzeichenVolltext: null
          -herausgeberID: []
          -gueltigkeitszeitraum: []
          -aenderungszeitraum: []
          -verfuegbareSprache: []
          -elementfilterSprache: array:1 [
            0 => "de"
          ]
          -leistungskategorie: []
          -leistungsklasse: []
          -leistungsverrichtung: []
          -gueltigkeitGebietID: []
          -spezialisiereFuerGebietID: null
          -wirtschaftszweigCode: []
          -staatsangehoerigkeitCode: []
          -rechtsformCode: []
          -kennzeichenNurBasisinformation: false
        }
      }
      -ergebnis: App\Type\AuswahlLeistungBasisinformation^ {#63438
        -leistung: array:1 [
          0 => App\Type\Leistung^ {#62922
            -id: App\Type\Identifikator^ {#63511
              -_: "121370768"
              -schemeAgencyID: "Test_schemeAgencyID"
              -schemeAgencyName: "Test_schemeAgencyName"
              -schemeDataURI: null
              -schemeID: "Test_schemeID"
              -schemeName: "Test_schemeName"
              -schemeURI: null
              -schemeVersionID: null
            }
            -idSekundaer: []
            -struktur: App\Type\LeistungsstrukturObjektMitVerrichtung^ {#63188
              -leistungsgruppierung: App\Type\LeistungsgruppierungAuswahl^ {#63726
                -leistungsgruppierungLeiKa: null
                -leistungsgruppierungIndividuell: App\Type\Leistungskategorie^ {#63037
                  -klasse: App\Type\LeistungskategorieKlasse^ {#62844
                    -id: App\Type\Identifikator^ {#63552
                      -_: "LEISTUNGSGRUPPIERUNG"
                      -schemeAgencyID: null
                      -schemeAgencyName: null
                      -schemeDataURI: null
                      -schemeID: null
                      -schemeName: null
                      -schemeURI: null
                      -schemeVersionID: null
                    }
                    -idSekundaer: []
                    -bezeichnung: array:1 [
                      0 => App\Type\StringLocalized^ {#63644
                        -_: "Individuelle Leistungsgruppierung"
                        -languageCode: "de-DE"
                      }
                    ]
                    -beschreibung: []
                    -version: null
                  }
                  -id: App\Type\Identifikator^ {#62874
                    -_: "085"
                    -schemeAgencyID: null
                    -schemeAgencyName: null
                    -schemeDataURI: null
                    -schemeID: "LEISTUNGSGRUPPIERUNG"
                    -schemeName: null
                    -schemeURI: null
                    -schemeVersionID: null
                  }
                  -idSekundaer: []
                  -uebergeordneteKategorieID: null
                  -untergeordneteKategorieID: []
                  -bezeichnung: array:1 [
                    0 => App\Type\StringLocalized^ {#63121
                      -_: "Reisepass"
                      -languageCode: "de-DE"
                    }
                  ]
                  -beschreibung: []
                }
              }
              -leistungsobjektID: App\Type\Identifikator^ {#63660
                -_: "121178548"
                -schemeAgencyID: null
                -schemeAgencyName: null
                -schemeDataURI: null
                -schemeID: null
                -schemeName: null
                -schemeURI: null
                -schemeVersionID: null
              }
              -verrichtung: App\Type\LeistungsverrichtungAuswahl^ {#63210
                -verrichtungLeiKa: App\Type\CodeLeiKaVerrichtungskennung^ {#62930
                  -code: "012"
                  -name: "Ausstellung"
                  -listURI: "urn:de:fim:leika:verrichtung"
                  -listVersionID: "20230523"
                }
                -verrichtungIndividuell: null
              }
            }
            -referenzLeiKa: array:1 [
              0 => App\Type\CodeLeiKaLeistung^ {#63287
                -code: "99085001012000"
                -name: "Reisepass Ausstellung"
                -listURI: "urn:de:fim:leika:leistung"
                -listVersionID: "20240721"
              }
            ]
            -modulText: []
            -modulTextIndividuell: []
            -modulFrist: App\Type\Fristmodul^ {#63081
              -positionDarstellung: null
              -id: null
              -idSekundaer: []
              -gueltigkeit: []
              -frist: array:1 [
                0 => App\Type\FristMitTyp^ {#63145
                  -typ: App\Type\FristtypErweiterbar^ {#63706
                    -code: App\Type\FristtypErweiterbarCode^ {#62990
                      -code: App\Type\CodelisteFristtyp^ {#64666
                        +name: "Value_005"
                        +value: "005"
                      }
                      -name: null
                      -listURI: "urn:xoev-de:fim:codeliste:xzufi.fristtyp"
                      -listVersionID: "1.2"
                    }
                    -nichtGelisteterWert: null
                  }
                  -fristauswahl: App\Type\FristAuswahl^ {#64785
                    -fristDauer: App\Type\FristDauer^ {#64845
                      -dauer: 6
                      -einheit: App\Type\CodeZeiteinheit^ {#63097
                        -code: App\Type\CodelisteZeiteinheit^ {#63055
                          +name: "JAHR"
                          +value: "JAHR"
                        }
                        -name: null
                        -listURI: "urn:xoev-de:fim:codeliste:xzufi.zeiteinheit"
                        -listVersionID: "1.1"
                      }
                      -dauerBis: 10
                      -einheitBis: App\Type\CodeZeiteinheit^ {#64853
                        -code: App\Type\CodelisteZeiteinheit^ {#63055}
                        -name: null
                        -listURI: "urn:xoev-de:fim:codeliste:xzufi.zeiteinheit"
                        -listVersionID: "1.1"
                      }
                    }
                    -fristStichtag: null
                  }
                  -beschreibung: array:1 [
                    0 => App\Type\StringLocalized^ {#64653
                      -_: """
                        - Antragsteller unter 24 Jahre: 6 Jahre\n
                        Antragsteller ab 24 Jahre: 10 Jahre
                        """
                      -languageCode: "de-DE"
                    }
                  ]
                  -positionDarstellung: 0
                  -gueltigkeit: []
                }
              ]
              -beschreibung: []
              -weiterfuehrenderLink: []
            }
            -modulKosten: null
            -modulBearbeitungsdauer: null
            -modulBegriffImKontext: []
            -modulFachlicheFreigabe: null
            -modulAuskunftshinweis: null
            -modulDokument: null
            -modulUrsprungsportal: []
            -typisierung: []
            -vertrauensniveau: null
            -leistungsadressat: []
            -kennzeichenSchriftformerfordernis: null
            -kategorie: []
            -klassifizierung: []
            -informationsbereichSDG: []
            -idLeistungImKontext: []
            -idProzess: []
            -herausgeber: null
            -gueltigkeitGebietID: []
            -kennzeichenEA: null
            -relevantFuerWirtschaftszweig: []
            -relevantFuerRechtsform: []
            -relevantFuerStaatsangehoerigkeit: []
            -versionsinformation: null
            -sprachversion: []
            -gueltigkeit: []
          }
        ]
        -basisinformation: []
      }
    }
  ]
}

[Harkonn]

@veewee thank you very much. I tested your code and it works now! :)

[veewee]

Tagged ;)