"Fossies" - the Fresh Open Source Software Archive

Member "docs/elementindex.html" (20 Jan 2013, 224919 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></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                         <a name="top"></a>
   12 <h2>Full index</h2>
   13 <h3>Package indexes</h3>
   14 <ul>
   15     <li><a href="elementindex_SitemapCreator.html">SitemapCreator</a></li>
   16     <li><a href="elementindex_phpcrawl.html">phpcrawl</a></li>
   17     <li><a href="elementindex_phpcrawl-enums.html">phpcrawl-enums</a></li>
   18 </ul>
   19 <br />
   20 <div class="index-letter-menu">
   21     <a class="index-letter" href="elementindex.html#a">a</a>
   22     <a class="index-letter" href="elementindex.html#b">b</a>
   23     <a class="index-letter" href="elementindex.html#c">c</a>
   24     <a class="index-letter" href="elementindex.html#d">d</a>
   25     <a class="index-letter" href="elementindex.html#e">e</a>
   26     <a class="index-letter" href="elementindex.html#f">f</a>
   27     <a class="index-letter" href="elementindex.html#g">g</a>
   28     <a class="index-letter" href="elementindex.html#h">h</a>
   29     <a class="index-letter" href="elementindex.html#i">i</a>
   30     <a class="index-letter" href="elementindex.html#k">k</a>
   31     <a class="index-letter" href="elementindex.html#l">l</a>
   32     <a class="index-letter" href="elementindex.html#m">m</a>
   33     <a class="index-letter" href="elementindex.html#n">n</a>
   34     <a class="index-letter" href="elementindex.html#o">o</a>
   35     <a class="index-letter" href="elementindex.html#p">p</a>
   36     <a class="index-letter" href="elementindex.html#q">q</a>
   37     <a class="index-letter" href="elementindex.html#r">r</a>
   38     <a class="index-letter" href="elementindex.html#s">s</a>
   39     <a class="index-letter" href="elementindex.html#t">t</a>
   40     <a class="index-letter" href="elementindex.html#u">u</a>
   41     <a class="index-letter" href="elementindex.html#v">v</a>
   42     <a class="index-letter" href="elementindex.html#w">w</a>
   43     <a class="index-letter" href="elementindex.html#x">x</a>
   44     <a class="index-letter" href="elementindex.html#_">_</a>
   45 </div>
   46 
   47     <a name="a"></a>
   48     <div class="index-letter-section">
   49         <div style="float: left" class="index-letter-title">a</div>
   50         <div style="float: right"><a href="#top">top</a></div>
   51         <div style="clear: both"></div>
   52     </div>
   53     <dl>
   54             <dt class="field">
   55                         <span class="var-title">$abort_reason</span>
   56                     </dt>
   57         <dd class="index-item-body">
   58             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerStatus.html#var$abort_reason">PHPCrawlerStatus::$abort_reason</a> in PHPCrawlerStatus.class.php</div>
   59                             <div class="index-item-description">Abort reason for aborting the crawling-process.</div>
   60                     </dd>
   61             <dt class="field">
   62                         <span class="var-title">$abort_reason</span>
   63                     </dt>
   64         <dd class="index-item-body">
   65             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$abort_reason">PHPCrawlerProcessReport::$abort_reason</a> in PHPCrawlerProcessReport.class.php</div>
   66                             <div class="index-item-description">Reason for the abortion of the crawling-process</div>
   67                     </dd>
   68             <dt class="field">
   69                         <span class="var-title">$aggressive_search</span>
   70                     </dt>
   71         <dd class="index-item-body">
   72             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$aggressive_search">PHPCrawlerLinkFinder::$aggressive_search</a> in PHPCrawlerLinkFinder.class.php</div>
   73                             <div class="index-item-description">Specifies whether links will also be searched outside of HTML-tags</div>
   74                     </dd>
   75             <dt class="field">
   76                         <span class="var-title">$auth_password</span>
   77                     </dt>
   78         <dd class="index-item-body">
   79             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$auth_password">PHPCrawlerUrlPartsDescriptor::$auth_password</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
   80                     </dd>
   81             <dt class="field">
   82                         <span class="var-title">$auth_username</span>
   83                     </dt>
   84         <dd class="index-item-body">
   85             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$auth_username">PHPCrawlerUrlPartsDescriptor::$auth_username</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
   86                     </dd>
   87             <dt class="field">
   88                         ABORTREASON_FILELIMIT_REACHED
   89                     </dt>
   90         <dd class="index-item-body">
   91             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerAbortReasons.html#constABORTREASON_FILELIMIT_REACHED">PHPCrawlerAbortReasons::ABORTREASON_FILELIMIT_REACHED</a> in PHPCrawlerAbortReasons.class.php</div>
   92                             <div class="index-item-description">Crawling-process aborted because the filelimit set by user was reached.</div>
   93                     </dd>
   94             <dt class="field">
   95                         ABORTREASON_PASSEDTHROUGH
   96                     </dt>
   97         <dd class="index-item-body">
   98             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerAbortReasons.html#constABORTREASON_PASSEDTHROUGH">PHPCrawlerAbortReasons::ABORTREASON_PASSEDTHROUGH</a> in PHPCrawlerAbortReasons.class.php</div>
   99                             <div class="index-item-description">Crawling-process aborted because everything is done/passedthrough.</div>
  100                     </dd>
  101             <dt class="field">
  102                         ABORTREASON_TRAFFICLIMIT_REACHED
  103                     </dt>
  104         <dd class="index-item-body">
  105             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerAbortReasons.html#constABORTREASON_TRAFFICLIMIT_REACHED">PHPCrawlerAbortReasons::ABORTREASON_TRAFFICLIMIT_REACHED</a> in PHPCrawlerAbortReasons.class.php</div>
  106                             <div class="index-item-description">Crawling-process aborted because the traffic-limit set by user was reached.</div>
  107                     </dd>
  108             <dt class="field">
  109                         ABORTREASON_USERABORT
  110                     </dt>
  111         <dd class="index-item-body">
  112             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerAbortReasons.html#constABORTREASON_USERABORT">PHPCrawlerAbortReasons::ABORTREASON_USERABORT</a> in PHPCrawlerAbortReasons.class.php</div>
  113                             <div class="index-item-description">Crawling-process aborted because the handleDocumentInfo-method returned a negative value</div>
  114                     </dd>
  115             <dt class="field">
  116                         <span class="method-title">addBasicAuthentication</span>
  117                     </dt>
  118         <dd class="index-item-body">
  119             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddBasicAuthentication">PHPCrawler::addBasicAuthentication()</a> in PHPCrawler.class.php</div>
  120                             <div class="index-item-description">Adds a basic-authentication (username and password) to the list of basic authentications that will be send with requests.</div>
  121                     </dd>
  122             <dt class="field">
  123                         <span class="method-title">addBasicAuthentication</span>
  124                     </dt>
  125         <dd class="index-item-body">
  126             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html#methodaddBasicAuthentication">PHPCrawlerUserSendDataCache::addBasicAuthentication()</a> in PHPCrawlerUserSendDataCache.class.php</div>
  127                             <div class="index-item-description">Adds a basic-authentication (username and password) to the list of authentications that will be send  with requests.</div>
  128                     </dd>
  129             <dt class="field">
  130                         <span class="method-title">addContentTypeReceiveRule</span>
  131                     </dt>
  132         <dd class="index-item-body">
  133             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddContentTypeReceiveRule">PHPCrawler::addContentTypeReceiveRule()</a> in PHPCrawler.class.php</div>
  134                             <div class="index-item-description">Adds a rule to the list of rules that decides which pages or files - regarding their content-type - should be received</div>
  135                     </dd>
  136             <dt class="field">
  137                         <span class="method-title">addCookie</span>
  138                     </dt>
  139         <dd class="index-item-body">
  140             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryCookieCache.html#methodaddCookie">PHPCrawlerMemoryCookieCache::addCookie()</a> in PHPCrawlerMemoryCookieCache.class.php</div>
  141                             <div class="index-item-description">Adds a cookie to the cookie-cache.</div>
  142                     </dd>
  143             <dt class="field">
  144                         <span class="method-title">addCookie</span>
  145                     </dt>
  146         <dd class="index-item-body">
  147             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookie">PHPCrawlerCookieCacheBase::addCookie()</a> in PHPCrawlerCookieCacheBase.class.php</div>
  148                             <div class="index-item-description">Adds a cookie to the cookie-cache.</div>
  149                     </dd>
  150             <dt class="field">
  151                         <span class="method-title">addCookie</span>
  152                     </dt>
  153         <dd class="index-item-body">
  154             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodaddCookie">PHPCrawlerSQLiteCookieCache::addCookie()</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
  155                             <div class="index-item-description">Adds a cookie to the cookie-cache.</div>
  156                     </dd>
  157             <dt class="field">
  158                         <span class="method-title">addCookie</span>
  159                     </dt>
  160         <dd class="index-item-body">
  161             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddCookie">PHPCrawlerHTTPRequest::addCookie()</a> in PHPCrawlerHTTPRequest.class.php</div>
  162                             <div class="index-item-description">Adds a cookie to send with the request.</div>
  163                     </dd>
  164             <dt class="field">
  165                         <span class="method-title">addCookieDescriptor</span>
  166                     </dt>
  167         <dd class="index-item-body">
  168             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddCookieDescriptor">PHPCrawlerHTTPRequest::addCookieDescriptor()</a> in PHPCrawlerHTTPRequest.class.php</div>
  169                             <div class="index-item-description">Adds a cookie to send with the request.</div>
  170                     </dd>
  171             <dt class="field">
  172                         <span class="method-title">addCookieDescriptors</span>
  173                     </dt>
  174         <dd class="index-item-body">
  175             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddCookieDescriptors">PHPCrawlerHTTPRequest::addCookieDescriptors()</a> in PHPCrawlerHTTPRequest.class.php</div>
  176                             <div class="index-item-description">Adds a bunch of cookies to send with the request</div>
  177                     </dd>
  178             <dt class="field">
  179                         <span class="method-title">addCookies</span>
  180                     </dt>
  181         <dd class="index-item-body">
  182             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodaddCookies">PHPCrawlerSQLiteCookieCache::addCookies()</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
  183                             <div class="index-item-description">Adds a bunch of cookies to the cookie-cache.</div>
  184                     </dd>
  185             <dt class="field">
  186                         <span class="method-title">addCookies</span>
  187                     </dt>
  188         <dd class="index-item-body">
  189             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookies">PHPCrawlerCookieCacheBase::addCookies()</a> in PHPCrawlerCookieCacheBase.class.php</div>
  190                             <div class="index-item-description">Adds a bunch of cookies to the cookie-cache.</div>
  191                     </dd>
  192             <dt class="field">
  193                         <span class="method-title">addCookies</span>
  194                     </dt>
  195         <dd class="index-item-body">
  196             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryCookieCache.html#methodaddCookies">PHPCrawlerMemoryCookieCache::addCookies()</a> in PHPCrawlerMemoryCookieCache.class.php</div>
  197                             <div class="index-item-description">Adds a bunch of cookies to the cookie-cache.</div>
  198                     </dd>
  199             <dt class="field">
  200                         <span class="method-title">addDocumentInfo</span>
  201                     </dt>
  202         <dd class="index-item-body">
  203             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#methodaddDocumentInfo">PHPCrawlerDocumentInfoQueue::addDocumentInfo()</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
  204                             <div class="index-item-description">Adds a PHPCrawlerDocumentInfo-object to the queue</div>
  205                     </dd>
  206             <dt class="field">
  207                         <span class="method-title">addEngine</span>
  208                     </dt>
  209         <dd class="index-item-body">
  210             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddEngine">SitemapCreator::addEngine()</a> in SitemapCreator.class.php</div>
  211                             <div class="index-item-description">add a ping URL to the array $engines</div>
  212                     </dd>
  213             <dt class="field">
  214                         <span class="method-title">addEntry</span>
  215                     </dt>
  216         <dd class="index-item-body">
  217             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddEntry">SitemapCreator::addEntry()</a> in SitemapCreator.class.php</div>
  218                             <div class="index-item-description">add URL entry manually to <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
  219                     </dd>
  220             <dt class="field">
  221                         <span class="method-title">addFollowMatch</span>
  222                     </dt>
  223         <dd class="index-item-body">
  224             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddFollowMatch">PHPCrawler::addFollowMatch()</a> in PHPCrawler.class.php</div>
  225                             <div class="index-item-description">Alias for addURLFollowRule().</div>
  226                     </dd>
  227             <dt class="field">
  228                         <span class="method-title">addLinkExtractionTags</span>
  229                     </dt>
  230         <dd class="index-item-body">
  231             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddLinkExtractionTags">PHPCrawler::addLinkExtractionTags()</a> in PHPCrawler.class.php</div>
  232                             <div class="index-item-description">Sets the list of html-tags from which links should be extracted from.</div>
  233                     </dd>
  234             <dt class="field">
  235                         <span class="method-title">addLinkPriorities</span>
  236                     </dt>
  237         <dd class="index-item-body">
  238             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodaddLinkPriorities">PHPCrawlerURLCacheBase::addLinkPriorities()</a> in PHPCrawlerURLCacheBase.class.php</div>
  239                             <div class="index-item-description">Adds a bunch of link-priorities</div>
  240                     </dd>
  241             <dt class="field">
  242                         <span class="method-title">addLinkPriority</span>
  243                     </dt>
  244         <dd class="index-item-body">
  245             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodaddLinkPriority">PHPCrawlerURLCacheBase::addLinkPriority()</a> in PHPCrawlerURLCacheBase.class.php</div>
  246                             <div class="index-item-description">Adds a Link-Priority-Level</div>
  247                     </dd>
  248             <dt class="field">
  249                         <span class="method-title">addLinkPriority</span>
  250                     </dt>
  251         <dd class="index-item-body">
  252             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddLinkPriority">PHPCrawler::addLinkPriority()</a> in PHPCrawler.class.php</div>
  253                             <div class="index-item-description">Adds a regular expression togehter with a priority-level to the list of rules that decide what links should be prefered.</div>
  254                     </dd>
  255             <dt class="field">
  256                         <span class="method-title">addLinkSearchContentType</span>
  257                     </dt>
  258         <dd class="index-item-body">
  259             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddLinkSearchContentType">PHPCrawlerHTTPRequest::addLinkSearchContentType()</a> in PHPCrawlerHTTPRequest.class.php</div>
  260                             <div class="index-item-description">Adds a rule to the list of rules that decide what kind of documents should get  checked for links in (regarding their content-type)</div>
  261                     </dd>
  262             <dt class="field">
  263                         <span class="method-title">addLinkSearchContentType</span>
  264                     </dt>
  265         <dd class="index-item-body">
  266             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddLinkSearchContentType">PHPCrawler::addLinkSearchContentType()</a> in PHPCrawler.class.php</div>
  267                             <div class="index-item-description">Adds a rule to the list of rules that decide in what kind of documents the crawler  should search for links in (regarding their content-type)</div>
  268                     </dd>
  269             <dt class="field">
  270                         <span class="method-title">addLinkToCache</span>
  271                     </dt>
  272         <dd class="index-item-body">
  273             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodaddLinkToCache">PHPCrawlerLinkFinder::addLinkToCache()</a> in PHPCrawlerLinkFinder.class.php</div>
  274                     </dd>
  275             <dt class="field">
  276                         <span class="method-title">addNonFollowMatch</span>
  277                     </dt>
  278         <dd class="index-item-body">
  279             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddNonFollowMatch">PHPCrawler::addNonFollowMatch()</a> in PHPCrawler.class.php</div>
  280                             <div class="index-item-description">Alias for addURLFilterRule().</div>
  281                     </dd>
  282             <dt class="field">
  283                         <span class="method-title">addPostData</span>
  284                     </dt>
  285         <dd class="index-item-body">
  286             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddPostData">PHPCrawlerHTTPRequest::addPostData()</a> in PHPCrawlerHTTPRequest.class.php</div>
  287                             <div class="index-item-description">Adds post-data to send with the request.</div>
  288                     </dd>
  289             <dt class="field">
  290                         <span class="method-title">addPostData</span>
  291                     </dt>
  292         <dd class="index-item-body">
  293             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddPostData">PHPCrawler::addPostData()</a> in PHPCrawler.class.php</div>
  294                             <div class="index-item-description">Adds post-data together with an URL-rule to the list of post-data to send with requests.</div>
  295                     </dd>
  296             <dt class="field">
  297                         <span class="method-title">addPostData</span>
  298                     </dt>
  299         <dd class="index-item-body">
  300             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html#methodaddPostData">PHPCrawlerUserSendDataCache::addPostData()</a> in PHPCrawlerUserSendDataCache.class.php</div>
  301                             <div class="index-item-description">Adds post-data together with an URL-regex to the list of post-data to send with requests.</div>
  302                     </dd>
  303             <dt class="field">
  304                         <span class="method-title">addReceiveContentType</span>
  305                     </dt>
  306         <dd class="index-item-body">
  307             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddReceiveContentType">PHPCrawler::addReceiveContentType()</a> in PHPCrawler.class.php</div>
  308                             <div class="index-item-description">Alias for addContentTypeReceiveRule().</div>
  309                     </dd>
  310             <dt class="field">
  311                         <span class="method-title">addReceiveContentType</span>
  312                     </dt>
  313         <dd class="index-item-body">
  314             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddReceiveContentType">PHPCrawlerHTTPRequest::addReceiveContentType()</a> in PHPCrawlerHTTPRequest.class.php</div>
  315                             <div class="index-item-description">Adds a rule to the list of rules that decides which pages or files - regarding their content-type - should be received</div>
  316                     </dd>
  317             <dt class="field">
  318                         <span class="method-title">addReceiveToMemoryMatch</span>
  319                     </dt>
  320         <dd class="index-item-body">
  321             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddReceiveToMemoryMatch">PHPCrawler::addReceiveToMemoryMatch()</a> in PHPCrawler.class.php</div>
  322                             <div class="index-item-description">Has no function anymore!</div>
  323                     </dd>
  324             <dt class="field">
  325                         <span class="method-title">addReceiveToTmpFileMatch</span>
  326                     </dt>
  327         <dd class="index-item-body">
  328             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddReceiveToTmpFileMatch">PHPCrawler::addReceiveToTmpFileMatch()</a> in PHPCrawler.class.php</div>
  329                             <div class="index-item-description">Alias for addStreamToFileContentType().</div>
  330                     </dd>
  331             <dt class="field">
  332                         <span class="method-title">addSitemapEXT</span>
  333                     </dt>
  334         <dd class="index-item-body">
  335             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddSitemapEXT">SitemapCreator::addSitemapEXT()</a> in SitemapCreator.class.php</div>
  336                             <div class="index-item-description">adds sitemap gzip extension to sitemap filename if $use_gzip enabled</div>
  337                     </dd>
  338             <dt class="field">
  339                         <span class="method-title">addStreamToFileContentType</span>
  340                     </dt>
  341         <dd class="index-item-body">
  342             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodaddStreamToFileContentType">PHPCrawlerHTTPRequest::addStreamToFileContentType()</a> in PHPCrawlerHTTPRequest.class.php</div>
  343                             <div class="index-item-description">Adds a rule to the list of rules that decides what types of content should be streamed diretly to the temporary file.</div>
  344                     </dd>
  345             <dt class="field">
  346                         <span class="method-title">addStreamToFileContentType</span>
  347                     </dt>
  348         <dd class="index-item-body">
  349             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddStreamToFileContentType">PHPCrawler::addStreamToFileContentType()</a> in PHPCrawler.class.php</div>
  350                             <div class="index-item-description">Adds a rule to the list of rules that decides what types of content should be streamed diretly to a temporary file.</div>
  351                     </dd>
  352             <dt class="field">
  353                         <span class="method-title">addToRobots</span>
  354                     </dt>
  355         <dd class="index-item-body">
  356             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddToRobots">SitemapCreator::addToRobots()</a> in SitemapCreator.class.php</div>
  357                             <div class="index-item-description">Add index sitemap URL to robots.txt file</div>
  358                     </dd>
  359             <dt class="field">
  360                         <span class="method-title">addURL</span>
  361                     </dt>
  362         <dd class="index-item-body">
  363             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodaddURL">PHPCrawlerURLCacheBase::addURL()</a> in PHPCrawlerURLCacheBase.class.php</div>
  364                             <div class="index-item-description">Adds an URL to the url-cache</div>
  365                     </dd>
  366             <dt class="field">
  367                         <span class="method-title">addURL</span>
  368                     </dt>
  369         <dd class="index-item-body">
  370             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodaddURL">PHPCrawlerSQLiteURLCache::addURL()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  371                             <div class="index-item-description">Adds an URL to the url-cache</div>
  372                     </dd>
  373             <dt class="field">
  374                         <span class="method-title">addURL</span>
  375                     </dt>
  376         <dd class="index-item-body">
  377             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodaddURL">PHPCrawlerMemoryURLCache::addURL()</a> in PHPCrawlerMemoryURLCache.class.php</div>
  378                             <div class="index-item-description">Adds an URL to the url-cache</div>
  379                     </dd>
  380             <dt class="field">
  381                         <span class="method-title">addURLFilterRule</span>
  382                     </dt>
  383         <dd class="index-item-body">
  384             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodaddURLFilterRule">PHPCrawlerURLFilter::addURLFilterRule()</a> in PHPCrawlerURLFilter.class.php</div>
  385                             <div class="index-item-description">Adds a rule to the list of rules that decide which URLs found on a page should be ignored by the crawler.</div>
  386                     </dd>
  387             <dt class="field">
  388                         <span class="method-title">addURLFilterRule</span>
  389                     </dt>
  390         <dd class="index-item-body">
  391             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddURLFilterRule">PHPCrawler::addURLFilterRule()</a> in PHPCrawler.class.php</div>
  392                             <div class="index-item-description">Adds a rule to the list of rules that decide which URLs found on a page should be ignored by the crawler.</div>
  393                     </dd>
  394             <dt class="field">
  395                         <span class="method-title">addURLFilterRules</span>
  396                     </dt>
  397         <dd class="index-item-body">
  398             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodaddURLFilterRules">PHPCrawlerURLFilter::addURLFilterRules()</a> in PHPCrawlerURLFilter.class.php</div>
  399                             <div class="index-item-description">Adds a bunch of rules to the list of rules that decide which URLs found on a page should be ignored by the crawler.</div>
  400                     </dd>
  401             <dt class="field">
  402                         <span class="method-title">addURLFollowRule</span>
  403                     </dt>
  404         <dd class="index-item-body">
  405             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodaddURLFollowRule">PHPCrawlerURLFilter::addURLFollowRule()</a> in PHPCrawlerURLFilter.class.php</div>
  406                     </dd>
  407             <dt class="field">
  408                         <span class="method-title">addURLFollowRule</span>
  409                     </dt>
  410         <dd class="index-item-body">
  411             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodaddURLFollowRule">PHPCrawler::addURLFollowRule()</a> in PHPCrawler.class.php</div>
  412                             <div class="index-item-description">Adds a rule to the list of rules that decide which URLs found on a page should be followd explicitly.</div>
  413                     </dd>
  414             <dt class="field">
  415                         <span class="method-title">addURLs</span>
  416                     </dt>
  417         <dd class="index-item-body">
  418             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodaddURLs">PHPCrawlerURLCacheBase::addURLs()</a> in PHPCrawlerURLCacheBase.class.php</div>
  419                             <div class="index-item-description">Adds an bunch of URLs to the url-cache</div>
  420                     </dd>
  421             <dt class="field">
  422                         <span class="method-title">addURLs</span>
  423                     </dt>
  424         <dd class="index-item-body">
  425             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodaddURLs">PHPCrawlerMemoryURLCache::addURLs()</a> in PHPCrawlerMemoryURLCache.class.php</div>
  426                             <div class="index-item-description">Adds an bunch of URLs to the url-cache</div>
  427                     </dd>
  428             <dt class="field">
  429                         <span class="method-title">addURLs</span>
  430                     </dt>
  431         <dd class="index-item-body">
  432             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodaddURLs">PHPCrawlerSQLiteURLCache::addURLs()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  433                             <div class="index-item-description">Adds an bunch of URLs to the url-cache</div>
  434                     </dd>
  435             <dt class="field">
  436                         <span class="method-title">addURL_Entry</span>
  437                     </dt>
  438         <dd class="index-item-body">
  439             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html#methodaddURL_Entry">SMCCrawler::addURL_Entry()</a> in SitemapCreatorCrawler.class.php</div>
  440                             <div class="index-item-description">add URL entry <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
  441                     </dd>
  442             <dt class="field">
  443                         <span class="method-title">addXMLURLSet</span>
  444                     </dt>
  445         <dd class="index-item-body">
  446             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddXMLURLSet">SitemapCreator::addXMLURLSet()</a> in SitemapCreator.class.php</div>
  447                             <div class="index-item-description">Add single XML code to $xml_url_set</div>
  448                     </dd>
  449         </dl>
  450     <a name="b"></a>
  451     <div class="index-letter-section">
  452         <div style="float: left" class="index-letter-title">b</div>
  453         <div style="float: right"><a href="#top">top</a></div>
  454         <div style="clear: both"></div>
  455     </div>
  456     <dl>
  457             <dt class="field">
  458                         <span class="var-title">$baseUrlParts</span>
  459                     </dt>
  460         <dd class="index-item-body">
  461             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$baseUrlParts">PHPCrawlerLinkFinder::$baseUrlParts</a> in PHPCrawlerLinkFinder.class.php</div>
  462                             <div class="index-item-description">Parts of the base-url as PHPCrawlerUrlPartsDescriptor-object</div>
  463                     </dd>
  464             <dt class="field">
  465                         <span class="var-title">$basic_authentications</span>
  466                     </dt>
  467         <dd class="index-item-body">
  468             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html#var$basic_authentications">PHPCrawlerUserSendDataCache::$basic_authentications</a> in PHPCrawlerUserSendDataCache.class.php</div>
  469                             <div class="index-item-description">Array containing basic-authentications to send.</div>
  470                     </dd>
  471             <dt class="field">
  472                         <span class="var-title">$benchmarks</span>
  473                     </dt>
  474         <dd class="index-item-body">
  475             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$benchmarks">PHPCrawlerDocumentInfo::$benchmarks</a> in PHPCrawlerDocumentInfo.class.php</div>
  476                             <div class="index-item-description">Some internal benchmak-results as array.</div>
  477                     </dd>
  478             <dt class="field">
  479                         <span class="var-title">$benchmark_results</span>
  480                     </dt>
  481         <dd class="index-item-body">
  482             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#var$benchmark_results">PHPCrawlerBenchmark::$benchmark_results</a> in PHPCrawlerBenchmark.class.php</div>
  483                     </dd>
  484             <dt class="field">
  485                         <span class="var-title">$benchmark_startcount</span>
  486                     </dt>
  487         <dd class="index-item-body">
  488             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#var$benchmark_startcount">PHPCrawlerBenchmark::$benchmark_startcount</a> in PHPCrawlerBenchmark.class.php</div>
  489                     </dd>
  490             <dt class="field">
  491                         <span class="var-title">$benchmark_starttimes</span>
  492                     </dt>
  493         <dd class="index-item-body">
  494             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#var$benchmark_starttimes">PHPCrawlerBenchmark::$benchmark_starttimes</a> in PHPCrawlerBenchmark.class.php</div>
  495                     </dd>
  496             <dt class="field">
  497                         <span class="var-title">$bytes_received</span>
  498                     </dt>
  499         <dd class="index-item-body">
  500             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$bytes_received">PHPCrawlerDocumentInfo::$bytes_received</a> in PHPCrawlerDocumentInfo.class.php</div>
  501                             <div class="index-item-description">The number of bytes the crawler received of the content of the document.</div>
  502                     </dd>
  503             <dt class="field">
  504                         <span class="var-title">$bytes_received</span>
  505                     </dt>
  506         <dd class="index-item-body">
  507             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$bytes_received">PHPCrawlerProcessReport::$bytes_received</a> in PHPCrawlerProcessReport.class.php</div>
  508                             <div class="index-item-description">The total number of bytes the crawler received alltogether.</div>
  509                     </dd>
  510             <dt class="field">
  511                         <span class="var-title">$bytes_received</span>
  512                     </dt>
  513         <dd class="index-item-body">
  514             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerStatus.html#var$bytes_received">PHPCrawlerStatus::$bytes_received</a> in PHPCrawlerStatus.class.php</div>
  515                             <div class="index-item-description">Number of bytes the crawler-instance received so far</div>
  516                     </dd>
  517             <dt class="field">
  518                         <span class="method-title">buildCookieHeader</span>
  519                     </dt>
  520         <dd class="index-item-body">
  521             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodbuildCookieHeader">PHPCrawlerHTTPRequest::buildCookieHeader()</a> in PHPCrawlerHTTPRequest.class.php</div>
  522                             <div class="index-item-description">Builds the cookie-header-part for the header to send.</div>
  523                     </dd>
  524             <dt class="field">
  525                         <span class="method-title">buildPostContent</span>
  526                     </dt>
  527         <dd class="index-item-body">
  528             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodbuildPostContent">PHPCrawlerHTTPRequest::buildPostContent()</a> in PHPCrawlerHTTPRequest.class.php</div>
  529                             <div class="index-item-description">Builds the post-content from the postdata-array for the header to send with the request (MIME-style)</div>
  530                     </dd>
  531             <dt class="field">
  532                         <span class="method-title">buildRegExpressions</span>
  533                     </dt>
  534         <dd class="index-item-body">
  535             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html#methodbuildRegExpressions">PHPCrawlerRobotsTxtParser::buildRegExpressions()</a> in PHPCrawlerRobotsTxtParser.class.php</div>
  536                             <div class="index-item-description">Returns an array containig regular-expressions corresponding  to the given robots.txt-style &quot;Disallow&quot;-lines</div>
  537                     </dd>
  538             <dt class="field">
  539                         <span class="method-title">buildRequestHeader</span>
  540                     </dt>
  541         <dd class="index-item-body">
  542             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodbuildRequestHeader">PHPCrawlerHTTPRequest::buildRequestHeader()</a> in PHPCrawlerHTTPRequest.class.php</div>
  543                             <div class="index-item-description">Builds the request-header from the given settings.</div>
  544                     </dd>
  545             <dt class="field">
  546                         <span class="method-title">buildURLFromLink</span>
  547                     </dt>
  548         <dd class="index-item-body">
  549             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodbuildURLFromLink">PHPCrawlerUtils::buildURLFromLink()</a> in PHPCrawlerUtils.class.php</div>
  550                             <div class="index-item-description">Reconstructs a full qualified and normalized URL from a given link relating to the URL the link was found in.</div>
  551                     </dd>
  552             <dt class="field">
  553                         <span class="method-title">buildURLFromParts</span>
  554                     </dt>
  555         <dd class="index-item-body">
  556             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodbuildURLFromParts">PHPCrawlerUtils::buildURLFromParts()</a> in PHPCrawlerUtils.class.php</div>
  557                             <div class="index-item-description">Builds an URL from it's single parts.</div>
  558                     </dd>
  559         </dl>
  560     <a name="c"></a>
  561     <div class="index-letter-section">
  562         <div style="float: left" class="index-letter-title">c</div>
  563         <div style="float: right"><a href="#top">top</a></div>
  564         <div style="clear: both"></div>
  565     </div>
  566     <dl>
  567             <dt class="field">
  568                         <span class="var-title">$child_process_number</span>
  569                     </dt>
  570         <dd class="index-item-body">
  571             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$child_process_number">PHPCrawler::$child_process_number</a> in PHPCrawler.class.php</div>
  572                             <div class="index-item-description">Number of child-process (NOT the PID!)</div>
  573                     </dd>
  574             <dt class="field">
  575                         <span class="var-title">$classpath</span>
  576                     </dt>
  577         <dd class="index-item-body">
  578             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$classpath">SitemapCreator::$classpath</a> in SitemapCreator.class.php</div>
  579                     </dd>
  580             <dt class="field">
  581                         <span class="var-title">$class_version</span>
  582                     </dt>
  583         <dd class="index-item-body">
  584             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$class_version">PHPCrawler::$class_version</a> in PHPCrawler.class.php</div>
  585                     </dd>
  586             <dt class="field">
  587                         <span class="var-title">$class_version</span>
  588                     </dt>
  589         <dd class="index-item-body">
  590             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$class_version">SitemapCreator::$class_version</a> in SitemapCreator.class.php</div>
  591                     </dd>
  592             <dt class="field">
  593                         <span class="var-title">$content</span>
  594                     </dt>
  595         <dd class="index-item-body">
  596             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$content">PHPCrawlerDocumentInfo::$content</a> in PHPCrawlerDocumentInfo.class.php</div>
  597                             <div class="index-item-description">The content of the requested document (html-sourcecode or content of file).</div>
  598                     </dd>
  599             <dt class="field">
  600                         <span class="var-title">$content_length</span>
  601                     </dt>
  602         <dd class="index-item-body">
  603             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html#var$content_length">PHPCrawlerResponseHeader::$content_length</a> in PHPCrawlerResponseHeader.class.php</div>
  604                             <div class="index-item-description">The content-length as stated in the header.</div>
  605                     </dd>
  606             <dt class="field">
  607                         <span class="var-title">$content_size_limit</span>
  608                     </dt>
  609         <dd class="index-item-body">
  610             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$content_size_limit">PHPCrawlerHTTPRequest::$content_size_limit</a> in PHPCrawlerHTTPRequest.class.php</div>
  611                             <div class="index-item-description">Limit for content-size to receive</div>
  612                     </dd>
  613             <dt class="field">
  614                         <span class="var-title">$content_tmp_file</span>
  615                     </dt>
  616         <dd class="index-item-body">
  617             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$content_tmp_file">PHPCrawlerDocumentInfo::$content_tmp_file</a> in PHPCrawlerDocumentInfo.class.php</div>
  618                             <div class="index-item-description">The temporary file to which the content was received.</div>
  619                     </dd>
  620             <dt class="field">
  621                         <span class="var-title">$content_type</span>
  622                     </dt>
  623         <dd class="index-item-body">
  624             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$content_type">PHPCrawlerDocumentInfo::$content_type</a> in PHPCrawlerDocumentInfo.class.php</div>
  625                             <div class="index-item-description">The content-type of the page or file, e.g. &quot;text/html&quot; or &quot;image/gif&quot;.</div>
  626                     </dd>
  627             <dt class="field">
  628                         <span class="var-title">$content_type</span>
  629                     </dt>
  630         <dd class="index-item-body">
  631             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html#var$content_type">PHPCrawlerResponseHeader::$content_type</a> in PHPCrawlerResponseHeader.class.php</div>
  632                             <div class="index-item-description">The content-type</div>
  633                     </dd>
  634             <dt class="field">
  635                         <span class="var-title">$CookieCache</span>
  636                     </dt>
  637         <dd class="index-item-body">
  638             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$CookieCache">PHPCrawler::$CookieCache</a> in PHPCrawler.class.php</div>
  639                             <div class="index-item-description">The PHPCrawlerCookieCache-Object</div>
  640                     </dd>
  641             <dt class="field">
  642                         <span class="var-title">$cookies</span>
  643                     </dt>
  644         <dd class="index-item-body">
  645             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryCookieCache.html#var$cookies">PHPCrawlerMemoryCookieCache::$cookies</a> in PHPCrawlerMemoryCookieCache.class.php</div>
  646                     </dd>
  647             <dt class="field">
  648                         <span class="var-title">$cookies</span>
  649                     </dt>
  650         <dd class="index-item-body">
  651             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html#var$cookies">PHPCrawlerResponseHeader::$cookies</a> in PHPCrawlerResponseHeader.class.php</div>
  652                             <div class="index-item-description">All cookies found in the header</div>
  653                     </dd>
  654             <dt class="field">
  655                         <span class="var-title">$cookies</span>
  656                     </dt>
  657         <dd class="index-item-body">
  658             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$cookies">PHPCrawlerDocumentInfo::$cookies</a> in PHPCrawlerDocumentInfo.class.php</div>
  659                             <div class="index-item-description">Cookies send by the server.</div>
  660                     </dd>
  661             <dt class="field">
  662                         <span class="var-title">$cookie_array</span>
  663                     </dt>
  664         <dd class="index-item-body">
  665             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$cookie_array">PHPCrawlerHTTPRequest::$cookie_array</a> in PHPCrawlerHTTPRequest.class.php</div>
  666                             <div class="index-item-description">Array containing cookies to send with the request</div>
  667                     </dd>
  668             <dt class="field">
  669                         <span class="var-title">$cookie_handling_enabled</span>
  670                     </dt>
  671         <dd class="index-item-body">
  672             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$cookie_handling_enabled">PHPCrawler::$cookie_handling_enabled</a> in PHPCrawler.class.php</div>
  673                             <div class="index-item-description">Flag cookie-handling enabled/diabled</div>
  674                     </dd>
  675             <dt class="field">
  676                         <span class="var-title">$cookie_send_time</span>
  677                     </dt>
  678         <dd class="index-item-body">
  679             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$cookie_send_time">PHPCrawlerCookieDescriptor::$cookie_send_time</a> in PHPCrawlerCookieDescriptor.class.php</div>
  680                             <div class="index-item-description">The time the cookie was send</div>
  681                     </dd>
  682             <dt class="field">
  683                         <span class="var-title">$Crawler</span>
  684                     </dt>
  685         <dd class="index-item-body">
  686             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$Crawler">SitemapCreator::$Crawler</a> in SitemapCreator.class.php</div>
  687                     </dd>
  688             <dt class="field">
  689                         <span class="var-title">$crawlerStatus</span>
  690                     </dt>
  691         <dd class="index-item-body">
  692             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#var$crawlerStatus">PHPCrawlerProcessCommunication::$crawlerStatus</a> in PHPCrawlerProcessCommunication.class.php</div>
  693                     </dd>
  694             <dt class="field">
  695                         <span class="var-title">$crawler_reports</span>
  696                     </dt>
  697         <dd class="index-item-body">
  698             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$crawler_reports">SitemapCreator::$crawler_reports</a> in SitemapCreator.class.php</div>
  699                     </dd>
  700             <dt class="field">
  701                         <span class="var-title">$crawler_uniqid</span>
  702                     </dt>
  703         <dd class="index-item-body">
  704             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#var$crawler_uniqid">PHPCrawlerProcessCommunication::$crawler_uniqid</a> in PHPCrawlerProcessCommunication.class.php</div>
  705                     </dd>
  706             <dt class="field">
  707                         <span class="var-title">$crawler_uniqid</span>
  708                     </dt>
  709         <dd class="index-item-body">
  710             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$crawler_uniqid">PHPCrawler::$crawler_uniqid</a> in PHPCrawler.class.php</div>
  711                             <div class="index-item-description">UID of this instance of the crawler</div>
  712                     </dd>
  713             <dt class="field">
  714                         <span class="var-title">$CurrentDocumentInfo</span>
  715                     </dt>
  716         <dd class="index-item-body">
  717             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$CurrentDocumentInfo">PHPCrawlerURLFilter::$CurrentDocumentInfo</a> in PHPCrawlerURLFilter.class.php</div>
  718                             <div class="index-item-description">Current PHPCrawlerDocumentInfo-object of the current document</div>
  719                     </dd>
  720             <dt class="field">
  721                         <span class="method-title">calcFrequency</span>
  722                     </dt>
  723         <dd class="index-item-body">
  724             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodcalcFrequency">SitemapCreator::calcFrequency()</a> in SitemapCreator.class.php</div>
  725                             <div class="index-item-description">calculates Frequency for each entry $priority_mode</div>
  726                     </dd>
  727             <dt class="field">
  728                         <span class="method-title">calcPriority</span>
  729                     </dt>
  730         <dd class="index-item-body">
  731             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodcalcPriority">SitemapCreator::calcPriority()</a> in SitemapCreator.class.php</div>
  732                             <div class="index-item-description">calculates Priority for each entry $priority_mode</div>
  733                     </dd>
  734             <dt class="field">
  735                         <span class="method-title">checkForAbort</span>
  736                     </dt>
  737         <dd class="index-item-body">
  738             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodcheckForAbort">PHPCrawler::checkForAbort()</a> in PHPCrawler.class.php</div>
  739                             <div class="index-item-description">Checks if the crawling-process should be aborted.</div>
  740                     </dd>
  741             <dt class="field">
  742                         <span class="method-title">checkRegexPattern</span>
  743                     </dt>
  744         <dd class="index-item-body">
  745             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodcheckRegexPattern">PHPCrawlerUtils::checkRegexPattern()</a> in PHPCrawlerUtils.class.php</div>
  746                             <div class="index-item-description">Checks whether a given RegEx-pattern is valid or not.</div>
  747                     </dd>
  748             <dt class="field">
  749                         <span class="method-title">checkStringAgainstRegexArray</span>
  750                     </dt>
  751         <dd class="index-item-body">
  752             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodcheckStringAgainstRegexArray">PHPCrawlerUtils::checkStringAgainstRegexArray()</a> in PHPCrawlerUtils.class.php</div>
  753                             <div class="index-item-description">Checks whether a given string matches with one of the given regular-expressions.</div>
  754                     </dd>
  755             <dt class="field">
  756                         <span class="method-title">childProcessAlive</span>
  757                     </dt>
  758         <dd class="index-item-body">
  759             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodchildProcessAlive">PHPCrawlerProcessCommunication::childProcessAlive()</a> in PHPCrawlerProcessCommunication.class.php</div>
  760                             <div class="index-item-description">Checks wehther any child-processes a (still) running.</div>
  761                     </dd>
  762             <dt class="field">
  763                         <span class="method-title">cleanup</span>
  764                     </dt>
  765         <dd class="index-item-body">
  766             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodcleanup">PHPCrawlerURLCacheBase::cleanup()</a> in PHPCrawlerURLCacheBase.class.php</div>
  767                             <div class="index-item-description">Do cleanups after the cache is not needed anymore</div>
  768                     </dd>
  769             <dt class="field">
  770                         <span class="method-title">cleanup</span>
  771                     </dt>
  772         <dd class="index-item-body">
  773             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodcleanup">PHPCrawler::cleanup()</a> in PHPCrawler.class.php</div>
  774                             <div class="index-item-description">Cleans up the crawler after it has finished.</div>
  775                     </dd>
  776             <dt class="field">
  777                         <span class="method-title">cleanup</span>
  778                     </dt>
  779         <dd class="index-item-body">
  780             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodcleanup">PHPCrawlerMemoryURLCache::cleanup()</a> in PHPCrawlerMemoryURLCache.class.php</div>
  781                             <div class="index-item-description">Has no function in this class.</div>
  782                     </dd>
  783             <dt class="field">
  784                         <span class="method-title">cleanup</span>
  785                     </dt>
  786         <dd class="index-item-body">
  787             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodcleanup">PHPCrawlerSQLiteURLCache::cleanup()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  788                             <div class="index-item-description">Cleans up the cache after is it not needed anymore.</div>
  789                     </dd>
  790             <dt class="field">
  791                         <span class="method-title">clear</span>
  792                     </dt>
  793         <dd class="index-item-body">
  794             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodclear">PHPCrawlerURLCacheBase::clear()</a> in PHPCrawlerURLCacheBase.class.php</div>
  795                             <div class="index-item-description">Removes all URLs and all priority-rules from the URL-cache.</div>
  796                     </dd>
  797             <dt class="field">
  798                         <span class="method-title">clear</span>
  799                     </dt>
  800         <dd class="index-item-body">
  801             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodclear">PHPCrawlerSQLiteURLCache::clear()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  802                             <div class="index-item-description">Removes all URLs and all priority-rules from the URL-cache.</div>
  803                     </dd>
  804             <dt class="field">
  805                         <span class="method-title">clear</span>
  806                     </dt>
  807         <dd class="index-item-body">
  808             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodclear">PHPCrawlerMemoryURLCache::clear()</a> in PHPCrawlerMemoryURLCache.class.php</div>
  809                             <div class="index-item-description">Removes all URLs and all priority-rules from the URL-cache.</div>
  810                     </dd>
  811             <dt class="field">
  812                         <span class="method-title">clearCookies</span>
  813                     </dt>
  814         <dd class="index-item-body">
  815             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodclearCookies">PHPCrawlerHTTPRequest::clearCookies()</a> in PHPCrawlerHTTPRequest.class.php</div>
  816                             <div class="index-item-description">Removes all cookies to send with the request.</div>
  817                     </dd>
  818             <dt class="field">
  819                         <span class="method-title">clearPostData</span>
  820                     </dt>
  821         <dd class="index-item-body">
  822             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodclearPostData">PHPCrawlerHTTPRequest::clearPostData()</a> in PHPCrawlerHTTPRequest.class.php</div>
  823                             <div class="index-item-description">Removes all post-data to send with the request.</div>
  824                     </dd>
  825             <dt class="field">
  826                         <span class="method-title">containsURLs</span>
  827                     </dt>
  828         <dd class="index-item-body">
  829             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodcontainsURLs">PHPCrawlerURLCacheBase::containsURLs()</a> in PHPCrawlerURLCacheBase.class.php</div>
  830                             <div class="index-item-description">Checks whether there are URLs left in the cache or not.</div>
  831                     </dd>
  832             <dt class="field">
  833                         <span class="method-title">containsURLs</span>
  834                     </dt>
  835         <dd class="index-item-body">
  836             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodcontainsURLs">PHPCrawlerSQLiteURLCache::containsURLs()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  837                             <div class="index-item-description">Checks whether there are URLs left in the cache that should be processed or not.</div>
  838                     </dd>
  839             <dt class="field">
  840                         <span class="method-title">containsURLs</span>
  841                     </dt>
  842         <dd class="index-item-body">
  843             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodcontainsURLs">PHPCrawlerMemoryURLCache::containsURLs()</a> in PHPCrawlerMemoryURLCache.class.php</div>
  844                             <div class="index-item-description">Checks whether there are URLs left in the cache or not.</div>
  845                     </dd>
  846             <dt class="field">
  847                         <span class="method-title">Crawl</span>
  848                     </dt>
  849         <dd class="index-item-body">
  850             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodCrawl">SitemapCreator::Crawl()</a> in SitemapCreator.class.php</div>
  851                             <div class="index-item-description">Start the crawl process</div>
  852                     </dd>
  853             <dt class="field">
  854                         <span class="method-title">createPreparedInsertStatement</span>
  855                     </dt>
  856         <dd class="index-item-body">
  857             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodcreatePreparedInsertStatement">PHPCrawlerSQLiteURLCache::createPreparedInsertStatement()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  858                             <div class="index-item-description">Creates the prepared statement for insterting URLs into database (if not done yet)</div>
  859                     </dd>
  860             <dt class="field">
  861                         <span class="method-title">createPreparedStatements</span>
  862                     </dt>
  863         <dd class="index-item-body">
  864             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#methodcreatePreparedStatements">PHPCrawlerDocumentInfoQueue::createPreparedStatements()</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
  865                     </dd>
  866             <dt class="field">
  867                         <span class="method-title">CreateSitemaps</span>
  868                     </dt>
  869         <dd class="index-item-body">
  870             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodCreateSitemaps">SitemapCreator::CreateSitemaps()</a> in SitemapCreator.class.php</div>
  871                             <div class="index-item-description">Create sitemaps files and index</div>
  872                     </dd>
  873             <dt class="field">
  874                         <span class="method-title">createWorkingDirectory</span>
  875                     </dt>
  876         <dd class="index-item-body">
  877             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodcreateWorkingDirectory">PHPCrawler::createWorkingDirectory()</a> in PHPCrawler.class.php</div>
  878                             <div class="index-item-description">Creates the working-directory for this instance of the cralwer.</div>
  879                     </dd>
  880             <dt class="field">
  881                         <span class="method-title">csvFile</span>
  882                     </dt>
  883         <dd class="index-item-body">
  884             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodcsvFile">SitemapCreator::csvFile()</a> in SitemapCreator.class.php</div>
  885                             <div class="index-item-description">get CSV file path</div>
  886                     </dd>
  887         </dl>
  888     <a name="d"></a>
  889     <div class="index-letter-section">
  890         <div style="float: left" class="index-letter-title">d</div>
  891         <div style="float: right"><a href="#top">top</a></div>
  892         <div style="clear: both"></div>
  893     </div>
  894     <dl>
  895             <dt class="field">
  896                         <span class="var-title">$data_dir</span>
  897                     </dt>
  898         <dd class="index-item-body">
  899             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$data_dir">SitemapCreator::$data_dir</a> in SitemapCreator.class.php</div>
  900                             <div class="index-item-description">Data directory Path.</div>
  901                     </dd>
  902             <dt class="field">
  903                         <span class="var-title">$data_throughput</span>
  904                     </dt>
  905         <dd class="index-item-body">
  906             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$data_throughput">PHPCrawlerProcessReport::$data_throughput</a> in PHPCrawlerProcessReport.class.php</div>
  907                             <div class="index-item-description">The average data-throughput in bytes per second.</div>
  908                     </dd>
  909             <dt class="field">
  910                         <span class="var-title">$data_transfer_rate</span>
  911                     </dt>
  912         <dd class="index-item-body">
  913             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$data_transfer_rate">PHPCrawlerDocumentInfo::$data_transfer_rate</a> in PHPCrawlerDocumentInfo.class.php</div>
  914                             <div class="index-item-description">The average data-transferrate for this document.</div>
  915                     </dd>
  916             <dt class="field">
  917                         <span class="var-title">$data_transfer_time</span>
  918                     </dt>
  919         <dd class="index-item-body">
  920             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$data_transfer_time">PHPCrawlerHTTPRequest::$data_transfer_time</a> in PHPCrawlerHTTPRequest.class.php</div>
  921                             <div class="index-item-description">The time it took te receive data-packets for the request.</div>
  922                     </dd>
  923             <dt class="field">
  924                         <span class="var-title">$data_transfer_time</span>
  925                     </dt>
  926         <dd class="index-item-body">
  927             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$data_transfer_time">PHPCrawlerDocumentInfo::$data_transfer_time</a> in PHPCrawlerDocumentInfo.class.php</div>
  928                             <div class="index-item-description">The time it took to receive the document.</div>
  929                     </dd>
  930             <dt class="field">
  931                         <span class="var-title">$db_analyzed</span>
  932                     </dt>
  933         <dd class="index-item-body">
  934             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#var$db_analyzed">PHPCrawlerSQLiteURLCache::$db_analyzed</a> in PHPCrawlerSQLiteURLCache.class.php</div>
  935                     </dd>
  936             <dt class="field">
  937                         <span class="var-title">$DNSCache</span>
  938                     </dt>
  939         <dd class="index-item-body">
  940             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$DNSCache">PHPCrawlerHTTPRequest::$DNSCache</a> in PHPCrawlerHTTPRequest.class.php</div>
  941                             <div class="index-item-description">DNS-cache</div>
  942                     </dd>
  943             <dt class="field">
  944                         <span class="var-title">$DocumentInfoQueue</span>
  945                     </dt>
  946         <dd class="index-item-body">
  947             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$DocumentInfoQueue">PHPCrawler::$DocumentInfoQueue</a> in PHPCrawler.class.php</div>
  948                             <div class="index-item-description">DocumentInfoQueue-object</div>
  949                     </dd>
  950             <dt class="field">
  951                         <span class="var-title">$documents_received</span>
  952                     </dt>
  953         <dd class="index-item-body">
  954             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerStatus.html#var$documents_received">PHPCrawlerStatus::$documents_received</a> in PHPCrawlerStatus.class.php</div>
  955                             <div class="index-item-description">Number of documents the crawler-instance received so far</div>
  956                     </dd>
  957             <dt class="field">
  958                         <span class="var-title">$document_limit</span>
  959                     </dt>
  960         <dd class="index-item-body">
  961             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$document_limit">PHPCrawler::$document_limit</a> in PHPCrawler.class.php</div>
  962                             <div class="index-item-description">Limit of documents to receive</div>
  963                     </dd>
  964             <dt class="field">
  965                         <span class="var-title">$domain</span>
  966                     </dt>
  967         <dd class="index-item-body">
  968             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$domain">PHPCrawlerUrlPartsDescriptor::$domain</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
  969                     </dd>
  970             <dt class="field">
  971                         <span class="var-title">$domain</span>
  972                     </dt>
  973         <dd class="index-item-body">
  974             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$domain">PHPCrawlerCookieDescriptor::$domain</a> in PHPCrawlerCookieDescriptor.class.php</div>
  975                             <div class="index-item-description">Cookie-domain</div>
  976                     </dd>
  977             <dt class="field">
  978                         <span class="method-title">decideRecevieContent</span>
  979                     </dt>
  980         <dd class="index-item-body">
  981             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methoddecideRecevieContent">PHPCrawlerHTTPRequest::decideRecevieContent()</a> in PHPCrawlerHTTPRequest.class.php</div>
  982                             <div class="index-item-description">Checks whether the content of this page/file should be received (based on the content-type  and the applied rules)</div>
  983                     </dd>
  984             <dt class="field">
  985                         <span class="method-title">decideStreamToFile</span>
  986                     </dt>
  987         <dd class="index-item-body">
  988             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methoddecideStreamToFile">PHPCrawlerHTTPRequest::decideStreamToFile()</a> in PHPCrawlerHTTPRequest.class.php</div>
  989                             <div class="index-item-description">Checks whether the content of this page/file should be streamed directly to file.</div>
  990                     </dd>
  991             <dt class="field">
  992                         <span class="method-title">deserializeFromFile</span>
  993                     </dt>
  994         <dd class="index-item-body">
  995             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methoddeserializeFromFile">PHPCrawlerUtils::deserializeFromFile()</a> in PHPCrawlerUtils.class.php</div>
  996                             <div class="index-item-description">Returns deserialized data that is stored in a file.</div>
  997                     </dd>
  998             <dt class="field">
  999                         <span class="method-title">disableExtendedLinkInfo</span>
 1000                     </dt>
 1001         <dd class="index-item-body">
 1002             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methoddisableExtendedLinkInfo">PHPCrawler::disableExtendedLinkInfo()</a> in PHPCrawler.class.php</div>
 1003                             <div class="index-item-description">Has no function anymore.</div>
 1004                     </dd>
 1005         </dl>
 1006     <a name="e"></a>
 1007     <div class="index-letter-section">
 1008         <div style="float: left" class="index-letter-title">e</div>
 1009         <div style="float: right"><a href="#top">top</a></div>
 1010         <div style="clear: both"></div>
 1011     </div>
 1012     <dl>
 1013             <dt class="field">
 1014                         <span class="var-title">$engines</span>
 1015                     </dt>
 1016         <dd class="index-item-body">
 1017             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$engines">SitemapCreator::$engines</a> in SitemapCreator.class.php</div>
 1018                             <div class="index-item-description">Ping URLs of the search engines sitemaps API</div>
 1019                     </dd>
 1020             <dt class="field">
 1021                         <span class="var-title">$entries</span>
 1022                     </dt>
 1023         <dd class="index-item-body">
 1024             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$entries">SitemapCreator::$entries</a> in SitemapCreator.class.php</div>
 1025                             <div class="index-item-description">Array contianing the entries of the sitemap.</div>
 1026                     </dd>
 1027             <dt class="field">
 1028                         <span class="var-title">$entries</span>
 1029                     </dt>
 1030         <dd class="index-item-body">
 1031             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html#var$entries">SMCCrawler::$entries</a> in SitemapCreatorCrawler.class.php</div>
 1032                             <div class="index-item-description">Array contianing the entries.</div>
 1033                     </dd>
 1034             <dt class="field">
 1035                         <span class="var-title">$entries_per_sitemap</span>
 1036                     </dt>
 1037         <dd class="index-item-body">
 1038             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$entries_per_sitemap">SitemapCreator::$entries_per_sitemap</a> in SitemapCreator.class.php</div>
 1039                             <div class="index-item-description">Maximum number of entries per sitemap file</div>
 1040                     </dd>
 1041             <dt class="field">
 1042                         <span class="var-title">$error_code</span>
 1043                     </dt>
 1044         <dd class="index-item-body">
 1045             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$error_code">PHPCrawlerDocumentInfo::$error_code</a> in PHPCrawlerDocumentInfo.class.php</div>
 1046                             <div class="index-item-description">The code of the error that perhaps occured while requesting/receiving the document.</div>
 1047                     </dd>
 1048             <dt class="field">
 1049                         <span class="var-title">$error_occured</span>
 1050                     </dt>
 1051         <dd class="index-item-body">
 1052             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$error_occured">PHPCrawlerDocumentInfo::$error_occured</a> in PHPCrawlerDocumentInfo.class.php</div>
 1053                             <div class="index-item-description">Indicates whether an error occured while requesting/receiving the document.</div>
 1054                     </dd>
 1055             <dt class="field">
 1056                         <span class="var-title">$error_string</span>
 1057                     </dt>
 1058         <dd class="index-item-body">
 1059             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$error_string">PHPCrawlerDocumentInfo::$error_string</a> in PHPCrawlerDocumentInfo.class.php</div>
 1060                             <div class="index-item-description">A representig, human readable string for the error that perhaps occured while requesting/receiving the document.</div>
 1061                     </dd>
 1062             <dt class="field">
 1063                         <span class="var-title">$expires</span>
 1064                     </dt>
 1065         <dd class="index-item-body">
 1066             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$expires">PHPCrawlerCookieDescriptor::$expires</a> in PHPCrawlerCookieDescriptor.class.php</div>
 1067                             <div class="index-item-description">Expire-string, e.g. &quot;Sat, 08-Aug-2020 23:59:08 GMT&quot;</div>
 1068                     </dd>
 1069             <dt class="field">
 1070                         <span class="var-title">$expire_timestamp</span>
 1071                     </dt>
 1072         <dd class="index-item-body">
 1073             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$expire_timestamp">PHPCrawlerCookieDescriptor::$expire_timestamp</a> in PHPCrawlerCookieDescriptor.class.php</div>
 1074                             <div class="index-item-description">Expire-date as unix-timestamp</div>
 1075                     </dd>
 1076             <dt class="field">
 1077                         <span class="var-title">$extract_tags</span>
 1078                     </dt>
 1079         <dd class="index-item-body">
 1080             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$extract_tags">PHPCrawlerLinkFinder::$extract_tags</a> in PHPCrawlerLinkFinder.class.php</div>
 1081                             <div class="index-item-description">Numeric array containing all tags to extract links from</div>
 1082                     </dd>
 1083             <dt class="field">
 1084                         <span class="method-title">enableAggressiveLinkSearch</span>
 1085                     </dt>
 1086         <dd class="index-item-body">
 1087             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodenableAggressiveLinkSearch">PHPCrawlerHTTPRequest::enableAggressiveLinkSearch()</a> in PHPCrawlerHTTPRequest.class.php</div>
 1088                             <div class="index-item-description">Enables/disables aggresive linksearch</div>
 1089                     </dd>
 1090             <dt class="field">
 1091                         <span class="method-title">enableAggressiveLinkSearch</span>
 1092                     </dt>
 1093         <dd class="index-item-body">
 1094             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodenableAggressiveLinkSearch">PHPCrawler::enableAggressiveLinkSearch()</a> in PHPCrawler.class.php</div>
 1095                             <div class="index-item-description">Enables or disables agressive link-searching.</div>
 1096                     </dd>
 1097             <dt class="field">
 1098                         <span class="method-title">enableCookieHandling</span>
 1099                     </dt>
 1100         <dd class="index-item-body">
 1101             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodenableCookieHandling">PHPCrawler::enableCookieHandling()</a> in PHPCrawler.class.php</div>
 1102                             <div class="index-item-description">Enables or disables cookie-handling.</div>
 1103                     </dd>
 1104             <dt class="field">
 1105                         <span class="method-title">enableLastModifiedCount</span>
 1106                     </dt>
 1107         <dd class="index-item-body">
 1108             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html#methodenableLastModifiedCount">SMCCrawler::enableLastModifiedCount()</a> in SitemapCreatorCrawler.class.php</div>
 1109                             <div class="index-item-description">Enable or diable last-Modified calculation <a href="phpcrawl/SMCCrawler.html#var$LastModifiedCount">$LastModifiedCount</a></div>
 1110                     </dd>
 1111             <dt class="field">
 1112                         <span class="method-title">enableResumption</span>
 1113                     </dt>
 1114         <dd class="index-item-body">
 1115             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodenableResumption">PHPCrawler::enableResumption()</a> in PHPCrawler.class.php</div>
 1116                             <div class="index-item-description">Prepares the crawler for process-resumption.</div>
 1117                     </dd>
 1118             <dt class="field">
 1119                         ERROR_HOST_UNREACHABLE
 1120                     </dt>
 1121         <dd class="index-item-body">
 1122             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html#constERROR_HOST_UNREACHABLE">PHPCrawlerRequestErrors::ERROR_HOST_UNREACHABLE</a> in PHPCrawlerRequestErrors.class.php</div>
 1123                             <div class="index-item-description">Error-Code: Host not reachable</div>
 1124                     </dd>
 1125             <dt class="field">
 1126                         ERROR_NO_HTTP_HEADER
 1127                     </dt>
 1128         <dd class="index-item-body">
 1129             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html#constERROR_NO_HTTP_HEADER">PHPCrawlerRequestErrors::ERROR_NO_HTTP_HEADER</a> in PHPCrawlerRequestErrors.class.php</div>
 1130                             <div class="index-item-description">Error-Code: Host didn't respond with a valid HTTP-header.</div>
 1131                     </dd>
 1132             <dt class="field">
 1133                         ERROR_PROXY_UNREACHABLE
 1134                     </dt>
 1135         <dd class="index-item-body">
 1136             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html#constERROR_PROXY_UNREACHABLE">PHPCrawlerRequestErrors::ERROR_PROXY_UNREACHABLE</a> in PHPCrawlerRequestErrors.class.php</div>
 1137                             <div class="index-item-description">Error-Code: Proxy not reachable</div>
 1138                     </dd>
 1139             <dt class="field">
 1140                         ERROR_SOCKET_TIMEOUT
 1141                     </dt>
 1142         <dd class="index-item-body">
 1143             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html#constERROR_SOCKET_TIMEOUT">PHPCrawlerRequestErrors::ERROR_SOCKET_TIMEOUT</a> in PHPCrawlerRequestErrors.class.php</div>
 1144                             <div class="index-item-description">Error-Code: Socket timed out while reading data.</div>
 1145                     </dd>
 1146             <dt class="field">
 1147                         ERROR_SSL_NOT_SUPPORTED
 1148                     </dt>
 1149         <dd class="index-item-body">
 1150             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html#constERROR_SSL_NOT_SUPPORTED">PHPCrawlerRequestErrors::ERROR_SSL_NOT_SUPPORTED</a> in PHPCrawlerRequestErrors.class.php</div>
 1151                             <div class="index-item-description">Error-Code: SSL/HTTPS not supported (probably openssl-extension not installed)</div>
 1152                     </dd>
 1153             <dt class="field">
 1154                         ERROR_TMP_FILE_NOT_WRITEABLE
 1155                     </dt>
 1156         <dd class="index-item-body">
 1157             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html#constERROR_TMP_FILE_NOT_WRITEABLE">PHPCrawlerRequestErrors::ERROR_TMP_FILE_NOT_WRITEABLE</a> in PHPCrawlerRequestErrors.class.php</div>
 1158                             <div class="index-item-description">Error-Code: Could not write or create TMP-file.</div>
 1159                     </dd>
 1160             <dt class="field">
 1161                         <span class="include-title">example.php</span>
 1162                     </dt>
 1163         <dd class="index-item-body">
 1164             <div class="index-item-details"><a href="SitemapCreator/_example---example.php.html">example.php</a> in example.php</div>
 1165                     </dd>
 1166         </dl>
 1167     <a name="f"></a>
 1168     <div class="index-letter-section">
 1169         <div style="float: left" class="index-letter-title">f</div>
 1170         <div style="float: right"><a href="#top">top</a></div>
 1171         <div style="clear: both"></div>
 1172     </div>
 1173     <dl>
 1174             <dt class="field">
 1175                         <span class="var-title">$file</span>
 1176                     </dt>
 1177         <dd class="index-item-body">
 1178             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$file">PHPCrawlerUrlPartsDescriptor::$file</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 1179                     </dd>
 1180             <dt class="field">
 1181                         <span class="var-title">$file</span>
 1182                     </dt>
 1183         <dd class="index-item-body">
 1184             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$file">PHPCrawlerDocumentInfo::$file</a> in PHPCrawlerDocumentInfo.class.php</div>
 1185                             <div class="index-item-description">The name of the requested page or file, e.g. &quot;page.html&quot;.</div>
 1186                     </dd>
 1187             <dt class="field">
 1188                         <span class="var-title">$files_received</span>
 1189                     </dt>
 1190         <dd class="index-item-body">
 1191             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$files_received">PHPCrawlerProcessReport::$files_received</a> in PHPCrawlerProcessReport.class.php</div>
 1192                             <div class="index-item-description">The total number of documents the crawler received.</div>
 1193                     </dd>
 1194             <dt class="field">
 1195                         <span class="var-title">$file_limit_reached</span>
 1196                     </dt>
 1197         <dd class="index-item-body">
 1198             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$file_limit_reached">PHPCrawlerProcessReport::$file_limit_reached</a> in PHPCrawlerProcessReport.class.php</div>
 1199                             <div class="index-item-description">Will be TRUE if the page/file-limit was reached.</div>
 1200                     </dd>
 1201             <dt class="field">
 1202                         <span class="var-title">$find_redirect_urls</span>
 1203                     </dt>
 1204         <dd class="index-item-body">
 1205             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$find_redirect_urls">PHPCrawlerLinkFinder::$find_redirect_urls</a> in PHPCrawlerLinkFinder.class.php</div>
 1206                             <div class="index-item-description">Specifies whether redirect-links set in http-headers should get found.</div>
 1207                     </dd>
 1208             <dt class="field">
 1209                         <span class="var-title">$first_content_url</span>
 1210                     </dt>
 1211         <dd class="index-item-body">
 1212             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerStatus.html#var$first_content_url">PHPCrawlerStatus::$first_content_url</a> in PHPCrawlerStatus.class.php</div>
 1213                     </dd>
 1214             <dt class="field">
 1215                         <span class="var-title">$follow_redirects_till_content</span>
 1216                     </dt>
 1217         <dd class="index-item-body">
 1218             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$follow_redirects_till_content">PHPCrawler::$follow_redirects_till_content</a> in PHPCrawler.class.php</div>
 1219                     </dd>
 1220             <dt class="field">
 1221                         <span class="var-title">$found_links_map</span>
 1222                     </dt>
 1223         <dd class="index-item-body">
 1224             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$found_links_map">PHPCrawlerLinkFinder::$found_links_map</a> in PHPCrawlerLinkFinder.class.php</div>
 1225                     </dd>
 1226             <dt class="field">
 1227                         <span class="var-title">$frequency_mode</span>
 1228                     </dt>
 1229         <dd class="index-item-body">
 1230             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$frequency_mode">SitemapCreator::$frequency_mode</a> in SitemapCreator.class.php</div>
 1231                             <div class="index-item-description">Frequency mode</div>
 1232                     </dd>
 1233             <dt class="field">
 1234                         <span class="var-title">$frequency_types</span>
 1235                     </dt>
 1236         <dd class="index-item-body">
 1237             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$frequency_types">SitemapCreator::$frequency_types</a> in SitemapCreator.class.php</div>
 1238                             <div class="index-item-description">Array contains Frequency types as keys and max time in seconds as values.</div>
 1239                     </dd>
 1240             <dt class="field">
 1241                         <span class="method-title">filterUrls</span>
 1242                     </dt>
 1243         <dd class="index-item-body">
 1244             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodfilterUrls">PHPCrawlerURLFilter::filterUrls()</a> in PHPCrawlerURLFilter.class.php</div>
 1245                             <div class="index-item-description">Filters the given URLs (contained in the given PHPCrawlerDocumentInfo-object) by the given rules.</div>
 1246                     </dd>
 1247             <dt class="field">
 1248                         <span class="method-title">findLinksInHTMLChunk</span>
 1249                     </dt>
 1250         <dd class="index-item-body">
 1251             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodfindLinksInHTMLChunk">PHPCrawlerLinkFinder::findLinksInHTMLChunk()</a> in PHPCrawlerLinkFinder.class.php</div>
 1252                             <div class="index-item-description">Searches for links in the given HTML-chunk and adds found links the the internal link-cache.</div>
 1253                     </dd>
 1254             <dt class="field">
 1255                         <span class="method-title">findRedirectLinkInHeader</span>
 1256                     </dt>
 1257         <dd class="index-item-body">
 1258             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodfindRedirectLinkInHeader">PHPCrawlerLinkFinder::findRedirectLinkInHeader()</a> in PHPCrawlerLinkFinder.class.php</div>
 1259                             <div class="index-item-description">Checks for a redirect-URL in the given http-header and adds it to the internal link-cache.</div>
 1260                     </dd>
 1261             <dt class="field">
 1262                         FREQUENCY_Disable
 1263                     </dt>
 1264         <dd class="index-item-body">
 1265             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constFREQUENCY_Disable">SitemapCreator::FREQUENCY_Disable</a> in SitemapCreator.class.php</div>
 1266                             <div class="index-item-description">Disables frequency calculations</div>
 1267                     </dd>
 1268             <dt class="field">
 1269                         FREQUENCY_LAST_MODIFIED
 1270                     </dt>
 1271         <dd class="index-item-body">
 1272             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constFREQUENCY_LAST_MODIFIED">SitemapCreator::FREQUENCY_LAST_MODIFIED</a> in SitemapCreator.class.php</div>
 1273                             <div class="index-item-description">Latest modified pages get higher frequency</div>
 1274                     </dd>
 1275             <dt class="field">
 1276                         FREQUENCY_PRIORITY
 1277                     </dt>
 1278         <dd class="index-item-body">
 1279             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constFREQUENCY_PRIORITY">SitemapCreator::FREQUENCY_PRIORITY</a> in SitemapCreator.class.php</div>
 1280                             <div class="index-item-description">Higher priority pages get higher frequency</div>
 1281                     </dd>
 1282             <dt class="field">
 1283                         <span class="method-title">fromURL</span>
 1284                     </dt>
 1285         <dd class="index-item-body">
 1286             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#methodfromURL">PHPCrawlerUrlPartsDescriptor::fromURL()</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 1287                             <div class="index-item-description">Returns the PHPCrawlerUrlPartsDescriptor-object for the given URL.</div>
 1288                     </dd>
 1289         </dl>
 1290     <a name="g"></a>
 1291     <div class="index-letter-section">
 1292         <div style="float: left" class="index-letter-title">g</div>
 1293         <div style="float: right"><a href="#top">top</a></div>
 1294         <div style="clear: both"></div>
 1295     </div>
 1296     <dl>
 1297             <dt class="field">
 1298                         <span class="var-title">$general_follow_mode</span>
 1299                     </dt>
 1300         <dd class="index-item-body">
 1301             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$general_follow_mode">PHPCrawlerURLFilter::$general_follow_mode</a> in PHPCrawlerURLFilter.class.php</div>
 1302                             <div class="index-item-description">The general follow-mode of the crawler</div>
 1303                     </dd>
 1304             <dt class="field">
 1305                         <span class="var-title">$global_traffic_count</span>
 1306                     </dt>
 1307         <dd class="index-item-body">
 1308             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$global_traffic_count">PHPCrawlerHTTPRequest::$global_traffic_count</a> in PHPCrawlerHTTPRequest.class.php</div>
 1309                             <div class="index-item-description">Global counter for traffic this instance of the HTTPRequest-class caused.</div>
 1310                     </dd>
 1311             <dt class="field">
 1312                         <span class="method-title">getAllBenchmarks</span>
 1313                     </dt>
 1314         <dd class="index-item-body">
 1315             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodgetAllBenchmarks">PHPCrawlerBenchmark::getAllBenchmarks()</a> in PHPCrawlerBenchmark.class.php</div>
 1316                             <div class="index-item-description">Returns all registered benchmark-results.</div>
 1317                     </dd>
 1318             <dt class="field">
 1319                         <span class="method-title">getAllMetaAttributes</span>
 1320                     </dt>
 1321         <dd class="index-item-body">
 1322             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodgetAllMetaAttributes">PHPCrawlerLinkFinder::getAllMetaAttributes()</a> in PHPCrawlerLinkFinder.class.php</div>
 1323                             <div class="index-item-description">Returns all meta-tag attributes found so far in the document.</div>
 1324                     </dd>
 1325             <dt class="field">
 1326                         <span class="method-title">getAllURLs</span>
 1327                     </dt>
 1328         <dd class="index-item-body">
 1329             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodgetAllURLs">PHPCrawlerLinkFinder::getAllURLs()</a> in PHPCrawlerLinkFinder.class.php</div>
 1330                             <div class="index-item-description">Returns all URLs/links found so far in the document.</div>
 1331                     </dd>
 1332             <dt class="field">
 1333                         <span class="method-title">getAllURLs</span>
 1334                     </dt>
 1335         <dd class="index-item-body">
 1336             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodgetAllURLs">PHPCrawlerMemoryURLCache::getAllURLs()</a> in PHPCrawlerMemoryURLCache.class.php</div>
 1337                             <div class="index-item-description">Returns all URLs currently cached in the URL-cache.</div>
 1338                     </dd>
 1339             <dt class="field">
 1340                         <span class="method-title">getAllURLs</span>
 1341                     </dt>
 1342         <dd class="index-item-body">
 1343             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodgetAllURLs">PHPCrawlerSQLiteURLCache::getAllURLs()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 1344                             <div class="index-item-description">Has no function in this class</div>
 1345                     </dd>
 1346             <dt class="field">
 1347                         <span class="method-title">getAllURLs</span>
 1348                     </dt>
 1349         <dd class="index-item-body">
 1350             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodgetAllURLs">PHPCrawlerURLCacheBase::getAllURLs()</a> in PHPCrawlerURLCacheBase.class.php</div>
 1351                             <div class="index-item-description">Returns all URLs currently cached in the URL-cache.</div>
 1352                     </dd>
 1353             <dt class="field">
 1354                         <span class="method-title">getApplyingLines</span>
 1355                     </dt>
 1356         <dd class="index-item-body">
 1357             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html#methodgetApplyingLines">PHPCrawlerRobotsTxtParser::getApplyingLines()</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 1358                             <div class="index-item-description">Function returns all RAW lines in the given robots.txt-content that apply to  the given useragent-string.</div>
 1359                     </dd>
 1360             <dt class="field">
 1361                         <span class="method-title">getBaseUrlFromMetaTag</span>
 1362                     </dt>
 1363         <dd class="index-item-body">
 1364             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetBaseUrlFromMetaTag">PHPCrawlerUtils::getBaseUrlFromMetaTag()</a> in PHPCrawlerUtils.class.php</div>
 1365                             <div class="index-item-description">Returns the base-URL specified in a meta-tag in the given HTML-source</div>
 1366                     </dd>
 1367             <dt class="field">
 1368                         <span class="method-title">getBasicAuthenticationForUrl</span>
 1369                     </dt>
 1370         <dd class="index-item-body">
 1371             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html#methodgetBasicAuthenticationForUrl">PHPCrawlerUserSendDataCache::getBasicAuthenticationForUrl()</a> in PHPCrawlerUserSendDataCache.class.php</div>
 1372                             <div class="index-item-description">Returns the basic-authentication (username and password) that should be send to the given URL.</div>
 1373                     </dd>
 1374             <dt class="field">
 1375                         <span class="method-title">getCallCount</span>
 1376                     </dt>
 1377         <dd class="index-item-body">
 1378             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodgetCallCount">PHPCrawlerBenchmark::getCallCount()</a> in PHPCrawlerBenchmark.class.php</div>
 1379                     </dd>
 1380             <dt class="field">
 1381                         <span class="method-title">getChildPIDs</span>
 1382                     </dt>
 1383         <dd class="index-item-body">
 1384             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodgetChildPIDs">PHPCrawlerProcessCommunication::getChildPIDs()</a> in PHPCrawlerProcessCommunication.class.php</div>
 1385                             <div class="index-item-description">Returns alls PIDs of all running child-processes</div>
 1386                     </dd>
 1387             <dt class="field">
 1388                         <span class="method-title">getCookiesForUrl</span>
 1389                     </dt>
 1390         <dd class="index-item-body">
 1391             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryCookieCache.html#methodgetCookiesForUrl">PHPCrawlerMemoryCookieCache::getCookiesForUrl()</a> in PHPCrawlerMemoryCookieCache.class.php</div>
 1392                             <div class="index-item-description">Returns all cookies from the cache that are adressed to the given URL</div>
 1393                     </dd>
 1394             <dt class="field">
 1395                         <span class="method-title">getCookiesForUrl</span>
 1396                     </dt>
 1397         <dd class="index-item-body">
 1398             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodgetCookiesForUrl">PHPCrawlerSQLiteCookieCache::getCookiesForUrl()</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
 1399                             <div class="index-item-description">Returns all cookies from the cache that are adressed to the given URL</div>
 1400                     </dd>
 1401             <dt class="field">
 1402                         <span class="method-title">getCookiesForUrl</span>
 1403                     </dt>
 1404         <dd class="index-item-body">
 1405             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieCacheBase.html#methodgetCookiesForUrl">PHPCrawlerCookieCacheBase::getCookiesForUrl()</a> in PHPCrawlerCookieCacheBase.class.php</div>
 1406                             <div class="index-item-description">Returns all cookies from the cache that are adressed to the given URL</div>
 1407                     </dd>
 1408             <dt class="field">
 1409                         <span class="method-title">getCookiesFromHeader</span>
 1410                     </dt>
 1411         <dd class="index-item-body">
 1412             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetCookiesFromHeader">PHPCrawlerUtils::getCookiesFromHeader()</a> in PHPCrawlerUtils.class.php</div>
 1413                             <div class="index-item-description">Returns all cookies from the give response-header.</div>
 1414                     </dd>
 1415             <dt class="field">
 1416                         <span class="method-title">getCrawlerId</span>
 1417                     </dt>
 1418         <dd class="index-item-body">
 1419             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodgetCrawlerId">PHPCrawler::getCrawlerId()</a> in PHPCrawler.class.php</div>
 1420                             <div class="index-item-description">Returns the unique ID of the instance of the crawler</div>
 1421                     </dd>
 1422             <dt class="field">
 1423                         <span class="method-title">getCrawlerStatus</span>
 1424                     </dt>
 1425         <dd class="index-item-body">
 1426             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodgetCrawlerStatus">PHPCrawlerProcessCommunication::getCrawlerStatus()</a> in PHPCrawlerProcessCommunication.class.php</div>
 1427                             <div class="index-item-description">Returns/reads the current crawler-status</div>
 1428                     </dd>
 1429             <dt class="field">
 1430                         <span class="method-title">getDataDir</span>
 1431                     </dt>
 1432         <dd class="index-item-body">
 1433             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetDataDir">SitemapCreator::getDataDir()</a> in SitemapCreator.class.php</div>
 1434                             <div class="index-item-description">Get data directory path $data_dir</div>
 1435                     </dd>
 1436             <dt class="field">
 1437                         <span class="method-title">getDistinctURLHash</span>
 1438                     </dt>
 1439         <dd class="index-item-body">
 1440             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodgetDistinctURLHash">PHPCrawlerURLCacheBase::getDistinctURLHash()</a> in PHPCrawlerURLCacheBase.class.php</div>
 1441                             <div class="index-item-description">Returns the distinct-hash for the given URL that ensures that no URLs a cached more than one time.</div>
 1442                     </dd>
 1443             <dt class="field">
 1444                         <span class="method-title">getDocumentInfoCount</span>
 1445                     </dt>
 1446         <dd class="index-item-body">
 1447             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#methodgetDocumentInfoCount">PHPCrawlerDocumentInfoQueue::getDocumentInfoCount()</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 1448                             <div class="index-item-description">Returns the current number of PHPCrawlerDocumentInfo-objects in the queue</div>
 1449                     </dd>
 1450             <dt class="field">
 1451                         <span class="method-title">getElapsedTime</span>
 1452                     </dt>
 1453         <dd class="index-item-body">
 1454             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodgetElapsedTime">PHPCrawlerBenchmark::getElapsedTime()</a> in PHPCrawlerBenchmark.class.php</div>
 1455                             <div class="index-item-description">Gets the elapsed time for the given benchmark.</div>
 1456                     </dd>
 1457             <dt class="field">
 1458                         <span class="method-title">getEntries</span>
 1459                     </dt>
 1460         <dd class="index-item-body">
 1461             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetEntries">SitemapCreator::getEntries()</a> in SitemapCreator.class.php</div>
 1462                             <div class="index-item-description">Get URLs sets array <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
 1463                     </dd>
 1464             <dt class="field">
 1465                         <span class="method-title">getFromHeaderLine</span>
 1466                     </dt>
 1467         <dd class="index-item-body">
 1468             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#methodgetFromHeaderLine">PHPCrawlerCookieDescriptor::getFromHeaderLine()</a> in PHPCrawlerCookieDescriptor.class.php</div>
 1469                             <div class="index-item-description">Returns a PHPCrawlerCookieDescriptor-object initiated by the given cookie-header-line.</div>
 1470                     </dd>
 1471             <dt class="field">
 1472                         <span class="method-title">getGlobalTrafficCount</span>
 1473                     </dt>
 1474         <dd class="index-item-body">
 1475             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodgetGlobalTrafficCount">PHPCrawlerHTTPRequest::getGlobalTrafficCount()</a> in PHPCrawlerHTTPRequest.class.php</div>
 1476                             <div class="index-item-description">Returns the global traffic this instance of the HTTPRequest-class caused so far.</div>
 1477                     </dd>
 1478             <dt class="field">
 1479                         <span class="method-title">getHeaderValue</span>
 1480                     </dt>
 1481         <dd class="index-item-body">
 1482             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetHeaderValue">PHPCrawlerUtils::getHeaderValue()</a> in PHPCrawlerUtils.class.php</div>
 1483                             <div class="index-item-description">Gets the value of an header-directive from the given HTTP-header.</div>
 1484                     </dd>
 1485             <dt class="field">
 1486                         <span class="method-title">getHTTPStatusCode</span>
 1487                     </dt>
 1488         <dd class="index-item-body">
 1489             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetHTTPStatusCode">PHPCrawlerUtils::getHTTPStatusCode()</a> in PHPCrawlerUtils.class.php</div>
 1490                             <div class="index-item-description">Gets the HTTP-statuscode from a given response-header.</div>
 1491                     </dd>
 1492             <dt class="field">
 1493                         <span class="method-title">getIP</span>
 1494                     </dt>
 1495         <dd class="index-item-body">
 1496             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDNSCache.html#methodgetIP">PHPCrawlerDNSCache::getIP()</a> in PHPCrawlerDNSCache.class.php</div>
 1497                             <div class="index-item-description">Returns the IP for the given hostname.</div>
 1498                     </dd>
 1499             <dt class="field">
 1500                         <span class="method-title">getLastModified</span>
 1501                     </dt>
 1502         <dd class="index-item-body">
 1503             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html#methodgetLastModified">SMCCrawler::getLastModified()</a> in SitemapCreatorCrawler.class.php</div>
 1504                             <div class="index-item-description">get Last-Modified header</div>
 1505                     </dd>
 1506             <dt class="field">
 1507                         <span class="method-title">getMaxPriorityLevel</span>
 1508                     </dt>
 1509         <dd class="index-item-body">
 1510             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodgetMaxPriorityLevel">PHPCrawlerMemoryURLCache::getMaxPriorityLevel()</a> in PHPCrawlerMemoryURLCache.class.php</div>
 1511                             <div class="index-item-description">Returns the highest priority-level an URL exists in cache for.</div>
 1512                     </dd>
 1513             <dt class="field">
 1514                         <span class="method-title">getMetaTagAttributes</span>
 1515                     </dt>
 1516         <dd class="index-item-body">
 1517             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetMetaTagAttributes">PHPCrawlerUtils::getMetaTagAttributes()</a> in PHPCrawlerUtils.class.php</div>
 1518                             <div class="index-item-description">Gets all meta-tag atteributes from the given HTML-source.</div>
 1519                     </dd>
 1520             <dt class="field">
 1521                         <span class="method-title">getmicrotime</span>
 1522                     </dt>
 1523         <dd class="index-item-body">
 1524             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodgetmicrotime">PHPCrawlerBenchmark::getmicrotime()</a> in PHPCrawlerBenchmark.class.php</div>
 1525                             <div class="index-item-description">Returns the current time in seconds and milliseconds.</div>
 1526                     </dd>
 1527             <dt class="field">
 1528                         <span class="method-title">getNextDocumentInfo</span>
 1529                     </dt>
 1530         <dd class="index-item-body">
 1531             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#methodgetNextDocumentInfo">PHPCrawlerDocumentInfoQueue::getNextDocumentInfo()</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 1532                             <div class="index-item-description">Returns a PHPCrawlerDocumentInfo-object from the queue</div>
 1533                     </dd>
 1534             <dt class="field">
 1535                         <span class="method-title">getNextUrl</span>
 1536                     </dt>
 1537         <dd class="index-item-body">
 1538             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodgetNextUrl">PHPCrawlerMemoryURLCache::getNextUrl()</a> in PHPCrawlerMemoryURLCache.class.php</div>
 1539                             <div class="index-item-description">Returns the next URL from the cache that should be crawled.</div>
 1540                     </dd>
 1541             <dt class="field">
 1542                         <span class="method-title">getNextUrl</span>
 1543                     </dt>
 1544         <dd class="index-item-body">
 1545             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodgetNextUrl">PHPCrawlerSQLiteURLCache::getNextUrl()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 1546                             <div class="index-item-description">Returns the next URL from the cache that should be crawled.</div>
 1547                     </dd>
 1548             <dt class="field">
 1549                         <span class="method-title">getNextUrl</span>
 1550                     </dt>
 1551         <dd class="index-item-body">
 1552             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodgetNextUrl">PHPCrawlerURLCacheBase::getNextUrl()</a> in PHPCrawlerURLCacheBase.class.php</div>
 1553                             <div class="index-item-description">Returns the next URL from the cache that should be crawled.</div>
 1554                     </dd>
 1555             <dt class="field">
 1556                         <span class="method-title">getPostDataForUrl</span>
 1557                     </dt>
 1558         <dd class="index-item-body">
 1559             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html#methodgetPostDataForUrl">PHPCrawlerUserSendDataCache::getPostDataForUrl()</a> in PHPCrawlerUserSendDataCache.class.php</div>
 1560                             <div class="index-item-description">Returns the post-data (key and value) that should be send to the given URL.</div>
 1561                     </dd>
 1562             <dt class="field">
 1563                         <span class="method-title">getProcessReport</span>
 1564                     </dt>
 1565         <dd class="index-item-body">
 1566             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodgetProcessReport">PHPCrawler::getProcessReport()</a> in PHPCrawler.class.php</div>
 1567                             <div class="index-item-description">Retruns summarizing report-information about the crawling-process after it has finished.</div>
 1568                     </dd>
 1569             <dt class="field">
 1570                         <span class="method-title">getRedirectURLFromHeader</span>
 1571                     </dt>
 1572         <dd class="index-item-body">
 1573             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetRedirectURLFromHeader">PHPCrawlerUtils::getRedirectURLFromHeader()</a> in PHPCrawlerUtils.class.php</div>
 1574                             <div class="index-item-description">Returns the redirect-URL from the given HTML-header</div>
 1575                     </dd>
 1576             <dt class="field">
 1577                         <span class="method-title">getReport</span>
 1578                     </dt>
 1579         <dd class="index-item-body">
 1580             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodgetReport">PHPCrawler::getReport()</a> in PHPCrawler.class.php</div>
 1581                             <div class="index-item-description">Retruns an array with summarizing report-information after the crawling-process has finished</div>
 1582                     </dd>
 1583             <dt class="field">
 1584                         <span class="method-title">getRobotsTxtContent</span>
 1585                     </dt>
 1586         <dd class="index-item-body">
 1587             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html#methodgetRobotsTxtContent">PHPCrawlerRobotsTxtParser::getRobotsTxtContent()</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 1588                             <div class="index-item-description">Retreives the content of a robots.txt-file</div>
 1589                     </dd>
 1590             <dt class="field">
 1591                         <span class="method-title">getRobotsTxtURL</span>
 1592                     </dt>
 1593         <dd class="index-item-body">
 1594             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html#methodgetRobotsTxtURL">PHPCrawlerRobotsTxtParser::getRobotsTxtURL()</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 1595                             <div class="index-item-description">Returns the Robots.txt-URL related to the given URL</div>
 1596                     </dd>
 1597             <dt class="field">
 1598                         <span class="method-title">getRootUrl</span>
 1599                     </dt>
 1600         <dd class="index-item-body">
 1601             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetRootUrl">PHPCrawlerUtils::getRootUrl()</a> in PHPCrawlerUtils.class.php</div>
 1602                             <div class="index-item-description">Returns the normalized root-URL of the given URL</div>
 1603                     </dd>
 1604             <dt class="field">
 1605                         <span class="method-title">getSitemapDirName</span>
 1606                     </dt>
 1607         <dd class="index-item-body">
 1608             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapDirName">SitemapCreator::getSitemapDirName()</a> in SitemapCreator.class.php</div>
 1609                             <div class="index-item-description">Get sitemap directory name</div>
 1610                     </dd>
 1611             <dt class="field">
 1612                         <span class="method-title">getSitemapPath</span>
 1613                     </dt>
 1614         <dd class="index-item-body">
 1615             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapPath">SitemapCreator::getSitemapPath()</a> in SitemapCreator.class.php</div>
 1616                             <div class="index-item-description">Get sitemap file path</div>
 1617                     </dd>
 1618             <dt class="field">
 1619                         <span class="method-title">getSitemapsDir</span>
 1620                     </dt>
 1621         <dd class="index-item-body">
 1622             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapsDir">SitemapCreator::getSitemapsDir()</a> in SitemapCreator.class.php</div>
 1623                             <div class="index-item-description">Get sitemap directory path $sitemaps_dir</div>
 1624                     </dd>
 1625             <dt class="field">
 1626                         <span class="method-title">getSitemapURL</span>
 1627                     </dt>
 1628         <dd class="index-item-body">
 1629             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapURL">SitemapCreator::getSitemapURL()</a> in SitemapCreator.class.php</div>
 1630                             <div class="index-item-description">Get sitemap file URL</div>
 1631                     </dd>
 1632             <dt class="field">
 1633                         <span class="method-title">getSystemTempDir</span>
 1634                     </dt>
 1635         <dd class="index-item-body">
 1636             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodgetSystemTempDir">PHPCrawlerUtils::getSystemTempDir()</a> in PHPCrawlerUtils.class.php</div>
 1637                             <div class="index-item-description">Determinates the systems temporary-directory.</div>
 1638                     </dd>
 1639             <dt class="field">
 1640                         <span class="method-title">getUrlCount</span>
 1641                     </dt>
 1642         <dd class="index-item-body">
 1643             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodgetUrlCount">PHPCrawlerSQLiteURLCache::getUrlCount()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 1644                     </dd>
 1645             <dt class="field">
 1646                         <span class="method-title">getUrlPriority</span>
 1647                     </dt>
 1648         <dd class="index-item-body">
 1649             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodgetUrlPriority">PHPCrawlerURLCacheBase::getUrlPriority()</a> in PHPCrawlerURLCacheBase.class.php</div>
 1650                             <div class="index-item-description">Gets the priority-level of the given URL</div>
 1651                     </dd>
 1652             <dt class="field">
 1653                         <span class="method-title">go</span>
 1654                     </dt>
 1655         <dd class="index-item-body">
 1656             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodgo">PHPCrawler::go()</a> in PHPCrawler.class.php</div>
 1657                             <div class="index-item-description">Starts the crawling process in single-process-mode.</div>
 1658                     </dd>
 1659             <dt class="field">
 1660                         <span class="method-title">goMultiProcessed</span>
 1661                     </dt>
 1662         <dd class="index-item-body">
 1663             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodgoMultiProcessed">PHPCrawler::goMultiProcessed()</a> in PHPCrawler.class.php</div>
 1664                             <div class="index-item-description">Starts the cralwer by using multi processes.</div>
 1665                     </dd>
 1666         </dl>
 1667     <a name="h"></a>
 1668     <div class="index-letter-section">
 1669         <div style="float: left" class="index-letter-title">h</div>
 1670         <div style="float: right"><a href="#top">top</a></div>
 1671         <div style="clear: both"></div>
 1672     </div>
 1673     <dl>
 1674             <dt class="field">
 1675                         <span class="var-title">$header</span>
 1676                     </dt>
 1677         <dd class="index-item-body">
 1678             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$header">PHPCrawlerDocumentInfo::$header</a> in PHPCrawlerDocumentInfo.class.php</div>
 1679                             <div class="index-item-description">The complete HTTP-header the webserver responded with this page or file.</div>
 1680                     </dd>
 1681             <dt class="field">
 1682                         <span class="var-title">$header_check_callback_function</span>
 1683                     </dt>
 1684         <dd class="index-item-body">
 1685             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$header_check_callback_function">PHPCrawlerHTTPRequest::$header_check_callback_function</a> in PHPCrawlerHTTPRequest.class.php</div>
 1686                     </dd>
 1687             <dt class="field">
 1688                         <span class="var-title">$header_raw</span>
 1689                     </dt>
 1690         <dd class="index-item-body">
 1691             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html#var$header_raw">PHPCrawlerResponseHeader::$header_raw</a> in PHPCrawlerResponseHeader.class.php</div>
 1692                             <div class="index-item-description">The raw HTTP-header as it was send by the server</div>
 1693                     </dd>
 1694             <dt class="field">
 1695                         <span class="var-title">$header_send</span>
 1696                     </dt>
 1697         <dd class="index-item-body">
 1698             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$header_send">PHPCrawlerDocumentInfo::$header_send</a> in PHPCrawlerDocumentInfo.class.php</div>
 1699                             <div class="index-item-description">The complete HTTP-request-header the crawler sent to the server (debugging info).</div>
 1700                     </dd>
 1701             <dt class="field">
 1702                         <span class="var-title">$host</span>
 1703                     </dt>
 1704         <dd class="index-item-body">
 1705             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$host">PHPCrawlerDocumentInfo::$host</a> in PHPCrawlerDocumentInfo.class.php</div>
 1706                             <div class="index-item-description">The host-part of the URL of the requested page or file, e.g. &quot;www.foo.com&quot;.</div>
 1707                     </dd>
 1708             <dt class="field">
 1709                         <span class="var-title">$host</span>
 1710                     </dt>
 1711         <dd class="index-item-body">
 1712             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$host">PHPCrawlerUrlPartsDescriptor::$host</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 1713                     </dd>
 1714             <dt class="field">
 1715                         <span class="var-title">$host_ip_array</span>
 1716                     </dt>
 1717         <dd class="index-item-body">
 1718             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDNSCache.html#var$host_ip_array">PHPCrawlerDNSCache::$host_ip_array</a> in PHPCrawlerDNSCache.class.php</div>
 1719                             <div class="index-item-description">Array for caching IPs of the requested hostnames</div>
 1720                     </dd>
 1721             <dt class="field">
 1722                         <span class="var-title">$http_status_code</span>
 1723                     </dt>
 1724         <dd class="index-item-body">
 1725             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html#var$http_status_code">PHPCrawlerResponseHeader::$http_status_code</a> in PHPCrawlerResponseHeader.class.php</div>
 1726                             <div class="index-item-description">The HTTP-statuscode</div>
 1727                     </dd>
 1728             <dt class="field">
 1729                         <span class="var-title">$http_status_code</span>
 1730                     </dt>
 1731         <dd class="index-item-body">
 1732             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$http_status_code">PHPCrawlerDocumentInfo::$http_status_code</a> in PHPCrawlerDocumentInfo.class.php</div>
 1733                             <div class="index-item-description">The HTTP-statuscode the webserver responded for the request, e.g. 200 (OK) or 404 (file not found).</div>
 1734                     </dd>
 1735             <dt class="field">
 1736                         <span class="method-title">handleDocumentInfo</span>
 1737                     </dt>
 1738         <dd class="index-item-body">
 1739             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html#methodhandleDocumentInfo">SMCCrawler::handleDocumentInfo()</a> in SitemapCreatorCrawler.class.php</div>
 1740                             <div class="index-item-description">get access to all information about a page or file the crawler found and received.</div>
 1741                     </dd>
 1742             <dt class="field">
 1743                         <span class="method-title">handleDocumentInfo</span>
 1744                     </dt>
 1745         <dd class="index-item-body">
 1746             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodhandleDocumentInfo">PHPCrawler::handleDocumentInfo()</a> in PHPCrawler.class.php</div>
 1747                             <div class="index-item-description">Override this method to get access to all information about a page or file the crawler found and received.</div>
 1748                     </dd>
 1749             <dt class="field">
 1750                         <span class="method-title">handleHeaderInfo</span>
 1751                     </dt>
 1752         <dd class="index-item-body">
 1753             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodhandleHeaderInfo">PHPCrawler::handleHeaderInfo()</a> in PHPCrawler.class.php</div>
 1754                             <div class="index-item-description">Overridable method that will be called after the header of a document was received and BEFORE the content  will be received.</div>
 1755                     </dd>
 1756             <dt class="field">
 1757                         <span class="method-title">handlePageData</span>
 1758                     </dt>
 1759         <dd class="index-item-body">
 1760             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodhandlePageData">PHPCrawler::handlePageData()</a> in PHPCrawler.class.php</div>
 1761                             <div class="index-item-description">Override this method to get access to all information about a page or file the crawler found and received.</div>
 1762                     </dd>
 1763             <dt class="field">
 1764                         <span class="method-title">hostInCache</span>
 1765                     </dt>
 1766         <dd class="index-item-body">
 1767             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDNSCache.html#methodhostInCache">PHPCrawlerDNSCache::hostInCache()</a> in PHPCrawlerDNSCache.class.php</div>
 1768                             <div class="index-item-description">Checks whether a hostname is already cached.</div>
 1769                     </dd>
 1770         </dl>
 1771     <a name="i"></a>
 1772     <div class="index-letter-section">
 1773         <div style="float: left" class="index-letter-title">i</div>
 1774         <div style="float: right"><a href="#top">top</a></div>
 1775         <div style="clear: both"></div>
 1776     </div>
 1777     <dl>
 1778             <dt class="field">
 1779                         <span class="var-title">$is_chlid_process</span>
 1780                     </dt>
 1781         <dd class="index-item-body">
 1782             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$is_chlid_process">PHPCrawler::$is_chlid_process</a> in PHPCrawler.class.php</div>
 1783                             <div class="index-item-description">Flag indicating whether this instance is running in a child-process (if crawler runs multi-processed)</div>
 1784                     </dd>
 1785             <dt class="field">
 1786                         <span class="var-title">$is_parent_process</span>
 1787                     </dt>
 1788         <dd class="index-item-body">
 1789             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$is_parent_process">PHPCrawler::$is_parent_process</a> in PHPCrawler.class.php</div>
 1790                             <div class="index-item-description">Flag indicating whether this instance is running in the parent-process (if crawler runs multi-processed)</div>
 1791                     </dd>
 1792             <dt class="field">
 1793                         <span class="var-title">$is_redirect_url</span>
 1794                     </dt>
 1795         <dd class="index-item-body">
 1796             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html#var$is_redirect_url">PHPCrawlerURLDescriptor::$is_redirect_url</a> in PHPCrawlerURLDescriptor.class.php</div>
 1797                             <div class="index-item-description">Flag indicating whether this URL was target of an HTTP-redirect.</div>
 1798                     </dd>
 1799             <dt class="field">
 1800                         <span class="method-title">initChildProcess</span>
 1801                     </dt>
 1802         <dd class="index-item-body">
 1803             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodinitChildProcess">PHPCrawler::initChildProcess()</a> in PHPCrawler.class.php</div>
 1804                             <div class="index-item-description">Overridable method that will be called by every used child-process just before it starts the crawling-procedure.</div>
 1805                     </dd>
 1806             <dt class="field">
 1807                         <span class="method-title">initCrawler</span>
 1808                     </dt>
 1809         <dd class="index-item-body">
 1810             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodinitCrawler">SitemapCreator::initCrawler()</a> in SitemapCreator.class.php</div>
 1811                             <div class="index-item-description">Initiate the crawler $Crawler</div>
 1812                     </dd>
 1813             <dt class="field">
 1814                         <span class="method-title">initCrawlerProcess</span>
 1815                     </dt>
 1816         <dd class="index-item-body">
 1817             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodinitCrawlerProcess">PHPCrawler::initCrawlerProcess()</a> in PHPCrawler.class.php</div>
 1818                             <div class="index-item-description">Initiates a crawler-process</div>
 1819                     </dd>
 1820             <dt class="field">
 1821                         <span class="method-title">isDataDirWritable</span>
 1822                     </dt>
 1823         <dd class="index-item-body">
 1824             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodisDataDirWritable">SitemapCreator::isDataDirWritable()</a> in SitemapCreator.class.php</div>
 1825                             <div class="index-item-description">Check if data directory is writable $data_dir</div>
 1826                     </dd>
 1827             <dt class="field">
 1828                         <span class="method-title">isUTF8String</span>
 1829                     </dt>
 1830         <dd class="index-item-body">
 1831             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodisUTF8String">PHPCrawlerUtils::isUTF8String()</a> in PHPCrawlerUtils.class.php</div>
 1832                             <div class="index-item-description">Checks wether the given string is an UTF8-encoded string.</div>
 1833                     </dd>
 1834             <dt class="field">
 1835                         <span class="method-title">isValidUrlString</span>
 1836                     </dt>
 1837         <dd class="index-item-body">
 1838             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodisValidUrlString">PHPCrawlerUtils::isValidUrlString()</a> in PHPCrawlerUtils.class.php</div>
 1839                             <div class="index-item-description">Checks whether the given string is a valid, urlencoded URL (by RFC)</div>
 1840                     </dd>
 1841         </dl>
 1842     <a name="k"></a>
 1843     <div class="index-letter-section">
 1844         <div style="float: left" class="index-letter-title">k</div>
 1845         <div style="float: right"><a href="#top">top</a></div>
 1846         <div style="clear: both"></div>
 1847     </div>
 1848     <dl>
 1849             <dt class="field">
 1850                         <span class="method-title">keepRedirectUrls</span>
 1851                     </dt>
 1852         <dd class="index-item-body">
 1853             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodkeepRedirectUrls">PHPCrawlerURLFilter::keepRedirectUrls()</a> in PHPCrawlerURLFilter.class.php</div>
 1854                             <div class="index-item-description">Filters out all non-redirect-URLs from the URLs given in the PHPCrawlerDocumentInfo-object</div>
 1855                     </dd>
 1856             <dt class="field">
 1857                         <span class="method-title">killChildProcesses</span>
 1858                     </dt>
 1859         <dd class="index-item-body">
 1860             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodkillChildProcesses">PHPCrawlerProcessCommunication::killChildProcesses()</a> in PHPCrawlerProcessCommunication.class.php</div>
 1861                             <div class="index-item-description">Kills all running child-processes</div>
 1862                     </dd>
 1863         </dl>
 1864     <a name="l"></a>
 1865     <div class="index-letter-section">
 1866         <div style="float: left" class="index-letter-title">l</div>
 1867         <div style="float: right"><a href="#top">top</a></div>
 1868         <div style="clear: both"></div>
 1869     </div>
 1870     <dl>
 1871             <dt class="field">
 1872                         <span class="var-title">$LastModifiedCount</span>
 1873                     </dt>
 1874         <dd class="index-item-body">
 1875             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html#var$LastModifiedCount">SMCCrawler::$LastModifiedCount</a> in SitemapCreatorCrawler.class.php</div>
 1876                             <div class="index-item-description">get Last Modified header</div>
 1877                     </dd>
 1878             <dt class="field">
 1879                         <span class="var-title">$lastResponseHeader</span>
 1880                     </dt>
 1881         <dd class="index-item-body">
 1882             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$lastResponseHeader">PHPCrawlerHTTPRequest::$lastResponseHeader</a> in PHPCrawlerHTTPRequest.class.php</div>
 1883                             <div class="index-item-description">The last response-header this request-instance received.</div>
 1884                     </dd>
 1885             <dt class="field">
 1886                         <span class="var-title">$LinkCache</span>
 1887                     </dt>
 1888         <dd class="index-item-body">
 1889             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$LinkCache">PHPCrawlerLinkFinder::$LinkCache</a> in PHPCrawlerLinkFinder.class.php</div>
 1890                             <div class="index-item-description">Cache for storing found links/urls</div>
 1891                     </dd>
 1892             <dt class="field">
 1893                         <span class="var-title">$LinkCache</span>
 1894                     </dt>
 1895         <dd class="index-item-body">
 1896             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$LinkCache">PHPCrawler::$LinkCache</a> in PHPCrawler.class.php</div>
 1897                             <div class="index-item-description">The PHPCrawlerLinkCache-Object</div>
 1898                     </dd>
 1899             <dt class="field">
 1900                         <span class="var-title">$linkcode</span>
 1901                     </dt>
 1902         <dd class="index-item-body">
 1903             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html#var$linkcode">PHPCrawlerURLDescriptor::$linkcode</a> in PHPCrawlerURLDescriptor.class.php</div>
 1904                             <div class="index-item-description">The html-codepart that contained the link to this URL, i.e. &quot;&lt;a href=&quot;../foo.html&quot;&gt;LINKTEXT&lt;/a&gt;&quot;</div>
 1905                     </dd>
 1906             <dt class="field">
 1907                         <span class="var-title">$LinkFinder</span>
 1908                     </dt>
 1909         <dd class="index-item-body">
 1910             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$LinkFinder">PHPCrawlerHTTPRequest::$LinkFinder</a> in PHPCrawlerHTTPRequest.class.php</div>
 1911                             <div class="index-item-description">Link-finder object</div>
 1912                     </dd>
 1913             <dt class="field">
 1914                         <span class="var-title">$linksearch_content_types</span>
 1915                     </dt>
 1916         <dd class="index-item-body">
 1917             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$linksearch_content_types">PHPCrawlerHTTPRequest::$linksearch_content_types</a> in PHPCrawlerHTTPRequest.class.php</div>
 1918                             <div class="index-item-description">Contains all rules defining the content-types defining which documents shoud get checked for links.</div>
 1919                     </dd>
 1920             <dt class="field">
 1921                         <span class="var-title">$links_followed</span>
 1922                     </dt>
 1923         <dd class="index-item-body">
 1924             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$links_followed">PHPCrawlerProcessReport::$links_followed</a> in PHPCrawlerProcessReport.class.php</div>
 1925                             <div class="index-item-description">The total number of links/URLs the crawler found and followed.</div>
 1926                     </dd>
 1927             <dt class="field">
 1928                         <span class="var-title">$links_followed</span>
 1929                     </dt>
 1930         <dd class="index-item-body">
 1931             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerStatus.html#var$links_followed">PHPCrawlerStatus::$links_followed</a> in PHPCrawlerStatus.class.php</div>
 1932                             <div class="index-item-description">Number of links the crawler-instance followed so far</div>
 1933                     </dd>
 1934             <dt class="field">
 1935                         <span class="var-title">$links_found</span>
 1936                     </dt>
 1937         <dd class="index-item-body">
 1938             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$links_found">PHPCrawlerDocumentInfo::$links_found</a> in PHPCrawlerDocumentInfo.class.php</div>
 1939                             <div class="index-item-description">An numeric array containing information about all links that were found in the source of the page.</div>
 1940                     </dd>
 1941             <dt class="field">
 1942                         <span class="var-title">$links_found_url_descriptors</span>
 1943                     </dt>
 1944         <dd class="index-item-body">
 1945             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$links_found_url_descriptors">PHPCrawlerDocumentInfo::$links_found_url_descriptors</a> in PHPCrawlerDocumentInfo.class.php</div>
 1946                             <div class="index-item-description">An numeric array containing a PHPCrawlerURLDescriptor-object for every link that was found in the page.</div>
 1947                     </dd>
 1948             <dt class="field">
 1949                         <span class="var-title">$linktext</span>
 1950                     </dt>
 1951         <dd class="index-item-body">
 1952             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html#var$linktext">PHPCrawlerURLDescriptor::$linktext</a> in PHPCrawlerURLDescriptor.class.php</div>
 1953                             <div class="index-item-description">The linktext or html-code the link to this URL was layed over.</div>
 1954                     </dd>
 1955             <dt class="field">
 1956                         <span class="var-title">$link_priority_array</span>
 1957                     </dt>
 1958         <dd class="index-item-body">
 1959             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$link_priority_array">PHPCrawler::$link_priority_array</a> in PHPCrawler.class.php</div>
 1960                     </dd>
 1961             <dt class="field">
 1962                         <span class="var-title">$link_raw</span>
 1963                     </dt>
 1964         <dd class="index-item-body">
 1965             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html#var$link_raw">PHPCrawlerURLDescriptor::$link_raw</a> in PHPCrawlerURLDescriptor.class.php</div>
 1966                             <div class="index-item-description">The raw link to this URL as it was found in the HTML-source, i.e. &quot;../dunno/index.php&quot;</div>
 1967                     </dd>
 1968         </dl>
 1969     <a name="m"></a>
 1970     <div class="index-letter-section">
 1971         <div style="float: left" class="index-letter-title">m</div>
 1972         <div style="float: right"><a href="#top">top</a></div>
 1973         <div style="clear: both"></div>
 1974     </div>
 1975     <dl>
 1976             <dt class="field">
 1977                         <span class="var-title">$memory_peak_usage</span>
 1978                     </dt>
 1979         <dd class="index-item-body">
 1980             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$memory_peak_usage">PHPCrawlerProcessReport::$memory_peak_usage</a> in PHPCrawlerProcessReport.class.php</div>
 1981                             <div class="index-item-description">The peak memory-usage the crawling-process caused.</div>
 1982                     </dd>
 1983             <dt class="field">
 1984                         <span class="var-title">$meta_attributes</span>
 1985                     </dt>
 1986         <dd class="index-item-body">
 1987             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$meta_attributes">PHPCrawlerLinkFinder::$meta_attributes</a> in PHPCrawlerLinkFinder.class.php</div>
 1988                             <div class="index-item-description">Meta-attributes found in the html-source.</div>
 1989                     </dd>
 1990             <dt class="field">
 1991                         <span class="var-title">$meta_attributes</span>
 1992                     </dt>
 1993         <dd class="index-item-body">
 1994             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$meta_attributes">PHPCrawlerDocumentInfo::$meta_attributes</a> in PHPCrawlerDocumentInfo.class.php</div>
 1995                             <div class="index-item-description">All meta-tag atteributes found in the source of the document.</div>
 1996                     </dd>
 1997             <dt class="field">
 1998                         <span class="var-title">$min_frequency</span>
 1999                     </dt>
 2000         <dd class="index-item-body">
 2001             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$min_frequency">SitemapCreator::$min_frequency</a> in SitemapCreator.class.php</div>
 2002                             <div class="index-item-description">Minimum Priority</div>
 2003                     </dd>
 2004             <dt class="field">
 2005                         <span class="var-title">$min_priority</span>
 2006                     </dt>
 2007         <dd class="index-item-body">
 2008             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$min_priority">SitemapCreator::$min_priority</a> in SitemapCreator.class.php</div>
 2009                             <div class="index-item-description">Minimum Priority</div>
 2010                     </dd>
 2011             <dt class="field">
 2012                         <span class="var-title">$multiprocess_mode</span>
 2013                     </dt>
 2014         <dd class="index-item-body">
 2015             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$multiprocess_mode">PHPCrawler::$multiprocess_mode</a> in PHPCrawler.class.php</div>
 2016                             <div class="index-item-description">Multiprocess-mode the crawler is runnung in.</div>
 2017                     </dd>
 2018             <dt class="field">
 2019                         <span class="var-title">$multiprocess_mode</span>
 2020                     </dt>
 2021         <dd class="index-item-body">
 2022             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#var$multiprocess_mode">PHPCrawlerProcessCommunication::$multiprocess_mode</a> in PHPCrawlerProcessCommunication.class.php</div>
 2023                     </dd>
 2024             <dt class="field">
 2025                         <span class="method-title">markUrlAsFollowed</span>
 2026                     </dt>
 2027         <dd class="index-item-body">
 2028             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodmarkUrlAsFollowed">PHPCrawlerURLCacheBase::markUrlAsFollowed()</a> in PHPCrawlerURLCacheBase.class.php</div>
 2029                             <div class="index-item-description">Marks the given URL in the cache as &quot;followed&quot;</div>
 2030                     </dd>
 2031             <dt class="field">
 2032                         <span class="method-title">markUrlAsFollowed</span>
 2033                     </dt>
 2034         <dd class="index-item-body">
 2035             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodmarkUrlAsFollowed">PHPCrawlerSQLiteURLCache::markUrlAsFollowed()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2036                             <div class="index-item-description">Marks the given URL in the cache as &quot;followed&quot;</div>
 2037                     </dd>
 2038             <dt class="field">
 2039                         <span class="method-title">markUrlAsFollowed</span>
 2040                     </dt>
 2041         <dd class="index-item-body">
 2042             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodmarkUrlAsFollowed">PHPCrawlerMemoryURLCache::markUrlAsFollowed()</a> in PHPCrawlerMemoryURLCache.class.php</div>
 2043                             <div class="index-item-description">Has no function in this memory-cache.</div>
 2044                     </dd>
 2045             <dt class="field">
 2046                         MPMODE_CHILDS_EXECUTES_USERCODE
 2047                     </dt>
 2048         <dd class="index-item-body">
 2049             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerMultiProcessModes.html#constMPMODE_CHILDS_EXECUTES_USERCODE">PHPCrawlerMultiProcessModes::MPMODE_CHILDS_EXECUTES_USERCODE</a> in PHPCrawlerMultiProcessModes.class.php</div>
 2050                             <div class="index-item-description">Crawler runs in multiprocess-mode, usercode is executed by child-processes directly.</div>
 2051                     </dd>
 2052             <dt class="field">
 2053                         MPMODE_NONE
 2054                     </dt>
 2055         <dd class="index-item-body">
 2056             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerMultiProcessModes.html#constMPMODE_NONE">PHPCrawlerMultiProcessModes::MPMODE_NONE</a> in PHPCrawlerMultiProcessModes.class.php</div>
 2057                             <div class="index-item-description">Crawler runs in a single process</div>
 2058                     </dd>
 2059             <dt class="field">
 2060                         MPMODE_PARENT_EXECUTES_USERCODE
 2061                     </dt>
 2062         <dd class="index-item-body">
 2063             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerMultiProcessModes.html#constMPMODE_PARENT_EXECUTES_USERCODE">PHPCrawlerMultiProcessModes::MPMODE_PARENT_EXECUTES_USERCODE</a> in PHPCrawlerMultiProcessModes.class.php</div>
 2064                             <div class="index-item-description">Crawler runs in multiprocess-mode, usercode is executed by parent-process only.</div>
 2065                     </dd>
 2066         </dl>
 2067     <a name="n"></a>
 2068     <div class="index-letter-section">
 2069         <div style="float: left" class="index-letter-title">n</div>
 2070         <div style="float: right"><a href="#top">top</a></div>
 2071         <div style="clear: both"></div>
 2072     </div>
 2073     <dl>
 2074             <dt class="field">
 2075                         <span class="var-title">$name</span>
 2076                     </dt>
 2077         <dd class="index-item-body">
 2078             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$name">PHPCrawlerCookieDescriptor::$name</a> in PHPCrawlerCookieDescriptor.class.php</div>
 2079                             <div class="index-item-description">Cookie-name</div>
 2080                     </dd>
 2081             <dt class="field">
 2082                         <span class="var-title">$now</span>
 2083                     </dt>
 2084         <dd class="index-item-body">
 2085             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$now">SitemapCreator::$now</a> in SitemapCreator.class.php</div>
 2086                             <div class="index-item-description">Current time().</div>
 2087                     </dd>
 2088             <dt class="field">
 2089                         <span class="method-title">normalizeURL</span>
 2090                     </dt>
 2091         <dd class="index-item-body">
 2092             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodnormalizeURL">PHPCrawlerUtils::normalizeURL()</a> in PHPCrawlerUtils.class.php</div>
 2093                             <div class="index-item-description">Normalizes an URL</div>
 2094                     </dd>
 2095         </dl>
 2096     <a name="o"></a>
 2097     <div class="index-letter-section">
 2098         <div style="float: left" class="index-letter-title">o</div>
 2099         <div style="float: right"><a href="#top">top</a></div>
 2100         <div style="clear: both"></div>
 2101     </div>
 2102     <dl>
 2103             <dt class="field">
 2104                         <span class="var-title">$obey_nofollow_tags</span>
 2105                     </dt>
 2106         <dd class="index-item-body">
 2107             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$obey_nofollow_tags">PHPCrawlerURLFilter::$obey_nofollow_tags</a> in PHPCrawlerURLFilter.class.php</div>
 2108                             <div class="index-item-description">Defines whether nofollow-tags should get obeyed.</div>
 2109                     </dd>
 2110             <dt class="field">
 2111                         <span class="var-title">$obey_robots_txt</span>
 2112                     </dt>
 2113         <dd class="index-item-body">
 2114             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$obey_robots_txt">PHPCrawler::$obey_robots_txt</a> in PHPCrawler.class.php</div>
 2115                             <div class="index-item-description">Defines whether robots.txt-file should be obeyed</div>
 2116                     </dd>
 2117             <dt class="field">
 2118                         <span class="var-title">$only_count_received_documents</span>
 2119                     </dt>
 2120         <dd class="index-item-body">
 2121             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$only_count_received_documents">PHPCrawler::$only_count_received_documents</a> in PHPCrawler.class.php</div>
 2122                             <div class="index-item-description">Defines if only documents that were received will be counted.</div>
 2123                     </dd>
 2124             <dt class="field">
 2125                         <span class="method-title">obeyNoFollowTags</span>
 2126                     </dt>
 2127         <dd class="index-item-body">
 2128             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodobeyNoFollowTags">PHPCrawler::obeyNoFollowTags()</a> in PHPCrawler.class.php</div>
 2129                             <div class="index-item-description">Decides whether the crawler should obey &quot;nofollow&quot;-tags</div>
 2130                     </dd>
 2131             <dt class="field">
 2132                         <span class="method-title">obeyRobotsTxt</span>
 2133                     </dt>
 2134         <dd class="index-item-body">
 2135             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodobeyRobotsTxt">PHPCrawler::obeyRobotsTxt()</a> in PHPCrawler.class.php</div>
 2136                             <div class="index-item-description">Decides whether the crawler should parse and obey robots.txt-files.</div>
 2137                     </dd>
 2138             <dt class="field">
 2139                         <span class="method-title">openConnection</span>
 2140                     </dt>
 2141         <dd class="index-item-body">
 2142             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodopenConnection">PHPCrawlerSQLiteURLCache::openConnection()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2143                             <div class="index-item-description">Creates the sqlite-db-file and opens connection to it.</div>
 2144                     </dd>
 2145             <dt class="field">
 2146                         <span class="method-title">openConnection</span>
 2147                     </dt>
 2148         <dd class="index-item-body">
 2149             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#methodopenConnection">PHPCrawlerDocumentInfoQueue::openConnection()</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 2150                             <div class="index-item-description">Creates the sqlite-db-file and opens connection to it.</div>
 2151                     </dd>
 2152             <dt class="field">
 2153                         <span class="method-title">openConnection</span>
 2154                     </dt>
 2155         <dd class="index-item-body">
 2156             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html#methodopenConnection">PHPCrawlerSQLiteCookieCache::openConnection()</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
 2157                             <div class="index-item-description">Creates the sqlite-db-file and opens connection to it.</div>
 2158                     </dd>
 2159             <dt class="field">
 2160                         <span class="method-title">openSocket</span>
 2161                     </dt>
 2162         <dd class="index-item-body">
 2163             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodopenSocket">PHPCrawlerHTTPRequest::openSocket()</a> in PHPCrawlerHTTPRequest.class.php</div>
 2164                             <div class="index-item-description">Opens the socket to the host.</div>
 2165                     </dd>
 2166             <dt class="field">
 2167                         <span class="method-title">openURL</span>
 2168                     </dt>
 2169         <dd class="index-item-body">
 2170             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodopenURL">SitemapCreator::openURL()</a> in SitemapCreator.class.php</div>
 2171                             <div class="index-item-description">Open URL and get respond body or error</div>
 2172                     </dd>
 2173         </dl>
 2174     <a name="p"></a>
 2175     <div class="index-letter-section">
 2176         <div style="float: left" class="index-letter-title">p</div>
 2177         <div style="float: right"><a href="#top">top</a></div>
 2178         <div style="clear: both"></div>
 2179     </div>
 2180     <dl>
 2181             <dt class="field">
 2182                         <span class="var-title">$PageRequest</span>
 2183                     </dt>
 2184         <dd class="index-item-body">
 2185             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$PageRequest">PHPCrawler::$PageRequest</a> in PHPCrawler.class.php</div>
 2186                             <div class="index-item-description">The PHPCrawlerHTTPRequest-Object</div>
 2187                     </dd>
 2188             <dt class="field">
 2189                         <span class="var-title">$PageRequest</span>
 2190                     </dt>
 2191         <dd class="index-item-body">
 2192             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html#var$PageRequest">PHPCrawlerRobotsTxtParser::$PageRequest</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 2193                             <div class="index-item-description">A PHPCrawlerHTTPRequest-object for requesting robots.txt-files.</div>
 2194                     </dd>
 2195             <dt class="field">
 2196                         <span class="var-title">$path</span>
 2197                     </dt>
 2198         <dd class="index-item-body">
 2199             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$path">PHPCrawlerCookieDescriptor::$path</a> in PHPCrawlerCookieDescriptor.class.php</div>
 2200                             <div class="index-item-description">Cookie-path</div>
 2201                     </dd>
 2202             <dt class="field">
 2203                         <span class="var-title">$path</span>
 2204                     </dt>
 2205         <dd class="index-item-body">
 2206             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$path">PHPCrawlerDocumentInfo::$path</a> in PHPCrawlerDocumentInfo.class.php</div>
 2207                             <div class="index-item-description">The path in the URL of the requested page or file, e.g. &quot;/page/&quot;.</div>
 2208                     </dd>
 2209             <dt class="field">
 2210                         <span class="var-title">$path</span>
 2211                     </dt>
 2212         <dd class="index-item-body">
 2213             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$path">PHPCrawlerUrlPartsDescriptor::$path</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 2214                     </dd>
 2215             <dt class="field">
 2216                         <span class="var-title">$PDO</span>
 2217                     </dt>
 2218         <dd class="index-item-body">
 2219             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html#var$PDO">PHPCrawlerSQLiteCookieCache::$PDO</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
 2220                     </dd>
 2221             <dt class="field">
 2222                         <span class="var-title">$PDO</span>
 2223                     </dt>
 2224         <dd class="index-item-body">
 2225             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#var$PDO">PHPCrawlerDocumentInfoQueue::$PDO</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 2226                     </dd>
 2227             <dt class="field">
 2228                         <span class="var-title">$PDO</span>
 2229                     </dt>
 2230         <dd class="index-item-body">
 2231             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#var$PDO">PHPCrawlerSQLiteURLCache::$PDO</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2232                             <div class="index-item-description">PDO-object for querying SQLite-file.</div>
 2233                     </dd>
 2234             <dt class="field">
 2235                         <span class="var-title">$porcess_abort_reason</span>
 2236                     </dt>
 2237         <dd class="index-item-body">
 2238             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$porcess_abort_reason">PHPCrawler::$porcess_abort_reason</a> in PHPCrawler.class.php</div>
 2239                             <div class="index-item-description">The reason why the process was aborted/finished.</div>
 2240                     </dd>
 2241             <dt class="field">
 2242                         <span class="var-title">$port</span>
 2243                     </dt>
 2244         <dd class="index-item-body">
 2245             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$port">PHPCrawlerDocumentInfo::$port</a> in PHPCrawlerDocumentInfo.class.php</div>
 2246                             <div class="index-item-description">The port of the URL the request was send to, e.g. 80</div>
 2247                     </dd>
 2248             <dt class="field">
 2249                         <span class="var-title">$port</span>
 2250                     </dt>
 2251         <dd class="index-item-body">
 2252             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$port">PHPCrawlerUrlPartsDescriptor::$port</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 2253                     </dd>
 2254             <dt class="field">
 2255                         <span class="var-title">$post_data</span>
 2256                     </dt>
 2257         <dd class="index-item-body">
 2258             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$post_data">PHPCrawlerHTTPRequest::$post_data</a> in PHPCrawlerHTTPRequest.class.php</div>
 2259                             <div class="index-item-description">Array containing POST-data to send with the request</div>
 2260                     </dd>
 2261             <dt class="field">
 2262                         <span class="var-title">$post_data</span>
 2263                     </dt>
 2264         <dd class="index-item-body">
 2265             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html#var$post_data">PHPCrawlerUserSendDataCache::$post_data</a> in PHPCrawlerUserSendDataCache.class.php</div>
 2266                             <div class="index-item-description">Array containing post-data to send.</div>
 2267                     </dd>
 2268             <dt class="field">
 2269                         <span class="var-title">$PreparedInsertStatement</span>
 2270                     </dt>
 2271         <dd class="index-item-body">
 2272             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#var$PreparedInsertStatement">PHPCrawlerSQLiteURLCache::$PreparedInsertStatement</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2273                             <div class="index-item-description">Prepared statement for inserting URLS into the db-file as PDOStatement-object.</div>
 2274                     </dd>
 2275             <dt class="field">
 2276                         <span class="var-title">$prepared_statements_created</span>
 2277                     </dt>
 2278         <dd class="index-item-body">
 2279             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#var$prepared_statements_created">PHPCrawlerDocumentInfoQueue::$prepared_statements_created</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 2280                     </dd>
 2281             <dt class="field">
 2282                         <span class="var-title">$priority_mode</span>
 2283                     </dt>
 2284         <dd class="index-item-body">
 2285             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$priority_mode">SitemapCreator::$priority_mode</a> in SitemapCreator.class.php</div>
 2286                             <div class="index-item-description">Priority mode</div>
 2287                     </dd>
 2288             <dt class="field">
 2289                         <span class="var-title">$ProcessCommunication</span>
 2290                     </dt>
 2291         <dd class="index-item-body">
 2292             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$ProcessCommunication">PHPCrawler::$ProcessCommunication</a> in PHPCrawler.class.php</div>
 2293                             <div class="index-item-description">ProcessCommunication-object</div>
 2294                     </dd>
 2295             <dt class="field">
 2296                         <span class="var-title">$process_runtime</span>
 2297                     </dt>
 2298         <dd class="index-item-body">
 2299             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$process_runtime">PHPCrawlerProcessReport::$process_runtime</a> in PHPCrawlerProcessReport.class.php</div>
 2300                             <div class="index-item-description">The total time the crawling-process was running in seconds.</div>
 2301                     </dd>
 2302             <dt class="field">
 2303                         <span class="var-title">$protocol</span>
 2304                     </dt>
 2305         <dd class="index-item-body">
 2306             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$protocol">PHPCrawlerDocumentInfo::$protocol</a> in PHPCrawlerDocumentInfo.class.php</div>
 2307                             <div class="index-item-description">The protocol-part of the URL of the page or file, e.g. &quot;http://&quot;</div>
 2308                     </dd>
 2309             <dt class="field">
 2310                         <span class="var-title">$protocol</span>
 2311                     </dt>
 2312         <dd class="index-item-body">
 2313             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#var$protocol">PHPCrawlerUrlPartsDescriptor::$protocol</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 2314                     </dd>
 2315             <dt class="field">
 2316                         <span class="var-title">$proxy</span>
 2317                     </dt>
 2318         <dd class="index-item-body">
 2319             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$proxy">PHPCrawlerHTTPRequest::$proxy</a> in PHPCrawlerHTTPRequest.class.php</div>
 2320                             <div class="index-item-description">The proxy to use</div>
 2321                     </dd>
 2322             <dt class="field">
 2323                         <span class="include-title">PHPCrawlerCookieCacheBase.class.php</span>
 2324                     </dt>
 2325         <dd class="index-item-body">
 2326             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---CookieCache---PHPCrawlerCookieCacheBase.class.php.html">PHPCrawlerCookieCacheBase.class.php</a> in PHPCrawlerCookieCacheBase.class.php</div>
 2327                     </dd>
 2328             <dt class="field">
 2329                         <span class="include-title">PHPCrawlerMemoryCookieCache.class.php</span>
 2330                     </dt>
 2331         <dd class="index-item-body">
 2332             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---CookieCache---PHPCrawlerMemoryCookieCache.class.php.html">PHPCrawlerMemoryCookieCache.class.php</a> in PHPCrawlerMemoryCookieCache.class.php</div>
 2333                     </dd>
 2334             <dt class="field">
 2335                         <span class="include-title">PHPCrawlerSQLiteCookieCache.class.php</span>
 2336                     </dt>
 2337         <dd class="index-item-body">
 2338             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---CookieCache---PHPCrawlerSQLiteCookieCache.class.php.html">PHPCrawlerSQLiteCookieCache.class.php</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
 2339                     </dd>
 2340             <dt class="field">
 2341                         <span class="include-title">PHPCrawlerAbortReasons.class.php</span>
 2342                     </dt>
 2343         <dd class="index-item-body">
 2344             <div class="index-item-details"><a href="phpcrawl-enums/_libs---PHPCrawler---Enums---PHPCrawlerAbortReasons.class.php.html">PHPCrawlerAbortReasons.class.php</a> in PHPCrawlerAbortReasons.class.php</div>
 2345                     </dd>
 2346             <dt class="field">
 2347                         <span class="include-title">PHPCrawlerMultiProcessModes.class.php</span>
 2348                     </dt>
 2349         <dd class="index-item-body">
 2350             <div class="index-item-details"><a href="phpcrawl-enums/_libs---PHPCrawler---Enums---PHPCrawlerMultiProcessModes.class.php.html">PHPCrawlerMultiProcessModes.class.php</a> in PHPCrawlerMultiProcessModes.class.php</div>
 2351                     </dd>
 2352             <dt class="field">
 2353                         <span class="include-title">PHPCrawlerRequestErrors.class.php</span>
 2354                     </dt>
 2355         <dd class="index-item-body">
 2356             <div class="index-item-details"><a href="phpcrawl-enums/_libs---PHPCrawler---Enums---PHPCrawlerRequestErrors.class.php.html">PHPCrawlerRequestErrors.class.php</a> in PHPCrawlerRequestErrors.class.php</div>
 2357                     </dd>
 2358             <dt class="field">
 2359                         <span class="include-title">PHPCrawlerUrlCacheTypes.class.php</span>
 2360                     </dt>
 2361         <dd class="index-item-body">
 2362             <div class="index-item-details"><a href="phpcrawl-enums/_libs---PHPCrawler---Enums---PHPCrawlerUrlCacheTypes.class.php.html">PHPCrawlerUrlCacheTypes.class.php</a> in PHPCrawlerUrlCacheTypes.class.php</div>
 2363                     </dd>
 2364             <dt class="field">
 2365                         <span class="include-title">PHPCrawler.class.php</span>
 2366                     </dt>
 2367         <dd class="index-item-body">
 2368             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawler.class.php.html">PHPCrawler.class.php</a> in PHPCrawler.class.php</div>
 2369                     </dd>
 2370             <dt class="field">
 2371                         <span class="include-title">PHPCrawlerBenchmark.class.php</span>
 2372                     </dt>
 2373         <dd class="index-item-body">
 2374             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerBenchmark.class.php.html">PHPCrawlerBenchmark.class.php</a> in PHPCrawlerBenchmark.class.php</div>
 2375                     </dd>
 2376             <dt class="field">
 2377                         <span class="include-title">PHPCrawlerCookieDescriptor.class.php</span>
 2378                     </dt>
 2379         <dd class="index-item-body">
 2380             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerCookieDescriptor.class.php.html">PHPCrawlerCookieDescriptor.class.php</a> in PHPCrawlerCookieDescriptor.class.php</div>
 2381                     </dd>
 2382             <dt class="field">
 2383                         <span class="include-title">PHPCrawlerDNSCache.class.php</span>
 2384                     </dt>
 2385         <dd class="index-item-body">
 2386             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerDNSCache.class.php.html">PHPCrawlerDNSCache.class.php</a> in PHPCrawlerDNSCache.class.php</div>
 2387                     </dd>
 2388             <dt class="field">
 2389                         <span class="include-title">PHPCrawlerDocumentInfo.class.php</span>
 2390                     </dt>
 2391         <dd class="index-item-body">
 2392             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerDocumentInfo.class.php.html">PHPCrawlerDocumentInfo.class.php</a> in PHPCrawlerDocumentInfo.class.php</div>
 2393                     </dd>
 2394             <dt class="field">
 2395                         <span class="include-title">PHPCrawlerHTTPRequest.class.php</span>
 2396                     </dt>
 2397         <dd class="index-item-body">
 2398             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerHTTPRequest.class.php.html">PHPCrawlerHTTPRequest.class.php</a> in PHPCrawlerHTTPRequest.class.php</div>
 2399                     </dd>
 2400             <dt class="field">
 2401                         <span class="include-title">PHPCrawlerLinkFinder.class.php</span>
 2402                     </dt>
 2403         <dd class="index-item-body">
 2404             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerLinkFinder.class.php.html">PHPCrawlerLinkFinder.class.php</a> in PHPCrawlerLinkFinder.class.php</div>
 2405                     </dd>
 2406             <dt class="field">
 2407                         <span class="include-title">PHPCrawlerProcessReport.class.php</span>
 2408                     </dt>
 2409         <dd class="index-item-body">
 2410             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerProcessReport.class.php.html">PHPCrawlerProcessReport.class.php</a> in PHPCrawlerProcessReport.class.php</div>
 2411                     </dd>
 2412             <dt class="field">
 2413                         <span class="include-title">PHPCrawlerResponseHeader.class.php</span>
 2414                     </dt>
 2415         <dd class="index-item-body">
 2416             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerResponseHeader.class.php.html">PHPCrawlerResponseHeader.class.php</a> in PHPCrawlerResponseHeader.class.php</div>
 2417                     </dd>
 2418             <dt class="field">
 2419                         <span class="include-title">PHPCrawlerRobotsTxtParser.class.php</span>
 2420                     </dt>
 2421         <dd class="index-item-body">
 2422             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerRobotsTxtParser.class.php.html">PHPCrawlerRobotsTxtParser.class.php</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 2423                     </dd>
 2424             <dt class="field">
 2425                         <span class="include-title">PHPCrawlerStatus.class.php</span>
 2426                     </dt>
 2427         <dd class="index-item-body">
 2428             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerStatus.class.php.html">PHPCrawlerStatus.class.php</a> in PHPCrawlerStatus.class.php</div>
 2429                     </dd>
 2430             <dt class="field">
 2431                         <span class="include-title">PHPCrawlerURLDescriptor.class.php</span>
 2432                     </dt>
 2433         <dd class="index-item-body">
 2434             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerURLDescriptor.class.php.html">PHPCrawlerURLDescriptor.class.php</a> in PHPCrawlerURLDescriptor.class.php</div>
 2435                     </dd>
 2436             <dt class="field">
 2437                         <span class="include-title">PHPCrawlerURLFilter.class.php</span>
 2438                     </dt>
 2439         <dd class="index-item-body">
 2440             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerURLFilter.class.php.html">PHPCrawlerURLFilter.class.php</a> in PHPCrawlerURLFilter.class.php</div>
 2441                     </dd>
 2442             <dt class="field">
 2443                         <span class="include-title">PHPCrawlerUrlPartsDescriptor.class.php</span>
 2444                     </dt>
 2445         <dd class="index-item-body">
 2446             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerUrlPartsDescriptor.class.php.html">PHPCrawlerUrlPartsDescriptor.class.php</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 2447                     </dd>
 2448             <dt class="field">
 2449                         <span class="include-title">PHPCrawlerUserSendDataCache.class.php</span>
 2450                     </dt>
 2451         <dd class="index-item-body">
 2452             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerUserSendDataCache.class.php.html">PHPCrawlerUserSendDataCache.class.php</a> in PHPCrawlerUserSendDataCache.class.php</div>
 2453                     </dd>
 2454             <dt class="field">
 2455                         <span class="include-title">PHPCrawlerUtils.class.php</span>
 2456                     </dt>
 2457         <dd class="index-item-body">
 2458             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---PHPCrawlerUtils.class.php.html">PHPCrawlerUtils.class.php</a> in PHPCrawlerUtils.class.php</div>
 2459                     </dd>
 2460             <dt class="field">
 2461                         <span class="include-title">PHPCrawlerDocumentInfoQueue.class.php</span>
 2462                     </dt>
 2463         <dd class="index-item-body">
 2464             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---ProcessCommunication---PHPCrawlerDocumentInfoQueue.class.php.html">PHPCrawlerDocumentInfoQueue.class.php</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 2465                     </dd>
 2466             <dt class="field">
 2467                         <span class="include-title">PHPCrawlerProcessCommunication.class.php</span>
 2468                     </dt>
 2469         <dd class="index-item-body">
 2470             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---ProcessCommunication---PHPCrawlerProcessCommunication.class.php.html">PHPCrawlerProcessCommunication.class.php</a> in PHPCrawlerProcessCommunication.class.php</div>
 2471                     </dd>
 2472             <dt class="field">
 2473                         <span class="include-title">PHPCrawlerMemoryURLCache.class.php</span>
 2474                     </dt>
 2475         <dd class="index-item-body">
 2476             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---UrlCache---PHPCrawlerMemoryURLCache.class.php.html">PHPCrawlerMemoryURLCache.class.php</a> in PHPCrawlerMemoryURLCache.class.php</div>
 2477                     </dd>
 2478             <dt class="field">
 2479                         <span class="include-title">PHPCrawlerSQLiteURLCache.class.php</span>
 2480                     </dt>
 2481         <dd class="index-item-body">
 2482             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---UrlCache---PHPCrawlerSQLiteURLCache.class.php.html">PHPCrawlerSQLiteURLCache.class.php</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2483                     </dd>
 2484             <dt class="field">
 2485                         <span class="include-title">PHPCrawlerURLCacheBase.class.php</span>
 2486                     </dt>
 2487         <dd class="index-item-body">
 2488             <div class="index-item-details"><a href="phpcrawl/_libs---PHPCrawler---UrlCache---PHPCrawlerURLCacheBase.class.php.html">PHPCrawlerURLCacheBase.class.php</a> in PHPCrawlerURLCacheBase.class.php</div>
 2489                     </dd>
 2490             <dt class="field">
 2491                         <span class="method-title">parseRobotsTxt</span>
 2492                     </dt>
 2493         <dd class="index-item-body">
 2494             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html#methodparseRobotsTxt">PHPCrawlerRobotsTxtParser::parseRobotsTxt()</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 2495                             <div class="index-item-description">Parses the robots.txt-file related to the given URL and returns regular-expression-rules  corresponding to the containing &quot;disallow&quot;-rules that are adressed to the given user-agent.</div>
 2496                     </dd>
 2497             <dt class="field">
 2498                         PHPCrawler
 2499                     </dt>
 2500         <dd class="index-item-body">
 2501             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html">PHPCrawler</a> in PHPCrawler.class.php</div>
 2502                             <div class="index-item-description">PHPCrawl mainclass</div>
 2503                     </dd>
 2504             <dt class="field">
 2505                         PHPCrawlerAbortReasons
 2506                     </dt>
 2507         <dd class="index-item-body">
 2508             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerAbortReasons.html">PHPCrawlerAbortReasons</a> in PHPCrawlerAbortReasons.class.php</div>
 2509                             <div class="index-item-description">Contains all possible abortreasons for a crawling-process.</div>
 2510                     </dd>
 2511             <dt class="field">
 2512                         PHPCrawlerBenchmark
 2513                     </dt>
 2514         <dd class="index-item-body">
 2515             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html">PHPCrawlerBenchmark</a> in PHPCrawlerBenchmark.class.php</div>
 2516                             <div class="index-item-description">A static benchmark-class for doing benchmarks within phpcrawl.</div>
 2517                     </dd>
 2518             <dt class="field">
 2519                         PHPCrawlerCookieCacheBase
 2520                     </dt>
 2521         <dd class="index-item-body">
 2522             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieCacheBase.html">PHPCrawlerCookieCacheBase</a> in PHPCrawlerCookieCacheBase.class.php</div>
 2523                             <div class="index-item-description">Abstract baseclass for storing cookies.</div>
 2524                     </dd>
 2525             <dt class="field">
 2526                         PHPCrawlerCookieDescriptor
 2527                     </dt>
 2528         <dd class="index-item-body">
 2529             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a> in PHPCrawlerCookieDescriptor.class.php</div>
 2530                             <div class="index-item-description">Describes a cookie within the PHPCrawl-system.</div>
 2531                     </dd>
 2532             <dt class="field">
 2533                         PHPCrawlerDNSCache
 2534                     </dt>
 2535         <dd class="index-item-body">
 2536             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDNSCache.html">PHPCrawlerDNSCache</a> in PHPCrawlerDNSCache.class.php</div>
 2537                             <div class="index-item-description">Simple DNS-cache used by phpcrawl.</div>
 2538                     </dd>
 2539             <dt class="field">
 2540                         PHPCrawlerDocumentInfo
 2541                     </dt>
 2542         <dd class="index-item-body">
 2543             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a> in PHPCrawlerDocumentInfo.class.php</div>
 2544                             <div class="index-item-description">Contains information about a page or file the crawler found and received during the crawling-process.</div>
 2545                     </dd>
 2546             <dt class="field">
 2547                         PHPCrawlerDocumentInfoQueue
 2548                     </dt>
 2549         <dd class="index-item-body">
 2550             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html">PHPCrawlerDocumentInfoQueue</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 2551                             <div class="index-item-description">Queue for PHPCrawlerDocumentInfo-objects</div>
 2552                     </dd>
 2553             <dt class="field">
 2554                         PHPCrawlerHTTPRequest
 2555                     </dt>
 2556         <dd class="index-item-body">
 2557             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html">PHPCrawlerHTTPRequest</a> in PHPCrawlerHTTPRequest.class.php</div>
 2558                             <div class="index-item-description">Class for performing HTTP-requests.</div>
 2559                     </dd>
 2560             <dt class="field">
 2561                         PHPCrawlerLinkFinder
 2562                     </dt>
 2563         <dd class="index-item-body">
 2564             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html">PHPCrawlerLinkFinder</a> in PHPCrawlerLinkFinder.class.php</div>
 2565                             <div class="index-item-description">Class for finding links in HTML-documents.</div>
 2566                     </dd>
 2567             <dt class="field">
 2568                         PHPCrawlerMemoryCookieCache
 2569                     </dt>
 2570         <dd class="index-item-body">
 2571             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryCookieCache.html">PHPCrawlerMemoryCookieCache</a> in PHPCrawlerMemoryCookieCache.class.php</div>
 2572                             <div class="index-item-description">Class for storing/caching cookies in memory.</div>
 2573                     </dd>
 2574             <dt class="field">
 2575                         PHPCrawlerMemoryURLCache
 2576                     </dt>
 2577         <dd class="index-item-body">
 2578             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html">PHPCrawlerMemoryURLCache</a> in PHPCrawlerMemoryURLCache.class.php</div>
 2579                             <div class="index-item-description">Class for caching/storing URLs/links in memory.</div>
 2580                     </dd>
 2581             <dt class="field">
 2582                         PHPCrawlerMultiProcessModes
 2583                     </dt>
 2584         <dd class="index-item-body">
 2585             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerMultiProcessModes.html">PHPCrawlerMultiProcessModes</a> in PHPCrawlerMultiProcessModes.class.php</div>
 2586                             <div class="index-item-description">Multiprocessing-modes currently supported by phpcrawl.</div>
 2587                     </dd>
 2588             <dt class="field">
 2589                         PHPCrawlerProcessCommunication
 2590                     </dt>
 2591         <dd class="index-item-body">
 2592             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html">PHPCrawlerProcessCommunication</a> in PHPCrawlerProcessCommunication.class.php</div>
 2593                             <div class="index-item-description">Class containing methods for process handling and communication</div>
 2594                     </dd>
 2595             <dt class="field">
 2596                         PHPCrawlerProcessReport
 2597                     </dt>
 2598         <dd class="index-item-body">
 2599             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html">PHPCrawlerProcessReport</a> in PHPCrawlerProcessReport.class.php</div>
 2600                             <div class="index-item-description">Contains summarizing information about a crawling-process after the process is finished.</div>
 2601                     </dd>
 2602             <dt class="field">
 2603                         PHPCrawlerRequestErrors
 2604                     </dt>
 2605         <dd class="index-item-body">
 2606             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerRequestErrors.html">PHPCrawlerRequestErrors</a> in PHPCrawlerRequestErrors.class.php</div>
 2607                             <div class="index-item-description">Contains all possible errorcodes for errors that may appear during a http-request.</div>
 2608                     </dd>
 2609             <dt class="field">
 2610                         PHPCrawlerResponseHeader
 2611                     </dt>
 2612         <dd class="index-item-body">
 2613             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html">PHPCrawlerResponseHeader</a> in PHPCrawlerResponseHeader.class.php</div>
 2614                             <div class="index-item-description">Describes an HTTP response-header within the phpcrawl-system.</div>
 2615                     </dd>
 2616             <dt class="field">
 2617                         PHPCrawlerRobotsTxtParser
 2618                     </dt>
 2619         <dd class="index-item-body">
 2620             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerRobotsTxtParser.html">PHPCrawlerRobotsTxtParser</a> in PHPCrawlerRobotsTxtParser.class.php</div>
 2621                             <div class="index-item-description">Class for parsing robots.txt-files.</div>
 2622                     </dd>
 2623             <dt class="field">
 2624                         PHPCrawlerSQLiteCookieCache
 2625                     </dt>
 2626         <dd class="index-item-body">
 2627             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html">PHPCrawlerSQLiteCookieCache</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
 2628                             <div class="index-item-description">Class for storing/caching cookies in a SQLite-db-file.</div>
 2629                     </dd>
 2630             <dt class="field">
 2631                         PHPCrawlerSQLiteURLCache
 2632                     </dt>
 2633         <dd class="index-item-body">
 2634             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html">PHPCrawlerSQLiteURLCache</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2635                             <div class="index-item-description">Class for caching/storing URLs/links in a SQLite-database-file.</div>
 2636                     </dd>
 2637             <dt class="field">
 2638                         PHPCrawlerStatus
 2639                     </dt>
 2640         <dd class="index-item-body">
 2641             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerStatus.html">PHPCrawlerStatus</a> in PHPCrawlerStatus.class.php</div>
 2642                             <div class="index-item-description">Describes the current status of an crawler-instance.</div>
 2643                     </dd>
 2644             <dt class="field">
 2645                         PHPCrawlerURLCacheBase
 2646                     </dt>
 2647         <dd class="index-item-body">
 2648             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html">PHPCrawlerURLCacheBase</a> in PHPCrawlerURLCacheBase.class.php</div>
 2649                             <div class="index-item-description">Abstract baseclass for implemented URL-caching classes.</div>
 2650                     </dd>
 2651             <dt class="field">
 2652                         PHPCrawlerUrlCacheTypes
 2653                     </dt>
 2654         <dd class="index-item-body">
 2655             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerUrlCacheTypes.html">PHPCrawlerUrlCacheTypes</a> in PHPCrawlerUrlCacheTypes.class.php</div>
 2656                             <div class="index-item-description">Possible cache-types for caching found URLs within the phpcrawl-system.</div>
 2657                     </dd>
 2658             <dt class="field">
 2659                         PHPCrawlerURLDescriptor
 2660                     </dt>
 2661         <dd class="index-item-body">
 2662             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a> in PHPCrawlerURLDescriptor.class.php</div>
 2663                             <div class="index-item-description">Describes a URL within the PHPCrawl-system.</div>
 2664                     </dd>
 2665             <dt class="field">
 2666                         PHPCrawlerURLFilter
 2667                     </dt>
 2668         <dd class="index-item-body">
 2669             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html">PHPCrawlerURLFilter</a> in PHPCrawlerURLFilter.class.php</div>
 2670                             <div class="index-item-description">Class for filtering URLs by given filter-rules.</div>
 2671                     </dd>
 2672             <dt class="field">
 2673                         PHPCrawlerUrlPartsDescriptor
 2674                     </dt>
 2675         <dd class="index-item-body">
 2676             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html">PHPCrawlerUrlPartsDescriptor</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 2677                             <div class="index-item-description">Describes the single parts of an URL.</div>
 2678                     </dd>
 2679             <dt class="field">
 2680                         PHPCrawlerUserSendDataCache
 2681                     </dt>
 2682         <dd class="index-item-body">
 2683             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUserSendDataCache.html">PHPCrawlerUserSendDataCache</a> in PHPCrawlerUserSendDataCache.class.php</div>
 2684                             <div class="index-item-description">Cache for storing user-data to send with requests, like cookies, post-data  and basic-authentications.</div>
 2685                     </dd>
 2686             <dt class="field">
 2687                         PHPCrawlerUtils
 2688                     </dt>
 2689         <dd class="index-item-body">
 2690             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html">PHPCrawlerUtils</a> in PHPCrawlerUtils.class.php</div>
 2691                             <div class="index-item-description">Static util-methods used by phpcrawl.</div>
 2692                     </dd>
 2693             <dt class="field">
 2694                         <span class="method-title">ping</span>
 2695                     </dt>
 2696         <dd class="index-item-body">
 2697             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodping">SitemapCreator::ping()</a> in SitemapCreator.class.php</div>
 2698                             <div class="index-item-description">Ping search engines</div>
 2699                     </dd>
 2700             <dt class="field">
 2701                         <span class="method-title">prepareHTTPRequestQuery</span>
 2702                     </dt>
 2703         <dd class="index-item-body">
 2704             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodprepareHTTPRequestQuery">PHPCrawlerHTTPRequest::prepareHTTPRequestQuery()</a> in PHPCrawlerHTTPRequest.class.php</div>
 2705                             <div class="index-item-description">Prepares the given HTTP-query-string for the HTTP-request.</div>
 2706                     </dd>
 2707             <dt class="field">
 2708                         <span class="method-title">prepareSitemapsDir</span>
 2709                     </dt>
 2710         <dd class="index-item-body">
 2711             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodprepareSitemapsDir">SitemapCreator::prepareSitemapsDir()</a> in SitemapCreator.class.php</div>
 2712                             <div class="index-item-description">Creates sitemaps directory $sitemaps_dir</div>
 2713                     </dd>
 2714             <dt class="field">
 2715                         <span class="method-title">printAllBenchmarks</span>
 2716                     </dt>
 2717         <dd class="index-item-body">
 2718             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodprintAllBenchmarks">PHPCrawlerBenchmark::printAllBenchmarks()</a> in PHPCrawlerBenchmark.class.php</div>
 2719                     </dd>
 2720             <dt class="field">
 2721                         PRIORITY_CRAWLED_FIRST
 2722                     </dt>
 2723         <dd class="index-item-body">
 2724             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constPRIORITY_CRAWLED_FIRST">SitemapCreator::PRIORITY_CRAWLED_FIRST</a> in SitemapCreator.class.php</div>
 2725                             <div class="index-item-description">Crawled first pages get higher priority</div>
 2726                     </dd>
 2727             <dt class="field">
 2728                         PRIORITY_Disable
 2729                     </dt>
 2730         <dd class="index-item-body">
 2731             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constPRIORITY_Disable">SitemapCreator::PRIORITY_Disable</a> in SitemapCreator.class.php</div>
 2732                             <div class="index-item-description">Disables priority calculations</div>
 2733                     </dd>
 2734             <dt class="field">
 2735                         PRIORITY_URL_STRUCTURE
 2736                     </dt>
 2737         <dd class="index-item-body">
 2738             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constPRIORITY_URL_STRUCTURE">SitemapCreator::PRIORITY_URL_STRUCTURE</a> in SitemapCreator.class.php</div>
 2739                             <div class="index-item-description">Deeper pathes get lower priority</div>
 2740                     </dd>
 2741             <dt class="field">
 2742                         <span class="method-title">processHTTPHeader</span>
 2743                     </dt>
 2744         <dd class="index-item-body">
 2745             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodprocessHTTPHeader">PHPCrawlerLinkFinder::processHTTPHeader()</a> in PHPCrawlerLinkFinder.class.php</div>
 2746                             <div class="index-item-description">Processes the response-header of the document.</div>
 2747                     </dd>
 2748             <dt class="field">
 2749                         <span class="method-title">processRobotsTxt</span>
 2750                     </dt>
 2751         <dd class="index-item-body">
 2752             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodprocessRobotsTxt">PHPCrawler::processRobotsTxt()</a> in PHPCrawler.class.php</div>
 2753                     </dd>
 2754             <dt class="field">
 2755                         <span class="method-title">processUrl</span>
 2756                     </dt>
 2757         <dd class="index-item-body">
 2758             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodprocessUrl">PHPCrawler::processUrl()</a> in PHPCrawler.class.php</div>
 2759                             <div class="index-item-description">Receives and processes the given URL</div>
 2760                     </dd>
 2761             <dt class="field">
 2762                         <span class="method-title">purgeCache</span>
 2763                     </dt>
 2764         <dd class="index-item-body">
 2765             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#methodpurgeCache">PHPCrawlerSQLiteURLCache::purgeCache()</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 2766                             <div class="index-item-description">Cleans/purges the URL-cache from inconsistent entries.</div>
 2767                     </dd>
 2768             <dt class="field">
 2769                         <span class="method-title">purgeCache</span>
 2770                     </dt>
 2771         <dd class="index-item-body">
 2772             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#methodpurgeCache">PHPCrawlerURLCacheBase::purgeCache()</a> in PHPCrawlerURLCacheBase.class.php</div>
 2773                             <div class="index-item-description">Cleans/purges the URL-cache from inconsistent entries.</div>
 2774                     </dd>
 2775             <dt class="field">
 2776                         <span class="method-title">purgeCache</span>
 2777                     </dt>
 2778         <dd class="index-item-body">
 2779             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#methodpurgeCache">PHPCrawlerMemoryURLCache::purgeCache()</a> in PHPCrawlerMemoryURLCache.class.php</div>
 2780                             <div class="index-item-description">Has no function in this class.</div>
 2781                     </dd>
 2782             <dt class="field">
 2783                         <span class="method-title">putContent</span>
 2784                     </dt>
 2785         <dd class="index-item-body">
 2786             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodputContent">SitemapCreator::putContent()</a> in SitemapCreator.class.php</div>
 2787                             <div class="index-item-description">Write XML to disk</div>
 2788                     </dd>
 2789         </dl>
 2790     <a name="q"></a>
 2791     <div class="index-letter-section">
 2792         <div style="float: left" class="index-letter-title">q</div>
 2793         <div style="float: right"><a href="#top">top</a></div>
 2794         <div style="clear: both"></div>
 2795     </div>
 2796     <dl>
 2797             <dt class="field">
 2798                         <span class="var-title">$query</span>
 2799                     </dt>
 2800         <dd class="index-item-body">
 2801             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$query">PHPCrawlerDocumentInfo::$query</a> in PHPCrawlerDocumentInfo.class.php</div>
 2802                             <div class="index-item-description">The query-part of the URL of the requested page or file, e.g. &quot;?x=y&quot;.</div>
 2803                     </dd>
 2804             <dt class="field">
 2805                         <span class="var-title">$queue_max_size</span>
 2806                     </dt>
 2807         <dd class="index-item-body">
 2808             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#var$queue_max_size">PHPCrawlerDocumentInfoQueue::$queue_max_size</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 2809                     </dd>
 2810         </dl>
 2811     <a name="r"></a>
 2812     <div class="index-letter-section">
 2813         <div style="float: left" class="index-letter-title">r</div>
 2814         <div style="float: right"><a href="#top">top</a></div>
 2815         <div style="clear: both"></div>
 2816     </div>
 2817     <dl>
 2818             <dt class="field">
 2819                         <span class="var-title">$received</span>
 2820                     </dt>
 2821         <dd class="index-item-body">
 2822             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$received">PHPCrawlerDocumentInfo::$received</a> in PHPCrawlerDocumentInfo.class.php</div>
 2823                             <div class="index-item-description">Flag indicating whether content was received from the page or file.</div>
 2824                     </dd>
 2825             <dt class="field">
 2826                         <span class="var-title">$received_completely</span>
 2827                     </dt>
 2828         <dd class="index-item-body">
 2829             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$received_completely">PHPCrawlerDocumentInfo::$received_completely</a> in PHPCrawlerDocumentInfo.class.php</div>
 2830                             <div class="index-item-description">Flag indicating whether content was completely received from the page or file.</div>
 2831                     </dd>
 2832             <dt class="field">
 2833                         <span class="var-title">$received_completly</span>
 2834                     </dt>
 2835         <dd class="index-item-body">
 2836             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$received_completly">PHPCrawlerDocumentInfo::$received_completly</a> in PHPCrawlerDocumentInfo.class.php</div>
 2837                             <div class="index-item-description">Alias for received_completely, was spelled wrong in prevoius versions of phpcrawl.</div>
 2838                     </dd>
 2839             <dt class="field">
 2840                         <span class="var-title">$received_to_file</span>
 2841                     </dt>
 2842         <dd class="index-item-body">
 2843             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$received_to_file">PHPCrawlerDocumentInfo::$received_to_file</a> in PHPCrawlerDocumentInfo.class.php</div>
 2844                             <div class="index-item-description">Will be true if the content was received into temporary file.</div>
 2845                     </dd>
 2846             <dt class="field">
 2847                         <span class="var-title">$received_to_memory</span>
 2848                     </dt>
 2849         <dd class="index-item-body">
 2850             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$received_to_memory">PHPCrawlerDocumentInfo::$received_to_memory</a> in PHPCrawlerDocumentInfo.class.php</div>
 2851                             <div class="index-item-description">Will be true if the content was received into local memory.</div>
 2852                     </dd>
 2853             <dt class="field">
 2854                         <span class="var-title">$receive_content_types</span>
 2855                     </dt>
 2856         <dd class="index-item-body">
 2857             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$receive_content_types">PHPCrawlerHTTPRequest::$receive_content_types</a> in PHPCrawlerHTTPRequest.class.php</div>
 2858                             <div class="index-item-description">Contains all rules defining the content-types that should be received</div>
 2859                     </dd>
 2860             <dt class="field">
 2861                         <span class="var-title">$receive_to_file_content_types</span>
 2862                     </dt>
 2863         <dd class="index-item-body">
 2864             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$receive_to_file_content_types">PHPCrawlerHTTPRequest::$receive_to_file_content_types</a> in PHPCrawlerHTTPRequest.class.php</div>
 2865                             <div class="index-item-description">Contains all rules defining the content-types of pages/files that should be streamed directly to  a temporary file (instead of to memory)</div>
 2866                     </dd>
 2867             <dt class="field">
 2868                         <span class="var-title">$referer_url</span>
 2869                     </dt>
 2870         <dd class="index-item-body">
 2871             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$referer_url">PHPCrawlerDocumentInfo::$referer_url</a> in PHPCrawlerDocumentInfo.class.php</div>
 2872                             <div class="index-item-description">The complete URL of the page that contained the link to this document.</div>
 2873                     </dd>
 2874             <dt class="field">
 2875                         <span class="var-title">$refering_linkcode</span>
 2876                     </dt>
 2877         <dd class="index-item-body">
 2878             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$refering_linkcode">PHPCrawlerDocumentInfo::$refering_linkcode</a> in PHPCrawlerDocumentInfo.class.php</div>
 2879                             <div class="index-item-description">The html-sourcecode that contained the link to the current document.</div>
 2880                     </dd>
 2881             <dt class="field">
 2882                         <span class="var-title">$refering_linktext</span>
 2883                     </dt>
 2884         <dd class="index-item-body">
 2885             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$refering_linktext">PHPCrawlerDocumentInfo::$refering_linktext</a> in PHPCrawlerDocumentInfo.class.php</div>
 2886                             <div class="index-item-description">The linktext of the link that &quot;linked&quot; to this document.</div>
 2887                     </dd>
 2888             <dt class="field">
 2889                         <span class="var-title">$refering_link_raw</span>
 2890                     </dt>
 2891         <dd class="index-item-body">
 2892             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$refering_link_raw">PHPCrawlerDocumentInfo::$refering_link_raw</a> in PHPCrawlerDocumentInfo.class.php</div>
 2893                             <div class="index-item-description">Contains the raw link as it was found in the content of the refering URL. (E.g. &quot;../foo.html&quot;)</div>
 2894                     </dd>
 2895             <dt class="field">
 2896                         <span class="var-title">$refering_url</span>
 2897                     </dt>
 2898         <dd class="index-item-body">
 2899             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html#var$refering_url">PHPCrawlerURLDescriptor::$refering_url</a> in PHPCrawlerURLDescriptor.class.php</div>
 2900                             <div class="index-item-description">The URL of the page that contained the link to the URL described here.</div>
 2901                     </dd>
 2902             <dt class="field">
 2903                         <span class="var-title">$responseHeader</span>
 2904                     </dt>
 2905         <dd class="index-item-body">
 2906             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$responseHeader">PHPCrawlerDocumentInfo::$responseHeader</a> in PHPCrawlerDocumentInfo.class.php</div>
 2907                             <div class="index-item-description">The complete HTTP-header the webserver responded with this page or file as a PHPCrawlerResponseHeader-object.</div>
 2908                     </dd>
 2909             <dt class="field">
 2910                         <span class="var-title">$resumtion_enabled</span>
 2911                     </dt>
 2912         <dd class="index-item-body">
 2913             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#var$resumtion_enabled">PHPCrawlerProcessCommunication::$resumtion_enabled</a> in PHPCrawlerProcessCommunication.class.php</div>
 2914                             <div class="index-item-description">Flag indicating whether resumtion is activated</div>
 2915                     </dd>
 2916             <dt class="field">
 2917                         <span class="var-title">$resumtion_enabled</span>
 2918                     </dt>
 2919         <dd class="index-item-body">
 2920             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$resumtion_enabled">PHPCrawler::$resumtion_enabled</a> in PHPCrawler.class.php</div>
 2921                             <div class="index-item-description">Flag indicating whether resumtion is activated</div>
 2922                     </dd>
 2923             <dt class="field">
 2924                         <span class="var-title">$RobotsTxtParser</span>
 2925                     </dt>
 2926         <dd class="index-item-body">
 2927             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$RobotsTxtParser">PHPCrawler::$RobotsTxtParser</a> in PHPCrawler.class.php</div>
 2928                             <div class="index-item-description">The RobotsTxtParser-Object</div>
 2929                     </dd>
 2930             <dt class="field">
 2931                         <span class="method-title">readFromCSV</span>
 2932                     </dt>
 2933         <dd class="index-item-body">
 2934             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodreadFromCSV">SitemapCreator::readFromCSV()</a> in SitemapCreator.class.php</div>
 2935                             <div class="index-item-description">Read from CSV file and add to <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
 2936                     </dd>
 2937             <dt class="field">
 2938                         <span class="method-title">readResponseContent</span>
 2939                     </dt>
 2940         <dd class="index-item-body">
 2941             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodreadResponseContent">PHPCrawlerHTTPRequest::readResponseContent()</a> in PHPCrawlerHTTPRequest.class.php</div>
 2942                             <div class="index-item-description">Reads the response-content.</div>
 2943                     </dd>
 2944             <dt class="field">
 2945                         <span class="method-title">readResponseHeader</span>
 2946                     </dt>
 2947         <dd class="index-item-body">
 2948             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodreadResponseHeader">PHPCrawlerHTTPRequest::readResponseHeader()</a> in PHPCrawlerHTTPRequest.class.php</div>
 2949                             <div class="index-item-description">Reads the response-header.</div>
 2950                     </dd>
 2951             <dt class="field">
 2952                         <span class="method-title">readSitemap</span>
 2953                     </dt>
 2954         <dd class="index-item-body">
 2955             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodreadSitemap">SitemapCreator::readSitemap()</a> in SitemapCreator.class.php</div>
 2956                             <div class="index-item-description">Read sitemap file from disk</div>
 2957                     </dd>
 2958             <dt class="field">
 2959                         <span class="method-title">registerChildPID</span>
 2960                     </dt>
 2961         <dd class="index-item-body">
 2962             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodregisterChildPID">PHPCrawlerProcessCommunication::registerChildPID()</a> in PHPCrawlerProcessCommunication.class.php</div>
 2963                             <div class="index-item-description">Registers the PID of a child-process</div>
 2964                     </dd>
 2965             <dt class="field">
 2966                         <span class="method-title">removeSitemaps</span>
 2967                     </dt>
 2968         <dd class="index-item-body">
 2969             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodremoveSitemaps">SitemapCreator::removeSitemaps()</a> in SitemapCreator.class.php</div>
 2970                             <div class="index-item-description">Delete all sitemap dir and files</div>
 2971                     </dd>
 2972             <dt class="field">
 2973                         <span class="method-title">reset</span>
 2974                     </dt>
 2975         <dd class="index-item-body">
 2976             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodreset">PHPCrawlerBenchmark::reset()</a> in PHPCrawlerBenchmark.class.php</div>
 2977                             <div class="index-item-description">Resets the clock for the given benchmark.</div>
 2978                     </dd>
 2979             <dt class="field">
 2980                         <span class="method-title">resetAll</span>
 2981                     </dt>
 2982         <dd class="index-item-body">
 2983             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodresetAll">PHPCrawlerBenchmark::resetAll()</a> in PHPCrawlerBenchmark.class.php</div>
 2984                             <div class="index-item-description">Resets all clocks for all benchmarks.</div>
 2985                     </dd>
 2986             <dt class="field">
 2987                         <span class="method-title">resetLinkCache</span>
 2988                     </dt>
 2989         <dd class="index-item-body">
 2990             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodresetLinkCache">PHPCrawlerLinkFinder::resetLinkCache()</a> in PHPCrawlerLinkFinder.class.php</div>
 2991                             <div class="index-item-description">Resets/clears the internal link-cache.</div>
 2992                     </dd>
 2993             <dt class="field">
 2994                         <span class="method-title">resume</span>
 2995                     </dt>
 2996         <dd class="index-item-body">
 2997             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodresume">PHPCrawler::resume()</a> in PHPCrawler.class.php</div>
 2998                             <div class="index-item-description">Resumes the crawling-process with the given crawler-ID</div>
 2999                     </dd>
 3000             <dt class="field">
 3001                         <span class="method-title">rmDir</span>
 3002                     </dt>
 3003         <dd class="index-item-body">
 3004             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodrmDir">PHPCrawlerUtils::rmDir()</a> in PHPCrawlerUtils.class.php</div>
 3005                             <div class="index-item-description">Deletes a directory recursivly</div>
 3006                     </dd>
 3007         </dl>
 3008     <a name="s"></a>
 3009     <div class="index-letter-section">
 3010         <div style="float: left" class="index-letter-title">s</div>
 3011         <div style="float: right"><a href="#top">top</a></div>
 3012         <div style="clear: both"></div>
 3013     </div>
 3014     <dl>
 3015             <dt class="field">
 3016                         <span class="var-title">$site</span>
 3017                     </dt>
 3018         <dd class="index-item-body">
 3019             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$site">SitemapCreator::$site</a> in SitemapCreator.class.php</div>
 3020                             <div class="index-item-description">The URL of the website.It should be full qualified and normalized.</div>
 3021                     </dd>
 3022             <dt class="field">
 3023                         <span class="var-title">$sitemaps_count</span>
 3024                     </dt>
 3025         <dd class="index-item-body">
 3026             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$sitemaps_count">SitemapCreator::$sitemaps_count</a> in SitemapCreator.class.php</div>
 3027                             <div class="index-item-description">Number of sitemap files created</div>
 3028                     </dd>
 3029             <dt class="field">
 3030                         <span class="var-title">$sitemaps_dir</span>
 3031                     </dt>
 3032         <dd class="index-item-body">
 3033             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$sitemaps_dir">SitemapCreator::$sitemaps_dir</a> in SitemapCreator.class.php</div>
 3034                             <div class="index-item-description">Sitemaps directory path auto created in prepareSitemapsDir()</div>
 3035                     </dd>
 3036             <dt class="field">
 3037                         <span class="var-title">$sitemaps_url</span>
 3038                     </dt>
 3039         <dd class="index-item-body">
 3040             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$sitemaps_url">SitemapCreator::$sitemaps_url</a> in SitemapCreator.class.php</div>
 3041                             <div class="index-item-description">Sitemap URL where the sitemap file name will be appended to the end of the URL.</div>
 3042                     </dd>
 3043             <dt class="field">
 3044                         <span class="var-title">$socket</span>
 3045                     </dt>
 3046         <dd class="index-item-body">
 3047             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$socket">PHPCrawlerHTTPRequest::$socket</a> in PHPCrawlerHTTPRequest.class.php</div>
 3048                             <div class="index-item-description">The socket used for HTTP-requests</div>
 3049                     </dd>
 3050             <dt class="field">
 3051                         <span class="var-title">$socketConnectTimeout</span>
 3052                     </dt>
 3053         <dd class="index-item-body">
 3054             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$socketConnectTimeout">PHPCrawlerHTTPRequest::$socketConnectTimeout</a> in PHPCrawlerHTTPRequest.class.php</div>
 3055                             <div class="index-item-description">Timeout-value for socket-connection</div>
 3056                     </dd>
 3057             <dt class="field">
 3058                         <span class="var-title">$socketReadTimeout</span>
 3059                     </dt>
 3060         <dd class="index-item-body">
 3061             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$socketReadTimeout">PHPCrawlerHTTPRequest::$socketReadTimeout</a> in PHPCrawlerHTTPRequest.class.php</div>
 3062                             <div class="index-item-description">Socket-read-timeout</div>
 3063                     </dd>
 3064             <dt class="field">
 3065                         <span class="var-title">$source</span>
 3066                     </dt>
 3067         <dd class="index-item-body">
 3068             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$source">PHPCrawlerDocumentInfo::$source</a> in PHPCrawlerDocumentInfo.class.php</div>
 3069                             <div class="index-item-description">Same as &quot;content&quot;, the content of the requested document.</div>
 3070                     </dd>
 3071             <dt class="field">
 3072                         <span class="var-title">$SourceUrl</span>
 3073                     </dt>
 3074         <dd class="index-item-body">
 3075             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$SourceUrl">PHPCrawlerLinkFinder::$SourceUrl</a> in PHPCrawlerLinkFinder.class.php</div>
 3076                             <div class="index-item-description">The URL of the html-source to find links from</div>
 3077                     </dd>
 3078             <dt class="field">
 3079                         <span class="var-title">$source_domain</span>
 3080                     </dt>
 3081         <dd class="index-item-body">
 3082             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$source_domain">PHPCrawlerCookieDescriptor::$source_domain</a> in PHPCrawlerCookieDescriptor.class.php</div>
 3083                             <div class="index-item-description">The domain the cookie was send from</div>
 3084                     </dd>
 3085             <dt class="field">
 3086                         <span class="var-title">$source_url</span>
 3087                     </dt>
 3088         <dd class="index-item-body">
 3089             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerResponseHeader.html#var$source_url">PHPCrawlerResponseHeader::$source_url</a> in PHPCrawlerResponseHeader.class.php</div>
 3090                             <div class="index-item-description">The URL of the website the header was recevied from.</div>
 3091                     </dd>
 3092             <dt class="field">
 3093                         <span class="var-title">$source_url</span>
 3094                     </dt>
 3095         <dd class="index-item-body">
 3096             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$source_url">PHPCrawlerCookieDescriptor::$source_url</a> in PHPCrawlerCookieDescriptor.class.php</div>
 3097                             <div class="index-item-description">The URL the cookie was send from</div>
 3098                     </dd>
 3099             <dt class="field">
 3100                         <span class="var-title">$sqlite_db_file</span>
 3101                     </dt>
 3102         <dd class="index-item-body">
 3103             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteCookieCache.html#var$sqlite_db_file">PHPCrawlerSQLiteCookieCache::$sqlite_db_file</a> in PHPCrawlerSQLiteCookieCache.class.php</div>
 3104                     </dd>
 3105             <dt class="field">
 3106                         <span class="var-title">$sqlite_db_file</span>
 3107                     </dt>
 3108         <dd class="index-item-body">
 3109             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerSQLiteURLCache.html#var$sqlite_db_file">PHPCrawlerSQLiteURLCache::$sqlite_db_file</a> in PHPCrawlerSQLiteURLCache.class.php</div>
 3110                     </dd>
 3111             <dt class="field">
 3112                         <span class="var-title">$sqlite_db_file</span>
 3113                     </dt>
 3114         <dd class="index-item-body">
 3115             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfoQueue.html#var$sqlite_db_file">PHPCrawlerDocumentInfoQueue::$sqlite_db_file</a> in PHPCrawlerDocumentInfoQueue.class.php</div>
 3116                     </dd>
 3117             <dt class="field">
 3118                         <span class="var-title">$starting_url</span>
 3119                     </dt>
 3120         <dd class="index-item-body">
 3121             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$starting_url">PHPCrawler::$starting_url</a> in PHPCrawler.class.php</div>
 3122                             <div class="index-item-description">The URL the crawler should start with.</div>
 3123                     </dd>
 3124             <dt class="field">
 3125                         <span class="var-title">$starting_url</span>
 3126                     </dt>
 3127         <dd class="index-item-body">
 3128             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$starting_url">PHPCrawlerURLFilter::$starting_url</a> in PHPCrawlerURLFilter.class.php</div>
 3129                             <div class="index-item-description">The full qualified and normalized URL the crawling-prpocess was started with.</div>
 3130                     </dd>
 3131             <dt class="field">
 3132                         <span class="var-title">$starting_url_parts</span>
 3133                     </dt>
 3134         <dd class="index-item-body">
 3135             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$starting_url_parts">PHPCrawlerURLFilter::$starting_url_parts</a> in PHPCrawlerURLFilter.class.php</div>
 3136                             <div class="index-item-description">The URL-parts of the starting-url.</div>
 3137                     </dd>
 3138             <dt class="field">
 3139                         <span class="method-title">sendRequest</span>
 3140                     </dt>
 3141         <dd class="index-item-body">
 3142             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsendRequest">PHPCrawlerHTTPRequest::sendRequest()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3143                             <div class="index-item-description">Sends the HTTP-request and receives the page/file.</div>
 3144                     </dd>
 3145             <dt class="field">
 3146                         <span class="method-title">sendRequestHeader</span>
 3147                     </dt>
 3148         <dd class="index-item-body">
 3149             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsendRequestHeader">PHPCrawlerHTTPRequest::sendRequestHeader()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3150                             <div class="index-item-description">Send the request-header.</div>
 3151                     </dd>
 3152             <dt class="field">
 3153                         <span class="method-title">serializeToFile</span>
 3154                     </dt>
 3155         <dd class="index-item-body">
 3156             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodserializeToFile">PHPCrawlerUtils::serializeToFile()</a> in PHPCrawlerUtils.class.php</div>
 3157                             <div class="index-item-description">Serializes data (objects, arrayse etc.) and writes it to the given file.</div>
 3158                     </dd>
 3159             <dt class="field">
 3160                         <span class="method-title">setAggressiveLinkExtraction</span>
 3161                     </dt>
 3162         <dd class="index-item-body">
 3163             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetAggressiveLinkExtraction">PHPCrawler::setAggressiveLinkExtraction()</a> in PHPCrawler.class.php</div>
 3164                             <div class="index-item-description">Alias for enableAggressiveLinkSearch()</div>
 3165                     </dd>
 3166             <dt class="field">
 3167                         <span class="method-title">setBaseURL</span>
 3168                     </dt>
 3169         <dd class="index-item-body">
 3170             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodsetBaseURL">PHPCrawlerURLFilter::setBaseURL()</a> in PHPCrawlerURLFilter.class.php</div>
 3171                             <div class="index-item-description">Sets the base-URL of the crawling process some rules relate to</div>
 3172                     </dd>
 3173             <dt class="field">
 3174                         <span class="method-title">setBasicAuthentication</span>
 3175                     </dt>
 3176         <dd class="index-item-body">
 3177             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetBasicAuthentication">PHPCrawlerHTTPRequest::setBasicAuthentication()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3178                             <div class="index-item-description">Sets basic-authentication login-data for protected URLs.</div>
 3179                     </dd>
 3180             <dt class="field">
 3181                         <span class="method-title">setConnectionTimeout</span>
 3182                     </dt>
 3183         <dd class="index-item-body">
 3184             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetConnectionTimeout">PHPCrawler::setConnectionTimeout()</a> in PHPCrawler.class.php</div>
 3185                             <div class="index-item-description">Sets the timeout in seconds for connection tries to hosting webservers.</div>
 3186                     </dd>
 3187             <dt class="field">
 3188                         <span class="method-title">setContentSizeLimit</span>
 3189                     </dt>
 3190         <dd class="index-item-body">
 3191             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetContentSizeLimit">PHPCrawler::setContentSizeLimit()</a> in PHPCrawler.class.php</div>
 3192                             <div class="index-item-description">Sets the content-size-limit for content the crawler should receive from documents.</div>
 3193                     </dd>
 3194             <dt class="field">
 3195                         <span class="method-title">setContentSizeLimit</span>
 3196                     </dt>
 3197         <dd class="index-item-body">
 3198             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetContentSizeLimit">PHPCrawlerHTTPRequest::setContentSizeLimit()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3199                             <div class="index-item-description">Sets the size-limit in bytes for content the request should receive.</div>
 3200                     </dd>
 3201             <dt class="field">
 3202                         <span class="method-title">setCookieHandling</span>
 3203                     </dt>
 3204         <dd class="index-item-body">
 3205             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetCookieHandling">PHPCrawler::setCookieHandling()</a> in PHPCrawler.class.php</div>
 3206                             <div class="index-item-description">Alias for enableCookieHandling()</div>
 3207                     </dd>
 3208             <dt class="field">
 3209                         <span class="method-title">setCrawlerDefaults</span>
 3210                     </dt>
 3211         <dd class="index-item-body">
 3212             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetCrawlerDefaults">SitemapCreator::setCrawlerDefaults()</a> in SitemapCreator.class.php</div>
 3213                             <div class="index-item-description">Load default crawler settings for $Crawler</div>
 3214                     </dd>
 3215             <dt class="field">
 3216                         <span class="method-title">setCrawlerStatus</span>
 3217                     </dt>
 3218         <dd class="index-item-body">
 3219             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodsetCrawlerStatus">PHPCrawlerProcessCommunication::setCrawlerStatus()</a> in PHPCrawlerProcessCommunication.class.php</div>
 3220                             <div class="index-item-description">Sets/writes the current crawler-status</div>
 3221                     </dd>
 3222             <dt class="field">
 3223                         <span class="method-title">setDataDir</span>
 3224                     </dt>
 3225         <dd class="index-item-body">
 3226             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetDataDir">SitemapCreator::setDataDir()</a> in SitemapCreator.class.php</div>
 3227                             <div class="index-item-description">Sets the data directory path of the sitemaps $data_dir</div>
 3228                     </dd>
 3229             <dt class="field">
 3230                         <span class="method-title">setEntries</span>
 3231                     </dt>
 3232         <dd class="index-item-body">
 3233             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetEntries">SitemapCreator::setEntries()</a> in SitemapCreator.class.php</div>
 3234                             <div class="index-item-description">Set the URLs sets manually <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
 3235                     </dd>
 3236             <dt class="field">
 3237                         <span class="method-title">setEntriesPerSitemap</span>
 3238                     </dt>
 3239         <dd class="index-item-body">
 3240             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetEntriesPerSitemap">SitemapCreator::setEntriesPerSitemap()</a> in SitemapCreator.class.php</div>
 3241                             <div class="index-item-description">Sets number of URLs set for each sitemap file $entries_per_sitemap</div>
 3242                     </dd>
 3243             <dt class="field">
 3244                         <span class="method-title">setFindRedirectURLs</span>
 3245                     </dt>
 3246         <dd class="index-item-body">
 3247             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetFindRedirectURLs">PHPCrawlerHTTPRequest::setFindRedirectURLs()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3248                             <div class="index-item-description">Specifies whether redirect-links set in http-headers should get searched for.</div>
 3249                     </dd>
 3250             <dt class="field">
 3251                         <span class="method-title">setFollowMode</span>
 3252                     </dt>
 3253         <dd class="index-item-body">
 3254             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetFollowMode">PHPCrawler::setFollowMode()</a> in PHPCrawler.class.php</div>
 3255                             <div class="index-item-description">Sets the basic follow-mode of the crawler.</div>
 3256                     </dd>
 3257             <dt class="field">
 3258                         <span class="method-title">setFollowRedirects</span>
 3259                     </dt>
 3260         <dd class="index-item-body">
 3261             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetFollowRedirects">PHPCrawler::setFollowRedirects()</a> in PHPCrawler.class.php</div>
 3262                             <div class="index-item-description">Defines whether the crawler should follow redirects sent with headers by a webserver or not.</div>
 3263                     </dd>
 3264             <dt class="field">
 3265                         <span class="method-title">setFollowRedirectsTillContent</span>
 3266                     </dt>
 3267         <dd class="index-item-body">
 3268             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetFollowRedirectsTillContent">PHPCrawler::setFollowRedirectsTillContent()</a> in PHPCrawler.class.php</div>
 3269                             <div class="index-item-description">Defines whether the crawler should follow HTTP-redirects until first content was found, regardless of defined filter-rules and follow-modes.</div>
 3270                     </dd>
 3271             <dt class="field">
 3272                         <span class="method-title">setFrequency</span>
 3273                     </dt>
 3274         <dd class="index-item-body">
 3275             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetFrequency">SitemapCreator::setFrequency()</a> in SitemapCreator.class.php</div>
 3276                             <div class="index-item-description">Set Frequency mode $frequency_mode</div>
 3277                     </dd>
 3278             <dt class="field">
 3279                         <span class="method-title">setHeaderCheckCallbackFunction</span>
 3280                     </dt>
 3281         <dd class="index-item-body">
 3282             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetHeaderCheckCallbackFunction">PHPCrawlerHTTPRequest::setHeaderCheckCallbackFunction()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3283                     </dd>
 3284             <dt class="field">
 3285                         <span class="method-title">setLinkExtractionTags</span>
 3286                     </dt>
 3287         <dd class="index-item-body">
 3288             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetLinkExtractionTags">PHPCrawler::setLinkExtractionTags()</a> in PHPCrawler.class.php</div>
 3289                             <div class="index-item-description">Sets the list of html-tags the crawler should search for links in.</div>
 3290                     </dd>
 3291             <dt class="field">
 3292                         <span class="method-title">setLinkExtractionTags</span>
 3293                     </dt>
 3294         <dd class="index-item-body">
 3295             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetLinkExtractionTags">PHPCrawlerHTTPRequest::setLinkExtractionTags()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3296                             <div class="index-item-description">Sets the html-tags from which to extract/find links from.</div>
 3297                     </dd>
 3298             <dt class="field">
 3299                         <span class="method-title">setLinksFoundArray</span>
 3300                     </dt>
 3301         <dd class="index-item-body">
 3302             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#methodsetLinksFoundArray">PHPCrawlerDocumentInfo::setLinksFoundArray()</a> in PHPCrawlerDocumentInfo.class.php</div>
 3303                             <div class="index-item-description">Workaround-method, copies and converts the array $links_found_url_descriptors to $links_found.</div>
 3304                     </dd>
 3305             <dt class="field">
 3306                         <span class="method-title">setMinFrequency</span>
 3307                     </dt>
 3308         <dd class="index-item-body">
 3309             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetMinFrequency">SitemapCreator::setMinFrequency()</a> in SitemapCreator.class.php</div>
 3310                             <div class="index-item-description">Set minimum Frequency value for all URLs $min_priority</div>
 3311                     </dd>
 3312             <dt class="field">
 3313                         <span class="method-title">setMinPriority</span>
 3314                     </dt>
 3315         <dd class="index-item-body">
 3316             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetMinPriority">SitemapCreator::setMinPriority()</a> in SitemapCreator.class.php</div>
 3317                             <div class="index-item-description">Set minimum Priority value for all URLs $min_priority</div>
 3318                     </dd>
 3319             <dt class="field">
 3320                         <span class="method-title">setPageLimit</span>
 3321                     </dt>
 3322         <dd class="index-item-body">
 3323             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetPageLimit">PHPCrawler::setPageLimit()</a> in PHPCrawler.class.php</div>
 3324                             <div class="index-item-description">Sets a limit to the number of pages/files the crawler should follow.</div>
 3325                     </dd>
 3326             <dt class="field">
 3327                         <span class="method-title">setPort</span>
 3328                     </dt>
 3329         <dd class="index-item-body">
 3330             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetPort">PHPCrawler::setPort()</a> in PHPCrawler.class.php</div>
 3331                             <div class="index-item-description">Sets the port to connect to for crawling the starting-url set in setUrl().</div>
 3332                     </dd>
 3333             <dt class="field">
 3334                         <span class="method-title">setPriority</span>
 3335                     </dt>
 3336         <dd class="index-item-body">
 3337             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetPriority">SitemapCreator::setPriority()</a> in SitemapCreator.class.php</div>
 3338                             <div class="index-item-description">Set Priority mode $priority_mode</div>
 3339                     </dd>
 3340             <dt class="field">
 3341                         <span class="method-title">setProxy</span>
 3342                     </dt>
 3343         <dd class="index-item-body">
 3344             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetProxy">PHPCrawler::setProxy()</a> in PHPCrawler.class.php</div>
 3345                             <div class="index-item-description">Assigns a proxy-server the crawler should use for all HTTP-Requests.</div>
 3346                     </dd>
 3347             <dt class="field">
 3348                         <span class="method-title">setProxy</span>
 3349                     </dt>
 3350         <dd class="index-item-body">
 3351             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetProxy">PHPCrawlerHTTPRequest::setProxy()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3352                     </dd>
 3353             <dt class="field">
 3354                         <span class="method-title">setSite</span>
 3355                     </dt>
 3356         <dd class="index-item-body">
 3357             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetSite">SitemapCreator::setSite()</a> in SitemapCreator.class.php</div>
 3358                             <div class="index-item-description">Sets the URL of the website $site</div>
 3359                     </dd>
 3360             <dt class="field">
 3361                         <span class="method-title">setSitemapURL</span>
 3362                     </dt>
 3363         <dd class="index-item-body">
 3364             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetSitemapURL">SitemapCreator::setSitemapURL()</a> in SitemapCreator.class.php</div>
 3365                             <div class="index-item-description">Sets the URL of the sitemap files $sitemaps_url</div>
 3366                     </dd>
 3367             <dt class="field">
 3368                         <span class="method-title">setSourceUrl</span>
 3369                     </dt>
 3370         <dd class="index-item-body">
 3371             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#methodsetSourceUrl">PHPCrawlerLinkFinder::setSourceUrl()</a> in PHPCrawlerLinkFinder.class.php</div>
 3372                             <div class="index-item-description">Sets the source-URL of the document to find links in</div>
 3373                     </dd>
 3374             <dt class="field">
 3375                         <span class="method-title">setStreamTimeout</span>
 3376                     </dt>
 3377         <dd class="index-item-body">
 3378             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetStreamTimeout">PHPCrawler::setStreamTimeout()</a> in PHPCrawler.class.php</div>
 3379                             <div class="index-item-description">Sets the timeout in seconds for waiting for data on an established server-connection.</div>
 3380                     </dd>
 3381             <dt class="field">
 3382                         <span class="method-title">setTmpFile</span>
 3383                     </dt>
 3384         <dd class="index-item-body">
 3385             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetTmpFile">PHPCrawlerHTTPRequest::setTmpFile()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3386                             <div class="index-item-description">Sets the temporary file to use when content of found documents should be streamed directly into a temporary file.</div>
 3387                     </dd>
 3388             <dt class="field">
 3389                         <span class="method-title">setTmpFile</span>
 3390                     </dt>
 3391         <dd class="index-item-body">
 3392             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetTmpFile">PHPCrawler::setTmpFile()</a> in PHPCrawler.class.php</div>
 3393                             <div class="index-item-description">Has no function anymore.</div>
 3394                     </dd>
 3395             <dt class="field">
 3396                         <span class="method-title">setTrafficLimit</span>
 3397                     </dt>
 3398         <dd class="index-item-body">
 3399             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetTrafficLimit">PHPCrawler::setTrafficLimit()</a> in PHPCrawler.class.php</div>
 3400                             <div class="index-item-description">Sets a limit to the number of bytes the crawler should receive alltogether during crawling-process.</div>
 3401                     </dd>
 3402             <dt class="field">
 3403                         <span class="method-title">setUrl</span>
 3404                     </dt>
 3405         <dd class="index-item-body">
 3406             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#methodsetUrl">PHPCrawlerHTTPRequest::setUrl()</a> in PHPCrawlerHTTPRequest.class.php</div>
 3407                             <div class="index-item-description">Sets the URL for the request.</div>
 3408                     </dd>
 3409             <dt class="field">
 3410                         <span class="method-title">setURL</span>
 3411                     </dt>
 3412         <dd class="index-item-body">
 3413             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetURL">PHPCrawler::setURL()</a> in PHPCrawler.class.php</div>
 3414                             <div class="index-item-description">Sets the URL of the first page the crawler should crawl (root-page).</div>
 3415                     </dd>
 3416             <dt class="field">
 3417                         <span class="method-title">setUrlCacheType</span>
 3418                     </dt>
 3419         <dd class="index-item-body">
 3420             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetUrlCacheType">PHPCrawler::setUrlCacheType()</a> in PHPCrawler.class.php</div>
 3421                             <div class="index-item-description">Defines what type of cache will be internally used for caching URLs.</div>
 3422                     </dd>
 3423             <dt class="field">
 3424                         <span class="method-title">setUserAgentString</span>
 3425                     </dt>
 3426         <dd class="index-item-body">
 3427             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetUserAgentString">PHPCrawler::setUserAgentString()</a> in PHPCrawler.class.php</div>
 3428                             <div class="index-item-description">Sets the &quot;User-Agent&quot; identification-string that will be send with HTTP-requests.</div>
 3429                     </dd>
 3430             <dt class="field">
 3431                         <span class="method-title">setWorkingDirectory</span>
 3432                     </dt>
 3433         <dd class="index-item-body">
 3434             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodsetWorkingDirectory">PHPCrawler::setWorkingDirectory()</a> in PHPCrawler.class.php</div>
 3435                             <div class="index-item-description">Sets the working-directory the crawler should use for storing temporary data.</div>
 3436                     </dd>
 3437             <dt class="field">
 3438                         SitemapCreator
 3439                     </dt>
 3440         <dd class="index-item-body">
 3441             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html">SitemapCreator</a> in SitemapCreator.class.php</div>
 3442                             <div class="index-item-description">Sitemap Creator creates XML sitemaps files compatible with the standard  sitemaps.org protocol and supported by Google and Bing.</div>
 3443                     </dd>
 3444             <dt class="field">
 3445                         <span class="include-title">SitemapCreator.class.php</span>
 3446                     </dt>
 3447         <dd class="index-item-body">
 3448             <div class="index-item-details"><a href="SitemapCreator/_SitemapCreator.class.php.html">SitemapCreator.class.php</a> in SitemapCreator.class.php</div>
 3449                     </dd>
 3450             <dt class="field">
 3451                         <span class="include-title">SitemapCreatorCrawler.class.php</span>
 3452                     </dt>
 3453         <dd class="index-item-body">
 3454             <div class="index-item-details"><a href="SitemapCreator/_SitemapCreatorCrawler.class.php.html">SitemapCreatorCrawler.class.php</a> in SitemapCreatorCrawler.class.php</div>
 3455                     </dd>
 3456             <dt class="field">
 3457                         SMCCrawler
 3458                     </dt>
 3459         <dd class="index-item-body">
 3460             <div class="index-item-details"><a href="phpcrawl/SMCCrawler.html">SMCCrawler</a> in SitemapCreatorCrawler.class.php</div>
 3461                             <div class="index-item-description">Loading external PHPCrawler-class</div>
 3462                     </dd>
 3463             <dt class="field">
 3464                         <span class="method-title">sort2dArray</span>
 3465                     </dt>
 3466         <dd class="index-item-body">
 3467             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodsort2dArray">PHPCrawlerUtils::sort2dArray()</a> in PHPCrawlerUtils.class.php</div>
 3468                             <div class="index-item-description">Sorts a twodimensiolnal array.</div>
 3469                     </dd>
 3470             <dt class="field">
 3471                         <span class="method-title">splitURL</span>
 3472                     </dt>
 3473         <dd class="index-item-body">
 3474             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUtils.html#methodsplitURL">PHPCrawlerUtils::splitURL()</a> in PHPCrawlerUtils.class.php</div>
 3475                             <div class="index-item-description">Splits an URL into its parts</div>
 3476                     </dd>
 3477             <dt class="field">
 3478                         <span class="method-title">starControllerProcessLoop</span>
 3479                     </dt>
 3480         <dd class="index-item-body">
 3481             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodstarControllerProcessLoop">PHPCrawler::starControllerProcessLoop()</a> in PHPCrawler.class.php</div>
 3482                             <div class="index-item-description">Starts the loop of the controller-process (main-process).</div>
 3483                     </dd>
 3484             <dt class="field">
 3485                         <span class="method-title">start</span>
 3486                     </dt>
 3487         <dd class="index-item-body">
 3488             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodstart">PHPCrawlerBenchmark::start()</a> in PHPCrawlerBenchmark.class.php</div>
 3489                             <div class="index-item-description">Starts the clock for the given benchmark.</div>
 3490                     </dd>
 3491             <dt class="field">
 3492                         <span class="method-title">startChildProcessLoop</span>
 3493                     </dt>
 3494         <dd class="index-item-body">
 3495             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#methodstartChildProcessLoop">PHPCrawler::startChildProcessLoop()</a> in PHPCrawler.class.php</div>
 3496                             <div class="index-item-description">Starts the loop of a child-process.</div>
 3497                     </dd>
 3498             <dt class="field">
 3499                         <span class="method-title">stop</span>
 3500                     </dt>
 3501         <dd class="index-item-body">
 3502             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#methodstop">PHPCrawlerBenchmark::stop()</a> in PHPCrawlerBenchmark.class.php</div>
 3503                             <div class="index-item-description">Stops the benchmark-clock for the given benchmark.</div>
 3504                     </dd>
 3505         </dl>
 3506     <a name="t"></a>
 3507     <div class="index-letter-section">
 3508         <div style="float: left" class="index-letter-title">t</div>
 3509         <div style="float: right"><a href="#top">top</a></div>
 3510         <div style="clear: both"></div>
 3511     </div>
 3512     <dl>
 3513             <dt class="field">
 3514                         <span class="var-title">$temporary_benchmarks</span>
 3515                     </dt>
 3516         <dd class="index-item-body">
 3517             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerBenchmark.html#var$temporary_benchmarks">PHPCrawlerBenchmark::$temporary_benchmarks</a> in PHPCrawlerBenchmark.class.php</div>
 3518                     </dd>
 3519             <dt class="field">
 3520                         <span class="var-title">$tmpFile</span>
 3521                     </dt>
 3522         <dd class="index-item-body">
 3523             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$tmpFile">PHPCrawlerHTTPRequest::$tmpFile</a> in PHPCrawlerHTTPRequest.class.php</div>
 3524                             <div class="index-item-description">The TMP-File to use when a page/file should be streamed to file.</div>
 3525                     </dd>
 3526             <dt class="field">
 3527                         <span class="var-title">$top_lines_processed</span>
 3528                     </dt>
 3529         <dd class="index-item-body">
 3530             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerLinkFinder.html#var$top_lines_processed">PHPCrawlerLinkFinder::$top_lines_processed</a> in PHPCrawlerLinkFinder.class.php</div>
 3531                             <div class="index-item-description">Flag indicating whether the top lines of the HTML-source were processed.</div>
 3532                     </dd>
 3533             <dt class="field">
 3534                         <span class="var-title">$traffic_limit</span>
 3535                     </dt>
 3536         <dd class="index-item-body">
 3537             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$traffic_limit">PHPCrawler::$traffic_limit</a> in PHPCrawler.class.php</div>
 3538                             <div class="index-item-description">Limit of bytes to receive</div>
 3539                     </dd>
 3540             <dt class="field">
 3541                         <span class="var-title">$traffic_limit_reached</span>
 3542                     </dt>
 3543         <dd class="index-item-body">
 3544             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$traffic_limit_reached">PHPCrawlerProcessReport::$traffic_limit_reached</a> in PHPCrawlerProcessReport.class.php</div>
 3545                             <div class="index-item-description">Will be TRUE if the crawling-process stopped becaus the traffic-limit was reached.</div>
 3546                     </dd>
 3547             <dt class="field">
 3548                         <span class="var-title">$traffic_limit_reached</span>
 3549                     </dt>
 3550         <dd class="index-item-body">
 3551             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$traffic_limit_reached">PHPCrawlerDocumentInfo::$traffic_limit_reached</a> in PHPCrawlerDocumentInfo.class.php</div>
 3552                             <div class="index-item-description">Indicated whether the traffic-limit set by the user was reached after downloading this document.</div>
 3553                     </dd>
 3554             <dt class="field">
 3555                         <span class="method-title">toArray</span>
 3556                     </dt>
 3557         <dd class="index-item-body">
 3558             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerUrlPartsDescriptor.html#methodtoArray">PHPCrawlerUrlPartsDescriptor::toArray()</a> in PHPCrawlerUrlPartsDescriptor.class.php</div>
 3559                     </dd>
 3560             <dt class="field">
 3561                         <span class="method-title">toArray</span>
 3562                     </dt>
 3563         <dd class="index-item-body">
 3564             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#methodtoArray">PHPCrawlerProcessReport::toArray()</a> in PHPCrawlerProcessReport.class.php</div>
 3565                             <div class="index-item-description">Returns an array with all properties of this class.</div>
 3566                     </dd>
 3567             <dt class="field">
 3568                         <span class="method-title">toArray</span>
 3569                     </dt>
 3570         <dd class="index-item-body">
 3571             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#methodtoArray">PHPCrawlerDocumentInfo::toArray()</a> in PHPCrawlerDocumentInfo.class.php</div>
 3572                             <div class="index-item-description">Returns an array with all properties of this class.</div>
 3573                     </dd>
 3574         </dl>
 3575     <a name="u"></a>
 3576     <div class="index-letter-section">
 3577         <div style="float: left" class="index-letter-title">u</div>
 3578         <div style="float: right"><a href="#top">top</a></div>
 3579         <div style="clear: both"></div>
 3580     </div>
 3581     <dl>
 3582             <dt class="field">
 3583                         <span class="var-title">$url</span>
 3584                     </dt>
 3585         <dd class="index-item-body">
 3586             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDocumentInfo.html#var$url">PHPCrawlerDocumentInfo::$url</a> in PHPCrawlerDocumentInfo.class.php</div>
 3587                             <div class="index-item-description">The complete, full qualified URL of the page or file, e.g. &quot;http://www.foo.com/bar/page.html?x=y&quot;.</div>
 3588                     </dd>
 3589             <dt class="field">
 3590                         <span class="var-title">$urlcache_purged</span>
 3591                     </dt>
 3592         <dd class="index-item-body">
 3593             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$urlcache_purged">PHPCrawler::$urlcache_purged</a> in PHPCrawler.class.php</div>
 3594                             <div class="index-item-description">Flag indicating whether the URL-cahce was purged at the beginning of a crawling-process</div>
 3595                     </dd>
 3596             <dt class="field">
 3597                         <span class="var-title">$UrlDescriptor</span>
 3598                     </dt>
 3599         <dd class="index-item-body">
 3600             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$UrlDescriptor">PHPCrawlerHTTPRequest::$UrlDescriptor</a> in PHPCrawlerHTTPRequest.class.php</div>
 3601                             <div class="index-item-description">The URL for the request as PHPCrawlerURLDescriptor-object</div>
 3602                     </dd>
 3603             <dt class="field">
 3604                         <span class="var-title">$UrlFilter</span>
 3605                     </dt>
 3606         <dd class="index-item-body">
 3607             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$UrlFilter">PHPCrawler::$UrlFilter</a> in PHPCrawler.class.php</div>
 3608                             <div class="index-item-description">The UrlFilter-Object</div>
 3609                     </dd>
 3610             <dt class="field">
 3611                         <span class="var-title">$urls</span>
 3612                     </dt>
 3613         <dd class="index-item-body">
 3614             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#var$urls">PHPCrawlerMemoryURLCache::$urls</a> in PHPCrawlerMemoryURLCache.class.php</div>
 3615                     </dd>
 3616             <dt class="field">
 3617                         <span class="var-title">$url_cache_type</span>
 3618                     </dt>
 3619         <dd class="index-item-body">
 3620             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$url_cache_type">PHPCrawler::$url_cache_type</a> in PHPCrawler.class.php</div>
 3621                             <div class="index-item-description">URl cache-type.</div>
 3622                     </dd>
 3623             <dt class="field">
 3624                         <span class="var-title">$url_distinct_property</span>
 3625                     </dt>
 3626         <dd class="index-item-body">
 3627             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#var$url_distinct_property">PHPCrawlerURLCacheBase::$url_distinct_property</a> in PHPCrawlerURLCacheBase.class.php</div>
 3628                             <div class="index-item-description">Defines which property of an URL is used to ensure that each URL is only cached once.</div>
 3629                     </dd>
 3630             <dt class="field">
 3631                         <span class="var-title">$url_filter_rules</span>
 3632                     </dt>
 3633         <dd class="index-item-body">
 3634             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$url_filter_rules">PHPCrawlerURLFilter::$url_filter_rules</a> in PHPCrawlerURLFilter.class.php</div>
 3635                             <div class="index-item-description">Array containing regex-rules for URLs that should NOT be followed.</div>
 3636                     </dd>
 3637             <dt class="field">
 3638                         <span class="var-title">$url_follow_rules</span>
 3639                     </dt>
 3640         <dd class="index-item-body">
 3641             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#var$url_follow_rules">PHPCrawlerURLFilter::$url_follow_rules</a> in PHPCrawlerURLFilter.class.php</div>
 3642                             <div class="index-item-description">Array containing regex-rules for URLs that should be followed.</div>
 3643                     </dd>
 3644             <dt class="field">
 3645                         <span class="var-title">$url_map</span>
 3646                     </dt>
 3647         <dd class="index-item-body">
 3648             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerMemoryURLCache.html#var$url_map">PHPCrawlerMemoryURLCache::$url_map</a> in PHPCrawlerMemoryURLCache.class.php</div>
 3649                     </dd>
 3650             <dt class="field">
 3651                         <span class="var-title">$url_parts</span>
 3652                     </dt>
 3653         <dd class="index-item-body">
 3654             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$url_parts">PHPCrawlerHTTPRequest::$url_parts</a> in PHPCrawlerHTTPRequest.class.php</div>
 3655                             <div class="index-item-description">The parts of the URL for the request as returned by PHPCrawlerUtils::splitURL()</div>
 3656                     </dd>
 3657             <dt class="field">
 3658                         <span class="var-title">$url_priorities</span>
 3659                     </dt>
 3660         <dd class="index-item-body">
 3661             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#var$url_priorities">PHPCrawlerURLCacheBase::$url_priorities</a> in PHPCrawlerURLCacheBase.class.php</div>
 3662                     </dd>
 3663             <dt class="field">
 3664                         <span class="var-title">$url_rebuild</span>
 3665                     </dt>
 3666         <dd class="index-item-body">
 3667             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLDescriptor.html#var$url_rebuild">PHPCrawlerURLDescriptor::$url_rebuild</a> in PHPCrawlerURLDescriptor.class.php</div>
 3668                             <div class="index-item-description">The complete, full qualified and normalized URL</div>
 3669                     </dd>
 3670             <dt class="field">
 3671                         <span class="var-title">$useragent</span>
 3672                     </dt>
 3673         <dd class="index-item-body">
 3674             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$useragent">SitemapCreator::$useragent</a> in SitemapCreator.class.php</div>
 3675                     </dd>
 3676             <dt class="field">
 3677                         <span class="var-title">$userAgentString</span>
 3678                     </dt>
 3679         <dd class="index-item-body">
 3680             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerHTTPRequest.html#var$userAgentString">PHPCrawlerHTTPRequest::$userAgentString</a> in PHPCrawlerHTTPRequest.class.php</div>
 3681                             <div class="index-item-description">The user-agent-string</div>
 3682                     </dd>
 3683             <dt class="field">
 3684                         <span class="var-title">$UserSendDataCache</span>
 3685                     </dt>
 3686         <dd class="index-item-body">
 3687             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$UserSendDataCache">PHPCrawler::$UserSendDataCache</a> in PHPCrawler.class.php</div>
 3688                             <div class="index-item-description">UserSendDataCahce-object.</div>
 3689                     </dd>
 3690             <dt class="field">
 3691                         <span class="var-title">$user_abort</span>
 3692                     </dt>
 3693         <dd class="index-item-body">
 3694             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessReport.html#var$user_abort">PHPCrawlerProcessReport::$user_abort</a> in PHPCrawlerProcessReport.class.php</div>
 3695                             <div class="index-item-description">Will be TRUE if the crawling-process stopped because the overridable function handleDocumentInfo() returned a negative value.</div>
 3696                     </dd>
 3697             <dt class="field">
 3698                         <span class="var-title">$use_gzip</span>
 3699                     </dt>
 3700         <dd class="index-item-body">
 3701             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$use_gzip">SitemapCreator::$use_gzip</a> in SitemapCreator.class.php</div>
 3702                             <div class="index-item-description">choose to save sitemaps in gzip format</div>
 3703                     </dd>
 3704             <dt class="field">
 3705                         <span class="method-title">updateCrawlerStatus</span>
 3706                     </dt>
 3707         <dd class="index-item-body">
 3708             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerProcessCommunication.html#methodupdateCrawlerStatus">PHPCrawlerProcessCommunication::updateCrawlerStatus()</a> in PHPCrawlerProcessCommunication.class.php</div>
 3709                             <div class="index-item-description">Updates the status of the crawler</div>
 3710                     </dd>
 3711             <dt class="field">
 3712                         URLCACHE_MEMORY
 3713                     </dt>
 3714         <dd class="index-item-body">
 3715             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerUrlCacheTypes.html#constURLCACHE_MEMORY">PHPCrawlerUrlCacheTypes::URLCACHE_MEMORY</a> in PHPCrawlerUrlCacheTypes.class.php</div>
 3716                             <div class="index-item-description">URLs get cached in local RAM. Best performance.</div>
 3717                     </dd>
 3718             <dt class="field">
 3719                         URLCACHE_SQLITE
 3720                     </dt>
 3721         <dd class="index-item-body">
 3722             <div class="index-item-details"><a href="phpcrawl-enums/PHPCrawlerUrlCacheTypes.html#constURLCACHE_SQLITE">PHPCrawlerUrlCacheTypes::URLCACHE_SQLITE</a> in PHPCrawlerUrlCacheTypes.class.php</div>
 3723                             <div class="index-item-description">URLs get cached in a SQLite-database-file. Recommended for spidering huge websites.</div>
 3724                     </dd>
 3725             <dt class="field">
 3726                         URLHASH_NONE
 3727                     </dt>
 3728         <dd class="index-item-body">
 3729             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#constURLHASH_NONE">PHPCrawlerURLCacheBase::URLHASH_NONE</a> in PHPCrawlerURLCacheBase.class.php</div>
 3730                     </dd>
 3731             <dt class="field">
 3732                         URLHASH_RAWLINK
 3733                     </dt>
 3734         <dd class="index-item-body">
 3735             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#constURLHASH_RAWLINK">PHPCrawlerURLCacheBase::URLHASH_RAWLINK</a> in PHPCrawlerURLCacheBase.class.php</div>
 3736                     </dd>
 3737             <dt class="field">
 3738                         URLHASH_URL
 3739                     </dt>
 3740         <dd class="index-item-body">
 3741             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLCacheBase.html#constURLHASH_URL">PHPCrawlerURLCacheBase::URLHASH_URL</a> in PHPCrawlerURLCacheBase.class.php</div>
 3742                     </dd>
 3743             <dt class="field">
 3744                         <span class="method-title">urlHostInCache</span>
 3745                     </dt>
 3746         <dd class="index-item-body">
 3747             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerDNSCache.html#methodurlHostInCache">PHPCrawlerDNSCache::urlHostInCache()</a> in PHPCrawlerDNSCache.class.php</div>
 3748                             <div class="index-item-description">Checks whether the hostname of the given URL is already cached</div>
 3749                     </dd>
 3750             <dt class="field">
 3751                         <span class="method-title">urlMatchesRules</span>
 3752                     </dt>
 3753         <dd class="index-item-body">
 3754             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerURLFilter.html#methodurlMatchesRules">PHPCrawlerURLFilter::urlMatchesRules()</a> in PHPCrawlerURLFilter.class.php</div>
 3755                             <div class="index-item-description">Checks whether a given URL matches the rules.</div>
 3756                     </dd>
 3757             <dt class="field">
 3758                         <span class="method-title">useGzip</span>
 3759                     </dt>
 3760         <dd class="index-item-body">
 3761             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methoduseGzip">SitemapCreator::useGzip()</a> in SitemapCreator.class.php</div>
 3762                             <div class="index-item-description">Use gzip compressed sitemaps files $use_gzip</div>
 3763                     </dd>
 3764         </dl>
 3765     <a name="v"></a>
 3766     <div class="index-letter-section">
 3767         <div style="float: left" class="index-letter-title">v</div>
 3768         <div style="float: right"><a href="#top">top</a></div>
 3769         <div style="clear: both"></div>
 3770     </div>
 3771     <dl>
 3772             <dt class="field">
 3773                         <span class="var-title">$value</span>
 3774                     </dt>
 3775         <dd class="index-item-body">
 3776             <div class="index-item-details"><a href="phpcrawl/PHPCrawlerCookieDescriptor.html#var$value">PHPCrawlerCookieDescriptor::$value</a> in PHPCrawlerCookieDescriptor.class.php</div>
 3777                             <div class="index-item-description">Cookie-value</div>
 3778                     </dd>
 3779             <dt class="field">
 3780                         <span class="method-title">validSitemapName</span>
 3781                     </dt>
 3782         <dd class="index-item-body">
 3783             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodvalidSitemapName">SitemapCreator::validSitemapName()</a> in SitemapCreator.class.php</div>
 3784                             <div class="index-item-description">Validates sitemap filename</div>
 3785                     </dd>
 3786         </dl>
 3787     <a name="w"></a>
 3788     <div class="index-letter-section">
 3789         <div style="float: left" class="index-letter-title">w</div>
 3790         <div style="float: right"><a href="#top">top</a></div>
 3791         <div style="clear: both"></div>
 3792     </div>
 3793     <dl>
 3794             <dt class="field">
 3795                         <span class="var-title">$working_base_directory</span>
 3796                     </dt>
 3797         <dd class="index-item-body">
 3798             <div class="index-item-details"><a href="phpcrawl/PHPCrawler.html#var$working_base_directory">PHPCrawler::$working_base_directory</a>