Permalink
Browse files

sag 0.8 docs

  • Loading branch information...
1 parent a1ef0b6 commit dd36520c3ec9e92b243bc1752a6d8fed16e715a9 @sbisbee committed Feb 26, 2013
Showing with 15,833 additions and 8,822 deletions.
  1. +0 −591 phpdocs/Cache/SagCache.html
  2. +0 −431 phpdocs/Cache/SagFileCache.html
  3. +0 −383 phpdocs/Cache/SagMemoryCache.html
  4. +0 −87 phpdocs/Cache/_SagCache.php.html
  5. +0 −88 phpdocs/Cache/_SagFileCache.php.html
  6. +0 −88 phpdocs/Cache/_SagMemoryCache.php.html
  7. +0 −1,663 phpdocs/Core/Sag.html
  8. +0 −167 phpdocs/Core/SagConfigurationCheck.html
  9. +0 −304 phpdocs/Core/SagCouchException.html
  10. +0 −304 phpdocs/Core/SagException.html
  11. +0 −94 phpdocs/Core/_Sag.php.html
  12. +0 −86 phpdocs/Core/_SagConfigurationCheck.php.html
  13. +0 −86 phpdocs/Core/_SagCouchException.php.html
  14. +0 −86 phpdocs/Core/_SagException.php.html
  15. +0 −368 phpdocs/HTTP/SagCURLHTTPAdapter.html
  16. +0 −825 phpdocs/HTTP/SagHTTPAdapter.html
  17. +0 −425 phpdocs/HTTP/SagNativeHTTPAdapter.html
  18. +0 −83 phpdocs/HTTP/_httpAdapters---SagCURLHTTPAdapter.php.html
  19. +0 −83 phpdocs/HTTP/_httpAdapters---SagHTTPAdapter.php.html
  20. +0 −87 phpdocs/HTTP/_httpAdapters---SagNativeHTTPAdapter.php.html
  21. +0 −357 phpdocs/Utils/SagUserUtils.html
  22. +0 −81 phpdocs/Utils/_SagUserUtils.php.html
  23. +131 −0 phpdocs/classes.svg
  24. +0 −56 phpdocs/classtrees_Cache.html
  25. +0 −64 phpdocs/classtrees_Core.html
  26. +0 −56 phpdocs/classtrees_HTTP.html
  27. +0 −54 phpdocs/classtrees_Utils.html
  28. +17 −0 phpdocs/content.html
  29. +202 −0 phpdocs/css/abstract.css
  30. +81 −0 phpdocs/css/sen.full.min.css
  31. +31 −0 phpdocs/css/template.css
  32. +0 −395 phpdocs/elementindex.html
  33. +0 −187 phpdocs/elementindex_Cache.html
  34. +0 −277 phpdocs/elementindex_Core.html
  35. +0 −202 phpdocs/elementindex_HTTP.html
  36. +0 −121 phpdocs/elementindex_Utils.html
  37. +0 −103 phpdocs/errors.html
  38. +156 −0 phpdocs/files/Sag.html
  39. +48 −0 phpdocs/files/SagCache.html
  40. +17 −0 phpdocs/files/SagCouchException.html
  41. +15 −0 phpdocs/files/SagException.html
  42. +67 −0 phpdocs/files/SagFileCache.html
  43. +56 −0 phpdocs/files/SagMemoryCache.html
  44. +43 −0 phpdocs/files/SagUserUtils.html
  45. +92 −0 phpdocs/files/httpAdapters.SagCURLHTTPAdapter.html
  46. +49 −0 phpdocs/files/httpAdapters.SagHTTPAdapter.html
  47. +92 −0 phpdocs/files/httpAdapters.SagNativeHTTPAdapter.html
  48. +46 −0 phpdocs/graph.html
  49. BIN phpdocs/images/collapse_all.png
  50. BIN phpdocs/images/expand_all.png
  51. BIN phpdocs/images/icons/arrow_down.png
  52. BIN phpdocs/images/icons/arrow_right.png
  53. BIN phpdocs/images/icons/class.png
  54. BIN phpdocs/images/icons/constant.png
  55. BIN phpdocs/images/icons/favicon.ico
  56. BIN phpdocs/images/icons/file-php.png
  57. BIN phpdocs/images/icons/file.gif
  58. BIN phpdocs/images/icons/folder.gif
  59. BIN phpdocs/images/icons/function.png
  60. BIN phpdocs/images/icons/interface.png
  61. BIN phpdocs/images/icons/method.png
  62. BIN phpdocs/images/icons/ok.png
  63. BIN phpdocs/images/icons/property.png
  64. BIN phpdocs/images/icons/search.gif
  65. BIN phpdocs/images/icons/variable.png
  66. BIN phpdocs/images/icons/view_source.png
  67. BIN phpdocs/images/icons/visibility_private.png
  68. BIN phpdocs/images/icons/visibility_protected.png
  69. BIN phpdocs/images/icons/visibility_public.png
  70. BIN phpdocs/images/logo.png
  71. BIN phpdocs/images/search.gif
  72. +2 −72 phpdocs/index.html
  73. +232 −0 phpdocs/js/SVGPan.js
  74. +154 −0 phpdocs/js/jquery-1.4.2.min.js
  75. +9,270 −0 phpdocs/js/jquery-1.7.1.min.js
  76. +1,012 −0 phpdocs/js/jquery-ui-1.8.2.custom.min.js
  77. +104 −0 phpdocs/js/jquery.cookie.js
  78. +467 −0 phpdocs/js/jquery.panzoom.js
  79. +228 −0 phpdocs/js/jquery.splitter.js
  80. +115 −0 phpdocs/js/jquery.tools.min.js
  81. +256 −0 phpdocs/js/jquery.treeview.js
  82. +31 −0 phpdocs/js/menu.js
  83. +45 −0 phpdocs/js/sidebar.js
  84. +32 −0 phpdocs/js/template.js
  85. +0 −69 phpdocs/li_Cache.html
  86. +0 −72 phpdocs/li_Core.html
  87. +0 −69 phpdocs/li_HTTP.html
  88. +0 −63 phpdocs/li_Utils.html
  89. BIN phpdocs/media/background.png
  90. BIN phpdocs/media/empty.png
  91. +0 −195 phpdocs/media/style.css
  92. +3 −0 phpdocs/nav.html
  93. +21 −0 phpdocs/report_deprecated.html
  94. +36 −0 phpdocs/report_markers.html
  95. +484 −0 phpdocs/report_parse_markers.html
  96. +2,198 −0 phpdocs/structure.xml
