"Fossies" - the Fresh Open Source Software Archive

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