rollerworks/db-bundle

Doctrine DBAL Helper Bundle. Providing extra functionality for the DBAL

RollerworksDBBundle

UserErrorExceptionListener

This listener listens to DBAL related Exceptions and looks for an so-called user-error., _(*1)

Currently only PostgreSQL is supported., _(*2)

An user-error is an exception/error thrown by an DB used-defined function, and can be seen as a system exception, so its not intended for validating basic user-input., _(*3)

Usage may include an access-violation or none-existent relation., _(*4)

Installation

Step 1: Using Composer (recommended)

To install RollerworksDBBundle with Composer add the following to your composer.json file:, _(*5)

// composer.json
{
    // ...
    require: {
        // ...
        "rollerworks/db-bundle": "master-dev"
    }
}

NOTE: Please replace master-dev in the snippet above with the latest stable branch, for example 1.0.*., _(*6)

Then, you can install the new dependencies by running Composer's update command from the directory where your composer.json file is located:, _(*7)

$ php composer.phar update

Now, Composer will automatically download all required files, and install them for you. All that is left to do is to update your AppKernel.php file, and register the new bundle:, _(*8)

<?php

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new Rollerworks\Bundle\DBBundle\RollerworksDBBundle(),
    // ...
);

Step 1 (alternative): Using deps file (Symfony 2.0.x)

First, checkout a copy of the code. Just add the following to the deps file of your Symfony Standard Distribution:, _(*9)

[RollerworksDBBundle]
    git=http://github.com/rollerworks/RollerworksDBBundle.git
    target=/bundles/Rollerworks/Bundle/DBBundle

NOTE: You can add version tag in the snippet above with the latest stable branch, for example version=origin/2.0., _(*10)

Then register the bundle with your kernel:, _(*11)

<?php

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new Rollerworks\Bundle\DBBundle\RollerworksDBBundle(),
    // ...
);

Make sure that you also register the namespace with the autoloader:, _(*12)

<?php

// app/autoload.php
$loader->registerNamespaces(array(
    // ...
    'Rollerworks'              => __DIR__.'/../vendor/bundles',
    // ...
));

Now use the vendors script to clone the newly added repositories into your project:, _(*13)

$ php bin/vendors install

Step 1 (alternative): Using submodules (Symfony 2.0.x)

If you're managing your vendor libraries with submodules, first create the vendor/bundles/Rollerworks/Bundle directory:, _(*14)

``` bash $ mkdir -pv vendor/bundles/Rollerworks/Bundle, <sub>(*15)</sub>

Next, add the necessary submodule:

``` bash
$ git submodule add git://github.com/rollerworks/RollerworksDBBundle.git vendor/bundles/Rollerworks/Bundle/DBBundle

Step2: Configure the autoloader

Add the following entry to your autoloader:, <sub>(*16)</sub>

``` php <?php // app/autoload.php, <sub>(*17)</sub>

$loader->registerNamespaces(array( // ... 'Rollerworks' => DIR.'/../vendor/bundles', // ... ));, <sub>(*18)</sub>

### Step3: Enable the bundle

Finally, enable the bundle in the kernel:

``` php
<?php

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new Rollerworks\Bundle\DBBundle\RollerworksDBBundle(),
    // ...
);

Congratulations! You're ready!, <sub>(*19)</sub>

Step4: Configure the bundle

By default the exception listerner only listens to \PDOException and \Doctrine\DBAL\Driver\OCI8\OCI8Exception. And only tries to parse the error message when its starts with 'app-exception: '., <sub>(*20)</sub>

You may change this by adding this to your configuration., <sub>(*21)</sub>

``` yaml, <sub>(*22)</sub>

app/config/config.yml

rollerworks_db: user_exception_listener: check_prefix: 'my-app-exception: ' check_class_in: [ '\PDOException' ] ```, <sub>(*23)</sub>