View

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -1,383 +0,0 @@
-<html>
-<head>
-<title>Docs For Class SagMemoryCache</title>
-<link rel="stylesheet" type="text/css" href="../media/style.css">
-</head>
-<body>
-
-<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
- <tr>
- <td class="header_top">Cache</td>
- </tr>
- <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
- <tr>
- <td class="header_menu">
-
-
- [ <a href="../classtrees_Cache.html" class="menu">class tree: Cache</a> ]
- [ <a href="../elementindex_Cache.html" class="menu">index: Cache</a> ]
- [ <a href="../elementindex.html" class="menu">all elements</a> ]
- </td>
- </tr>
- <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
-</table>
-
-<table width="100%" border="0" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="200" class="menu">
- <b>Packages:</b><br />
- <a href="../li_Core.html">Core</a><br />
- <a href="../li_Cache.html">Cache</a><br />
- <a href="../li_HTTP.html">HTTP</a><br />
- <a href="../li_Utils.html">Utils</a><br />
- <br /><br />
- <b>Files:</b><br />
- <div class="package">
- <a href="../Cache/_SagCache.php.html"> SagCache.php
- </a><br>
- <a href="../Cache/_SagFileCache.php.html"> SagFileCache.php
- </a><br>
- <a href="../Cache/_SagMemoryCache.php.html"> SagMemoryCache.php
- </a><br>
- </div><br />
-
-
- <b>Classes:</b><br />
- <div class="package">
- <a href="../Cache/SagCache.html">SagCache</a><br />
- <a href="../Cache/SagFileCache.html">SagFileCache</a><br />
- <a href="../Cache/SagMemoryCache.html">SagMemoryCache</a><br />
- </div>
- </td>
- <td>
- <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
-
-<h1>Class: SagMemoryCache</h1>
-Source Location: /SagMemoryCache.php<br /><br />
-
-
-<table width="100%" border="0">
-<tr><td valign="top">
-
-<h3><a href="#class_details">Class Overview</a></h3>
-<pre><a href="../Cache/SagCache.html">SagCache</a>
- |
- --SagMemoryCache</pre><br />
-<div class="description">Stores cached items in PHP's memory as serialized JSON, which was benchmarked as being faster than serliaze() and clone.</div><br /><br />
-<h4>Author(s):</h4>
-<ul>
- </ul>
-
-
-
-
-
-
-<h4>Version:</h4>
-<ul>
- <li>0.7.0</li>
-</ul>
-
-
-</td>
-
-
-
-<td valign="top">
-<h3><a href="#class_methods">Methods</a></h3>
-<ul>
- <li><a href="../Cache/SagMemoryCache.html#method__construct">__construct</a></li>
- <li><a href="../Cache/SagMemoryCache.html#methodclear">clear</a></li>
- <li><a href="../Cache/SagMemoryCache.html#methodget">get</a></li>
- <li><a href="../Cache/SagMemoryCache.html#methodremove">remove</a></li>
- <li><a href="../Cache/SagMemoryCache.html#methodset">set</a></li>
- </ul>
-</td>
-
-</tr></table>
-<hr />
-
-<table width="100%" border="0"><tr>
-
-
-
-
-
-<td valign="top">
-<h3>Inherited Methods</h3>
-<div class="tags">
-<h4>Class: <a href="../Cache/SagCache.html">SagCache</a></h4>
-<dl>
- <dt>
- <a href="../Cache/SagCache.html#method__construct">SagCache::__construct()</a>
- </dt>
- <dd>
-
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodaddToSize">SagCache::addToSize()</a>
- </dt>
- <dd>
-
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodclear">SagCache::clear()</a>
- </dt>
- <dd>
- Clears the whole cache without applying any logic.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodget">SagCache::get()</a>
- </dt>
- <dd>
- Returns the cached object or null if nothing is cached.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodgetSize">SagCache::getSize()</a>
- </dt>
- <dd>
- Returns the max size of the cache, irrespective of what is or isn't in the cache.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodgetUsage">SagCache::getUsage()</a>
- </dt>
- <dd>
- Returns the total size of the items in the cache in bytes. Not reliable if you're using SagMemoryCache.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodmakeKey">SagCache::makeKey()</a>
- </dt>
- <dd>
- Generates the hash of the provided URL that will be used as the cache key.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodmayCache">SagCache::mayCache()</a>
- </dt>
- <dd>
- Returns whether or not the item may be cached. It has to be a stdClass that Sag would return, with a valid E-Tag, and no cache headers that tell us to not cache.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodremove">SagCache::remove()</a>
- </dt>
- <dd>
- Removes the item from the cache and returns it (null if nothing was cached).
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodset">SagCache::set()</a>
- </dt>
- <dd>
- Caches the item returned at the provided key, replacing any pre-existing cached item. If the cache's size will be exceeded by caching the new item, then it will remove items from the cache until there is sufficient room.
- </dd>
- <dt>
- <a href="../Cache/SagCache.html#methodsetSize">SagCache::setSize()</a>
- </dt>
- <dd>
- Sets the max size of the cache in bytes.
- </dd>
- </dl>
-</div>
-</td>
-
-</tr></table>
-<hr />
-
-<a name="class_details"></a>
-<h3>Class Details</h3>
-<div class="tags">
-[line 29]<br />
-Stores cached items in PHP's memory as serialized JSON, which was benchmarked as being faster than serliaze() and clone.<br /><br /><p>Memory sizes will not be exact because of how PHP allocates and cleans memory.</p><br /><br /><br />
-<h4>Tags:</h4>
-<div class="tags">
-<table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td><b>version:</b>&nbsp;&nbsp;</td><td>0.7.0</td>
- </tr>
-</table>
-</div>
-</div><br /><br />
-<div class="top">[ <a href="#top">Top</a> ]</div><br />
-
-
-<hr />
-<a name="class_methods"></a>
-<h3>Class Methods</h3>
-<div class="tags">
-
- <hr />
- <a name="method__construct"></a>
- <h3>constructor __construct <span class="smalllinenumber">[line 32]</span></h3>
- <div class="function">
- <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
- <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
- <code>SagMemoryCache __construct(
-)</code>
- </td></tr></table>
- </td></tr></table><br />
-
- <br /><br />
-<h4>Tags:</h4>
-<div class="tags">
-<table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
- </tr>
-</table>
-</div>
-<br /><br />
-
- Overrides <a href="../Cache/SagCache.html#method__construct">SagCache::__construct()</a> (parent method not documented)<br /><br />
- <div class="top">[ <a href="#top">Top</a> ]</div>
- </div>
- <hr />
- <a name="methodclear"></a>
- <h3>method clear <span class="smalllinenumber">[line 79]</span></h3>
- <div class="function">
- <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
- <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
- <code>void clear(
-)</code>
- </td></tr></table>
- </td></tr></table><br />
-
- <br /><br />
-<h4>Tags:</h4>
-<div class="tags">
-<table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
- </tr>
-</table>
-</div>
-<br /><br />
-
- Overrides <a href="../Cache/SagCache.html#methodclear">SagCache::clear()</a> (Clears the whole cache without applying any logic.)<br /><br />
- <div class="top">[ <a href="#top">Top</a> ]</div>
- </div>
- <hr />
- <a name="methodget"></a>
- <h3>method get <span class="smalllinenumber">[line 63]</span></h3>
- <div class="function">
- <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
- <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
- <code>void get(
-
-$url)</code>
- </td></tr></table>
- </td></tr></table><br />
-
- <br /><br />
-<h4>Tags:</h4>
-<div class="tags">
-<table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
- </tr>
-</table>
-</div>
-<br /><br />
-
- Overrides <a href="../Cache/SagCache.html#methodget">SagCache::get()</a> (Returns the cached object or null if nothing is cached.)<br /><br />
- <h4>Parameters:</h4>
- <div class="tags">
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td class="type">&nbsp;&nbsp;</td>
- <td><b>$url</b>&nbsp;&nbsp;</td>
- <td></td>
- </tr>
- </table>
- </div><br />
- <div class="top">[ <a href="#top">Top</a> ]</div>
- </div>
- <hr />
- <a name="methodremove"></a>
- <h3>method remove <span class="smalllinenumber">[line 67]</span></h3>
- <div class="function">
- <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
- <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
- <code>void remove(
-
-$url)</code>
- </td></tr></table>
- </td></tr></table><br />
-
- <br /><br />
-<h4>Tags:</h4>
-<div class="tags">
-<table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
- </tr>
-</table>
-</div>
-<br /><br />
-
- Overrides <a href="../Cache/SagCache.html#methodremove">SagCache::remove()</a> (Removes the item from the cache and returns it (null if nothing was cached).)<br /><br />
- <h4>Parameters:</h4>
- <div class="tags">
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td class="type">&nbsp;&nbsp;</td>
- <td><b>$url</b>&nbsp;&nbsp;</td>
- <td></td>
- </tr>
- </table>
- </div><br />
- <div class="top">[ <a href="#top">Top</a> ]</div>
- </div>
- <hr />
- <a name="methodset"></a>
- <h3>method set <span class="smalllinenumber">[line 37]</span></h3>
- <div class="function">
- <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
- <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
- <code>void set(
-
-$url,
-&$item)</code>
- </td></tr></table>
- </td></tr></table><br />
-
- <br /><br />
-<h4>Tags:</h4>
-<div class="tags">
-<table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
- </tr>
-</table>
-</div>
-<br /><br />
-
- Overrides <a href="../Cache/SagCache.html#methodset">SagCache::set()</a> (Caches the item returned at the provided key, replacing any pre-existing cached item. If the cache's size will be exceeded by caching the new item, then it will remove items from the cache until there is sufficient room.)<br /><br />
- <h4>Parameters:</h4>
- <div class="tags">
- <table border="0" cellspacing="0" cellpadding="0">
- <tr>
- <td class="type">&nbsp;&nbsp;</td>
- <td><b>$url</b>&nbsp;&nbsp;</td>
- <td></td>
- </tr>
- <tr>
- <td class="type">&nbsp;&nbsp;</td>
- <td><b>&$item</b>&nbsp;&nbsp;</td>
- <td></td>
- </tr>
- </table>
- </div><br />
- <div class="top">[ <a href="#top">Top</a> ]</div>
- </div>
-</div><br />
-
-
- <div class="credit">
- <hr />
- Documentation generated on Wed, 09 Nov 2011 15:24:01 -0500 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
- </div>
- </td></tr></table>
- </td>
- </tr>
-</table>
-
-</body>
-</html>
Oops, something went wrong.

0 comments on commit dd36520

Please sign in to comment.