"Fossies" - the Fresh Open Source Software Archive

Member "docs/elementindex_SitemapCreator.html" (20 Jan 2013, 34898 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></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                         <a name="top"></a>
   12 <h2>[SitemapCreator] element index</h2>
   13     <h3>Package indexes</h3>
   14     <ul>
   15                         <li><a href="elementindex_phpcrawl.html">phpcrawl</a></li>
   16                     <li><a href="elementindex_phpcrawl-enums.html">phpcrawl-enums</a></li>
   17             </ul>
   18 <a href="elementindex.html">All elements</a>
   19 <br />
   20 <div class="index-letter-menu">
   21     <a class="index-letter" href="elementindex_SitemapCreator.html#a">a</a>
   22     <a class="index-letter" href="elementindex_SitemapCreator.html#c">c</a>
   23     <a class="index-letter" href="elementindex_SitemapCreator.html#d">d</a>
   24     <a class="index-letter" href="elementindex_SitemapCreator.html#e">e</a>
   25     <a class="index-letter" href="elementindex_SitemapCreator.html#f">f</a>
   26     <a class="index-letter" href="elementindex_SitemapCreator.html#g">g</a>
   27     <a class="index-letter" href="elementindex_SitemapCreator.html#i">i</a>
   28     <a class="index-letter" href="elementindex_SitemapCreator.html#m">m</a>
   29     <a class="index-letter" href="elementindex_SitemapCreator.html#n">n</a>
   30     <a class="index-letter" href="elementindex_SitemapCreator.html#o">o</a>
   31     <a class="index-letter" href="elementindex_SitemapCreator.html#p">p</a>
   32     <a class="index-letter" href="elementindex_SitemapCreator.html#r">r</a>
   33     <a class="index-letter" href="elementindex_SitemapCreator.html#s">s</a>
   34     <a class="index-letter" href="elementindex_SitemapCreator.html#u">u</a>
   35     <a class="index-letter" href="elementindex_SitemapCreator.html#v">v</a>
   36     <a class="index-letter" href="elementindex_SitemapCreator.html#w">w</a>
   37     <a class="index-letter" href="elementindex_SitemapCreator.html#x">x</a>
   38     <a class="index-letter" href="elementindex_SitemapCreator.html#_">_</a>
   39 </div>
   40 
   41     <a name="_"></a>
   42     <div class="index-letter-section">
   43         <div style="float: left" class="index-letter-title">_</div>
   44         <div style="float: right"><a href="#top">top</a></div>
   45         <div style="clear: both"></div>
   46     </div>
   47     <dl>
   48             <dt class="field">
   49                         <span class="method-title">__construct</span>
   50                     </dt>
   51         <dd class="index-item-body">
   52             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#method__construct">SitemapCreator::__construct()</a> in SitemapCreator.class.php</div>
   53                             <div class="index-item-description">Initiates a new Sitemap.</div>
   54                     </dd>
   55         </dl>
   56     <a name="a"></a>
   57     <div class="index-letter-section">
   58         <div style="float: left" class="index-letter-title">a</div>
   59         <div style="float: right"><a href="#top">top</a></div>
   60         <div style="clear: both"></div>
   61     </div>
   62     <dl>
   63             <dt class="field">
   64                         <span class="method-title">addEngine</span>
   65                     </dt>
   66         <dd class="index-item-body">
   67             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddEngine">SitemapCreator::addEngine()</a> in SitemapCreator.class.php</div>
   68                             <div class="index-item-description">add a ping URL to the array $engines</div>
   69                     </dd>
   70             <dt class="field">
   71                         <span class="method-title">addEntry</span>
   72                     </dt>
   73         <dd class="index-item-body">
   74             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddEntry">SitemapCreator::addEntry()</a> in SitemapCreator.class.php</div>
   75                             <div class="index-item-description">add URL entry manually to <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
   76                     </dd>
   77             <dt class="field">
   78                         <span class="method-title">addSitemapEXT</span>
   79                     </dt>
   80         <dd class="index-item-body">
   81             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddSitemapEXT">SitemapCreator::addSitemapEXT()</a> in SitemapCreator.class.php</div>
   82                             <div class="index-item-description">adds sitemap gzip extension to sitemap filename if $use_gzip enabled</div>
   83                     </dd>
   84             <dt class="field">
   85                         <span class="method-title">addToRobots</span>
   86                     </dt>
   87         <dd class="index-item-body">
   88             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddToRobots">SitemapCreator::addToRobots()</a> in SitemapCreator.class.php</div>
   89                             <div class="index-item-description">Add index sitemap URL to robots.txt file</div>
   90                     </dd>
   91             <dt class="field">
   92                         <span class="method-title">addXMLURLSet</span>
   93                     </dt>
   94         <dd class="index-item-body">
   95             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodaddXMLURLSet">SitemapCreator::addXMLURLSet()</a> in SitemapCreator.class.php</div>
   96                             <div class="index-item-description">Add single XML code to $xml_url_set</div>
   97                     </dd>
   98         </dl>
   99     <a name="c"></a>
  100     <div class="index-letter-section">
  101         <div style="float: left" class="index-letter-title">c</div>
  102         <div style="float: right"><a href="#top">top</a></div>
  103         <div style="clear: both"></div>
  104     </div>
  105     <dl>
  106             <dt class="field">
  107                         <span class="var-title">$classpath</span>
  108                     </dt>
  109         <dd class="index-item-body">
  110             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$classpath">SitemapCreator::$classpath</a> in SitemapCreator.class.php</div>
  111                     </dd>
  112             <dt class="field">
  113                         <span class="var-title">$class_version</span>
  114                     </dt>
  115         <dd class="index-item-body">
  116             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$class_version">SitemapCreator::$class_version</a> in SitemapCreator.class.php</div>
  117                     </dd>
  118             <dt class="field">
  119                         <span class="var-title">$Crawler</span>
  120                     </dt>
  121         <dd class="index-item-body">
  122             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$Crawler">SitemapCreator::$Crawler</a> in SitemapCreator.class.php</div>
  123                     </dd>
  124             <dt class="field">
  125                         <span class="var-title">$crawler_reports</span>
  126                     </dt>
  127         <dd class="index-item-body">
  128             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$crawler_reports">SitemapCreator::$crawler_reports</a> in SitemapCreator.class.php</div>
  129                     </dd>
  130             <dt class="field">
  131                         <span class="method-title">calcFrequency</span>
  132                     </dt>
  133         <dd class="index-item-body">
  134             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodcalcFrequency">SitemapCreator::calcFrequency()</a> in SitemapCreator.class.php</div>
  135                             <div class="index-item-description">calculates Frequency for each entry $priority_mode</div>
  136                     </dd>
  137             <dt class="field">
  138                         <span class="method-title">calcPriority</span>
  139                     </dt>
  140         <dd class="index-item-body">
  141             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodcalcPriority">SitemapCreator::calcPriority()</a> in SitemapCreator.class.php</div>
  142                             <div class="index-item-description">calculates Priority for each entry $priority_mode</div>
  143                     </dd>
  144             <dt class="field">
  145                         <span class="method-title">Crawl</span>
  146                     </dt>
  147         <dd class="index-item-body">
  148             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodCrawl">SitemapCreator::Crawl()</a> in SitemapCreator.class.php</div>
  149                             <div class="index-item-description">Start the crawl process</div>
  150                     </dd>
  151             <dt class="field">
  152                         <span class="method-title">CreateSitemaps</span>
  153                     </dt>
  154         <dd class="index-item-body">
  155             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodCreateSitemaps">SitemapCreator::CreateSitemaps()</a> in SitemapCreator.class.php</div>
  156                             <div class="index-item-description">Create sitemaps files and index</div>
  157                     </dd>
  158             <dt class="field">
  159                         <span class="method-title">csvFile</span>
  160                     </dt>
  161         <dd class="index-item-body">
  162             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodcsvFile">SitemapCreator::csvFile()</a> in SitemapCreator.class.php</div>
  163                             <div class="index-item-description">get CSV file path</div>
  164                     </dd>
  165         </dl>
  166     <a name="d"></a>
  167     <div class="index-letter-section">
  168         <div style="float: left" class="index-letter-title">d</div>
  169         <div style="float: right"><a href="#top">top</a></div>
  170         <div style="clear: both"></div>
  171     </div>
  172     <dl>
  173             <dt class="field">
  174                         <span class="var-title">$data_dir</span>
  175                     </dt>
  176         <dd class="index-item-body">
  177             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$data_dir">SitemapCreator::$data_dir</a> in SitemapCreator.class.php</div>
  178                             <div class="index-item-description">Data directory Path.</div>
  179                     </dd>
  180         </dl>
  181     <a name="e"></a>
  182     <div class="index-letter-section">
  183         <div style="float: left" class="index-letter-title">e</div>
  184         <div style="float: right"><a href="#top">top</a></div>
  185         <div style="clear: both"></div>
  186     </div>
  187     <dl>
  188             <dt class="field">
  189                         <span class="var-title">$engines</span>
  190                     </dt>
  191         <dd class="index-item-body">
  192             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$engines">SitemapCreator::$engines</a> in SitemapCreator.class.php</div>
  193                             <div class="index-item-description">Ping URLs of the search engines sitemaps API</div>
  194                     </dd>
  195             <dt class="field">
  196                         <span class="var-title">$entries</span>
  197                     </dt>
  198         <dd class="index-item-body">
  199             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$entries">SitemapCreator::$entries</a> in SitemapCreator.class.php</div>
  200                             <div class="index-item-description">Array contianing the entries of the sitemap.</div>
  201                     </dd>
  202             <dt class="field">
  203                         <span class="var-title">$entries_per_sitemap</span>
  204                     </dt>
  205         <dd class="index-item-body">
  206             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$entries_per_sitemap">SitemapCreator::$entries_per_sitemap</a> in SitemapCreator.class.php</div>
  207                             <div class="index-item-description">Maximum number of entries per sitemap file</div>
  208                     </dd>
  209             <dt class="field">
  210                         <span class="include-title">example.php</span>
  211                     </dt>
  212         <dd class="index-item-body">
  213             <div class="index-item-details"><a href="SitemapCreator/_example---example.php.html">example.php</a> in example.php</div>
  214                     </dd>
  215         </dl>
  216     <a name="f"></a>
  217     <div class="index-letter-section">
  218         <div style="float: left" class="index-letter-title">f</div>
  219         <div style="float: right"><a href="#top">top</a></div>
  220         <div style="clear: both"></div>
  221     </div>
  222     <dl>
  223             <dt class="field">
  224                         <span class="var-title">$frequency_mode</span>
  225                     </dt>
  226         <dd class="index-item-body">
  227             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$frequency_mode">SitemapCreator::$frequency_mode</a> in SitemapCreator.class.php</div>
  228                             <div class="index-item-description">Frequency mode</div>
  229                     </dd>
  230             <dt class="field">
  231                         <span class="var-title">$frequency_types</span>
  232                     </dt>
  233         <dd class="index-item-body">
  234             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$frequency_types">SitemapCreator::$frequency_types</a> in SitemapCreator.class.php</div>
  235                             <div class="index-item-description">Array contains Frequency types as keys and max time in seconds as values.</div>
  236                     </dd>
  237             <dt class="field">
  238                         FREQUENCY_Disable
  239                     </dt>
  240         <dd class="index-item-body">
  241             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constFREQUENCY_Disable">SitemapCreator::FREQUENCY_Disable</a> in SitemapCreator.class.php</div>
  242                             <div class="index-item-description">Disables frequency calculations</div>
  243                     </dd>
  244             <dt class="field">
  245                         FREQUENCY_LAST_MODIFIED
  246                     </dt>
  247         <dd class="index-item-body">
  248             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constFREQUENCY_LAST_MODIFIED">SitemapCreator::FREQUENCY_LAST_MODIFIED</a> in SitemapCreator.class.php</div>
  249                             <div class="index-item-description">Latest modified pages get higher frequency</div>
  250                     </dd>
  251             <dt class="field">
  252                         FREQUENCY_PRIORITY
  253                     </dt>
  254         <dd class="index-item-body">
  255             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constFREQUENCY_PRIORITY">SitemapCreator::FREQUENCY_PRIORITY</a> in SitemapCreator.class.php</div>
  256                             <div class="index-item-description">Higher priority pages get higher frequency</div>
  257                     </dd>
  258         </dl>
  259     <a name="g"></a>
  260     <div class="index-letter-section">
  261         <div style="float: left" class="index-letter-title">g</div>
  262         <div style="float: right"><a href="#top">top</a></div>
  263         <div style="clear: both"></div>
  264     </div>
  265     <dl>
  266             <dt class="field">
  267                         <span class="method-title">getDataDir</span>
  268                     </dt>
  269         <dd class="index-item-body">
  270             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetDataDir">SitemapCreator::getDataDir()</a> in SitemapCreator.class.php</div>
  271                             <div class="index-item-description">Get data directory path $data_dir</div>
  272                     </dd>
  273             <dt class="field">
  274                         <span class="method-title">getEntries</span>
  275                     </dt>
  276         <dd class="index-item-body">
  277             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetEntries">SitemapCreator::getEntries()</a> in SitemapCreator.class.php</div>
  278                             <div class="index-item-description">Get URLs sets array <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
  279                     </dd>
  280             <dt class="field">
  281                         <span class="method-title">getSitemapDirName</span>
  282                     </dt>
  283         <dd class="index-item-body">
  284             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapDirName">SitemapCreator::getSitemapDirName()</a> in SitemapCreator.class.php</div>
  285                             <div class="index-item-description">Get sitemap directory name</div>
  286                     </dd>
  287             <dt class="field">
  288                         <span class="method-title">getSitemapPath</span>
  289                     </dt>
  290         <dd class="index-item-body">
  291             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapPath">SitemapCreator::getSitemapPath()</a> in SitemapCreator.class.php</div>
  292                             <div class="index-item-description">Get sitemap file path</div>
  293                     </dd>
  294             <dt class="field">
  295                         <span class="method-title">getSitemapsDir</span>
  296                     </dt>
  297         <dd class="index-item-body">
  298             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapsDir">SitemapCreator::getSitemapsDir()</a> in SitemapCreator.class.php</div>
  299                             <div class="index-item-description">Get sitemap directory path $sitemaps_dir</div>
  300                     </dd>
  301             <dt class="field">
  302                         <span class="method-title">getSitemapURL</span>
  303                     </dt>
  304         <dd class="index-item-body">
  305             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodgetSitemapURL">SitemapCreator::getSitemapURL()</a> in SitemapCreator.class.php</div>
  306                             <div class="index-item-description">Get sitemap file URL</div>
  307                     </dd>
  308         </dl>
  309     <a name="i"></a>
  310     <div class="index-letter-section">
  311         <div style="float: left" class="index-letter-title">i</div>
  312         <div style="float: right"><a href="#top">top</a></div>
  313         <div style="clear: both"></div>
  314     </div>
  315     <dl>
  316             <dt class="field">
  317                         <span class="method-title">initCrawler</span>
  318                     </dt>
  319         <dd class="index-item-body">
  320             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodinitCrawler">SitemapCreator::initCrawler()</a> in SitemapCreator.class.php</div>
  321                             <div class="index-item-description">Initiate the crawler $Crawler</div>
  322                     </dd>
  323             <dt class="field">
  324                         <span class="method-title">isDataDirWritable</span>
  325                     </dt>
  326         <dd class="index-item-body">
  327             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodisDataDirWritable">SitemapCreator::isDataDirWritable()</a> in SitemapCreator.class.php</div>
  328                             <div class="index-item-description">Check if data directory is writable $data_dir</div>
  329                     </dd>
  330         </dl>
  331     <a name="m"></a>
  332     <div class="index-letter-section">
  333         <div style="float: left" class="index-letter-title">m</div>
  334         <div style="float: right"><a href="#top">top</a></div>
  335         <div style="clear: both"></div>
  336     </div>
  337     <dl>
  338             <dt class="field">
  339                         <span class="var-title">$min_frequency</span>
  340                     </dt>
  341         <dd class="index-item-body">
  342             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$min_frequency">SitemapCreator::$min_frequency</a> in SitemapCreator.class.php</div>
  343                             <div class="index-item-description">Minimum Priority</div>
  344                     </dd>
  345             <dt class="field">
  346                         <span class="var-title">$min_priority</span>
  347                     </dt>
  348         <dd class="index-item-body">
  349             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$min_priority">SitemapCreator::$min_priority</a> in SitemapCreator.class.php</div>
  350                             <div class="index-item-description">Minimum Priority</div>
  351                     </dd>
  352         </dl>
  353     <a name="n"></a>
  354     <div class="index-letter-section">
  355         <div style="float: left" class="index-letter-title">n</div>
  356         <div style="float: right"><a href="#top">top</a></div>
  357         <div style="clear: both"></div>
  358     </div>
  359     <dl>
  360             <dt class="field">
  361                         <span class="var-title">$now</span>
  362                     </dt>
  363         <dd class="index-item-body">
  364             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$now">SitemapCreator::$now</a> in SitemapCreator.class.php</div>
  365                             <div class="index-item-description">Current time().</div>
  366                     </dd>
  367         </dl>
  368     <a name="o"></a>
  369     <div class="index-letter-section">
  370         <div style="float: left" class="index-letter-title">o</div>
  371         <div style="float: right"><a href="#top">top</a></div>
  372         <div style="clear: both"></div>
  373     </div>
  374     <dl>
  375             <dt class="field">
  376                         <span class="method-title">openURL</span>
  377                     </dt>
  378         <dd class="index-item-body">
  379             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodopenURL">SitemapCreator::openURL()</a> in SitemapCreator.class.php</div>
  380                             <div class="index-item-description">Open URL and get respond body or error</div>
  381                     </dd>
  382         </dl>
  383     <a name="p"></a>
  384     <div class="index-letter-section">
  385         <div style="float: left" class="index-letter-title">p</div>
  386         <div style="float: right"><a href="#top">top</a></div>
  387         <div style="clear: both"></div>
  388     </div>
  389     <dl>
  390             <dt class="field">
  391                         <span class="var-title">$priority_mode</span>
  392                     </dt>
  393         <dd class="index-item-body">
  394             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$priority_mode">SitemapCreator::$priority_mode</a> in SitemapCreator.class.php</div>
  395                             <div class="index-item-description">Priority mode</div>
  396                     </dd>
  397             <dt class="field">
  398                         <span class="method-title">ping</span>
  399                     </dt>
  400         <dd class="index-item-body">
  401             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodping">SitemapCreator::ping()</a> in SitemapCreator.class.php</div>
  402                             <div class="index-item-description">Ping search engines</div>
  403                     </dd>
  404             <dt class="field">
  405                         <span class="method-title">prepareSitemapsDir</span>
  406                     </dt>
  407         <dd class="index-item-body">
  408             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodprepareSitemapsDir">SitemapCreator::prepareSitemapsDir()</a> in SitemapCreator.class.php</div>
  409                             <div class="index-item-description">Creates sitemaps directory $sitemaps_dir</div>
  410                     </dd>
  411             <dt class="field">
  412                         PRIORITY_CRAWLED_FIRST
  413                     </dt>
  414         <dd class="index-item-body">
  415             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constPRIORITY_CRAWLED_FIRST">SitemapCreator::PRIORITY_CRAWLED_FIRST</a> in SitemapCreator.class.php</div>
  416                             <div class="index-item-description">Crawled first pages get higher priority</div>
  417                     </dd>
  418             <dt class="field">
  419                         PRIORITY_Disable
  420                     </dt>
  421         <dd class="index-item-body">
  422             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constPRIORITY_Disable">SitemapCreator::PRIORITY_Disable</a> in SitemapCreator.class.php</div>
  423                             <div class="index-item-description">Disables priority calculations</div>
  424                     </dd>
  425             <dt class="field">
  426                         PRIORITY_URL_STRUCTURE
  427                     </dt>
  428         <dd class="index-item-body">
  429             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#constPRIORITY_URL_STRUCTURE">SitemapCreator::PRIORITY_URL_STRUCTURE</a> in SitemapCreator.class.php</div>
  430                             <div class="index-item-description">Deeper pathes get lower priority</div>
  431                     </dd>
  432             <dt class="field">
  433                         <span class="method-title">putContent</span>
  434                     </dt>
  435         <dd class="index-item-body">
  436             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodputContent">SitemapCreator::putContent()</a> in SitemapCreator.class.php</div>
  437                             <div class="index-item-description">Write XML to disk</div>
  438                     </dd>
  439         </dl>
  440     <a name="r"></a>
  441     <div class="index-letter-section">
  442         <div style="float: left" class="index-letter-title">r</div>
  443         <div style="float: right"><a href="#top">top</a></div>
  444         <div style="clear: both"></div>
  445     </div>
  446     <dl>
  447             <dt class="field">
  448                         <span class="method-title">readFromCSV</span>
  449                     </dt>
  450         <dd class="index-item-body">
  451             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodreadFromCSV">SitemapCreator::readFromCSV()</a> in SitemapCreator.class.php</div>
  452                             <div class="index-item-description">Read from CSV file and add to <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
  453                     </dd>
  454             <dt class="field">
  455                         <span class="method-title">readSitemap</span>
  456                     </dt>
  457         <dd class="index-item-body">
  458             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodreadSitemap">SitemapCreator::readSitemap()</a> in SitemapCreator.class.php</div>
  459                             <div class="index-item-description">Read sitemap file from disk</div>
  460                     </dd>
  461             <dt class="field">
  462                         <span class="method-title">removeSitemaps</span>
  463                     </dt>
  464         <dd class="index-item-body">
  465             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodremoveSitemaps">SitemapCreator::removeSitemaps()</a> in SitemapCreator.class.php</div>
  466                             <div class="index-item-description">Delete all sitemap dir and files</div>
  467                     </dd>
  468         </dl>
  469     <a name="s"></a>
  470     <div class="index-letter-section">
  471         <div style="float: left" class="index-letter-title">s</div>
  472         <div style="float: right"><a href="#top">top</a></div>
  473         <div style="clear: both"></div>
  474     </div>
  475     <dl>
  476             <dt class="field">
  477                         <span class="var-title">$site</span>
  478                     </dt>
  479         <dd class="index-item-body">
  480             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$site">SitemapCreator::$site</a> in SitemapCreator.class.php</div>
  481                             <div class="index-item-description">The URL of the website.It should be full qualified and normalized.</div>
  482                     </dd>
  483             <dt class="field">
  484                         <span class="var-title">$sitemaps_count</span>
  485                     </dt>
  486         <dd class="index-item-body">
  487             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$sitemaps_count">SitemapCreator::$sitemaps_count</a> in SitemapCreator.class.php</div>
  488                             <div class="index-item-description">Number of sitemap files created</div>
  489                     </dd>
  490             <dt class="field">
  491                         <span class="var-title">$sitemaps_dir</span>
  492                     </dt>
  493         <dd class="index-item-body">
  494             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$sitemaps_dir">SitemapCreator::$sitemaps_dir</a> in SitemapCreator.class.php</div>
  495                             <div class="index-item-description">Sitemaps directory path auto created in prepareSitemapsDir()</div>
  496                     </dd>
  497             <dt class="field">
  498                         <span class="var-title">$sitemaps_url</span>
  499                     </dt>
  500         <dd class="index-item-body">
  501             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$sitemaps_url">SitemapCreator::$sitemaps_url</a> in SitemapCreator.class.php</div>
  502                             <div class="index-item-description">Sitemap URL where the sitemap file name will be appended to the end of the URL.</div>
  503                     </dd>
  504             <dt class="field">
  505                         <span class="method-title">setCrawlerDefaults</span>
  506                     </dt>
  507         <dd class="index-item-body">
  508             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetCrawlerDefaults">SitemapCreator::setCrawlerDefaults()</a> in SitemapCreator.class.php</div>
  509                             <div class="index-item-description">Load default crawler settings for $Crawler</div>
  510                     </dd>
  511             <dt class="field">
  512                         <span class="method-title">setDataDir</span>
  513                     </dt>
  514         <dd class="index-item-body">
  515             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetDataDir">SitemapCreator::setDataDir()</a> in SitemapCreator.class.php</div>
  516                             <div class="index-item-description">Sets the data directory path of the sitemaps $data_dir</div>
  517                     </dd>
  518             <dt class="field">
  519                         <span class="method-title">setEntries</span>
  520                     </dt>
  521         <dd class="index-item-body">
  522             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetEntries">SitemapCreator::setEntries()</a> in SitemapCreator.class.php</div>
  523                             <div class="index-item-description">Set the URLs sets manually <a href="phpcrawl/SMCCrawler.html#var$entries">$entries</a></div>
  524                     </dd>
  525             <dt class="field">
  526                         <span class="method-title">setEntriesPerSitemap</span>
  527                     </dt>
  528         <dd class="index-item-body">
  529             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetEntriesPerSitemap">SitemapCreator::setEntriesPerSitemap()</a> in SitemapCreator.class.php</div>
  530                             <div class="index-item-description">Sets number of URLs set for each sitemap file $entries_per_sitemap</div>
  531                     </dd>
  532             <dt class="field">
  533                         <span class="method-title">setFrequency</span>
  534                     </dt>
  535         <dd class="index-item-body">
  536             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetFrequency">SitemapCreator::setFrequency()</a> in SitemapCreator.class.php</div>
  537                             <div class="index-item-description">Set Frequency mode $frequency_mode</div>
  538                     </dd>
  539             <dt class="field">
  540                         <span class="method-title">setMinFrequency</span>
  541                     </dt>
  542         <dd class="index-item-body">
  543             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetMinFrequency">SitemapCreator::setMinFrequency()</a> in SitemapCreator.class.php</div>
  544                             <div class="index-item-description">Set minimum Frequency value for all URLs $min_priority</div>
  545                     </dd>
  546             <dt class="field">
  547                         <span class="method-title">setMinPriority</span>
  548                     </dt>
  549         <dd class="index-item-body">
  550             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetMinPriority">SitemapCreator::setMinPriority()</a> in SitemapCreator.class.php</div>
  551                             <div class="index-item-description">Set minimum Priority value for all URLs $min_priority</div>
  552                     </dd>
  553             <dt class="field">
  554                         <span class="method-title">setPriority</span>
  555                     </dt>
  556         <dd class="index-item-body">
  557             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetPriority">SitemapCreator::setPriority()</a> in SitemapCreator.class.php</div>
  558                             <div class="index-item-description">Set Priority mode $priority_mode</div>
  559                     </dd>
  560             <dt class="field">
  561                         <span class="method-title">setSite</span>
  562                     </dt>
  563         <dd class="index-item-body">
  564             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetSite">SitemapCreator::setSite()</a> in SitemapCreator.class.php</div>
  565                             <div class="index-item-description">Sets the URL of the website $site</div>
  566                     </dd>
  567             <dt class="field">
  568                         <span class="method-title">setSitemapURL</span>
  569                     </dt>
  570         <dd class="index-item-body">
  571             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodsetSitemapURL">SitemapCreator::setSitemapURL()</a> in SitemapCreator.class.php</div>
  572                             <div class="index-item-description">Sets the URL of the sitemap files $sitemaps_url</div>
  573                     </dd>
  574             <dt class="field">
  575                         SitemapCreator
  576                     </dt>
  577         <dd class="index-item-body">
  578             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html">SitemapCreator</a> in SitemapCreator.class.php</div>
  579                             <div class="index-item-description">Sitemap Creator creates XML sitemaps files compatible with the standard  sitemaps.org protocol and supported by Google and Bing.</div>
  580                     </dd>
  581             <dt class="field">
  582                         <span class="include-title">SitemapCreator.class.php</span>
  583                     </dt>
  584         <dd class="index-item-body">
  585             <div class="index-item-details"><a href="SitemapCreator/_SitemapCreator.class.php.html">SitemapCreator.class.php</a> in SitemapCreator.class.php</div>
  586                     </dd>
  587             <dt class="field">
  588                         <span class="include-title">SitemapCreatorCrawler.class.php</span>
  589                     </dt>
  590         <dd class="index-item-body">
  591             <div class="index-item-details"><a href="SitemapCreator/_SitemapCreatorCrawler.class.php.html">SitemapCreatorCrawler.class.php</a> in SitemapCreatorCrawler.class.php</div>
  592                     </dd>
  593         </dl>
  594     <a name="u"></a>
  595     <div class="index-letter-section">
  596         <div style="float: left" class="index-letter-title">u</div>
  597         <div style="float: right"><a href="#top">top</a></div>
  598         <div style="clear: both"></div>
  599     </div>
  600     <dl>
  601             <dt class="field">
  602                         <span class="var-title">$useragent</span>
  603                     </dt>
  604         <dd class="index-item-body">
  605             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$useragent">SitemapCreator::$useragent</a> in SitemapCreator.class.php</div>
  606                     </dd>
  607             <dt class="field">
  608                         <span class="var-title">$use_gzip</span>
  609                     </dt>
  610         <dd class="index-item-body">
  611             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$use_gzip">SitemapCreator::$use_gzip</a> in SitemapCreator.class.php</div>
  612                             <div class="index-item-description">choose to save sitemaps in gzip format</div>
  613                     </dd>
  614             <dt class="field">
  615                         <span class="method-title">useGzip</span>
  616                     </dt>
  617         <dd class="index-item-body">
  618             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methoduseGzip">SitemapCreator::useGzip()</a> in SitemapCreator.class.php</div>
  619                             <div class="index-item-description">Use gzip compressed sitemaps files $use_gzip</div>
  620                     </dd>
  621         </dl>
  622     <a name="v"></a>
  623     <div class="index-letter-section">
  624         <div style="float: left" class="index-letter-title">v</div>
  625         <div style="float: right"><a href="#top">top</a></div>
  626         <div style="clear: both"></div>
  627     </div>
  628     <dl>
  629             <dt class="field">
  630                         <span class="method-title">validSitemapName</span>
  631                     </dt>
  632         <dd class="index-item-body">
  633             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodvalidSitemapName">SitemapCreator::validSitemapName()</a> in SitemapCreator.class.php</div>
  634                             <div class="index-item-description">Validates sitemap filename</div>
  635                     </dd>
  636         </dl>
  637     <a name="w"></a>
  638     <div class="index-letter-section">
  639         <div style="float: left" class="index-letter-title">w</div>
  640         <div style="float: right"><a href="#top">top</a></div>
  641         <div style="clear: both"></div>
  642     </div>
  643     <dl>
  644             <dt class="field">
  645                         <span class="method-title">writeIndex</span>
  646                     </dt>
  647         <dd class="index-item-body">
  648             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodwriteIndex">SitemapCreator::writeIndex()</a> in SitemapCreator.class.php</div>
  649                             <div class="index-item-description">Write sitemap index file</div>
  650                     </dd>
  651             <dt class="field">
  652                         <span class="method-title">writeSitemap</span>
  653                     </dt>
  654         <dd class="index-item-body">
  655             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodwriteSitemap">SitemapCreator::writeSitemap()</a> in SitemapCreator.class.php</div>
  656                             <div class="index-item-description">Write sitemap file</div>
  657                     </dd>
  658             <dt class="field">
  659                         <span class="method-title">writeToCSV</span>
  660                     </dt>
  661         <dd class="index-item-body">
  662             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#methodwriteToCSV">SitemapCreator::writeToCSV()</a> in SitemapCreator.class.php</div>
  663                             <div class="index-item-description">Write to CSV file</div>
  664                     </dd>
  665         </dl>
  666     <a name="x"></a>
  667     <div class="index-letter-section">
  668         <div style="float: left" class="index-letter-title">x</div>
  669         <div style="float: right"><a href="#top">top</a></div>
  670         <div style="clear: both"></div>
  671     </div>
  672     <dl>
  673             <dt class="field">
  674                         <span class="var-title">$xml_foot</span>
  675                     </dt>
  676         <dd class="index-item-body">
  677             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$xml_foot">SitemapCreator::$xml_foot</a> in SitemapCreator.class.php</div>
  678                     </dd>
  679             <dt class="field">
  680                         <span class="var-title">$xml_head</span>
  681                     </dt>
  682         <dd class="index-item-body">
  683             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$xml_head">SitemapCreator::$xml_head</a> in SitemapCreator.class.php</div>
  684                     </dd>
  685             <dt class="field">
  686                         <span class="var-title">$xml_url_set</span>
  687                     </dt>
  688         <dd class="index-item-body">
  689             <div class="index-item-details"><a href="SitemapCreator/SitemapCreator.html#var$xml_url_set">SitemapCreator::$xml_url_set</a> in SitemapCreator.class.php</div>
  690                             <div class="index-item-description">XML string containing sitemap &lt;urlset&gt;&lt;/urlset&gt; elements</div>
  691                     </dd>
  692         </dl>
  693 
  694 <div class="index-letter-menu">
  695     <a class="index-letter" href="elementindex_SitemapCreator.html#a">a</a>
  696     <a class="index-letter" href="elementindex_SitemapCreator.html#c">c</a>
  697     <a class="index-letter" href="elementindex_SitemapCreator.html#d">d</a>
  698     <a class="index-letter" href="elementindex_SitemapCreator.html#e">e</a>
  699     <a class="index-letter" href="elementindex_SitemapCreator.html#f">f</a>
  700     <a class="index-letter" href="elementindex_SitemapCreator.html#g">g</a>
  701     <a class="index-letter" href="elementindex_SitemapCreator.html#i">i</a>
  702     <a class="index-letter" href="elementindex_SitemapCreator.html#m">m</a>
  703     <a class="index-letter" href="elementindex_SitemapCreator.html#n">n</a>
  704     <a class="index-letter" href="elementindex_SitemapCreator.html#o">o</a>
  705     <a class="index-letter" href="elementindex_SitemapCreator.html#p">p</a>
  706     <a class="index-letter" href="elementindex_SitemapCreator.html#r">r</a>
  707     <a class="index-letter" href="elementindex_SitemapCreator.html#s">s</a>
  708     <a class="index-letter" href="elementindex_SitemapCreator.html#u">u</a>
  709     <a class="index-letter" href="elementindex_SitemapCreator.html#v">v</a>
  710     <a class="index-letter" href="elementindex_SitemapCreator.html#w">w</a>
  711     <a class="index-letter" href="elementindex_SitemapCreator.html#x">x</a>
  712     <a class="index-letter" href="elementindex_SitemapCreator.html#_">_</a>
  713 </div>  </body>
  714 </html>