Download the PHP package dolmatovdev/laravel-x12-parser without Composer

Laravel X12 Parser Package

A comprehensive Laravel package for processing X12 files with validation, parsing, and JSON conversion capabilities. Built with clean architecture principles and optimized for maintainability.

Author: Danila Dolmatov (LinkedIn)

🚀 Features

• ANSI X12 File Parsing: Parse ANSI files into structured data
• Validation: Comprehensive validation for different transaction types
• JSON Conversion: Convert ANSI files to/from JSON format
• File Building: Generate ANSI files from structured data
• Transaction Support: Currently supports 270 (Eligibility/Benefit Inquiry)
• Extensible: Easy to add support for other transaction types
• Laravel Integration: Full Laravel integration with facades and service providers
• Console Commands: Artisan commands for file processing operations
• Input Sanitization: Advanced security with input validation and sanitization
• Custom File Naming: Dynamic file naming with placeholders and patterns
• Clean Architecture: Optimized codebase with shared traits and reduced duplication
• Configuration-Driven: Flexible configuration system with fallbacks

📋 Requirements

• PHP 8.1+
• Laravel 10.0+ or 11.0+

📦 Installation

1. Install via Composer:

2. Publish Configuration (Optional):

3. Publish Stubs (Optional):

🔧 Configuration

The package configuration is located in config/x12-parser.php:

🎯 Usage

Using the Facade

Using Dependency Injection

Using DTOs

Using Transaction-Specific Delimiters

Console Commands

The package provides several Artisan commands for X12 file processing:

Available Commands:

• x12:parse {file} - Parse X12 file to JSON

  • --output= - Save output to file (optional)
  • --pretty - Pretty print JSON output

• x12:validate {file} - Validate X12 file structure and content

• x12:build {json-file} - Build X12 file from JSON data
  • --output= - Save output to file (optional)
  • --type=270 - Transaction type (default: 270)

Using Custom File Naming

📄 Supported Transaction Types

270 - Eligibility/Benefit Inquiry

The 270 transaction is used to inquire about a subscriber's eligibility and benefits.

Required Segments:

• ISA - Interchange Control Header
• GS - Functional Group Header
• ST - Transaction Set Header
• BHT - Beginning of Hierarchical Transaction
• HL - Hierarchical Level
• NM1 - Subscriber Name
• SE - Transaction Set Trailer
• GE - Functional Group Trailer
• IEA - Interchange Control Trailer

Optional Segments:

• TRN - Subscriber Trace Number
• DMG - Subscriber Demographics
• DTP - Date/Time Reference
• EQ - Subscriber Eligibility or Benefit Inquiry
• QTY - Quantity

Sample 270 File:

🧪 Testing

Run the test suite:

Test Examples

🔍 Validation

The package provides comprehensive validation for ANSI files:

Validation Features:

• Segment Order: Ensures segments appear in the correct order
• Required Segments: Validates all required segments are present
• Element Format: Validates element formats and lengths
• Business Rules: Enforces business logic specific to each transaction type
• Input Sanitization: Removes control characters and validates X12-safe content

Validation Result:

🏗️ Architecture

The package follows clean architecture principles with optimized code organization:

Key Architectural Improvements:

• Shared Traits: HasDelimiters and HasConfig traits eliminate code duplication
• Configuration-Driven: All services use centralized configuration with fallbacks
• Clean Separation: Clear separation between parsing, validation, and building
• Extensible Design: Easy to add new transaction types and validators
• Optimized Performance: Reduced memory footprint and improved execution speed

🔧 Extending the Package

Adding New Transaction Types

1. Create Validator:

2. Update Configuration:

The ValidatorFactory will automatically load the new validator from configuration.

📚 API Reference

AnsiParserService

Parser & X12Builder

Both classes use the HasDelimiters trait, providing these methods:

ValidationResult

Eligibility270DTO

🚀 Performance & Optimization

Recent Improvements:

• Code Duplication Reduced: ~7% reduction in total lines of code
• Shared Traits: Eliminated duplicate delimiter and configuration handling
• Optimized Configuration: Centralized config access with intelligent fallbacks
• Improved Memory Usage: Better resource management and reduced overhead
• Enhanced Testability: Instance-based services instead of static methods

Best Practices:

• Use Configuration: Leverage the configuration system for customization
• Leverage Traits: Extend functionality using the provided traits
• Input Sanitization: Always use the built-in sanitization for security
• Error Handling: Implement proper exception handling for production use

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

📄 License

This package is open-sourced software licensed under the MIT License. See the LICENSE file for the full license text.

MIT License

License Summary

• License Type: MIT License
• Copyright: © 2024 Danila Dolmatov
• Permissions:
  • ✅ Commercial use
  • ✅ Modification
  • ✅ Distribution
  • ✅ Private use
• Limitations:
  • ❌ No liability
  • ❌ No warranty
• Conditions: Include license and copyright notice

For more information about the MIT License, visit opensource.org/licenses/MIT.

🔗 Links

• X12.org - Official X12 standards
• 270 Transaction Specification
• Laravel Documentation

🆘 Support

For support, please open an issue on GitHub or contact Danila Dolmatov on LinkedIn.