"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerURLCacheBase.html" (20 Jan 2013, 29239 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 PHPCrawlerURLCacheBase</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 PHPCrawlerURLCacheBase</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   21                         |                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   22                         
   23                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
   24                         
   25             </div>
   26     <div class="info-box-body">
   27                 <!-- ========== Info from phpDoc block ========= -->
   28 <p class="short-description">Abstract baseclass for implemented URL-caching classes.</p>
   29     <ul class="tags">
   30                 <li><span class="field">abstract:</span> </li>
   31             </ul>
   32         <p class="notes">
   33             Located in <a class="field" href="_libs---PHPCrawler---UrlCache---PHPCrawlerURLCacheBase.class.php.html">/libs/PHPCrawler/UrlCache/PHPCrawlerURLCacheBase.class.php</a> (line <span class="field">8</span>)
   34         </p>
   35         
   36                 
   37         <pre></pre>
   38     
   39             </div>
   40 </div>
   41 
   42     <a name="sec-descendents"></a>
   43     <div class="info-box">
   44         <div class="info-box-title">Direct descendents</div>
   45         <div class="nav-bar">
   46             <a href="#sec-description">Description</a> |
   47             <span class="disabled">Descendents</span>
   48             |                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   49                                 |                                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   50                             
   51                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
   52                             
   53                     </div>
   54         <div class="info-box-body">
   55             <table cellpadding="2" cellspacing="0" class="class-table">
   56                 <tr>
   57                     <th class="class-table-header">Class</th>
   58                     <th class="class-table-header">Description</th>
   59                 </tr>
   60                                 <tr>
   61                     <td style="padding-right: 2em"><a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html">PHPCrawlerSQLiteURLCache</a></td>
   62                     <td>
   63                                             Class for caching/storing URLs/links in a SQLite-database-file.
   64                                         </td>
   65                 </tr>
   66                                 <tr>
   67                     <td style="padding-right: 2em"><a href="../phpcrawl/PHPCrawlerMemoryURLCache.html">PHPCrawlerMemoryURLCache</a></td>
   68                     <td>
   69                                             Class for caching/storing URLs/links in memory.
   70                                         </td>
   71                 </tr>
   72                             </table>
   73         </div>
   74     </div>
   75 
   76     <a name="sec-const-summary"></a>
   77     <div class="info-box">
   78         <div class="info-box-title">Class Constant Summary</span></div>
   79         <div class="nav-bar">
   80             <a href="#sec-description">Description</a> |
   81                             <a href="#sec-descendents">Descendants</a> |
   82                         <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
   83                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   84                  
   85                 |
   86                                         | 
   87                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   88                             
   89                     </div>
   90         <div class="info-box-body">
   91             <div class="const-summary">
   92                                 <div class="const-title">
   93                     <a href="#URLHASH_NONE" title="details" class="const-name">URLHASH_NONE</a> =                   <span class="var-type"> 3</span>
   94 
   95                 </div>
   96                                 <div class="const-title">
   97                     <a href="#URLHASH_RAWLINK" title="details" class="const-name">URLHASH_RAWLINK</a> =                     <span class="var-type"> 2</span>
   98 
   99                 </div>
  100                                 <div class="const-title">
  101                     <a href="#URLHASH_URL" title="details" class="const-name">URLHASH_URL</a> =                     <span class="var-type"> 1</span>
  102 
  103                 </div>
  104                             </div>
  105         </div>
  106     </div>
  107 
  108     <a name="sec-var-summary"></a>
  109     <div class="info-box">
  110         <div class="info-box-title">Variable Summary</span></div>
  111         <div class="nav-bar">
  112             <a href="#sec-description">Description</a> |
  113                             <a href="#sec-descendents">Descendents</a> |
  114                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  115                             | 
  116                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  117                             
  118                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  119                             
  120                     </div>
  121         <div class="info-box-body">
  122             <div class="var-summary">
  123                                                                                                                                 <div class="var-title">
  124                     <span class="var-type">int</span>
  125                     <a href="#$url_distinct_property" title="details" class="var-name">$url_distinct_property</a>
  126                 </div>
  127                                                                 <div class="var-title">
  128                     <span class="var-type">mixed</span>
  129                     <a href="#$url_priorities" title="details" class="var-name">$url_priorities</a>
  130                 </div>
  131                                             </div>
  132         </div>
  133     </div>
  134 
  135     <a name="sec-method-summary"></a>
  136     <div class="info-box">
  137         <div class="info-box-title">Method Summary</span></div>
  138         <div class="nav-bar">
  139             <a href="#sec-description">Description</a> |
  140                             <a href="#sec-descendents">Descendents</a> |
  141                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  142                             
  143                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  144                  
  145                 |
  146                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  147         </div>
  148         <div class="info-box-body">         
  149             <div class="method-summary">
  150                                                                                                                                                                                                                                                                                                                                                                                                                                                 
  151                                                 <div class="method-definition">
  152                                             <span class="method-result">void</span>
  153                                         <a href="#addLinkPriorities" title="details" class="method-name">addLinkPriorities</a>
  154                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$priority_array</span>)
  155                                     </div>
  156                                                                 <div class="method-definition">
  157                                             <span class="method-result">void</span>
  158                                         <a href="#addLinkPriority" title="details" class="method-name">addLinkPriority</a>
  159                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$level</span>)
  160                                     </div>
  161                                                                 <div class="method-definition">
  162                                             <span class="method-result">void</span>
  163                                         <a href="#addURL" title="details" class="method-name">addURL</a>
  164                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  165                                     </div>
  166                                                                 <div class="method-definition">
  167                                             <span class="method-result">void</span>
  168                                         <a href="#addURLs" title="details" class="method-name">addURLs</a>
  169                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$urls</span>)
  170                                     </div>
  171                                                                 <div class="method-definition">
  172                                             <span class="method-result">void</span>
  173                                         <a href="#cleanup" title="details" class="method-name">cleanup</a>
  174                                         ()
  175                                     </div>
  176                                                                 <div class="method-definition">
  177                                             <span class="method-result">void</span>
  178                                         <a href="#clear" title="details" class="method-name">clear</a>
  179                                         ()
  180                                     </div>
  181                                                                 <div class="method-definition">
  182                                             <span class="method-result">bool</span>
  183                                         <a href="#containsURLs" title="details" class="method-name">containsURLs</a>
  184                                         ()
  185                                     </div>
  186                                                                 <div class="method-definition">
  187                                             <span class="method-result">array</span>
  188                                         <a href="#getAllURLs" title="details" class="method-name">getAllURLs</a>
  189                                         ()
  190                                     </div>
  191                                                                 <div class="method-definition">
  192                                             <span class="method-result">string</span>
  193                                         <a href="#getDistinctURLHash" title="details" class="method-name">getDistinctURLHash</a>
  194                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  195                                     </div>
  196                                                                 <div class="method-definition">
  197                                             <span class="method-result">PhpCrawlerURLDescriptor</span>
  198                                         <a href="#getNextUrl" title="details" class="method-name">getNextUrl</a>
  199                                         ()
  200                                     </div>
  201                                                                 <div class="method-definition">
  202                                             <span class="method-result">void</span>
  203                                         <a href="#getUrlPriority" title="details" class="method-name">getUrlPriority</a>
  204                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>)
  205                                     </div>
  206                                                                 <div class="method-definition">
  207                                             <span class="method-result">void</span>
  208                                         <a href="#markUrlAsFollowed" title="details" class="method-name">markUrlAsFollowed</a>
  209                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  210                                     </div>
  211                                                                 <div class="method-definition">
  212                                             <span class="method-result">void</span>
  213                                         <a href="#purgeCache" title="details" class="method-name">purgeCache</a>
  214                                         ()
  215                                     </div>
  216                                 </div>
  217         </div>
  218     </div>      
  219 
  220     <a name="sec-vars"></a>
  221     <div class="info-box">
  222         <div class="info-box-title">Variables</div>
  223         <div class="nav-bar">
  224             <a href="#sec-description">Description</a> |
  225                             <a href="#sec-descendents">Descendents</a> |
  226                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  227                         
  228             
  229                                                 <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  230                             
  231                                         | 
  232                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  233                             
  234                     </div>
  235         <div class="info-box-body">
  236             <a name="var$url_distinct_property" id="$url_distinct_property"><!-- --></A>
  237 <div class="evenrow">
  238 
  239     <div class="var-header">
  240         <span class="var-title">
  241             <span class="var-type">int</span>
  242             <span class="var-name">$url_distinct_property</span>
  243              = <span class="var-default"> self::URLHASH_URL</span>          (line <span class="line-number">17</span>)
  244         </span>
  245     </div>
  246 
  247     <!-- ========== Info from phpDoc block ========= -->
  248 <p class="short-description">Defines which property of an URL is used to ensure that each URL is only cached once.</p>
  249     <ul class="tags">
  250                 <li><span class="field">var:</span> One of the URLHASH_.. constants</li>
  251                 <li><span class="field">access:</span> public</li>
  252             </ul>
  253     
  254     
  255         
  256         
  257 
  258 </div>
  259 <a name="var$url_priorities" id="$url_priorities"><!-- --></A>
  260 <div class="oddrow">
  261 
  262     <div class="var-header">
  263         <span class="var-title">
  264             <span class="var-type">mixed</span>
  265             <span class="var-name">$url_priorities</span>
  266              = <span class="var-default">array()</span>         (line <span class="line-number">10</span>)
  267         </span>
  268     </div>
  269 
  270     <!-- ========== Info from phpDoc block ========= -->
  271     <ul class="tags">
  272                 <li><span class="field">access:</span> protected</li>
  273             </ul>
  274     
  275     
  276         
  277         
  278 
  279 </div>
  280                         
  281         </div>
  282     </div>
  283     
  284     <a name="sec-methods"></a>
  285     <div class="info-box">
  286         <div class="info-box-title">Methods</div>
  287         <div class="nav-bar">
  288             <a href="#sec-description">Description</a> |
  289                             <a href="#sec-descendents">Descendents</a> |
  290                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  291                                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  292                             
  293                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  294                         
  295         </div>
  296         <div class="info-box-body">
  297             <A NAME='method_detail'></A>
  298 
  299 <a name="methodaddLinkPriorities" id="addLinkPriorities"><!-- --></a>
  300 <div class="evenrow">
  301     
  302     <div class="method-header">
  303         <span class="method-title">addLinkPriorities</span> (line <span class="line-number">133</span>)
  304     </div> 
  305     
  306     <!-- ========== Info from phpDoc block ========= -->
  307 <p class="short-description">Adds a bunch of link-priorities</p>
  308     <ul class="tags">
  309                 <li><span class="field">access:</span> public</li>
  310             </ul>
  311     
  312     <div class="method-signature">
  313         <span class="method-result">void</span>
  314         <span class="method-name">
  315             addLinkPriorities
  316         </span>
  317                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$priority_array</span>)
  318             </div>
  319     
  320             <ul class="parameters">
  321                     <li>
  322                 <span class="var-type">array</span>
  323                 <span class="var-name">$priority_array</span><span class="var-description">: Numeric array containing the subkeys &quot;match&quot; and &quot;level&quot;</span>            </li>
  324                 </ul>
  325         
  326             
  327     </div>
  328 <a name="methodaddLinkPriority" id="addLinkPriority"><!-- --></a>
  329 <div class="oddrow">
  330     
  331     <div class="method-header">
  332         <span class="method-title">addLinkPriority</span> (line <span class="line-number">118</span>)
  333     </div> 
  334     
  335     <!-- ========== Info from phpDoc block ========= -->
  336 <p class="short-description">Adds a Link-Priority-Level</p>
  337     <ul class="tags">
  338                 <li><span class="field">access:</span> public</li>
  339             </ul>
  340     
  341     <div class="method-signature">
  342         <span class="method-result">void</span>
  343         <span class="method-name">
  344             addLinkPriority
  345         </span>
  346                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$level</span>)
  347             </div>
  348     
  349             <ul class="parameters">
  350                     <li>
  351                 <span class="var-type">string</span>
  352                 <span class="var-name">$regex</span>            </li>
  353                     <li>
  354                 <span class="var-type">int</span>
  355                 <span class="var-name">$level</span>            </li>
  356                 </ul>
  357         
  358             
  359     </div>
  360 <a name="methodaddURL" id="addURL"><!-- --></a>
  361 <div class="evenrow">
  362     
  363     <div class="method-header">
  364         <span class="method-title">addURL</span> (line <span class="line-number">47</span>)
  365     </div> 
  366     
  367     <!-- ========== Info from phpDoc block ========= -->
  368 <p class="short-description">Adds an URL to the url-cache</p>
  369     <ul class="tags">
  370                 <li><span class="field">abstract:</span> </li>
  371                 <li><span class="field">access:</span> public</li>
  372             </ul>
  373     
  374     <div class="method-signature">
  375         <span class="method-result">void</span>
  376         <span class="method-name">
  377             addURL
  378         </span>
  379                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  380             </div>
  381     
  382             <ul class="parameters">
  383                     <li>
  384                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>
  385                 <span class="var-name">$UrlDescriptor</span>            </li>
  386                 </ul>
  387         
  388             
  389             <hr class="separator" />
  390         <div class="notes">Redefined in descendants as:</div>
  391         <ul class="redefinitions">
  392                     <li>
  393                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodaddURL">PHPCrawlerSQLiteURLCache::addURL()</a>
  394                                 : Adds an URL to the url-cache
  395                             </li>
  396                     <li>
  397                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodaddURL">PHPCrawlerMemoryURLCache::addURL()</a>
  398                                 : Adds an URL to the url-cache
  399                             </li>
  400                 </ul>
  401     </div>
  402 <a name="methodaddURLs" id="addURLs"><!-- --></a>
  403 <div class="oddrow">
  404     
  405     <div class="method-header">
  406         <span class="method-title">addURLs</span> (line <span class="line-number">54</span>)
  407     </div> 
  408     
  409     <!-- ========== Info from phpDoc block ========= -->
  410 <p class="short-description">Adds an bunch of URLs to the url-cache</p>
  411     <ul class="tags">
  412                 <li><span class="field">abstract:</span> </li>
  413                 <li><span class="field">access:</span> public</li>
  414             </ul>
  415     
  416     <div class="method-signature">
  417         <span class="method-result">void</span>
  418         <span class="method-name">
  419             addURLs
  420         </span>
  421                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$urls</span>)
  422             </div>
  423     
  424             <ul class="parameters">
  425                     <li>
  426                 <span class="var-type">array</span>
  427                 <span class="var-name">$urls</span><span class="var-description">: A numeric array containing the URLs as PHPCrawlerURLDescriptor-objects</span>            </li>
  428                 </ul>
  429         
  430             
  431             <hr class="separator" />
  432         <div class="notes">Redefined in descendants as:</div>
  433         <ul class="redefinitions">
  434                     <li>
  435                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodaddURLs">PHPCrawlerSQLiteURLCache::addURLs()</a>
  436                                 : Adds an bunch of URLs to the url-cache
  437                             </li>
  438                     <li>
  439                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodaddURLs">PHPCrawlerMemoryURLCache::addURLs()</a>
  440                                 : Adds an bunch of URLs to the url-cache
  441                             </li>
  442                 </ul>
  443     </div>
  444 <a name="methodcleanup" id="cleanup"><!-- --></a>
  445 <div class="evenrow">
  446     
  447     <div class="method-header">
  448         <span class="method-title">cleanup</span> (line <span class="line-number">73</span>)
  449     </div> 
  450     
  451     <!-- ========== Info from phpDoc block ========= -->
  452 <p class="short-description">Do cleanups after the cache is not needed anymore</p>
  453     <ul class="tags">
  454                 <li><span class="field">abstract:</span> </li>
  455                 <li><span class="field">access:</span> public</li>
  456             </ul>
  457     
  458     <div class="method-signature">
  459         <span class="method-result">void</span>
  460         <span class="method-name">
  461             cleanup
  462         </span>
  463                 ()
  464             </div>
  465     
  466         
  467             
  468             <hr class="separator" />
  469         <div class="notes">Redefined in descendants as:</div>
  470         <ul class="redefinitions">
  471                     <li>
  472                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodcleanup">PHPCrawlerSQLiteURLCache::cleanup()</a>
  473                                 : Cleans up the cache after is it not needed anymore.
  474                             </li>
  475                     <li>
  476                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodcleanup">PHPCrawlerMemoryURLCache::cleanup()</a>
  477                                 : Has no function in this class.
  478                             </li>
  479                 </ul>
  480     </div>
  481 <a name="methodclear" id="clear"><!-- --></a>
  482 <div class="oddrow">
  483     
  484     <div class="method-header">
  485         <span class="method-title">clear</span> (line <span class="line-number">40</span>)
  486     </div> 
  487     
  488     <!-- ========== Info from phpDoc block ========= -->
  489 <p class="short-description">Removes all URLs and all priority-rules from the URL-cache.</p>
  490     <ul class="tags">
  491                 <li><span class="field">abstract:</span> </li>
  492                 <li><span class="field">access:</span> public</li>
  493             </ul>
  494     
  495     <div class="method-signature">
  496         <span class="method-result">void</span>
  497         <span class="method-name">
  498             clear
  499         </span>
  500                 ()
  501             </div>
  502     
  503         
  504             
  505             <hr class="separator" />
  506         <div class="notes">Redefined in descendants as:</div>
  507         <ul class="redefinitions">
  508                     <li>
  509                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodclear">PHPCrawlerSQLiteURLCache::clear()</a>
  510                                 : Removes all URLs and all priority-rules from the URL-cache.
  511                             </li>
  512                     <li>
  513                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodclear">PHPCrawlerMemoryURLCache::clear()</a>
  514                                 : Removes all URLs and all priority-rules from the URL-cache.
  515                             </li>
  516                 </ul>
  517     </div>
  518 <a name="methodcontainsURLs" id="containsURLs"><!-- --></a>
  519 <div class="evenrow">
  520     
  521     <div class="method-header">
  522         <span class="method-title">containsURLs</span> (line <span class="line-number">61</span>)
  523     </div> 
  524     
  525     <!-- ========== Info from phpDoc block ========= -->
  526 <p class="short-description">Checks whether there are URLs left in the cache or not.</p>
  527     <ul class="tags">
  528                 <li><span class="field">abstract:</span> </li>
  529                 <li><span class="field">access:</span> public</li>
  530             </ul>
  531     
  532     <div class="method-signature">
  533         <span class="method-result">bool</span>
  534         <span class="method-name">
  535             containsURLs
  536         </span>
  537                 ()
  538             </div>
  539     
  540         
  541             
  542             <hr class="separator" />
  543         <div class="notes">Redefined in descendants as:</div>
  544         <ul class="redefinitions">
  545                     <li>
  546                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodcontainsURLs">PHPCrawlerSQLiteURLCache::containsURLs()</a>
  547                                 : Checks whether there are URLs left in the cache that should be processed or not.
  548                             </li>
  549                     <li>
  550                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodcontainsURLs">PHPCrawlerMemoryURLCache::containsURLs()</a>
  551                                 : Checks whether there are URLs left in the cache or not.
  552                             </li>
  553                 </ul>
  554     </div>
  555 <a name="methodgetAllURLs" id="getAllURLs"><!-- --></a>
  556 <div class="oddrow">
  557     
  558     <div class="method-header">
  559         <span class="method-title">getAllURLs</span> (line <span class="line-number">35</span>)
  560     </div> 
  561     
  562     <!-- ========== Info from phpDoc block ========= -->
  563 <p class="short-description">Returns all URLs currently cached in the URL-cache.</p>
  564     <ul class="tags">
  565                 <li><span class="field">return:</span> Numeric array containing all URLs as PHPCrawlerURLDescriptor-objects</li>
  566                 <li><span class="field">abstract:</span> </li>
  567                 <li><span class="field">access:</span> public</li>
  568             </ul>
  569     
  570     <div class="method-signature">
  571         <span class="method-result">array</span>
  572         <span class="method-name">
  573             getAllURLs
  574         </span>
  575                 ()
  576             </div>
  577     
  578         
  579             
  580             <hr class="separator" />
  581         <div class="notes">Redefined in descendants as:</div>
  582         <ul class="redefinitions">
  583                     <li>
  584                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodgetAllURLs">PHPCrawlerSQLiteURLCache::getAllURLs()</a>
  585                                 : Has no function in this class
  586                             </li>
  587                     <li>
  588                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodgetAllURLs">PHPCrawlerMemoryURLCache::getAllURLs()</a>
  589                                 : Returns all URLs currently cached in the URL-cache.
  590                             </li>
  591                 </ul>
  592     </div>
  593 <a name="methodgetDistinctURLHash" id="getDistinctURLHash"><!-- --></a>
  594 <div class="evenrow">
  595     
  596     <div class="method-header">
  597         <span class="method-title">getDistinctURLHash</span> (line <span class="line-number">85</span>)
  598     </div> 
  599     
  600     <!-- ========== Info from phpDoc block ========= -->
  601 <p class="short-description">Returns the distinct-hash for the given URL that ensures that no URLs a cached more than one time.</p>
  602     <ul class="tags">
  603                 <li><span class="field">return:</span> The hash or NULL if no distinct-hash should be used.</li>
  604                 <li><span class="field">access:</span> protected</li>
  605             </ul>
  606     
  607     <div class="method-signature">
  608         <span class="method-result">string</span>
  609         <span class="method-name">
  610             getDistinctURLHash
  611         </span>
  612                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  613             </div>
  614     
  615             <ul class="parameters">
  616                     <li>
  617                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>
  618                 <span class="var-name">$UrlDescriptor</span>            </li>
  619                 </ul>
  620         
  621             
  622     </div>
  623 <a name="methodgetNextUrl" id="getNextUrl"><!-- --></a>
  624 <div class="oddrow">
  625     
  626     <div class="method-header">
  627         <span class="method-title">getNextUrl</span> (line <span class="line-number">28</span>)
  628     </div> 
  629     
  630     <!-- ========== Info from phpDoc block ========= -->
  631 <p class="short-description">Returns the next URL from the cache that should be crawled.</p>
  632     <ul class="tags">
  633                 <li><span class="field">abstract:</span> </li>
  634                 <li><span class="field">access:</span> public</li>
  635             </ul>
  636     
  637     <div class="method-signature">
  638         <span class="method-result">PhpCrawlerURLDescriptor</span>
  639         <span class="method-name">
  640             getNextUrl
  641         </span>
  642                 ()
  643             </div>
  644     
  645         
  646             
  647             <hr class="separator" />
  648         <div class="notes">Redefined in descendants as:</div>
  649         <ul class="redefinitions">
  650                     <li>
  651                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodgetNextUrl">PHPCrawlerSQLiteURLCache::getNextUrl()</a>
  652                                 : Returns the next URL from the cache that should be crawled.
  653                             </li>
  654                     <li>
  655                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodgetNextUrl">PHPCrawlerMemoryURLCache::getNextUrl()</a>
  656                                 : Returns the next URL from the cache that should be crawled.
  657                             </li>
  658                 </ul>
  659     </div>
  660 <a name="methodgetUrlPriority" id="getUrlPriority"><!-- --></a>
  661 <div class="evenrow">
  662     
  663     <div class="method-header">
  664         <span class="method-title">getUrlPriority</span> (line <span class="line-number">98</span>)
  665     </div> 
  666     
  667     <!-- ========== Info from phpDoc block ========= -->
  668 <p class="short-description">Gets the priority-level of the given URL</p>
  669     <ul class="tags">
  670                 <li><span class="field">access:</span> protected</li>
  671             </ul>
  672     
  673     <div class="method-signature">
  674         <span class="method-result">void</span>
  675         <span class="method-name">
  676             getUrlPriority
  677         </span>
  678                     (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>)
  679             </div>
  680     
  681             <ul class="parameters">
  682                     <li>
  683                 <span class="var-type"></span>
  684                 <span class="var-name">$url</span>          </li>
  685                 </ul>
  686         
  687             
  688     </div>
  689 <a name="methodmarkUrlAsFollowed" id="markUrlAsFollowed"><!-- --></a>
  690 <div class="oddrow">
  691     
  692     <div class="method-header">
  693         <span class="method-title">markUrlAsFollowed</span> (line <span class="line-number">68</span>)
  694     </div> 
  695     
  696     <!-- ========== Info from phpDoc block ========= -->
  697 <p class="short-description">Marks the given URL in the cache as &quot;followed&quot;</p>
  698     <ul class="tags">
  699                 <li><span class="field">abstract:</span> </li>
  700                 <li><span class="field">access:</span> public</li>
  701             </ul>
  702     
  703     <div class="method-signature">
  704         <span class="method-result">void</span>
  705         <span class="method-name">
  706             markUrlAsFollowed
  707         </span>
  708                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  709             </div>
  710     
  711             <ul class="parameters">
  712                     <li>
  713                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>
  714                 <span class="var-name">$UrlDescriptor</span>            </li>
  715                 </ul>
  716         
  717             
  718             <hr class="separator" />
  719         <div class="notes">Redefined in descendants as:</div>
  720         <ul class="redefinitions">
  721                     <li>
  722                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodmarkUrlAsFollowed">PHPCrawlerSQLiteURLCache::markUrlAsFollowed()</a>
  723                                 : Marks the given URL in the cache as &quot;followed&quot;
  724                             </li>
  725                     <li>
  726                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodmarkUrlAsFollowed">PHPCrawlerMemoryURLCache::markUrlAsFollowed()</a>
  727                                 : Has no function in this memory-cache.
  728                             </li>
  729                 </ul>
  730     </div>
  731 <a name="methodpurgeCache" id="purgeCache"><!-- --></a>
  732 <div class="evenrow">
  733     
  734     <div class="method-header">
  735         <span class="method-title">purgeCache</span> (line <span class="line-number">78</span>)
  736     </div> 
  737     
  738     <!-- ========== Info from phpDoc block ========= -->
  739 <p class="short-description">Cleans/purges the URL-cache from inconsistent entries.</p>
  740     <ul class="tags">
  741                 <li><span class="field">abstract:</span> </li>
  742                 <li><span class="field">access:</span> public</li>
  743             </ul>
  744     
  745     <div class="method-signature">
  746         <span class="method-result">void</span>
  747         <span class="method-name">
  748             purgeCache
  749         </span>
  750                 ()
  751             </div>
  752     
  753         
  754             
  755             <hr class="separator" />
  756         <div class="notes">Redefined in descendants as:</div>
  757         <ul class="redefinitions">
  758                     <li>
  759                 <a href="../phpcrawl/PHPCrawlerSQLiteURLCache.html#methodpurgeCache">PHPCrawlerSQLiteURLCache::purgeCache()</a>
  760                                 : Cleans/purges the URL-cache from inconsistent entries.
  761                             </li>
  762                     <li>
  763                 <a href="../phpcrawl/PHPCrawlerMemoryURLCache.html#methodpurgeCache">PHPCrawlerMemoryURLCache::purgeCache()</a>
  764                                 : Has no function in this class.
  765                             </li>
  766                 </ul>
  767     </div>
  768                         
  769         </div>
  770     </div>
  771 
  772     <a name="sec-consts"></a>
  773     <div class="info-box">
  774         <div class="info-box-title">Class Constants</div>
  775         <div class="nav-bar">
  776             <a href="#sec-description">Description</a> |
  777                             <a href="#sec-descendents">Descendants</a> |
  778                                         <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
  779                         
  780             
  781                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  782                                                         | 
  783                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  784                             
  785                     </div>
  786         <div class="info-box-body">
  787             <a name="constURLHASH_NONE" id="URLHASH_NONE"><!-- --></A>
  788 <div class="oddrow">
  789 
  790     <div class="const-header">
  791         <span class="const-title">
  792             <span class="const-name">URLHASH_NONE</span>
  793              = <span class="const-default"> 3</span>
  794             (line <span class="line-number">21</span>)
  795         </span>
  796     </div>
  797 
  798     <!-- ========== Info from phpDoc block ========= -->
  799     
  800     
  801 </div>
  802 <a name="constURLHASH_RAWLINK" id="URLHASH_RAWLINK"><!-- --></A>
  803 <div class="evenrow">
  804 
  805     <div class="const-header">
  806         <span class="const-title">
  807             <span class="const-name">URLHASH_RAWLINK</span>
  808              = <span class="const-default"> 2</span>
  809             (line <span class="line-number">20</span>)
  810         </span>
  811     </div>
  812 
  813     <!-- ========== Info from phpDoc block ========= -->
  814     
  815     
  816 </div>
  817 <a name="constURLHASH_URL" id="URLHASH_URL"><!-- --></A>
  818 <div class="oddrow">
  819 
  820     <div class="const-header">
  821         <span class="const-title">
  822             <span class="const-name">URLHASH_URL</span>
  823              = <span class="const-default"> 1</span>
  824             (line <span class="line-number">19</span>)
  825         </span>
  826     </div>
  827 
  828     <!-- ========== Info from phpDoc block ========= -->
  829     
  830     
  831 </div>
  832                         
  833         </div>
  834     </div>
  835 
  836     <p class="notes" id="credit">
  837         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>
  838     </p>
  839     </div></body>
  840 </html>