baraja-core/sitemap

此包最新版本(v2.0.2)没有可用的许可证信息。

v2.0.2 2021-12-23 17:33 UTC

README

Integrity check

一个简单、功能强大、性能优良的网站地图生成器。

  • 以XML格式生成标准化的网站地图,
  • 允许自定义实现UrlLoader并指定自定义链接源,
  • 生成的地图会自动缓存和更新,无需使用cron。

📦 安装

建议使用 Composer 进行安装,您还可以在 PackagistGitHub 上找到此包。

安装命令:

$ composer require baraja-core/sitemap

您可以通过创建内部类的实例来手动使用此包,或者注册DIC扩展将服务直接链接到Nette框架。

基本描述

该包自动生成一个名为 sitemap.xml 的网站地图文件,具有以下结构

<urlset xmlns = "http://www.sitemaps.org/schemas/sitemap/0.9">
    <url>
        <loc>
            https://... // Here will be the whole absolute path
        </loc>
        <changefreq>weekly</changefreq>
        <priority>0.5</priority>
    </url>
</urlset>

从抽象的 SitemapUrlLoader 服务中检索URL,该服务可以被覆盖和实现。UrlLoader通过 getUrls() 方法返回实体字段 SitemapItems[]

它向管理中添加了自己的演示者,显示当前表单和文件结构。

安装

Composer

$ composer require baraja-core/sitemap

路由规则和服务会自动注册。

安装后,您必须在包中定义一个UrlLoader,该UrlLoader获取所有可用URL的列表并将其传递给渲染。您可以使用另一个现有的库作为UrlLoader。

获取URL列表

该包不包括UrlLoader的默认实现,每个项目必须自行实现。

该类必须包含一个公共的 getUrls() 方法,该方法返回一个 SitemapItem[] 实例的数组。

获取网站地图 + 缓存

该包不会创建任何物理的网站地图文件,因为它在每个请求时都运行一个PHP脚本。为了避免总是执行复杂的映射,该包本身将使用默认有效期为5分钟的缓存。

缓存长度设置受 neon 配置文件的影响

sitemap:
    cacheExpirationTime: '20 minutes'

📄 许可证

baraja-core/sitemap 采用MIT许可证。有关详细信息,请参阅 LICENSE 文件。