"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerSQLiteCookieCache.html" (20 Jan 2013, 13250 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 PHPCrawlerSQLiteCookieCache</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 PHPCrawlerSQLiteCookieCache</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 storing/caching cookies in a SQLite-db-file.</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---CookieCache---PHPCrawlerSQLiteCookieCache.class.php.html">/libs/PHPCrawler/CookieCache/PHPCrawlerSQLiteCookieCache.class.php</a> (line <span class="field">8</span>)
   28         </p>
   29         
   30                 
   31         <pre><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html">PHPCrawlerCookieCacheBase</a>
   32    |
   33    --PHPCrawlerSQLiteCookieCache</pre>
   34     
   35             </div>
   36 </div>
   37 
   38 
   39 
   40     <a name="sec-var-summary"></a>
   41     <div class="info-box">
   42         <div class="info-box-title">Variable Summary</span></div>
   43         <div class="nav-bar">
   44             <a href="#sec-description">Description</a> |
   45                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   46                             | 
   47                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   48                             
   49                                 </div>
   50         <div class="info-box-body">
   51             <div class="var-summary">
   52                                                                                                                                 <div class="var-title">
   53                     <span class="var-type">mixed</span>
   54                     <a href="#$PDO" title="details" class="var-name">$PDO</a>
   55                 </div>
   56                                                                 <div class="var-title">
   57                     <span class="var-type">mixed</span>
   58                     <a href="#$sqlite_db_file" title="details" class="var-name">$sqlite_db_file</a>
   59                 </div>
   60                                             </div>
   61         </div>
   62     </div>
   63 
   64     <a name="sec-method-summary"></a>
   65     <div class="info-box">
   66         <div class="info-box-title">Method Summary</span></div>
   67         <div class="nav-bar">
   68             <a href="#sec-description">Description</a> |
   69                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   70                  
   71                 |
   72                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   73         </div>
   74         <div class="info-box-body">         
   75             <div class="method-summary">
   76                                                                                                                                                                                 
   77                                                 <div class="method-definition">
   78                                             <span class="method-result">PHPCrawlerSQLiteCookieCache</span>
   79                                         <a href="#__construct" title="details" class="method-name">__construct</a>
   80                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$sqlite_db_file</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
   81                                     </div>
   82                                                                 <div class="method-definition">
   83                                             <span class="method-result">void</span>
   84                                         <a href="#addCookie" title="details" class="method-name">addCookie</a>
   85                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
   86                                     </div>
   87                                                                 <div class="method-definition">
   88                                             <span class="method-result">void</span>
   89                                         <a href="#addCookies" title="details" class="method-name">addCookies</a>
   90                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
   91                                     </div>
   92                                                                 <div class="method-definition">
   93                                             <span class="method-result">array</span>
   94                                         <a href="#getCookiesForUrl" title="details" class="method-name">getCookiesForUrl</a>
   95                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$target_url</span>)
   96                                     </div>
   97                                                                 <div class="method-definition">
   98                                             <span class="method-result">void</span>
   99                                         <a href="#openConnection" title="details" class="method-name">openConnection</a>
  100                                             ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
  101                                     </div>
  102                                 </div>
  103         </div>
  104     </div>      
  105 
  106     <a name="sec-vars"></a>
  107     <div class="info-box">
  108         <div class="info-box-title">Variables</div>
  109         <div class="nav-bar">
  110             <a href="#sec-description">Description</a> |
  111                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  112                         
  113             
  114                                         | 
  115                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  116                             
  117                     </div>
  118         <div class="info-box-body">
  119             <a name="var$PDO" id="$PDO"><!-- --></A>
  120 <div class="oddrow">
  121 
  122     <div class="var-header">
  123         <span class="var-title">
  124             <span class="var-type">mixed</span>
  125             <span class="var-name">$PDO</span>
  126                         (line <span class="line-number">10</span>)
  127         </span>
  128     </div>
  129 
  130     <!-- ========== Info from phpDoc block ========= -->
  131     <ul class="tags">
  132                 <li><span class="field">access:</span> protected</li>
  133             </ul>
  134     
  135     
  136         
  137         
  138 
  139 </div>
  140 <a name="var$sqlite_db_file" id="$sqlite_db_file"><!-- --></A>
  141 <div class="evenrow">
  142 
  143     <div class="var-header">
  144         <span class="var-title">
  145             <span class="var-type">mixed</span>
  146             <span class="var-name">$sqlite_db_file</span>
  147                         (line <span class="line-number">12</span>)
  148         </span>
  149     </div>
  150 
  151     <!-- ========== Info from phpDoc block ========= -->
  152     <ul class="tags">
  153                 <li><span class="field">access:</span> protected</li>
  154             </ul>
  155     
  156     
  157         
  158         
  159 
  160 </div>
  161                         
  162         </div>
  163     </div>
  164     
  165     <a name="sec-methods"></a>
  166     <div class="info-box">
  167         <div class="info-box-title">Methods</div>
  168         <div class="nav-bar">
  169             <a href="#sec-description">Description</a> |
  170                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  171                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  172                         
  173         </div>
  174         <div class="info-box-body">
  175             <A NAME='method_detail'></A>
  176 
  177 <a name="method__construct" id="__construct"><!-- --></a>
  178 <div class="oddrow">
  179     
  180     <div class="method-header">
  181         <span class="method-title">Constructor __construct</span> (line <span class="line-number">14</span>)
  182     </div> 
  183     
  184     <!-- ========== Info from phpDoc block ========= -->
  185     <ul class="tags">
  186                 <li><span class="field">access:</span> public</li>
  187             </ul>
  188     
  189     <div class="method-signature">
  190         <span class="method-result">PHPCrawlerSQLiteCookieCache</span>
  191         <span class="method-name">
  192             __construct
  193         </span>
  194                     (<span class="var-type"></span>&nbsp;<span class="var-name">$sqlite_db_file</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
  195             </div>
  196     
  197             <ul class="parameters">
  198                     <li>
  199                 <span class="var-type"></span>
  200                 <span class="var-name">$sqlite_db_file</span>           </li>
  201                     <li>
  202                 <span class="var-type"></span>
  203                 <span class="var-name">$create_tables</span>            </li>
  204                 </ul>
  205         
  206             
  207     </div>
  208 <a name="methodaddCookie" id="addCookie"><!-- --></a>
  209 <div class="evenrow">
  210     
  211     <div class="method-header">
  212         <span class="method-title">addCookie</span> (line <span class="line-number">25</span>)
  213     </div> 
  214     
  215     <!-- ========== Info from phpDoc block ========= -->
  216 <p class="short-description">Adds a cookie to the cookie-cache.</p>
  217     <ul class="tags">
  218                 <li><span class="field">access:</span> public</li>
  219             </ul>
  220     
  221     <div class="method-signature">
  222         <span class="method-result">void</span>
  223         <span class="method-name">
  224             addCookie
  225         </span>
  226                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>&nbsp;<span class="var-name">$Cookie</span>)
  227             </div>
  228     
  229             <ul class="parameters">
  230                     <li>
  231                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerCookieDescriptor.html">PHPCrawlerCookieDescriptor</a></span>
  232                 <span class="var-name">$Cookie</span><span class="var-description">: The cookie to add.</span>          </li>
  233                 </ul>
  234         
  235             <hr class="separator" />
  236         <div class="notes">Redefinition of:</div>
  237         <dl>
  238             <dt><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookie">PHPCrawlerCookieCacheBase::addCookie()</a></dt>
  239                         <dd>Adds a cookie to the cookie-cache.</dd>
  240                     </dl>
  241             
  242     </div>
  243 <a name="methodaddCookies" id="addCookies"><!-- --></a>
  244 <div class="oddrow">
  245     
  246     <div class="method-header">
  247         <span class="method-title">addCookies</span> (line <span class="line-number">53</span>)
  248     </div> 
  249     
  250     <!-- ========== Info from phpDoc block ========= -->
  251 <p class="short-description">Adds a bunch of cookies to the cookie-cache.</p>
  252     <ul class="tags">
  253                 <li><span class="field">access:</span> public</li>
  254             </ul>
  255     
  256     <div class="method-signature">
  257         <span class="method-result">void</span>
  258         <span class="method-name">
  259             addCookies
  260         </span>
  261                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$cookies</span>)
  262             </div>
  263     
  264             <ul class="parameters">
  265                     <li>
  266                 <span class="var-type">array</span>
  267                 <span class="var-name">$cookies</span><span class="var-description">: Numeric array conatining the cookies to add as PHPCrawlerCookieDescriptor-objects</span>          </li>
  268                 </ul>
  269         
  270             <hr class="separator" />
  271         <div class="notes">Redefinition of:</div>
  272         <dl>
  273             <dt><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookies">PHPCrawlerCookieCacheBase::addCookies()</a></dt>
  274                         <dd>Adds a bunch of cookies to the cookie-cache.</dd>
  275                     </dl>
  276             
  277     </div>
  278 <a name="methodgetCookiesForUrl" id="getCookiesForUrl"><!-- --></a>
  279 <div class="evenrow">
  280     
  281     <div class="method-header">
  282         <span class="method-title">getCookiesForUrl</span> (line <span class="line-number">75</span>)
  283     </div> 
  284     
  285     <!-- ========== Info from phpDoc block ========= -->
  286 <p class="short-description">Returns all cookies from the cache that are adressed to the given URL</p>
  287     <ul class="tags">
  288                 <li><span class="field">return:</span> Numeric array conatining all matching cookies as PHPCrawlerCookieDescriptor-objects</li>
  289                 <li><span class="field">access:</span> public</li>
  290             </ul>
  291     
  292     <div class="method-signature">
  293         <span class="method-result">array</span>
  294         <span class="method-name">
  295             getCookiesForUrl
  296         </span>
  297                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$target_url</span>)
  298             </div>
  299     
  300             <ul class="parameters">
  301                     <li>
  302                 <span class="var-type">string</span>
  303                 <span class="var-name">$target_url</span><span class="var-description">: The target-URL</span>          </li>
  304                 </ul>
  305         
  306             <hr class="separator" />
  307         <div class="notes">Redefinition of:</div>
  308         <dl>
  309             <dt><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodgetCookiesForUrl">PHPCrawlerCookieCacheBase::getCookiesForUrl()</a></dt>
  310                         <dd>Returns all cookies from the cache that are adressed to the given URL</dd>
  311                     </dl>
  312             
  313     </div>
  314 <a name="methodopenConnection" id="openConnection"><!-- --></a>
  315 <div class="oddrow">
  316     
  317     <div class="method-header">
  318         <span class="method-title">openConnection</span> (line <span class="line-number">117</span>)
  319     </div> 
  320     
  321     <!-- ========== Info from phpDoc block ========= -->
  322 <p class="short-description">Creates the sqlite-db-file and opens connection to it.</p>
  323     <ul class="tags">
  324                 <li><span class="field">access:</span> protected</li>
  325             </ul>
  326     
  327     <div class="method-signature">
  328         <span class="method-result">void</span>
  329         <span class="method-name">
  330             openConnection
  331         </span>
  332                     ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
  333             </div>
  334     
  335             <ul class="parameters">
  336                     <li>
  337                 <span class="var-type">bool</span>
  338                 <span class="var-name">$create_tables</span><span class="var-description">: Defines whether all necessary tables should be created</span>           </li>
  339                 </ul>
  340         
  341             
  342     </div>
  343                             <h4>Inherited Methods</h4>
  344                 <a name='inherited_methods'><!-- --></a>    
  345                                     <!-- =========== Summary =========== -->
  346                     <p>Inherited From <span class="classname"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html">PHPCrawlerCookieCacheBase</a></span></p>
  347                     <blockquote>
  348                                                     <span class="method-name"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookie">PHPCrawlerCookieCacheBase::addCookie()</a></span><br>
  349                                                     <span class="method-name"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodaddCookies">PHPCrawlerCookieCacheBase::addCookies()</a></span><br>
  350                                                     <span class="method-name"><a href="../phpcrawl/PHPCrawlerCookieCacheBase.html#methodgetCookiesForUrl">PHPCrawlerCookieCacheBase::getCookiesForUrl()</a></span><br>
  351                                             </blockquote>
  352                                         
  353         </div>
  354     </div>
  355 
  356 
  357     <p class="notes" id="credit">
  358         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>
  359     </p>
  360     </div></body>
  361 </html>