joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation for new class.

Browse source
This commit is contained in:
Josh Sherman 2010-11-24 23:42:38 -05:00
parent d754757eee
commit dce116fa54
2 changed files with 305 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

237
docs/PICKLES/String.html Normal file
View file

@ -0,0 +1,237 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class String</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class String</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant string related manipulation.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---String.php.html">/classes/String.php</a> (line <span class="field">24</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#formatPhoneNumber" title="details" class="method-name">formatPhoneNumber</a>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>)
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#random" title="details" class="method-name">random</a>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$length</span> = <span class="var-default">8</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$alpha</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$numeric</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$similar</span> = <span class="var-default">true</span>])
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#truncate" title="details" class="method-name">truncate</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$length</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$hover</span> = <span class="var-default">true</span>])
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#upperWords" title="details" class="method-name">upperWords</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodformatPhoneNumber" id="formatPhoneNumber"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method formatPhoneNumber</span> (line <span class="line-number">38</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format Phone Number</p>
<p class="description"><p>Formats a 10 digit phone number with dashes as ###-###-####.</p></p>
<ul class="tags">
<li><span class="field">return:</span> formatted phone number</li>
<li><span class="field">todo:</span> Allow a format to be passed in, perhaps make it configurable in config.php</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
formatPhoneNumber
</span>
(<span class="var-type">integer</span>&nbsp;<span class="var-name">$number</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$number</span><span class="var-description">: number to format</span> </li>
</ul>
</div>
<a name="methodrandom" id="random"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method random</span> (line <span class="line-number">62</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Random</p>
<p class="description"><p>Generates a pseudo-random string based on the passed parameters.</p><p>Note: Similar characters = 0, O, 1, I (and may be expanded)</p></p>
<ul class="tags">
<li><span class="field">return:</span> generated string</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
random
</span>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$length</span> = <span class="var-default">8</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$alpha</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$numeric</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$similar</span> = <span class="var-default">true</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$length</span><span class="var-description">: optional length of the generated string</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$alpha</span><span class="var-description">: optional include alpha characters</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$numeric</span><span class="var-description">: optional include numeric characters</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$similar</span><span class="var-description">: optional include similar characters</span> </li>
</ul>
</div>
<a name="methodtruncate" id="truncate"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method truncate</span> (line <span class="line-number">122</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Truncate</p>
<p class="description"><p>Truncates a string to a specified length and (optionally) adds a span to provide a rollover to see the expanded text.</p></p>
<ul class="tags">
<li><span class="field">return:</span> truncate string</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
truncate
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$length</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$hover</span> = <span class="var-default">true</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$string</span><span class="var-description">: string to truncate</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$length</span><span class="var-description">: length to truncate to</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$hover</span><span class="var-description">: (optional) whether or not to add the rollover</span> </li>
</ul>
</div>
<a name="methodupperWords" id="upperWords"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method upperWords</span> (line <span class="line-number">153</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Upper Words</p>
<p class="description"><p>Applies strtolower() and ucwords() to the passed string. The exception being email addresses which are not formatted at all.</p></p>
<ul class="tags">
<li><span class="field">return:</span> formatted string</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
upperWords
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$string</span><span class="var-description">: string to format</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---String.php.html Normal file
View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page String.php</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="file-name">/classes/String.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String Utility Collection</p>
<p class="description"><p>PHP version 5</p><p>Licensed under The MIT License Redistribution of these files must retain the above copyright notice.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Josh Sherman &lt;<a href="mailto:josh@gravityblvd.com">josh@gravityblvd.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2010, Gravity Boulevard, LLC</li>
<li><span class="field">link:</span> <a href="http://p.ickl.es">http://p.ickl.es</a></li>
<li><span class="field">license:</span> <a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></li>
</ul>
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PICKLES/String.html">String</a>
</td>
<td>
String Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 24 Nov 2010 23:41:53 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>