"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerMemoryCookieCache.html" (20 Jan 2013, 9837 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 PHPCrawlerMemoryCookieCache</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 PHPCrawlerMemoryCookieCache</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-var-summary">Vars</a> (<a href="#sec-vars">details</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">Class for storing/caching cookies in memory.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---CookieCache---PHPCrawlerMemoryCookieCache.class.php.html">/libs/PHPCrawler/CookieCache/PHPCrawlerMemoryCookieCache.class.php</a> (line <span class="field">8</span>)
   28         </p>
   29         
   30                 
   31         <pre><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html">PHPCrawlerCookieCacheBase</a>
   32    |
   33    --PHPCrawlerMemoryCookieCache</pre>
   34     
   35             </div>
   36 </div>
   37 
   38 
   39 
   40     <a name="sec-var-summary"></a>
   41     <div class="info-box">
   42         <div class="info-box-title">Variable Summary</span></div>
   43         <div class="nav-bar">
   44             <a href="#sec-description">Description</a> |
   45                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   46                             | 
   47                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   48                             
   49                                 </div>
   50         <div class="info-box-body">
   51             <div class="var-summary">
   52                                                                                                 <div class="var-title">
   53                     <span class="var-type">mixed</span>
   54                     <a href="#$cookies" title="details" class="var-name">$cookies</a>
   55                 </div>
   56                                             </div>
   57         </div>
   58     </div>
   59 
   60     <a name="sec-method-summary"></a>
   61     <div class="info-box">
   62         <div class="info-box-title">Method Summary</span></div>
   63         <div class="nav-bar">
   64             <a href="#sec-description">Description</a> |
   65                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   66                  
   67                 |
   68                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   69         </div>
   70         <div class="info-box-body">         
   71             <div class="method-summary">
   72                                                                                                                 
   73                                                 <div class="method-definition">
   74                                             <span class="method-result">void</span>
   75                                         <a href="#addCookie" title="details" class="method-name">addCookie</a>
   76                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
   77                                     </div>
   78                                                                 <div class="method-definition">
   79                                             <span class="method-result">void</span>
   80                                         <a href="#addCookies" title="details" class="method-name">addCookies</a>
   81                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
   82                                     </div>
   83                                                                 <div class="method-definition">
   84                                             <span class="method-result">array</span>
   85                                         <a href="#getCookiesForUrl" title="details" class="method-name">getCookiesForUrl</a>
   86                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$target_url</span>)
   87                                     </div>
   88                                 </div>
   89         </div>
   90     </div>      
   91 
   92     <a name="sec-vars"></a>
   93     <div class="info-box">
   94         <div class="info-box-title">Variables</div>
   95         <div class="nav-bar">
   96             <a href="#sec-description">Description</a> |
   97                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
   98                         
   99             
  100                                         | 
  101                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  102                             
  103                     </div>
  104         <div class="info-box-body">
  105             <a name="var$cookies" id="$cookies"><!-- --></A>
  106 <div class="evenrow">
  107 
  108     <div class="var-header">
  109         <span class="var-title">
  110             <span class="var-type">mixed</span>
  111             <span class="var-name">$cookies</span>
  112                         (line <span class="line-number">10</span>)
  113         </span>
  114     </div>
  115 
  116     <!-- ========== Info from phpDoc block ========= -->
  117     <ul class="tags">
  118                 <li><span class="field">access:</span> protected</li>
  119             </ul>
  120     
  121     
  122         
  123         
  124 
  125 </div>
  126                         
  127         </div>
  128     </div>
  129     
  130     <a name="sec-methods"></a>
  131     <div class="info-box">
  132         <div class="info-box-title">Methods</div>
  133         <div class="nav-bar">
  134             <a href="#sec-description">Description</a> |
  135                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  136                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  137                         
  138         </div>
  139         <div class="info-box-body">
  140             <A NAME='method_detail'></A>
  141 
  142 <a name="methodaddCookie" id="addCookie"><!-- --></a>
  143 <div class="oddrow">
  144     
  145     <div class="method-header">
  146         <span class="method-title">addCookie</span> (line <span class="line-number">17</span>)
  147     </div> 
  148     
  149     <!-- ========== Info from phpDoc block ========= -->
  150 <p class="short-description">Adds a cookie to the cookie-cache.</p>
  151     <ul class="tags">
  152                 <li><span class="field">access:</span> public</li>
  153             </ul>
  154     
  155     <div class="method-signature">
  156         <span class="method-result">void</span>
  157         <span class="method-name">
  158             addCookie
  159         </span>
  160                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
  161             </div>
  162     
  163             <ul class="parameters">
  164                     <li>
  165                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>
  166                 <span class="var-name">$Cookie</span><span class="var-description">: The cookie to add.</span>          </li>
  167                 </ul>
  168         
  169             <hr class="separator" />
  170         <div class="notes">Redefinition of:</div>
  171         <dl>
  172             <dt><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookie">PHPCrawlerCookieCacheBase::addCookie()</a></dt>
  173                         <dd>Adds a cookie to the cookie-cache.</dd>
  174                     </dl>
  175             
  176     </div>
  177 <a name="methodaddCookies" id="addCookies"><!-- --></a>
  178 <div class="evenrow">
  179     
  180     <div class="method-header">
  181         <span class="method-title">addCookies</span> (line <span class="line-number">34</span>)
  182     </div> 
  183     
  184     <!-- ========== Info from phpDoc block ========= -->
  185 <p class="short-description">Adds a bunch of cookies to the cookie-cache.</p>
  186     <ul class="tags">
  187                 <li><span class="field">access:</span> public</li>
  188             </ul>
  189     
  190     <div class="method-signature">
  191         <span class="method-result">void</span>
  192         <span class="method-name">
  193             addCookies
  194         </span>
  195                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
  196             </div>
  197     
  198             <ul class="parameters">
  199                     <li>
  200                 <span class="var-type">array</span>
  201                 <span class="var-name">$cookies</span><span class="var-description">: Numeric array conatinin the cookies to add as PHPCrawlerCookieDescriptor-objects</span>           </li>
  202                 </ul>
  203         
  204             <hr class="separator" />
  205         <div class="notes">Redefinition of:</div>
  206         <dl>
  207             <dt><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookies">PHPCrawlerCookieCacheBase::addCookies()</a></dt>
  208                         <dd>Adds a bunch of cookies to the cookie-cache.</dd>
  209                     </dl>
  210             
  211     </div>
  212 <a name="methodgetCookiesForUrl" id="getCookiesForUrl"><!-- --></a>
  213 <div class="oddrow">
  214     
  215     <div class="method-header">
  216         <span class="method-title">getCookiesForUrl</span> (line <span class="line-number">48</span>)
  217     </div> 
  218     
  219     <!-- ========== Info from phpDoc block ========= -->
  220 <p class="short-description">Returns all cookies from the cache that are adressed to the given URL</p>
  221     <ul class="tags">
  222                 <li><span class="field">return:</span> Numeric array conatining all matching cookies as PHPCrawlerCookieDescriptor-objects</li>
  223                 <li><span class="field">access:</span> public</li>
  224             </ul>
  225     
  226     <div class="method-signature">
  227         <span class="method-result">array</span>
  228         <span class="method-name">
  229             getCookiesForUrl
  230         </span>
  231                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$target_url</span>)
  232             </div>
  233     
  234             <ul class="parameters">
  235                     <li>
  236                 <span class="var-type">string</span>
  237                 <span class="var-name">$target_url</span><span class="var-description">: The target-URL</span>          </li>
  238                 </ul>
  239         
  240             <hr class="separator" />
  241         <div class="notes">Redefinition of:</div>
  242         <dl>
  243             <dt><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodgetCookiesForUrl">PHPCrawlerCookieCacheBase::getCookiesForUrl()</a></dt>
  244                         <dd>Returns all cookies from the cache that are adressed to the given URL</dd>
  245                     </dl>
  246             
  247     </div>
  248                             <h4>Inherited Methods</h4>
  249                 <a name='inherited_methods'><!-- --></a>    
  250                                     <!-- =========== Summary =========== -->
  251                     <p>Inherited From <span class="classname"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html">PHPCrawlerCookieCacheBase</a></span></p>
  252                     <blockquote>
  253                                                     <span class="method-name"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookie">PHPCrawlerCookieCacheBase::addCookie()</a></span><br>
  254                                                     <span class="method-name"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookies">PHPCrawlerCookieCacheBase::addCookies()</a></span><br>
  255                                                     <span class="method-name"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodgetCookiesForUrl">PHPCrawlerCookieCacheBase::getCookiesForUrl()</a></span><br>
  256                                             </blockquote>
  257                                         
  258         </div>
  259     </div>
  260 
  261 
  262     <p class="notes" id="credit">
  263         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>
  264     </p>
  265     </div></body>
  266 </html>