PHPackages                             cyberomulus/sitemap-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. cyberomulus/sitemap-generator

ActiveLibrary[Parsing & Serialization](/categories/parsing)

cyberomulus/sitemap-generator
=============================

SiteMapGenerator is a PHP library that makes it easy to generate a SiteMap and SiteMapIndex (including Google specific tags).

2.0.1(6y ago)428.3k↓41.2%1MITPHPPHP >=5.2.0

Since May 20Pushed 6y ago1 watchersCompare

[ Source](https://github.com/cyberomulus/SiteMapGenerator)[ Packagist](https://packagist.org/packages/cyberomulus/sitemap-generator)[ Docs](https://github.com/cyberomulus/SiteMapGenerator)[ RSS](/packages/cyberomulus-sitemap-generator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)DependenciesVersions (6)Used By (0)

SiteMapGenerator
================

[](#sitemapgenerator)

What is SiteMapGenerator ?
--------------------------

[](#what-is-sitemapgenerator-)

SiteMapGenerator is a PHP library that makes it easy to generate a SiteMap and SiteMapIndex (including Google specific tags).

How to install SiteMapGenerator
-------------------------------

[](#how-to-install-sitemapgenerator)

There are 2 ways to install SiteMapGenerator.

If you use [Composer](https://getcomposer.org/), SiteMapGenerator is available by [Packagist](https://packagist.org).
Just add the dependencies to your composer.json:

```
{
	"require": {
        "cyberomulus/sitemap-generator": "~2.0"
    }
}

```

Else, got to the page [github of SiteMapGenerator](https://github.com/cyberomulus/SiteMapGenerator) and choose the release of your choice.
You can download the source code with the link 'Download ZIP'.
Place the directory in the ZIP in a lib folder (for example) of your project.

What I need to use SiteMapGenerator
-----------------------------------

[](#what-i-need-to-use-sitemapgenerator)

It takes minimum PHP version 5.2.0 with XMLWriter extension enabled (it is enabled by default).

How to generate a SiteMapIndex
------------------------------

[](#how-to-generate-a-sitemapindex)

1. Create one or more `SiteMapEntry`
2. Create one `SiteMapIndex`
3. Add all `SiteMapEntry` in `SiteMapIndex`
4. Create a Formatter (example : `XMLFormatter`)
5. Use `Formatter::formatSiteMapIndex()`

How to generate a SiteMap
-------------------------

[](#how-to-generate-a-sitemap)

1. Create one or more `URLEntry`
2. Create one `SiteMap`
3. Add all `URLEntry` in `SiteMap`
4. Create a Formatter (example : `XMLFormatter`)
5. Use `Formatter::formatSiteMap()`

How to add Image for Google's extra
-----------------------------------

[](#how-to-add-image-for-googles-extra)

1. Create one or more `GoogleImageEntry`
2. Add all `GoogleImageEntry` in `URLEntry`

How to not actived Google's extra
---------------------------------

[](#how-to-not-actived-googles-extra)

Juste set Parameter at false in constructor of `SiteMap`. All GoogleImageEntry are not displayed

How to create a formatter
-------------------------

[](#how-to-create-a-formatter)

Create a class extends `Formatter`.

Example for generate a SiteMap with Google's extra
--------------------------------------------------

[](#example-for-generate-a-sitemap-with-googles-extra)

```