Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeroendesloovere/sitemap
https://github.com/jeroendesloovere/sitemap
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jeroendesloovere/sitemap
- Owner: jeroendesloovere
- License: mit
- Created: 2022-03-11T07:54:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-07T07:51:38.000Z (over 2 years ago)
- Last Synced: 2024-12-04T09:49:02.208Z (23 days ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sitemap bundle
[](https://packagist.org/packages/jeroendesloovere/sitemap)
[](https://github.com/jeroendesloovere/sitemap/blob/master/LICENSE)
[](https://travis-ci.org/jeroendesloovere/sitemap)
[](https://scrutinizer-ci.com/g/jeroendesloovere/sitemap/)
> This Symfony bundle allows you to easily generate a sitemapindex and one or multiple sitemap(s).
## To Do Features
What needs to be done:
* Generate the "sitemap provider last modified on datetime" which we need to show in the sitemapindex.
## Usage
### Installation
```bash
composer require jeroendesloovere/sitemap
```
### Example: "How to create your custom sitemap?"
We need to notify Symfony that we have a new sitemap provider.
Add the following somewhere in your `services.yaml`
```yaml
services:
App\SitemapProviders\NewsArticleSitemapProvider:
tags:
- { name: sitemap.provider }
```
When the `SitemapGenerator` needs to generate the sitemap(s),
it will ask all SitemapProviders to fill in the items.
Create something like the following in your app.
```php
articleRepository = $articleRepository;
// `NewsArticle::class` would even be better then just `NewsArticle`
// because you can then use it with doctrine events.
parent::__construct('NewsArticle');
}
public function createItems(): void
{
/** @var Article[] $articles */
$articles = $this->articleRepository->findAll();
foreach ($articles as $article) {
$this->createItem('/nl/xxx/url-to-article', $article->getEditedOn(), ChangeFrequency::monthly());
}
}
}
```
You can now generate the sitemap(s) by executing:
```bash
SitemapGenerator->generate()
```
> Use a cronjob (f.e. every hour) to have up-to-date sitemaps.
## Documentation
The class is well documented inline. If you use a decent IDE you'll see that each method is documented with PHPDoc.
## Contributing
Contributions are **welcome** and will be fully **credited**.
### Pull Requests
> To add or update code
- **Coding Syntax** - Please keep the code syntax consistent with the rest of the package.
- **Add unit tests!** - Your patch won't be accepted if it doesn't have tests.
- **Document any change in behavior** - Make sure the README and any other relevant documentation are kept up-to-date.
- **Consider our release cycle** - We try to follow [semver](http://semver.org/). Randomly breaking public APIs is not an option.
- **Create topic branches** - Don't ask us to pull from your master branch.
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
### Issues
> For bug reporting or code discussions.
More info on how to work with GitHub on help.github.com.
### Coding Syntax
We use [squizlabs/php_codesniffer](https://packagist.org/packages/squizlabs/php_codesniffer) to maintain the code standards.
Type the following to execute them:
```bash
# To view the code errors
vendor/bin/phpcs --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"
# OR to fix the code errors
vendor/bin/phpcbf --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"
```
> [Read documentation about the code standards](https://github.com/squizlabs/PHP_CodeSniffer/wiki)
### Unit Tests
We have build in tests, type the following to execute them:
```bash
vendor/bin/phpunit tests
```
## Credits
- [Jeroen Desloovere](https://github.com/jeroendesloovere)
- [All Contributors](https://github.com/jeroendesloovere/sitemap/contributors)
## License
The module is licensed under [MIT](./LICENSE.md). In short, this license allows you to do everything as long as the copyright statement stays present.