php-doc-en/reference/oauth/oauthprovider/setparam.xml
2014-11-13 22:02:55 +00:00

86 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Set a parameter</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>
Sets a parameter.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>param_key</parameter></term>
<listitem>
<para>
The parameter key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_val</parameter></term>
<listitem>
<para>
The optional parameter value.
</para>
<para>
To exclude a parameter from signature verification, set
its value to &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
-->