Order Cms Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require dywee/order-cms-bundle
   

   Ensure DyweeCoreBundle is installed (required for admin features).

2. Register Bundle Add to config/bundles.php:

   return [
       // ...
       Dywee\OrderCMSBundle\DyweeOrderCMSBundle::class => ['all' => true],
   ];
   

3. Routing Add to config/routes.yaml:

   dywee_order_cms:
       resource: "@DyweeOrderCMSBundle/Controller/"
       type: annotation
       prefix: /admin/orders  # Adjust prefix as needed
   

4. First Use Case Access /admin/orders to view the default order management dashboard. The bundle assumes integration with DyweeCoreBundle for admin UI scaffolding.

Implementation Patterns

Core Workflows

1. Order Management

   • CRUD Operations: Use the annotated controllers (e.g., OrderController) for listing, creating, updating, and deleting orders.
   • Example Workflow:

     // Fetch orders via service (if exposed)
     $orders = $this->get('dywee_order_cms.order_service')->findAll();
     

     Note: Check src/DependencyInjection/DyweeOrderCMSBundleExtension.php for service definitions.

2. Integration with DyweeCoreBundle

   • Leverage DyweeCoreBundle's admin grid system to customize order listings:

     # config/packages/dywee_core.yaml
     dywee_core:
         admin:
             grids:
                 order_grid:
                     model: Dywee\OrderCMSBundle\Entity\Order
                     fields: [id, customer, total, status, createdAt]
     

3. Entity Extensions

   • Extend the default Order entity (located in Entity/Order.php) by overriding it in your project:

     // src/Entity/Order.php
     namespace App\Entity;
     use Dywee\OrderCMSBundle\Entity\Order as BaseOrder;
     
     class Order extends BaseOrder {
         // Custom fields/methods
     }
     

   • Update config/packages/doctrine.yaml to point to your extended entity.

4. Event Listeners

   • Attach listeners to order lifecycle events (e.g., order.pre_create):

     // src/EventListener/OrderListener.php
     namespace App\EventListener;
     use Dywee\OrderCMSBundle\Event\OrderEvents;
     
     class OrderListener {
         public function onOrderCreate(OrderEvent $event) {
             // Logic here
         }
     }
     

     Register in services.yaml:

     services:
         App\EventListener\OrderListener:
             tags:
                 - { name: kernel.event_listener, event: order.pre_create, method: onOrderCreate }
     

5. API Exposure (Optional)

   • Use Symfony’s serializers to expose order data via API:

     use Symfony\Component\Serializer\Annotation\Groups;
     
     class Order {
         #[Groups(['order:read'])]
         private $id;
         // ...
     }
     

Gotchas and Tips

Pitfalls

1. Missing DyweeCoreBundle

   • The bundle requires DyweeCoreBundle for admin features. Install it first:

     composer require dywee/dywee-core-bundle
     

2. Entity Overrides

   • If extending Order entity, ensure your class is autoloaded and Doctrine is configured to use it. Clear cache after changes:

     php bin/console cache:clear
     

3. Routing Conflicts

   • The default prefix: / in routing may clash with other bundles. Use a namespace-specific prefix (e.g., /admin/orders).

4. Undocumented Services

   • The bundle lacks clear documentation for services. Inspect src/DependencyInjection/ for available services and their configurations.

5. Database Schema

   • The bundle assumes a default schema. Customize migrations or entity mappings if your database structure differs.

Debugging Tips

1. Check Controller Annotations

   • Verify that annotated controllers (e.g., OrderController) are properly loaded. Run:

     php bin/console debug:router | grep dywee_order_cms
     

2. Enable Debug Mode

   • Set APP_DEBUG=true in .env to surface errors related to missing configurations or services.

3. Event Dispatching

   • If events (e.g., order.pre_create) aren’t firing, ensure:
     • The listener is tagged correctly in services.yaml.
     • The event class is imported from Dywee\OrderCMSBundle\Event.

4. Doctrine Entities

   • For entity issues, validate your overrides with:

     php bin/console doctrine:schema:validate
     

Extension Points

1. Custom Fields

   • Add fields to the Order entity and update the admin grid in dywee_core.yaml:

     dywee_core:
         admin:
             grids:
                 order_grid:
                     fields: [id, customer, custom_field]
     

2. Order Status Workflow

   • Extend the status system by overriding the OrderStatus entity or adding transitions via state machines (e.g., Symfony State Machine Bundle).

3. API Resources

   • Create custom API resources for orders using Symfony’s ApiPlatform or Serializer components.

4. Testing

   • Write functional tests for order-related endpoints. Example:

     public function testOrderListing() {
         $client = static::createClient();
         $client->request('GET', '/admin/orders');
         $this->assertResponseIsSuccessful();
     }