https://github.com/apy/apybreadcrumbtrailbundle

Generate a dynamic Twig breadcrumbs trail via Annotations, PHP Attributes or PHP methods.
https://github.com/apy/apybreadcrumbtrailbundle

annotations attributes breadcrumbs bundle php symfony symfony-bundle twig

Last synced: about 12 hours ago
JSON representation

Generate a dynamic Twig breadcrumbs trail via Annotations, PHP Attributes or PHP methods.

• Host: GitHub
• URL: https://github.com/apy/apybreadcrumbtrailbundle
• Owner: APY
• Created: 2011-12-17T00:17:58.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-11-19T10:19:33.000Z (about 1 month ago)
• Last Synced: 2024-12-24T21:43:22.326Z (1 day ago)
• Topics: annotations, attributes, breadcrumbs, bundle, php, symfony, symfony-bundle, twig
• Language: PHP
• Homepage:
• Size: 152 KB
• Stars: 84
• Watchers: 7
• Forks: 33
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
Getting Started With BreadcrumbTrailBundle

==========================================

This bundle provides a breadcrumb trail service also known as breadcrumbs or Fil d'Ariane.

Breadcrumbs can be defined with Attributes, annotations, PHP and Twig.

## Installation

Please follow the steps given in [installation.md](src/Resources/doc/installation.md) to install this bundle.

## Bundle documentation

- [Annotation configuration](src/Resources/doc/annotation_configuration.md)

- [PHP configuration](src/Resources/doc/php_configuration.md)

- [Twig configuration](src/Resources/doc/twig_configuration.md)

- [Render the breadcrumb trail](src/Resources/doc/rendering.md)

- [Override the template](src/Resources/doc/override_template.md)

## Tests

Several make targets can get used to run the PHPUnit test suite on different PHP environments:

```

$ make test

$ make test-php73

$ make test-php74-lowest

```

In case all test suites pass but running tests still returns an error code, that

might be related to the number of allowed deprecations. Make sure that the

`SYMFONY_DEPRECATIONS_HELPER` value of `max[self]` as found in `phpunit.xml.dist`

matches the "Remaining self deprecation notices" count from the test runner output.

## Code style

PHP-CS-Fixer is used to keep the code style in shape. There is a make target that uses Docker to fix

the code style without having to install any other dependencies:

```

$ make cs

```

## Static code analysis

PHPStan is used to keep the code quality up to par. There is a make target that uses Docker to test

the code quality without having to install any other dependencies:

```

$ make static

```