setparam.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 16f141aeafbcc8a5e70f2acb6798765a78def32c Maintainer: takagi Status: ready -->

<refentry xml:id="oauthprovider.setparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>OAuthProvider::setParam</refname>
  <refpurpose>パラメータを設定する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>OAuthProvider::setParam</methodname>
   <methodparam><type>string</type><parameter>param_key</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>param_val</parameter></methodparam>
  </methodsynopsis>
  <para>
   パラメータを設定します。
  </para>

  &warn.undocumented.func;

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>param_key</parameter></term>
    <listitem>
     <para>
      パラメータのキー。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>param_val</parameter></term>
    <listitem>
     <para>
      パラメータの値。
     </para>
     <para>
      パラメータをシグネチャの検証から除外するには、この値を &null; にします。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>OAuthProvider::addRequiredParameter</methodname></member>
  </simplelist>
 </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
-->