Getting Started

Minimal Setup

Installation

composer require 20steps/autotables-bundle

Add to config/bundles.php:

return [
    // ...
    Twentysteps\AutoTablesBundle\TwentystepsAutoTablesBundle::class => ['all' => true],
];

Basic Configuration Create a YAML config file (e.g., config/packages/twentysteps_autotables.yaml):
```
twentysteps_autotables:
    default:
        theme: bootstrap3
        editable: true
```

First Use Case: Auto-Generated Table for an Entity Annotate your entity (e.g., src/Entity/User.php):

use Twentysteps\AutoTablesBundle\Annotation\AutoTable;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 * @AutoTable()
 */
class User
{
    // ...
}

Render the Table in a Controller

use Twentysteps\AutoTablesBundle\TwentystepsAutoTablesBundle;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class UserController extends AbstractController
{
    /**
     * @Route("/users", name="user_list")
     */
    public function listAction()
    {
        return $this->render('user/list.html.twig', [
            'entity' => new User(),
        ]);
    }
}

Display in Twig
```
{{ autotable(entity) }}
```

Implementation Patterns

Workflows

Standard CRUD Workflow
- List: Use {{ autotable(entity) }} in Twig.
- Edit: Enable editable: true in config and annotate columns:
```
/**
 * @AutoTable\Column(editable=true)
 */
private $name;
```
- Custom Actions: Use actions in annotations:
```
/**
 * @AutoTable\Action(type="delete", label="Delete")
 */
```
Integration with Doctrine Repositories
- Pass a repository to the autotable Twig function:
```
{{ autotable(repository.findAll(), entity) }}
```
Custom CRUD Services
- Implement Twentysteps\AutoTablesBundle\Service\CrudServiceInterface and configure in services.yaml:
```
services:
    App\Service\CustomUserCrudService:
        tags: ['twentysteps_autotables.crud_service']
```

Theming and Styling

Override templates in templates/bundles/twentystepsautotables/.

Customize via YAML config:

twentysteps_autotables:
    default:
        theme: jqueryui
        table_options:
            paging: true
            searching: true

Dynamic Column Configuration

Use AutoTable\Column annotations for per-property control:

/**
 * @AutoTable\Column(label="Full Name", width="200px", sortable=false)
 */
private $fullName;

ManyToOne Relationships

Auto-initialize with AutoTable\ManyToOne:

/**
 * @AutoTable\ManyToOne(targetEntity="App\Entity\Role", property="name")
 */
private $role;

Integration Tips

Leverage Events

Listen to twentysteps_autotables.pre_build to modify table configuration dynamically:

use Twentysteps\AutoTablesBundle\Event\PreBuildEvent;

$eventDispatcher->addListener('twentysteps_autotables.pre_build', function (PreBuildEvent $event) {
    $event->getTable()->addColumn('custom_column', 'Custom Value');
});

Custom Validation

Use Symfony’s validation constraints alongside AutoTable\Column:

/**
 * @AutoTable\Column(editable=true)
 * @Assert\NotBlank()
 */
private $email;

AJAX Handling

Configure routes for AJAX calls in routing.yaml:

twentysteps_autotables:
    resource: "@TwentystepsAutoTablesBundle/Resources/config/routing.xml"
    prefix: /api

Localization
- Translate labels and messages via Symfony’s translation system:
```
{{ autotable(entity, {'labels': {'name': 'app.user.name'}}) }}
```

Gotchas and Tips

Pitfalls

Annotation Processing
- Ensure doctrine/annotations is installed and cached:
```
php bin/console doctrine:cache:clear-metadata
```
- Fix: Clear cache after adding new annotations.
JavaScript Conflicts
- DataTables and jQuery-UI/Bootstrap may conflict with other JS libraries.
- Fix: Load AutoTables JS last or use dataTablesOptions to isolate:
```
twentysteps_autotables:
    default:
        dataTablesOptions:
            ajax: { url: '/api/users' }
```
Editable Fields and CSRF
- Editable fields may fail due to missing CSRF tokens.
- Fix: Ensure csrf_token is included in your form templates or use editable_options:
```
twentysteps_autotables:
    default:
        editable_options:
            csrf: true
```
ManyToOne Auto-Initialization
- Auto-initialization may not work if the target entity lacks a name or id property.
- Fix: Explicitly define property in AutoTable\ManyToOne:
```
/**
 * @AutoTable\ManyToOne(targetEntity="App\Entity\Role", property="title")
 */
private $role;
```
Performance with Large Datasets
- AutoTables loads all data by default, which can be slow.
- Fix: Use server-side processing via dataTablesOptions:
```
twentysteps_autotables:
    default:
        dataTablesOptions:
            serverSide: true
            processing: true
```

Debugging

Check Generated HTML/JS
- Inspect the rendered table in browser dev tools to verify DataTables initialization.
Enable Debug Mode
- Set debug: true in config to log table generation:
```
twentysteps_autotables:
    debug: true
```
Validate Annotations
- Use php bin/console debug:container Twentysteps\AutoTablesBundle\Annotation\AutoTable to check if annotations are processed.

Extension Points

Custom Column Types
- Extend Twentysteps\AutoTablesBundle\Column\AbstractColumn to create custom columns (e.g., for dates or JSON).
Override Templates
- Copy templates/bundles/twentystepsautotables/table.html.twig to your project and modify as needed.
Add Custom Actions
- Implement Twentysteps\AutoTablesBundle\Action\ActionInterface and register via services:
```
services:
    App\Action\CustomAction:
        tags: ['twentysteps_autotables.action']
```

Modify Table Configuration

Use the twentysteps_autotables.post_build event to alter the table after generation:

$eventDispatcher->addListener('twentysteps_autotables.post_build', function (PostBuildEvent $event) {
    $event->getTable()->setOption('order', [[0, 'desc']]);
});

Integrate with Forms
- Use AutoTable\Form\Type\AutoTableType to generate forms dynamically:
```
{{ form_start(form) }}
    {{ form_widget(form) }}
{{ form_end(form) }}
```

Autotables Bundle Laravel Package