"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerDocumentInfoQueue.html" (20 Jan 2013, 13770 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 PHPCrawlerDocumentInfoQueue</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 PHPCrawlerDocumentInfoQueue</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">Queue for PHPCrawlerDocumentInfo-objects</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---ProcessCommunication---PHPCrawlerDocumentInfoQueue.class.php.html">/libs/PHPCrawler/ProcessCommunication/PHPCrawlerDocumentInfoQueue.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">mixed</span>
   52                     <a href="#$PDO" title="details" class="var-name">$PDO</a>
   53                 </div>
   54                                                                 <div class="var-title">
   55                     <span class="var-type">mixed</span>
   56                     <a href="#$prepared_statements_created" title="details" class="var-name">$prepared_statements_created</a>
   57                 </div>
   58                                                                 <div class="var-title">
   59                     <span class="var-type">mixed</span>
   60                     <a href="#$queue_max_size" title="details" class="var-name">$queue_max_size</a>
   61                 </div>
   62                                                                 <div class="var-title">
   63                     <span class="var-type">mixed</span>
   64                     <a href="#$sqlite_db_file" title="details" class="var-name">$sqlite_db_file</a>
   65                 </div>
   66                                                                 <div class="var-title">
   67                     <span class="var-type">mixed</span>
   68                     <a href="#$working_directory" title="details" class="var-name">$working_directory</a>
   69                 </div>
   70                                             </div>
   71         </div>
   72     </div>
   73 
   74     <a name="sec-method-summary"></a>
   75     <div class="info-box">
   76         <div class="info-box-title">Method Summary</span></div>
   77         <div class="nav-bar">
   78             <a href="#sec-description">Description</a> |
   79                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   80                  
   81                 |
   82                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   83         </div>
   84         <div class="info-box-body">         
   85             <div class="method-summary">
   86                                                                                                                                                                                                                 
   87                                                 <div class="method-definition">
   88                                             <span class="method-result">PHPCrawlerDocumentInfoQueue</span>
   89                                         <a href="#__construct" title="details" class="method-name">__construct</a>
   90                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
   91                                     </div>
   92                                                                 <div class="method-definition">
   93                                             <span class="method-result">void</span>
   94                                         <a href="#addDocumentInfo" title="details" class="method-name">addDocumentInfo</a>
   95                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a></span>&nbsp;<span class="var-name">$DocInfo</span>)
   96                                     </div>
   97                                                                 <div class="method-definition">
   98                                             <span class="method-result">void</span>
   99                                         <a href="#createPreparedStatements" title="details" class="method-name">createPreparedStatements</a>
  100                                         ()
  101                                     </div>
  102                                                                 <div class="method-definition">
  103                                             <span class="method-result">void</span>
  104                                         <a href="#getDocumentInfoCount" title="details" class="method-name">getDocumentInfoCount</a>
  105                                         ()
  106                                     </div>
  107                                                                 <div class="method-definition">
  108                                             <span class="method-result">void</span>
  109                                         <a href="#getNextDocumentInfo" title="details" class="method-name">getNextDocumentInfo</a>
  110                                         ()
  111                                     </div>
  112                                                                 <div class="method-definition">
  113                                             <span class="method-result">void</span>
  114                                         <a href="#openConnection" title="details" class="method-name">openConnection</a>
  115                                             ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
  116                                     </div>
  117                                 </div>
  118         </div>
  119     </div>      
  120 
  121     <a name="sec-vars"></a>
  122     <div class="info-box">
  123         <div class="info-box-title">Variables</div>
  124         <div class="nav-bar">
  125             <a href="#sec-description">Description</a> |
  126                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  127                         
  128             
  129                                         | 
  130                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  131                             
  132                     </div>
  133         <div class="info-box-body">
  134             <a name="var$PDO" id="$PDO"><!-- --></A>
  135 <div class="evenrow">
  136 
  137     <div class="var-header">
  138         <span class="var-title">
  139             <span class="var-type">mixed</span>
  140             <span class="var-name">$PDO</span>
  141                         (line <span class="line-number">10</span>)
  142         </span>
  143     </div>
  144 
  145     <!-- ========== Info from phpDoc block ========= -->
  146     <ul class="tags">
  147                 <li><span class="field">access:</span> protected</li>
  148             </ul>
  149     
  150     
  151         
  152         
  153 
  154 </div>
  155 <a name="var$prepared_statements_created" id="$prepared_statements_created"><!-- --></A>
  156 <div class="oddrow">
  157 
  158     <div class="var-header">
  159         <span class="var-title">
  160             <span class="var-type">mixed</span>
  161             <span class="var-name">$prepared_statements_created</span>
  162              = <span class="var-default"> false</span>          (line <span class="line-number">14</span>)
  163         </span>
  164     </div>
  165 
  166     <!-- ========== Info from phpDoc block ========= -->
  167     <ul class="tags">
  168                 <li><span class="field">access:</span> protected</li>
  169             </ul>
  170     
  171     
  172         
  173         
  174 
  175 </div>
  176 <a name="var$queue_max_size" id="$queue_max_size"><!-- --></A>
  177 <div class="evenrow">
  178 
  179     <div class="var-header">
  180         <span class="var-title">
  181             <span class="var-type">mixed</span>
  182             <span class="var-name">$queue_max_size</span>
  183              = <span class="var-default"> 20</span>         (line <span class="line-number">18</span>)
  184         </span>
  185     </div>
  186 
  187     <!-- ========== Info from phpDoc block ========= -->
  188     <ul class="tags">
  189                 <li><span class="field">access:</span> protected</li>
  190             </ul>
  191     
  192     
  193         
  194         
  195 
  196 </div>
  197 <a name="var$sqlite_db_file" id="$sqlite_db_file"><!-- --></A>
  198 <div class="oddrow">
  199 
  200     <div class="var-header">
  201         <span class="var-title">
  202             <span class="var-type">mixed</span>
  203             <span class="var-name">$sqlite_db_file</span>
  204                         (line <span class="line-number">12</span>)
  205         </span>
  206     </div>
  207 
  208     <!-- ========== Info from phpDoc block ========= -->
  209     <ul class="tags">
  210                 <li><span class="field">access:</span> protected</li>
  211             </ul>
  212     
  213     
  214         
  215         
  216 
  217 </div>
  218 <a name="var$working_directory" id="$working_directory"><!-- --></A>
  219 <div class="evenrow">
  220 
  221     <div class="var-header">
  222         <span class="var-title">
  223             <span class="var-type">mixed</span>
  224             <span class="var-name">$working_directory</span>
  225              = <span class="var-default"> null</span>           (line <span class="line-number">16</span>)
  226         </span>
  227     </div>
  228 
  229     <!-- ========== Info from phpDoc block ========= -->
  230     <ul class="tags">
  231                 <li><span class="field">access:</span> protected</li>
  232             </ul>
  233     
  234     
  235         
  236         
  237 
  238 </div>
  239                         
  240         </div>
  241     </div>
  242     
  243     <a name="sec-methods"></a>
  244     <div class="info-box">
  245         <div class="info-box-title">Methods</div>
  246         <div class="nav-bar">
  247             <a href="#sec-description">Description</a> |
  248                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  249                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  250                         
  251         </div>
  252         <div class="info-box-body">
  253             <A NAME='method_detail'></A>
  254 
  255 <a name="method__construct" id="__construct"><!-- --></a>
  256 <div class="oddrow">
  257     
  258     <div class="method-header">
  259         <span class="method-title">Constructor __construct</span> (line <span class="line-number">26</span>)
  260     </div> 
  261     
  262     <!-- ========== Info from phpDoc block ========= -->
  263 <p class="short-description">Initiates a PHPCrawlerDocumentInfoQueue</p>
  264     <ul class="tags">
  265                 <li><span class="field">access:</span> public</li>
  266             </ul>
  267     
  268     <div class="method-signature">
  269         <span class="method-result">PHPCrawlerDocumentInfoQueue</span>
  270         <span class="method-name">
  271             __construct
  272         </span>
  273                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
  274             </div>
  275     
  276             <ul class="parameters">
  277                     <li>
  278                 <span class="var-type">string</span>
  279                 <span class="var-name">$file</span><span class="var-description">: The SQLite-fiel to use.</span>           </li>
  280                     <li>
  281                 <span class="var-type">bool</span>
  282                 <span class="var-name">$create_tables</span><span class="var-description">: Defines whether all necessary tables should be created</span>           </li>
  283                 </ul>
  284         
  285             
  286     </div>
  287 <a name="methodaddDocumentInfo" id="addDocumentInfo"><!-- --></a>
  288 <div class="evenrow">
  289     
  290     <div class="method-header">
  291         <span class="method-title">addDocumentInfo</span> (line <span class="line-number">48</span>)
  292     </div> 
  293     
  294     <!-- ========== Info from phpDoc block ========= -->
  295 <p class="short-description">Adds a PHPCrawlerDocumentInfo-object to the queue</p>
  296     <ul class="tags">
  297                 <li><span class="field">access:</span> public</li>
  298             </ul>
  299     
  300     <div class="method-signature">
  301         <span class="method-result">void</span>
  302         <span class="method-name">
  303             addDocumentInfo
  304         </span>
  305                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a></span>&nbsp;<span class="var-name">$DocInfo</span>)
  306             </div>
  307     
  308             <ul class="parameters">
  309                     <li>
  310                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a></span>
  311                 <span class="var-name">$DocInfo</span>          </li>
  312                 </ul>
  313         
  314             
  315     </div>
  316 <a name="methodcreatePreparedStatements" id="createPreparedStatements"><!-- --></a>
  317 <div class="oddrow">
  318     
  319     <div class="method-header">
  320         <span class="method-title">createPreparedStatements</span> (line <span class="line-number">92</span>)
  321     </div> 
  322     
  323     <!-- ========== Info from phpDoc block ========= -->
  324     <ul class="tags">
  325                 <li><span class="field">access:</span> protected</li>
  326             </ul>
  327     
  328     <div class="method-signature">
  329         <span class="method-result">void</span>
  330         <span class="method-name">
  331             createPreparedStatements
  332         </span>
  333                 ()
  334             </div>
  335     
  336         
  337             
  338     </div>
  339 <a name="methodgetDocumentInfoCount" id="getDocumentInfoCount"><!-- --></a>
  340 <div class="evenrow">
  341     
  342     <div class="method-header">
  343         <span class="method-title">getDocumentInfoCount</span> (line <span class="line-number">36</span>)
  344     </div> 
  345     
  346     <!-- ========== Info from phpDoc block ========= -->
  347 <p class="short-description">Returns the current number of PHPCrawlerDocumentInfo-objects in the queue</p>
  348     <ul class="tags">
  349                 <li><span class="field">access:</span> public</li>
  350             </ul>
  351     
  352     <div class="method-signature">
  353         <span class="method-result">void</span>
  354         <span class="method-name">
  355             getDocumentInfoCount
  356         </span>
  357                 ()
  358             </div>
  359     
  360         
  361             
  362     </div>
  363 <a name="methodgetNextDocumentInfo" id="getNextDocumentInfo"><!-- --></a>
  364 <div class="oddrow">
  365     
  366     <div class="method-header">
  367         <span class="method-title">getNextDocumentInfo</span> (line <span class="line-number">70</span>)
  368     </div> 
  369     
  370     <!-- ========== Info from phpDoc block ========= -->
  371 <p class="short-description">Returns a PHPCrawlerDocumentInfo-object from the queue</p>
  372     <ul class="tags">
  373                 <li><span class="field">access:</span> public</li>
  374             </ul>
  375     
  376     <div class="method-signature">
  377         <span class="method-result">void</span>
  378         <span class="method-name">
  379             getNextDocumentInfo
  380         </span>
  381                 ()
  382             </div>
  383     
  384         
  385             
  386     </div>
  387 <a name="methodopenConnection" id="openConnection"><!-- --></a>
  388 <div class="evenrow">
  389     
  390     <div class="method-header">
  391         <span class="method-title">openConnection</span> (line <span class="line-number">108</span>)
  392     </div> 
  393     
  394     <!-- ========== Info from phpDoc block ========= -->
  395 <p class="short-description">Creates the sqlite-db-file and opens connection to it.</p>
  396     <ul class="tags">
  397                 <li><span class="field">access:</span> protected</li>
  398             </ul>
  399     
  400     <div class="method-signature">
  401         <span class="method-result">void</span>
  402         <span class="method-name">
  403             openConnection
  404         </span>
  405                     ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$create_tables</span> = <span class="var-default">false</span>])
  406             </div>
  407     
  408             <ul class="parameters">
  409                     <li>
  410                 <span class="var-type">bool</span>
  411                 <span class="var-name">$create_tables</span><span class="var-description">: Defines whether all necessary tables should be created</span>           </li>
  412                 </ul>
  413         
  414             
  415     </div>
  416                         
  417         </div>
  418     </div>
  419 
  420 
  421     <p class="notes" id="credit">
  422         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>
  423     </p>
  424     </div></body>
  425 </html>