bestit/kitchensink-bundle

Helps you create a kitchensink incl. route, template and services.

1.1.0 2020-02-26 14:39 UTC

This package is auto-updated.

Last update: 2024-04-29 03:38:14 UTC


README

Helps you create a kitchensink incl. route, template and services.

Build Status Scrutinizer Code Quality Code Coverage

Usage

This bundle provides you with a simple controller (/kitchensink) and service structure, to load a template, defined through the config, filled with the data from the dataprovider implementing the DataProviderInterface of this bundle.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require bestit/kitchensink-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        // ...
        
        if (in_array($this->getEnvironment(), ['dev', 'test'], true)) {
            $bundles[] = new BestIt\KitchensinkBundle\BestItKitchensinkBundle();
        }        

        // ...
    }

    // ...
}

Step 3: Configure the bundle

# Default configuration for "BestItKitchensinkBundle"
best_it_kitchensink:

    # Which template should be used the render the kitchensink?
    template:             kitchensink/index.html.twig

    # The data provider service implementing the matching interface.
    data_provider:        ~ # Required

Step 4: Import routing files

# routing_dev.yml
best_it_kitchensink:
    resource: "@BestItKitchensinkBundle/Resources/config/routing.yml"