"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerUserSendDataCache.html" (20 Jan 2013, 11802 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 PHPCrawlerUserSendDataCache</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 PHPCrawlerUserSendDataCache</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">Cache for storing user-data to send with requests, like cookies, post-data  and basic-authentications.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---PHPCrawlerUserSendDataCache.class.php.html">/libs/PHPCrawler/PHPCrawlerUserSendDataCache.class.php</a> (line <span class="field">9</span>)
   28         </p>
   29         
   30                 
   31         <pre></pre>
   32     
   33             </div>
   34 </div>
   35 
   36 
   37 
   38     <a name="sec-var-summary"></a>
   39     <div class="info-box">
   40         <div class="info-box-title">Variable Summary</span></div>
   41         <div class="nav-bar">
   42             <a href="#sec-description">Description</a> |
   43                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   44                             | 
   45                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   46                             
   47                                 </div>
   48         <div class="info-box-body">
   49             <div class="var-summary">
   50                                                                                                                                 <div class="var-title">
   51                     <span class="var-type">array</span>
   52                     <a href="#$basic_authentications" title="details" class="var-name">$basic_authentications</a>
   53                 </div>
   54                                                                 <div class="var-title">
   55                     <span class="var-type">array</span>
   56                     <a href="#$post_data" title="details" class="var-name">$post_data</a>
   57                 </div>
   58                                             </div>
   59         </div>
   60     </div>
   61 
   62     <a name="sec-method-summary"></a>
   63     <div class="info-box">
   64         <div class="info-box-title">Method Summary</span></div>
   65         <div class="nav-bar">
   66             <a href="#sec-description">Description</a> |
   67                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   68                  
   69                 |
   70                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   71         </div>
   72         <div class="info-box-body">         
   73             <div class="method-summary">
   74                                                                                                                                                 
   75                                                 <div class="method-definition">
   76                                             <span class="method-result">bool</span>
   77                                         <a href="#addBasicAuthentication" title="details" class="method-name">addBasicAuthentication</a>
   78                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url_regex</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
   79                                     </div>
   80                                                                 <div class="method-definition">
   81                                             <span class="method-result">void</span>
   82                                         <a href="#addPostData" title="details" class="method-name">addPostData</a>
   83                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url_regex</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$post_data_array</span>)
   84                                     </div>
   85                                                                 <div class="method-definition">
   86                                             <span class="method-result">array</span>
   87                                         <a href="#getBasicAuthenticationForUrl" title="details" class="method-name">getBasicAuthenticationForUrl</a>
   88                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
   89                                     </div>
   90                                                                 <div class="method-definition">
   91                                             <span class="method-result">array</span>
   92                                         <a href="#getPostDataForUrl" title="details" class="method-name">getPostDataForUrl</a>
   93                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
   94                                     </div>
   95                                 </div>
   96         </div>
   97     </div>      
   98 
   99     <a name="sec-vars"></a>
  100     <div class="info-box">
  101         <div class="info-box-title">Variables</div>
  102         <div class="nav-bar">
  103             <a href="#sec-description">Description</a> |
  104                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  105                         
  106             
  107                                         | 
  108                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  109                             
  110                     </div>
  111         <div class="info-box-body">
  112             <a name="var$basic_authentications" id="$basic_authentications"><!-- --></A>
  113 <div class="oddrow">
  114 
  115     <div class="var-header">
  116         <span class="var-title">
  117             <span class="var-type">array</span>
  118             <span class="var-name">$basic_authentications</span>
  119              = <span class="var-default">array()</span>         (line <span class="line-number">16</span>)
  120         </span>
  121     </div>
  122 
  123     <!-- ========== Info from phpDoc block ========= -->
  124 <p class="short-description">Array containing basic-authentications to send.</p>
  125     <ul class="tags">
  126                 <li><span class="field">access:</span> protected</li>
  127             </ul>
  128     
  129     
  130         
  131         
  132 
  133 </div>
  134 <a name="var$post_data" id="$post_data"><!-- --></A>
  135 <div class="evenrow">
  136 
  137     <div class="var-header">
  138         <span class="var-title">
  139             <span class="var-type">array</span>
  140             <span class="var-name">$post_data</span>
  141              = <span class="var-default">array()</span>         (line <span class="line-number">23</span>)
  142         </span>
  143     </div>
  144 
  145     <!-- ========== Info from phpDoc block ========= -->
  146 <p class="short-description">Array containing post-data to send.</p>
  147     <ul class="tags">
  148                 <li><span class="field">access:</span> protected</li>
  149             </ul>
  150     
  151     
  152         
  153         
  154 
  155 </div>
  156                         
  157         </div>
  158     </div>
  159     
  160     <a name="sec-methods"></a>
  161     <div class="info-box">
  162         <div class="info-box-title">Methods</div>
  163         <div class="nav-bar">
  164             <a href="#sec-description">Description</a> |
  165                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  166                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  167                         
  168         </div>
  169         <div class="info-box-body">
  170             <A NAME='method_detail'></A>
  171 
  172 <a name="methodaddBasicAuthentication" id="addBasicAuthentication"><!-- --></a>
  173 <div class="oddrow">
  174     
  175     <div class="method-header">
  176         <span class="method-title">addBasicAuthentication</span> (line <span class="line-number">89</span>)
  177     </div> 
  178     
  179     <!-- ========== Info from phpDoc block ========= -->
  180 <p class="short-description">Adds a basic-authentication (username and password) to the list of authentications that will be send  with requests.</p>
  181     <ul class="tags">
  182                 <li><span class="field">access:</span> public</li>
  183             </ul>
  184     
  185     <div class="method-signature">
  186         <span class="method-result">bool</span>
  187         <span class="method-name">
  188             addBasicAuthentication
  189         </span>
  190                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url_regex</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
  191             </div>
  192     
  193             <ul class="parameters">
  194                     <li>
  195                 <span class="var-type">string</span>
  196                 <span class="var-name">$url_regex</span><span class="var-description">: Regular expression defining the URL(s) the authentication should be send to.</span>         </li>
  197                     <li>
  198                 <span class="var-type">string</span>
  199                 <span class="var-name">$username</span><span class="var-description">: The username</span>          </li>
  200                     <li>
  201                 <span class="var-type">string</span>
  202                 <span class="var-name">$password</span><span class="var-description">: The password</span>          </li>
  203                 </ul>
  204         
  205             
  206     </div>
  207 <a name="methodaddPostData" id="addPostData"><!-- --></a>
  208 <div class="evenrow">
  209     
  210     <div class="method-header">
  211         <span class="method-title">addPostData</span> (line <span class="line-number">32</span>)
  212     </div> 
  213     
  214     <!-- ========== Info from phpDoc block ========= -->
  215 <p class="short-description">Adds post-data together with an URL-regex to the list of post-data to send with requests.</p>
  216     <ul class="tags">
  217                 <li><span class="field">access:</span> public</li>
  218             </ul>
  219     
  220     <div class="method-signature">
  221         <span class="method-result">void</span>
  222         <span class="method-name">
  223             addPostData
  224         </span>
  225                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url_regex</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$post_data_array</span>)
  226             </div>
  227     
  228             <ul class="parameters">
  229                     <li>
  230                 <span class="var-type">string</span>
  231                 <span class="var-name">$url_regex</span><span class="var-description">: Regular expression defining the URL(s) the post-data should be send to.</span>          </li>
  232                     <li>
  233                 <span class="var-type">array</span>
  234                 <span class="var-name">$post_data_array</span><span class="var-description">: Post-data-array, the keys are the post-data-keys, the values the post-values.                                 (like array(&quot;key1&quot; =&gt; &quot;value1&quot;, &quot;key2&quot; =&gt; &quot;value2&quot;)</span>            </li>
  235                 </ul>
  236         
  237             
  238     </div>
  239 <a name="methodgetBasicAuthenticationForUrl" id="getBasicAuthenticationForUrl"><!-- --></a>
  240 <div class="oddrow">
  241     
  242     <div class="method-header">
  243         <span class="method-title">getBasicAuthenticationForUrl</span> (line <span class="line-number">115</span>)
  244     </div> 
  245     
  246     <!-- ========== Info from phpDoc block ========= -->
  247 <p class="short-description">Returns the basic-authentication (username and password) that should be send to the given URL.</p>
  248     <ul class="tags">
  249                 <li><span class="field">return:</span> Array containing the keys &quot;username&quot; and &quot;password&quot;.                Returns NULL if no authentication was found in cache for the given URL.</li>
  250                 <li><span class="field">access:</span> public</li>
  251             </ul>
  252     
  253     <div class="method-signature">
  254         <span class="method-result">array</span>
  255         <span class="method-name">
  256             getBasicAuthenticationForUrl
  257         </span>
  258                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  259             </div>
  260     
  261             <ul class="parameters">
  262                     <li>
  263                 <span class="var-type">string</span>
  264                 <span class="var-name">$url</span><span class="var-description">: The URL.</span>           </li>
  265                 </ul>
  266         
  267             
  268     </div>
  269 <a name="methodgetPostDataForUrl" id="getPostDataForUrl"><!-- --></a>
  270 <div class="evenrow">
  271     
  272     <div class="method-header">
  273         <span class="method-title">getPostDataForUrl</span> (line <span class="line-number">63</span>)
  274     </div> 
  275     
  276     <!-- ========== Info from phpDoc block ========= -->
  277 <p class="short-description">Returns the post-data (key and value) that should be send to the given URL.</p>
  278     <ul class="tags">
  279                 <li><span class="field">return:</span> Array containing the post_keys as keys and the values as values.                (like array(&quot;key1&quot; =&gt; &quot;value1&quot;, &quot;key2&quot; =&gt; &quot;value2&quot;)</li>
  280                 <li><span class="field">access:</span> public</li>
  281             </ul>
  282     
  283     <div class="method-signature">
  284         <span class="method-result">array</span>
  285         <span class="method-name">
  286             getPostDataForUrl
  287         </span>
  288                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  289             </div>
  290     
  291             <ul class="parameters">
  292                     <li>
  293                 <span class="var-type">string</span>
  294                 <span class="var-name">$url</span><span class="var-description">: The URL.</span>           </li>
  295                 </ul>
  296         
  297             
  298     </div>
  299                         
  300         </div>
  301     </div>
  302 
  303 
  304     <p class="notes" id="credit">
  305         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>
  306     </p>
  307     </div></body>
  308 </html>