Can Zend_Soap_Client set custom user-agent?

Question

I have Zend_Soap_Server. It should be tested. One issue - unit testing and development modes should work with different databases. It can be done via .htaccess:

SetEnvIfNoCase User-Agent (.*) APPLICATION_ENV=development
SetEnvIfNoCase User-Agent testing APPLICATION_ENV=testing

It would work fine for me, I use Zend_Soap_Client as is for development/production mode, and add extra parameter for testing. There are no special changes in source code for testing support. The issue - I can't set custom user-agent for (Zend_Soap_Client It seems as this parameter isn't supported or isn't documented. I tried to do the same thing via mod_rewrite and adding

new Zend_Soap_Client('...?wsdl&testing');

but it requires to change Zend_Soap_Server to support testing Query_String, otherwise soap-actions aren't reflected with 'testing' outside of wsdl. It's not good in my opinion.

I agree it's a bit more related with acceptance testing, not unit (I have tests for classes such as $server->setClass('classWS')), but anyway, I need it regardless of terminology.

So, what would work fine for me is something like:

new Zend_Soap_Client($wsdl, array('useragent' => 'testing'));

in tests.

Answer 1

It's possible but it's a bit more complicated than just setting an option. The key is a stream context. The required function is stream_context_create() - please also have a look at "HTTP context options".

$context = stream_context_create(array(
    'http' => array(
        'user_agent' => 'testing'
    )
);
$client = new Zend_Soap_Client($wsdl, array('stream_context' => $context));

// or set option after instatiation
$client->setStreamContext($context);

EDIT:

As the stream context user-agent seems to get overridden another option is to use the user_agent-option of SoapClient itself. But this is a little bit more complicated as this option is not exposed by Zend_Soap_Client.

$client = new Zend_Soap_Client($wsdl);
$options = array_merge($client->getOptions(), array(
    'trace'      => true,
    'user_agent' => 'testing'
));
$soapClient = new Zend_Soap_Client_Common(array($client, '_doRequest'), $wsdl, $options);
$client->setSoapClient($soapClient);

The above code is more or less an extract of what happens in Zend_Soap_Client::_initSoapClientObject() which initializes the default SoapClient when no custom object is registered.