"Fossies" - the Fresh Open Source Software Archive

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


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

    1 <?xml version="1.0" encoding="iso-8859-1"?>
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3   <html xmlns="http://www.w3.org/1999/xhtml">
    4         <head>
    5             <!-- template designed by Marco Von Ballmoos -->
    6             <title>Docs For Class PHPCrawlerDocumentInfo</title>
    7             <link rel="stylesheet" href="../media/stylesheet.css" />
    8             <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9         </head>
   10         <body>
   11             <div class="page-body">         
   12 <h2 class="class-name">Class PHPCrawlerDocumentInfo</h2>
   13 
   14 <a name="sec-description"></a>
   15 <div class="info-box">
   16     <div class="info-box-title">Description</div>
   17     <div class="nav-bar">
   18                     <span class="disabled">Description</span> |
   19                                                     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   20                         |                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   21                         
   22                     </div>
   23     <div class="info-box-body">
   24                 <!-- ========== Info from phpDoc block ========= -->
   25 <p class="short-description">Contains information about a page or file the crawler found and received during the crawling-process.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---PHPCrawlerDocumentInfo.class.php.html">/libs/PHPCrawler/PHPCrawlerDocumentInfo.class.php</a> (line <span class="field">7</span>)
   28         </p>
   29         
   30                 
   31         <pre></pre>
   32     
   33             </div>
   34 </div>
   35 
   36 
   37 
   38     <a name="sec-var-summary"></a>
   39     <div class="info-box">
   40         <div class="info-box-title">Variable Summary</span></div>
   41         <div class="nav-bar">
   42             <a href="#sec-description">Description</a> |
   43                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   44                             | 
   45                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   46                             
   47                                 </div>
   48         <div class="info-box-body">
   49             <div class="var-summary">
   50                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="var-title">
   51                     <span class="var-type">array</span>
   52                     <a href="#$benchmarks" title="details" class="var-name">$benchmarks</a>
   53                 </div>
   54                                                                 <div class="var-title">
   55                     <span class="var-type">int</span>
   56                     <a href="#$bytes_received" title="details" class="var-name">$bytes_received</a>
   57                 </div>
   58                                                                 <div class="var-title">
   59                     <span class="var-type">string</span>
   60                     <a href="#$content" title="details" class="var-name">$content</a>
   61                 </div>
   62                                                                 <div class="var-title">
   63                     <span class="var-type">string</span>
   64                     <a href="#$content_tmp_file" title="details" class="var-name">$content_tmp_file</a>
   65                 </div>
   66                                                                 <div class="var-title">
   67                     <span class="var-type">string</span>
   68                     <a href="#$content_type" title="details" class="var-name">$content_type</a>
   69                 </div>
   70                                                                 <div class="var-title">
   71                     <span class="var-type">array</span>
   72                     <a href="#$cookies" title="details" class="var-name">$cookies</a>
   73                 </div>
   74                                                                 <div class="var-title">
   75                     <span class="var-type">float</span>
   76                     <a href="#$data_transfer_rate" title="details" class="var-name">$data_transfer_rate</a>
   77                 </div>
   78                                                                 <div class="var-title">
   79                     <span class="var-type">float</span>
   80                     <a href="#$data_transfer_time" title="details" class="var-name">$data_transfer_time</a>
   81                 </div>
   82                                                                 <div class="var-title">
   83                     <span class="var-type">int</span>
   84                     <a href="#$error_code" title="details" class="var-name">$error_code</a>
   85                 </div>
   86                                                                 <div class="var-title">
   87                     <span class="var-type">bool</span>
   88                     <a href="#$error_occured" title="details" class="var-name">$error_occured</a>
   89                 </div>
   90                                                                 <div class="var-title">
   91                     <span class="var-type">string</span>
   92                     <a href="#$error_string" title="details" class="var-name">$error_string</a>
   93                 </div>
   94                                                                 <div class="var-title">
   95                     <span class="var-type">string</span>
   96                     <a href="#$file" title="details" class="var-name">$file</a>
   97                 </div>
   98                                                                 <div class="var-title">
   99                     <span class="var-type">string</span>
  100                     <a href="#$header" title="details" class="var-name">$header</a>
  101                 </div>
  102                                                                 <div class="var-title">
  103                     <span class="var-type">string</span>
  104                     <a href="#$header_send" title="details" class="var-name">$header_send</a>
  105                 </div>
  106                                                                 <div class="var-title">
  107                     <span class="var-type">string</span>
  108                     <a href="#$host" title="details" class="var-name">$host</a>
  109                 </div>
  110                                                                 <div class="var-title">
  111                     <span class="var-type">int</span>
  112                     <a href="#$http_status_code" title="details" class="var-name">$http_status_code</a>
  113                 </div>
  114                                                                 <div class="var-title">
  115                     <span class="var-type">array</span>
  116                     <a href="#$links_found" title="details" class="var-name">$links_found</a>
  117                 </div>
  118                                                                 <div class="var-title">
  119                     <span class="var-type">array</span>
  120                     <a href="#$links_found_url_descriptors" title="details" class="var-name">$links_found_url_descriptors</a>
  121                 </div>
  122                                                                 <div class="var-title">
  123                     <span class="var-type">array</span>
  124                     <a href="#$meta_attributes" title="details" class="var-name">$meta_attributes</a>
  125                 </div>
  126                                                                 <div class="var-title">
  127                     <span class="var-type">string</span>
  128                     <a href="#$path" title="details" class="var-name">$path</a>
  129                 </div>
  130                                                                 <div class="var-title">
  131                     <span class="var-type">int</span>
  132                     <a href="#$port" title="details" class="var-name">$port</a>
  133                 </div>
  134                                                                 <div class="var-title">
  135                     <span class="var-type">string</span>
  136                     <a href="#$protocol" title="details" class="var-name">$protocol</a>
  137                 </div>
  138                                                                 <div class="var-title">
  139                     <span class="var-type">string</span>
  140                     <a href="#$query" title="details" class="var-name">$query</a>
  141                 </div>
  142                                                                 <div class="var-title">
  143                     <span class="var-type">bool</span>
  144                     <a href="#$received" title="details" class="var-name">$received</a>
  145                 </div>
  146                                                                 <div class="var-title">
  147                     <span class="var-type">bool</span>
  148                     <a href="#$received_completely" title="details" class="var-name">$received_completely</a>
  149                 </div>
  150                                                                 <div class="var-title">
  151                     <span class="var-type">mixed</span>
  152                     <a href="#$received_completly" title="details" class="var-name">$received_completly</a>
  153                 </div>
  154                                                                 <div class="var-title">
  155                     <span class="var-type">bool</span>
  156                     <a href="#$received_to_file" title="details" class="var-name">$received_to_file</a>
  157                 </div>
  158                                                                 <div class="var-title">
  159                     <span class="var-type">bool</span>
  160                     <a href="#$received_to_memory" title="details" class="var-name">$received_to_memory</a>
  161                 </div>
  162                                                                 <div class="var-title">
  163                     <span class="var-type">string</span>
  164                     <a href="#$referer_url" title="details" class="var-name">$referer_url</a>
  165                 </div>
  166                                                                 <div class="var-title">
  167                     <span class="var-type">string</span>
  168                     <a href="#$refering_linkcode" title="details" class="var-name">$refering_linkcode</a>
  169                 </div>
  170                                                                 <div class="var-title">
  171                     <span class="var-type">string</span>
  172                     <a href="#$refering_linktext" title="details" class="var-name">$refering_linktext</a>
  173                 </div>
  174                                                                 <div class="var-title">
  175                     <span class="var-type">string</span>
  176                     <a href="#$refering_link_raw" title="details" class="var-name">$refering_link_raw</a>
  177                 </div>
  178                                                                 <div class="var-title">
  179                     <span class="var-type"><a href="../phpcrawl/PHPCrawlerResponseHeader.html">PHPCrawlerResponseHeader</a></span>
  180                     <a href="#$responseHeader" title="details" class="var-name">$responseHeader</a>
  181                 </div>
  182                                                                 <div class="var-title">
  183                     <span class="var-type">string</span>
  184                     <a href="#$source" title="details" class="var-name">$source</a>
  185                 </div>
  186                                                                 <div class="var-title">
  187                     <span class="var-type">bool</span>
  188                     <a href="#$traffic_limit_reached" title="details" class="var-name">$traffic_limit_reached</a>
  189                 </div>
  190                                                                 <div class="var-title">
  191                     <span class="var-type">string</span>
  192                     <a href="#$url" title="details" class="var-name">$url</a>
  193                 </div>
  194                                             </div>
  195         </div>
  196     </div>
  197 
  198     <a name="sec-method-summary"></a>
  199     <div class="info-box">
  200         <div class="info-box-title">Method Summary</span></div>
  201         <div class="nav-bar">
  202             <a href="#sec-description">Description</a> |
  203                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  204                  
  205                 |
  206                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  207         </div>
  208         <div class="info-box-body">         
  209             <div class="method-summary">
  210                                                                                 
  211                                                 <div class="method-definition">
  212                                             <span class="method-result">void</span>
  213                                         <a href="#setLinksFoundArray" title="details" class="method-name">setLinksFoundArray</a>
  214                                         ()
  215                                     </div>
  216                                                                 <div class="method-definition">
  217                                             <span class="method-result">array</span>
  218                                         <a href="#toArray" title="details" class="method-name">toArray</a>
  219                                         ()
  220                                     </div>
  221                                 </div>
  222         </div>
  223     </div>      
  224 
  225     <a name="sec-vars"></a>
  226     <div class="info-box">
  227         <div class="info-box-title">Variables</div>
  228         <div class="nav-bar">
  229             <a href="#sec-description">Description</a> |
  230                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  231                         
  232             
  233                                         | 
  234                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  235                             
  236                     </div>
  237         <div class="info-box-body">
  238             <a name="var$benchmarks" id="$benchmarks"><!-- --></A>
  239 <div class="evenrow">
  240 
  241     <div class="var-header">
  242         <span class="var-title">
  243             <span class="var-type">array</span>
  244             <span class="var-name">$benchmarks</span>
  245              = <span class="var-default">array()</span>         (line <span class="line-number">319</span>)
  246         </span>
  247     </div>
  248 
  249     <!-- ========== Info from phpDoc block ========= -->
  250 <p class="short-description">Some internal benchmak-results as array.</p>
  251     <ul class="tags">
  252                 <li><span class="field">var:</span> Array containing some interlnal benchmark-results for receiving and processing this document.             The keys are the identifiers, the values are the benchmark-times.</li>
  253                 <li><span class="field">section:</span> 10 Benchmarks</li>
  254                 <li><span class="field">access:</span> public</li>
  255             </ul>
  256     
  257     
  258         
  259         
  260 
  261 </div>
  262 <a name="var$bytes_received" id="$bytes_received"><!-- --></A>
  263 <div class="oddrow">
  264 
  265     <div class="var-header">
  266         <span class="var-title">
  267             <span class="var-type">int</span>
  268             <span class="var-name">$bytes_received</span>
  269              = <span class="var-default"> 0</span>          (line <span class="line-number">141</span>)
  270         </span>
  271     </div>
  272 
  273     <!-- ========== Info from phpDoc block ========= -->
  274 <p class="short-description">The number of bytes the crawler received of the content of the document.</p>
  275     <ul class="tags">
  276                 <li><span class="field">var:</span> Received bytes</li>
  277                 <li><span class="field">section:</span> 2 Content-related information</li>
  278                 <li><span class="field">access:</span> public</li>
  279             </ul>
  280     
  281     
  282         
  283         
  284 
  285 </div>
  286 <a name="var$content" id="$content"><!-- --></A>
  287 <div class="evenrow">
  288 
  289     <div class="var-header">
  290         <span class="var-title">
  291             <span class="var-type">string</span>
  292             <span class="var-name">$content</span>
  293              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">159</span>)
  294         </span>
  295     </div>
  296 
  297     <!-- ========== Info from phpDoc block ========= -->
  298 <p class="short-description">The content of the requested document (html-sourcecode or content of file).</p>
  299 <p class="description"><p>Will be empty if &quot;received&quot; is FALSE and the source won't be complete if &quot;received_completly&quot; is FALSE!</p></p>
  300     <ul class="tags">
  301                 <li><span class="field">section:</span> 2 Content-related information</li>
  302                 <li><span class="field">access:</span> public</li>
  303             </ul>
  304     
  305     
  306         
  307         
  308 
  309 </div>
  310 <a name="var$content_tmp_file" id="$content_tmp_file"><!-- --></A>
  311 <div class="oddrow">
  312 
  313     <div class="var-header">
  314         <span class="var-title">
  315             <span class="var-type">string</span>
  316             <span class="var-name">$content_tmp_file</span>
  317              = <span class="var-default"> null</span>           (line <span class="line-number">177</span>)
  318         </span>
  319     </div>
  320 
  321     <!-- ========== Info from phpDoc block ========= -->
  322 <p class="short-description">The temporary file to which the content was received.</p>
  323 <p class="description"><p>Will be NULL if the content wasn't received to the temporary file.</p></p>
  324     <ul class="tags">
  325                 <li><span class="field">section:</span> 2 Content-related information</li>
  326                 <li><span class="field">access:</span> public</li>
  327             </ul>
  328     
  329     
  330         
  331         
  332 
  333 </div>
  334 <a name="var$content_type" id="$content_type"><!-- --></A>
  335 <div class="evenrow">
  336 
  337     <div class="var-header">
  338         <span class="var-title">
  339             <span class="var-type">string</span>
  340             <span class="var-name">$content_type</span>
  341              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">149</span>)
  342         </span>
  343     </div>
  344 
  345     <!-- ========== Info from phpDoc block ========= -->
  346 <p class="short-description">The content-type of the page or file, e.g. &quot;text/html&quot; or &quot;image/gif&quot;.</p>
  347     <ul class="tags">
  348                 <li><span class="field">var:</span> The content-type</li>
  349                 <li><span class="field">section:</span> 2 Content-related information</li>
  350                 <li><span class="field">access:</span> public</li>
  351             </ul>
  352     
  353     
  354         
  355         
  356 
  357 </div>
  358 <a name="var$cookies" id="$cookies"><!-- --></A>
  359 <div class="oddrow">
  360 
  361     <div class="var-header">
  362         <span class="var-title">
  363             <span class="var-type">array</span>
  364             <span class="var-name">$cookies</span>
  365              = <span class="var-default">array()</span>         (line <span class="line-number">193</span>)
  366         </span>
  367     </div>
  368 
  369     <!-- ========== Info from phpDoc block ========= -->
  370 <p class="short-description">Cookies send by the server.</p>
  371     <ul class="tags">
  372                 <li><span class="field">var:</span> Numeric array containing all send cookies as <a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a>-objects.</li>
  373                 <li><span class="field">section:</span> 2 Content-related information</li>
  374                 <li><span class="field">access:</span> public</li>
  375             </ul>
  376     
  377     
  378         
  379         
  380 
  381 </div>
  382 <a name="var$data_transfer_rate" id="$data_transfer_rate"><!-- --></A>
  383 <div class="evenrow">
  384 
  385     <div class="var-header">
  386         <span class="var-title">
  387             <span class="var-type">float</span>
  388             <span class="var-name">$data_transfer_rate</span>
  389              = <span class="var-default"> null</span>           (line <span class="line-number">309</span>)
  390         </span>
  391     </div>
  392 
  393     <!-- ========== Info from phpDoc block ========= -->
  394 <p class="short-description">The average data-transferrate for this document.</p>
  395     <ul class="tags">
  396                 <li><span class="field">var:</span> The rate in bytes per seconds.</li>
  397                 <li><span class="field">section:</span> 10 Benchmarks</li>
  398                 <li><span class="field">access:</span> public</li>
  399             </ul>
  400     
  401     
  402         
  403         
  404 
  405 </div>
  406 <a name="var$data_transfer_time" id="$data_transfer_time"><!-- --></A>
  407 <div class="oddrow">
  408 
  409     <div class="var-header">
  410         <span class="var-title">
  411             <span class="var-type">float</span>
  412             <span class="var-name">$data_transfer_time</span>
  413              = <span class="var-default"> null</span>           (line <span class="line-number">301</span>)
  414         </span>
  415     </div>
  416 
  417     <!-- ========== Info from phpDoc block ========= -->
  418 <p class="short-description">The time it took to receive the document.</p>
  419     <ul class="tags">
  420                 <li><span class="field">var:</span> The time seconds</li>
  421                 <li><span class="field">section:</span> 10 Benchmarks</li>
  422                 <li><span class="field">access:</span> public</li>
  423             </ul>
  424     
  425     
  426         
  427         
  428 
  429 </div>
  430 <a name="var$error_code" id="$error_code"><!-- --></A>
  431 <div class="evenrow">
  432 
  433     <div class="var-header">
  434         <span class="var-title">
  435             <span class="var-type">int</span>
  436             <span class="var-name">$error_code</span>
  437              = <span class="var-default"> null</span>           (line <span class="line-number">278</span>)
  438         </span>
  439     </div>
  440 
  441     <!-- ========== Info from phpDoc block ========= -->
  442 <p class="short-description">The code of the error that perhaps occured while requesting/receiving the document.</p>
  443 <p class="description"><p>(See PHPCrawlerRequestErrors::ERROR_... - constants)</p></p>
  444     <ul class="tags">
  445                 <li><span class="field">var:</span> One of the <a href="../phpcrawl-enums/PHPCrawlerRequestErrors.html">PHPCrawlerRequestErrors</a>::ERROR_ ... constants.</li>
  446                 <li><span class="field">section:</span> 8 Error-handling</li>
  447                 <li><span class="field">access:</span> public</li>
  448             </ul>
  449     
  450     
  451         
  452         
  453 
  454 </div>
  455 <a name="var$error_occured" id="$error_occured"><!-- --></A>
  456 <div class="oddrow">
  457 
  458     <div class="var-header">
  459         <span class="var-title">
  460             <span class="var-type">bool</span>
  461             <span class="var-name">$error_occured</span>
  462              = <span class="var-default"> false</span>          (line <span class="line-number">269</span>)
  463         </span>
  464     </div>
  465 
  466     <!-- ========== Info from phpDoc block ========= -->
  467 <p class="short-description">Indicates whether an error occured while requesting/receiving the document.</p>
  468     <ul class="tags">
  469                 <li><span class="field">var:</span> TRUE if an error occured.</li>
  470                 <li><span class="field">section:</span> 8 Error-handling</li>
  471                 <li><span class="field">access:</span> public</li>
  472             </ul>
  473     
  474     
  475         
  476         
  477 
  478 </div>
  479 <a name="var$error_string" id="$error_string"><!-- --></A>
  480 <div class="evenrow">
  481 
  482     <div class="var-header">
  483         <span class="var-title">
  484             <span class="var-type">string</span>
  485             <span class="var-name">$error_string</span>
  486              = <span class="var-default"> null</span>           (line <span class="line-number">286</span>)
  487         </span>
  488     </div>
  489 
  490     <!-- ========== Info from phpDoc block ========= -->
  491 <p class="short-description">A representig, human readable string for the error that perhaps occured while requesting/receiving the document.</p>
  492     <ul class="tags">
  493                 <li><span class="field">var:</span> A human readable error-string.</li>
  494                 <li><span class="field">section:</span> 8 Error-handling</li>
  495                 <li><span class="field">access:</span> public</li>
  496             </ul>
  497     
  498     
  499         
  500         
  501 
  502 </div>
  503 <a name="var$file" id="$file"><!-- --></A>
  504 <div class="oddrow">
  505 
  506     <div class="var-header">
  507         <span class="var-title">
  508             <span class="var-type">string</span>
  509             <span class="var-name">$file</span>
  510              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">47</span>)
  511         </span>
  512     </div>
  513 
  514     <!-- ========== Info from phpDoc block ========= -->
  515 <p class="short-description">The name of the requested page or file, e.g. &quot;page.html&quot;.</p>
  516     <ul class="tags">
  517                 <li><span class="field">section:</span> 1 URL-related information</li>
  518                 <li><span class="field">access:</span> public</li>
  519             </ul>
  520     
  521     
  522         
  523         
  524 
  525 </div>
  526 <a name="var$header" id="$header"><!-- --></A>
  527 <div class="evenrow">
  528 
  529     <div class="var-header">
  530         <span class="var-title">
  531             <span class="var-type">string</span>
  532             <span class="var-name">$header</span>
  533              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">71</span>)
  534         </span>
  535     </div>
  536 
  537     <!-- ========== Info from phpDoc block ========= -->
  538 <p class="short-description">The complete HTTP-header the webserver responded with this page or file.</p>
  539     <ul class="tags">
  540                 <li><span class="field">section:</span> 2 Content-related information</li>
  541                 <li><span class="field">access:</span> public</li>
  542             </ul>
  543     
  544     
  545         
  546         
  547 
  548 </div>
  549 <a name="var$header_send" id="$header_send"><!-- --></A>
  550 <div class="oddrow">
  551 
  552     <div class="var-header">
  553         <span class="var-title">
  554             <span class="var-type">string</span>
  555             <span class="var-name">$header_send</span>
  556              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">86</span>)
  557         </span>
  558     </div>
  559 
  560     <!-- ========== Info from phpDoc block ========= -->
  561 <p class="short-description">The complete HTTP-request-header the crawler sent to the server (debugging info).</p>
  562     <ul class="tags">
  563                 <li><span class="field">access:</span> public</li>
  564             </ul>
  565     
  566     
  567         
  568         
  569 
  570 </div>
  571 <a name="var$host" id="$host"><!-- --></A>
  572 <div class="evenrow">
  573 
  574     <div class="var-header">
  575         <span class="var-title">
  576             <span class="var-type">string</span>
  577             <span class="var-name">$host</span>
  578              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">31</span>)
  579         </span>
  580     </div>
  581 
  582     <!-- ========== Info from phpDoc block ========= -->
  583 <p class="short-description">The host-part of the URL of the requested page or file, e.g. &quot;www.foo.com&quot;.</p>
  584     <ul class="tags">
  585                 <li><span class="field">section:</span> 1 URL-related information</li>
  586                 <li><span class="field">access:</span> public</li>
  587             </ul>
  588     
  589     
  590         
  591         
  592 
  593 </div>
  594 <a name="var$http_status_code" id="$http_status_code"><!-- --></A>
  595 <div class="oddrow">
  596 
  597     <div class="var-header">
  598         <span class="var-title">
  599             <span class="var-type">int</span>
  600             <span class="var-name">$http_status_code</span>
  601              = <span class="var-default"> null</span>           (line <span class="line-number">185</span>)
  602         </span>
  603     </div>
  604 
  605     <!-- ========== Info from phpDoc block ========= -->
  606 <p class="short-description">The HTTP-statuscode the webserver responded for the request, e.g. 200 (OK) or 404 (file not found).</p>
  607     <ul class="tags">
  608                 <li><span class="field">section:</span> 2 Content-related information</li>
  609                 <li><span class="field">access:</span> public</li>
  610             </ul>
  611     
  612     
  613         
  614         
  615 
  616 </div>
  617 <a name="var$links_found" id="$links_found"><!-- --></A>
  618 <div class="evenrow">
  619 
  620     <div class="var-header">
  621         <span class="var-title">
  622             <span class="var-type">array</span>
  623             <span class="var-name">$links_found</span>
  624              = <span class="var-default">array()</span>         (line <span class="line-number">211</span>)
  625         </span>
  626     </div>
  627 
  628     <!-- ========== Info from phpDoc block ========= -->
  629 <p class="short-description">An numeric array containing information about all links that were found in the source of the page.</p>
  630 <p class="description"><p>Every element of that numeric array contains the following keys again:</p><p>link_raw - contains the raw link as it was found  url_rebuild - contains the full qualified URL the link leads to  linkcode - the html-codepart that contained the link.  linktext - the linktext the link was layed over (may be empty).</p><p>So e.g $page_data[&quot;links_found&quot;][5][&quot;link_raw&quot;] contains the fifth link that was found in the current page.  (May be something like &quot;../../foo.html&quot;).</p></p>
  631     <ul class="tags">
  632                 <li><span class="field">section:</span> 3 Information about found links</li>
  633                 <li><span class="field">access:</span> public</li>
  634             </ul>
  635     
  636     
  637         
  638         
  639 
  640 </div>
  641 <a name="var$links_found_url_descriptors" id="$links_found_url_descriptors"><!-- --></A>
  642 <div class="oddrow">
  643 
  644     <div class="var-header">
  645         <span class="var-title">
  646             <span class="var-type">array</span>
  647             <span class="var-name">$links_found_url_descriptors</span>
  648              = <span class="var-default">array()</span>         (line <span class="line-number">224</span>)
  649         </span>
  650     </div>
  651 
  652     <!-- ========== Info from phpDoc block ========= -->
  653 <p class="short-description">An numeric array containing a PHPCrawlerURLDescriptor-object for every link that was found in the page.</p>
  654 <p class="description"><p>Example: Printing the second raw link that was found on the page  <div class="src-code"><ol><li><div class="src-line">&nbsp;echo&nbsp;<span class="src-var">$PageInfo</span><span class="src-sym">-&gt;</span><span class="src-id"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html#var$links_found_url_descriptors">links_found_url_descriptors</a></span><span class="src-sym">[</span><span class="src-num">2</span><span class="src-sym">]</span><span class="src-sym">-&gt;</span><span class="src-id">link_raw</span><span class="src-sym">;</span></div></li>
  655 </ol></div></p></p>
  656     <ul class="tags">
  657                 <li><span class="field">var:</span> Numneric array containing <a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a>-objects</li>
  658                 <li><span class="field">section:</span> 3 Information about found links</li>
  659                 <li><span class="field">access:</span> public</li>
  660             </ul>
  661     
  662     
  663         
  664         
  665 
  666 </div>
  667 <a name="var$meta_attributes" id="$meta_attributes"><!-- --></A>
  668 <div class="evenrow">
  669 
  670     <div class="var-header">
  671         <span class="var-title">
  672             <span class="var-type">array</span>
  673             <span class="var-name">$meta_attributes</span>
  674              = <span class="var-default">array()</span>         (line <span class="line-number">330</span>)
  675         </span>
  676     </div>
  677 
  678     <!-- ========== Info from phpDoc block ========= -->
  679 <p class="short-description">All meta-tag atteributes found in the source of the document.</p>
  680     <ul class="tags">
  681                 <li><span class="field">var:</span> Assoziative array conatining all found meta-attributes.             The keys are the meta-names, the values the content of the attributes.             (like $tags[&quot;robots&quot;] = &quot;nofollow&quot;)</li>
  682                 <li><span class="field">section:</span> 2 Content-related information</li>
  683                 <li><span class="field">access:</span> public</li>
  684             </ul>
  685     
  686     
  687         
  688         
  689 
  690 </div>
  691 <a name="var$path" id="$path"><!-- --></A>
  692 <div class="oddrow">
  693 
  694     <div class="var-header">
  695         <span class="var-title">
  696             <span class="var-type">string</span>
  697             <span class="var-name">$path</span>
  698              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">39</span>)
  699         </span>
  700     </div>
  701 
  702     <!-- ========== Info from phpDoc block ========= -->
  703 <p class="short-description">The path in the URL of the requested page or file, e.g. &quot;/page/&quot;.</p>
  704     <ul class="tags">
  705                 <li><span class="field">section:</span> 1 URL-related information</li>
  706                 <li><span class="field">access:</span> public</li>
  707             </ul>
  708     
  709     
  710         
  711         
  712 
  713 </div>
  714 <a name="var$port" id="$port"><!-- --></A>
  715 <div class="evenrow">
  716 
  717     <div class="var-header">
  718         <span class="var-title">
  719             <span class="var-type">int</span>
  720             <span class="var-name">$port</span>
  721                         (line <span class="line-number">63</span>)
  722         </span>
  723     </div>
  724 
  725     <!-- ========== Info from phpDoc block ========= -->
  726 <p class="short-description">The port of the URL the request was send to, e.g. 80</p>
  727     <ul class="tags">
  728                 <li><span class="field">section:</span> 1 URL-related information</li>
  729                 <li><span class="field">access:</span> public</li>
  730             </ul>
  731     
  732     
  733         
  734         
  735 
  736 </div>
  737 <a name="var$protocol" id="$protocol"><!-- --></A>
  738 <div class="oddrow">
  739 
  740     <div class="var-header">
  741         <span class="var-title">
  742             <span class="var-type">string</span>
  743             <span class="var-name">$protocol</span>
  744              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">23</span>)
  745         </span>
  746     </div>
  747 
  748     <!-- ========== Info from phpDoc block ========= -->
  749 <p class="short-description">The protocol-part of the URL of the page or file, e.g. &quot;http://&quot;</p>
  750     <ul class="tags">
  751                 <li><span class="field">section:</span> 1 URL-related information</li>
  752                 <li><span class="field">access:</span> public</li>
  753             </ul>
  754     
  755     
  756         
  757         
  758 
  759 </div>
  760 <a name="var$query" id="$query"><!-- --></A>
  761 <div class="evenrow">
  762 
  763     <div class="var-header">
  764         <span class="var-title">
  765             <span class="var-type">string</span>
  766             <span class="var-name">$query</span>
  767              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">55</span>)
  768         </span>
  769     </div>
  770 
  771     <!-- ========== Info from phpDoc block ========= -->
  772 <p class="short-description">The query-part of the URL of the requested page or file, e.g. &quot;?x=y&quot;.</p>
  773     <ul class="tags">
  774                 <li><span class="field">section:</span> 1 URL-related information</li>
  775                 <li><span class="field">access:</span> public</li>
  776             </ul>
  777     
  778     
  779         
  780         
  781 
  782 </div>
  783 <a name="var$received" id="$received"><!-- --></A>
  784 <div class="oddrow">
  785 
  786     <div class="var-header">
  787         <span class="var-title">
  788             <span class="var-type">bool</span>
  789             <span class="var-name">$received</span>
  790              = <span class="var-default"> false</span>          (line <span class="line-number">94</span>)
  791         </span>
  792     </div>
  793 
  794     <!-- ========== Info from phpDoc block ========= -->
  795 <p class="short-description">Flag indicating whether content was received from the page or file.</p>
  796     <ul class="tags">
  797                 <li><span class="field">var:</span> TRUE if the crawler received at least some source/content of this page or file.</li>
  798                 <li><span class="field">section:</span> 2 Content-related information</li>
  799                 <li><span class="field">access:</span> public</li>
  800             </ul>
  801     
  802     
  803         
  804         
  805 
  806 </div>
  807 <a name="var$received_completely" id="$received_completely"><!-- --></A>
  808 <div class="evenrow">
  809 
  810     <div class="var-header">
  811         <span class="var-title">
  812             <span class="var-type">bool</span>
  813             <span class="var-name">$received_completely</span>
  814              = <span class="var-default"> false</span>          (line <span class="line-number">105</span>)
  815         </span>
  816     </div>
  817 
  818     <!-- ========== Info from phpDoc block ========= -->
  819 <p class="short-description">Flag indicating whether content was completely received from the page or file.</p>
  820 <p class="description"><p>The conten of the current document may not be received comepletely due to settings made  with PHPCrawler::setContentSizeLimit())<a href="../phpcrawl/PHPCrawler.html#methodsetTrafficLimit">PHPCrawler::setTrafficLimit()</a>.</p></p>
  821     <ul class="tags">
  822                 <li><span class="field">var:</span> TRUE if the crawler received the complete source/content of this page or file.</li>
  823                 <li><span class="field">section:</span> 2 Content-related information</li>
  824                 <li><span class="field">access:</span> public</li>
  825             </ul>
  826     
  827     
  828         
  829         
  830 
  831 </div>
  832 <a name="var$received_completly" id="$received_completly"><!-- --></A>
  833 <div class="oddrow">
  834 
  835     <div class="var-header">
  836         <span class="var-title">
  837             <span class="var-type">mixed</span>
  838             <span class="var-name">$received_completly</span>
  839              = <span class="var-default"> false</span>          (line <span class="line-number">113</span>)
  840         </span>
  841     </div>
  842 
  843     <!-- ========== Info from phpDoc block ========= -->
  844 <p class="short-description">Alias for received_completely, was spelled wrong in prevoius versions of phpcrawl.</p>
  845     <ul class="tags">
  846                 <li><span class="field">deprecated:</span> </li>
  847                 <li><span class="field">section:</span> 11 Deprecated</li>
  848                 <li><span class="field">access:</span> public</li>
  849             </ul>
  850     
  851     
  852         
  853         
  854 
  855 </div>
  856 <a name="var$received_to_file" id="$received_to_file"><!-- --></A>
  857 <div class="evenrow">
  858 
  859     <div class="var-header">
  860         <span class="var-title">
  861             <span class="var-type">bool</span>
  862             <span class="var-name">$received_to_file</span>
  863              = <span class="var-default"> false</span>          (line <span class="line-number">133</span>)
  864         </span>
  865     </div>
  866 
  867     <!-- ========== Info from phpDoc block ========= -->
  868 <p class="short-description">Will be true if the content was received into temporary file.</p>
  869 <p class="description"><p>The content is stored in the temporary file $pageInfo-&gt;content_tmp_file in this case.</p></p>
  870     <ul class="tags">
  871                 <li><span class="field">section:</span> 2 Content-related information</li>
  872                 <li><span class="field">access:</span> public</li>
  873             </ul>
  874     
  875     
  876         
  877         
  878 
  879 </div>
  880 <a name="var$received_to_memory" id="$received_to_memory"><!-- --></A>
  881 <div class="oddrow">
  882 
  883     <div class="var-header">
  884         <span class="var-title">
  885             <span class="var-type">bool</span>
  886             <span class="var-name">$received_to_memory</span>
  887              = <span class="var-default"> false</span>          (line <span class="line-number">123</span>)
  888         </span>
  889     </div>
  890 
  891     <!-- ========== Info from phpDoc block ========= -->
  892 <p class="short-description">Will be true if the content was received into local memory.</p>
  893 <p class="description"><p>You will have access to the content of the current page or file through $pageInfo-&gt;source.</p></p>
  894     <ul class="tags">
  895                 <li><span class="field">section:</span> 2 Content-related information</li>
  896                 <li><span class="field">access:</span> public</li>
  897             </ul>
  898     
  899     
  900         
  901         
  902 
  903 </div>
  904 <a name="var$referer_url" id="$referer_url"><!-- --></A>
  905 <div class="evenrow">
  906 
  907     <div class="var-header">
  908         <span class="var-title">
  909             <span class="var-type">string</span>
  910             <span class="var-name">$referer_url</span>
  911              = <span class="var-default"> null</span>           (line <span class="line-number">232</span>)
  912         </span>
  913     </div>
  914 
  915     <!-- ========== Info from phpDoc block ========= -->
  916 <p class="short-description">The complete URL of the page that contained the link to this document.</p>
  917     <ul class="tags">
  918                 <li><span class="field">section:</span> 7 Referer information</li>
  919                 <li><span class="field">access:</span> public</li>
  920             </ul>
  921     
  922     
  923         
  924         
  925 
  926 </div>
  927 <a name="var$refering_linkcode" id="$refering_linkcode"><!-- --></A>
  928 <div class="oddrow">
  929 
  930     <div class="var-header">
  931         <span class="var-title">
  932             <span class="var-type">string</span>
  933             <span class="var-name">$refering_linkcode</span>
  934              = <span class="var-default"> null</span>           (line <span class="line-number">242</span>)
  935         </span>
  936     </div>
  937 
  938     <!-- ========== Info from phpDoc block ========= -->
  939 <p class="short-description">The html-sourcecode that contained the link to the current document.</p>
  940 <p class="description"><p>(E.g. &lt;a href=&quot;../foo.html&quot;&gt;LINKTEXT&lt;/a&gt;)</p></p>
  941     <ul class="tags">
  942                 <li><span class="field">section:</span> 7 Referer information</li>
  943                 <li><span class="field">access:</span> public</li>
  944             </ul>
  945     
  946     
  947         
  948         
  949 
  950 </div>
  951 <a name="var$refering_linktext" id="$refering_linktext"><!-- --></A>
  952 <div class="evenrow">
  953 
  954     <div class="var-header">
  955         <span class="var-title">
  956             <span class="var-type">string</span>
  957             <span class="var-name">$refering_linktext</span>
  958              = <span class="var-default"> null</span>           (line <span class="line-number">261</span>)
  959         </span>
  960     </div>
  961 
  962     <!-- ========== Info from phpDoc block ========= -->
  963 <p class="short-description">The linktext of the link that &quot;linked&quot; to this document.</p>
  964 <p class="description"><p>E.g. if the refering link was &lt;a href=&quot;../foo.html&quot;&gt;LINKTEXT&lt;/a&gt;, the refering linktext is &quot;LINKTEXT&quot;.  May contain html-tags of course.</p></p>
  965     <ul class="tags">
  966                 <li><span class="field">section:</span> 7 Referer information</li>
  967                 <li><span class="field">access:</span> public</li>
  968             </ul>
  969     
  970     
  971         
  972         
  973 
  974 </div>
  975 <a name="var$refering_link_raw" id="$refering_link_raw"><!-- --></A>
  976 <div class="oddrow">
  977 
  978     <div class="var-header">
  979         <span class="var-title">
  980             <span class="var-type">string</span>
  981             <span class="var-name">$refering_link_raw</span>
  982              = <span class="var-default"> null</span>           (line <span class="line-number">250</span>)
  983         </span>
  984     </div>
  985 
  986     <!-- ========== Info from phpDoc block ========= -->
  987 <p class="short-description">Contains the raw link as it was found in the content of the refering URL. (E.g. &quot;../foo.html&quot;)</p>
  988     <ul class="tags">
  989                 <li><span class="field">section:</span> 7 Referer information</li>
  990                 <li><span class="field">access:</span> public</li>
  991             </ul>
  992     
  993     
  994         
  995         
  996 
  997 </div>
  998 <a name="var$responseHeader" id="$responseHeader"><!-- --></A>
  999 <div class="evenrow">
 1000 
 1001     <div class="var-header">
 1002         <span class="var-title">
 1003             <span class="var-type"><a href="../phpcrawl/PHPCrawlerResponseHeader.html">PHPCrawlerResponseHeader</a></span>
 1004             <span class="var-name">$responseHeader</span>
 1005                         (line <span class="line-number">79</span>)
 1006         </span>
 1007     </div>
 1008 
 1009     <!-- ========== Info from phpDoc block ========= -->
 1010 <p class="short-description">The complete HTTP-header the webserver responded with this page or file as a PHPCrawlerResponseHeader-object.</p>
 1011     <ul class="tags">
 1012                 <li><span class="field">section:</span> 2 Content-related information</li>
 1013                 <li><span class="field">access:</span> public</li>
 1014             </ul>
 1015     
 1016     
 1017         
 1018         
 1019 
 1020 </div>
 1021 <a name="var$source" id="$source"><!-- --></A>
 1022 <div class="oddrow">
 1023 
 1024     <div class="var-header">
 1025         <span class="var-title">
 1026             <span class="var-type">string</span>
 1027             <span class="var-name">$source</span>
 1028              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">167</span>)
 1029         </span>
 1030     </div>
 1031 
 1032     <!-- ========== Info from phpDoc block ========= -->
 1033 <p class="short-description">Same as &quot;content&quot;, the content of the requested document.</p>
 1034     <ul class="tags">
 1035                 <li><span class="field">section:</span> 2 Content-related information</li>
 1036                 <li><span class="field">access:</span> public</li>
 1037             </ul>
 1038     
 1039     
 1040         
 1041         
 1042 
 1043 </div>
 1044 <a name="var$traffic_limit_reached" id="$traffic_limit_reached"><!-- --></A>
 1045 <div class="evenrow">
 1046 
 1047     <div class="var-header">
 1048         <span class="var-title">
 1049             <span class="var-type">bool</span>
 1050             <span class="var-name">$traffic_limit_reached</span>
 1051              = <span class="var-default"> false</span>          (line <span class="line-number">293</span>)
 1052         </span>
 1053     </div>
 1054 
 1055     <!-- ========== Info from phpDoc block ========= -->
 1056 <p class="short-description">Indicated whether the traffic-limit set by the user was reached after downloading this document.</p>
 1057     <ul class="tags">
 1058                 <li><span class="field">var:</span> TRUE if traffic-limit was reached.</li>
 1059                 <li><span class="field">access:</span> public</li>
 1060             </ul>
 1061     
 1062     
 1063         
 1064         
 1065 
 1066 </div>
 1067 <a name="var$url" id="$url"><!-- --></A>
 1068 <div class="oddrow">
 1069 
 1070     <div class="var-header">
 1071         <span class="var-title">
 1072             <span class="var-type">string</span>
 1073             <span class="var-name">$url</span>
 1074              = <span class="var-default"> &quot;&quot;</span>           (line <span class="line-number">15</span>)
 1075         </span>
 1076     </div>
 1077 
 1078     <!-- ========== Info from phpDoc block ========= -->
 1079 <p class="short-description">The complete, full qualified URL of the page or file, e.g. &quot;http://www.foo.com/bar/page.html?x=y&quot;.</p>
 1080     <ul class="tags">
 1081                 <li><span class="field">section:</span> 1 URL-related information</li>
 1082                 <li><span class="field">access:</span> public</li>
 1083             </ul>
 1084     
 1085     
 1086         
 1087         
 1088 
 1089 </div>
 1090                         
 1091         </div>
 1092     </div>
 1093     
 1094     <a name="sec-methods"></a>
 1095     <div class="info-box">
 1096         <div class="info-box-title">Methods</div>
 1097         <div class="nav-bar">
 1098             <a href="#sec-description">Description</a> |
 1099                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 1100                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 1101                         
 1102         </div>
 1103         <div class="info-box-body">
 1104             <A NAME='method_detail'></A>
 1105 
 1106 <a name="methodsetLinksFoundArray" id="setLinksFoundArray"><!-- --></a>
 1107 <div class="evenrow">
 1108     
 1109     <div class="method-header">
 1110         <span class="method-title">setLinksFoundArray</span> (line <span class="line-number">337</span>)
 1111     </div> 
 1112     
 1113     <!-- ========== Info from phpDoc block ========= -->
 1114 <p class="short-description">Workaround-method, copies and converts the array $links_found_url_descriptors to $links_found.</p>
 1115     <ul class="tags">
 1116                 <li><span class="field">access:</span> public</li>
 1117             </ul>
 1118     
 1119     <div class="method-signature">
 1120         <span class="method-result">void</span>
 1121         <span class="method-name">
 1122             setLinksFoundArray
 1123         </span>
 1124                 ()
 1125             </div>
 1126     
 1127         
 1128             
 1129     </div>
 1130 <a name="methodtoArray" id="toArray"><!-- --></a>
 1131 <div class="oddrow">
 1132     
 1133     <div class="method-header">
 1134         <span class="method-title">toArray</span> (line <span class="line-number">357</span>)
 1135     </div> 
 1136     
 1137     <!-- ========== Info from phpDoc block ========= -->
 1138 <p class="short-description">Returns an array with all properties of this class.</p>
 1139     <ul class="tags">
 1140                 <li><span class="field">access:</span> public</li>
 1141             </ul>
 1142     
 1143     <div class="method-signature">
 1144         <span class="method-result">array</span>
 1145         <span class="method-name">
 1146             toArray
 1147         </span>
 1148                 ()
 1149             </div>
 1150     
 1151         
 1152             
 1153     </div>
 1154                         
 1155         </div>
 1156     </div>
 1157 
 1158 
 1159     <p class="notes" id="credit">
 1160         Documentation generated on Sun, 20 Jan 2013 21:18:50 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
 1161     </p>
 1162     </div></body>
 1163 </html>