Search code examples
phpfootersoap-client

PHP - How to set footer in SoapClient


With PHP, I need to send a SOAP request with a parameter (Hash) in the footer. I'm using SoapClient but I can not figure out how to do this, neither in internet searches, nor in documentation.

This is the envelope I used in the SoapUI tool to test:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:abc="" xmlns:abc1="" xmlns:abc2="">
   <soapenv:Header/>
   <soapenv:Body>
      <abc:Method>
         <!--Optional:-->
         <abc:request>
            <abc1:Header>
               <abc1:Username>Username</abc1:Username>
               <abc1:Password>Password</abc1:Password>
               <!--Optional:-->
               <abc1:PublicKeyUid></abc1:PublicKeyUid>
            </abc1:Header>
            <abc1:Body>
               <abc2:Id></abc2:Id>
            </abc1:Body>
            <abc1:Footer>
                <abc1:Hash></abc1:Hash>
            </abc1:Footer>
         </abc:request>
      </abc:Method>
   </soapenv:Body>
</soapenv:Envelope>

There is The SoapHeader class e the SoapClient::__setSoapHeaders method but I find nothing related to the footer.

I do not have access to the server and should follow this structure mentioned above.

What I need to know is how to send the HASH parameter that is inside the footer with SoapClient.

Thanks in advance for any help or suggestion.


Solution

  • As IMSoP and axiac have commented, the footer (<abc1: Footer>) is just a sub-structure of the envelop body and not a standard XML envelop element. I had not realized this and so I did not find it in the documentation.

    So to send HASH to the requested structure, I need to pass a multidimensional array on the body element. The code looks like this:

    $arrParameters = [
        'request'=>[
            'Header'=>[
                'Username'=>$strUsername,
                'Password'=>$strPassword
            ],
            'Body'=>[
                ...
            ],
            'Footer'=>[
                'Hash'=>$strHash
            ]
        ]
    ];
    
    $SoapClient = new SoapClient(<WSDL URL>);
    
    $resp = $SoapClient->method($arrParameters);
    


    Thank you IMSoP and axiac!