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

Added new class documentation

Browse source
This commit is contained in:
Josh Sherman 2012-10-11 18:55:33 -04:00
parent c0afa08026
commit fb4c8c1a5a
2 changed files with 481 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

413
docs/PICKLES/Time.html Normal file
View file

@ -0,0 +1,413 @@
<?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 Time</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 Time</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>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Time Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant time and date related manipulation.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Time.php.html">/classes/Time.php</a> (line <span class="field">24</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="const-summary">
<div class="const-title">
<a href="#CENTURY" title="details" class="const-name">CENTURY</a> = <span class="var-type"> 3153600000</span>
</div>
<div class="const-title">
<a href="#DAY" title="details" class="const-name">DAY</a> = <span class="var-type"> 86400</span>
</div>
<div class="const-title">
<a href="#DECADE" title="details" class="const-name">DECADE</a> = <span class="var-type"> 315360000</span>
</div>
<div class="const-title">
<a href="#HOUR" title="details" class="const-name">HOUR</a> = <span class="var-type"> 3600</span>
</div>
<div class="const-title">
<a href="#MINUTE" title="details" class="const-name">MINUTE</a> = <span class="var-type"> 60</span>
</div>
<div class="const-title">
<a href="#MONTH" title="details" class="const-name">MONTH</a> = <span class="var-type"> 2592000</span>
</div>
<div class="const-title">
<a href="#QUARTER" title="details" class="const-name">QUARTER</a> = <span class="var-type"> 7776000</span>
</div>
<div class="const-title">
<a href="#WEEK" title="details" class="const-name">WEEK</a> = <span class="var-type"> 604800</span>
</div>
<div class="const-title">
<a href="#YEAR" title="details" class="const-name">YEAR</a> = <span class="var-type"> 31536000</span>
</div>
</div>
</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> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</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">integer</span>
<a href="#age" title="details" class="method-name">age</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#timestamp" title="details" class="method-name">timestamp</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">'Y-m-d H:i:s'</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-const-summary">Constants</a> (<a href="#sec-consts">details</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="methodage" id="age"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method age</span> (line <span class="line-number">120</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Age</p>
<p class="description"><p>Calculates age based on the passed date.</p></p>
<ul class="tags">
<li><span class="field">return:</span> number of years old</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">integer</span>
<span class="method-name">
age
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$date</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$date</span><span class="var-description">: birth / inception date</span> </li>
</ul>
</div>
<a name="methodtimestamp" id="timestamp"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method timestamp</span> (line <span class="line-number">148</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Timestamp</p>
<p class="description"><p>Current Universal Time in the specified format.</p></p>
<ul class="tags">
<li><span class="field">return:</span> formatted timestamp</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">
timestamp
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">'Y-m-d H:i:s'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$format</span><span class="var-description">: format of the timestamp</span> </li>
</ul>
</div>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
Strict standards: Only variables should be passed by reference in /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
Call Stack:
0.0001 642352 1. {main}() /usr/local/Cellar/php53/5.3.16/bin/phpdoc:0
0.0003 658000 2. require('/usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc') /usr/local/Cellar/php53/5.3.16/bin/phpdoc:40
0.0820 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.3422 97029544 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.4874 97095512 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.4874 97095832 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
8.0597 100972328 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
8.0598 100975768 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
8.0629 101853472 9. include('/Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php') /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1298
8.0665 101874352 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:786
8.0666 101880544 11. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1935
8.0667 101883944 12. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
8.0668 101916488 13. Smarty_Compiler->_compile_file() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1523
8.0675 101936992 14. Smarty_Compiler->_compile_tag() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:316
8.0677 101938832 15. Smarty_Compiler->_compile_custom_tag() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:537
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/New_York' for 'EDT/-4.0/DST' instead in /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
Call Stack:
0.0001 642352 1. {main}() /usr/local/Cellar/php53/5.3.16/bin/phpdoc:0
0.0003 658000 2. require('/usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc') /usr/local/Cellar/php53/5.3.16/bin/phpdoc:40
0.0820 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.3422 97029544 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.4874 97095512 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.4874 97095832 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
8.0597 100972328 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
8.0598 100975768 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
8.0629 101853472 9. include('/Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php') /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1298
8.0665 101874352 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:786
8.0666 101880544 11. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1935
8.0667 101883944 12. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
8.0668 101916488 13. Smarty_Compiler->_compile_file() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1523
8.0695 101943888 14. strftime() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:370
<a name="constCENTURY" id="CENTURY"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">CENTURY</span>
= <span class="const-default"> 3153600000</span>
(line <span class="line-number">107</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Century</p>
<p class="description"><p>Seconds in a decade (decade * 10)</p></p>
</div>
<a name="constDAY" id="DAY"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">DAY</span>
= <span class="const-default"> 86400</span>
(line <span class="line-number">53</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Day</p>
<p class="description"><p>Seconds in a day (hour * 24)</p></p>
</div>
<a name="constDECADE" id="DECADE"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">DECADE</span>
= <span class="const-default"> 315360000</span>
(line <span class="line-number">98</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Decade</p>
<p class="description"><p>Seconds in a decade (year * 10)</p></p>
</div>
<a name="constHOUR" id="HOUR"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">HOUR</span>
= <span class="const-default"> 3600</span>
(line <span class="line-number">44</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Hour</p>
<p class="description"><p>Seconds in an hour (minute * 60)</p></p>
</div>
<a name="constMINUTE" id="MINUTE"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">MINUTE</span>
= <span class="const-default"> 60</span>
(line <span class="line-number">35</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Minute</p>
<p class="description"><p>Seconds in a minute</p></p>
</div>
<a name="constMONTH" id="MONTH"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">MONTH</span>
= <span class="const-default"> 2592000</span>
(line <span class="line-number">71</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Month</p>
<p class="description"><p>Seconds in a month (day * 30)</p></p>
</div>
<a name="constQUARTER" id="QUARTER"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">QUARTER</span>
= <span class="const-default"> 7776000</span>
(line <span class="line-number">80</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Quarter</p>
<p class="description"><p>Seconds in a quarter (day * 90)</p></p>
</div>
<a name="constWEEK" id="WEEK"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">WEEK</span>
= <span class="const-default"> 604800</span>
(line <span class="line-number">62</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Week</p>
<p class="description"><p>Seconds in a week (day * 7)</p></p>
</div>
<a name="constYEAR" id="YEAR"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<span class="const-title">
<span class="const-name">YEAR</span>
= <span class="const-default"> 31536000</span>
(line <span class="line-number">89</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Year</p>
<p class="description"><p>Seconds in a year (day * 365)</p></p>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 11 Oct 2012 18:39:32 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>

68
docs/PICKLES/_classes---Time.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 Time.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/Time.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">Time 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:pickles@joshtronic.com">pickles@joshtronic.com</a>&gt;</li>
<li><span class="field">copyright:</span> Copyright 2007-2012, Josh Sherman</li>
<li><span class="field">link:</span> <a href="https://github.com/joshtronic/pickles">https://github.com/joshtronic/pickles</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/Time.html">Time</a>
</td>
<td>
Time Class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 11 Oct 2012 18:39:32 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>