archived-doc-ja/reference/soap/soapserver/addfunction.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 577239f64b3959c22d348a5f381eaf32fde996ed Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka -->

<refentry xml:id="soapserver.addfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SoapServer::addFunction</refname>
  <refpurpose>SOAP リクエストによって処理される単一もしくはいくつかの関数を追加する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SoapServer">
   <modifier>public</modifier> <type>void</type><methodname>SoapServer::addFunction</methodname>
   <methodparam><type class="union"><type>array</type><type>string</type><type>int</type></type><parameter>functions</parameter></methodparam>
  </methodsynopsis>
  <para>
   リモートクライアント用に単一もしくは複数の関数をエクスポートします。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>functions</parameter></term>
     <listitem>
      <para>
       単一の関数をエクスポートするには、
       このパラメータに文字列として関数名を渡してください。
      </para>
      <para>
       いくつかの関数をエクスポートするには、関数名の配列を渡してください。
      </para>
      <para>
       全ての関数をエクスポートするには、関数名の配列を渡してください。
      </para>
      <simpara>
       PHP 8.4.0 以降、<type>int</type> 値
       （<constant>SOAP_FUNCTIONS_ALL</constant> を含む）を渡すことは非推奨になりました。
       <function>get_defined_functions</function> を使って全ての関数を取得し、
       配列として渡してください。
      </simpara>
      <note>
       <para>
        <parameter>functions</parameter> は、全ての入力引数を
        WSDL ファイルで定義されている順序と同じ順序で受け取る必要があり
        (これらの関数は出力パラメータを引数として受け取ることはありません)
        、一つまたは複数の値を返す必要があります。
        複数の値を返すには、名前付き出力パラメータの配列を返す必要があります。
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </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.4.0</entry>
      <entry>
       <methodname>SoapServer::addFunction</methodname> に
       <type>int</type> を渡すこと
       （<constant>SOAP_FUNCTIONS_ALL</constant> を含む）は非推奨になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>SoapServer::addFunction</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

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

$server->addFunction("echoString");

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

$functions = array_merge(...get_defined_functions());
$server->addFunction($functions);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>SoapServer::__construct</methodname></member>
    <member><methodname>SoapServer::setClass</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
-->