"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerCookieCacheBase.html" (20 Jan 2013, 9319 Bytes) of package /linux/www/SitemapCreator.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <?xml version="1.0" encoding="iso-8859-1"?>
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3   <html xmlns="http://www.w3.org/1999/xhtml">
    4         <head>
    5             <!-- template designed by Marco Von Ballmoos -->
    6             <title>Docs For Class PHPCrawlerCookieCacheBase</title>
    7             <link rel="stylesheet" href="../media/stylesheet.css" />
    8             <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9         </head>
   10         <body>
   11             <div class="page-body">         
   12 <h2 class="class-name">Class PHPCrawlerCookieCacheBase</h2>
   13 
   14 <a name="sec-description"></a>
   15 <div class="info-box">
   16     <div class="info-box-title">Description</div>
   17     <div class="nav-bar">
   18                     <span class="disabled">Description</span> |
   19                             <a href="#sec-descendents">Descendents</a>
   20             |                                                   <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   21                         
   22                     </div>
   23     <div class="info-box-body">
   24                 <!-- ========== Info from phpDoc block ========= -->
   25 <p class="short-description">Abstract baseclass for storing cookies.</p>
   26     <ul class="tags">
   27                 <li><span class="field">abstract:</span> </li>
   28             </ul>
   29         <p class="notes">
   30             Located in <a class="field" href="_libs---PHPCrawler---CookieCache---PHPCrawlerCookieCacheBase.class.php.html">/libs/PHPCrawler/CookieCache/PHPCrawlerCookieCacheBase.class.php</a> (line <span class="field">8</span>)
   31         </p>
   32         
   33                 
   34         <pre></pre>
   35     
   36             </div>
   37 </div>
   38 
   39     <a name="sec-descendents"></a>
   40     <div class="info-box">
   41         <div class="info-box-title">Direct descendents</div>
   42         <div class="nav-bar">
   43             <a href="#sec-description">Description</a> |
   44             <span class="disabled">Descendents</span>
   45             |                                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   46                             
   47                                 </div>
   48         <div class="info-box-body">
   49             <table cellpadding="2" cellspacing="0" class="class-table">
   50                 <tr>
   51                     <th class="class-table-header">Class</th>
   52                     <th class="class-table-header">Description</th>
   53                 </tr>
   54                                 <tr>
   55                     <td style="padding-right: 2em"><a href="../phpcrawl/PHPCrawlerSQLiteCookieCache.html">PHPCrawlerSQLiteCookieCache</a></td>
   56                     <td>
   57                                             Class for storing/caching cookies in a SQLite-db-file.
   58                                         </td>
   59                 </tr>
   60                                 <tr>
   61                     <td style="padding-right: 2em"><a href="../phpcrawl/PHPCrawlerMemoryCookieCache.html">PHPCrawlerMemoryCookieCache</a></td>
   62                     <td>
   63                                             Class for storing/caching cookies in memory.
   64                                         </td>
   65                 </tr>
   66                             </table>
   67         </div>
   68     </div>
   69 
   70 
   71 
   72     <a name="sec-method-summary"></a>
   73     <div class="info-box">
   74         <div class="info-box-title">Method Summary</span></div>
   75         <div class="nav-bar">
   76             <a href="#sec-description">Description</a> |
   77                             <a href="#sec-descendents">Descendents</a> |
   78                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   79         </div>
   80         <div class="info-box-body">         
   81             <div class="method-summary">
   82                                                                                                                 
   83                                                 <div class="method-definition">
   84                                             <span class="method-result">void</span>
   85                                         <a href="#addCookie" title="details" class="method-name">addCookie</a>
   86                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
   87                                     </div>
   88                                                                 <div class="method-definition">
   89                                             <span class="method-result">void</span>
   90                                         <a href="#addCookies" title="details" class="method-name">addCookies</a>
   91                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
   92                                     </div>
   93                                                                 <div class="method-definition">
   94                                             <span class="method-result">array</span>
   95                                         <a href="#getCookiesForUrl" title="details" class="method-name">getCookiesForUrl</a>
   96                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$target_url</span>)
   97                                     </div>
   98                                 </div>
   99         </div>
  100     </div>      
  101 
  102     
  103     <a name="sec-methods"></a>
  104     <div class="info-box">
  105         <div class="info-box-title">Methods</div>
  106         <div class="nav-bar">
  107             <a href="#sec-description">Description</a> |
  108                             <a href="#sec-descendents">Descendents</a> |
  109                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  110                         
  111         </div>
  112         <div class="info-box-body">
  113             <A NAME='method_detail'></A>
  114 
  115 <a name="methodaddCookie" id="addCookie"><!-- --></a>
  116 <div class="oddrow">
  117     
  118     <div class="method-header">
  119         <span class="method-title">addCookie</span> (line <span class="line-number">15</span>)
  120     </div> 
  121     
  122     <!-- ========== Info from phpDoc block ========= -->
  123 <p class="short-description">Adds a cookie to the cookie-cache.</p>
  124     <ul class="tags">
  125                 <li><span class="field">abstract:</span> </li>
  126                 <li><span class="field">access:</span> public</li>
  127             </ul>
  128     
  129     <div class="method-signature">
  130         <span class="method-result">void</span>
  131         <span class="method-name">
  132             addCookie
  133         </span>
  134                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
  135             </div>
  136     
  137             <ul class="parameters">
  138                     <li>
  139                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>
  140                 <span class="var-name">$Cookie</span><span class="var-description">: The cookie to add.</span>          </li>
  141                 </ul>
  142         
  143             
  144             <hr class="separator" />
  145         <div class="notes">Redefined in descendants as:</div>
  146         <ul class="redefinitions">
  147                     <li>
  148                 <a href="../phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodaddCookie">PHPCrawlerSQLiteCookieCache::addCookie()</a>
  149                                 : Adds a cookie to the cookie-cache.
  150                             </li>
  151                     <li>
  152                 <a href="../phpcrawl/PHPCrawlerMemoryCookieCache.html#methodaddCookie">PHPCrawlerMemoryCookieCache::addCookie()</a>
  153                                 : Adds a cookie to the cookie-cache.
  154                             </li>
  155                 </ul>
  156     </div>
  157 <a name="methodaddCookies" id="addCookies"><!-- --></a>
  158 <div class="evenrow">
  159     
  160     <div class="method-header">
  161         <span class="method-title">addCookies</span> (line <span class="line-number">22</span>)
  162     </div> 
  163     
  164     <!-- ========== Info from phpDoc block ========= -->
  165 <p class="short-description">Adds a bunch of cookies to the cookie-cache.</p>
  166     <ul class="tags">
  167                 <li><span class="field">abstract:</span> </li>
  168                 <li><span class="field">access:</span> public</li>
  169             </ul>
  170     
  171     <div class="method-signature">
  172         <span class="method-result">void</span>
  173         <span class="method-name">
  174             addCookies
  175         </span>
  176                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
  177             </div>
  178     
  179             <ul class="parameters">
  180                     <li>
  181                 <span class="var-type">array</span>
  182                 <span class="var-name">$cookies</span><span class="var-description">: Numeric array conatinin the cookies to add as PHPCrawlerCookieDescriptor-objects</span>           </li>
  183                 </ul>
  184         
  185             
  186             <hr class="separator" />
  187         <div class="notes">Redefined in descendants as:</div>
  188         <ul class="redefinitions">
  189                     <li>
  190                 <a href="../phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodaddCookies">PHPCrawlerSQLiteCookieCache::addCookies()</a>
  191                                 : Adds a bunch of cookies to the cookie-cache.
  192                             </li>
  193                     <li>
  194                 <a href="../phpcrawl/PHPCrawlerMemoryCookieCache.html#methodaddCookies">PHPCrawlerMemoryCookieCache::addCookies()</a>
  195                                 : Adds a bunch of cookies to the cookie-cache.
  196                             </li>
  197                 </ul>
  198     </div>
  199 <a name="methodgetCookiesForUrl" id="getCookiesForUrl"><!-- --></a>
  200 <div class="oddrow">
  201     
  202     <div class="method-header">
  203         <span class="method-title">getCookiesForUrl</span> (line <span class="line-number">30</span>)
  204     </div> 
  205     
  206     <!-- ========== Info from phpDoc block ========= -->
  207 <p class="short-description">Returns all cookies from the cache that are adressed to the given URL</p>
  208     <ul class="tags">
  209                 <li><span class="field">return:</span> Numeric array conatining all matching cookies as PHPCrawlerCookieDescriptor-objects</li>
  210                 <li><span class="field">abstract:</span> </li>
  211                 <li><span class="field">access:</span> public</li>
  212             </ul>
  213     
  214     <div class="method-signature">
  215         <span class="method-result">array</span>
  216         <span class="method-name">
  217             getCookiesForUrl
  218         </span>
  219                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$target_url</span>)
  220             </div>
  221     
  222             <ul class="parameters">
  223                     <li>
  224                 <span class="var-type">string</span>
  225                 <span class="var-name">$target_url</span><span class="var-description">: The target-URL</span>          </li>
  226                 </ul>
  227         
  228             
  229             <hr class="separator" />
  230         <div class="notes">Redefined in descendants as:</div>
  231         <ul class="redefinitions">
  232                     <li>
  233                 <a href="../phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodgetCookiesForUrl">PHPCrawlerSQLiteCookieCache::getCookiesForUrl()</a>
  234                                 : Returns all cookies from the cache that are adressed to the given URL
  235                             </li>
  236                     <li>
  237                 <a href="../phpcrawl/PHPCrawlerMemoryCookieCache.html#methodgetCookiesForUrl">PHPCrawlerMemoryCookieCache::getCookiesForUrl()</a>
  238                                 : Returns all cookies from the cache that are adressed to the given URL
  239                             </li>
  240                 </ul>
  241     </div>
  242                         
  243         </div>
  244     </div>
  245 
  246 
  247     <p class="notes" id="credit">
  248         Documentation generated on Sun, 20 Jan 2013 21:18:50 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
  249     </p>
  250     </div></body>
  251 </html>