SoapServer::addFunction

(PHP 5 >= 5.0.1)

SoapServer::addFunction — Ajoute une ou plusieurs fonctions qui vont gérer les requêtes SOAP

Description

public void SoapServer::addFunction ( mixed $functions )

Exporte une ou plusieurs fonctions pour les clients distants.

Liste de paramètres

functions

Pour exporter une seule fonction, il faut passer son nom dans ce paramètre en tant que chaîne de caractères.

Pour exporter plusieurs fonctions, il faut utiliser un tableau de noms de fonctions.

Pour exporter toutes les fonctions, il faut utiliser la constante spéciale SOAP_FUNCTIONS_ALL.

Note:
functions doit recevoir tous les arguments d'entrée dans le même ordre que celui défini dans le fichier WSDL (il ne doit recevoir aucun paramètre de sortie en tant qu'argument) et retourne une ou plusieurs valeurs. Pour retourner plusieurs valeurs, il doit retourner un tableau contenant le nom des paramètres de sortie.

Valeurs de retour

Aucune valeur n'est retournée.

Exemples

Exemple #1 Exemple avec SoapServer::addFunction()


<?php

function echoString($inputString)
{
    return $inputString;
}

$server->addFunction("echoString");

function echoTwoStrings($inputString1, $inputString2)
{
    return array("outputString1" => $inputString1,
                 "outputString2" => $inputString2);
}
$server->addFunction(array("echoString", "echoTwoStrings"));

$server->addFunction(SOAP_FUNCTIONS_ALL);

?>

Voir aussi

SoapServer::SoapServer() - Constructeur SoapServer
SoapServer::setClass() - Configure la classe qui sera utilisée pour gérer les requêtes SOAP

SoapServer::addSoapHeader

SoapServer

[edit] Last updated: Fri, 10 Feb 2012

add a note User Contributed Notes SoapServer::addFunction

dotpointer at gmail dot com 26-Oct-2007 06:52


Be careful with SOAP_FUNCTIONS_ALL, as it adds ALL availiable PHP functions to your server.



This can be a potential security threat, imagine clients doing this:



echo $client->file_get_contents("c:\\my files\\my_passwords.doc");



And voila, they have the contents of your file my_passwords.doc.

Evan Borgstrom 23-Aug-2006 03:42


In response to comment by Nathan O'Sullivan about returning (or passing) a complex type, you can also use the stdClass() object.



Assume you define a complex type like so:



<xsd:complexType name="TestType">

        <xsd:all>

                <xsd:element name="A" type="xsd:string" />

                <xsd:element name="B" type="xsd:int" />

                <xsd:element name="C" type="xsd:boolean" />

        </xsd:all>

</xsd:complexType>



To use an object in place of an array you can do:



$test = new stdClass();

$test->A = "test string";

$test->B = 45;

$test->C = false;



$result = $client->Test($test);

15-Jun-2005 05:10


function Login($username, $password)

{

  return array("LoginResult" => array("Id"=>1, "Name"=>"Nathan", "Nickname"=>"Nathan", "Email"=>"email address") );

}



Ok, Only a litte error in the last note.. :

"LoginResult" => array    and NOT      "LoginResult" , array

Nathan O'Sullivan 28-Apr-2005 11:36


You may be left wondering, as I was, how to return a complex type - consider the following WSDL snippets, for a method called Login:



 <xs:element name="Login">

        <xs:complexType>

          <xs:sequence>

            <xs:element minOccurs="0" maxOccurs="1" name="username" type="xs:string" />

            <xs:element minOccurs="0" maxOccurs="1" name="password" type="xs:string" />

          </xs:sequence>

        </xs:complexType>

      </xs:element>



   <xs:complexType name="UserInfo">

        <xs:sequence>

          <xs:element minOccurs="0" maxOccurs="1" name="Id" type="xs:string" />

          <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:string" />

          <xs:element minOccurs="0" maxOccurs="1" name="Nickname" type="xs:string" />

          <xs:element minOccurs="0" maxOccurs="1" name="Email" type="xs:string" />

        </xs:sequence>

      </xs:complexType>



   <xs:element name="LoginResponse">

        <xs:complexType>

          <xs:sequence>

            <xs:element minOccurs="0" maxOccurs="1" name="LoginResult" type="s0:UserInfo" />

          </xs:sequence>

        </xs:complexType>

      </xs:element>



Here's a working Login function  that I've added with add SoapServer::addFunction



function Login($username, $password)

{

  return array("LoginResult", array("Id"=>1, "Name"=>"Nathan", "Nickname"=>"Nathan", "Email"=>"email address") );

}



The UserInfo complextype is represented by the inner array.  The outer array has just one element, "LoginResult".  The LogineResponse element  seems to be treated as a one-member array by PHP.

add a note