Xml Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require desperado/xml-bundle
   

   Add to AppKernel.php:

   new Desperado\XmlBundle\DesperadoXmlBundle(),
   

2. First Use Case: Inject XmlEditor or XmlReader via dependency injection:

   use Desperado\XmlBundle\Model\XmlEditor;
   use Desperado\XmlBundle\Model\XmlReader;
   
   class MyController extends Controller
   {
       public function __construct(XmlEditor $xmlEditor, XmlReader $xmlReader)
       {
           $this->xmlEditor = $xmlEditor;
           $this->xmlReader = $xmlReader;
       }
   }
   

3. Quick Example: Generate XML from an array:

   $data = ['book' => ['title' => 'Laravel', 'author' => 'Taylor']];
   $xml = $this->xmlEditor->generate($data, 'books');
   

Implementation Patterns

Core Workflows

1. XML Generation:

   • Use XmlGenerator for structured XML output:

     $generator = $this->get('desperado_xml.model.xml_generator');
     $xml = $generator->generate(['root' => ['child' => 'value']], 'root');
     

   • Customize with XmlEditor for dynamic manipulation:

     $this->xmlEditor->addAttribute('root', 'version', '1.0');
     

2. XML Parsing:

   • Read XML into arrays with XmlReader:

     $xmlString = '<root><child>value</child></root>';
     $data = $this->xmlReader->parse($xmlString);
     

   • Handle namespaces via XmlPrep (if available):

     $this->xmlReader->setNamespace('ns', 'http://example.com');
     

3. Integration with Laravel:

   • Bind services in AppServiceProvider:

     public function register()
     {
         $this->app->bind('desperado_xml.model.xml_reader', function ($app) {
             return new XmlReader();
         });
     }
     

   • Use in controllers/services:

     public function processXml(Request $request)
     {
         $xml = $request->xml; // Assume XML is passed
         $data = $this->xmlReader->parse($xml);
         // Process $data...
     }
     

4. Validation:

   • Combine with Laravel Validation for XML schemas:

     $validator = Validator::make($data, [
         'root.child' => 'required|string',
     ]);
     

Gotchas and Tips

Pitfalls

1. Deprecated Bundle:

   • Last release in 2015; test thoroughly in Laravel/Symfony 5+.
   • May conflict with modern PHP versions (e.g., SimpleXML deprecations).

2. Namespace Issues:

   • XML namespaces require explicit handling via XmlPrep (if exposed).
   • Default behavior may strip namespaces; configure via:

     $this->xmlReader->setPreserveNamespaces(true);
     

3. Performance:

   • Large XML files may cause memory issues. Stream processing (e.g., SimpleXMLIterator) is recommended for big files.

4. Laravel-Specific Quirks:

   • Symfony DIC services must be manually bound (not auto-discovered).
   • Use app('desperado_xml.model.xml_reader') for direct access.

Debugging Tips

1. Validate XML:

   • Use libxml_use_internal_errors(true) before parsing:

     libxml_use_internal_errors(true);
     $data = $this->xmlReader->parse($xml);
     $errors = libxml_get_errors();
     

   • Clear errors after use:

     libxml_clear_errors();
     

2. Logging:

   • Log raw XML/input for debugging:

     \Log::debug('XML Input:', ['xml' => $xmlString]);
     

3. Fallbacks:

   • For critical XML parsing, implement a fallback (e.g., DOMDocument):

     try {
         $data = $this->xmlReader->parse($xml);
     } catch (\Exception $e) {
         $data = $this->fallbackXmlParser($xml);
     }
     

Extension Points

1. Custom Generators:

   • Extend XmlGenerator for domain-specific rules:

     class CustomXmlGenerator extends XmlGenerator
     {
         public function generate(array $data, string $root)
         {
             // Add custom logic
             return parent::generate($data, $root);
         }
     }
     

   • Register in AppServiceProvider:

     $this->app->bind('desperado_xml.model.xml_generator', function () {
         return new CustomXmlGenerator();
     });
     

2. Event Listeners:

   • Hook into XML generation/parsing via Symfony events (if supported):

     // Example (hypothetical event)
     $dispatcher->addListener('xml.generate', function ($event) {
         $event->getXml()->addAttribute('custom', 'value');
     });
     

3. Configuration:

   • Override default settings via bundle config (if supported):

     # config/packages/desperado_xml.yaml
     desperado_xml:
         preserve_namespaces: true
         indent_output: true