php-doc-en/reference/soap/soapclient/setlocation.xml
Máté Kocsis 5770355a66
Various methodsynopsis updates based on recent stub changes
* Update ext/zip methodsynopses based on stubs
* Update resource-related ext/standard methodsynopses based on stubs
* Update ext/dom methodsynopses based on stubs
* Update ext/ffi methodsynopses based on stubs
* Update ext/fileinfo methodsynopses based on stubs
* Update ext/soap methodsynopses based on stubs
* Update ext/sodium methodsynopses based on stubs
* Update ext/ldap methodsynopses based on stubs

Closes GH-598.
2021-05-22 15:24:20 +02:00

130 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapclient.setlocation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__setLocation</refname>
<refpurpose>Sets the location of the Web service to use</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>SoapClient::__setLocation</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>location</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
specifying the <literal>location</literal> option when constructing the SoapClient.
</para>
<note>
<para>
Calling this method is optional. The SoapClient uses the endpoint from
the WSDL file by default.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>location</parameter></term>
<listitem>
<para>
The new endpoint URL.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The old endpoint URL.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.3</entry>
<entry>
<parameter>location</parameter> is nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapClient::__setLocation</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient('http://example.com/webservice.php?wsdl');
$client->__setLocation('http://www.somethirdparty.com');
$old_location = $client->__setLocation(); // unsets the location option
echo $old_location;
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
http://www.somethirdparty.com
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__construct</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->