Sitemap Class

This class allows you to easily create a sitemap that adheres to the standards set forth by Google, Yahoo! and Bing. I used the following resources to create the ultimate Sitemap class:

This class will:

Automatically gzip all of your sitemaps (if desired)
Create (and update) a sitemap index file
Allow you to separate your urls into different files
Limit the number of urls in each file to 50,000
Properly escape and format all of the required and optional fields
Ping the search engines when your sitemap(s) have been updated

I like to create a sitemap (.php) page that only updates the urls I tell it to, and then this class takes care of the rest.

<?php�
�
require_once ('php/classes/Sitemap.php');�
�
$sitemap = new Sitemap;�
�
if (get('pages')) {�
  $sitemap->page('pages');�
  $result = db_query ("SELECT url, created FROM pages"); // 20 pages�
  while (list($url, $created) = $result->fetch_row()) {�
    $sitemap->url($url, $created, 'yearly');�
  }�
}�
  �
if (get('posts')) {�
  $sitemap->page('posts');�
  $result = db_query ("SELECT url, updated FROM posts"); // 70,000 posts�
  while (list($url, $updated) = $result->fetch_row()) {�
    $sitemap->url($url, $updated, 'monthly');�
  }�
}�
�
$sitemap->close();�
unset ($sitemap);�
�
function get ($name) {�
  return (isset($_GET['update']) && strpos($_GET['update'], $name) !== false) ? true : false;�
}�
�
?>

If you call the 'sitemap.php?update=pages-posts' then the following files would be created at your BASE_URL:

sitemap-index.xml.gz
sitemap-pages-1.xml.gz
sitemap-posts-1.xml.gz
sitemap-posts-2.xml.gz

If you call 'sitemap.php?update=posts', then only the sitemap-posts-1 and 2.xml.gz files will be recreated, the sitemap-index.xml.gz will be updated, and the search engines will be pinged to notify them of any changes.

object Sitemap ( [ bool $compress= true ] )

This is the constructor for the class, and it creates a sitemap object.

$compress	If true (the default), then all of your sitemaps will be gzipped. Set to false if you just want the uncompressed xml.
Example	$sitemap = new Sitemap;

page ( string $name )

This will start a new sitemap page of url's to keep them separate, if desired. If you never call this method then every url will be put into sitemap-index-1,2,3,4....xml.gz.

$name	Start putting these url's into "sitemap-{$name}-1.xml.gz"
Example	$sitemap->page('posts');

url ( string $url [, string $lastmod [, string $changefreq [, float $priority ]]] )

This method creates the guts of your sitemap(s). The url is required, and all other paramenters are optional.

$url	The relative url you would like indexed. eg. 'path/to/page.html'
$lastmod	A [strtotime() parsable] date. The last time this url was updated or modified. All dates will be converted to 'Y-m-d' format within the class.
$changefreq	How often you expect this url may change. Valid values are 'always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly', and 'never'
$priority	Between 0 and 1. The relative priority that this url has within your site.
Example	$sitemap->url('example/page.php', 'now', 'weekly', .6);

close ( )

