Download the PHP package dlapps/sitemap-bundle without Composer
On this page you can find all versions of the php package dlapps/sitemap-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dlapps/sitemap-bundle
More information about dlapps/sitemap-bundle
Files in dlapps/sitemap-bundle
Package sitemap-bundle
Short Description Provides simple integration for generating sitemaps in Symfony 3.2+ projects
License proprietary
Homepage https://github.com/dlapps/sitemap-bundle
Informations about the package sitemap-bundle
Sitemap Bundle
The Sitemap bundle enables development teams to quickly add support for generating sitemaps, for their PHP7 packages and projects built on Symfony 3.2+.
The bundle supports a number of customisation parameters, PSR-4 autoloading, is PSR-2 compliant and has been well tested through automated tests, as well as being used in various microservices within the Dreamlabs ecosystem.
Install
Via Composer
Enable the bundle in your AppKernel, present in: app/AppKernel.php
.
Usage
In order to generate a sitemap, you need to generate an instance of sitemap definition DL\SitemapBundle\Definition\Sitemap
.
This instance can then accept the individual sitemap resources that you would like to add via the Sitemap::addResource()
method.
In order to assist with the generation and validation of sitemap resources, the sitemap_resource_builder
service is exposed, and can be used as in the example below:
The builder will automatically validate a new resource that is added to the Sitemap, and ensure that:
- All fields have been provided.
- The priority is a float between 0 and 1.
- The change frequency is a valid value.
- An absolute URL has been provided for the location.
The builder also exposes a ->withRelativeLocation($location)
method, which can be used alongside the location_prefix
configuration parameter in order to generate absolute routes, from relative URLs. This feature is present in order to assist with possibly mismatching hostnames when proxying through an improperly configured load balancer.
Given a scenarion in which the location_prefix
parameter is set to https://example.com
calling ->withRelativeLocation('/article/test')
will generate the absolute URL https://example.com//article/test
.
The DL\SitemapBundle\Enum\ChangeFrequencyEnum
class can be used in order to define a strict change frequency. Possible values are:
- ChangeFrequencyEnum::ALWAYS
- ChangeFrequencyEnum::HOURLY
- ChangeFrequencyEnum::DAILY
- ChangeFrequencyEnum::WEEKLY
- ChangeFrequencyEnum::MONTHLY
- ChangeFrequencyEnum::YEARLY
- ChangeFrequencyEnum::NEVER
Configuration Reference
The following configuration parameters are also available for the bundle:
Testing
PSR-2 Compatibility
Contributing
Please see CONDUCT for details.
Security
If you discover any security related issues, please email petre [at] dreamlabs.ro instead of using the issue tracker.
Credits
- Petre Pătrașc
- All Contributors
License
The MIT License (MIT). Please see License File for more information.