<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Generate a random token</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="oauthprovider.consumerhandler.html">OAuthProvider::consumerHandler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oauthprovider.is2leggedendpoint.html">OAuthProvider::is2LeggedEndpoint</a></div>
<div class="up"><a href="class.oauthprovider.html">OAuthProvider</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="oauthprovider.generatetoken" class="refentry">
<div class="refnamediv">
<h1 class="refname">OAuthProvider::generateToken</h1>
<p class="verinfo">(PECL OAuth >= 1.0.0)</p><p class="refpurpose"><span class="refname">OAuthProvider::generateToken</span> — <span class="dc-title">Generate a random token</span></p>
</div>
<div class="refsect1 description" id="refsect1-oauthprovider.generatetoken-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><strong>OAuthProvider::generateToken</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$strong</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Generates a <span class="type"><a href="language.types.string.html" class="type string">string</a></span> of pseudo-random bytes.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-oauthprovider.generatetoken-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">
The desired token length, in terms of bytes.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">strong</code></em></span>
<dd>
<p class="para">
Setting to <strong><code>TRUE</code></strong> means <em>/dev/random</em> will be used for
entropy, as otherwise the non-blocking <em>/dev/urandom</em> is used.
This parameter is ignored on Windows.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-oauthprovider.generatetoken-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The generated token, as a <span class="type"><a href="language.types.string.html" class="type string">string</a></span> of bytes.
</p>
</div>
<div class="refsect1 errors" id="refsect1-oauthprovider.generatetoken-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If the <em><code class="parameter">strong</code></em> parameter is <strong><code>TRUE</code></strong>, then an
<strong><code>E_WARNING</code></strong> level error will be emitted when the
fallback <span class="function"><a href="function.rand.html" class="function">rand()</a></span> implementation is used to fill
the remaining random bytes (e.g., when not enough random data was found,
initially).
</p>
</div>
<div class="refsect1 examples" id="refsect1-oauthprovider.generatetoken-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5291">
<p><strong>Example #1 <span class="function"><strong>OAuthProvider::generateToken()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">OAuthProvider</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$t </span><span style="color: #007700">= </span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">generateToken</span><span style="color: #007700">(</span><span style="color: #0000BB">4</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$t</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">bin2hex</span><span style="color: #007700">(</span><span style="color: #0000BB">$t</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
4
b6a82c27
</pre></div>
</div>
</div>
</div>
<div class="refsect1 notes" id="refsect1-oauthprovider.generatetoken-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
When not enough random data is available to the system, this function will
fill the remaining random bytes using the internal PHP <span class="function"><a href="function.rand.html" class="function">rand()</a></span>
implementation.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-oauthprovider.generatetoken-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.openssl-random-pseudo-bytes.html" class="function" rel="rdfs-seeAlso">openssl_random_pseudo_bytes()</a> - Generate a pseudo-random string of bytes</span></li>
<li class="member"> <span class="function"><a href="function.mcrypt-create-iv.html" class="function" rel="rdfs-seeAlso">mcrypt_create_iv()</a> - Creates an initialization vector (IV) from a random source</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="oauthprovider.consumerhandler.html">OAuthProvider::consumerHandler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="oauthprovider.is2leggedendpoint.html">OAuthProvider::is2LeggedEndpoint</a></div>
<div class="up"><a href="class.oauthprovider.html">OAuthProvider</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
