README

Tracenator 是一个PHP库，用于生成XML格式的网站地图。

功能

• 为您的网站生成XML格式的网站地图。
• 支持多种类型的网站地图，包括URL、索引等。
• 避免重复的URL条目。
• 支持在网站地图中包含额外的元素，如图片、视频、文章和不同语言。
• 自动设置网站URL

安装

您可以通过Composer安装Tracenator。在项目目录中运行以下命令

composer require k_universe/tracenator

用法

以下是如何生成URL网站地图的示例

<?php

$siteMap = new K_Universe\Tracenator\GenerateSitemap();
foreach ($urls as $url) {
    $siteMap->addUrl([
        'location' => 'https://example.com/',
        'priority' => 0.8,
        'images' => [
            'https://example.com/image.jpg',
            'https://example.com/image-1.jpg',
        ],
        'alternates' => [
            [
                'href' => 'https://example.com/de/',
                'hreflang' => 'de',
            ],
            [
                'href' => 'https://example.com/cs/',
                'hreflang' => 'cs',
            ]
        ],
        'article' => [
            'author' => 'John Doe',
            'publication_date' => '2021-01-01',
            'title' => 'Example Article',
            'description' => 'This is an example article.',
        ],
        'videos' => [
            [
                'thumbnail_url' => 'https://example.com/video.jpg',
                'title' => 'Example Video',
                'description' => 'This is an example video.',
                // either content_url or player_url is required
                'content_url' => 'https://example.com/video.mp4',
                'player_url' => 'https://example.com/videoplayer.php?video=123',
                // optional parameters
                'duration' => '600',
                'expiration_date' => '2021-11-05T19:20:30+08:00',
                'rating' => 4.2,
                'view_count' => 1000,
                'publication_date' => '2007-11-05T19:20:30+08:00',
                'family_friendly' => true,
                'restriction' => [
                    'relationship' => 'allow', // only allow or denied
                    'value' => 'IE GB US CA',
                ],
                'platform' => [
                    'relationship' => 'allow', // only allow or denied
                    'platform' => 'tv mobile web' // only available values spaced
                ],
                'requires_subscription' => true,
                'uploader' => [
                    'info' => 'https://example.com/user/123',
                    'name' => 'John Doe',
                ],
                'live' => true
            ],
        ],
    ]);
}
// generates sitemap in base directory
$siteMap->export();

GenerateSitemap

此类用于生成网站地图。它有以下方法

• addUrl(array $urlData): 向网站地图添加URL。URL数据是一个关联数组。需要以上格式
• export(string $dir = null, string $name = null): 将网站地图导出到项目基础目录的XML文件中。您可以指定输出目录和文件名。