acseo/fast-show-generator-bundle

There is no license information available for the latest version (v2.0.1) of this package.

A bundle to quickly generate show actions based on annotation or yaml

v2.0.1 2023-07-03 16:20 UTC

Requires

• doctrine/annotations: ^2.0
• symfony/config: ^5.0
• symfony/dependency-injection: ^5.0
• symfony/http-kernel: ^5.0
• symfony/yaml: ^5.0

Unknown License

• Nicolas Kern
• Nicolas Potier

• symfony
• generate
• show

README

ACSEOFastShowGeneratorBundle allows to quickly generate show actions based on annotation or yaml This bundle was initiated by Nicolas Kern (ACSEO).

Version: 2.0 Compatibility: Symfony ^5.0, Twig >= 1.5.0

Installation using Composer

$ composer install acseo/fast-show-generator-bundle

Composer will install the bundle to your project's vendor/ACSEO directory.

How To Use

Annotation

In entity :

use ACSEO\FastShowGeneratorBundle\Annotations as ACSEOFastShowGeneratorBundle;

For each property :

* @ACSEOFastShowGenerator\Show(label="My Property 1", show=true, groups={"default"})

In controller :

$fastShow = $this->get('acseo_fast_show_generator.driver.annotation');

$fastShow->setEntity(new MyEntity());
$fastShow->setGroup('default');
$fastShow->setClassMetadata($em->getClassMetadata("ACSEOMyBundle:MyEntity"));

$fastShowData = $fastShow->getShowableData();

YAML :

Create the a file in your bundle for each entity :

#ACSEO/Bundle/MyBundle/Resources/config/fastshowgenerator/MyEntity.default.fastshowgenerator.yml

ACSEO\Bundle\MyBundle\Entity\MyEntity:
    Columns:
        myProperty:
            label: My Property 1
            show: true
            groups: {"default"}
        myProperty2:
            label: My Property 2
            show: true
            groups: {"default"}

In controller :

        $fastShow = $this->get('acseo_fast_show_generator.driver.yaml');

        $fastShow->setEntity($entity);
        $fastShow->setGroup('default');
        $fastShow->setClassMetadata($em->getClassMetadata($this->getEntityName()));

        $fastShowData = $fastShow->getShowableData();

Available options :

label : string - optional - if not set, uses the property name capitalized
show : boolean - optional - if not set, value is assumed to be true
groups : array - optional - if not set, group name is "default"

Template

Now, in your twig file, something like that :

    <table class="table table-striped">
      <tbody>
        {% for propertyName, propertyValue in data %}
            <tr><td>{{ propertyName }}</td><td>{{ propertyValue }}</td></tr>
        {% endfor %}
      </tbody>
    </table>