pickles/docs/PICKLES/Cache.html

506 lines
No EOL
32 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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5511 103673176 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.5512 103702864 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.5513 103748344 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.5746 104128472 12. strftime() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:370
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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5779 104537072 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
6.5779 104538568 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:4
6.5780 104545648 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.5781 104548664 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.5782 104581352 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.5787 104592136 14. 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 Cache</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 Cache</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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5779 104537072 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
6.5794 104540040 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:59
6.5795 104546696 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.5796 104549416 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.5796 104581728 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.5806 104602368 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">Cache Class</p>
<p class="description"><p>Wrapper class for Memcache() to allow for better error handling when the Memcached server is unavailable. Designed around the syntax for Memcached() to allow for an easier transistion to the aforementioned in the future. I don't entirely remember specifics, but the reason for not using Memcached() was due to an unexplainable bug in the version in the repository for Ubuntu 10.04 LTS. Memcached() does support more of the memcached protocol and will eventually be what PICKLES uses.</p><p>Requires php5-memcache</p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://www.memcached.org/">http://www.memcached.org/</a></li>
<li><span class="field">link:</span> <a href="http://packages.ubuntu.com/lucid/php5-memcache">http://packages.ubuntu.com/lucid/php5-memcache</a></li>
<li><span class="field">link:</span> <a href="http://us.php.net/manual/en/book.memcache.php">http://us.php.net/manual/en/book.memcache.php</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---Cache.php.html">/classes/Cache.php</a> (line <span class="field">35</span>)
</p>
<pre>Object
|
--Cache</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">object self::$instance</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Cache'</span>])
</div>
<div class="method-definition">
<span class="method-result">Cache</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#delete" title="details" class="method-name">delete</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#get" title="details" class="method-name">get</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#increment" title="details" class="method-name">increment</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#open" title="details" class="method-name">open</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#set" title="details" class="method-name">set</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">300</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$expiration</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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5779 104537072 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
6.5818 104555648 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:684
6.5819 104562176 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.5820 104576680 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.5820 104615208 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.5834 104753520 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.5835 104755264 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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5779 104537072 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
6.5818 104555648 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:684
6.5819 104562176 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.5820 104576680 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.5820 104615208 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.5901 104786280 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.5903 104788024 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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5779 104537072 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
6.5818 104555648 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:684
6.5819 104562176 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.5820 104576680 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.5820 104615208 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.6025 104805912 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="methodgetInstance" id="getInstance"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getInstance</span> (line <span class="line-number">110</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Instance</p>
<p class="description"><p>Let's the parent class do all the work.</p></p>
<ul class="tags">
<li><span class="field">return:</span> instance of the Cache class</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">object self::$instance</span>
<span class="method-name">
getInstance
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">'Cache'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: name of the class to instantiate</span> </li>
</ul>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">69</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Sets up our connection variables.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Cache</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$hostname</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$port</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$database</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$hostname</span><span class="var-description">: optional hostname to connect to</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$database</span><span class="var-description">: optional port to use</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$port</span> </li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number">93</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destructor</p>
<p class="description"><p>Closes the connection when the object dies.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__destruct
</span>
()
</div>
</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">181</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delete Key</p>
<p class="description"><p>Deletes the specified key.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of deleting the key</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
delete
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to delete</span> </li>
</ul>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">get</span> (line <span class="line-number">139</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get Key</p>
<p class="description"><p>Gets the value of the key and returns it.</p></p>
<ul class="tags">
<li><span class="field">return:</span> value of the requested key, false if not set</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
get
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to retrieve</span> </li>
</ul>
</div>
<a name="methodincrement" id="increment"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">increment</span> (line <span class="line-number">200</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Increment Key</p>
<p class="description"><p>Increments the value of an existing key.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of incrementing the key</li>
<li><span class="field">todo:</span> Wondering if I should check the key and set to 1 if it's new</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
increment
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to increment</span> </li>
</ul>
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">open</span> (line <span class="line-number">120</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Opens Connection</p>
<p class="description"><p>Establishes a connection to the memcached server.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
open
</span>
()
</div>
</div>
<a name="methodset" id="set"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">set</span> (line <span class="line-number">163</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Key</p>
<p class="description"><p>Sets key to the specified value. I've found that compression can lead to issues with integers and can slow down the storage and retrieval of data (defeats the purpose of caching if you ask me) and isn't supported. I've also been burned by data inadvertantly being cached for infinity, hence the 5 minute default.</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of writing the data to the key</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
set
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">300</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$expiration</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: key to set</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: value to set</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$expiration</span><span class="var-description">: optional expiration, defaults to 5 minutes</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$expire</span> </li>
</ul>
</div>
</div>
</div>
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.5509 103627984 7. HTMLframesConverter->endClass() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converter.inc:1936
6.5510 103631384 8. Smarty->fetch() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc:347
6.5779 104537072 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
6.6158 104558896 10. Smarty->_smarty_include() /Users/josh/Source/pickles/docs/PICKLES/26d3399f63abd43a7d72f8c21440dcb0/%%165^%%1653142046^class.tpl.php:857
6.6158 104565128 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.6159 104567536 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.6160 104600576 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.6167 104613032 14. strftime() /usr/local/Cellar/php53/5.3.16/lib/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php:370
<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>