pickles/docs/PICKLES/Browser.html

274 lines
No EOL
19 KiB
HTML

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.0504 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.2081 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.0026 101044048 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.1709 101132944 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.1709 101133256 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
6.4436 103461440 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.4438 103465112 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.4439 103506800 9. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1296
6.4445 103536464 10. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
6.4446 103584688 11. Smarty_Compiler->_compile_file() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1523
6.4693 103959312 12. strftime() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:370
<?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 Browser</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 Browser</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">
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.0504 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.2081 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.0026 101044048 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.1709 101132944 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.1709 101133256 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
6.4436 103461440 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.4438 103465112 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.4725 104360216 9. include('/Users/josh/Source/pickles/docs/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
6.4727 104362664 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:59
6.4728 104369376 11. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1935
6.4731 104372016 12. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
6.4733 104404952 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
6.4743 104425480 14. strftime() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:370
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Browser Utility Class</p>
<p class="description"><p>Just a simple collection of static functions to accomplish some of the more redundant browser-related tasks.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Browser.php.html">/classes/Browser.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">boolean</span>
<a href="#isMobile" title="details" class="method-name">isMobile</a>
()
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#redirect" title="details" class="method-name">redirect</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#status" title="details" class="method-name">status</a>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">200</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">
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.0504 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.2081 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.0026 101044048 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.1709 101132944 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.1709 101133256 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
6.4436 103461440 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.4438 103465112 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.4725 104360216 9. include('/Users/josh/Source/pickles/docs/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
6.4753 104372440 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:684
6.4754 104379144 11. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1935
6.4758 104393704 12. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
6.4759 104432776 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
6.4772 104572808 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
6.4774 104574552 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
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.0504 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.2081 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.0026 101044048 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.1709 101132944 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.1709 101133256 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
6.4436 103461440 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.4438 103465112 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.4725 104360216 9. include('/Users/josh/Source/pickles/docs/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
6.4753 104372440 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:684
6.4754 104379144 11. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1935
6.4758 104393704 12. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
6.4759 104432776 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
6.4834 104605432 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
6.4836 104607192 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.0504 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.2081 15420440 3. phpDocumentor_setup->createDocs() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc:65
6.0026 101044048 4. phpDocumentor_IntermediateParser->Output() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Setup.inc.php:763
6.1709 101132944 5. phpDocumentor_IntermediateParser->Convert() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1867
6.1709 101133256 6. Converter->walk() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1654
6.4436 103461440 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.4438 103465112 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.4725 104360216 9. include('/Users/josh/Source/pickles/docs/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
6.4753 104372440 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:684
6.4754 104379144 11. Smarty->_compile_resource() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1935
6.4758 104393704 12. Smarty->_compile_source() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php:1458
6.4759 104432776 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
6.4899 104624120 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='method_detail'></A>
<a name="methodisMobile" id="isMobile"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method isMobile</span> (line <span class="line-number">33</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is Mobile</p>
<p class="description"><p>Detects if we're working with a mobile browser.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not the browser is considered mobile</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">boolean</span>
<span class="method-name">
isMobile
</span>
()
</div>
</div>
<a name="methodredirect" id="redirect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method redirect</span> (line <span class="line-number">52</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Redirect</p>
<p class="description"><p>Redirects the browser to another URL. Stops execution as to not run code erroneously due to output buffering. HTTP/1.1 request an absolute URI, hence the inclusion of the scheme, hostname and absolute path if :// is not found. Don't hate the player, hate the RFC.</p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
redirect
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$destination</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$destination</span><span class="var-description">: URL to redirect to</span> </li>
</ul>
</div>
<a name="methodstatus" id="status"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method status</span> (line <span class="line-number">75</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Status</p>
<p class="description"><p>Pushes a status code to the browser. Some of these codes are site (420) and server (444) specific, some just for LOLs (418) and some that are still in draft (425) and subject to change. I wanted this to be a complete list and in the scenario that a code had multiple meanings, I favored a more recent RFC (424) even if merely a draft (451).</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">void</span>
<span class="method-name">
status
</span>
([<span class="var-type">integer</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">200</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$code</span><span class="var-description">: status response code</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>