mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
5faa7a6747
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324122 c90b9560-bf6c-de11-be94-00142212c4b1
99 lines
2.4 KiB
XML
99 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="oauthprovider.consumerhandler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>OAuthProvider::consumerHandler</refname>
|
|
<refpurpose>Set the consumerHandler handler callback</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>OAuthProvider::consumerHandler</methodname>
|
|
<methodparam><type>callable</type><parameter>callback_function</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the consumer handler callback, which will later be called with
|
|
<methodname>OAuthProvider::callConsumerHandler</methodname>.
|
|
</para>
|
|
|
|
&warn.undocumented.func;
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>callback_function</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <type>callable</type> functions name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Example <methodname>OAuthProvider::consumerHandler</methodname> callback</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function lookupConsumer($provider) {
|
|
|
|
if ($provider->consumer_key === 'unknown') {
|
|
return OAUTH_CONSUMER_KEY_UNKNOWN;
|
|
} else if($provider->consumer_key == 'blacklisted' || $provider->consumer_key === 'throttled') {
|
|
return OAUTH_CONSUMER_KEY_REFUSED;
|
|
}
|
|
|
|
$provider->consumer_secret = "the_consumers_secret";
|
|
|
|
return OAUTH_OK;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><methodname>OAuthProvider::callConsumerHandler</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
|
|
-->
|