miniMVC/docs/classes/Bcrypt.html

204 lines
11 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » \Bcrypt</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul><li>todo 
<span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Create a new Bcrypt object"><span class="description">Create a new Bcrypt object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#hash" title="hash :: Returns a has for the input string"><span class="description">Returns a has for the input string</span><pre>hash()</pre></a></li>
<li class="method public "><a href="#verify" title="verify :: Check if a password hash is valid"><span class="description">Check if a password hash is valid</span><pre>verify()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#encodeBytes" title="encodeBytes :: Further randomizes salt?"><span class="description">Further randomizes salt?</span><pre>encodeBytes()</pre></a></li>
<li class="method private "><a href="#getRandomBytes" title="getRandomBytes :: Private method to generate random characters for salt"><span class="description">Private method to generate random characters for salt</span><pre>getRandomBytes()</pre></a></li>
<li class="method private "><a href="#getSalt" title="getSalt :: Private function to generate the random salt"><span class="description">Private function to generate the random salt</span><pre>getSalt()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24randomState" title="$randomState :: Stores random seed"><span class="description">Stores random seed</span><pre>$randomState</pre></a></li>
<li class="property private "><a href="#%24rounds" title="$rounds :: Number of times to recurse"><span class="description">Number of times to recurse</span><pre>$rounds</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CBcrypt" id="\Bcrypt"></a><div href="../classes/Bcrypt.html" class="element class">
<p class="short_description">Class to simplify dealing with bcrypt for password handling</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td></td>
</tr>
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.libraries.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>libraries</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Create a new Bcrypt object</h2>
<pre>__construct(int $rounds) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$rounds</h4>
<code>int</code>
</div>
</div></div>
</div>
<a name="hash" id="hash"></a><div class="element clickable method public hash" data-toggle="collapse" data-target=".hash .collapse">
<h2>Returns a has for the input string</h2>
<pre>hash($input) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$input</h4>
<code></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="verify" id="verify"></a><div class="element clickable method public verify" data-toggle="collapse" data-target=".verify .collapse">
<h2>Check if a password hash is valid</h2>
<pre>verify($input, $existingHash) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$input</h4>
<code></code><p>string</p></div>
<div class="subelement argument">
<h4>$existingHash</h4>
<code></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="encodeBytes" id="encodeBytes"></a><div class="element clickable method private encodeBytes" data-toggle="collapse" data-target=".encodeBytes .collapse">
<h2>Further randomizes salt?</h2>
<pre>encodeBytes($input) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$input</h4>
<code></code><p>string</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="getRandomBytes" id="getRandomBytes"></a><div class="element clickable method private getRandomBytes" data-toggle="collapse" data-target=".getRandomBytes .collapse">
<h2>Private method to generate random characters for salt</h2>
<pre>getRandomBytes($count) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$count</h4>
<code></code><p>int</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<a name="getSalt" id="getSalt"></a><div class="element clickable method private getSalt" data-toggle="collapse" data-target=".getSalt .collapse">
<h2>Private function to generate the random salt</h2>
<pre>getSalt() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>string</code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24randomState" id="$randomState"> </a><div class="element clickable property private $randomState" data-toggle="collapse" data-target=".$randomState .collapse">
<h2>Stores random seed</h2>
<pre>$randomState : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24rounds" id="$rounds"> </a><div class="element clickable property private $rounds" data-toggle="collapse" data-target=".$rounds .collapse">
<h2>Number of times to recurse</h2>
<pre>$rounds : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-07-03T13:29:42-04:00.<br></footer></div>
</div>
</body>
</html>