starychfojtu/viewcomponent

Implementation of View Components for Symfony 3.3

v0.4.0 2017-09-25 07:50 UTC

Requires

• php: ^7.1
• nayjest/str-case-converter: ^1.0
• symfony/cache: ^3.3
• symfony/config: ^3.3
• symfony/dependency-injection: ^3.3
• symfony/finder: ^3.3
• symfony/http-kernel: ^3.3
• twig/twig: ^2.4

Requires (Dev)

• phpunit/phpunit: ^6.2

MIT

• Josef Starýchfojtů

• symfony
• twig
• components
• component
• viewcomponents

README

Implementation of View Components for Symfony 3.3

Installation

$ composer require starychfojtu/viewcomponent

Symfony flex might register incorrect namespace in bundles.php. If it did, go ahead and register it yourself with

'ViewComponent\ViewComponentBundle' => ['all' => true]

Configuration

starychfojtu_view_component:
    component_dirs: ['AppBundle/Component', 'AppBundle/SpecialComponent'] #results in '/src/AppBundle/Component', '/src/AppBundle/Component/specialComponent'
    # Specify directories where the bundle should search for components from /src
    template_dirs: ['components', 'specialComponents'] #results in '/templates/components', '/templates/specialComponents'
    # Specify directories where the bundle should search for templates from /templates

Usage

First specify your view component by creating a class in configured directories and implement ViewComponentInterface. The render method returns associative array of objects that are passed to the view.

YOU HAVE TO NAME YOUR COMPONENT IN THIS WAY : YourSpecialNameViewComponent It is a classic CamelCase naming e.g. MenuViewComponent or CartSummaryViewComponent.

# src/AppBundle/Component/MenuViewComponent

<?php

namespace AppBundle\Component;

use Starychfojtu\ViewComponentBundle\ViewComponentInterface;

class MenuViewComponent implements ViewComponentInterface
{
    public function render(): array
    {
        return [
            'links' => ['home','about','contact']
        ];
    }
}

Then add your template to one of configured directories.

# templates/components/Menu.html.twig

{% for link in links %}
    {{ link }}
{% endfor %}

And finally render your component in the view:

{{ component('Menu', 60 * 60) }}

The second parameter is cache time of the whole component with default set on 0;

Custom template name

If you want to specify another template name in view component, just add a key with template like this:

# src/AppBundle/Component/MenuViewComponent

<?php

namespace AppBundle\SpecialComponent;

use Starychfojtu\ViewComponentBundle\ViewComponentInterface;

class MenuViewComponent implements ViewComponentInterface
{
    public function render(): array
    {
        return [
            'links' => ['home','about','contact'],
            'template' => 'AnotherMenu'
        ];
    }
}

Dependency injection

To pass any dependencies to the component, just register them as services.

TODO: register them automatically in bundle