svn: /phpdoc/en/trunk/reference/oauth/ oauthprovider/generatetoken.xml versions.xml

From: Date: Mon, 31 May 2010 19:23:40 +0000
Subject: svn: /phpdoc/en/trunk/reference/oauth/ oauthprovider/generatetoken.xml versions.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-6764@lists.php.net to get a copy of this message
philip Mon, 31 May 2010 19:23:40 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=300006 Log: Documented the upcoming OAuthProvider::generateToken() Changed paths: A phpdoc/en/trunk/reference/oauth/oauthprovider/generatetoken.xml U phpdoc/en/trunk/reference/oauth/versions.xml Added: phpdoc/en/trunk/reference/oauth/oauthprovider/generatetoken.xml =================================================================== --- phpdoc/en/trunk/reference/oauth/oauthprovider/generatetoken.xml (rev 0) +++ phpdoc/en/trunk/reference/oauth/oauthprovider/generatetoken.xml 2010-05-31 19:23:40 UTC (rev 300006) @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> + +<refentry xml:id="oauthprovider.generatetoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>OAuthProvider::generateToken</refname> + <refpurpose>Generate a random token</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>OAuthProvider::generateToken</methodname> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>strong</parameter><initializer>false</initializer></methodparam> + </methodsynopsis> + <para> + Generates a <type>string</type> of pseudo-random bytes. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <variablelist> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + The desired token length, in terms of bytes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>strong</parameter></term> + <listitem> + <para> + Setting to &true; means <literal>/dev/random</literal> will be used for + entropy, as otherwise the non-blocking <literal>/dev/urandom</literal> is used. + This parameter is ignored on Windows. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The generated token, as a <type>string</type> of bytes. + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + If the <parameter>strong</parameter> parameter is &true;, then an + <constant>E_WARNING</constant> level error will be emitted when the + fallback <function>rand</function> implementation is used to fill + the remaining random bytes (e.g., when not enough random data was found, + initially). + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <example> + <title><function>OAuthProvider::generateToken</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$p = new OAuthProvider(); + +$t = $p->generateToken(4); + +echo strlen($t), PHP_EOL; +echo bin2hex($t), PHP_EOL; + +?> +]]> + </programlisting> + &example.outputs.similar; + <screen> +<![CDATA[ +4 +b6a82c27 +]]> + </screen> + </example> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + When not enough random data is available to the system, this function will + fill the remaining random bytes using the internal PHP <function>rand</function> + implementation. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <simplelist> + <member><function>openssl_random_pseudo_bytes</function></member> + <member><function>mcrypt_create_iv</function></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 +--> Property changes on: phpdoc/en/trunk/reference/oauth/oauthprovider/generatetoken.xml ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL Added: svn:eol-style + native Modified: phpdoc/en/trunk/reference/oauth/versions.xml =================================================================== --- phpdoc/en/trunk/reference/oauth/versions.xml 2010-05-31 19:20:08 UTC (rev 300005) +++ phpdoc/en/trunk/reference/oauth/versions.xml 2010-05-31 19:23:40 UTC (rev 300006) @@ -50,6 +50,7 @@ <function name='OAuthProvider::checkOauthRequest' from='PECL OAuth &gt;= 1.0.0'/> <function name='OAuthProvider::__construct' from='PECL OAuth &gt;= 1.0.0'/> <function name='OAuthProvider::consumerHandler' from='PECL OAuth &gt;= 1.0.0'/> + <function name='OAuthProvider::generateToken' from='PECL OAuth &gt;= 1.0.0'/> <function name='OAuthProvider::is2LeggedEndpoint' from='PECL OAuth &gt;= 1.0.0'/> <function name='OAuthProvider::isRequestTokenEndpoint' from='PECL OAuth &gt;= 1.0.0'/> <function name='OAuthProvider::removeRequiredParameter' from='PECL OAuth &gt;= 1.0.0'/>

« previous php.doc.cvs (#6764) next »