"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerProcessReport.html" (20 Jan 2013, 12267 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 PHPCrawlerProcessReport</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 PHPCrawlerProcessReport</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 summarizing information about a crawling-process after the process is finished.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---PHPCrawlerProcessReport.class.php.html">/libs/PHPCrawler/PHPCrawlerProcessReport.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">int</span>
   52                     <a href="#$abort_reason" title="details" class="var-name">$abort_reason</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">float</span>
   60                     <a href="#$data_throughput" title="details" class="var-name">$data_throughput</a>
   61                 </div>
   62                                                                 <div class="var-title">
   63                     <span class="var-type">int</span>
   64                     <a href="#$files_received" title="details" class="var-name">$files_received</a>
   65                 </div>
   66                                                                 <div class="var-title">
   67                     <span class="var-type">bool</span>
   68                     <a href="#$file_limit_reached" title="details" class="var-name">$file_limit_reached</a>
   69                 </div>
   70                                                                 <div class="var-title">
   71                     <span class="var-type">int</span>
   72                     <a href="#$links_followed" title="details" class="var-name">$links_followed</a>
   73                 </div>
   74                                                                 <div class="var-title">
   75                     <span class="var-type">int</span>
   76                     <a href="#$memory_peak_usage" title="details" class="var-name">$memory_peak_usage</a>
   77                 </div>
   78                                                                 <div class="var-title">
   79                     <span class="var-type">float</span>
   80                     <a href="#$process_runtime" title="details" class="var-name">$process_runtime</a>
   81                 </div>
   82                                                                 <div class="var-title">
   83                     <span class="var-type">bool</span>
   84                     <a href="#$traffic_limit_reached" title="details" class="var-name">$traffic_limit_reached</a>
   85                 </div>
   86                                                                 <div class="var-title">
   87                     <span class="var-type">bool</span>
   88                     <a href="#$user_abort" title="details" class="var-name">$user_abort</a>
   89                 </div>
   90                                             </div>
   91         </div>
   92     </div>
   93 
   94     <a name="sec-method-summary"></a>
   95     <div class="info-box">
   96         <div class="info-box-title">Method Summary</span></div>
   97         <div class="nav-bar">
   98             <a href="#sec-description">Description</a> |
   99                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  100                  
  101                 |
  102                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  103         </div>
  104         <div class="info-box-body">         
  105             <div class="method-summary">
  106                                                 
  107                                                 <div class="method-definition">
  108                                             <span class="method-result">array</span>
  109                                         <a href="#toArray" title="details" class="method-name">toArray</a>
  110                                         ()
  111                                     </div>
  112                                 </div>
  113         </div>
  114     </div>      
  115 
  116     <a name="sec-vars"></a>
  117     <div class="info-box">
  118         <div class="info-box-title">Variables</div>
  119         <div class="nav-bar">
  120             <a href="#sec-description">Description</a> |
  121                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  122                         
  123             
  124                                         | 
  125                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  126                             
  127                     </div>
  128         <div class="info-box-body">
  129             <a name="var$abort_reason" id="$abort_reason"><!-- --></A>
  130 <div class="evenrow">
  131 
  132     <div class="var-header">
  133         <span class="var-title">
  134             <span class="var-type">int</span>
  135             <span class="var-name">$abort_reason</span>
  136                         (line <span class="line-number">77</span>)
  137         </span>
  138     </div>
  139 
  140     <!-- ========== Info from phpDoc block ========= -->
  141 <p class="short-description">Reason for the abortion of the crawling-process</p>
  142     <ul class="tags">
  143                 <li><span class="field">var:</span> One of the <a href="../phpcrawl-enums/PHPCrawlerAbortReasons.html">PHPCrawlerAbortReasons</a>-constants</li>
  144                 <li><span class="field">access:</span> public</li>
  145             </ul>
  146     
  147     
  148         
  149         
  150 
  151 </div>
  152 <a name="var$bytes_received" id="$bytes_received"><!-- --></A>
  153 <div class="oddrow">
  154 
  155     <div class="var-header">
  156         <span class="var-title">
  157             <span class="var-type">int</span>
  158             <span class="var-name">$bytes_received</span>
  159              = <span class="var-default"> 0</span>          (line <span class="line-number">28</span>)
  160         </span>
  161     </div>
  162 
  163     <!-- ========== Info from phpDoc block ========= -->
  164 <p class="short-description">The total number of bytes the crawler received alltogether.</p>
  165     <ul class="tags">
  166                 <li><span class="field">access:</span> public</li>
  167             </ul>
  168     
  169     
  170         
  171         
  172 
  173 </div>
  174 <a name="var$data_throughput" id="$data_throughput"><!-- --></A>
  175 <div class="evenrow">
  176 
  177     <div class="var-header">
  178         <span class="var-title">
  179             <span class="var-type">float</span>
  180             <span class="var-name">$data_throughput</span>
  181              = <span class="var-default"> 0</span>          (line <span class="line-number">42</span>)
  182         </span>
  183     </div>
  184 
  185     <!-- ========== Info from phpDoc block ========= -->
  186 <p class="short-description">The average data-throughput in bytes per second.</p>
  187     <ul class="tags">
  188                 <li><span class="field">access:</span> public</li>
  189             </ul>
  190     
  191     
  192         
  193         
  194 
  195 </div>
  196 <a name="var$files_received" id="$files_received"><!-- --></A>
  197 <div class="oddrow">
  198 
  199     <div class="var-header">
  200         <span class="var-title">
  201             <span class="var-type">int</span>
  202             <span class="var-name">$files_received</span>
  203              = <span class="var-default"> 0</span>          (line <span class="line-number">21</span>)
  204         </span>
  205     </div>
  206 
  207     <!-- ========== Info from phpDoc block ========= -->
  208 <p class="short-description">The total number of documents the crawler received.</p>
  209     <ul class="tags">
  210                 <li><span class="field">access:</span> public</li>
  211             </ul>
  212     
  213     
  214         
  215         
  216 
  217 </div>
  218 <a name="var$file_limit_reached" id="$file_limit_reached"><!-- --></A>
  219 <div class="evenrow">
  220 
  221     <div class="var-header">
  222         <span class="var-title">
  223             <span class="var-type">bool</span>
  224             <span class="var-name">$file_limit_reached</span>
  225              = <span class="var-default"> false</span>          (line <span class="line-number">56</span>)
  226         </span>
  227     </div>
  228 
  229     <!-- ========== Info from phpDoc block ========= -->
  230 <p class="short-description">Will be TRUE if the page/file-limit was reached.</p>
  231     <ul class="tags">
  232                 <li><span class="field">access:</span> public</li>
  233             </ul>
  234     
  235     
  236         
  237         
  238 
  239 </div>
  240 <a name="var$links_followed" id="$links_followed"><!-- --></A>
  241 <div class="oddrow">
  242 
  243     <div class="var-header">
  244         <span class="var-title">
  245             <span class="var-type">int</span>
  246             <span class="var-name">$links_followed</span>
  247              = <span class="var-default"> 0</span>          (line <span class="line-number">14</span>)
  248         </span>
  249     </div>
  250 
  251     <!-- ========== Info from phpDoc block ========= -->
  252 <p class="short-description">The total number of links/URLs the crawler found and followed.</p>
  253     <ul class="tags">
  254                 <li><span class="field">access:</span> public</li>
  255             </ul>
  256     
  257     
  258         
  259         
  260 
  261 </div>
  262 <a name="var$memory_peak_usage" id="$memory_peak_usage"><!-- --></A>
  263 <div class="evenrow">
  264 
  265     <div class="var-header">
  266         <span class="var-title">
  267             <span class="var-type">int</span>
  268             <span class="var-name">$memory_peak_usage</span>
  269                         (line <span class="line-number">70</span>)
  270         </span>
  271     </div>
  272 
  273     <!-- ========== Info from phpDoc block ========= -->
  274 <p class="short-description">The peak memory-usage the crawling-process caused.</p>
  275     <ul class="tags">
  276                 <li><span class="field">var:</span> Memory-usage in bytes. May be NULL if PHP-version is lower than 5.2.0.</li>
  277                 <li><span class="field">access:</span> public</li>
  278             </ul>
  279     
  280     
  281         
  282         
  283 
  284 </div>
  285 <a name="var$process_runtime" id="$process_runtime"><!-- --></A>
  286 <div class="oddrow">
  287 
  288     <div class="var-header">
  289         <span class="var-title">
  290             <span class="var-type">float</span>
  291             <span class="var-name">$process_runtime</span>
  292              = <span class="var-default"> 0</span>          (line <span class="line-number">35</span>)
  293         </span>
  294     </div>
  295 
  296     <!-- ========== Info from phpDoc block ========= -->
  297 <p class="short-description">The total time the crawling-process was running in seconds.</p>
  298     <ul class="tags">
  299                 <li><span class="field">var:</span> Proess-runtime in seconds.</li>
  300                 <li><span class="field">access:</span> public</li>
  301             </ul>
  302     
  303     
  304         
  305         
  306 
  307 </div>
  308 <a name="var$traffic_limit_reached" id="$traffic_limit_reached"><!-- --></A>
  309 <div class="evenrow">
  310 
  311     <div class="var-header">
  312         <span class="var-title">
  313             <span class="var-type">bool</span>
  314             <span class="var-name">$traffic_limit_reached</span>
  315              = <span class="var-default"> false</span>          (line <span class="line-number">49</span>)
  316         </span>
  317     </div>
  318 
  319     <!-- ========== Info from phpDoc block ========= -->
  320 <p class="short-description">Will be TRUE if the crawling-process stopped becaus the traffic-limit was reached.</p>
  321     <ul class="tags">
  322                 <li><span class="field">access:</span> public</li>
  323             </ul>
  324     
  325     
  326         
  327         
  328 
  329 </div>
  330 <a name="var$user_abort" id="$user_abort"><!-- --></A>
  331 <div class="oddrow">
  332 
  333     <div class="var-header">
  334         <span class="var-title">
  335             <span class="var-type">bool</span>
  336             <span class="var-name">$user_abort</span>
  337              = <span class="var-default"> false</span>          (line <span class="line-number">63</span>)
  338         </span>
  339     </div>
  340 
  341     <!-- ========== Info from phpDoc block ========= -->
  342 <p class="short-description">Will be TRUE if the crawling-process stopped because the overridable function handleDocumentInfo() returned a negative value.</p>
  343     <ul class="tags">
  344                 <li><span class="field">access:</span> public</li>
  345             </ul>
  346     
  347     
  348         
  349         
  350 
  351 </div>
  352                         
  353         </div>
  354     </div>
  355     
  356     <a name="sec-methods"></a>
  357     <div class="info-box">
  358         <div class="info-box-title">Methods</div>
  359         <div class="nav-bar">
  360             <a href="#sec-description">Description</a> |
  361                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  362                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  363                         
  364         </div>
  365         <div class="info-box-body">
  366             <A NAME='method_detail'></A>
  367 
  368 <a name="methodtoArray" id="toArray"><!-- --></a>
  369 <div class="evenrow">
  370     
  371     <div class="method-header">
  372         <span class="method-title">toArray</span> (line <span class="line-number">85</span>)
  373     </div> 
  374     
  375     <!-- ========== Info from phpDoc block ========= -->
  376 <p class="short-description">Returns an array with all properties of this class.</p>
  377     <ul class="tags">
  378                 <li><span class="field">access:</span> public</li>
  379             </ul>
  380     
  381     <div class="method-signature">
  382         <span class="method-result">array</span>
  383         <span class="method-name">
  384             toArray
  385         </span>
  386                 ()
  387             </div>
  388     
  389         
  390             
  391     </div>
  392                         
  393         </div>
  394     </div>
  395 
  396 
  397     <p class="notes" id="credit">
  398         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>
  399     </p>
  400     </div></body>
  401 </html>