Edit Report a Bug

    SoapServer::addFunction

    (PHP 5, PHP 7, PHP 8)

    SoapServer::addFunction — Adds one or more functions to handle SOAP requests

    Descrizione

    public SoapServer::addFunction(array|string|int $functions): void

    Exports one or more functions for remote clients

    Elenco dei parametri

    functions

    To export one function, pass the function name into this parameter as a string.

    To export several functions, pass an array of function names.

    To export all the functions, pass a special constant SOAP_FUNCTIONS_ALL.

    Nota:

    functions must receive all input arguments in the same order as defined in the WSDL file (They should not receive any output parameters as arguments) and return one or more values. To return several values they must return an array with named output parameters.

    Valori restituiti

    Nessun valore viene restituito.

    Esempi

    Example #1 SoapServer::addFunction() example

    <?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);

    ?>

    Vedere anche:

    add a note add a note

    User Contributed Notes 3 notes

    up
    8
    dotpointer at gmail dot com
    17 years ago
    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.
    up
    0
    Evan Borgstrom
    18 years ago
    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);
    up
    -1
    Nathan O'Sullivan
    19 years ago
    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 add a note
    To Top