Dafuer Jpgraph Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the bundle to your composer.json:

   composer require dafuer/dafuer-jpgraph-bundle
   

   Enable it in config/bundles.php:

   Dafuer\JpgraphBundle\DafuerJpgraphBundle::class => ['all' => true],
   

2. Configuration Publish the default config (if needed):

   php bin/console dafuer:jpgraph:install
   

   Verify config/packages/dafuer_jpgraph.yaml exists.

3. First Use Case Generate a basic line plot via a controller:

   use Dafuer\JpgraphBundle\Controller\GraphController;
   
   class MyController extends AbstractController {
       public function showGraph(GraphController $graphController) {
           $data = [1, 2, 3, 4, 5];
           return $graphController->linePlot($data, 'My Line Graph');
       }
   }
   

   Route it:

   # config/routes.yaml
   my_graph:
       path: /graph
       controller: App\Controller\MyController::showGraph
   

Implementation Patterns

Core Workflows

1. Static Graphs Use GraphController actions (linePlot, barPlot, piePlot) for pre-defined charts:

   // Bar plot with custom labels
   return $graphController->barPlot(
       [10, 20, 30],
       ['Jan', 'Feb', 'Mar'],
       'Monthly Sales'
   );
   

2. Dynamic AJAX Graphs Extend Dafuer\JpgraphBundle\Event\GraphEvent to modify plots on-the-fly:

   // src/EventListener/MyGraphListener.php
   class MyGraphListener implements EventSubscriberInterface {
       public static function getSubscribedEvents() {
           return ['dafuer.jpgraph.pre_render'];
       }
   
       public function onPreRender(GraphEvent $event) {
           $event->getGraph()->setTitle('Dynamic Title');
       }
   }
   

3. Custom Styling Override default styles via YAML config:

   # config/packages/dafuer_jpgraph.yaml
   dafuer_jpgraph:
       styles:
           line:
               color: '#FF0000'
               width: 2
   

4. Data Integration Fetch data from services/repositories:

   public function dynamicDataPlot(GraphController $graphController, DataService $dataService) {
       $data = $dataService->getChartData();
       return $graphController->linePlot($data, 'Live Data');
   }
   

Integration Tips

• Twig Integration: Pass the graph object to templates:

  <img src="{{ path('my_graph') }}" alt="Graph">
  

• Caching: Use Symfony’s cache system for static graphs:

  # config/packages/dafuer_jpgraph.yaml
  dafuer_jpgraph:
      cache_enabled: true
      cache_lifetime: 3600
  

• API Endpoints: Return graphs as binary responses:

  return new BinaryFileResponse($graph->stroke(), 200, [
      'Content-Type' => 'image/png',
  ]);
  

Gotchas and Tips

Pitfalls

1. Bundle Maturity

   • The package is under development (per README). Test thoroughly in staging.
   • Expect breaking changes; monitor the GitHub repo for updates.

2. Configuration Overrides

   • Custom styles in dafuer_jpgraph.yaml do not merge with defaults—they replace them. Use !merge tags if needed:

     styles: * = %dafuer_jpgraph.styles%
     styles:
         line:
             width: 3  # Override only width
     

3. AJAX Limitations

   • Dynamic graphs via AJAX require CSRF protection in Symfony 4.3+. Add this to your event listener:

     $event->getRequest()->headers->set('X-Requested-With', 'XMLHttpRequest');
     

4. Memory Issues

   • Complex graphs may hit PHP’s memory_limit. Increase it temporarily:

     php -d memory_limit=512M bin/console ...
     

Debugging

• Graph Not Rendering? Check the jpgraph directory in var/cache/ for generated files. Clear cache:

  php bin/console cache:clear
  

• Style Not Applying? Verify the YAML key matches the event name (e.g., line for linePlot).

Extension Points

1. Custom Graph Types Extend Dafuer\JpgraphBundle\Graph\AbstractGraph:

   class CustomGraph extends AbstractGraph {
       protected function build() {
           $this->graph->setTheme('custom');
           // Add custom logic
       }
   }
   

   Register it in services:

   services:
       App\Graph\CustomGraph:
           tags: ['dafuer.jpgraph.graph']
   

2. Event Subscribers Hook into dafuer.jpgraph.pre_render or dafuer.jpgraph.post_render for cross-cutting concerns (e.g., logging, analytics).

3. Data Transformers Create a service to pre-process data:

   class DataTransformer {
       public function transform(array $data): array {
           return array_map(fn($v) => $v * 10, $data);
       }
   }
   

   Inject it into your controller or event listener.

Pro Tips

• Use GraphEvent for Reusability Share graph configurations across controllers by modifying the event object.
• Leverage Symfony’s Parameter Bag Pass runtime data via GraphEvent:

  $event->setParameter('theme', 'modern');
  

• Test with jpgraph CLI Validate graphs independently:

  vendor/bin/jpgraph --help