"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerCookieDescriptor.html" (20 Jan 2013, 14984 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 PHPCrawlerCookieDescriptor</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 PHPCrawlerCookieDescriptor</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">Describes a cookie within the PHPCrawl-system.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---PHPCrawlerCookieDescriptor.class.php.html">/libs/PHPCrawler/PHPCrawlerCookieDescriptor.class.php</a> (line <span class="field">7</span>)
   28         </p>
   29         
   30                 
   31         <pre></pre>
   32     
   33             </div>
   34 </div>
   35 
   36 
   37 
   38     <a name="sec-var-summary"></a>
   39     <div class="info-box">
   40         <div class="info-box-title">Variable Summary</span></div>
   41         <div class="nav-bar">
   42             <a href="#sec-description">Description</a> |
   43                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   44                             | 
   45                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   46                             
   47                                 </div>
   48         <div class="info-box-body">
   49             <div class="var-summary">
   50                                                                                                                                                                                                                                                                                                                                                                 <div class="var-title">
   51                     <span class="var-type">float</span>
   52                     <a href="#$cookie_send_time" title="details" class="var-name">$cookie_send_time</a>
   53                 </div>
   54                                                                 <div class="var-title">
   55                     <span class="var-type">string</span>
   56                     <a href="#$domain" title="details" class="var-name">$domain</a>
   57                 </div>
   58                                                                 <div class="var-title">
   59                     <span class="var-type">string</span>
   60                     <a href="#$expires" title="details" class="var-name">$expires</a>
   61                 </div>
   62                                                                 <div class="var-title">
   63                     <span class="var-type">int</span>
   64                     <a href="#$expire_timestamp" title="details" class="var-name">$expire_timestamp</a>
   65                 </div>
   66                                                                 <div class="var-title">
   67                     <span class="var-type">string</span>
   68                     <a href="#$name" title="details" class="var-name">$name</a>
   69                 </div>
   70                                                                 <div class="var-title">
   71                     <span class="var-type">string</span>
   72                     <a href="#$path" title="details" class="var-name">$path</a>
   73                 </div>
   74                                                                 <div class="var-title">
   75                     <span class="var-type">string</span>
   76                     <a href="#$source_domain" title="details" class="var-name">$source_domain</a>
   77                 </div>
   78                                                                 <div class="var-title">
   79                     <span class="var-type">string</span>
   80                     <a href="#$source_url" title="details" class="var-name">$source_url</a>
   81                 </div>
   82                                                                 <div class="var-title">
   83                     <span class="var-type">string</span>
   84                     <a href="#$value" title="details" class="var-name">$value</a>
   85                 </div>
   86                                             </div>
   87         </div>
   88     </div>
   89 
   90     <a name="sec-method-summary"></a>
   91     <div class="info-box">
   92         <div class="info-box-title">Method Summary</span></div>
   93         <div class="nav-bar">
   94             <a href="#sec-description">Description</a> |
   95                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   96                  
   97                 |
   98                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   99         </div>
  100         <div class="info-box-body">         
  101             <div class="method-summary">
  102                                                                                 <div class="method-definition">
  103                     static                      <span class="method-result"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>
  104                                         <a href="#getFromHeaderLine" title="details" class="method-name">getFromHeaderLine</a>
  105                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$header_line</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$source_url</span>)
  106                                     </div>
  107                                 
  108                                                 <div class="method-definition">
  109                                             <span class="method-result">PHPCrawlerCookieDescriptor</span>
  110                                         <a href="#__construct" title="details" class="method-name">__construct</a>
  111                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$source_url</span>, <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>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$expires</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span> = <span class="var-default">null</span>])
  112                                     </div>
  113                                                                 </div>
  114         </div>
  115     </div>      
  116 
  117     <a name="sec-vars"></a>
  118     <div class="info-box">
  119         <div class="info-box-title">Variables</div>
  120         <div class="nav-bar">
  121             <a href="#sec-description">Description</a> |
  122                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  123                         
  124             
  125                                         | 
  126                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  127                             
  128                     </div>
  129         <div class="info-box-body">
  130             <a name="var$cookie_send_time" id="$cookie_send_time"><!-- --></A>
  131 <div class="evenrow">
  132 
  133     <div class="var-header">
  134         <span class="var-title">
  135             <span class="var-type">float</span>
  136             <span class="var-name">$cookie_send_time</span>
  137              = <span class="var-default"> null</span>           (line <span class="line-number">70</span>)
  138         </span>
  139     </div>
  140 
  141     <!-- ========== Info from phpDoc block ========= -->
  142 <p class="short-description">The time the cookie was send</p>
  143     <ul class="tags">
  144                 <li><span class="field">var:</span> time in secs and microseconds</li>
  145                 <li><span class="field">access:</span> public</li>
  146             </ul>
  147     
  148     
  149         
  150         
  151 
  152 </div>
  153 <a name="var$domain" id="$domain"><!-- --></A>
  154 <div class="oddrow">
  155 
  156     <div class="var-header">
  157         <span class="var-title">
  158             <span class="var-type">string</span>
  159             <span class="var-name">$domain</span>
  160              = <span class="var-default"> null</span>           (line <span class="line-number">49</span>)
  161         </span>
  162     </div>
  163 
  164     <!-- ========== Info from phpDoc block ========= -->
  165 <p class="short-description">Cookie-domain</p>
  166     <ul class="tags">
  167                 <li><span class="field">access:</span> public</li>
  168             </ul>
  169     
  170     
  171         
  172         
  173 
  174 </div>
  175 <a name="var$expires" id="$expires"><!-- --></A>
  176 <div class="evenrow">
  177 
  178     <div class="var-header">
  179         <span class="var-title">
  180             <span class="var-type">string</span>
  181             <span class="var-name">$expires</span>
  182              = <span class="var-default"> null</span>           (line <span class="line-number">28</span>)
  183         </span>
  184     </div>
  185 
  186     <!-- ========== Info from phpDoc block ========= -->
  187 <p class="short-description">Expire-string, e.g. &quot;Sat, 08-Aug-2020 23:59:08 GMT&quot;</p>
  188     <ul class="tags">
  189                 <li><span class="field">access:</span> public</li>
  190             </ul>
  191     
  192     
  193         
  194         
  195 
  196 </div>
  197 <a name="var$expire_timestamp" id="$expire_timestamp"><!-- --></A>
  198 <div class="oddrow">
  199 
  200     <div class="var-header">
  201         <span class="var-title">
  202             <span class="var-type">int</span>
  203             <span class="var-name">$expire_timestamp</span>
  204              = <span class="var-default"> null</span>           (line <span class="line-number">35</span>)
  205         </span>
  206     </div>
  207 
  208     <!-- ========== Info from phpDoc block ========= -->
  209 <p class="short-description">Expire-date as unix-timestamp</p>
  210     <ul class="tags">
  211                 <li><span class="field">access:</span> public</li>
  212             </ul>
  213     
  214     
  215         
  216         
  217 
  218 </div>
  219 <a name="var$name" id="$name"><!-- --></A>
  220 <div class="evenrow">
  221 
  222     <div class="var-header">
  223         <span class="var-title">
  224             <span class="var-type">string</span>
  225             <span class="var-name">$name</span>
  226                         (line <span class="line-number">14</span>)
  227         </span>
  228     </div>
  229 
  230     <!-- ========== Info from phpDoc block ========= -->
  231 <p class="short-description">Cookie-name</p>
  232     <ul class="tags">
  233                 <li><span class="field">access:</span> public</li>
  234             </ul>
  235     
  236     
  237         
  238         
  239 
  240 </div>
  241 <a name="var$path" id="$path"><!-- --></A>
  242 <div class="oddrow">
  243 
  244     <div class="var-header">
  245         <span class="var-title">
  246             <span class="var-type">string</span>
  247             <span class="var-name">$path</span>
  248              = <span class="var-default"> null</span>           (line <span class="line-number">42</span>)
  249         </span>
  250     </div>
  251 
  252     <!-- ========== Info from phpDoc block ========= -->
  253 <p class="short-description">Cookie-path</p>
  254     <ul class="tags">
  255                 <li><span class="field">access:</span> public</li>
  256             </ul>
  257     
  258     
  259         
  260         
  261 
  262 </div>
  263 <a name="var$source_domain" id="$source_domain"><!-- --></A>
  264 <div class="evenrow">
  265 
  266     <div class="var-header">
  267         <span class="var-title">
  268             <span class="var-type">string</span>
  269             <span class="var-name">$source_domain</span>
  270              = <span class="var-default"> null</span>           (line <span class="line-number">56</span>)
  271         </span>
  272     </div>
  273 
  274     <!-- ========== Info from phpDoc block ========= -->
  275 <p class="short-description">The domain the cookie was send from</p>
  276     <ul class="tags">
  277                 <li><span class="field">access:</span> public</li>
  278             </ul>
  279     
  280     
  281         
  282         
  283 
  284 </div>
  285 <a name="var$source_url" id="$source_url"><!-- --></A>
  286 <div class="oddrow">
  287 
  288     <div class="var-header">
  289         <span class="var-title">
  290             <span class="var-type">string</span>
  291             <span class="var-name">$source_url</span>
  292              = <span class="var-default"> null</span>           (line <span class="line-number">63</span>)
  293         </span>
  294     </div>
  295 
  296     <!-- ========== Info from phpDoc block ========= -->
  297 <p class="short-description">The URL the cookie was send from</p>
  298     <ul class="tags">
  299                 <li><span class="field">access:</span> public</li>
  300             </ul>
  301     
  302     
  303         
  304         
  305 
  306 </div>
  307 <a name="var$value" id="$value"><!-- --></A>
  308 <div class="evenrow">
  309 
  310     <div class="var-header">
  311         <span class="var-title">
  312             <span class="var-type">string</span>
  313             <span class="var-name">$value</span>
  314                         (line <span class="line-number">21</span>)
  315         </span>
  316     </div>
  317 
  318     <!-- ========== Info from phpDoc block ========= -->
  319 <p class="short-description">Cookie-value</p>
  320     <ul class="tags">
  321                 <li><span class="field">access:</span> public</li>
  322             </ul>
  323     
  324     
  325         
  326         
  327 
  328 </div>
  329                         
  330         </div>
  331     </div>
  332     
  333     <a name="sec-methods"></a>
  334     <div class="info-box">
  335         <div class="info-box-title">Methods</div>
  336         <div class="nav-bar">
  337             <a href="#sec-description">Description</a> |
  338                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  339                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  340                         
  341         </div>
  342         <div class="info-box-body">
  343             <A NAME='method_detail'></A>
  344 <a name="methodgetFromHeaderLine" id="getFromHeaderLine"><!-- --></a>
  345 <div class="oddrow">
  346     
  347     <div class="method-header">
  348         <span class="method-title">static method getFromHeaderLine</span> (line <span class="line-number">128</span>)
  349     </div> 
  350     
  351     <!-- ========== Info from phpDoc block ========= -->
  352 <p class="short-description">Returns a PHPCrawlerCookieDescriptor-object initiated by the given cookie-header-line.</p>
  353     <ul class="tags">
  354                 <li><span class="field">return:</span> The appropriate PHPCrawlerCookieDescriptor-object.</li>
  355                 <li><span class="field">access:</span> public</li>
  356             </ul>
  357     
  358     <div class="method-signature">
  359         static
  360         <span class="method-result"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>
  361         <span class="method-name">
  362             getFromHeaderLine
  363         </span>
  364                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$header_line</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$source_url</span>)
  365             </div>
  366     
  367             <ul class="parameters">
  368                     <li>
  369                 <span class="var-type">string</span>
  370                 <span class="var-name">$header_line</span><span class="var-description">: The line from an header defining the cookie, e.g. &quot;VISITOR=4c63394c2d82e31552001a58; expires=&quot;Sat, 08-Aug-2020 23:59:08 GMT&quot;; Path=/&quot;</span>          </li>
  371                     <li>
  372                 <span class="var-type">string</span>
  373                 <span class="var-name">$source_url</span><span class="var-description">: URL the cookie was send from.</span>           </li>
  374                 </ul>
  375         
  376             
  377     </div>
  378 
  379 <a name="method__construct" id="__construct"><!-- --></a>
  380 <div class="evenrow">
  381     
  382     <div class="method-header">
  383         <span class="method-title">Constructor __construct</span> (line <span class="line-number">83</span>)
  384     </div> 
  385     
  386     <!-- ========== Info from phpDoc block ========= -->
  387 <p class="short-description">Initiates a new PHPCrawlerCookieDescriptor-object.</p>
  388     <ul class="tags">
  389                 <li><span class="field">access:</span> public</li>
  390             </ul>
  391     
  392     <div class="method-signature">
  393         <span class="method-result">PHPCrawlerCookieDescriptor</span>
  394         <span class="method-name">
  395             __construct
  396         </span>
  397                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$source_url</span>, <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>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$expires</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span> = <span class="var-default">null</span>])
  398             </div>
  399     
  400             <ul class="parameters">
  401                     <li>
  402                 <span class="var-type">string</span>
  403                 <span class="var-name">$source_url</span><span class="var-description">: URL the cookie was send from.</span>           </li>
  404                     <li>
  405                 <span class="var-type">string</span>
  406                 <span class="var-name">$name</span><span class="var-description">: Cookie-name</span>           </li>
  407                     <li>
  408                 <span class="var-type">string</span>
  409                 <span class="var-name">$value</span><span class="var-description">: Cookie-value</span>         </li>
  410                     <li>
  411                 <span class="var-type">string</span>
  412                 <span class="var-name">$expires</span><span class="var-description">: Expire-string, e.g. &quot;Sat, 08-Aug-2020 23:59:08 GMT&quot;</span>          </li>
  413                     <li>
  414                 <span class="var-type">string</span>
  415                 <span class="var-name">$path</span><span class="var-description">: Cookie-path</span>           </li>
  416                     <li>
  417                 <span class="var-type">string</span>
  418                 <span class="var-name">$domain</span><span class="var-description">: Cookie-domain</span>           </li>
  419                 </ul>
  420         
  421             
  422     </div>
  423                         
  424         </div>
  425     </div>
  426 
  427 
  428     <p class="notes" id="credit">
  429         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>
  430     </p>
  431     </div></body>
  432 </html>