https://github.com/steevanb/dev-bundle

Bundle for dev environment, to help you fix some errors
https://github.com/steevanb/dev-bundle

doctrine doctrine2 php symfony

Last synced: 9 days ago
JSON representation

Bundle for dev environment, to help you fix some errors

• Host: GitHub
• URL: https://github.com/steevanb/dev-bundle
• Owner: steevanb
• Created: 2015-09-21T09:25:29.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-29T13:05:58.000Z (over 6 years ago)
• Last Synced: 2024-11-15T13:55:09.680Z (about 1 month ago)
• Topics: doctrine, doctrine2, php, symfony
• Language: PHP
• Homepage:
• Size: 72.3 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md

Awesome Lists containing this project

README

        
[![version](https://img.shields.io/badge/version-5.0.1-green.svg)](https://github.com/steevanb/dev-bundle/tree/5.0.1)

[![symfony](https://img.shields.io/badge/php-^7.1-blue.svg)](https://symfony.com/)

[![symfony](https://img.shields.io/badge/symfony_framework_bundle-^4.0-blue.svg)](https://symfony.com/)

![Lines](https://img.shields.io/badge/code%20lines-1326-green.svg)

![Total Downloads](https://poser.pugx.org/steevanb/dev-bundle/downloads)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/steevanb/dev-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/steevanb/dev-bundle/?branch=master)

### dev-bundle

Bundle for dev environment, to help you find missing translations, validate your Doctrine schema automatically and show what is loaded (classes, services etc).

For Symfony ^2.6 and ^3.0, see [steevan/dev-bundle ^4.1](https://github.com/steevanb/dev-bundle/tree/4.1.1).

[Changelog](changelog.md)

### Installation

```bash

composer require steevanb/dev-bundle ^5.0.1

```

Or add it manually, and then execute _composer update steevanb/dev-bundle_ :

```json

# composer.json

{

    "require": {

        "steevanb/dev-bundle": "^5.0.1"

    }

}

```

Add bundle to your AppKernel :

```php

# app/AppKernel.php

class AppKernel extends Kernel

{

    public function registerBundles()

    {

        if ($this->getEnvironment() == 'dev') {

            $bundles[] = new steevanb\DevBundle\DevBundle();

        }

    }

}

```

### Configuration

```yml

# app/config/config.yml

dev:

    # throws steevanb\DevBundle\Exception\TranslationsNotFoundException on translations not found

    translation_not_found:

        enabled: [TRUE|false]

        # allow Translator to search your translation in fallbacks, or not

        allow_fallbacks: [true|FALSE]

    # validate Doctrine schema

    validate_schema:

        enabled: [TRUE|false]

        disabled_urls:

            - /_wdt

            - /_profiler/

            - /_errors

        event: [KERNEL.REQUEST|kernel.response]

        excludes:

            - Foo\Bar\Entity

            - Foo\Bar\Entity#property

        bundles:

            # enable scan of Resources/config/doctrine dir of bundles

            enabled: [TRUE|false]

            # bundles to scan. if empty or not specified, will add all installed bundles

            bundles:

                - FooBundle

                - BarBundle

```

### Translation not found exception

Throws steevanb\Exception\TranslationsNotFoundException at _kernel.response_ event when at least one translation is not found.

All translations not found throws this exception, especially when fallbacks are used.

For example, if you have a _messages.fr.yml_ in your bundle, and you try to translate a string with _fr_FR_ locale,

exception will be throwned. You can allow this with _translation.allow_fallbacks_ configuration.

### Validate Doctrine mapping

Same as calling _doctrine:schema:validate_ on each request, with a cache to not recall it if nothing has changed.

Throws steevanb\Exception\InvalidMappingException when mapping informations are invalid.

Doctrine schema validation will be executed on each request (_kernel.request_ or _kernel.response event_, depends on configuration), only for main request.

You can exclude entities or properties validation, by adding values in _dev.validate_schema.excludes_ configuration.

If value is a fully classified entity, all validation errors on this entity will be ignored.

If value if a fully qualifier entity, plus a property (ex : _Foo\Bar\Entity#property_),

only validation errors on this property will be ignored.

### List loaded classes, services etc

Add Symfony WebProfilter panel, with informations about what is loaded : classes, traits, interfaces, services, container parameters, etc.

![Loaded](loaded.jpg)