cvs: peardoc /en/pecl soap.xml
| From: | Philip Olson | Date: | Sun, 11 May 2003 08:30:28 +0000 |
| Subject: | cvs: peardoc /en/pecl soap.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-774@lists.php.net to get a copy of this message | ||
philip Sun May 11 04:30:28 2003 EDT
Modified files:
/peardoc/en/pecl soap.xml
Log:
Whitespace and some XML formatting, no real changes. Also some PHP tag additions.
Index: peardoc/en/pecl/soap.xml diff -u peardoc/en/pecl/soap.xml:1.1 peardoc/en/pecl/soap.xml:1.2 --- peardoc/en/pecl/soap.xml:1.1 Thu Jan 2 22:54:13 2003 +++ peardoc/en/pecl/soap.xml Sun May 11 04:30:28 2003 @@ -1,81 +1,91 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="pecl.soap"> <title>Soap</title> <titleabbrev>soap</titleabbrev> <partintro> + &warn.experimental; <sect1 id="pecl.soap.partintro"> - <title>Introduction</title> - <sect2 id="pecl.soap.intro"> - <title>About soap</title> - <para> - The soap extension is a really easy way to write soap clients and servers, - </para> - <para> - This really needs a better introduction - if you can think of one send an - email to <ulink url="mailto:soap@lists.php.net">soap@lists.php.net</ulink> - </para> - + <title>Introduction</title> + <sect2 id="pecl.soap.intro"> + <title>About soap</title> + <para> + The soap extension is a really easy way to write soap clients and servers. + </para> + <para> + This really needs a better introduction - if you can think of one send an + email to <ulink url="&email.php.soap;">&email.php.soap;</ulink> + </para> </sect2> + <sect2 id="pecl.soap.install"> <title>Installation</title> <para> - short installation note: - <itemizedlist> - <listitem><simpara>To compile and install you will need <ulink url="http://xmlsoft.org">libxml2 (download)</ulink> - Only versions 2.4.12 and 2.4.14 have been tested. php-soap "should" work with other versions of - libxml2 they just haven't been tested</simpara></listitem> + Short installation note: + </para> + <para> + <itemizedlist> <listitem> - <simpara> - You currently need to check the soap exetension out from - <ulink url="http://www.php.net/anoncvs.php">Anonymous CVS</ulink>, using - cvs co pear/PECL/soap - </simpara> - </listitem> + <simpara> + To compile and install you will need + <ulink url="&url.libxml;">libxml</ulink>. Only versions 2.4.12 + and 2.4.14 have been tested. php-soap "should" work with other + versions of libxml2, they just haven't been tested + </simpara> + </listitem> <listitem> + <simpara> + You currently need to check the soap exetension out from + <ulink url="&url.php.anoncvs;">Anonymous CVS</ulink>, using + <literal>cvs co pear/PECL/soap</literal>. + </simpara> + </listitem> + <listitem> <simpara> - You should copy the soap directory into the PHP /ext folder (unless you - only want to build it as self-contained php-module) + You should copy the soap directory into the PHP + <filename>/ext</filename> folder (unless you only want to + build it as a self-contained php-module) </simpara> </listitem> - - <listitem><simpara>run phpize in the soap folder (for the module) or ./buildconf in php4</simpara></listitem> - <listitem><simpara></simpara></listitem> - <listitem> - <simpara> - run configure with --with-soap (and your other options) - </simpara> - </listitem> - <listitem><simpara>make; make install</simpara></listitem> - <listitem><simpara>that's it.</simpara></listitem> - </itemizedlist> - + <listitem> + <simpara> + Run <emphasis>phpize</emphasis> in the soap folder (for the module) or + <filename>./buildconf</filename> in the php4 directory. + </simpara> + </listitem> + <listitem> + <simpara> + Run <filename>configure</filename> with <literal>--with-soap</literal> + (and your other options) + </simpara> + </listitem> + <listitem> + <simpara> + <literal>make; make install</literal> + </simpara> + </listitem> + <listitem> + <simpara>that's it.</simpara> + </listitem> + </itemizedlist> </para> - </sect2> + <sect2 id="pecl.soap.contact"> - <title>Contact Information</title> - <para> - ...... - </para> - <para> + <title>Contact Information</title> + <para> If you have comments, bugfixes, enhancements or want to help - developing this beast, join the <ulink - url="http://www.php.net/mailing-lists.php">Soap Mailing List</ulink>. Any help is very - welcome. - </para> + developing this beast, join the + <ulink url="&url.php.mailinglists;">Soap Mailing List</ulink>. All + help is very welcome. + </para> </sect2> + </sect1> - - </partintro> - -<!-- soapobject --> - - <refentry id="pecl.soap.soapobject"> <refnamediv> <refname>SoapObject</refname> @@ -90,35 +100,48 @@ <paramdef>string <parameter><optional>urn</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This is the constructor of the SoapObject the 'Soap Client'. + This is the constructor of the SoapObject the 'Soap Client'. </para> <para> - This constructor takes two parameters. If only one parameter is supplied then it willassume the parameter is a WSDL of the soap service you wish to reach. If two parameters -are passed then it will assume the first parameter is the 'proxy' or endpoint of the soap service -and the second parameter will be the uri of the soap service you wish to reach. + This constructor takes two parameters. If only one parameter is + supplied then it willassume the parameter is a WSDL of the soap + service you wish to reach. If two parameters are passed then it + will assume the first parameter is the 'proxy' or endpoint of the + soap service and the second parameter will be the uri of the soap + service you wish to reach. </para> <para> - Parameters: + Parameters: <itemizedlist> - <listitem><simpara> - $location -- This parameter is either the 'proxy' for the soap server or a wsdl. - </simpara></listitem> - <listitem><simpara> - $uri -- If the 'location' parameter isn't a wsdl then you must supply the uri of the soap service. - </simpara></listitem> + <listitem> + <simpara> + <parameter>$location</parameter> -- This parameter is either + the 'proxy' for the soap server or a wsdl. + </simpara> + </listitem> + <listitem> + <simpara> + <parameter>$uri</parameter> -- If the 'location' parameter + isn't a wsdl then you must supply the uri of the soap service. + </simpara> + </listitem> </itemizedlist> - </para> <para> - Once you have connected to the remote server, by creating the object, you can call any of the - exposed Methods as in the example below which calls the remote method, getQuote(); - <example> - <title><function>SoapObject</function> example</title> - <programlisting role="php"> + Once you have connected to the remote server, by creating the + object, you can call any of the exposed Methods as in the example + below which calls the remote method, getQuote(); + </para> + <para> + <example> + <title><function>SoapObject</function> example</title> + <programlisting role="php"> <![CDATA[ - +<?php //simple example to check soap extension client is working.. dl('soap.so'); echo "create client\n"; @@ -130,19 +153,14 @@ print_r($ret); echo "done"; - +?> ]]> - </programlisting> - </example> - </para> + </programlisting> + </example> + </para> </refsect1> </refentry> - - -<!-- soapobject __isfault --> - - <refentry id="pecl.soap.soapobject-isFault"> <refnamediv> <refname>SoapObject::__isFault</refname> @@ -156,15 +174,18 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> Return TRUE if an error occured during the last SOAP method call. </para> <para> - <example> - <title><function>SoapObject::__isFault</function> example</title> - <programlisting role="php"> + <example> + <title><function>SoapObject::__isFault</function> example</title> + <programlisting role="php"> <![CDATA[ +<?php //simple example to check soap extension client is working.. dl('soap.so'); @@ -172,21 +193,14 @@ $ret = $soapclient->sillytest(); var_dump($soapclient->__isFault()); - - - +?> ]]> - </programlisting> - </example> + </programlisting> + </example> </para> </refsect1> </refentry> - - -<!-- soapobject __getfault --> - - <refentry id="pecl.soap.soapobject-getFault"> <refnamediv> <refname>SoapObject::__getFault</refname> @@ -200,15 +214,18 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> Returns the last Soapfault object </para> <para> - <example> - <title><function>SoapObject::__getFault</function> example</title> - <programlisting role="php"> + <example> + <title><function>SoapObject::__getFault</function> example</title> + <programlisting role="php"> <![CDATA[ +<?php //simple example to check soap extension client is working.. dl('soap.so'); @@ -218,21 +235,14 @@ if ($soapclient->__isFault()) { print_r($soapclient->__getFault()); } - - +?> ]]> - </programlisting> - </example> + </programlisting> + </example> </para> </refsect1> </refentry> - - - - - - <refentry id="pecl.soap.soapserver"> <refnamediv> <refname>SoapServer</refname> @@ -246,46 +256,53 @@ <paramdef>string <parameter><optional>urn</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This is the constructor of the SoapServer Object. + This is the constructor of the SoapServer Object. </para> <para> - Currently the server doesn't validate requests against urn, it eventually will. + Currently the server doesn't validate requests against urn, it + eventually will. </para> <para> - - <example> - <title>Note: you will need this line to your php.ini file.</title> - <programlisting role="ini"> + <example> + <title>Note: you will need this line to your php.ini file.</title> + <programlisting role="ini"> <![CDATA[ always_populate_raw_post_data = On - ]]> - </programlisting> - </example> - (this requirement will be removed in future versions) +]]> + </programlisting> + </example> </para> + <note> + <para> + This requirement will be removed in future versions + </para> + </note> <para> - Dont forget that no spaces or HTML are allowed before the >?php tags. otherwise output will begin - before the server return data, hence confusing SOAP clients. + Dont forget that no spaces or HTML are allowed before the >?php + tags. otherwise output will begin before the server return data, + hence confusing SOAP clients. </para> - <para> - Parameters: + Parameters: <itemizedlist> - <listitem><simpara> - $urn -- name of the urn for the SoapServer. - </simpara></listitem> + <listitem> + <simpara> + <parameter>$urn</parameter> -- name of the urn for the + SoapServer. + </simpara> + </listitem> </itemizedlist> - </para> <para> - - <example> - <title><function>SoapObject</function> example</title> - <programlisting role="php"> + <example> + <title><function>SoapObject</function> example</title> + <programlisting role="php"> <![CDATA[ - +<?php @dl('soap.so'); $server = new SoapServer("urn:HelloWorld"); @@ -296,22 +313,14 @@ { return "PHP-SOAP says ($mes } - +?> ]]> - </programlisting> - </example> - </para> + </programlisting> + </example> + </para> </refsect1> </refentry> - - - - - -<!-- soapserver handle --> - - <refentry id="pecl.soap.soapserver-handle"> <refnamediv> <refname>SoapObject::handle</refname> @@ -325,21 +334,16 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - The handle method allows execution of the SOAP request and - must be invoked by each SoapServer. + The handle method allows execution of the SOAP request and must be + invoked by each SoapServer. </para> - </refsect1> </refentry> - - - -<!-- soapserver setClass --> - - <refentry id="pecl.soap.soapserver-setclass"> <refnamediv> <refname>SoapObject::setClass</refname> @@ -354,38 +358,35 @@ <paramdef>mixed <parameter><optional>constructor_args</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This function will first check if the class exists. - If it finds the existing class, it will bind all existing methods - to the created SoapServer. + This function will first check if the class exists. + If it finds the existing class, it will bind all existing methods + to the created SoapServer. </para> - <para> - Parameters: + <para> + Parameters: <itemizedlist> - <listitem><simpara> - $class_name -- This is a string of the class name that you want to bind. - </simpara></listitem> - <listitem><simpara> - $constructor_args -- Variable number of arguments that will be passed to the constructor of the object everytime an object is created - </simpara></listitem> + <listitem> + <simpara> + <parameter>$class_name</parameter> -- This is a string of the + class name that you want to bind. + </simpara> + </listitem> + <listitem> + <simpara> + <parameter>$constructor_args</parameter> -- Variable number of + arguments that will be passed to the constructor of the object + everytime an object is created + </simpara> + </listitem> </itemizedlist> - </para> - </refsect1> </refentry> - - -<!-- - -soapserver setPersistence - ---> - - - <refentry id="pecl.soap.soapserver-setpersistence"> <refnamediv> <refname>SoapObject::setPersistence</refname> @@ -399,37 +400,33 @@ <paramdef>long <parameter>SOAP_PERSISTENCE_SESSION | SOAP_PERSISTENCE_REQUEST</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This function should only be used if the SoapServer is bound to a class. - + This function should only be used if the SoapServer is bound to a + class. </para> - <para> - Use either of these constants - <itemizedlist> - <listitem><simpara> - SOAP_PERSISTENCE_SESSION - tells the server to keep the object created at the end of the request - </simpara></listitem> - <listitem><simpara> - SOAP_PERSISTENCE_REQUEST - tells the server to discard the object at the end of the request - </simpara></listitem> - </itemizedlist> - + <para> + Use either of these constants + <itemizedlist> + <listitem> + <simpara> + <constant>SOAP_PERSISTENCE_SESSION</constant> - tells the server + to keep the object created at the end of the request + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SOAP_PERSISTENCE_REQUEST</constant> - tells the server + to discard the object at the end of the request + </simpara> + </listitem> + </itemizedlist> </para> - </refsect1> </refentry> - -<!-- - -soapserver addFunction(mixed $functions) - - ---> - - - <refentry id="pecl.soap.soapserver-addfunction"> <refnamediv> <refname>SoapObject::setFunction</refname> @@ -443,34 +440,24 @@ <paramdef>(string|array) <parameter>functions</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - Based on the parameters passed, addfunction will add a single function, - an array of functions. + Based on the parameters passed, addfunction will add a single + function, an array of functions. </para> <para> - AddFunction should only be used when implementing a non-class SoapServer. - + AddFunction should only be used when implementing a non-class SoapServer. </para> - <para> - You can currently also use SOAP_FUNCTIONS_ALL as the paramenter, and this is - also the default for testing purposes, - this will be changed for security reasons. + <para> + You can currently also use SOAP_FUNCTIONS_ALL as the paramenter, + and this is also the default for testing purposes, this will be + changed for security reasons. </para> - </refsect1> </refentry> - -<!-- - -soapserver bind - - ---> - - - <refentry id="pecl.soap.soapserver-bind"> <refnamediv> <refname>SoapObject::bind</refname> @@ -484,24 +471,14 @@ <paramdef>location <parameter>wsdl</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - A wsdl is an xml description of the methods available in the server. + A wsdl is an xml description of the methods available in the server. </para> - </refsect1> </refentry> - - - - -<!-- - -soapvar - ---> - - <refentry id="pecl.soap.soapvar"> <refnamediv> @@ -517,162 +494,241 @@ <paramdef>long <parameter>type</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - You can change the return type of <parameter>variable</parameter> - - so that it works better with non-PHP applications for example. + You can change the return type of <parameter>variable</parameter> + - so that it works better with non-PHP applications for example. </para> <para> - type should be one of the following + type should be one of the following <itemizedlist> - - <listitem><simpara> -XSD_1999_TIMEINSTANT - </simpara></listitem> - <listitem><simpara> -XSD_STRING - </simpara></listitem> - <listitem><simpara> -XSD_BOOLEAN - </simpara></listitem> - <listitem><simpara> -XSD_DECIMAL - </simpara></listitem> - <listitem><simpara> -XSD_FLOAT - </simpara></listitem> - <listitem><simpara> -XSD_DOUBLE - </simpara></listitem> - <listitem><simpara> -XSD_DURATION - </simpara></listitem> - <listitem><simpara> -XSD_DATETIME - </simpara></listitem> - <listitem><simpara> -XSD_TIME - </simpara></listitem> - <listitem><simpara> -XSD_DATE - </simpara></listitem> - <listitem><simpara> -XSD_GYEARMONTH - </simpara></listitem> - <listitem><simpara> -XSD_GYEAR - </simpara></listitem> - <listitem><simpara> -XSD_GMONTHDAY - </simpara></listitem> - <listitem><simpara> -XSD_GDAY - </simpara></listitem> - <listitem><simpara> -XSD_GMONTH - </simpara></listitem> - <listitem><simpara> -XSD_HEXBINARY - </simpara></listitem> - <listitem><simpara> -XSD_BASE64BINARY - </simpara></listitem> - <listitem><simpara> -XSD_ANYURI - </simpara></listitem> - <listitem><simpara> -XSD_QNAME - </simpara></listitem> - <listitem><simpara> -XSD_NOTATION - </simpara></listitem> - <listitem><simpara> -XSD_NORMALIZEDSTRING - </simpara></listitem> - <listitem><simpara> -XSD_TOKEN - </simpara></listitem> - <listitem><simpara> -XSD_LANGUAGE - </simpara></listitem> - <listitem><simpara> -XSD_NMTOKEN - </simpara></listitem> - <listitem><simpara> -XSD_NAME - </simpara></listitem> - <listitem><simpara> -XSD_NCNAME - </simpara></listitem> - <listitem><simpara> -XSD_ID - </simpara></listitem> - <listitem><simpara> -XSD_IDREF - </simpara></listitem> - <listitem><simpara> -XSD_IDREFS - </simpara></listitem> - <listitem><simpara> -XSD_ENTITY - </simpara></listitem> - <listitem><simpara> -XSD_ENTITYS - </simpara></listitem> - <listitem><simpara> -XSD_INTEGER - </simpara></listitem> - <listitem><simpara> -XSD_NONPOSITIVEINTEGER - </simpara></listitem> - <listitem><simpara> -XSD_NEGATIVEINTEGER - </simpara></listitem> - <listitem><simpara> -XSD_LONG - </simpara></listitem> - <listitem><simpara> -XSD_INT - </simpara></listitem> - <listitem><simpara> -XSD_SHORT - </simpara></listitem> - <listitem><simpara> -XSD_BYTE - </simpara></listitem> - <listitem><simpara> -XSD_NONNEGATIVEINTEGER - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDLONG - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDINT - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDSHORT - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDBYTE - </simpara></listitem> - <listitem><simpara> -XSD_POSITIVEINTEGER - </simpara></listitem> - </itemizedlist> - </para> + <listitem> + <simpara> + XSD_1999_TIMEINSTANT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_STRING + </simpara> + </listitem> + <listitem> + <simpara> + XSD_BOOLEAN + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DECIMAL + </simpara> + </listitem> + <listitem> + <simpara> + XSD_FLOAT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DOUBLE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DURATION + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DATETIME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_TIME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DATE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GYEARMONTH + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GYEAR + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GMONTHDAY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GDAY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GMONTH + </simpara> + </listitem> + <listitem> + <simpara> + XSD_HEXBINARY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_BASE64BINARY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ANYURI + </simpara> + </listitem> + <listitem> + <simpara> + XSD_QNAME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NOTATION + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NORMALIZEDSTRING + </simpara> + </listitem> + <listitem> + <simpara> + XSD_TOKEN + </simpara> + </listitem> + <listitem> + <simpara> + XSD_LANGUAGE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NMTOKEN + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NAME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NCNAME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ID + </simpara> + </listitem> + <listitem> + <simpara> + XSD_IDREF + </simpara> + </listitem> + <listitem> + <simpara> + XSD_IDREFS + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ENTITY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ENTITYS + </simpara> + </listitem> + <listitem> + <simpara> + XSD_INTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NONPOSITIVEINTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NEGATIVEINTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_LONG + </simpara> + </listitem> + <listitem> + <simpara> + XSD_INT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_SHORT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_BYTE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NONNEGATIVEINTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDLONG + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDINT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDSHORT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDBYTE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_POSITIVEINTEGER + </simpara> + </listitem> + </itemizedlist> + </para> </refsect1> </refentry> - - -<!-- - -soapserver addFunction(mixed $functions) - - ---> - - <refentry id="pecl.soap.soapfault"> <refnamediv> <refname>SoapFault</refname> @@ -686,32 +742,40 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + + <para> + This class no methods or constructor associated with it, but it does + have 4 available members to determine what caused the fault + </para> <para> - This class no methods or constructor associated with it, but it does - have 4 available members to determine what caused the fault - - <itemizedlist> - <listitem><simpara> -$soapfault->faultstring - the fault string - </simpara></listitem> - <listitem><simpara> -$soapfault->faultcode - the fault code - </simpara></listitem> - <listitem><simpara> -$soapfault->faultactor - the fault actor - </simpara></listitem> - <listitem><simpara> -$soapfault->details - the fault details - </simpara></listitem> - </itemizedlist> - </para> - + <itemizedlist> + <listitem> + <simpara> + $soapfault->faultstring - the fault string + </simpara> + </listitem> + <listitem> + <simpara> + $soapfault->faultcode - the fault code + </simpara> + </listitem> + <listitem> + <simpara> + $soapfault->faultactor - the fault actor + </simpara> + </listitem> + <listitem> + <simpara> + $soapfault->details - the fault details + </simpara> + </listitem> + </itemizedlist> + </para> </refsect1> </refentry> - - </reference> <!-- Keep this comment at the end of the file
Index: peardoc/en/pecl/soap.xml diff -u peardoc/en/pecl/soap.xml:1.1 peardoc/en/pecl/soap.xml:1.2 --- peardoc/en/pecl/soap.xml:1.1 Thu Jan 2 22:54:13 2003 +++ peardoc/en/pecl/soap.xml Sun May 11 04:30:28 2003 @@ -1,81 +1,91 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="pecl.soap"> <title>Soap</title> <titleabbrev>soap</titleabbrev> <partintro> + &warn.experimental; <sect1 id="pecl.soap.partintro"> - <title>Introduction</title> - <sect2 id="pecl.soap.intro"> - <title>About soap</title> - <para> - The soap extension is a really easy way to write soap clients and servers, - </para> - <para> - This really needs a better introduction - if you can think of one send an - email to <ulink url="mailto:soap@lists.php.net">soap@lists.php.net</ulink> - </para> - + <title>Introduction</title> + <sect2 id="pecl.soap.intro"> + <title>About soap</title> + <para> + The soap extension is a really easy way to write soap clients and servers. + </para> + <para> + This really needs a better introduction - if you can think of one send an + email to <ulink url="&email.php.soap;">&email.php.soap;</ulink> + </para> </sect2> + <sect2 id="pecl.soap.install"> <title>Installation</title> <para> - short installation note: - <itemizedlist> - <listitem><simpara>To compile and install you will need <ulink url="http://xmlsoft.org">libxml2 (download)</ulink> - Only versions 2.4.12 and 2.4.14 have been tested. php-soap "should" work with other versions of - libxml2 they just haven't been tested</simpara></listitem> + Short installation note: + </para> + <para> + <itemizedlist> <listitem> - <simpara> - You currently need to check the soap exetension out from - <ulink url="http://www.php.net/anoncvs.php">Anonymous CVS</ulink>, using - cvs co pear/PECL/soap - </simpara> - </listitem> + <simpara> + To compile and install you will need + <ulink url="&url.libxml;">libxml</ulink>. Only versions 2.4.12 + and 2.4.14 have been tested. php-soap "should" work with other + versions of libxml2, they just haven't been tested + </simpara> + </listitem> <listitem> + <simpara> + You currently need to check the soap exetension out from + <ulink url="&url.php.anoncvs;">Anonymous CVS</ulink>, using + <literal>cvs co pear/PECL/soap</literal>. + </simpara> + </listitem> + <listitem> <simpara> - You should copy the soap directory into the PHP /ext folder (unless you - only want to build it as self-contained php-module) + You should copy the soap directory into the PHP + <filename>/ext</filename> folder (unless you only want to + build it as a self-contained php-module) </simpara> </listitem> - - <listitem><simpara>run phpize in the soap folder (for the module) or ./buildconf in php4</simpara></listitem> - <listitem><simpara></simpara></listitem> - <listitem> - <simpara> - run configure with --with-soap (and your other options) - </simpara> - </listitem> - <listitem><simpara>make; make install</simpara></listitem> - <listitem><simpara>that's it.</simpara></listitem> - </itemizedlist> - + <listitem> + <simpara> + Run <emphasis>phpize</emphasis> in the soap folder (for the module) or + <filename>./buildconf</filename> in the php4 directory. + </simpara> + </listitem> + <listitem> + <simpara> + Run <filename>configure</filename> with <literal>--with-soap</literal> + (and your other options) + </simpara> + </listitem> + <listitem> + <simpara> + <literal>make; make install</literal> + </simpara> + </listitem> + <listitem> + <simpara>that's it.</simpara> + </listitem> + </itemizedlist> </para> - </sect2> + <sect2 id="pecl.soap.contact"> - <title>Contact Information</title> - <para> - ...... - </para> - <para> + <title>Contact Information</title> + <para> If you have comments, bugfixes, enhancements or want to help - developing this beast, join the <ulink - url="http://www.php.net/mailing-lists.php">Soap Mailing List</ulink>. Any help is very - welcome. - </para> + developing this beast, join the + <ulink url="&url.php.mailinglists;">Soap Mailing List</ulink>. All + help is very welcome. + </para> </sect2> + </sect1> - - </partintro> - -<!-- soapobject --> - - <refentry id="pecl.soap.soapobject"> <refnamediv> <refname>SoapObject</refname> @@ -90,35 +100,48 @@ <paramdef>string <parameter><optional>urn</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This is the constructor of the SoapObject the 'Soap Client'. + This is the constructor of the SoapObject the 'Soap Client'. </para> <para> - This constructor takes two parameters. If only one parameter is supplied then it willassume the parameter is a WSDL of the soap service you wish to reach. If two parameters -are passed then it will assume the first parameter is the 'proxy' or endpoint of the soap service -and the second parameter will be the uri of the soap service you wish to reach. + This constructor takes two parameters. If only one parameter is + supplied then it willassume the parameter is a WSDL of the soap + service you wish to reach. If two parameters are passed then it + will assume the first parameter is the 'proxy' or endpoint of the + soap service and the second parameter will be the uri of the soap + service you wish to reach. </para> <para> - Parameters: + Parameters: <itemizedlist> - <listitem><simpara> - $location -- This parameter is either the 'proxy' for the soap server or a wsdl. - </simpara></listitem> - <listitem><simpara> - $uri -- If the 'location' parameter isn't a wsdl then you must supply the uri of the soap service. - </simpara></listitem> + <listitem> + <simpara> + <parameter>$location</parameter> -- This parameter is either + the 'proxy' for the soap server or a wsdl. + </simpara> + </listitem> + <listitem> + <simpara> + <parameter>$uri</parameter> -- If the 'location' parameter + isn't a wsdl then you must supply the uri of the soap service. + </simpara> + </listitem> </itemizedlist> - </para> <para> - Once you have connected to the remote server, by creating the object, you can call any of the - exposed Methods as in the example below which calls the remote method, getQuote(); - <example> - <title><function>SoapObject</function> example</title> - <programlisting role="php"> + Once you have connected to the remote server, by creating the + object, you can call any of the exposed Methods as in the example + below which calls the remote method, getQuote(); + </para> + <para> + <example> + <title><function>SoapObject</function> example</title> + <programlisting role="php"> <![CDATA[ - +<?php //simple example to check soap extension client is working.. dl('soap.so'); echo "create client\n"; @@ -130,19 +153,14 @@ print_r($ret); echo "done"; - +?> ]]> - </programlisting> - </example> - </para> + </programlisting> + </example> + </para> </refsect1> </refentry> - - -<!-- soapobject __isfault --> - - <refentry id="pecl.soap.soapobject-isFault"> <refnamediv> <refname>SoapObject::__isFault</refname> @@ -156,15 +174,18 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> Return TRUE if an error occured during the last SOAP method call. </para> <para> - <example> - <title><function>SoapObject::__isFault</function> example</title> - <programlisting role="php"> + <example> + <title><function>SoapObject::__isFault</function> example</title> + <programlisting role="php"> <![CDATA[ +<?php //simple example to check soap extension client is working.. dl('soap.so'); @@ -172,21 +193,14 @@ $ret = $soapclient->sillytest(); var_dump($soapclient->__isFault()); - - - +?> ]]> - </programlisting> - </example> + </programlisting> + </example> </para> </refsect1> </refentry> - - -<!-- soapobject __getfault --> - - <refentry id="pecl.soap.soapobject-getFault"> <refnamediv> <refname>SoapObject::__getFault</refname> @@ -200,15 +214,18 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> Returns the last Soapfault object </para> <para> - <example> - <title><function>SoapObject::__getFault</function> example</title> - <programlisting role="php"> + <example> + <title><function>SoapObject::__getFault</function> example</title> + <programlisting role="php"> <![CDATA[ +<?php //simple example to check soap extension client is working.. dl('soap.so'); @@ -218,21 +235,14 @@ if ($soapclient->__isFault()) { print_r($soapclient->__getFault()); } - - +?> ]]> - </programlisting> - </example> + </programlisting> + </example> </para> </refsect1> </refentry> - - - - - - <refentry id="pecl.soap.soapserver"> <refnamediv> <refname>SoapServer</refname> @@ -246,46 +256,53 @@ <paramdef>string <parameter><optional>urn</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This is the constructor of the SoapServer Object. + This is the constructor of the SoapServer Object. </para> <para> - Currently the server doesn't validate requests against urn, it eventually will. + Currently the server doesn't validate requests against urn, it + eventually will. </para> <para> - - <example> - <title>Note: you will need this line to your php.ini file.</title> - <programlisting role="ini"> + <example> + <title>Note: you will need this line to your php.ini file.</title> + <programlisting role="ini"> <![CDATA[ always_populate_raw_post_data = On - ]]> - </programlisting> - </example> - (this requirement will be removed in future versions) +]]> + </programlisting> + </example> </para> + <note> + <para> + This requirement will be removed in future versions + </para> + </note> <para> - Dont forget that no spaces or HTML are allowed before the >?php tags. otherwise output will begin - before the server return data, hence confusing SOAP clients. + Dont forget that no spaces or HTML are allowed before the >?php + tags. otherwise output will begin before the server return data, + hence confusing SOAP clients. </para> - <para> - Parameters: + Parameters: <itemizedlist> - <listitem><simpara> - $urn -- name of the urn for the SoapServer. - </simpara></listitem> + <listitem> + <simpara> + <parameter>$urn</parameter> -- name of the urn for the + SoapServer. + </simpara> + </listitem> </itemizedlist> - </para> <para> - - <example> - <title><function>SoapObject</function> example</title> - <programlisting role="php"> + <example> + <title><function>SoapObject</function> example</title> + <programlisting role="php"> <![CDATA[ - +<?php @dl('soap.so'); $server = new SoapServer("urn:HelloWorld"); @@ -296,22 +313,14 @@ { return "PHP-SOAP says ($mes } - +?> ]]> - </programlisting> - </example> - </para> + </programlisting> + </example> + </para> </refsect1> </refentry> - - - - - -<!-- soapserver handle --> - - <refentry id="pecl.soap.soapserver-handle"> <refnamediv> <refname>SoapObject::handle</refname> @@ -325,21 +334,16 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - The handle method allows execution of the SOAP request and - must be invoked by each SoapServer. + The handle method allows execution of the SOAP request and must be + invoked by each SoapServer. </para> - </refsect1> </refentry> - - - -<!-- soapserver setClass --> - - <refentry id="pecl.soap.soapserver-setclass"> <refnamediv> <refname>SoapObject::setClass</refname> @@ -354,38 +358,35 @@ <paramdef>mixed <parameter><optional>constructor_args</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This function will first check if the class exists. - If it finds the existing class, it will bind all existing methods - to the created SoapServer. + This function will first check if the class exists. + If it finds the existing class, it will bind all existing methods + to the created SoapServer. </para> - <para> - Parameters: + <para> + Parameters: <itemizedlist> - <listitem><simpara> - $class_name -- This is a string of the class name that you want to bind. - </simpara></listitem> - <listitem><simpara> - $constructor_args -- Variable number of arguments that will be passed to the constructor of the object everytime an object is created - </simpara></listitem> + <listitem> + <simpara> + <parameter>$class_name</parameter> -- This is a string of the + class name that you want to bind. + </simpara> + </listitem> + <listitem> + <simpara> + <parameter>$constructor_args</parameter> -- Variable number of + arguments that will be passed to the constructor of the object + everytime an object is created + </simpara> + </listitem> </itemizedlist> - </para> - </refsect1> </refentry> - - -<!-- - -soapserver setPersistence - ---> - - - <refentry id="pecl.soap.soapserver-setpersistence"> <refnamediv> <refname>SoapObject::setPersistence</refname> @@ -399,37 +400,33 @@ <paramdef>long <parameter>SOAP_PERSISTENCE_SESSION | SOAP_PERSISTENCE_REQUEST</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - This function should only be used if the SoapServer is bound to a class. - + This function should only be used if the SoapServer is bound to a + class. </para> - <para> - Use either of these constants - <itemizedlist> - <listitem><simpara> - SOAP_PERSISTENCE_SESSION - tells the server to keep the object created at the end of the request - </simpara></listitem> - <listitem><simpara> - SOAP_PERSISTENCE_REQUEST - tells the server to discard the object at the end of the request - </simpara></listitem> - </itemizedlist> - + <para> + Use either of these constants + <itemizedlist> + <listitem> + <simpara> + <constant>SOAP_PERSISTENCE_SESSION</constant> - tells the server + to keep the object created at the end of the request + </simpara> + </listitem> + <listitem> + <simpara> + <constant>SOAP_PERSISTENCE_REQUEST</constant> - tells the server + to discard the object at the end of the request + </simpara> + </listitem> + </itemizedlist> </para> - </refsect1> </refentry> - -<!-- - -soapserver addFunction(mixed $functions) - - ---> - - - <refentry id="pecl.soap.soapserver-addfunction"> <refnamediv> <refname>SoapObject::setFunction</refname> @@ -443,34 +440,24 @@ <paramdef>(string|array) <parameter>functions</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - Based on the parameters passed, addfunction will add a single function, - an array of functions. + Based on the parameters passed, addfunction will add a single + function, an array of functions. </para> <para> - AddFunction should only be used when implementing a non-class SoapServer. - + AddFunction should only be used when implementing a non-class SoapServer. </para> - <para> - You can currently also use SOAP_FUNCTIONS_ALL as the paramenter, and this is - also the default for testing purposes, - this will be changed for security reasons. + <para> + You can currently also use SOAP_FUNCTIONS_ALL as the paramenter, + and this is also the default for testing purposes, this will be + changed for security reasons. </para> - </refsect1> </refentry> - -<!-- - -soapserver bind - - ---> - - - <refentry id="pecl.soap.soapserver-bind"> <refnamediv> <refname>SoapObject::bind</refname> @@ -484,24 +471,14 @@ <paramdef>location <parameter>wsdl</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - A wsdl is an xml description of the methods available in the server. + A wsdl is an xml description of the methods available in the server. </para> - </refsect1> </refentry> - - - - -<!-- - -soapvar - ---> - - <refentry id="pecl.soap.soapvar"> <refnamediv> @@ -517,162 +494,241 @@ <paramdef>long <parameter>type</parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + <para> - You can change the return type of <parameter>variable</parameter> - - so that it works better with non-PHP applications for example. + You can change the return type of <parameter>variable</parameter> + - so that it works better with non-PHP applications for example. </para> <para> - type should be one of the following + type should be one of the following <itemizedlist> - - <listitem><simpara> -XSD_1999_TIMEINSTANT - </simpara></listitem> - <listitem><simpara> -XSD_STRING - </simpara></listitem> - <listitem><simpara> -XSD_BOOLEAN - </simpara></listitem> - <listitem><simpara> -XSD_DECIMAL - </simpara></listitem> - <listitem><simpara> -XSD_FLOAT - </simpara></listitem> - <listitem><simpara> -XSD_DOUBLE - </simpara></listitem> - <listitem><simpara> -XSD_DURATION - </simpara></listitem> - <listitem><simpara> -XSD_DATETIME - </simpara></listitem> - <listitem><simpara> -XSD_TIME - </simpara></listitem> - <listitem><simpara> -XSD_DATE - </simpara></listitem> - <listitem><simpara> -XSD_GYEARMONTH - </simpara></listitem> - <listitem><simpara> -XSD_GYEAR - </simpara></listitem> - <listitem><simpara> -XSD_GMONTHDAY - </simpara></listitem> - <listitem><simpara> -XSD_GDAY - </simpara></listitem> - <listitem><simpara> -XSD_GMONTH - </simpara></listitem> - <listitem><simpara> -XSD_HEXBINARY - </simpara></listitem> - <listitem><simpara> -XSD_BASE64BINARY - </simpara></listitem> - <listitem><simpara> -XSD_ANYURI - </simpara></listitem> - <listitem><simpara> -XSD_QNAME - </simpara></listitem> - <listitem><simpara> -XSD_NOTATION - </simpara></listitem> - <listitem><simpara> -XSD_NORMALIZEDSTRING - </simpara></listitem> - <listitem><simpara> -XSD_TOKEN - </simpara></listitem> - <listitem><simpara> -XSD_LANGUAGE - </simpara></listitem> - <listitem><simpara> -XSD_NMTOKEN - </simpara></listitem> - <listitem><simpara> -XSD_NAME - </simpara></listitem> - <listitem><simpara> -XSD_NCNAME - </simpara></listitem> - <listitem><simpara> -XSD_ID - </simpara></listitem> - <listitem><simpara> -XSD_IDREF - </simpara></listitem> - <listitem><simpara> -XSD_IDREFS - </simpara></listitem> - <listitem><simpara> -XSD_ENTITY - </simpara></listitem> - <listitem><simpara> -XSD_ENTITYS - </simpara></listitem> - <listitem><simpara> -XSD_INTEGER - </simpara></listitem> - <listitem><simpara> -XSD_NONPOSITIVEINTEGER - </simpara></listitem> - <listitem><simpara> -XSD_NEGATIVEINTEGER - </simpara></listitem> - <listitem><simpara> -XSD_LONG - </simpara></listitem> - <listitem><simpara> -XSD_INT - </simpara></listitem> - <listitem><simpara> -XSD_SHORT - </simpara></listitem> - <listitem><simpara> -XSD_BYTE - </simpara></listitem> - <listitem><simpara> -XSD_NONNEGATIVEINTEGER - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDLONG - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDINT - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDSHORT - </simpara></listitem> - <listitem><simpara> -XSD_UNSIGNEDBYTE - </simpara></listitem> - <listitem><simpara> -XSD_POSITIVEINTEGER - </simpara></listitem> - </itemizedlist> - </para> + <listitem> + <simpara> + XSD_1999_TIMEINSTANT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_STRING + </simpara> + </listitem> + <listitem> + <simpara> + XSD_BOOLEAN + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DECIMAL + </simpara> + </listitem> + <listitem> + <simpara> + XSD_FLOAT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DOUBLE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DURATION + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DATETIME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_TIME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_DATE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GYEARMONTH + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GYEAR + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GMONTHDAY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GDAY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_GMONTH + </simpara> + </listitem> + <listitem> + <simpara> + XSD_HEXBINARY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_BASE64BINARY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ANYURI + </simpara> + </listitem> + <listitem> + <simpara> + XSD_QNAME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NOTATION + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NORMALIZEDSTRING + </simpara> + </listitem> + <listitem> + <simpara> + XSD_TOKEN + </simpara> + </listitem> + <listitem> + <simpara> + XSD_LANGUAGE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NMTOKEN + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NAME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NCNAME + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ID + </simpara> + </listitem> + <listitem> + <simpara> + XSD_IDREF + </simpara> + </listitem> + <listitem> + <simpara> + XSD_IDREFS + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ENTITY + </simpara> + </listitem> + <listitem> + <simpara> + XSD_ENTITYS + </simpara> + </listitem> + <listitem> + <simpara> + XSD_INTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NONPOSITIVEINTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NEGATIVEINTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_LONG + </simpara> + </listitem> + <listitem> + <simpara> + XSD_INT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_SHORT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_BYTE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_NONNEGATIVEINTEGER + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDLONG + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDINT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDSHORT + </simpara> + </listitem> + <listitem> + <simpara> + XSD_UNSIGNEDBYTE + </simpara> + </listitem> + <listitem> + <simpara> + XSD_POSITIVEINTEGER + </simpara> + </listitem> + </itemizedlist> + </para> </refsect1> </refentry> - - -<!-- - -soapserver addFunction(mixed $functions) - - ---> - - <refentry id="pecl.soap.soapfault"> <refnamediv> <refname>SoapFault</refname> @@ -686,32 +742,40 @@ <paramdef><parameter></parameter></paramdef> </funcprototype> </funcsynopsis> - &warn.experimental.func; + + &warn.experimental.func; + + <para> + This class no methods or constructor associated with it, but it does + have 4 available members to determine what caused the fault + </para> <para> - This class no methods or constructor associated with it, but it does - have 4 available members to determine what caused the fault - - <itemizedlist> - <listitem><simpara> -$soapfault->faultstring - the fault string - </simpara></listitem> - <listitem><simpara> -$soapfault->faultcode - the fault code - </simpara></listitem> - <listitem><simpara> -$soapfault->faultactor - the fault actor - </simpara></listitem> - <listitem><simpara> -$soapfault->details - the fault details - </simpara></listitem> - </itemizedlist> - </para> - + <itemizedlist> + <listitem> + <simpara> + $soapfault->faultstring - the fault string + </simpara> + </listitem> + <listitem> + <simpara> + $soapfault->faultcode - the fault code + </simpara> + </listitem> + <listitem> + <simpara> + $soapfault->faultactor - the fault actor + </simpara> + </listitem> + <listitem> + <simpara> + $soapfault->details - the fault details + </simpara> + </listitem> + </itemizedlist> + </para> </refsect1> </refentry> - - </reference> <!-- Keep this comment at the end of the file