# sitemap

**Repository Path**: web/sitemap

## Basic Information

- **Project Name**: sitemap
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-16
- **Last Updated**: 2026-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sitemap 生成工具

一个用于生成网站地图（Sitemap）的PHP类库，支持XML和HTML两种格式。

## 功能特性

- 生成标准的XML格式Sitemap（兼容Google Sitemap协议）
- 生成HTML格式的站点地图，便于用户浏览
- 支持同时生成多种格式
- 支持大型网站（自动分卷处理，每卷最多50000个URL）
- 支持自定义域名、优先级、更新频率等参数

## 安装

将 `Sitemap.php` 文件复制到您的项目目录中，然后通过 `include` 或 `require` 引入即可。

```php
include_once('Sitemap.php');
```

## 使用方法

### 基本使用

```php
include_once('Sitemap.php');

// 创建Sitemap实例
$sitemap = new Sitemap();

// 添加页面
$sitemap->addItem('/', '1.0', 'daily', 'Today');
$sitemap->addItem('/about.php', '0.8', 'monthly', '2026-01-01');
$sitemap->addItem('/contact.php', '0.7', 'weekly', time());

// 生成sitemap文件
$sitemap->endSitemap();
```

### 指定域名

```php
// 手动指定域名
$sitemap = new Sitemap('https://www.example.com');
// 或者
$sitemap->setDomain('https://www.example.com');
```

### 设置保存目录

```php
$sitemap->setDir('./sitemaps/'); // 注意：目录需预先创建
```

### 生成XML格式（默认）

```php
$sitemap->setFormat('xml'); // 默认格式
```

### 生成HTML格式

```php
$sitemap->setFormat('html');
```

### 同时生成多种格式

```php
// 同时生成XML和HTML格式
$sitemap->setFormat(['xml', 'html']);

// 添加页面
$sitemap->addItem('/', '1.0', 'daily', 'Today');
$sitemap->addItem('/about.php', '0.8', 'monthly', '2026-01-01');

// 生成所有指定格式的sitemap
$sitemap->endSitemap();
```

### 参数说明

`addItem($loc, $priority, $changefreq, $lastmod, $title)` 方法参数：

- `$loc`: 页面路径（如 `/`, `/about.php`）
- `$priority`: 优先级（0.0 - 1.0，默认 0.5）
- `$changefreq`: 更新频率（always, hourly, daily, weekly, monthly, yearly, never）
- `$lastmod`: 最后修改时间（日期字符串或时间戳）
- `$title`: 页面标题（可选，主要用于HTML格式的sitemap显示）

## 格式说明

### XML格式

生成符合Google Sitemap协议的XML文件，文件扩展名为 `.xml`。

### HTML格式

生成用户友好的HTML页面，包含表格形式的站点导航，文件扩展名为 `.html`。

## 示例

```php
include_once('Sitemap.php');

// 创建实例
$sitemap = new Sitemap('https://www.example.com');

// 设置同时生成XML和HTML格式
$sitemap->setFormat(['xml', 'html']);

// 添加页面
$sitemap->addItem('/', '1.0', 'daily', 'Today');
$sitemap->addItem('/products/', '0.9', 'weekly', '2026-01-01');
$sitemap->addItem('/about.php', '0.8', 'monthly', time());
$sitemap->addItem('/contact.php', '0.7', 'monthly', '2026-01-15');

// 生成sitemap文件
$sitemap->endSitemap();

// 获取生成的文件路径
echo $sitemap->getCurrXmlFileFullPath();
```

## 文件说明

- `Sitemap.php`: 核心类文件
- `index.php`: 使用示例文件
- `sitemap.html`: HTML格式模板参考

## 许可证

MIT License