nousefreak/breadcrumbr

This package is abandoned and no longer maintained. No replacement package was suggested.

Breadcrumbr, breadcrumb logic helpers.

1.0.0 2014-01-19 02:13 UTC

This package is auto-updated.

Last update: 2020-01-29 23:15:20 UTC


README

Breadcrumbr, breadcrumb logic helpers.

Usage

In it's very basic form.

$breadcrumb = new \Breadcrumbr\Breadcrumb();
$breadcrumb->addCrumb(new \Breadcrumbr\Crumb\Crumb());

foreach ($breadcrumb as $crumb) {
    // Render the crumb
}

Adding resolvers.

$breadcrumb->addResolver(new EnvResolver());

// render

Adding more context to the resolvers.

$context = new \Breadcrumbr\Context\Context();
$context->addContext('menu', $menuInfo);

$breadcrumb->setContext($context);
$breadcrumb->addResolver(new MenuResolver());

// render

Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send us a pull request.

To ensure a consistent code base, you should make sure the code follows the Coding Standards which we borrowed from Symfony. Make sure to check out php-cs-fixer as this will help you a lot.

If you would like to help take a look at the list of issues.

Requirements

PHP 5.3.2 or above

Author and contributors

Dries De Peuter - dries@nousefreak.be - http://nousefreak.be

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT license.