"Fossies" - the Fresh Open Source Software Archive

Member "docs/SitemapCreator/SitemapCreator.html" (20 Jan 2013, 88694 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 SitemapCreator</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 SitemapCreator</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                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
   23                         
   24             </div>
   25     <div class="info-box-body">
   26                 <!-- ========== Info from phpDoc block ========= -->
   27 <p class="short-description">Sitemap Creator creates XML sitemaps files compatible with the standard  sitemaps.org protocol and supported by Google and Bing.</p>
   28     <ul class="tags">
   29                 <li><span class="field">author:</span> Waleed Gadelkareem &lt;<a href="mailto:gadelkareem@gmail.com">gadelkareem@gmail.com</a>&gt;</li>
   30                 <li><span class="field">version:</span> 1.0</li>
   31                 <li><span class="field">link:</span> <a href="http://sitemapcreator.org/">http://sitemapcreator.org/</a></li>
   32                 <li><span class="field">link:</span> <a href="http://gadelkareem.com/">http://gadelkareem.com/</a></li>
   33                 <li><span class="field">license:</span> GPLv2</li>
   34             </ul>
   35         <p class="notes">
   36             Located in <a class="field" href="_SitemapCreator.class.php.html">/SitemapCreator.class.php</a> (line <span class="field">19</span>)
   37         </p>
   38         
   39                 
   40         <pre></pre>
   41     
   42             </div>
   43 </div>
   44 
   45 
   46     <a name="sec-const-summary"></a>
   47     <div class="info-box">
   48         <div class="info-box-title">Class Constant Summary</span></div>
   49         <div class="nav-bar">
   50             <a href="#sec-description">Description</a> |
   51                         <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
   52                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   53                  
   54                 |
   55                                         | 
   56                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   57                             
   58                     </div>
   59         <div class="info-box-body">
   60             <div class="const-summary">
   61                                 <div class="const-title">
   62                     <a href="#FREQUENCY_Disable" title="details" class="const-name">FREQUENCY_Disable</a> =                     <span class="var-type"> 0</span>
   63 
   64                 </div>
   65                                 <div class="const-title">
   66                     <a href="#FREQUENCY_LAST_MODIFIED" title="details" class="const-name">FREQUENCY_LAST_MODIFIED</a> =                     <span class="var-type"> 1</span>
   67 
   68                 </div>
   69                                 <div class="const-title">
   70                     <a href="#FREQUENCY_PRIORITY" title="details" class="const-name">FREQUENCY_PRIORITY</a> =                   <span class="var-type"> 2</span>
   71 
   72                 </div>
   73                                 <div class="const-title">
   74                     <a href="#PRIORITY_CRAWLED_FIRST" title="details" class="const-name">PRIORITY_CRAWLED_FIRST</a> =                   <span class="var-type"> 1</span>
   75 
   76                 </div>
   77                                 <div class="const-title">
   78                     <a href="#PRIORITY_Disable" title="details" class="const-name">PRIORITY_Disable</a> =                   <span class="var-type"> 0</span>
   79 
   80                 </div>
   81                                 <div class="const-title">
   82                     <a href="#PRIORITY_URL_STRUCTURE" title="details" class="const-name">PRIORITY_URL_STRUCTURE</a> =                   <span class="var-type"> 2</span>
   83 
   84                 </div>
   85                             </div>
   86         </div>
   87     </div>
   88 
   89     <a name="sec-var-summary"></a>
   90     <div class="info-box">
   91         <div class="info-box-title">Variable Summary</span></div>
   92         <div class="nav-bar">
   93             <a href="#sec-description">Description</a> |
   94                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   95                             | 
   96                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   97                             
   98                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
   99                             
  100                     </div>
  101         <div class="info-box-body">
  102             <div class="var-summary">
  103                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="var-title">
  104                     static <span class="var-type">mixed</span>
  105                     <a href="#$useragent" title="details" class="var-name">$useragent</a>
  106                 </div>
  107                                                                                                                                                                                                                 <div class="var-title">
  108                     <span class="var-type">mixed</span>
  109                     <a href="#$classpath" title="details" class="var-name">$classpath</a>
  110                 </div>
  111                                                                 <div class="var-title">
  112                     <span class="var-type">mixed</span>
  113                     <a href="#$class_version" title="details" class="var-name">$class_version</a>
  114                 </div>
  115                                                                 <div class="var-title">
  116                     <span class="var-type">mixed</span>
  117                     <a href="#$Crawler" title="details" class="var-name">$Crawler</a>
  118                 </div>
  119                                                                 <div class="var-title">
  120                     <span class="var-type">mixed</span>
  121                     <a href="#$crawler_reports" title="details" class="var-name">$crawler_reports</a>
  122                 </div>
  123                                                                 <div class="var-title">
  124                     <span class="var-type">string</span>
  125                     <a href="#$data_dir" title="details" class="var-name">$data_dir</a>
  126                 </div>
  127                                                                 <div class="var-title">
  128                     <span class="var-type">array</span>
  129                     <a href="#$engines" title="details" class="var-name">$engines</a>
  130                 </div>
  131                                                                 <div class="var-title">
  132                     <span class="var-type">array</span>
  133                     <a href="#$entries" title="details" class="var-name">$entries</a>
  134                 </div>
  135                                                                 <div class="var-title">
  136                     <span class="var-type">int</span>
  137                     <a href="#$entries_per_sitemap" title="details" class="var-name">$entries_per_sitemap</a>
  138                 </div>
  139                                                                 <div class="var-title">
  140                     <span class="var-type">int</span>
  141                     <a href="#$frequency_mode" title="details" class="var-name">$frequency_mode</a>
  142                 </div>
  143                                                                 <div class="var-title">
  144                     <span class="var-type">array</span>
  145                     <a href="#$frequency_types" title="details" class="var-name">$frequency_types</a>
  146                 </div>
  147                                                                 <div class="var-title">
  148                     <span class="var-type">string</span>
  149                     <a href="#$min_frequency" title="details" class="var-name">$min_frequency</a>
  150                 </div>
  151                                                                 <div class="var-title">
  152                     <span class="var-type">int</span>
  153                     <a href="#$min_priority" title="details" class="var-name">$min_priority</a>
  154                 </div>
  155                                                                 <div class="var-title">
  156                     <span class="var-type">int</span>
  157                     <a href="#$now" title="details" class="var-name">$now</a>
  158                 </div>
  159                                                                 <div class="var-title">
  160                     <span class="var-type">int</span>
  161                     <a href="#$priority_mode" title="details" class="var-name">$priority_mode</a>
  162                 </div>
  163                                                                 <div class="var-title">
  164                     <span class="var-type">string</span>
  165                     <a href="#$site" title="details" class="var-name">$site</a>
  166                 </div>
  167                                                                 <div class="var-title">
  168                     <span class="var-type">int</span>
  169                     <a href="#$sitemaps_count" title="details" class="var-name">$sitemaps_count</a>
  170                 </div>
  171                                                                 <div class="var-title">
  172                     <span class="var-type">string</span>
  173                     <a href="#$sitemaps_dir" title="details" class="var-name">$sitemaps_dir</a>
  174                 </div>
  175                                                                 <div class="var-title">
  176                     <span class="var-type">string</span>
  177                     <a href="#$sitemaps_url" title="details" class="var-name">$sitemaps_url</a>
  178                 </div>
  179                                                                                                 <div class="var-title">
  180                     <span class="var-type">bool</span>
  181                     <a href="#$use_gzip" title="details" class="var-name">$use_gzip</a>
  182                 </div>
  183                                                                 <div class="var-title">
  184                     <span class="var-type">mixed</span>
  185                     <a href="#$xml_foot" title="details" class="var-name">$xml_foot</a>
  186                 </div>
  187                                                                 <div class="var-title">
  188                     <span class="var-type">mixed</span>
  189                     <a href="#$xml_head" title="details" class="var-name">$xml_head</a>
  190                 </div>
  191                                                                 <div class="var-title">
  192                     <span class="var-type">string</span>
  193                     <a href="#$xml_url_set" title="details" class="var-name">$xml_url_set</a>
  194                 </div>
  195                                             </div>
  196         </div>
  197     </div>
  198 
  199     <a name="sec-method-summary"></a>
  200     <div class="info-box">
  201         <div class="info-box-title">Method Summary</span></div>
  202         <div class="nav-bar">
  203             <a href="#sec-description">Description</a> |
  204                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  205                             
  206                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  207                  
  208                 |
  209                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  210         </div>
  211         <div class="info-box-body">         
  212             <div class="method-summary">
  213                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  214                     static                      <span class="method-result">array</span>
  215                                         <a href="#openURL" title="details" class="method-name">openURL</a>
  216                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$max_redirects</span> = <span class="var-default">5</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">15</span>])
  217                                     </div>
  218                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  219                     static                      <span class="method-result">bool</span>
  220                                         <a href="#validSitemapName" title="details" class="method-name">validSitemapName</a>
  221                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$filename</span>)
  222                                     </div>
  223                                                                                                                                 
  224                                                 <div class="method-definition">
  225                                             <span class="method-result">SitemapCreator</span>
  226                                         <a href="#__construct" title="details" class="method-name">__construct</a>
  227                                             ([<span class="var-type">string</span>&nbsp;<span class="var-name">$site</span> = <span class="var-default">''</span>])
  228                                     </div>
  229                                                                 <div class="method-definition">
  230                                             <span class="method-result">void</span>
  231                                         <a href="#addEngine" title="details" class="method-name">addEngine</a>
  232                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  233                                     </div>
  234                                                                 <div class="method-definition">
  235                                             <span class="method-result">void</span>
  236                                         <a href="#addEntry" title="details" class="method-name">addEntry</a>
  237                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$entry</span>)
  238                                     </div>
  239                                                                 <div class="method-definition">
  240                                             <span class="method-result">string</span>
  241                                         <a href="#addSitemapEXT" title="details" class="method-name">addSitemapEXT</a>
  242                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$filename</span>)
  243                                     </div>
  244                                                                 <div class="method-definition">
  245                                             <span class="method-result">string</span>
  246                                         <a href="#addToRobots" title="details" class="method-name">addToRobots</a>
  247                                             ([<span class="var-type">string</span>&nbsp;<span class="var-name">$robots_file</span> = <span class="var-default">''</span>])
  248                                     </div>
  249                                                                 <div class="method-definition">
  250                                             <span class="method-result">void</span>
  251                                         <a href="#addXMLURLSet" title="details" class="method-name">addXMLURLSet</a>
  252                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$entry</span>)
  253                                     </div>
  254                                                                 <div class="method-definition">
  255                                             <span class="method-result">void</span>
  256                                         <a href="#calcFrequency" title="details" class="method-name">calcFrequency</a>
  257                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$entry</span>)
  258                                     </div>
  259                                                                 <div class="method-definition">
  260                                             <span class="method-result">void</span>
  261                                         <a href="#calcPriority" title="details" class="method-name">calcPriority</a>
  262                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$entry</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$total_entries</span>)
  263                                     </div>
  264                                                                 <div class="method-definition">
  265                                             <span class="method-result">void</span>
  266                                         <a href="#Crawl" title="details" class="method-name">Crawl</a>
  267                                         ()
  268                                     </div>
  269                                                                 <div class="method-definition">
  270                                             <span class="method-result">void</span>
  271                                         <a href="#CreateSitemaps" title="details" class="method-name">CreateSitemaps</a>
  272                                             ([<span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span> = <span class="var-default">array()</span>])
  273                                     </div>
  274                                                                 <div class="method-definition">
  275                                             <span class="method-result">string</span>
  276                                         <a href="#csvFile" title="details" class="method-name">csvFile</a>
  277                                         ()
  278                                     </div>
  279                                                                 <div class="method-definition">
  280                                             <span class="method-result">string</span>
  281                                         <a href="#getDataDir" title="details" class="method-name">getDataDir</a>
  282                                         ()
  283                                     </div>
  284                                                                 <div class="method-definition">
  285                                             <span class="method-result">array</span>
  286                                         <a href="#getEntries" title="details" class="method-name">getEntries</a>
  287                                         ()
  288                                     </div>
  289                                                                 <div class="method-definition">
  290                                             <span class="method-result">bool|string</span>
  291                                         <a href="#getSitemapDirName" title="details" class="method-name">getSitemapDirName</a>
  292                                         ()
  293                                     </div>
  294                                                                 <div class="method-definition">
  295                                             <span class="method-result">bool|string</span>
  296                                         <a href="#getSitemapPath" title="details" class="method-name">getSitemapPath</a>
  297                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
  298                                     </div>
  299                                                                 <div class="method-definition">
  300                                             <span class="method-result">string</span>
  301                                         <a href="#getSitemapsDir" title="details" class="method-name">getSitemapsDir</a>
  302                                         ()
  303                                     </div>
  304                                                                 <div class="method-definition">
  305                                             <span class="method-result">bool|string</span>
  306                                         <a href="#getSitemapURL" title="details" class="method-name">getSitemapURL</a>
  307                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
  308                                     </div>
  309                                                                 <div class="method-definition">
  310                                             <span class="method-result"><a href="../phpcrawl/SMCCrawler.html">SMCCrawler</a></span>
  311                                         <a href="#initCrawler" title="details" class="method-name">initCrawler</a>
  312                                         ()
  313                                     </div>
  314                                                                 <div class="method-definition">
  315                                             <span class="method-result">bool</span>
  316                                         <a href="#isDataDirWritable" title="details" class="method-name">isDataDirWritable</a>
  317                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
  318                                     </div>
  319                                                                                                 <div class="method-definition">
  320                                             <span class="method-result">array</span>
  321                                         <a href="#ping" title="details" class="method-name">ping</a>
  322                                             ([<span class="var-type">string|int</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'index'</span>])
  323                                     </div>
  324                                                                 <div class="method-definition">
  325                                             <span class="method-result">void</span>
  326                                         <a href="#prepareSitemapsDir" title="details" class="method-name">prepareSitemapsDir</a>
  327                                         ()
  328                                     </div>
  329                                                                 <div class="method-definition">
  330                                             <span class="method-result">void</span>
  331                                         <a href="#putContent" title="details" class="method-name">putContent</a>
  332                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">$XML</span>&nbsp;<span class="var-name">$XML</span>)
  333                                     </div>
  334                                                                 <div class="method-definition">
  335                                             <span class="method-result">bool</span>
  336                                         <a href="#readFromCSV" title="details" class="method-name">readFromCSV</a>
  337                                             ([<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">''</span>])
  338                                     </div>
  339                                                                 <div class="method-definition">
  340                                             <span class="method-result">void</span>
  341                                         <a href="#readSitemap" title="details" class="method-name">readSitemap</a>
  342                                             (<span class="var-type">string|int</span>&nbsp;<span class="var-name">$filename</span>)
  343                                     </div>
  344                                                                 <div class="method-definition">
  345                                             <span class="method-result">bool</span>
  346                                         <a href="#removeSitemaps" title="details" class="method-name">removeSitemaps</a>
  347                                         ()
  348                                     </div>
  349                                                                 <div class="method-definition">
  350                                             <span class="method-result">void</span>
  351                                         <a href="#setCrawlerDefaults" title="details" class="method-name">setCrawlerDefaults</a>
  352                                         ()
  353                                     </div>
  354                                                                 <div class="method-definition">
  355                                             <span class="method-result">void</span>
  356                                         <a href="#setDataDir" title="details" class="method-name">setDataDir</a>
  357                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
  358                                     </div>
  359                                                                 <div class="method-definition">
  360                                             <span class="method-result">void</span>
  361                                         <a href="#setEntries" title="details" class="method-name">setEntries</a>
  362                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span>)
  363                                     </div>
  364                                                                 <div class="method-definition">
  365                                             <span class="method-result">bool</span>
  366                                         <a href="#setEntriesPerSitemap" title="details" class="method-name">setEntriesPerSitemap</a>
  367                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$number</span>)
  368                                     </div>
  369                                                                 <div class="method-definition">
  370                                             <span class="method-result">bool</span>
  371                                         <a href="#setFrequency" title="details" class="method-name">setFrequency</a>
  372                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
  373                                     </div>
  374                                                                 <div class="method-definition">
  375                                             <span class="method-result">bool</span>
  376                                         <a href="#setMinFrequency" title="details" class="method-name">setMinFrequency</a>
  377                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
  378                                     </div>
  379                                                                 <div class="method-definition">
  380                                             <span class="method-result">bool</span>
  381                                         <a href="#setMinPriority" title="details" class="method-name">setMinPriority</a>
  382                                             (<span class="var-type">float</span>&nbsp;<span class="var-name">$mode</span>)
  383                                     </div>
  384                                                                 <div class="method-definition">
  385                                             <span class="method-result">bool</span>
  386                                         <a href="#setPriority" title="details" class="method-name">setPriority</a>
  387                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
  388                                     </div>
  389                                                                 <div class="method-definition">
  390                                             <span class="method-result">string|bool</span>
  391                                         <a href="#setSite" title="details" class="method-name">setSite</a>
  392                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$site</span>)
  393                                     </div>
  394                                                                 <div class="method-definition">
  395                                             <span class="method-result">void</span>
  396                                         <a href="#setSitemapURL" title="details" class="method-name">setSitemapURL</a>
  397                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  398                                     </div>
  399                                                                 <div class="method-definition">
  400                                             <span class="method-result">void</span>
  401                                         <a href="#useGzip" title="details" class="method-name">useGzip</a>
  402                                             (<span class="var-type">bool</span>&nbsp;<span class="var-name">$mode</span>)
  403                                     </div>
  404                                                                                                 <div class="method-definition">
  405                                             <span class="method-result">void</span>
  406                                         <a href="#writeIndex" title="details" class="method-name">writeIndex</a>
  407                                         ()
  408                                     </div>
  409                                                                 <div class="method-definition">
  410                                             <span class="method-result">void</span>
  411                                         <a href="#writeSitemap" title="details" class="method-name">writeSitemap</a>
  412                                         ()
  413                                     </div>
  414                                                                 <div class="method-definition">
  415                                             <span class="method-result">bool</span>
  416                                         <a href="#writeToCSV" title="details" class="method-name">writeToCSV</a>
  417                                             ([<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">''</span>])
  418                                     </div>
  419                                 </div>
  420         </div>
  421     </div>      
  422 
  423     <a name="sec-vars"></a>
  424     <div class="info-box">
  425         <div class="info-box-title">Variables</div>
  426         <div class="nav-bar">
  427             <a href="#sec-description">Description</a> |
  428                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  429                         
  430             
  431                                                 <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  432                             
  433                                         | 
  434                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  435                             
  436                     </div>
  437         <div class="info-box-body">
  438             <a name="var$useragent" id="$useragent"><!-- --></A>
  439 <div class="oddrow">
  440 
  441     <div class="var-header">
  442         <span class="var-title">
  443             static <span class="var-type">mixed</span>
  444             <span class="var-name">$useragent</span>
  445              = <span class="var-default"> &quot;Sitemaps Creator 1.0 (compatible; sitemapcreatorbot/1.0; +http://sitemapcreator.org/)&quot;</span>          (line <span class="line-number">22</span>)
  446         </span>
  447     </div>
  448 
  449     <!-- ========== Info from phpDoc block ========= -->
  450     
  451     
  452         
  453         
  454 
  455 </div>
  456 <a name="var$classpath" id="$classpath"><!-- --></A>
  457 <div class="evenrow">
  458 
  459     <div class="var-header">
  460         <span class="var-title">
  461             <span class="var-type">mixed</span>
  462             <span class="var-name">$classpath</span>
  463                         (line <span class="line-number">214</span>)
  464         </span>
  465     </div>
  466 
  467     <!-- ========== Info from phpDoc block ========= -->
  468     <ul class="tags">
  469                 <li><span class="field">access:</span> protected</li>
  470             </ul>
  471     
  472     
  473         
  474         
  475 
  476 </div>
  477 <a name="var$class_version" id="$class_version"><!-- --></A>
  478 <div class="oddrow">
  479 
  480     <div class="var-header">
  481         <span class="var-title">
  482             <span class="var-type">mixed</span>
  483             <span class="var-name">$class_version</span>
  484              = <span class="var-default"> &quot;1.0&quot;</span>            (line <span class="line-number">21</span>)
  485         </span>
  486     </div>
  487 
  488     <!-- ========== Info from phpDoc block ========= -->
  489     <ul class="tags">
  490                 <li><span class="field">access:</span> public</li>
  491             </ul>
  492     
  493     
  494         
  495         
  496 
  497 </div>
  498 <a name="var$Crawler" id="$Crawler"><!-- --></A>
  499 <div class="evenrow">
  500 
  501     <div class="var-header">
  502         <span class="var-title">
  503             <span class="var-type">mixed</span>
  504             <span class="var-name">$Crawler</span>
  505                         (line <span class="line-number">208</span>)
  506         </span>
  507     </div>
  508 
  509     <!-- ========== Info from phpDoc block ========= -->
  510     <ul class="tags">
  511                 <li><span class="field">access:</span> public</li>
  512             </ul>
  513     
  514     
  515         
  516         
  517 
  518 </div>
  519 <a name="var$crawler_reports" id="$crawler_reports"><!-- --></A>
  520 <div class="oddrow">
  521 
  522     <div class="var-header">
  523         <span class="var-title">
  524             <span class="var-type">mixed</span>
  525             <span class="var-name">$crawler_reports</span>
  526                         (line <span class="line-number">221</span>)
  527         </span>
  528     </div>
  529 
  530     <!-- ========== Info from phpDoc block ========= -->
  531     <ul class="tags">
  532                 <li><span class="field">access:</span> public</li>
  533             </ul>
  534     
  535     
  536         
  537         
  538 
  539 </div>
  540 <a name="var$data_dir" id="$data_dir"><!-- --></A>
  541 <div class="evenrow">
  542 
  543     <div class="var-header">
  544         <span class="var-title">
  545             <span class="var-type">string</span>
  546             <span class="var-name">$data_dir</span>
  547              = <span class="var-default"> ''</span>         (line <span class="line-number">161</span>)
  548         </span>
  549     </div>
  550 
  551     <!-- ========== Info from phpDoc block ========= -->
  552 <p class="short-description">Data directory Path.</p>
  553 <p class="description"><p>Valid system path for the directory where sitemaps directories  will be created.The directory should be writable.</p></p>
  554     <ul class="tags">
  555                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetDataDir">SitemapCreator::setDataDir()</a></li>
  556                 <li><span class="field">see:</span> getDataDir()
  557 
  558  Default: sys_get_temp_dir()</li>
  559                 <li><span class="field">access:</span> protected</li>
  560             </ul>
  561     
  562     
  563         
  564         
  565 
  566 </div>
  567 <a name="var$engines" id="$engines"><!-- --></A>
  568 <div class="oddrow">
  569 
  570     <div class="var-header">
  571         <span class="var-title">
  572             <span class="var-type">array</span>
  573             <span class="var-name">$engines</span>
  574              = <span class="var-default">array
<br />        (
<br />        'Google' =&gt; 'http://www.google.com/webmasters/sitemaps/ping?sitemap=',
<br />        'Live Search' =&gt; 'http://www.bing.com/webmaster/ping.aspx?siteMap='
<br />    )</span>          (line <span class="line-number">198</span>)
  575         </span>
  576     </div>
  577 
  578     <!-- ========== Info from phpDoc block ========= -->
  579 <p class="short-description">Ping URLs of the search engines sitemaps API</p>
  580     <ul class="tags">
  581                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodaddEngine">SitemapCreator::addEngine()</a></li>
  582                 <li><span class="field">access:</span> protected</li>
  583             </ul>
  584     
  585     
  586         
  587         
  588 
  589 </div>
  590 <a name="var$entries" id="$entries"><!-- --></A>
  591 <div class="evenrow">
  592 
  593     <div class="var-header">
  594         <span class="var-title">
  595             <span class="var-type">array</span>
  596             <span class="var-name">$entries</span>
  597              = <span class="var-default">array()</span>         (line <span class="line-number">123</span>)
  598         </span>
  599     </div>
  600 
  601     <!-- ========== Info from phpDoc block ========= -->
  602 <p class="short-description">Array contianing the entries of the sitemap.</p>
  603     <ul class="tags">
  604                 <li><span class="field">access:</span> protected</li>
  605             </ul>
  606     
  607     
  608         
  609         
  610 
  611 </div>
  612 <a name="var$entries_per_sitemap" id="$entries_per_sitemap"><!-- --></A>
  613 <div class="oddrow">
  614 
  615     <div class="var-header">
  616         <span class="var-title">
  617             <span class="var-type">int</span>
  618             <span class="var-name">$entries_per_sitemap</span>
  619              = <span class="var-default"> 50000</span>          (line <span class="line-number">131</span>)
  620         </span>
  621     </div>
  622 
  623     <!-- ========== Info from phpDoc block ========= -->
  624 <p class="short-description">Maximum number of entries per sitemap file</p>
  625     <ul class="tags">
  626                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetEntriesPerSitemap">SitemapCreator::setEntriesPerSitemap()</a></li>
  627                 <li><span class="field">access:</span> protected</li>
  628             </ul>
  629     
  630     
  631         
  632         
  633 
  634 </div>
  635 <a name="var$frequency_mode" id="$frequency_mode"><!-- --></A>
  636 <div class="evenrow">
  637 
  638     <div class="var-header">
  639         <span class="var-title">
  640             <span class="var-type">int</span>
  641             <span class="var-name">$frequency_mode</span>
  642              = <span class="var-default"> 1</span>          (line <span class="line-number">79</span>)
  643         </span>
  644     </div>
  645 
  646     <!-- ========== Info from phpDoc block ========= -->
  647 <p class="short-description">Frequency mode</p>
  648     <ul class="tags">
  649                 <li><span class="field">var:</span> one of SitemapCreator::FREQUENCY-constants</li>
  650                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetFrequency">SitemapCreator::setFrequency()</a></li>
  651                 <li><span class="field">access:</span> protected</li>
  652             </ul>
  653     
  654     
  655         
  656         
  657 
  658 </div>
  659 <a name="var$frequency_types" id="$frequency_types"><!-- --></A>
  660 <div class="oddrow">
  661 
  662     <div class="var-header">
  663         <span class="var-title">
  664             <span class="var-type">array</span>
  665             <span class="var-name">$frequency_types</span>
  666              = <span class="var-default">array
<br />        (
<br />        'always' =&gt; 3600, //1 hour
<br />        'hourly' =&gt; 86400, //1 day
<br />        'daily' =&gt; 604800, //1 week
<br />        'weekly' =&gt; 2678400, //1 month
<br />        'monthly' =&gt; 31536000, //1 year
<br />        'yearly' =&gt; 63072000, //2 years
<br />        'never' =&gt; 94608000 //3 years
<br />    )</span>         (line <span class="line-number">91</span>)
  667         </span>
  668     </div>
  669 
  670     <!-- ========== Info from phpDoc block ========= -->
  671 <p class="short-description">Array contains Frequency types as keys and max time in seconds as values.</p>
  672     <ul class="tags">
  673                 <li><span class="field">access:</span> protected</li>
  674             </ul>
  675     
  676     
  677         
  678         
  679 
  680 </div>
  681 <a name="var$min_frequency" id="$min_frequency"><!-- --></A>
  682 <div class="evenrow">
  683 
  684     <div class="var-header">
  685         <span class="var-title">
  686             <span class="var-type">string</span>
  687             <span class="var-name">$min_frequency</span>
  688              = <span class="var-default"> 'never'</span>            (line <span class="line-number">85</span>)
  689         </span>
  690     </div>
  691 
  692     <!-- ========== Info from phpDoc block ========= -->
  693 <p class="short-description">Minimum Priority</p>
  694     <ul class="tags">
  695                 <li><span class="field">var:</span> one of  <a href="../SitemapCreator/SitemapCreator.html#var$frequency_types">$frequency_types</a></li>
  696                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetMinFrequency">SitemapCreator::setMinFrequency()</a></li>
  697                 <li><span class="field">access:</span> protected</li>
  698             </ul>
  699     
  700     
  701         
  702         
  703 
  704 </div>
  705 <a name="var$min_priority" id="$min_priority"><!-- --></A>
  706 <div class="oddrow">
  707 
  708     <div class="var-header">
  709         <span class="var-title">
  710             <span class="var-type">int</span>
  711             <span class="var-name">$min_priority</span>
  712              = <span class="var-default"> 0</span>          (line <span class="line-number">53</span>)
  713         </span>
  714     </div>
  715 
  716     <!-- ========== Info from phpDoc block ========= -->
  717 <p class="short-description">Minimum Priority</p>
  718     <ul class="tags">
  719                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetMinPriority">SitemapCreator::setMinPriority()</a></li>
  720                 <li><span class="field">access:</span> protected</li>
  721             </ul>
  722     
  723     
  724         
  725         
  726 
  727 </div>
  728 <a name="var$now" id="$now"><!-- --></A>
  729 <div class="evenrow">
  730 
  731     <div class="var-header">
  732         <span class="var-title">
  733             <span class="var-type">int</span>
  734             <span class="var-name">$now</span>
  735                         (line <span class="line-number">106</span>)
  736         </span>
  737     </div>
  738 
  739     <!-- ========== Info from phpDoc block ========= -->
  740 <p class="short-description">Current time().</p>
  741     <ul class="tags">
  742                 <li><span class="field">access:</span> protected</li>
  743             </ul>
  744     
  745     
  746         
  747         
  748 
  749 </div>
  750 <a name="var$priority_mode" id="$priority_mode"><!-- --></A>
  751 <div class="oddrow">
  752 
  753     <div class="var-header">
  754         <span class="var-title">
  755             <span class="var-type">int</span>
  756             <span class="var-name">$priority_mode</span>
  757              = <span class="var-default"> 1</span>          (line <span class="line-number">47</span>)
  758         </span>
  759     </div>
  760 
  761     <!-- ========== Info from phpDoc block ========= -->
  762 <p class="short-description">Priority mode</p>
  763     <ul class="tags">
  764                 <li><span class="field">var:</span> one of SitemapCreator::PRIORITY-constants</li>
  765                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetPriority">SitemapCreator::setPriority()</a></li>
  766                 <li><span class="field">access:</span> protected</li>
  767             </ul>
  768     
  769     
  770         
  771         
  772 
  773 </div>
  774 <a name="var$site" id="$site"><!-- --></A>
  775 <div class="evenrow">
  776 
  777     <div class="var-header">
  778         <span class="var-title">
  779             <span class="var-type">string</span>
  780             <span class="var-name">$site</span>
  781                         (line <span class="line-number">116</span>)
  782         </span>
  783     </div>
  784 
  785     <!-- ========== Info from phpDoc block ========= -->
  786 <p class="short-description">The URL of the website.It should be full qualified and normalized.</p>
  787 <p class="description"><p>Set on class creation <a href="../SitemapCreator/SitemapCreator.html#method__construct">__construct()</a> or <a href="../SitemapCreator/SitemapCreator.html#methodsetSite">setSite()</a></p><p>Default: 'http://' . $_SERVER['HTTP_HOST'] . '/'</p></p>
  788     <ul class="tags">
  789                 <li><span class="field">access:</span> protected</li>
  790             </ul>
  791     
  792     
  793         
  794         
  795 
  796 </div>
  797 <a name="var$sitemaps_count" id="$sitemaps_count"><!-- --></A>
  798 <div class="oddrow">
  799 
  800     <div class="var-header">
  801         <span class="var-title">
  802             <span class="var-type">int</span>
  803             <span class="var-name">$sitemaps_count</span>
  804              = <span class="var-default"> 0</span>          (line <span class="line-number">138</span>)
  805         </span>
  806     </div>
  807 
  808     <!-- ========== Info from phpDoc block ========= -->
  809 <p class="short-description">Number of sitemap files created</p>
  810     <ul class="tags">
  811                 <li><span class="field">access:</span> protected</li>
  812             </ul>
  813     
  814     
  815         
  816         
  817 
  818 </div>
  819 <a name="var$sitemaps_dir" id="$sitemaps_dir"><!-- --></A>
  820 <div class="evenrow">
  821 
  822     <div class="var-header">
  823         <span class="var-title">
  824             <span class="var-type">string</span>
  825             <span class="var-name">$sitemaps_dir</span>
  826                         (line <span class="line-number">169</span>)
  827         </span>
  828     </div>
  829 
  830     <!-- ========== Info from phpDoc block ========= -->
  831 <p class="short-description">Sitemaps directory path auto created in prepareSitemapsDir()</p>
  832     <ul class="tags">
  833                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodgetSitemapPath">SitemapCreator::getSitemapPath()</a></li>
  834                 <li><span class="field">access:</span> protected</li>
  835             </ul>
  836     
  837     
  838         
  839         
  840 
  841 </div>
  842 <a name="var$sitemaps_url" id="$sitemaps_url"><!-- --></A>
  843 <div class="oddrow">
  844 
  845     <div class="var-header">
  846         <span class="var-title">
  847             <span class="var-type">string</span>
  848             <span class="var-name">$sitemaps_url</span>
  849                         (line <span class="line-number">182</span>)
  850         </span>
  851     </div>
  852 
  853     <!-- ========== Info from phpDoc block ========= -->
  854 <p class="short-description">Sitemap URL where the sitemap file name will be appended to the end of the URL.</p>
  855 <p class="description"><p>If not set then the link will be generated automatically.</p></p>
  856     <ul class="tags">
  857                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodgetSitemapURL">SitemapCreator::getSitemapURL()</a></li>
  858                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetSitemapURL">SitemapCreator::setSitemapURL()</a></li>
  859                 <li><span class="field">access:</span> protected</li>
  860                 <li><span class="field">example:</span> example not found</li>
  861             </ul>
  862     
  863     
  864         
  865         
  866 
  867 </div>
  868 <a name="var$use_gzip" id="$use_gzip"><!-- --></A>
  869 <div class="evenrow">
  870 
  871     <div class="var-header">
  872         <span class="var-title">
  873             <span class="var-type">bool</span>
  874             <span class="var-name">$use_gzip</span>
  875              = <span class="var-default"> false</span>          (line <span class="line-number">190</span>)
  876         </span>
  877     </div>
  878 
  879     <!-- ========== Info from phpDoc block ========= -->
  880 <p class="short-description">choose to save sitemaps in gzip format</p>
  881     <ul class="tags">
  882                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methoduseGzip">SitemapCreator::useGzip()</a></li>
  883                 <li><span class="field">access:</span> protected</li>
  884             </ul>
  885     
  886     
  887         
  888         
  889 
  890 </div>
  891 <a name="var$xml_foot" id="$xml_foot"><!-- --></A>
  892 <div class="oddrow">
  893 
  894     <div class="var-header">
  895         <span class="var-title">
  896             <span class="var-type">mixed</span>
  897             <span class="var-name">$xml_foot</span>
  898                         (line <span class="line-number">147</span>)
  899         </span>
  900     </div>
  901 
  902     <!-- ========== Info from phpDoc block ========= -->
  903     <ul class="tags">
  904                 <li><span class="field">access:</span> protected</li>
  905             </ul>
  906     
  907     
  908         
  909         
  910 
  911 </div>
  912 <a name="var$xml_head" id="$xml_head"><!-- --></A>
  913 <div class="evenrow">
  914 
  915     <div class="var-header">
  916         <span class="var-title">
  917             <span class="var-type">mixed</span>
  918             <span class="var-name">$xml_head</span>
  919                         (line <span class="line-number">146</span>)
  920         </span>
  921     </div>
  922 
  923     <!-- ========== Info from phpDoc block ========= -->
  924     <ul class="tags">
  925                 <li><span class="field">access:</span> protected</li>
  926             </ul>
  927     
  928     
  929         
  930         
  931 
  932 </div>
  933 <a name="var$xml_url_set" id="$xml_url_set"><!-- --></A>
  934 <div class="oddrow">
  935 
  936     <div class="var-header">
  937         <span class="var-title">
  938             <span class="var-type">string</span>
  939             <span class="var-name">$xml_url_set</span>
  940              = <span class="var-default"> ''</span>         (line <span class="line-number">145</span>)
  941         </span>
  942     </div>
  943 
  944     <!-- ========== Info from phpDoc block ========= -->
  945 <p class="short-description">XML string containing sitemap &lt;urlset&gt;&lt;/urlset&gt; elements</p>
  946     <ul class="tags">
  947                 <li><span class="field">access:</span> protected</li>
  948             </ul>
  949     
  950     
  951         
  952         
  953 
  954 </div>
  955                         
  956         </div>
  957     </div>
  958     
  959     <a name="sec-methods"></a>
  960     <div class="info-box">
  961         <div class="info-box-title">Methods</div>
  962         <div class="nav-bar">
  963             <a href="#sec-description">Description</a> |
  964                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  965                                                                             <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  966                             
  967                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  968                         
  969         </div>
  970         <div class="info-box-body">
  971             <A NAME='method_detail'></A>
  972 <a name="methodopenURL" id="openURL"><!-- --></a>
  973 <div class="evenrow">
  974     
  975     <div class="method-header">
  976         <span class="method-title">static method openURL</span> (line <span class="line-number">940</span>)
  977     </div> 
  978     
  979     <!-- ========== Info from phpDoc block ========= -->
  980 <p class="short-description">Open URL and get respond body or error</p>
  981     <ul class="tags">
  982                 <li><span class="field">return:</span> Array contains errors as $results['error'], or respond body as $request['body']</li>
  983                 <li><span class="field">see:</span> Ping()</li>
  984                 <li><span class="field">section:</span> 4 Sitemap</li>
  985             </ul>
  986     
  987     <div class="method-signature">
  988         static
  989         <span class="method-result">array</span>
  990         <span class="method-name">
  991             openURL
  992         </span>
  993                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$max_redirects</span> = <span class="var-default">5</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">15</span>])
  994             </div>
  995     
  996             <ul class="parameters">
  997                     <li>
  998                 <span class="var-type">string</span>
  999                 <span class="var-name">$url</span><span class="var-description">: URL to retrieve</span>            </li>
 1000                     <li>
 1001                 <span class="var-type">int</span>
 1002                 <span class="var-name">$max_redirects</span><span class="var-description">: max allowed redirects (optional)</span>         </li>
 1003                     <li>
 1004                 <span class="var-type">int</span>
 1005                 <span class="var-name">$timeout</span><span class="var-description">: process timeout (optional )</span>            </li>
 1006                 </ul>
 1007         
 1008             
 1009     </div>
 1010 <a name="methodvalidSitemapName" id="validSitemapName"><!-- --></a>
 1011 <div class="oddrow">
 1012     
 1013     <div class="method-header">
 1014         <span class="method-title">static method validSitemapName</span> (line <span class="line-number">570</span>)
 1015     </div> 
 1016     
 1017     <!-- ========== Info from phpDoc block ========= -->
 1018 <p class="short-description">Validates sitemap filename</p>
 1019     <ul class="tags">
 1020                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodgetSitemapPath">SitemapCreator::getSitemapPath()</a></li>
 1021                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodgetSitemapURL">SitemapCreator::getSitemapURL()</a></li>
 1022                 <li><span class="field">section:</span> 2 Info</li>
 1023             </ul>
 1024     
 1025     <div class="method-signature">
 1026         static
 1027         <span class="method-result">bool</span>
 1028         <span class="method-name">
 1029             validSitemapName
 1030         </span>
 1031                     (<span class="var-type"></span>&nbsp;<span class="var-name">$filename</span>)
 1032             </div>
 1033     
 1034             <ul class="parameters">
 1035                     <li>
 1036                 <span class="var-type"></span>
 1037                 <span class="var-name">$filename</span>         </li>
 1038                 </ul>
 1039         
 1040             
 1041     </div>
 1042 
 1043 <a name="method__construct" id="__construct"><!-- --></a>
 1044 <div class="evenrow">
 1045     
 1046     <div class="method-header">
 1047         <span class="method-title">Constructor __construct</span> (line <span class="line-number">230</span>)
 1048     </div> 
 1049     
 1050     <!-- ========== Info from phpDoc block ========= -->
 1051 <p class="short-description">Initiates a new Sitemap.</p>
 1052     <ul class="tags">
 1053                 <li><span class="field">section:</span> 1 Settings</li>
 1054                 <li><span class="field">access:</span> public</li>
 1055             </ul>
 1056     
 1057     <div class="method-signature">
 1058         <span class="method-result">SitemapCreator</span>
 1059         <span class="method-name">
 1060             __construct
 1061         </span>
 1062                     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$site</span> = <span class="var-default">''</span>])
 1063             </div>
 1064     
 1065             <ul class="parameters">
 1066                     <li>
 1067                 <span class="var-type">string</span>
 1068                 <span class="var-name">$site</span><span class="var-description">: The url may contain the protocol (http://www.foo.com or https://www.foo.com), the port (http://www.foo.com:4500/index.php)                                         and/or basic-authentication-data (http://loginname:passwd@www.foo.com)</span>         </li>
 1069                 </ul>
 1070         
 1071             
 1072     </div>
 1073 <a name="methodaddEngine" id="addEngine"><!-- --></a>
 1074 <div class="oddrow">
 1075     
 1076     <div class="method-header">
 1077         <span class="method-title">addEngine</span> (line <span class="line-number">469</span>)
 1078     </div> 
 1079     
 1080     <!-- ========== Info from phpDoc block ========= -->
 1081 <p class="short-description">add a ping URL to the array $engines</p>
 1082     <ul class="tags">
 1083                 <li><span class="field">section:</span> 1 Settings</li>
 1084                 <li><span class="field">access:</span> public</li>
 1085             </ul>
 1086     
 1087     <div class="method-signature">
 1088         <span class="method-result">void</span>
 1089         <span class="method-name">
 1090             addEngine
 1091         </span>
 1092                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
 1093             </div>
 1094     
 1095             <ul class="parameters">
 1096                     <li>
 1097                 <span class="var-type">string</span>
 1098                 <span class="var-name">$url</span><span class="var-description">: ping URL of the search engine</span>          </li>
 1099                 </ul>
 1100         
 1101             
 1102     </div>
 1103 <a name="methodaddEntry" id="addEntry"><!-- --></a>
 1104 <div class="evenrow">
 1105     
 1106     <div class="method-header">
 1107         <span class="method-title">addEntry</span> (line <span class="line-number">456</span>)
 1108     </div> 
 1109     
 1110     <!-- ========== Info from phpDoc block ========= -->
 1111 <p class="short-description">add URL entry manually to <a href="../phpcrawl/SMCCrawler.html#var$entries">$entries</a></p>
 1112 <p class="description"><p>* this method throws exception if $entry is not an array or    does not have 'URL' key</p></p>
 1113     <ul class="tags">
 1114                 <li><span class="field">section:</span> 1 Settings</li>
 1115                 <li><span class="field">access:</span> public</li>
 1116                 <li><span class="field">example:</span> example not found</li>
 1117             </ul>
 1118     
 1119     <div class="method-signature">
 1120         <span class="method-result">void</span>
 1121         <span class="method-name">
 1122             addEntry
 1123         </span>
 1124                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$entry</span>)
 1125             </div>
 1126     
 1127             <ul class="parameters">
 1128                     <li>
 1129                 <span class="var-type">array</span>
 1130                 <span class="var-name">$entry</span><span class="var-description">: URL set to be added to sitemap</span>           </li>
 1131                 </ul>
 1132         
 1133             
 1134     </div>
 1135 <a name="methodaddSitemapEXT" id="addSitemapEXT"><!-- --></a>
 1136 <div class="oddrow">
 1137     
 1138     <div class="method-header">
 1139         <span class="method-title">addSitemapEXT</span> (line <span class="line-number">710</span>)
 1140     </div> 
 1141     
 1142     <!-- ========== Info from phpDoc block ========= -->
 1143 <p class="short-description">adds sitemap gzip extension to sitemap filename if $use_gzip enabled</p>
 1144     <ul class="tags">
 1145                 <li><span class="field">return:</span> filename</li>
 1146                 <li><span class="field">see:</span> useGzip();</li>
 1147                 <li><span class="field">section:</span> 4 Sitemap</li>
 1148                 <li><span class="field">access:</span> protected</li>
 1149             </ul>
 1150     
 1151     <div class="method-signature">
 1152         <span class="method-result">string</span>
 1153         <span class="method-name">
 1154             addSitemapEXT
 1155         </span>
 1156                     (<span class="var-type"></span>&nbsp;<span class="var-name">$filename</span>)
 1157             </div>
 1158     
 1159             <ul class="parameters">
 1160                     <li>
 1161                 <span class="var-type"></span>
 1162                 <span class="var-name">$filename</span>         </li>
 1163                 </ul>
 1164         
 1165             
 1166     </div>
 1167 <a name="methodaddToRobots" id="addToRobots"><!-- --></a>
 1168 <div class="evenrow">
 1169     
 1170     <div class="method-header">
 1171         <span class="method-title">addToRobots</span> (line <span class="line-number">1037</span>)
 1172     </div> 
 1173     
 1174     <!-- ========== Info from phpDoc block ========= -->
 1175 <p class="short-description">Add index sitemap URL to robots.txt file</p>
 1176 <p class="description"><p>* this method throws exception if robots file doesn't exist and is writable</p></p>
 1177     <ul class="tags">
 1178                 <li><span class="field">return:</span> robots.txt text</li>
 1179                 <li><span class="field">section:</span> 4 Sitemap</li>
 1180                 <li><span class="field">access:</span> public</li>
 1181             </ul>
 1182     
 1183     <div class="method-signature">
 1184         <span class="method-result">string</span>
 1185         <span class="method-name">
 1186             addToRobots
 1187         </span>
 1188                     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$robots_file</span> = <span class="var-default">''</span>])
 1189             </div>
 1190     
 1191             <ul class="parameters">
 1192                     <li>
 1193                 <span class="var-type">string</span>
 1194                 <span class="var-name">$robots_file</span><span class="var-description">: Robots.txt file path</span>           </li>
 1195                 </ul>
 1196         
 1197             
 1198     </div>
 1199 <a name="methodaddXMLURLSet" id="addXMLURLSet"><!-- --></a>
 1200 <div class="oddrow">
 1201     
 1202     <div class="method-header">
 1203         <span class="method-title">addXMLURLSet</span> (line <span class="line-number">867</span>)
 1204     </div> 
 1205     
 1206     <!-- ========== Info from phpDoc block ========= -->
 1207 <p class="short-description">Add single XML code to $xml_url_set</p>
 1208     <ul class="tags">
 1209                 <li><span class="field">section:</span> 4 Sitemap</li>
 1210                 <li><span class="field">access:</span> protected</li>
 1211             </ul>
 1212     
 1213     <div class="method-signature">
 1214         <span class="method-result">void</span>
 1215         <span class="method-name">
 1216             addXMLURLSet
 1217         </span>
 1218                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$entry</span>)
 1219             </div>
 1220     
 1221             <ul class="parameters">
 1222                     <li>
 1223                 <span class="var-type">array</span>
 1224                 <span class="var-name">$entry</span><span class="var-description">: URL set entry</span>            </li>
 1225                 </ul>
 1226         
 1227             
 1228     </div>
 1229 <a name="methodcalcFrequency" id="calcFrequency"><!-- --></a>
 1230 <div class="evenrow">
 1231     
 1232     <div class="method-header">
 1233         <span class="method-title">calcFrequency</span> (line <span class="line-number">812</span>)
 1234     </div> 
 1235     
 1236     <!-- ========== Info from phpDoc block ========= -->
 1237 <p class="short-description">calculates Frequency for each entry $priority_mode</p>
 1238     <ul class="tags">
 1239                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#var$frequency_types">SitemapCreator::$frequency_types</a></li>
 1240                 <li><span class="field">section:</span> 4 Sitemap</li>
 1241                 <li><span class="field">access:</span> protected</li>
 1242             </ul>
 1243     
 1244     <div class="method-signature">
 1245         <span class="method-result">void</span>
 1246         <span class="method-name">
 1247             calcFrequency
 1248         </span>
 1249                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$entry</span>)
 1250             </div>
 1251     
 1252             <ul class="parameters">
 1253                     <li>
 1254                 <span class="var-type">int</span>
 1255                 <span class="var-name">$key</span><span class="var-description">: array offset                       $entry reference to array offset in <a href="../SitemapCreator/SitemapCreator.html#var$entries">$entries</a></span>            </li>
 1256                     <li>
 1257                 <span class="var-type"></span>
 1258                 <span class="var-name">&$entry</span>           </li>
 1259                 </ul>
 1260         
 1261             
 1262     </div>
 1263 <a name="methodcalcPriority" id="calcPriority"><!-- --></a>
 1264 <div class="oddrow">
 1265     
 1266     <div class="method-header">
 1267         <span class="method-title">calcPriority</span> (line <span class="line-number">770</span>)
 1268     </div> 
 1269     
 1270     <!-- ========== Info from phpDoc block ========= -->
 1271 <p class="short-description">calculates Priority for each entry $priority_mode</p>
 1272     <ul class="tags">
 1273                 <li><span class="field">section:</span> 4 Sitemap</li>
 1274                 <li><span class="field">access:</span> protected</li>
 1275             </ul>
 1276     
 1277     <div class="method-signature">
 1278         <span class="method-result">void</span>
 1279         <span class="method-name">
 1280             calcPriority
 1281         </span>
 1282                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$entry</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$total_entries</span>)
 1283             </div>
 1284     
 1285             <ul class="parameters">
 1286                     <li>
 1287                 <span class="var-type">int</span>
 1288                 <span class="var-name">$key</span><span class="var-description">: array offset                       $entry reference to array offset in <a href="../SitemapCreator/SitemapCreator.html#var$entries">$entries</a>                       $total_entries <a href="../SitemapCreator/SitemapCreator.html#var$entries">$entries</a> array count</span>          </li>
 1289                     <li>
 1290                 <span class="var-type"></span>
 1291                 <span class="var-name">&$entry</span>           </li>
 1292                     <li>
 1293                 <span class="var-type"></span>
 1294                 <span class="var-name">$total_entries</span>            </li>
 1295                 </ul>
 1296         
 1297             
 1298     </div>
 1299 <a name="methodCrawl" id="Crawl"><!-- --></a>
 1300 <div class="evenrow">
 1301     
 1302     <div class="method-header">
 1303         <span class="method-title">Crawl</span> (line <span class="line-number">620</span>)
 1304     </div> 
 1305     
 1306     <!-- ========== Info from phpDoc block ========= -->
 1307 <p class="short-description">Start the crawl process</p>
 1308 <p class="description"><p>More related options could be found on <a href="http://phpcrawl.cuab.de/classreferences/index.html">http://phpcrawl.cuab.de/classreferences/index.html</a></p></p>
 1309     <ul class="tags">
 1310                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodinitCrawler">SitemapCreator::initCrawler()</a></li>
 1311                 <li><span class="field">section:</span> 3 Crawler</li>
 1312                 <li><span class="field">access:</span> public</li>
 1313             </ul>
 1314     
 1315     <div class="method-signature">
 1316         <span class="method-result">void</span>
 1317         <span class="method-name">
 1318             Crawl
 1319         </span>
 1320                 ()
 1321             </div>
 1322     
 1323         
 1324             
 1325     </div>
 1326 <a name="methodCreateSitemaps" id="CreateSitemaps"><!-- --></a>
 1327 <div class="oddrow">
 1328     
 1329     <div class="method-header">
 1330         <span class="method-title">CreateSitemaps</span> (line <span class="line-number">728</span>)
 1331     </div> 
 1332     
 1333     <!-- ========== Info from phpDoc block ========= -->
 1334 <p class="short-description">Create sitemaps files and index</p>
 1335     <ul class="tags">
 1336                 <li><span class="field">section:</span> 4 Sitemap</li>
 1337                 <li><span class="field">access:</span> public</li>
 1338                 <li><span class="field">example:</span> example not found</li>
 1339             </ul>
 1340     
 1341     <div class="method-signature">
 1342         <span class="method-result">void</span>
 1343         <span class="method-name">
 1344             CreateSitemaps
 1345         </span>
 1346                     ([<span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span> = <span class="var-default">array()</span>])
 1347             </div>
 1348     
 1349             <ul class="parameters">
 1350                     <li>
 1351                 <span class="var-type">array</span>
 1352                 <span class="var-name">$entries</span><span class="var-description">: array of entries to be added to sitemap</span>            </li>
 1353                 </ul>
 1354         
 1355             
 1356     </div>
 1357 <a name="methodcsvFile" id="csvFile"><!-- --></a>
 1358 <div class="evenrow">
 1359     
 1360     <div class="method-header">
 1361         <span class="method-title">csvFile</span> (line <span class="line-number">1138</span>)
 1362     </div> 
 1363     
 1364     <!-- ========== Info from phpDoc block ========= -->
 1365 <p class="short-description">get CSV file path</p>
 1366     <ul class="tags">
 1367                 <li><span class="field">return:</span> CSV file path</li>
 1368                 <li><span class="field">section:</span> 5 CSV</li>
 1369                 <li><span class="field">access:</span> public</li>
 1370             </ul>
 1371     
 1372     <div class="method-signature">
 1373         <span class="method-result">string</span>
 1374         <span class="method-name">
 1375             csvFile
 1376         </span>
 1377                 ()
 1378             </div>
 1379     
 1380         
 1381             
 1382     </div>
 1383 <a name="methodgetDataDir" id="getDataDir"><!-- --></a>
 1384 <div class="oddrow">
 1385     
 1386     <div class="method-header">
 1387         <span class="method-title">getDataDir</span> (line <span class="line-number">558</span>)
 1388     </div> 
 1389     
 1390     <!-- ========== Info from phpDoc block ========= -->
 1391 <p class="short-description">Get data directory path $data_dir</p>
 1392     <ul class="tags">
 1393                 <li><span class="field">return:</span> <a href="../SitemapCreator/SitemapCreator.html#var$data_dir">$data_dir</a></li>
 1394                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetDataDir">SitemapCreator::setDataDir()</a></li>
 1395                 <li><span class="field">section:</span> 2 Info</li>
 1396                 <li><span class="field">access:</span> public</li>
 1397             </ul>
 1398     
 1399     <div class="method-signature">
 1400         <span class="method-result">string</span>
 1401         <span class="method-name">
 1402             getDataDir
 1403         </span>
 1404                 ()
 1405             </div>
 1406     
 1407         
 1408             
 1409     </div>
 1410 <a name="methodgetEntries" id="getEntries"><!-- --></a>
 1411 <div class="evenrow">
 1412     
 1413     <div class="method-header">
 1414         <span class="method-title">getEntries</span> (line <span class="line-number">547</span>)
 1415     </div> 
 1416     
 1417     <!-- ========== Info from phpDoc block ========= -->
 1418 <p class="short-description">Get URLs sets array <a href="../phpcrawl/SMCCrawler.html#var$entries">$entries</a></p>
 1419     <ul class="tags">
 1420                 <li><span class="field">return:</span> <a href="../SitemapCreator/SitemapCreator.html#var$entries">$entries</a></li>
 1421                 <li><span class="field">section:</span> 2 Info</li>
 1422                 <li><span class="field">access:</span> public</li>
 1423             </ul>
 1424     
 1425     <div class="method-signature">
 1426         <span class="method-result">array</span>
 1427         <span class="method-name">
 1428             getEntries
 1429         </span>
 1430                 ()
 1431             </div>
 1432     
 1433         
 1434             
 1435     </div>
 1436 <a name="methodgetSitemapDirName" id="getSitemapDirName"><!-- --></a>
 1437 <div class="oddrow">
 1438     
 1439     <div class="method-header">
 1440         <span class="method-title">getSitemapDirName</span> (line <span class="line-number">518</span>)
 1441     </div> 
 1442     
 1443     <!-- ========== Info from phpDoc block ========= -->
 1444 <p class="short-description">Get sitemap directory name</p>
 1445 <p class="description"><p>Get this site's directory name where sitemaps are strored.   The directory is created inside the <a href="../SitemapCreator/SitemapCreator.html#var$data_dir">$data_dir</a> directory.</p></p>
 1446     <ul class="tags">
 1447                 <li><span class="field">return:</span> false if <a href="../SitemapCreator/SitemapCreator.html#var$site">$site</a> has not been set, sitemap dir path on success</li>
 1448                 <li><span class="field">section:</span> 2 Info</li>
 1449                 <li><span class="field">access:</span> public</li>
 1450                 <li><span class="field">example:</span> example not found</li>
 1451             </ul>
 1452     
 1453     <div class="method-signature">
 1454         <span class="method-result">bool|string</span>
 1455         <span class="method-name">
 1456             getSitemapDirName
 1457         </span>
 1458                 ()
 1459             </div>
 1460     
 1461         
 1462             
 1463     </div>
 1464 <a name="methodgetSitemapPath" id="getSitemapPath"><!-- --></a>
 1465 <div class="evenrow">
 1466     
 1467     <div class="method-header">
 1468         <span class="method-title">getSitemapPath</span> (line <span class="line-number">482</span>)
 1469     </div> 
 1470     
 1471     <!-- ========== Info from phpDoc block ========= -->
 1472 <p class="short-description">Get sitemap file path</p>
 1473     <ul class="tags">
 1474                 <li><span class="field">return:</span> false on invalid $filename parameter, sitemap path on success</li>
 1475                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetDataDir">SitemapCreator::setDataDir()</a></li>
 1476                 <li><span class="field">section:</span> 2 Info</li>
 1477                 <li><span class="field">access:</span> public</li>
 1478             </ul>
 1479     
 1480     <div class="method-signature">
 1481         <span class="method-result">bool|string</span>
 1482         <span class="method-name">
 1483             getSitemapPath
 1484         </span>
 1485                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
 1486             </div>
 1487     
 1488             <ul class="parameters">
 1489                     <li>
 1490                 <span class="var-type">string</span>
 1491                 <span class="var-name">$filename</span><span class="var-description">: 'index' string or number</span>          </li>
 1492                 </ul>
 1493         
 1494             
 1495     </div>
 1496 <a name="methodgetSitemapsDir" id="getSitemapsDir"><!-- --></a>
 1497 <div class="oddrow">
 1498     
 1499     <div class="method-header">
 1500         <span class="method-title">getSitemapsDir</span> (line <span class="line-number">535</span>)
 1501     </div> 
 1502     
 1503     <!-- ========== Info from phpDoc block ========= -->
 1504 <p class="short-description">Get sitemap directory path $sitemaps_dir</p>
 1505 <p class="description"><p>Get this site's directory path where sitemaps are strored.   The directory is created inside the <a href="../SitemapCreator/SitemapCreator.html#var$data_dir">$data_dir</a> directory.</p></p>
 1506     <ul class="tags">
 1507                 <li><span class="field">return:</span> SitemapCreator::sitemaps_dir sitemap dir path</li>
 1508                 <li><span class="field">section:</span> 2 Info</li>
 1509                 <li><span class="field">access:</span> public</li>
 1510                 <li><span class="field">example:</span> example not found</li>
 1511             </ul>
 1512     
 1513     <div class="method-signature">
 1514         <span class="method-result">string</span>
 1515         <span class="method-name">
 1516             getSitemapsDir
 1517         </span>
 1518                 ()
 1519             </div>
 1520     
 1521         
 1522             
 1523     </div>
 1524 <a name="methodgetSitemapURL" id="getSitemapURL"><!-- --></a>
 1525 <div class="evenrow">
 1526     
 1527     <div class="method-header">
 1528         <span class="method-title">getSitemapURL</span> (line <span class="line-number">499</span>)
 1529     </div> 
 1530     
 1531     <!-- ========== Info from phpDoc block ========= -->
 1532 <p class="short-description">Get sitemap file URL</p>
 1533     <ul class="tags">
 1534                 <li><span class="field">return:</span> false on invalid $filename parameter, sitemap path on success</li>
 1535                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodvalidSitemapName">SitemapCreator::validSitemapName()</a></li>
 1536                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodaddSitemapEXT">SitemapCreator::addSitemapEXT()</a></li>
 1537                 <li><span class="field">section:</span> 2 Info</li>
 1538                 <li><span class="field">access:</span> public</li>
 1539             </ul>
 1540     
 1541     <div class="method-signature">
 1542         <span class="method-result">bool|string</span>
 1543         <span class="method-name">
 1544             getSitemapURL
 1545         </span>
 1546                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>)
 1547             </div>
 1548     
 1549             <ul class="parameters">
 1550                     <li>
 1551                 <span class="var-type">string</span>
 1552                 <span class="var-name">$filename</span><span class="var-description">: 'index' string or number</span>          </li>
 1553                 </ul>
 1554         
 1555             
 1556     </div>
 1557 <a name="methodinitCrawler" id="initCrawler"><!-- --></a>
 1558 <div class="oddrow">
 1559     
 1560     <div class="method-header">
 1561         <span class="method-title">initCrawler</span> (line <span class="line-number">591</span>)
 1562     </div> 
 1563     
 1564     <!-- ========== Info from phpDoc block ========= -->
 1565 <p class="short-description">Initiate the crawler $Crawler</p>
 1566 <p class="description"><p>visit <a href="http://phpcrawl.cuab.de/classreferences/index.html">http://phpcrawl.cuab.de/classreferences/index.html</a> for  full cralwer options which can be accessed through <a href="../SitemapCreator/SitemapCreator.html#var$Crawler">$Crawler</a> object.</p></p>
 1567     <ul class="tags">
 1568                 <li><span class="field">return:</span> object <a href="../phpcrawl/SMCCrawler.html">SMCCrawler</a></li>
 1569                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodCrawl">SitemapCreator::Crawl()</a></li>
 1570                 <li><span class="field">section:</span> 3 Crawler</li>
 1571                 <li><span class="field">access:</span> public</li>
 1572                 <li><span class="field">example:</span> example not found</li>
 1573             </ul>
 1574     
 1575     <div class="method-signature">
 1576         <span class="method-result"><a href="../phpcrawl/SMCCrawler.html">SMCCrawler</a></span>
 1577         <span class="method-name">
 1578             initCrawler
 1579         </span>
 1580                 ()
 1581             </div>
 1582     
 1583         
 1584             
 1585     </div>
 1586 <a name="methodisDataDirWritable" id="isDataDirWritable"><!-- --></a>
 1587 <div class="evenrow">
 1588     
 1589     <div class="method-header">
 1590         <span class="method-title">isDataDirWritable</span> (line <span class="line-number">697</span>)
 1591     </div> 
 1592     
 1593     <!-- ========== Info from phpDoc block ========= -->
 1594 <p class="short-description">Check if data directory is writable $data_dir</p>
 1595     <ul class="tags">
 1596                 <li><span class="field">return:</span> true on success, false otherwise</li>
 1597                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetDataDir">SitemapCreator::setDataDir()</a></li>
 1598                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodprepareSitemapsDir">SitemapCreator::prepareSitemapsDir()</a></li>
 1599                 <li><span class="field">section:</span> 4 Sitemap</li>
 1600                 <li><span class="field">access:</span> protected</li>
 1601             </ul>
 1602     
 1603     <div class="method-signature">
 1604         <span class="method-result">bool</span>
 1605         <span class="method-name">
 1606             isDataDirWritable
 1607         </span>
 1608                     (<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
 1609             </div>
 1610     
 1611             <ul class="parameters">
 1612                     <li>
 1613                 <span class="var-type"></span>
 1614                 <span class="var-name">$dir</span>          </li>
 1615                 </ul>
 1616         
 1617             
 1618     </div>
 1619 <a name="methodping" id="ping"><!-- --></a>
 1620 <div class="oddrow">
 1621     
 1622     <div class="method-header">
 1623         <span class="method-title">ping</span> (line <span class="line-number">919</span>)
 1624     </div> 
 1625     
 1626     <!-- ========== Info from phpDoc block ========= -->
 1627 <p class="short-description">Ping search engines</p>
 1628     <ul class="tags">
 1629                 <li><span class="field">return:</span> Array contains errors as $results['google']['error'], or respond body as $request['google']['body']</li>
 1630                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodaddEngine">SitemapCreator::addEngine()</a></li>
 1631                 <li><span class="field">section:</span> 4 Sitemap</li>
 1632                 <li><span class="field">access:</span> public</li>
 1633             </ul>
 1634     
 1635     <div class="method-signature">
 1636         <span class="method-result">array</span>
 1637         <span class="method-name">
 1638             ping
 1639         </span>
 1640                     ([<span class="var-type">string|int</span>&nbsp;<span class="var-name">$filename</span> = <span class="var-default">'index'</span>])
 1641             </div>
 1642     
 1643             <ul class="parameters">
 1644                     <li>
 1645                 <span class="var-type">string|int</span>
 1646                 <span class="var-name">$filename</span><span class="var-description">: 'index' string or number</span>          </li>
 1647                 </ul>
 1648         
 1649             
 1650     </div>
 1651 <a name="methodprepareSitemapsDir" id="prepareSitemapsDir"><!-- --></a>
 1652 <div class="evenrow">
 1653     
 1654     <div class="method-header">
 1655         <span class="method-title">prepareSitemapsDir</span> (line <span class="line-number">675</span>)
 1656     </div> 
 1657     
 1658     <!-- ========== Info from phpDoc block ========= -->
 1659 <p class="short-description">Creates sitemaps directory $sitemaps_dir</p>
 1660 <p class="description"><p>* this method throws exception if data is not writable</p></p>
 1661     <ul class="tags">
 1662                 <li><span class="field">see:</span> setDataDir();</li>
 1663                 <li><span class="field">section:</span> 4 Sitemap</li>
 1664                 <li><span class="field">access:</span> protected</li>
 1665             </ul>
 1666     
 1667     <div class="method-signature">
 1668         <span class="method-result">void</span>
 1669         <span class="method-name">
 1670             prepareSitemapsDir
 1671         </span>
 1672                 ()
 1673             </div>
 1674     
 1675         
 1676             
 1677     </div>
 1678 <a name="methodputContent" id="putContent"><!-- --></a>
 1679 <div class="oddrow">
 1680     
 1681     <div class="method-header">
 1682         <span class="method-title">putContent</span> (line <span class="line-number">1000</span>)
 1683     </div> 
 1684     
 1685     <!-- ========== Info from phpDoc block ========= -->
 1686 <p class="short-description">Write XML to disk</p>
 1687     <ul class="tags">
 1688                 <li><span class="field">section:</span> 4 Sitemap</li>
 1689                 <li><span class="field">access:</span> public</li>
 1690             </ul>
 1691     
 1692     <div class="method-signature">
 1693         <span class="method-result">void</span>
 1694         <span class="method-name">
 1695             putContent
 1696         </span>
 1697                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">$XML</span>&nbsp;<span class="var-name">$XML</span>)
 1698             </div>
 1699     
 1700             <ul class="parameters">
 1701                     <li>
 1702                 <span class="var-type">string</span>
 1703                 <span class="var-name">$file</span><span class="var-description">: file path</span>         </li>
 1704                     <li>
 1705                 <span class="var-type">$XML</span>
 1706                 <span class="var-name">$XML</span><span class="var-description">: XML code</span>           </li>
 1707                 </ul>
 1708         
 1709             
 1710     </div>
 1711 <a name="methodreadFromCSV" id="readFromCSV"><!-- --></a>
 1712 <div class="evenrow">
 1713     
 1714     <div class="method-header">
 1715         <span class="method-title">readFromCSV</span> (line <span class="line-number">1110</span>)
 1716     </div> 
 1717     
 1718     <!-- ========== Info from phpDoc block ========= -->
 1719 <p class="short-description">Read from CSV file and add to <a href="../phpcrawl/SMCCrawler.html#var$entries">$entries</a></p>
 1720     <ul class="tags">
 1721                 <li><span class="field">return:</span> true on success, false otherwise</li>
 1722                 <li><span class="field">section:</span> 5 CSV</li>
 1723                 <li><span class="field">access:</span> public</li>
 1724             </ul>
 1725     
 1726     <div class="method-signature">
 1727         <span class="method-result">bool</span>
 1728         <span class="method-name">
 1729             readFromCSV
 1730         </span>
 1731                     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">''</span>])
 1732             </div>
 1733     
 1734             <ul class="parameters">
 1735                     <li>
 1736                 <span class="var-type">string</span>
 1737                 <span class="var-name">$file</span><span class="var-description">: file path</span>         </li>
 1738                 </ul>
 1739         
 1740             
 1741     </div>
 1742 <a name="methodreadSitemap" id="readSitemap"><!-- --></a>
 1743 <div class="oddrow">
 1744     
 1745     <div class="method-header">
 1746         <span class="method-title">readSitemap</span> (line <span class="line-number">1017</span>)
 1747     </div> 
 1748     
 1749     <!-- ========== Info from phpDoc block ========= -->
 1750 <p class="short-description">Read sitemap file from disk</p>
 1751 <p class="description"><p>*this method throws exception if sitemap file doesn't exsit</p></p>
 1752     <ul class="tags">
 1753                 <li><span class="field">section:</span> 4 Sitemap</li>
 1754                 <li><span class="field">access:</span> public</li>
 1755             </ul>
 1756     
 1757     <div class="method-signature">
 1758         <span class="method-result">void</span>
 1759         <span class="method-name">
 1760             readSitemap
 1761         </span>
 1762                     (<span class="var-type">string|int</span>&nbsp;<span class="var-name">$filename</span>)
 1763             </div>
 1764     
 1765             <ul class="parameters">
 1766                     <li>
 1767                 <span class="var-type">string|int</span>
 1768                 <span class="var-name">$filename</span><span class="var-description">: 'index' string or number</span>          </li>
 1769                 </ul>
 1770         
 1771             
 1772     </div>
 1773 <a name="methodremoveSitemaps" id="removeSitemaps"><!-- --></a>
 1774 <div class="evenrow">
 1775     
 1776     <div class="method-header">
 1777         <span class="method-title">removeSitemaps</span> (line <span class="line-number">1062</span>)
 1778     </div> 
 1779     
 1780     <!-- ========== Info from phpDoc block ========= -->
 1781 <p class="short-description">Delete all sitemap dir and files</p>
 1782     <ul class="tags">
 1783                 <li><span class="field">return:</span> true on success, false otherwise</li>
 1784                 <li><span class="field">section:</span> 4 Sitemap</li>
 1785                 <li><span class="field">access:</span> public</li>
 1786             </ul>
 1787     
 1788     <div class="method-signature">
 1789         <span class="method-result">bool</span>
 1790         <span class="method-name">
 1791             removeSitemaps
 1792         </span>
 1793                 ()
 1794             </div>
 1795     
 1796         
 1797             
 1798     </div>
 1799 <a name="methodsetCrawlerDefaults" id="setCrawlerDefaults"><!-- --></a>
 1800 <div class="oddrow">
 1801     
 1802     <div class="method-header">
 1803         <span class="method-title">setCrawlerDefaults</span> (line <span class="line-number">647</span>)
 1804     </div> 
 1805     
 1806     <!-- ========== Info from phpDoc block ========= -->
 1807 <p class="short-description">Load default crawler settings for $Crawler</p>
 1808 <p class="description"><p>Internally load default options, no external calls allowed   More related options could be found on  <a href="http://phpcrawl.cuab.de/classreferences/index.html">http://phpcrawl.cuab.de/classreferences/index.html</a></p></p>
 1809     <ul class="tags">
 1810                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodCrawl">SitemapCreator::Crawl()</a></li>
 1811                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodinitCrawler">SitemapCreator::initCrawler()</a></li>
 1812                 <li><span class="field">section:</span> 3 Crawler</li>
 1813                 <li><span class="field">access:</span> protected</li>
 1814             </ul>
 1815     
 1816     <div class="method-signature">
 1817         <span class="method-result">void</span>
 1818         <span class="method-name">
 1819             setCrawlerDefaults
 1820         </span>
 1821                 ()
 1822             </div>
 1823     
 1824         
 1825             
 1826     </div>
 1827 <a name="methodsetDataDir" id="setDataDir"><!-- --></a>
 1828 <div class="evenrow">
 1829     
 1830     <div class="method-header">
 1831         <span class="method-title">setDataDir</span> (line <span class="line-number">290</span>)
 1832     </div> 
 1833     
 1834     <!-- ========== Info from phpDoc block ========= -->
 1835 <p class="short-description">Sets the data directory path of the sitemaps $data_dir</p>
 1836 <p class="description"><p>The directory is used to store sitemaps and csv files. If not set then  sys_get_temp_dir() will be used.</p><p>* This method throws an exception if the path is not valid or the directory is not writable.</p></p>
 1837     <ul class="tags">
 1838                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodprepareSitemapsDir">SitemapCreator::prepareSitemapsDir()</a></li>
 1839                 <li><span class="field">section:</span> 1 Settings</li>
 1840                 <li><span class="field">access:</span> public</li>
 1841                 <li><span class="field">example:</span> example not found</li>
 1842             </ul>
 1843     
 1844     <div class="method-signature">
 1845         <span class="method-result">void</span>
 1846         <span class="method-name">
 1847             setDataDir
 1848         </span>
 1849                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
 1850             </div>
 1851     
 1852             <ul class="parameters">
 1853                     <li>
 1854                 <span class="var-type">string</span>
 1855                 <span class="var-name">$dir</span><span class="var-description">: data directory <a href="../SitemapCreator/SitemapCreator.html#var$data_dir">$data_dir</a></span>          </li>
 1856                 </ul>
 1857         
 1858             
 1859     </div>
 1860 <a name="methodsetEntries" id="setEntries"><!-- --></a>
 1861 <div class="oddrow">
 1862     
 1863     <div class="method-header">
 1864         <span class="method-title">setEntries</span> (line <span class="line-number">358</span>)
 1865     </div> 
 1866     
 1867     <!-- ========== Info from phpDoc block ========= -->
 1868 <p class="short-description">Set the URLs sets manually <a href="../phpcrawl/SMCCrawler.html#var$entries">$entries</a></p>
 1869 <p class="description"><p>* this method throws exception if $entires is not an array or    the first entry does not have 'URL' key</p></p>
 1870     <ul class="tags">
 1871                 <li><span class="field">section:</span> 1 Settings</li>
 1872                 <li><span class="field">access:</span> public</li>
 1873                 <li><span class="field">example:</span> example not found</li>
 1874             </ul>
 1875     
 1876     <div class="method-signature">
 1877         <span class="method-result">void</span>
 1878         <span class="method-name">
 1879             setEntries
 1880         </span>
 1881                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$entries</span>)
 1882             </div>
 1883     
 1884             <ul class="parameters">
 1885                     <li>
 1886                 <span class="var-type">array</span>
 1887                 <span class="var-name">$entries</span><span class="var-description">: array of entries to be added to sitemap</span>            </li>
 1888                 </ul>
 1889         
 1890             
 1891     </div>
 1892 <a name="methodsetEntriesPerSitemap" id="setEntriesPerSitemap"><!-- --></a>
 1893 <div class="evenrow">
 1894     
 1895     <div class="method-header">
 1896         <span class="method-title">setEntriesPerSitemap</span> (line <span class="line-number">325</span>)
 1897     </div> 
 1898     
 1899     <!-- ========== Info from phpDoc block ========= -->
 1900 <p class="short-description">Sets number of URLs set for each sitemap file $entries_per_sitemap</p>
 1901 <p class="description"><p>Each sitemap file should have a maximum of 50,000 URL.  Use this function to change the number of URLs set per sitemap.</p></p>
 1902     <ul class="tags">
 1903                 <li><span class="field">return:</span> true on success, false otherwise</li>
 1904                 <li><span class="field">section:</span> 1 Settings</li>
 1905                 <li><span class="field">access:</span> public</li>
 1906                 <li><span class="field">example:</span> example not found</li>
 1907             </ul>
 1908     
 1909     <div class="method-signature">
 1910         <span class="method-result">bool</span>
 1911         <span class="method-name">
 1912             setEntriesPerSitemap
 1913         </span>
 1914                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$number</span>)
 1915             </div>
 1916     
 1917             <ul class="parameters">
 1918                     <li>
 1919                 <span class="var-type">int</span>
 1920                 <span class="var-name">$number</span><span class="var-description">: number greater than 0</span>           </li>
 1921                 </ul>
 1922         
 1923             
 1924     </div>
 1925 <a name="methodsetFrequency" id="setFrequency"><!-- --></a>
 1926 <div class="oddrow">
 1927     
 1928     <div class="method-header">
 1929         <span class="method-title">setFrequency</span> (line <span class="line-number">416</span>)
 1930     </div> 
 1931     
 1932     <!-- ========== Info from phpDoc block ========= -->
 1933 <p class="short-description">Set Frequency mode $frequency_mode</p>
 1934 <p class="description"><p>Choose how the Frequency of every URL should be calculated</p></p>
 1935     <ul class="tags">
 1936                 <li><span class="field">return:</span> true on success, false otherwise</li>
 1937                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetMinFrequency">SitemapCreator::setMinFrequency()</a></li>
 1938                 <li><span class="field">link:</span> <a href="http://www.sitemaps.org/protocol.html#changefreqdef">http://www.sitemaps.org/protocol.html#changefreqdef</a></li>
 1939                 <li><span class="field">section:</span> 1 Settings</li>
 1940                 <li><span class="field">access:</span> public</li>
 1941             </ul>
 1942     
 1943     <div class="method-signature">
 1944         <span class="method-result">bool</span>
 1945         <span class="method-name">
 1946             setFrequency
 1947         </span>
 1948                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
 1949             </div>
 1950     
 1951             <ul class="parameters">
 1952                     <li>
 1953                 <span class="var-type">int</span>
 1954                 <span class="var-name">$mode</span><span class="var-description">: number between 0 and 2 or  use the predefined constants                                   SitemapCreator::FREQUENCY_Disable  Disables frequency calculations                                   SitemapCreator::FREQUENCY_LAST_MODIFIED Latest modified pages get higher frequency                                   SitemapCreator::FREQUENCY_PRIORITY Higher priority pages get higher frequency</span>         </li>
 1955                 </ul>
 1956         
 1957             
 1958     </div>
 1959 <a name="methodsetMinFrequency" id="setMinFrequency"><!-- --></a>
 1960 <div class="evenrow">
 1961     
 1962     <div class="method-header">
 1963         <span class="method-title">setMinFrequency</span> (line <span class="line-number">432</span>)
 1964     </div> 
 1965     
 1966     <!-- ========== Info from phpDoc block ========= -->
 1967 <p class="short-description">Set minimum Frequency value for all URLs $min_priority</p>
 1968     <ul class="tags">
 1969                 <li><span class="field">return:</span> true on success, false otherwise</li>
 1970                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetMinFrequency">SitemapCreator::setMinFrequency()</a></li>
 1971                 <li><span class="field">section:</span> 1 Settings</li>
 1972                 <li><span class="field">access:</span> public</li>
 1973             </ul>
 1974     
 1975     <div class="method-signature">
 1976         <span class="method-result">bool</span>
 1977         <span class="method-name">
 1978             setMinFrequency
 1979         </span>
 1980                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span>)
 1981             </div>
 1982     
 1983             <ul class="parameters">
 1984                     <li>
 1985                 <span class="var-type">string</span>
 1986                 <span class="var-name">$mode</span><span class="var-description">: one of <a href="../SitemapCreator/SitemapCreator.html#var$frequency_types">$frequency_types</a> keys</span>          </li>
 1987                 </ul>
 1988         
 1989             
 1990     </div>
 1991 <a name="methodsetMinPriority" id="setMinPriority"><!-- --></a>
 1992 <div class="oddrow">
 1993     
 1994     <div class="method-header">
 1995         <span class="method-title">setMinPriority</span> (line <span class="line-number">395</span>)
 1996     </div> 
 1997     
 1998     <!-- ========== Info from phpDoc block ========= -->
 1999 <p class="short-description">Set minimum Priority value for all URLs $min_priority</p>
 2000     <ul class="tags">
 2001                 <li><span class="field">return:</span> true on success, false otherwise</li>
 2002                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetMinPriority">SitemapCreator::setMinPriority()</a></li>
 2003                 <li><span class="field">section:</span> 1 Settings</li>
 2004                 <li><span class="field">access:</span> public</li>
 2005             </ul>
 2006     
 2007     <div class="method-signature">
 2008         <span class="method-result">bool</span>
 2009         <span class="method-name">
 2010             setMinPriority
 2011         </span>
 2012                     (<span class="var-type">float</span>&nbsp;<span class="var-name">$mode</span>)
 2013             </div>
 2014     
 2015             <ul class="parameters">
 2016                     <li>
 2017                 <span class="var-type">float</span>
 2018                 <span class="var-name">$mode</span><span class="var-description">: number between 0 and 1.0</span>          </li>
 2019                 </ul>
 2020         
 2021             
 2022     </div>
 2023 <a name="methodsetPriority" id="setPriority"><!-- --></a>
 2024 <div class="evenrow">
 2025     
 2026     <div class="method-header">
 2027         <span class="method-title">setPriority</span> (line <span class="line-number">379</span>)
 2028     </div> 
 2029     
 2030     <!-- ========== Info from phpDoc block ========= -->
 2031 <p class="short-description">Set Priority mode $priority_mode</p>
 2032 <p class="description"><p>Choose how the Priority of every URL should be calculated</p></p>
 2033     <ul class="tags">
 2034                 <li><span class="field">return:</span> true on success, false otherwise</li>
 2035                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetMinPriority">SitemapCreator::setMinPriority()</a></li>
 2036                 <li><span class="field">link:</span> <a href="http://www.sitemaps.org/protocol.html#prioritydef">http://www.sitemaps.org/protocol.html#prioritydef</a></li>
 2037                 <li><span class="field">section:</span> 1 Settings</li>
 2038                 <li><span class="field">access:</span> public</li>
 2039             </ul>
 2040     
 2041     <div class="method-signature">
 2042         <span class="method-result">bool</span>
 2043         <span class="method-name">
 2044             setPriority
 2045         </span>
 2046                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
 2047             </div>
 2048     
 2049             <ul class="parameters">
 2050                     <li>
 2051                 <span class="var-type">int</span>
 2052                 <span class="var-name">$mode</span><span class="var-description">: number between 0 and 2 or  use the predefined constants                                   SitemapCreator::PRIORITY_Disable  Disables priority calculations                                   SitemapCreator::PRIORITY_CRAWLED_FIRST Crawled first pages get higher priority                                   SitemapCreator::PRIORITY_URL_STRUCTURE Deeper pathes get lower priority</span>         </li>
 2053                 </ul>
 2054         
 2055             
 2056     </div>
 2057 <a name="methodsetSite" id="setSite"><!-- --></a>
 2058 <div class="oddrow">
 2059     
 2060     <div class="method-header">
 2061         <span class="method-title">setSite</span> (line <span class="line-number">259</span>)
 2062     </div> 
 2063     
 2064     <!-- ========== Info from phpDoc block ========= -->
 2065 <p class="short-description">Sets the URL of the website $site</p>
 2066 <p class="description"><p>Normalizes the given URL and returns a full qualified and normalized URL.  The method also generates <a href="../SitemapCreator/SitemapCreator.html#var$sitemaps_url">$sitemaps_url</a> if not set.</p><p>* This method throws an exception if the URL is invalid</p></p>
 2067     <ul class="tags">
 2068                 <li><span class="field">return:</span> SitemapCreator::$site|false Returns the valid normalized URL on success or false on failure</li>
 2069                 <li><span class="field">section:</span> 1 Settings</li>
 2070                 <li><span class="field">access:</span> public</li>
 2071             </ul>
 2072     
 2073     <div class="method-signature">
 2074         <span class="method-result">string|bool</span>
 2075         <span class="method-name">
 2076             setSite
 2077         </span>
 2078                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$site</span>)
 2079             </div>
 2080     
 2081             <ul class="parameters">
 2082                     <li>
 2083                 <span class="var-type">string</span>
 2084                 <span class="var-name">$site</span><span class="var-description">: The url may contain the protocol (http://www.foo.com or https://www.foo.com), the port (http://www.foo.com:4500/index.php)                                         and/or basic-authentication-data (http://loginname:passwd@www.foo.com)</span>         </li>
 2085                 </ul>
 2086         
 2087             
 2088     </div>
 2089 <a name="methodsetSitemapURL" id="setSitemapURL"><!-- --></a>
 2090 <div class="evenrow">
 2091     
 2092     <div class="method-header">
 2093         <span class="method-title">setSitemapURL</span> (line <span class="line-number">309</span>)
 2094     </div> 
 2095     
 2096     <!-- ========== Info from phpDoc block ========= -->
 2097 <p class="short-description">Sets the URL of the sitemap files $sitemaps_url</p>
 2098 <p class="description"><p>Sitemap URL where the sitemap file name will be appended to the end of the URL.</p></p>
 2099     <ul class="tags">
 2100                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodgetSitemapURL">SitemapCreator::getSitemapURL()</a></li>
 2101                 <li><span class="field">section:</span> 1 Settings</li>
 2102                 <li><span class="field">access:</span> public</li>
 2103                 <li><span class="field">example:</span> example not found</li>
 2104             </ul>
 2105     
 2106     <div class="method-signature">
 2107         <span class="method-result">void</span>
 2108         <span class="method-name">
 2109             setSitemapURL
 2110         </span>
 2111                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
 2112             </div>
 2113     
 2114             <ul class="parameters">
 2115                     <li>
 2116                 <span class="var-type">string</span>
 2117                 <span class="var-name">$url</span><span class="var-description">: The sitemap URL</span>            </li>
 2118                 </ul>
 2119         
 2120             
 2121     </div>
 2122 <a name="methoduseGzip" id="useGzip"><!-- --></a>
 2123 <div class="oddrow">
 2124     
 2125     <div class="method-header">
 2126         <span class="method-title">useGzip</span> (line <span class="line-number">338</span>)
 2127     </div> 
 2128     
 2129     <!-- ========== Info from phpDoc block ========= -->
 2130 <p class="short-description">Use gzip compressed sitemaps files $use_gzip</p>
 2131     <ul class="tags">
 2132                 <li><span class="field">section:</span> 1 Settings</li>
 2133                 <li><span class="field">access:</span> public</li>
 2134             </ul>
 2135     
 2136     <div class="method-signature">
 2137         <span class="method-result">void</span>
 2138         <span class="method-name">
 2139             useGzip
 2140         </span>
 2141                     (<span class="var-type">bool</span>&nbsp;<span class="var-name">$mode</span>)
 2142             </div>
 2143     
 2144             <ul class="parameters">
 2145                     <li>
 2146                 <span class="var-type">bool</span>
 2147                 <span class="var-name">$mode</span><span class="var-description">: true to enable gzip, false otherwise</span>          </li>
 2148                 </ul>
 2149         
 2150             
 2151     </div>
 2152 <a name="methodwriteIndex" id="writeIndex"><!-- --></a>
 2153 <div class="evenrow">
 2154     
 2155     <div class="method-header">
 2156         <span class="method-title">writeIndex</span> (line <span class="line-number">897</span>)
 2157     </div> 
 2158     
 2159     <!-- ========== Info from phpDoc block ========= -->
 2160 <p class="short-description">Write sitemap index file</p>
 2161     <ul class="tags">
 2162                 <li><span class="field">section:</span> 4 Sitemap</li>
 2163                 <li><span class="field">access:</span> protected</li>
 2164             </ul>
 2165     
 2166     <div class="method-signature">
 2167         <span class="method-result">void</span>
 2168         <span class="method-name">
 2169             writeIndex
 2170         </span>
 2171                 ()
 2172             </div>
 2173     
 2174         
 2175             
 2176     </div>
 2177 <a name="methodwriteSitemap" id="writeSitemap"><!-- --></a>
 2178 <div class="oddrow">
 2179     
 2180     <div class="method-header">
 2181         <span class="method-title">writeSitemap</span> (line <span class="line-number">887</span>)
 2182     </div> 
 2183     
 2184     <!-- ========== Info from phpDoc block ========= -->
 2185 <p class="short-description">Write sitemap file</p>
 2186     <ul class="tags">
 2187                 <li><span class="field">section:</span> 4 Sitemap</li>
 2188                 <li><span class="field">access:</span> protected</li>
 2189             </ul>
 2190     
 2191     <div class="method-signature">
 2192         <span class="method-result">void</span>
 2193         <span class="method-name">
 2194             writeSitemap
 2195         </span>
 2196                 ()
 2197             </div>
 2198     
 2199         
 2200             
 2201     </div>
 2202 <a name="methodwriteToCSV" id="writeToCSV"><!-- --></a>
 2203 <div class="evenrow">
 2204     
 2205     <div class="method-header">
 2206         <span class="method-title">writeToCSV</span> (line <span class="line-number">1083</span>)
 2207     </div> 
 2208     
 2209     <!-- ========== Info from phpDoc block ========= -->
 2210 <p class="short-description">Write to CSV file</p>
 2211     <ul class="tags">
 2212                 <li><span class="field">return:</span> true on success, false otherwise</li>
 2213                 <li><span class="field">section:</span> 5 CSV</li>
 2214                 <li><span class="field">access:</span> public</li>
 2215             </ul>
 2216     
 2217     <div class="method-signature">
 2218         <span class="method-result">bool</span>
 2219         <span class="method-name">
 2220             writeToCSV
 2221         </span>
 2222                     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span> = <span class="var-default">''</span>])
 2223             </div>
 2224     
 2225             <ul class="parameters">
 2226                     <li>
 2227                 <span class="var-type">string</span>
 2228                 <span class="var-name">$file</span><span class="var-description">: file path</span>         </li>
 2229                 </ul>
 2230         
 2231             
 2232     </div>
 2233                         
 2234         </div>
 2235     </div>
 2236 
 2237     <a name="sec-consts"></a>
 2238     <div class="info-box">
 2239         <div class="info-box-title">Class Constants</div>
 2240         <div class="nav-bar">
 2241             <a href="#sec-description">Description</a> |
 2242                                         <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
 2243                         
 2244             
 2245                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 2246                                                         | 
 2247                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 2248                             
 2249                     </div>
 2250         <div class="info-box-body">
 2251             <a name="constFREQUENCY_Disable" id="FREQUENCY_Disable"><!-- --></A>
 2252 <div class="oddrow">
 2253 
 2254     <div class="const-header">
 2255         <span class="const-title">
 2256             <span class="const-name">FREQUENCY_Disable</span>
 2257              = <span class="const-default"> 0</span>
 2258             (line <span class="line-number">61</span>)
 2259         </span>
 2260     </div>
 2261 
 2262     <!-- ========== Info from phpDoc block ========= -->
 2263 <p class="short-description">Disables frequency calculations</p>
 2264     <ul class="tags">
 2265                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetFrequency">SitemapCreator::setFrequency()</a></li>
 2266             </ul>
 2267     
 2268     
 2269 </div>
 2270 <a name="constFREQUENCY_LAST_MODIFIED" id="FREQUENCY_LAST_MODIFIED"><!-- --></A>
 2271 <div class="evenrow">
 2272 
 2273     <div class="const-header">
 2274         <span class="const-title">
 2275             <span class="const-name">FREQUENCY_LAST_MODIFIED</span>
 2276              = <span class="const-default"> 1</span>
 2277             (line <span class="line-number">67</span>)
 2278         </span>
 2279     </div>
 2280 
 2281     <!-- ========== Info from phpDoc block ========= -->
 2282 <p class="short-description">Latest modified pages get higher frequency</p>
 2283 <p class="description"><p>Default</p></p>
 2284     <ul class="tags">
 2285                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetFrequency">SitemapCreator::setFrequency()</a></li>
 2286             </ul>
 2287     
 2288     
 2289 </div>
 2290 <a name="constFREQUENCY_PRIORITY" id="FREQUENCY_PRIORITY"><!-- --></A>
 2291 <div class="oddrow">
 2292 
 2293     <div class="const-header">
 2294         <span class="const-title">
 2295             <span class="const-name">FREQUENCY_PRIORITY</span>
 2296              = <span class="const-default"> 2</span>
 2297             (line <span class="line-number">72</span>)
 2298         </span>
 2299     </div>
 2300 
 2301     <!-- ========== Info from phpDoc block ========= -->
 2302 <p class="short-description">Higher priority pages get higher frequency</p>
 2303     <ul class="tags">
 2304                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetFrequency">SitemapCreator::setFrequency()</a></li>
 2305             </ul>
 2306     
 2307     
 2308 </div>
 2309 <a name="constPRIORITY_CRAWLED_FIRST" id="PRIORITY_CRAWLED_FIRST"><!-- --></A>
 2310 <div class="evenrow">
 2311 
 2312     <div class="const-header">
 2313         <span class="const-title">
 2314             <span class="const-name">PRIORITY_CRAWLED_FIRST</span>
 2315              = <span class="const-default"> 1</span>
 2316             (line <span class="line-number">35</span>)
 2317         </span>
 2318     </div>
 2319 
 2320     <!-- ========== Info from phpDoc block ========= -->
 2321 <p class="short-description">Crawled first pages get higher priority</p>
 2322 <p class="description"><p>Default</p></p>
 2323     <ul class="tags">
 2324                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetPriority">SitemapCreator::setPriority()</a></li>
 2325             </ul>
 2326     
 2327     
 2328 </div>
 2329 <a name="constPRIORITY_Disable" id="PRIORITY_Disable"><!-- --></A>
 2330 <div class="oddrow">
 2331 
 2332     <div class="const-header">
 2333         <span class="const-title">
 2334             <span class="const-name">PRIORITY_Disable</span>
 2335              = <span class="const-default"> 0</span>
 2336             (line <span class="line-number">29</span>)
 2337         </span>
 2338     </div>
 2339 
 2340     <!-- ========== Info from phpDoc block ========= -->
 2341 <p class="short-description">Disables priority calculations</p>
 2342     <ul class="tags">
 2343                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetPriority">SitemapCreator::setPriority()</a></li>
 2344             </ul>
 2345     
 2346     
 2347 </div>
 2348 <a name="constPRIORITY_URL_STRUCTURE" id="PRIORITY_URL_STRUCTURE"><!-- --></A>
 2349 <div class="evenrow">
 2350 
 2351     <div class="const-header">
 2352         <span class="const-title">
 2353             <span class="const-name">PRIORITY_URL_STRUCTURE</span>
 2354              = <span class="const-default"> 2</span>
 2355             (line <span class="line-number">40</span>)
 2356         </span>
 2357     </div>
 2358 
 2359     <!-- ========== Info from phpDoc block ========= -->
 2360 <p class="short-description">Deeper pathes get lower priority</p>
 2361     <ul class="tags">
 2362                 <li><span class="field">see:</span> <a href="../SitemapCreator/SitemapCreator.html#methodsetPriority">SitemapCreator::setPriority()</a></li>
 2363             </ul>
 2364     
 2365     
 2366 </div>
 2367                         
 2368         </div>
 2369     </div>
 2370 
 2371     <p class="notes" id="credit">
 2372         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>
 2373     </p>
 2374     </div></body>
 2375 </html>