"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerHTTPRequest.html" (20 Jan 2013, 61062 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 PHPCrawlerHTTPRequest</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 PHPCrawlerHTTPRequest</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">Class for performing HTTP-requests.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---PHPCrawlerHTTPRequest.class.php.html">/libs/PHPCrawler/PHPCrawlerHTTPRequest.class.php</a> (line <span class="field">8</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="#$content_size_limit" title="details" class="var-name">$content_size_limit</a>
   53                 </div>
   54                                                                 <div class="var-title">
   55                     <span class="var-type">mixed</span>
   56                     <a href="#$cookie_array" title="details" class="var-name">$cookie_array</a>
   57                 </div>
   58                                                                 <div class="var-title">
   59                     <span class="var-type">mixed</span>
   60                     <a href="#$data_transfer_time" title="details" class="var-name">$data_transfer_time</a>
   61                 </div>
   62                                                                 <div class="var-title">
   63                     <span class="var-type"><a href="../phpcrawl/PHPCrawlerDNSCache.html">PHPCrawlerDNSCache</a></span>
   64                     <a href="#$DNSCache" title="details" class="var-name">$DNSCache</a>
   65                 </div>
   66                                                                 <div class="var-title">
   67                     <span class="var-type">mixed</span>
   68                     <a href="#$global_traffic_count" title="details" class="var-name">$global_traffic_count</a>
   69                 </div>
   70                                                                 <div class="var-title">
   71                     <span class="var-type">mixed</span>
   72                     <a href="#$header_check_callback_function" title="details" class="var-name">$header_check_callback_function</a>
   73                 </div>
   74                                                                 <div class="var-title">
   75                     <span class="var-type">mixed</span>
   76                     <a href="#$lastResponseHeader" title="details" class="var-name">$lastResponseHeader</a>
   77                 </div>
   78                                                                 <div class="var-title">
   79                     <span class="var-type"><a href="../phpcrawl/PHPCrawlerLinkFinder.html">PHPCrawlerLinkFinder</a></span>
   80                     <a href="#$LinkFinder" title="details" class="var-name">$LinkFinder</a>
   81                 </div>
   82                                                                 <div class="var-title">
   83                     <span class="var-type">array</span>
   84                     <a href="#$linksearch_content_types" title="details" class="var-name">$linksearch_content_types</a>
   85                 </div>
   86                                                                 <div class="var-title">
   87                     <span class="var-type">array</span>
   88                     <a href="#$post_data" title="details" class="var-name">$post_data</a>
   89                 </div>
   90                                                                 <div class="var-title">
   91                     <span class="var-type">array</span>
   92                     <a href="#$proxy" title="details" class="var-name">$proxy</a>
   93                 </div>
   94                                                                 <div class="var-title">
   95                     <span class="var-type">array</span>
   96                     <a href="#$receive_content_types" title="details" class="var-name">$receive_content_types</a>
   97                 </div>
   98                                                                 <div class="var-title">
   99                     <span class="var-type">array</span>
  100                     <a href="#$receive_to_file_content_types" title="details" class="var-name">$receive_to_file_content_types</a>
  101                 </div>
  102                                                                 <div class="var-title">
  103                     <span class="var-type">mixed</span>
  104                     <a href="#$socket" title="details" class="var-name">$socket</a>
  105                 </div>
  106                                                                 <div class="var-title">
  107                     <span class="var-type">mixed</span>
  108                     <a href="#$socketConnectTimeout" title="details" class="var-name">$socketConnectTimeout</a>
  109                 </div>
  110                                                                 <div class="var-title">
  111                     <span class="var-type">mixed</span>
  112                     <a href="#$socketReadTimeout" title="details" class="var-name">$socketReadTimeout</a>
  113                 </div>
  114                                                                 <div class="var-title">
  115                     <span class="var-type">string</span>
  116                     <a href="#$tmpFile" title="details" class="var-name">$tmpFile</a>
  117                 </div>
  118                                                                 <div class="var-title">
  119                     <span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>
  120                     <a href="#$UrlDescriptor" title="details" class="var-name">$UrlDescriptor</a>
  121                 </div>
  122                                                                 <div class="var-title">
  123                     <span class="var-type">array</span>
  124                     <a href="#$url_parts" title="details" class="var-name">$url_parts</a>
  125                 </div>
  126                                                                 <div class="var-title">
  127                     <span class="var-type">mixed</span>
  128                     <a href="#$userAgentString" title="details" class="var-name">$userAgentString</a>
  129                 </div>
  130                                             </div>
  131         </div>
  132     </div>
  133 
  134     <a name="sec-method-summary"></a>
  135     <div class="info-box">
  136         <div class="info-box-title">Method Summary</span></div>
  137         <div class="nav-bar">
  138             <a href="#sec-description">Description</a> |
  139                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  140                  
  141                 |
  142                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  143         </div>
  144         <div class="info-box-body">         
  145             <div class="method-summary">
  146                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
  147                                                 <div class="method-definition">
  148                                             <span class="method-result">PHPCrawlerHTTPRequest</span>
  149                                         <a href="#__construct" title="details" class="method-name">__construct</a>
  150                                         ()
  151                                     </div>
  152                                                                 <div class="method-definition">
  153                                             <span class="method-result">void</span>
  154                                         <a href="#addCookie" title="details" class="method-name">addCookie</a>
  155                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  156                                     </div>
  157                                                                 <div class="method-definition">
  158                                             <span class="method-result">void</span>
  159                                         <a href="#addCookieDescriptor" title="details" class="method-name">addCookieDescriptor</a>
  160                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
  161                                     </div>
  162                                                                 <div class="method-definition">
  163                                             <span class="method-result">void</span>
  164                                         <a href="#addCookieDescriptors" title="details" class="method-name">addCookieDescriptors</a>
  165                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
  166                                     </div>
  167                                                                 <div class="method-definition">
  168                                             <span class="method-result">bool</span>
  169                                         <a href="#addLinkSearchContentType" title="details" class="method-name">addLinkSearchContentType</a>
  170                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>)
  171                                     </div>
  172                                                                 <div class="method-definition">
  173                                             <span class="method-result">void</span>
  174                                         <a href="#addPostData" title="details" class="method-name">addPostData</a>
  175                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  176                                     </div>
  177                                                                 <div class="method-definition">
  178                                             <span class="method-result">bool</span>
  179                                         <a href="#addReceiveContentType" title="details" class="method-name">addReceiveContentType</a>
  180                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>)
  181                                     </div>
  182                                                                 <div class="method-definition">
  183                                             <span class="method-result">bool</span>
  184                                         <a href="#addStreamToFileContentType" title="details" class="method-name">addStreamToFileContentType</a>
  185                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>)
  186                                     </div>
  187                                                                 <div class="method-definition">
  188                                             <span class="method-result">string</span>
  189                                         <a href="#buildCookieHeader" title="details" class="method-name">buildCookieHeader</a>
  190                                         ()
  191                                     </div>
  192                                                                 <div class="method-definition">
  193                                             <span class="method-result">array</span>
  194                                         <a href="#buildPostContent" title="details" class="method-name">buildPostContent</a>
  195                                         ()
  196                                     </div>
  197                                                                 <div class="method-definition">
  198                                             <span class="method-result">array</span>
  199                                         <a href="#buildRequestHeader" title="details" class="method-name">buildRequestHeader</a>
  200                                         ()
  201                                     </div>
  202                                                                 <div class="method-definition">
  203                                             <span class="method-result">void</span>
  204                                         <a href="#clearCookies" title="details" class="method-name">clearCookies</a>
  205                                         ()
  206                                     </div>
  207                                                                 <div class="method-definition">
  208                                             <span class="method-result">void</span>
  209                                         <a href="#clearPostData" title="details" class="method-name">clearPostData</a>
  210                                         ()
  211                                     </div>
  212                                                                 <div class="method-definition">
  213                                             <span class="method-result">bool</span>
  214                                         <a href="#decideRecevieContent" title="details" class="method-name">decideRecevieContent</a>
  215                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerResponseHeader.html">PHPCrawlerResponseHeader</a></span>&nbsp;<span class="var-name">$responseHeader</span>)
  216                                     </div>
  217                                                                 <div class="method-definition">
  218                                             <span class="method-result">bool</span>
  219                                         <a href="#decideStreamToFile" title="details" class="method-name">decideStreamToFile</a>
  220                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$response_header</span>)
  221                                     </div>
  222                                                                 <div class="method-definition">
  223                                             <span class="method-result">bool</span>
  224                                         <a href="#enableAggressiveLinkSearch" title="details" class="method-name">enableAggressiveLinkSearch</a>
  225                                             (<span class="var-type">bool</span>&nbsp;<span class="var-name">$mode</span>)
  226                                     </div>
  227                                                                 <div class="method-definition">
  228                                             <span class="method-result">int</span>
  229                                         <a href="#getGlobalTrafficCount" title="details" class="method-name">getGlobalTrafficCount</a>
  230                                         ()
  231                                     </div>
  232                                                                 <div class="method-definition">
  233                                             <span class="method-result">bool</span>
  234                                         <a href="#openSocket" title="details" class="method-name">openSocket</a>
  235                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">&$error_code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$error_string</span>)
  236                                     </div>
  237                                                                 <div class="method-definition">
  238                                             <span class="method-result">string</span>
  239                                         <a href="#prepareHTTPRequestQuery" title="details" class="method-name">prepareHTTPRequestQuery</a>
  240                                             (<span class="var-type">stirng</span>&nbsp;<span class="var-name">$query</span>)
  241                                     </div>
  242                                                                 <div class="method-definition">
  243                                             <span class="method-result">string</span>
  244                                         <a href="#readResponseContent" title="details" class="method-name">readResponseContent</a>
  245                                             ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$stream_to_file</span> = <span class="var-default">false</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">&$error_code</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">&$error_string</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">&$document_received_completely</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">&$bytes_received</span>)
  246                                     </div>
  247                                                                 <div class="method-definition">
  248                                             <span class="method-result">string</span>
  249                                         <a href="#readResponseHeader" title="details" class="method-name">readResponseHeader</a>
  250                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">&$error_code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$error_string</span>)
  251                                     </div>
  252                                                                 <div class="method-definition">
  253                                             <span class="method-result">A</span>
  254                                         <a href="#sendRequest" title="details" class="method-name">sendRequest</a>
  255                                         ()
  256                                     </div>
  257                                                                 <div class="method-definition">
  258                                             <span class="method-result">void</span>
  259                                         <a href="#sendRequestHeader" title="details" class="method-name">sendRequestHeader</a>
  260                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$request_header_lines</span>)
  261                                     </div>
  262                                                                 <div class="method-definition">
  263                                             <span class="method-result">void</span>
  264                                         <a href="#setBasicAuthentication" title="details" class="method-name">setBasicAuthentication</a>
  265                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
  266                                     </div>
  267                                                                 <div class="method-definition">
  268                                             <span class="method-result">bool</span>
  269                                         <a href="#setContentSizeLimit" title="details" class="method-name">setContentSizeLimit</a>
  270                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$bytes</span>)
  271                                     </div>
  272                                                                 <div class="method-definition">
  273                                             <span class="method-result">bool</span>
  274                                         <a href="#setFindRedirectURLs" title="details" class="method-name">setFindRedirectURLs</a>
  275                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>)
  276                                     </div>
  277                                                                 <div class="method-definition">
  278                                             <span class="method-result">void</span>
  279                                         <a href="#setHeaderCheckCallbackFunction" title="details" class="method-name">setHeaderCheckCallbackFunction</a>
  280                                             (<span class="var-type"></span>&nbsp;<span class="var-name">&$obj</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$method_name</span>)
  281                                     </div>
  282                                                                 <div class="method-definition">
  283                                             <span class="method-result">bool</span>
  284                                         <a href="#setLinkExtractionTags" title="details" class="method-name">setLinkExtractionTags</a>
  285                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$tag_array</span>)
  286                                     </div>
  287                                                                 <div class="method-definition">
  288                                             <span class="method-result">void</span>
  289                                         <a href="#setProxy" title="details" class="method-name">setProxy</a>
  290                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$proxy_host</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$proxy_port</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$proxy_username</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$proxy_password</span> = <span class="var-default">null</span>])
  291                                     </div>
  292                                                                 <div class="method-definition">
  293                                             <span class="method-result">void</span>
  294                                         <a href="#setTmpFile" title="details" class="method-name">setTmpFile</a>
  295                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$tmp_file</span>)
  296                                     </div>
  297                                                                 <div class="method-definition">
  298                                             <span class="method-result">void</span>
  299                                         <a href="#setUrl" title="details" class="method-name">setUrl</a>
  300                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
  301                                     </div>
  302                                 </div>
  303         </div>
  304     </div>      
  305 
  306     <a name="sec-vars"></a>
  307     <div class="info-box">
  308         <div class="info-box-title">Variables</div>
  309         <div class="nav-bar">
  310             <a href="#sec-description">Description</a> |
  311                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  312                         
  313             
  314                                         | 
  315                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  316                             
  317                     </div>
  318         <div class="info-box-body">
  319             <a name="var$content_size_limit" id="$content_size_limit"><!-- --></A>
  320 <div class="oddrow">
  321 
  322     <div class="var-header">
  323         <span class="var-title">
  324             <span class="var-type">int</span>
  325             <span class="var-name">$content_size_limit</span>
  326              = <span class="var-default"> 0</span>          (line <span class="line-number">30</span>)
  327         </span>
  328     </div>
  329 
  330     <!-- ========== Info from phpDoc block ========= -->
  331 <p class="short-description">Limit for content-size to receive</p>
  332     <ul class="tags">
  333                 <li><span class="field">var:</span> The kimit n bytes</li>
  334                 <li><span class="field">access:</span> protected</li>
  335             </ul>
  336     
  337     
  338         
  339         
  340 
  341 </div>
  342 <a name="var$cookie_array" id="$cookie_array"><!-- --></A>
  343 <div class="evenrow">
  344 
  345     <div class="var-header">
  346         <span class="var-title">
  347             <span class="var-type">mixed</span>
  348             <span class="var-name">$cookie_array</span>
  349              = <span class="var-default">array()</span>         (line <span class="line-number">113</span>)
  350         </span>
  351     </div>
  352 
  353     <!-- ========== Info from phpDoc block ========= -->
  354 <p class="short-description">Array containing cookies to send with the request</p>
  355     <ul class="tags">
  356                 <li><span class="field">access:</span> protected</li>
  357             </ul>
  358     
  359     
  360         
  361         
  362 
  363 </div>
  364 <a name="var$data_transfer_time" id="$data_transfer_time"><!-- --></A>
  365 <div class="oddrow">
  366 
  367     <div class="var-header">
  368         <span class="var-title">
  369             <span class="var-type">mixed</span>
  370             <span class="var-name">$data_transfer_time</span>
  371              = <span class="var-default"> 0</span>          (line <span class="line-number">44</span>)
  372         </span>
  373     </div>
  374 
  375     <!-- ========== Info from phpDoc block ========= -->
  376 <p class="short-description">The time it took te receive data-packets for the request.</p>
  377     <ul class="tags">
  378                 <li><span class="field">access:</span> protected</li>
  379             </ul>
  380     
  381     
  382         
  383         
  384 
  385 </div>
  386 <a name="var$DNSCache" id="$DNSCache"><!-- --></A>
  387 <div class="evenrow">
  388 
  389     <div class="var-header">
  390         <span class="var-title">
  391             <span class="var-type"><a href="../phpcrawl/PHPCrawlerDNSCache.html">PHPCrawlerDNSCache</a></span>
  392             <span class="var-name">$DNSCache</span>
  393                         (line <span class="line-number">94</span>)
  394         </span>
  395     </div>
  396 
  397     <!-- ========== Info from phpDoc block ========= -->
  398 <p class="short-description">DNS-cache</p>
  399     <ul class="tags">
  400                 <li><span class="field">access:</span> public</li>
  401             </ul>
  402     
  403     
  404         
  405         
  406 
  407 </div>
  408 <a name="var$global_traffic_count" id="$global_traffic_count"><!-- --></A>
  409 <div class="oddrow">
  410 
  411     <div class="var-header">
  412         <span class="var-title">
  413             <span class="var-type">mixed</span>
  414             <span class="var-name">$global_traffic_count</span>
  415              = <span class="var-default"> 0</span>          (line <span class="line-number">37</span>)
  416         </span>
  417     </div>
  418 
  419     <!-- ========== Info from phpDoc block ========= -->
  420 <p class="short-description">Global counter for traffic this instance of the HTTPRequest-class caused.</p>
  421     <ul class="tags">
  422                 <li><span class="field">access:</span> protected</li>
  423             </ul>
  424     
  425     
  426         
  427         
  428 
  429 </div>
  430 <a name="var$header_check_callback_function" id="$header_check_callback_function"><!-- --></A>
  431 <div class="evenrow">
  432 
  433     <div class="var-header">
  434         <span class="var-title">
  435             <span class="var-type">mixed</span>
  436             <span class="var-name">$header_check_callback_function</span>
  437              = <span class="var-default"> null</span>           (line <span class="line-number">134</span>)
  438         </span>
  439     </div>
  440 
  441     <!-- ========== Info from phpDoc block ========= -->
  442     <ul class="tags">
  443                 <li><span class="field">access:</span> protected</li>
  444             </ul>
  445     
  446     
  447         
  448         
  449 
  450 </div>
  451 <a name="var$lastResponseHeader" id="$lastResponseHeader"><!-- --></A>
  452 <div class="oddrow">
  453 
  454     <div class="var-header">
  455         <span class="var-title">
  456             <span class="var-type">mixed</span>
  457             <span class="var-name">$lastResponseHeader</span>
  458                         (line <span class="line-number">106</span>)
  459         </span>
  460     </div>
  461 
  462     <!-- ========== Info from phpDoc block ========= -->
  463 <p class="short-description">The last response-header this request-instance received.</p>
  464     <ul class="tags">
  465                 <li><span class="field">access:</span> protected</li>
  466             </ul>
  467     
  468     
  469         
  470         
  471 
  472 </div>
  473 <a name="var$LinkFinder" id="$LinkFinder"><!-- --></A>
  474 <div class="evenrow">
  475 
  476     <div class="var-header">
  477         <span class="var-title">
  478             <span class="var-type"><a href="../phpcrawl/PHPCrawlerLinkFinder.html">PHPCrawlerLinkFinder</a></span>
  479             <span class="var-name">$LinkFinder</span>
  480                         (line <span class="line-number">101</span>)
  481         </span>
  482     </div>
  483 
  484     <!-- ========== Info from phpDoc block ========= -->
  485 <p class="short-description">Link-finder object</p>
  486     <ul class="tags">
  487                 <li><span class="field">access:</span> protected</li>
  488             </ul>
  489     
  490     
  491         
  492         
  493 
  494 </div>
  495 <a name="var$linksearch_content_types" id="$linksearch_content_types"><!-- --></A>
  496 <div class="oddrow">
  497 
  498     <div class="var-header">
  499         <span class="var-title">
  500             <span class="var-type">array</span>
  501             <span class="var-name">$linksearch_content_types</span>
  502              = <span class="var-default">array(&quot;#text/html# i&quot;)</span>            (line <span class="line-number">66</span>)
  503         </span>
  504     </div>
  505 
  506     <!-- ========== Info from phpDoc block ========= -->
  507 <p class="short-description">Contains all rules defining the content-types defining which documents shoud get checked for links.</p>
  508     <ul class="tags">
  509                 <li><span class="field">var:</span> Numeric array conatining the regex-rules</li>
  510                 <li><span class="field">access:</span> protected</li>
  511             </ul>
  512     
  513     
  514         
  515         
  516 
  517 </div>
  518 <a name="var$post_data" id="$post_data"><!-- --></A>
  519 <div class="evenrow">
  520 
  521     <div class="var-header">
  522         <span class="var-title">
  523             <span class="var-type">array</span>
  524             <span class="var-name">$post_data</span>
  525              = <span class="var-default">array()</span>         (line <span class="line-number">120</span>)
  526         </span>
  527     </div>
  528 
  529     <!-- ========== Info from phpDoc block ========= -->
  530 <p class="short-description">Array containing POST-data to send with the request</p>
  531     <ul class="tags">
  532                 <li><span class="field">access:</span> protected</li>
  533             </ul>
  534     
  535     
  536         
  537         
  538 
  539 </div>
  540 <a name="var$proxy" id="$proxy"><!-- --></A>
  541 <div class="oddrow">
  542 
  543     <div class="var-header">
  544         <span class="var-title">
  545             <span class="var-type">array</span>
  546             <span class="var-name">$proxy</span>
  547                         (line <span class="line-number">127</span>)
  548         </span>
  549     </div>
  550 
  551     <!-- ========== Info from phpDoc block ========= -->
  552 <p class="short-description">The proxy to use</p>
  553     <ul class="tags">
  554                 <li><span class="field">var:</span> Array containing the keys &quot;proxy_host&quot;, &quot;proxy_port&quot;, &quot;proxy_username&quot;, &quot;proxy_password&quot;.</li>
  555                 <li><span class="field">access:</span> protected</li>
  556             </ul>
  557     
  558     
  559         
  560         
  561 
  562 </div>
  563 <a name="var$receive_content_types" id="$receive_content_types"><!-- --></A>
  564 <div class="evenrow">
  565 
  566     <div class="var-header">
  567         <span class="var-title">
  568             <span class="var-type">array</span>
  569             <span class="var-name">$receive_content_types</span>
  570              = <span class="var-default">array()</span>         (line <span class="line-number">51</span>)
  571         </span>
  572     </div>
  573 
  574     <!-- ========== Info from phpDoc block ========= -->
  575 <p class="short-description">Contains all rules defining the content-types that should be received</p>
  576     <ul class="tags">
  577                 <li><span class="field">var:</span> Numeric array conatining the regex-rules</li>
  578                 <li><span class="field">access:</span> protected</li>
  579             </ul>
  580     
  581     
  582         
  583         
  584 
  585 </div>
  586 <a name="var$receive_to_file_content_types" id="$receive_to_file_content_types"><!-- --></A>
  587 <div class="oddrow">
  588 
  589     <div class="var-header">
  590         <span class="var-title">
  591             <span class="var-type">array</span>
  592             <span class="var-name">$receive_to_file_content_types</span>
  593              = <span class="var-default">array()</span>         (line <span class="line-number">59</span>)
  594         </span>
  595     </div>
  596 
  597     <!-- ========== Info from phpDoc block ========= -->
  598 <p class="short-description">Contains all rules defining the content-types of pages/files that should be streamed directly to  a temporary file (instead of to memory)</p>
  599     <ul class="tags">
  600                 <li><span class="field">var:</span> Numeric array conatining the regex-rules</li>
  601                 <li><span class="field">access:</span> protected</li>
  602             </ul>
  603     
  604     
  605         
  606         
  607 
  608 </div>
  609 <a name="var$socket" id="$socket"><!-- --></A>
  610 <div class="evenrow">
  611 
  612     <div class="var-header">
  613         <span class="var-title">
  614             <span class="var-type">mixed</span>
  615             <span class="var-name">$socket</span>
  616                         (line <span class="line-number">132</span>)
  617         </span>
  618     </div>
  619 
  620     <!-- ========== Info from phpDoc block ========= -->
  621 <p class="short-description">The socket used for HTTP-requests</p>
  622     <ul class="tags">
  623                 <li><span class="field">access:</span> protected</li>
  624             </ul>
  625     
  626     
  627         
  628         
  629 
  630 </div>
  631 <a name="var$socketConnectTimeout" id="$socketConnectTimeout"><!-- --></A>
  632 <div class="oddrow">
  633 
  634     <div class="var-header">
  635         <span class="var-title">
  636             <span class="var-type">mixed</span>
  637             <span class="var-name">$socketConnectTimeout</span>
  638              = <span class="var-default"> 5</span>          (line <span class="line-number">18</span>)
  639         </span>
  640     </div>
  641 
  642     <!-- ========== Info from phpDoc block ========= -->
  643 <p class="short-description">Timeout-value for socket-connection</p>
  644     <ul class="tags">
  645                 <li><span class="field">access:</span> public</li>
  646             </ul>
  647     
  648     
  649         
  650         
  651 
  652 </div>
  653 <a name="var$socketReadTimeout" id="$socketReadTimeout"><!-- --></A>
  654 <div class="evenrow">
  655 
  656     <div class="var-header">
  657         <span class="var-title">
  658             <span class="var-type">mixed</span>
  659             <span class="var-name">$socketReadTimeout</span>
  660              = <span class="var-default"> 2</span>          (line <span class="line-number">23</span>)
  661         </span>
  662     </div>
  663 
  664     <!-- ========== Info from phpDoc block ========= -->
  665 <p class="short-description">Socket-read-timeout</p>
  666     <ul class="tags">
  667                 <li><span class="field">access:</span> public</li>
  668             </ul>
  669     
  670     
  671         
  672         
  673 
  674 </div>
  675 <a name="var$tmpFile" id="$tmpFile"><!-- --></A>
  676 <div class="oddrow">
  677 
  678     <div class="var-header">
  679         <span class="var-title">
  680             <span class="var-type">string</span>
  681             <span class="var-name">$tmpFile</span>
  682              = <span class="var-default"> &quot;phpcrawl.tmp&quot;</span>           (line <span class="line-number">73</span>)
  683         </span>
  684     </div>
  685 
  686     <!-- ========== Info from phpDoc block ========= -->
  687 <p class="short-description">The TMP-File to use when a page/file should be streamed to file.</p>
  688     <ul class="tags">
  689                 <li><span class="field">access:</span> protected</li>
  690             </ul>
  691     
  692     
  693         
  694         
  695 
  696 </div>
  697 <a name="var$UrlDescriptor" id="$UrlDescriptor"><!-- --></A>
  698 <div class="evenrow">
  699 
  700     <div class="var-header">
  701         <span class="var-title">
  702             <span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>
  703             <span class="var-name">$UrlDescriptor</span>
  704                         (line <span class="line-number">80</span>)
  705         </span>
  706     </div>
  707 
  708     <!-- ========== Info from phpDoc block ========= -->
  709 <p class="short-description">The URL for the request as PHPCrawlerURLDescriptor-object</p>
  710     <ul class="tags">
  711                 <li><span class="field">access:</span> protected</li>
  712             </ul>
  713     
  714     
  715         
  716         
  717 
  718 </div>
  719 <a name="var$url_parts" id="$url_parts"><!-- --></A>
  720 <div class="oddrow">
  721 
  722     <div class="var-header">
  723         <span class="var-title">
  724             <span class="var-type">array</span>
  725             <span class="var-name">$url_parts</span>
  726              = <span class="var-default">array()</span>         (line <span class="line-number">87</span>)
  727         </span>
  728     </div>
  729 
  730     <!-- ========== Info from phpDoc block ========= -->
  731 <p class="short-description">The parts of the URL for the request as returned by PHPCrawlerUtils::splitURL()</p>
  732     <ul class="tags">
  733                 <li><span class="field">access:</span> protected</li>
  734             </ul>
  735     
  736     
  737         
  738         
  739 
  740 </div>
  741 <a name="var$userAgentString" id="$userAgentString"><!-- --></A>
  742 <div class="evenrow">
  743 
  744     <div class="var-header">
  745         <span class="var-title">
  746             <span class="var-type">mixed</span>
  747             <span class="var-name">$userAgentString</span>
  748              = <span class="var-default"> &quot;PHPCrawl&quot;</span>           (line <span class="line-number">13</span>)
  749         </span>
  750     </div>
  751 
  752     <!-- ========== Info from phpDoc block ========= -->
  753 <p class="short-description">The user-agent-string</p>
  754     <ul class="tags">
  755                 <li><span class="field">access:</span> public</li>
  756             </ul>
  757     
  758     
  759         
  760         
  761 
  762 </div>
  763                         
  764         </div>
  765     </div>
  766     
  767     <a name="sec-methods"></a>
  768     <div class="info-box">
  769         <div class="info-box-title">Methods</div>
  770         <div class="nav-bar">
  771             <a href="#sec-description">Description</a> |
  772                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  773                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  774                         
  775         </div>
  776         <div class="info-box-body">
  777             <A NAME='method_detail'></A>
  778 
  779 <a name="method__construct" id="__construct"><!-- --></a>
  780 <div class="oddrow">
  781     
  782     <div class="method-header">
  783         <span class="method-title">Constructor __construct</span> (line <span class="line-number">136</span>)
  784     </div> 
  785     
  786     <!-- ========== Info from phpDoc block ========= -->
  787     <ul class="tags">
  788                 <li><span class="field">access:</span> public</li>
  789             </ul>
  790     
  791     <div class="method-signature">
  792         <span class="method-result">PHPCrawlerHTTPRequest</span>
  793         <span class="method-name">
  794             __construct
  795         </span>
  796                 ()
  797             </div>
  798     
  799         
  800             
  801     </div>
  802 <a name="methodaddCookie" id="addCookie"><!-- --></a>
  803 <div class="evenrow">
  804     
  805     <div class="method-header">
  806         <span class="method-title">addCookie</span> (line <span class="line-number">172</span>)
  807     </div> 
  808     
  809     <!-- ========== Info from phpDoc block ========= -->
  810 <p class="short-description">Adds a cookie to send with the request.</p>
  811     <ul class="tags">
  812                 <li><span class="field">access:</span> public</li>
  813             </ul>
  814     
  815     <div class="method-signature">
  816         <span class="method-result">void</span>
  817         <span class="method-name">
  818             addCookie
  819         </span>
  820                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  821             </div>
  822     
  823             <ul class="parameters">
  824                     <li>
  825                 <span class="var-type">string</span>
  826                 <span class="var-name">$name</span><span class="var-description">: Cookie-name</span>           </li>
  827                     <li>
  828                 <span class="var-type">string</span>
  829                 <span class="var-name">$value</span><span class="var-description">: Cookie-value</span>         </li>
  830                 </ul>
  831         
  832             
  833     </div>
  834 <a name="methodaddCookieDescriptor" id="addCookieDescriptor"><!-- --></a>
  835 <div class="oddrow">
  836     
  837     <div class="method-header">
  838         <span class="method-title">addCookieDescriptor</span> (line <span class="line-number">182</span>)
  839     </div> 
  840     
  841     <!-- ========== Info from phpDoc block ========= -->
  842 <p class="short-description">Adds a cookie to send with the request.</p>
  843     <ul class="tags">
  844                 <li><span class="field">access:</span> public</li>
  845             </ul>
  846     
  847     <div class="method-signature">
  848         <span class="method-result">void</span>
  849         <span class="method-name">
  850             addCookieDescriptor
  851         </span>
  852                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
  853             </div>
  854     
  855             <ul class="parameters">
  856                     <li>
  857                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>
  858                 <span class="var-name">$Cookie</span>           </li>
  859                 </ul>
  860         
  861             
  862     </div>
  863 <a name="methodaddCookieDescriptors" id="addCookieDescriptors"><!-- --></a>
  864 <div class="evenrow">
  865     
  866     <div class="method-header">
  867         <span class="method-title">addCookieDescriptors</span> (line <span class="line-number">193</span>)
  868     </div> 
  869     
  870     <!-- ========== Info from phpDoc block ========= -->
  871 <p class="short-description">Adds a bunch of cookies to send with the request</p>
  872     <ul class="tags">
  873                 <li><span class="field">access:</span> public</li>
  874             </ul>
  875     
  876     <div class="method-signature">
  877         <span class="method-result">void</span>
  878         <span class="method-name">
  879             addCookieDescriptors
  880         </span>
  881                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
  882             </div>
  883     
  884             <ul class="parameters">
  885                     <li>
  886                 <span class="var-type">array</span>
  887                 <span class="var-name">$cookies</span><span class="var-description">: Numeric array containins cookies as PHPCrawlerCookieDescriptor-objects</span>         </li>
  888                 </ul>
  889         
  890             
  891     </div>
  892 <a name="methodaddLinkSearchContentType" id="addLinkSearchContentType"><!-- --></a>
  893 <div class="oddrow">
  894     
  895     <div class="method-header">
  896         <span class="method-title">addLinkSearchContentType</span> (line <span class="line-number">995</span>)
  897     </div> 
  898     
  899     <!-- ========== Info from phpDoc block ========= -->
  900 <p class="short-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)</p>
  901     <ul class="tags">
  902                 <li><span class="field">return:</span> TRUE if the rule was successfully added</li>
  903             </ul>
  904     
  905     <div class="method-signature">
  906         <span class="method-result">bool</span>
  907         <span class="method-name">
  908             addLinkSearchContentType
  909         </span>
  910                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>)
  911             </div>
  912     
  913             <ul class="parameters">
  914                     <li>
  915                 <span class="var-type">string</span>
  916                 <span class="var-name">$regex</span><span class="var-description">: Regular-expression defining the rule</span>         </li>
  917                 </ul>
  918         
  919             
  920     </div>
  921 <a name="methodaddPostData" id="addPostData"><!-- --></a>
  922 <div class="evenrow">
  923     
  924     <div class="method-header">
  925         <span class="method-title">addPostData</span> (line <span class="line-number">241</span>)
  926     </div> 
  927     
  928     <!-- ========== Info from phpDoc block ========= -->
  929 <p class="short-description">Adds post-data to send with the request.</p>
  930     <ul class="tags">
  931                 <li><span class="field">access:</span> public</li>
  932             </ul>
  933     
  934     <div class="method-signature">
  935         <span class="method-result">void</span>
  936         <span class="method-name">
  937             addPostData
  938         </span>
  939                     (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  940             </div>
  941     
  942             <ul class="parameters">
  943                     <li>
  944                 <span class="var-type"></span>
  945                 <span class="var-name">$key</span>          </li>
  946                     <li>
  947                 <span class="var-type"></span>
  948                 <span class="var-name">$value</span>            </li>
  949                 </ul>
  950         
  951             
  952     </div>
  953 <a name="methodaddReceiveContentType" id="addReceiveContentType"><!-- --></a>
  954 <div class="oddrow">
  955     
  956     <div class="method-header">
  957         <span class="method-title">addReceiveContentType</span> (line <span class="line-number">909</span>)
  958     </div> 
  959     
  960     <!-- ========== Info from phpDoc block ========= -->
  961 <p class="short-description">Adds a rule to the list of rules that decides which pages or files - regarding their content-type - should be received</p>
  962 <p class="description"><p>If the content-type of a requested document doesn't match with the given rules, the request will be aborted after the header  was received.</p></p>
  963     <ul class="tags">
  964                 <li><span class="field">return:</span> TRUE if the rule was added to the list.               FALSE if the given regex is not valid.</li>
  965                 <li><span class="field">access:</span> public</li>
  966             </ul>
  967     
  968     <div class="method-signature">
  969         <span class="method-result">bool</span>
  970         <span class="method-name">
  971             addReceiveContentType
  972         </span>
  973                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>)
  974             </div>
  975     
  976             <ul class="parameters">
  977                     <li>
  978                 <span class="var-type">string</span>
  979                 <span class="var-name">$regex</span><span class="var-description">: The rule as a regular-expression</span>         </li>
  980                 </ul>
  981         
  982             
  983     </div>
  984 <a name="methodaddStreamToFileContentType" id="addStreamToFileContentType"><!-- --></a>
  985 <div class="evenrow">
  986     
  987     <div class="method-header">
  988         <span class="method-title">addStreamToFileContentType</span> (line <span class="line-number">929</span>)
  989     </div> 
  990     
  991     <!-- ========== Info from phpDoc block ========= -->
  992 <p class="short-description">Adds a rule to the list of rules that decides what types of content should be streamed diretly to the temporary file.</p>
  993 <p class="description"><p>If a content-type of a page or file matches with one of these rules, the content will be streamed directly into the temporary file  given in setTmpFile() without claiming local RAM.</p></p>
  994     <ul class="tags">
  995                 <li><span class="field">return:</span> TRUE if the rule was added to the list and the regex is valid.</li>
  996                 <li><span class="field">access:</span> public</li>
  997             </ul>
  998     
  999     <div class="method-signature">
 1000         <span class="method-result">bool</span>
 1001         <span class="method-name">
 1002             addStreamToFileContentType
 1003         </span>
 1004                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$regex</span>)
 1005             </div>
 1006     
 1007             <ul class="parameters">
 1008                     <li>
 1009                 <span class="var-type">string</span>
 1010                 <span class="var-name">$regex</span><span class="var-description">: The rule as a regular-expression</span>         </li>
 1011                 </ul>
 1012         
 1013             
 1014     </div>
 1015 <a name="methodbuildCookieHeader" id="buildCookieHeader"><!-- --></a>
 1016 <div class="oddrow">
 1017     
 1018     <div class="method-header">
 1019         <span class="method-title">buildCookieHeader</span> (line <span class="line-number">836</span>)
 1020     </div> 
 1021     
 1022     <!-- ========== Info from phpDoc block ========= -->
 1023 <p class="short-description">Builds the cookie-header-part for the header to send.</p>
 1024     <ul class="tags">
 1025                 <li><span class="field">return:</span> The cookie-header-part, i.e. &quot;Cookie: test=bla; palimm=palaber&quot;</li>
 1026                 <li><span class="field">access:</span> protected</li>
 1027             </ul>
 1028     
 1029     <div class="method-signature">
 1030         <span class="method-result">string</span>
 1031         <span class="method-name">
 1032             buildCookieHeader
 1033         </span>
 1034                 ()
 1035             </div>
 1036     
 1037         
 1038             
 1039     </div>
 1040 <a name="methodbuildPostContent" id="buildPostContent"><!-- --></a>
 1041 <div class="evenrow">
 1042     
 1043     <div class="method-header">
 1044         <span class="method-title">buildPostContent</span> (line <span class="line-number">813</span>)
 1045     </div> 
 1046     
 1047     <!-- ========== Info from phpDoc block ========= -->
 1048 <p class="short-description">Builds the post-content from the postdata-array for the header to send with the request (MIME-style)</p>
 1049     <ul class="tags">
 1050                 <li><span class="field">return:</span> Numeric array containing the lines of the POST-part for the header</li>
 1051                 <li><span class="field">access:</span> protected</li>
 1052             </ul>
 1053     
 1054     <div class="method-signature">
 1055         <span class="method-result">array</span>
 1056         <span class="method-name">
 1057             buildPostContent
 1058         </span>
 1059                 ()
 1060             </div>
 1061     
 1062         
 1063             
 1064     </div>
 1065 <a name="methodbuildRequestHeader" id="buildRequestHeader"><!-- --></a>
 1066 <div class="oddrow">
 1067     
 1068     <div class="method-header">
 1069         <span class="method-title">buildRequestHeader</span> (line <span class="line-number">701</span>)
 1070     </div> 
 1071     
 1072     <!-- ========== Info from phpDoc block ========= -->
 1073 <p class="short-description">Builds the request-header from the given settings.</p>
 1074     <ul class="tags">
 1075                 <li><span class="field">return:</span> Numeric array containing the lines of the request-header</li>
 1076                 <li><span class="field">access:</span> protected</li>
 1077             </ul>
 1078     
 1079     <div class="method-signature">
 1080         <span class="method-result">array</span>
 1081         <span class="method-name">
 1082             buildRequestHeader
 1083         </span>
 1084                 ()
 1085             </div>
 1086     
 1087         
 1088             
 1089     </div>
 1090 <a name="methodclearCookies" id="clearCookies"><!-- --></a>
 1091 <div class="evenrow">
 1092     
 1093     <div class="method-header">
 1094         <span class="method-title">clearCookies</span> (line <span class="line-number">205</span>)
 1095     </div> 
 1096     
 1097     <!-- ========== Info from phpDoc block ========= -->
 1098 <p class="short-description">Removes all cookies to send with the request.</p>
 1099     <ul class="tags">
 1100                 <li><span class="field">access:</span> public</li>
 1101             </ul>
 1102     
 1103     <div class="method-signature">
 1104         <span class="method-result">void</span>
 1105         <span class="method-name">
 1106             clearCookies
 1107         </span>
 1108                 ()
 1109             </div>
 1110     
 1111         
 1112             
 1113     </div>
 1114 <a name="methodclearPostData" id="clearPostData"><!-- --></a>
 1115 <div class="oddrow">
 1116     
 1117     <div class="method-header">
 1118         <span class="method-title">clearPostData</span> (line <span class="line-number">249</span>)
 1119     </div> 
 1120     
 1121     <!-- ========== Info from phpDoc block ========= -->
 1122 <p class="short-description">Removes all post-data to send with the request.</p>
 1123     <ul class="tags">
 1124                 <li><span class="field">access:</span> public</li>
 1125             </ul>
 1126     
 1127     <div class="method-signature">
 1128         <span class="method-result">void</span>
 1129         <span class="method-name">
 1130             clearPostData
 1131         </span>
 1132                 ()
 1133             </div>
 1134     
 1135         
 1136             
 1137     </div>
 1138 <a name="methoddecideRecevieContent" id="decideRecevieContent"><!-- --></a>
 1139 <div class="evenrow">
 1140     
 1141     <div class="method-header">
 1142         <span class="method-title">decideRecevieContent</span> (line <span class="line-number">863</span>)
 1143     </div> 
 1144     
 1145     <!-- ========== Info from phpDoc block ========= -->
 1146 <p class="short-description">Checks whether the content of this page/file should be received (based on the content-type  and the applied rules)</p>
 1147     <ul class="tags">
 1148                 <li><span class="field">return:</span> TRUE if the content should be received</li>
 1149                 <li><span class="field">access:</span> protected</li>
 1150             </ul>
 1151     
 1152     <div class="method-signature">
 1153         <span class="method-result">bool</span>
 1154         <span class="method-name">
 1155             decideRecevieContent
 1156         </span>
 1157                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerResponseHeader.html">PHPCrawlerResponseHeader</a></span>&nbsp;<span class="var-name">$responseHeader</span>)
 1158             </div>
 1159     
 1160             <ul class="parameters">
 1161                     <li>
 1162                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerResponseHeader.html">PHPCrawlerResponseHeader</a></span>
 1163                 <span class="var-name">$responseHeader</span><span class="var-description">: The response-header as an PHPCrawlerResponseHeader-object</span>           </li>
 1164                 </ul>
 1165         
 1166             
 1167     </div>
 1168 <a name="methoddecideStreamToFile" id="decideStreamToFile"><!-- --></a>
 1169 <div class="oddrow">
 1170     
 1171     <div class="method-header">
 1172         <span class="method-title">decideStreamToFile</span> (line <span class="line-number">883</span>)
 1173     </div> 
 1174     
 1175     <!-- ========== Info from phpDoc block ========= -->
 1176 <p class="short-description">Checks whether the content of this page/file should be streamed directly to file.</p>
 1177     <ul class="tags">
 1178                 <li><span class="field">return:</span> TRUE if the content should be streamed to TMP-file</li>
 1179                 <li><span class="field">access:</span> protected</li>
 1180             </ul>
 1181     
 1182     <div class="method-signature">
 1183         <span class="method-result">bool</span>
 1184         <span class="method-name">
 1185             decideStreamToFile
 1186         </span>
 1187                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$response_header</span>)
 1188             </div>
 1189     
 1190             <ul class="parameters">
 1191                     <li>
 1192                 <span class="var-type">string</span>
 1193                 <span class="var-name">$response_header</span><span class="var-description">: The response-header</span>            </li>
 1194                 </ul>
 1195         
 1196             
 1197     </div>
 1198 <a name="methodenableAggressiveLinkSearch" id="enableAggressiveLinkSearch"><!-- --></a>
 1199 <div class="evenrow">
 1200     
 1201     <div class="method-header">
 1202         <span class="method-title">enableAggressiveLinkSearch</span> (line <span class="line-number">278</span>)
 1203     </div> 
 1204     
 1205     <!-- ========== Info from phpDoc block ========= -->
 1206 <p class="short-description">Enables/disables aggresive linksearch</p>
 1207     <ul class="tags">
 1208                 <li><span class="field">access:</span> public</li>
 1209             </ul>
 1210     
 1211     <div class="method-signature">
 1212         <span class="method-result">bool</span>
 1213         <span class="method-name">
 1214             enableAggressiveLinkSearch
 1215         </span>
 1216                     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$mode</span>)
 1217             </div>
 1218     
 1219             <ul class="parameters">
 1220                     <li>
 1221                 <span class="var-type">bool</span>
 1222                 <span class="var-name">$mode</span>         </li>
 1223                 </ul>
 1224         
 1225             
 1226     </div>
 1227 <a name="methodgetGlobalTrafficCount" id="getGlobalTrafficCount"><!-- --></a>
 1228 <div class="oddrow">
 1229     
 1230     <div class="method-header">
 1231         <span class="method-title">getGlobalTrafficCount</span> (line <span class="line-number">983</span>)
 1232     </div> 
 1233     
 1234     <!-- ========== Info from phpDoc block ========= -->
 1235 <p class="short-description">Returns the global traffic this instance of the HTTPRequest-class caused so far.</p>
 1236     <ul class="tags">
 1237                 <li><span class="field">return:</span> The traffic in bytes.</li>
 1238                 <li><span class="field">access:</span> public</li>
 1239             </ul>
 1240     
 1241     <div class="method-signature">
 1242         <span class="method-result">int</span>
 1243         <span class="method-name">
 1244             getGlobalTrafficCount
 1245         </span>
 1246                 ()
 1247             </div>
 1248     
 1249         
 1250             
 1251     </div>
 1252 <a name="methodopenSocket" id="openSocket"><!-- --></a>
 1253 <div class="evenrow">
 1254     
 1255     <div class="method-header">
 1256         <span class="method-title">openSocket</span> (line <span class="line-number">426</span>)
 1257     </div> 
 1258     
 1259     <!-- ========== Info from phpDoc block ========= -->
 1260 <p class="short-description">Opens the socket to the host.</p>
 1261     <ul class="tags">
 1262                 <li><span class="field">return:</span> TRUE if socket could be opened, otherwise FALSE.</li>
 1263                 <li><span class="field">access:</span> protected</li>
 1264             </ul>
 1265     
 1266     <div class="method-signature">
 1267         <span class="method-result">bool</span>
 1268         <span class="method-name">
 1269             openSocket
 1270         </span>
 1271                     (<span class="var-type">int</span>&nbsp;<span class="var-name">&$error_code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$error_string</span>)
 1272             </div>
 1273     
 1274             <ul class="parameters">
 1275                     <li>
 1276                 <span class="var-type">int</span>
 1277                 <span class="var-name">&$error_code</span><span class="var-description">: Error-code by referenct if an error occured.</span>           </li>
 1278                     <li>
 1279                 <span class="var-type">string</span>
 1280                 <span class="var-name">&$error_string</span><span class="var-description">: Error-string by reference</span>            </li>
 1281                 </ul>
 1282         
 1283             
 1284     </div>
 1285 <a name="methodprepareHTTPRequestQuery" id="prepareHTTPRequestQuery"><!-- --></a>
 1286 <div class="oddrow">
 1287     
 1288     <div class="method-header">
 1289         <span class="method-title">prepareHTTPRequestQuery</span> (line <span class="line-number">777</span>)
 1290     </div> 
 1291     
 1292     <!-- ========== Info from phpDoc block ========= -->
 1293 <p class="short-description">Prepares the given HTTP-query-string for the HTTP-request.</p>
 1294 <p class="description"><p></p></p>
 1295     <ul class="tags">
 1296                 <li><span class="field">access:</span> protected</li>
 1297             </ul>
 1298     
 1299     <div class="method-signature">
 1300         <span class="method-result">string</span>
 1301         <span class="method-name">
 1302             prepareHTTPRequestQuery
 1303         </span>
 1304                     (<span class="var-type">stirng</span>&nbsp;<span class="var-name">$query</span>)
 1305             </div>
 1306     
 1307             <ul class="parameters">
 1308                     <li>
 1309                 <span class="var-type">stirng</span>
 1310                 <span class="var-name">$query</span>            </li>
 1311                 </ul>
 1312         
 1313             
 1314     </div>
 1315 <a name="methodreadResponseContent" id="readResponseContent"><!-- --></a>
 1316 <div class="evenrow">
 1317     
 1318     <div class="method-header">
 1319         <span class="method-title">readResponseContent</span> (line <span class="line-number">590</span>)
 1320     </div> 
 1321     
 1322     <!-- ========== Info from phpDoc block ========= -->
 1323 <p class="short-description">Reads the response-content.</p>
 1324     <ul class="tags">
 1325                 <li><span class="field">return:</span> The response-content/source. May be emtpy if an error ocdured or data was streamed to the tmp-file.</li>
 1326                 <li><span class="field">access:</span> protected</li>
 1327             </ul>
 1328     
 1329     <div class="method-signature">
 1330         <span class="method-result">string</span>
 1331         <span class="method-name">
 1332             readResponseContent
 1333         </span>
 1334                     ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$stream_to_file</span> = <span class="var-default">false</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">&$error_code</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">&$error_string</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">&$document_received_completely</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">&$bytes_received</span>)
 1335             </div>
 1336     
 1337             <ul class="parameters">
 1338                     <li>
 1339                 <span class="var-type">bool</span>
 1340                 <span class="var-name">$stream_to_file</span><span class="var-description">: If TRUE, the content will be streamed diretly to the temporary file and                                 this method will not return the content as a string.</span>            </li>
 1341                     <li>
 1342                 <span class="var-type">int</span>
 1343                 <span class="var-name">&$error_code</span><span class="var-description">: Error-code by reference if an error occured.</span>           </li>
 1344                     <li>
 1345                 <span class="var-type">&string</span>
 1346                 <span class="var-name">&$error_string</span><span class="var-description">: Error-string by reference</span>            </li>
 1347                     <li>
 1348                 <span class="var-type">&string</span>
 1349                 <span class="var-name">&$document_received_completely</span><span class="var-description">: Flag indicatign whether the content was received completely passed by reference</span>          </li>
 1350                     <li>
 1351                 <span class="var-type">&string</span>
 1352                 <span class="var-name">&$bytes_received</span><span class="var-description">: Number of bytes received, passed by reference</span>          </li>
 1353                 </ul>
 1354         
 1355             
 1356     </div>
 1357 <a name="methodreadResponseHeader" id="readResponseHeader"><!-- --></a>
 1358 <div class="oddrow">
 1359     
 1360     <div class="method-header">
 1361         <span class="method-title">readResponseHeader</span> (line <span class="line-number">511</span>)
 1362     </div> 
 1363     
 1364     <!-- ========== Info from phpDoc block ========= -->
 1365 <p class="short-description">Reads the response-header.</p>
 1366     <ul class="tags">
 1367                 <li><span class="field">return:</span> The response-header or NULL if an error occured</li>
 1368                 <li><span class="field">access:</span> protected</li>
 1369             </ul>
 1370     
 1371     <div class="method-signature">
 1372         <span class="method-result">string</span>
 1373         <span class="method-name">
 1374             readResponseHeader
 1375         </span>
 1376                     (<span class="var-type">int</span>&nbsp;<span class="var-name">&$error_code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$error_string</span>)
 1377             </div>
 1378     
 1379             <ul class="parameters">
 1380                     <li>
 1381                 <span class="var-type">int</span>
 1382                 <span class="var-name">&$error_code</span><span class="var-description">: Error-code by reference if an error occured.</span>           </li>
 1383                     <li>
 1384                 <span class="var-type">string</span>
 1385                 <span class="var-name">&$error_string</span><span class="var-description">: Error-string by reference</span>            </li>
 1386                 </ul>
 1387         
 1388             
 1389     </div>
 1390 <a name="methodsendRequest" id="sendRequest"><!-- --></a>
 1391 <div class="evenrow">
 1392     
 1393     <div class="method-header">
 1394         <span class="method-title">sendRequest</span> (line <span class="line-number">296</span>)
 1395     </div> 
 1396     
 1397     <!-- ========== Info from phpDoc block ========= -->
 1398 <p class="short-description">Sends the HTTP-request and receives the page/file.</p>
 1399     <ul class="tags">
 1400                 <li><span class="field">return:</span> PHPCrawlerDocumentInfo-object containing all information about the received page/file</li>
 1401                 <li><span class="field">access:</span> public</li>
 1402             </ul>
 1403     
 1404     <div class="method-signature">
 1405         <span class="method-result">A</span>
 1406         <span class="method-name">
 1407             sendRequest
 1408         </span>
 1409                 ()
 1410             </div>
 1411     
 1412         
 1413             
 1414     </div>
 1415 <a name="methodsendRequestHeader" id="sendRequestHeader"><!-- --></a>
 1416 <div class="oddrow">
 1417     
 1418     <div class="method-header">
 1419         <span class="method-title">sendRequestHeader</span> (line <span class="line-number">490</span>)
 1420     </div> 
 1421     
 1422     <!-- ========== Info from phpDoc block ========= -->
 1423 <p class="short-description">Send the request-header.</p>
 1424     <ul class="tags">
 1425                 <li><span class="field">access:</span> protected</li>
 1426             </ul>
 1427     
 1428     <div class="method-signature">
 1429         <span class="method-result">void</span>
 1430         <span class="method-name">
 1431             sendRequestHeader
 1432         </span>
 1433                     (<span class="var-type"></span>&nbsp;<span class="var-name">$request_header_lines</span>)
 1434             </div>
 1435     
 1436             <ul class="parameters">
 1437                     <li>
 1438                 <span class="var-type"></span>
 1439                 <span class="var-name">$request_header_lines</span>         </li>
 1440                 </ul>
 1441         
 1442             
 1443     </div>
 1444 <a name="methodsetBasicAuthentication" id="setBasicAuthentication"><!-- --></a>
 1445 <div class="evenrow">
 1446     
 1447     <div class="method-header">
 1448         <span class="method-title">setBasicAuthentication</span> (line <span class="line-number">266</span>)
 1449     </div> 
 1450     
 1451     <!-- ========== Info from phpDoc block ========= -->
 1452 <p class="short-description">Sets basic-authentication login-data for protected URLs.</p>
 1453     <ul class="tags">
 1454                 <li><span class="field">access:</span> public</li>
 1455             </ul>
 1456     
 1457     <div class="method-signature">
 1458         <span class="method-result">void</span>
 1459         <span class="method-name">
 1460             setBasicAuthentication
 1461         </span>
 1462                     (<span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
 1463             </div>
 1464     
 1465             <ul class="parameters">
 1466                     <li>
 1467                 <span class="var-type"></span>
 1468                 <span class="var-name">$username</span>         </li>
 1469                     <li>
 1470                 <span class="var-type"></span>
 1471                 <span class="var-name">$password</span>         </li>
 1472                 </ul>
 1473         
 1474             
 1475     </div>
 1476 <a name="methodsetContentSizeLimit" id="setContentSizeLimit"><!-- --></a>
 1477 <div class="oddrow">
 1478     
 1479     <div class="method-header">
 1480         <span class="method-title">setContentSizeLimit</span> (line <span class="line-number">968</span>)
 1481     </div> 
 1482     
 1483     <!-- ========== Info from phpDoc block ========= -->
 1484 <p class="short-description">Sets the size-limit in bytes for content the request should receive.</p>
 1485     <ul class="tags">
 1486                 <li><span class="field">access:</span> public</li>
 1487             </ul>
 1488     
 1489     <div class="method-signature">
 1490         <span class="method-result">bool</span>
 1491         <span class="method-name">
 1492             setContentSizeLimit
 1493         </span>
 1494                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$bytes</span>)
 1495             </div>
 1496     
 1497             <ul class="parameters">
 1498                     <li>
 1499                 <span class="var-type">int</span>
 1500                 <span class="var-name">$bytes</span>            </li>
 1501                 </ul>
 1502         
 1503             
 1504     </div>
 1505 <a name="methodsetFindRedirectURLs" id="setFindRedirectURLs"><!-- --></a>
 1506 <div class="evenrow">
 1507     
 1508     <div class="method-header">
 1509         <span class="method-title">setFindRedirectURLs</span> (line <span class="line-number">229</span>)
 1510     </div> 
 1511     
 1512     <!-- ========== Info from phpDoc block ========= -->
 1513 <p class="short-description">Specifies whether redirect-links set in http-headers should get searched for.</p>
 1514     <ul class="tags">
 1515                 <li><span class="field">access:</span> public</li>
 1516             </ul>
 1517     
 1518     <div class="method-signature">
 1519         <span class="method-result">bool</span>
 1520         <span class="method-name">
 1521             setFindRedirectURLs
 1522         </span>
 1523                     (<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>)
 1524             </div>
 1525     
 1526             <ul class="parameters">
 1527                     <li>
 1528                 <span class="var-type"></span>
 1529                 <span class="var-name">$mode</span>         </li>
 1530                 </ul>
 1531         
 1532             
 1533     </div>
 1534 <a name="methodsetHeaderCheckCallbackFunction" id="setHeaderCheckCallbackFunction"><!-- --></a>
 1535 <div class="oddrow">
 1536     
 1537     <div class="method-header">
 1538         <span class="method-title">setHeaderCheckCallbackFunction</span> (line <span class="line-number">286</span>)
 1539     </div> 
 1540     
 1541     <!-- ========== Info from phpDoc block ========= -->
 1542     <ul class="tags">
 1543                 <li><span class="field">access:</span> public</li>
 1544             </ul>
 1545     
 1546     <div class="method-signature">
 1547         <span class="method-result">void</span>
 1548         <span class="method-name">
 1549             setHeaderCheckCallbackFunction
 1550         </span>
 1551                     (<span class="var-type"></span>&nbsp;<span class="var-name">&$obj</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$method_name</span>)
 1552             </div>
 1553     
 1554             <ul class="parameters">
 1555                     <li>
 1556                 <span class="var-type"></span>
 1557                 <span class="var-name">&$obj</span>         </li>
 1558                     <li>
 1559                 <span class="var-type"></span>
 1560                 <span class="var-name">$method_name</span>          </li>
 1561                 </ul>
 1562         
 1563             
 1564     </div>
 1565 <a name="methodsetLinkExtractionTags" id="setLinkExtractionTags"><!-- --></a>
 1566 <div class="evenrow">
 1567     
 1568     <div class="method-header">
 1569         <span class="method-title">setLinkExtractionTags</span> (line <span class="line-number">216</span>)
 1570     </div> 
 1571     
 1572     <!-- ========== Info from phpDoc block ========= -->
 1573 <p class="short-description">Sets the html-tags from which to extract/find links from.</p>
 1574     <ul class="tags">
 1575                 <li><span class="field">access:</span> public</li>
 1576             </ul>
 1577     
 1578     <div class="method-signature">
 1579         <span class="method-result">bool</span>
 1580         <span class="method-name">
 1581             setLinkExtractionTags
 1582         </span>
 1583                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$tag_array</span>)
 1584             </div>
 1585     
 1586             <ul class="parameters">
 1587                     <li>
 1588                 <span class="var-type">array</span>
 1589                 <span class="var-name">$tag_array</span><span class="var-description">: Numeric array containing the tags, i.g. array(&quot;href&quot;, &quot;src&quot;, &quot;url&quot;, ...)</span>           </li>
 1590                 </ul>
 1591         
 1592             
 1593     </div>
 1594 <a name="methodsetProxy" id="setProxy"><!-- --></a>
 1595 <div class="oddrow">
 1596     
 1597     <div class="method-header">
 1598         <span class="method-title">setProxy</span> (line <span class="line-number">254</span>)
 1599     </div> 
 1600     
 1601     <!-- ========== Info from phpDoc block ========= -->
 1602     <ul class="tags">
 1603                 <li><span class="field">access:</span> public</li>
 1604             </ul>
 1605     
 1606     <div class="method-signature">
 1607         <span class="method-result">void</span>
 1608         <span class="method-name">
 1609             setProxy
 1610         </span>
 1611                     (<span class="var-type"></span>&nbsp;<span class="var-name">$proxy_host</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$proxy_port</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$proxy_username</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$proxy_password</span> = <span class="var-default">null</span>])
 1612             </div>
 1613     
 1614             <ul class="parameters">
 1615                     <li>
 1616                 <span class="var-type"></span>
 1617                 <span class="var-name">$proxy_host</span>           </li>
 1618                     <li>
 1619                 <span class="var-type"></span>
 1620                 <span class="var-name">$proxy_port</span>           </li>
 1621                     <li>
 1622                 <span class="var-type"></span>
 1623                 <span class="var-name">$proxy_username</span>           </li>
 1624                     <li>
 1625                 <span class="var-type"></span>
 1626                 <span class="var-name">$proxy_password</span>           </li>
 1627                 </ul>
 1628         
 1629             
 1630     </div>
 1631 <a name="methodsetTmpFile" id="setTmpFile"><!-- --></a>
 1632 <div class="evenrow">
 1633     
 1634     <div class="method-header">
 1635         <span class="method-title">setTmpFile</span> (line <span class="line-number">945</span>)
 1636     </div> 
 1637     
 1638     <!-- ========== Info from phpDoc block ========= -->
 1639 <p class="short-description">Sets the temporary file to use when content of found documents should be streamed directly into a temporary file.</p>
 1640     <ul class="tags">
 1641                 <li><span class="field">access:</span> public</li>
 1642             </ul>
 1643     
 1644     <div class="method-signature">
 1645         <span class="method-result">void</span>
 1646         <span class="method-name">
 1647             setTmpFile
 1648         </span>
 1649                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$tmp_file</span>)
 1650             </div>
 1651     
 1652             <ul class="parameters">
 1653                     <li>
 1654                 <span class="var-type">string</span>
 1655                 <span class="var-name">$tmp_file</span><span class="var-description">: The TMP-file to use.</span>          </li>
 1656                 </ul>
 1657         
 1658             
 1659     </div>
 1660 <a name="methodsetUrl" id="setUrl"><!-- --></a>
 1661 <div class="oddrow">
 1662     
 1663     <div class="method-header">
 1664         <span class="method-title">setUrl</span> (line <span class="line-number">158</span>)
 1665     </div> 
 1666     
 1667     <!-- ========== Info from phpDoc block ========= -->
 1668 <p class="short-description">Sets the URL for the request.</p>
 1669     <ul class="tags">
 1670                 <li><span class="field">access:</span> public</li>
 1671             </ul>
 1672     
 1673     <div class="method-signature">
 1674         <span class="method-result">void</span>
 1675         <span class="method-name">
 1676             setUrl
 1677         </span>
 1678                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>&nbsp;<span class="var-name">$UrlDescriptor</span>)
 1679             </div>
 1680     
 1681             <ul class="parameters">
 1682                     <li>
 1683                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerURLDescriptor.html">PHPCrawlerURLDescriptor</a></span>
 1684                 <span class="var-name">$UrlDescriptor</span><span class="var-description">: An PHPCrawlerURLDescriptor-object containing the URL to request</span>          </li>
 1685                 </ul>
 1686         
 1687             
 1688     </div>
 1689                         
 1690         </div>
 1691     </div>
 1692 
 1693 
 1694     <p class="notes" id="credit">
 1695         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>
 1696     </p>
 1697     </div></body>
 1698 </html>