Symfony is a set ofreusable PHP components and based on web projects, as well as implementing php frameworks for web applications.

10 common gotchas in symfony

1. Cache Issues

   • Forgetting to clear the cache after changes can cause unexpected behavior.

   1	php bin/console cache:clear

2. Configuration File Typos

   • A typo in YAML or XML config files can break your app and be hard to spot.

config/services.yaml

services: app.my_service: class: App\Service\MyService

a typo in ‘class’ or indentation will cause errors

1
2
3
4
5
6
7

3. **Service Autowiring Pitfalls**
- Autowiring may not work as expected if type hints or service definitions are missing.

```php
// Missing type hint or not registered as a service
public function __construct(MyService $service) { ... }

4. Environment Variable Handling

   • Symfony uses .env files, but environment variables may not be loaded as expected in all contexts.

.env

DATABASE_URL=“mysql://user:pass@localhost/db”

1
2
3

```php
$dbUrl = $_ENV['DATABASE_URL'] ?? null;

5. Doctrine Lazy Loading

   • Lazy loading entities can cause performance issues or unexpected queries.

   1 2 3 4 5

   // Triggers extra queries $posts = $user->getPosts(); foreach ($posts as $post) { echo $post->getTitle(); }

6. Twig Template Errors

   • A typo in a Twig template can cause a runtime error that’s not always obvious.

   1 2	{# templates/base.html.twig #} {{ user.nmae }} {# Typo: should be 'name' #}

7. Route Name Conflicts

   • Duplicate route names will cause routing errors.

config/routes.yaml

home: path: / controller: App\Controller\HomeController::index home: path: /main controller: App\Controller\MainController::index

duplicate ‘home’ route name

1
2
3
4
5
6
7

8. **CSRF Token Handling**
- Forgetting to include or validate CSRF tokens in forms can lead to security issues.

```twig
{# In your form #}
<input type="hidden" name="_token" value="{{ csrf_token('item') }}">

1
2
3
4
5
6

// In controller
if (
  $this->isCsrfTokenValid('item', $request->request->get('_token'))
) {
  // valid
}

9. Asset Management

   • Not running assets:install or encore after asset changes can break your frontend.

   1 2	php bin/console assets:install yarn encore dev

10. Bundle Version Compatibility

    • Using bundles not compatible with your Symfony version can cause subtle bugs.

    1	composer require some/bundle:^5.0 # Check compatibility with your Symfony version

These are important to keep in mind so that you avoid common pitfalls when working with Symfony!