https://github.com/agence-adeliom/easy-seo-bundle
Symfony SEO bundle for EasyAdmin
https://github.com/agence-adeliom/easy-seo-bundle
breadcrumb easyadmin metadata seo sitemap symfony
Last synced: 28 days ago
JSON representation
Symfony SEO bundle for EasyAdmin
- Host: GitHub
- URL: https://github.com/agence-adeliom/easy-seo-bundle
- Owner: agence-adeliom
- License: mit
- Created: 2021-08-23T12:08:17.000Z (over 3 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-05-29T09:46:28.000Z (12 months ago)
- Last Synced: 2024-11-24T17:49:08.753Z (6 months ago)
- Topics: breadcrumb, easyadmin, metadata, seo, sitemap, symfony
- Language: PHP
- Homepage:
- Size: 98.6 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=agence-adeliom_easy-seo-bundle)
# Easy SEO Bundle
## Versions
| Repository Branch | Version | Symfony Compatibility | PHP Compatibility | Status |
|-------------------|---------|-----------------------|-------------------|----------------------------|
| `3.x` | `3.x` | `6.4`, and `7.x` | `8.2` or higher | New features and bug fixes |
| `2.x` | `2.x` | `5.4`, and `6.x` | `8.0.2` or higher | Bug fixes |
| `1.x` | `1.x` | `4.4`, and `5.x` | `7.2.5` or higher | No longer maintained |
## Installation with Symfony Flex
Add our recipes endpoint
```json
{
"extra": {
"symfony": {
"endpoint": [
"https://api.github.com/repos/agence-adeliom/symfony-recipes/contents/index.json?ref=flex/main",
...
"flex://defaults"
],
"allow-contrib": true
}
}
}
```
Install with composer
```bash
composer require agence-adeliom/easy-seo-bundle
```
## Documentation
### Customisation
```yaml
# config/packages/easy_seo.yaml
easy_seo:
title:
suffix: ACME # Change the title suffix
separator: '|' # Change the title separator
breadcrumbs:
class: 'breadcrumb'
item_class: 'breadcrumb-item'
link_class: ''
current_class: 'active'
separator: '>'
separator_class: 'breadcrumb-separator'
enable_profiler: '%kernel.debug%'
ignore_profiler:
- '^/admin*'
```
### Add SEO to your entity
#### Entity
```php
use Adeliom\EasySeoBundle\Traits\EntitySeoTrait;
class Article {
use EntitySeoTrait;
}
```
#### CRUD Controller
```php
class ArticleCrudController extends AbstractCrudController
{
public function configureFields(string $pageName): iterable
{
yield SEOField::new("seo");
}
}
```
#### Twig template
```php
# Render the title
{{- seo_title(object.seo) -}}
# Render the metadatas
{{- seo_metas(object.seo) -}}
# Render the breadcrumb
{{- seo_breadcrumb() -}}
```
### Events
#### easyseo.title
```php
use Symfony\Contracts\EventDispatcher\Event;
$dispatcher->addListener('easyseo.title', function (Event $event) {
// will be executed when the easyseo.title event is dispatched
// Get the title
$title = $event->getArgument("title");
// Set the title
$event->setArgument("title", "custom title");
});
```
#### easyseo.render_meta
```php
use Symfony\Contracts\EventDispatcher\Event;
$dispatcher->addListener('easyseo.render_meta', function (Event $event) {
// will be executed when the easyseo.render_meta event is dispatched
// Get SEO data
$seoData = $event->getArgument("datas");
// Set SEO data
$event->setArgument("datas", $seoData);
});
```
#### easyseo.breadcrumb
```php
use Symfony\Contracts\EventDispatcher\Event;
$dispatcher->addListener('easyseo.breadcrumb', function (Event $event) {
// will be executed when the easyseo.breadcrumb event is dispatched
// Get breadcrumb's items
$items = $event->getArgument("items");
// Set breadcrumb's items
$event->setArgument("items", $items);
});
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Authors
- [@arnaud-ritti](https://github.com/arnaud-ritti)