Util Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require demontpx/util-bundle
   

   Ensure Demontpx\UtilBundle\DemontpxUtilBundle() is registered in config/bundles.php (Symfony 4+) or AppKernel.php (Symfony 3).

2. First Use Case: Check the Utils class for common helpers. Example:

   use Demontpx\UtilBundle\Utils;
   
   // Format a date (if included)
   $formattedDate = Utils::formatDate(new \DateTime(), 'Y-m-d');
   
   // Validate an email (if included)
   $isValid = Utils::isValidEmail('test@example.com');
   

3. Where to Look First:

   • Browse src/Utils.php for available static methods.
   • Check Resources/config/services.yaml for services (if any).
   • Review README.md for undocumented features (e.g., Twig extensions, event listeners).

Implementation Patterns

Common Workflows

1. Data Validation:

   // Validate input (if methods exist)
   if (Utils::isValidPhone('+1234567890')) {
       // Proceed
   }
   

2. String Manipulation:

   // Slugify a string (if included)
   $slug = Utils::slugify('Hello World!');
   
   // Truncate text
   $shortened = Utils::truncate('Long text...', 20);
   

3. Array Utilities:

   // Merge arrays recursively (if included)
   $merged = Utils::deepMerge($array1, $array2);
   
   // Filter empty values
   $cleaned = Utils::removeEmpty($array);
   

4. Integration with Symfony:

   • Twig Extensions: If the bundle includes Twig filters (e.g., {{ 'text'|slugify }}), register them in twig.config:

     # config/packages/twig.yaml
     twig:
         globals:
             util: '@demontpx_util.utils'
     

   • Event Subscribers: Check for listeners in Resources/config/services.yaml and extend them.

5. Dependency Injection: If the bundle provides services, autowire them:

   use Demontpx\UtilBundle\Service\SomeService;
   
   public function __construct(private SomeService $someService) {}
   

Gotchas and Tips

Pitfalls

1. Undocumented Methods:

   • The bundle lacks a clear API reference. Test methods in Utils before relying on them (e.g., Utils::formatDate() may not exist).
   • Debugging Tip: Use get_class_methods(\Demontpx\UtilBundle\Utils::class) to list available methods dynamically.

2. Symfony Version Compatibility:

   • The bundle may not support Symfony 6+ features (e.g., autoconfigure: true in services.yaml). Verify compatibility by checking composer.json constraints.

3. No Configuration:

   • If the bundle expects config (e.g., default locales, API keys), ensure you’ve set it in config/packages/demontpx_util.yaml (if the file exists).

4. Twig Integration:

   • If Twig filters/extensions are broken, clear the cache:

     php bin/console cache:clear
     

Tips

1. Extend the Bundle:

   • Override the Utils class in your project to add custom methods:

     namespace App\Utils;
     use Demontpx\UtilBundle\Utils as BaseUtils;
     
     class Utils extends BaseUtils {
         public static function customMethod() { ... }
     }
     

2. Testing:

   • Mock the Utils class in tests to isolate logic:

     $this->getMockBuilder(\Demontpx\UtilBundle\Utils::class)
          ->disableOriginalConstructor()
          ->onlyMethods(['methodToMock'])
          ->getMock();
     

3. Performance:

   • Avoid calling static methods in tight loops (e.g., Utils::isValidEmail() inside a foreach). Cache results if possible.

4. Contributing:

   • Since the bundle is lightweight, consider forking and extending it for your team’s needs (MIT license allows modifications).

5. Fallback Logic:

   • Wrap bundle methods in try-catch blocks for graceful degradation:

     try {
         $result = Utils::someMethod();
     } catch (\BadMethodCallException $e) {
         // Fallback to custom logic
         $result = self::fallbackMethod();
     }