Finishes saving your last page of urls, then pings the search engines. If you get lazy and forget (or just don't) call this method, then the class destructor will finish your thoght, but the search engines will not be pinged.

Example

$sitemap->close(); �
unset($sitemap);

�Subscribe to our feed

Sitemap.php

<?php�
�
/*�
 *    author:		Kyle Gadd�
 *    documentation:	http://www.php-ease.com/classes/sitemap.html�
 *�
 *    This program is free software: you can redistribute it and/or modify�
 *    it under the terms of the GNU General Public License as published by�
 *    the Free Software Foundation, either version 3 of the License, or�
 *    (at your option) any later version.�
 *�
 *    This program is distributed in the hope that it will be useful,�
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of�
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the�
 *    GNU General Public License for more details.�
 *�
 *    You should have received a copy of the GNU General Public License�
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.�
 */�
�
class Sitemap {�
�
  private $compress;�
  private $page = 'index';�
  private $index = 1;�
  private $count = 1;�
  private $urls = array();�
  �
  public function __construct ($compress=true) {�
    ini_set('memory_limit', '75M'); // 50M required per tests�
    $this->compress = ($compress) ? '.gz' : '';�
  }�
  �
  public function page ($name) {�
    $this->save();�
    $this->page = $name;�
    $this->index = 1;�
  }�
  �
  public function url ($url, $lastmod='', $changefreq='', $priority='') {�
    $url = htmlspecialchars(BASE_URL . $url);�
    $lastmod = (!empty($lastmod)) ? date('Y-m-d', strtotime($lastmod)) : false;�
    $changefreq = (!empty($changefreq) && in_array(strtolower($changefreq), array('always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'never'))) ? strtolower($changefreq) : false;�
    $priority = (!empty($priority) && is_numeric($priority) && abs($priority) <= 1) ? round(abs($priority), 1) : false;�
    if (!$lastmod && !$changefreq && !$priority) {�
      $this->urls[] = $url;�
    } else {�
      $url = array('loc'=>$url);�
      if ($lastmod !== false) $url['lastmod'] = $lastmod;�
      if ($changefreq !== false) $url['changefreq'] = $changefreq;�
      if ($priority !== false) $url['priority'] = ($priority < 1) ? $priority : '1.0';�
      $this->urls[] = $url;�
    }�
    if ($this->count == 50000) {�
      $this->save();�
    } else {�
      $this->count++;�
    }�
  }�
  �
  public function close() {�
    $this->save();�
    $this->ping_search_engines();�
  }�
  �
  private function save () {�
    if (empty($this->urls)) return;�
    $file = "sitemap-{$this->page}-{$this->index}.xml{$this->compress}";�
    $xml = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";�
    $xml .= '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' . "\n";�
    foreach ($this->urls as $url) {�
      $xml .= '  <url>' . "\n";�
      if (is_array($url)) {�
        foreach ($url as $key => $value) $xml .= "    <{$key}>{$value}</{$key}>\n";�
      } else {�
        $xml .= "    <loc>{$url}</loc>\n";�
      }�
      $xml .= '  </url>' . "\n";�
    }�
    $xml .= '</urlset>' . "\n";�
    $this->urls = array();�
    if (!empty($this->compress)) $xml = gzencode($xml, 9);�
    $fp = fopen(BASE_URI . $file, 'wb');�
    fwrite($fp, $xml);�
    fclose($fp);�
    $this->index++;�
    $this->count = 1;�
    $num = $this->index; // should have already been incremented�
    while (file_exists(BASE_URI . "sitemap-{$this->page}-{$num}.xml{$this->compress}")) {�
      unlink(BASE_URI . "sitemap-{$this->page}-{$num}.xml{$this->compress}");�
      $num++;�
    }�
    $this->index($file);�
  }�
  �
  private function index ($file) {�
    $sitemaps = array();�
    $index = "sitemap-index.xml{$this->compress}";�
    if (file_exists(BASE_URI . $index)) {�
      $xml = (!empty($this->compress)) ? gzfile(BASE_URI . $index) : file(BASE_URI . $index);�
      $tags = $this->xml_tag(implode('', $xml), array('sitemap'));�
      foreach ($tags as $xml) {�
        $loc = str_replace(BASE_URL, '', $this->xml_tag($xml, 'loc'));�
        $lastmod = $this->xml_tag($xml, 'lastmod');�
        $lastmod = ($lastmod) ? date('Y-m-d', strtotime($lastmod)) : date('Y-m-d');�
        if (file_exists(BASE_URI . $loc)) $sitemaps[$loc] = $lastmod;�
      }�
    }�
    $sitemaps[$file] = date('Y-m-d');�
    $xml = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";�
    $xml .= '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' . "\n";�
    foreach ($sitemaps as $loc => $lastmod) {�
      $xml .= '  <sitemap>' . "\n";�
      $xml .= '    <loc>' . BASE_URL . $loc . '</loc>' . "\n";�
      $xml .= '    <lastmod>' . $lastmod . '</lastmod>' . "\n";�
      $xml .= '  </sitemap>' . "\n";�
    }�
    $xml .= '</sitemapindex>' . "\n";�
    if (!empty($this->compress)) $xml = gzencode($xml, 9);�
    $fp = fopen(BASE_URI . $index, 'wb');�
    fwrite($fp, $xml);�
    fclose($fp);�
  }�
  �
  private function xml_tag ($xml, $tag, &$end='') {�
    if (is_array($tag)) {�
      $tags = array();�
      while ($value = $this->xml_tag($xml, $tag[0], $end)) {�
        $tags[] = $value;�
        $xml = substr($xml, $end);�
      }�
      return $tags;�
    }�
    $pos = strpos($xml, "<{$tag}>");�
    if ($pos === false) return false;�
    $start = strpos($xml, '>', $pos) + 1;�
    $length = strpos($xml, "</{$tag}>", $start) - $start;�
    $end = strpos($xml, '>', $start + $length) + 1;�
    return ($end !== false) ? substr($xml, $start, $length) : false;�
  }�
  �
  public function ping_search_engines () {�
    $sitemap = BASE_URL . 'sitemap-index.xml' . $this->compress;�
    $engines = array();�
    $engines['www.google.com'] = '/webmasters/tools/ping?sitemap=' . urlencode($sitemap);�
    $engines['www.bing.com'] = '/webmaster/ping.aspx?siteMap=' . urlencode($sitemap);�
    $engines['submissions.ask.com'] = '/ping?sitemap=' . urlencode($sitemap);�
    foreach ($engines as $host => $path) {�
      if ($fp = fsockopen($host, 80)) {�
        $send = "HEAD $path HTTP/1.1\r\n";�
        $send .= "HOST: $host\r\n";�
        $send .= "CONNECTION: Close\r\n\r\n";�
        fwrite($fp, $send);�
        $http_response = fgets($fp, 128);�
        fclose($fp);�
        list($response, $code) = explode (' ', $http_response);�
        if ($code != 200) trigger_error ("{$host} ping was unsuccessful.<br />Code: {$code}<br />Response: {$response}");�
      }�
    }�
  }�
  �
  public function __destruct () {�
    $this->save();�
  }�
�
}�
�
?>