<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="oauthprovider.checkoauthrequest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>OAuthProvider::checkOAuthRequest</refname>
  <refpurpose>Check an oauth request</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>void</type><methodname>OAuthProvider::checkOAuthRequest</methodname>
   <methodparam choice="opt"><type>string</type><parameter>uri</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>method</parameter></methodparam>
  </methodsynopsis>
  <para>
   Checks an OAuth request.
  </para>

  &warn.undocumented.func;

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>uri</parameter></term>
    <listitem>
     <para>
      The optional <acronym>URI</acronym>, or endpoint.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>method</parameter></term>
    <listitem>
     <para>
      The <acronym>HTTP</acronym> method. Optionally pass in one of the 
      <constant>OAUTH_HTTP_METHOD_*</constant> <link linkend="oauth.constants">OAuth constants</link>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Emits an <constant>E_ERROR</constant> level error if
   the HTTP method cannot be detected.
  </para>
 </refsect1>

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