Common Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the bundle via Composer:

   composer require ano/common-bundle
   

   Register it in config/bundles.php (Symfony 4+):

   return [
       // ...
       Ano\CommonBundle\AnoCommonBundle::class => ['all' => true],
   ];
   

2. First Use Case The bundle lacks explicit documentation, but its util focus suggests common helpers. Check:

   • Service Container: Look for registered services in Ano\CommonBundle\DependencyInjection\.
   • Traits/Helpers: Inspect src/Ano/CommonBundle/ for reusable utilities (e.g., string manipulation, data masking).
   • Example: If it includes anonymization tools (implied by "Anonymation"), test basic data masking:

     use Ano\CommonBundle\Utils\Anonymizer;
     
     $anonymizer = $this->container->get('ano.anonymizer');
     $maskedEmail = $anonymizer->maskEmail('user@example.com'); // Hypothetical method
     

Implementation Patterns

Core Workflows

1. Service Integration

   • Inject the bundle’s services (e.g., AnoCommonBundle services) via dependency injection:

     use Ano\CommonBundle\Service\CommonService;
     
     class MyController {
         public function __construct(private CommonService $commonService) {}
     }
     

   • Symfony Config: Override default behavior via config/packages/ano_common.yaml (if supported).

2. Utility Reuse

   • Traits: Extend classes with bundle-provided traits (e.g., Anonymizable):

     use Ano\CommonBundle\Traits\Anonymizable;
     
     class User {
         use Anonymizable;
         public function anonymize(): void { /* ... */ }
     }
     

   • Helper Functions: Use static methods (if available) for one-off tasks:

     $hashedValue = \Ano\CommonBundle\Utils\StringUtils::hash('sensitive-data');
     

3. Event Listeners

   • Hook into bundle events (if documented) for custom logic:

     // config/services.yaml
     services:
         App\EventListener\AnonymizationListener:
             tags:
                 - { name: 'kernel.event_listener', event: 'ano.common.event', method: 'onAnonymize' }
     

Gotchas and Tips

Pitfalls

1. Undocumented Features

   • The bundle lacks stars/dependents, suggesting unproven stability. Test thoroughly in a staging environment.
   • No Clear API: Methods like maskEmail are hypothetical—verify actual methods via IDE autocompletion or php artisan debug:container.

2. Symfony Version Lock

   • Requires Symfony 2.x ("symfony/framework-bundle":"2.*"). Upgrade risks: May not support Symfony 5/6+ without patches.

3. Missing Configuration

   • No config/ directory in the repo implies default-only behavior. Customization may require extending classes directly.

Debugging Tips

• Service Dumping:

  php bin/console debug:container | grep ano
  

• Log Utilities: If the bundle includes logging helpers, use:

  $this->get('logger')->debug('Anonymization triggered', ['data' => $sensitiveData]);
  

Extension Points

1. Override Services

   • Extend bundle services via compiler passes or custom definitions:

     # config/services.yaml
     services:
         ano.common_service:
             class: App\Service\CustomCommonService
             decorates: 'ano.common_service'
     

2. Add New Utilities

   • Fork the repo and extend Ano\CommonBundle\Utils with your own helpers, then publish via Composer.

3. Event-Driven Extensions

   • Dispatch custom events (if the bundle supports it) to integrate with other systems:

     $event = new \Ano\CommonBundle\Event\AnonymizationEvent($data);
     $this->get('event_dispatcher')->dispatch($event, 'ano.common.event');