用于创建/操作固定宽度文本文件的 PHP 库

Question

我们有一个 Web 应用程序可以执行时间跟踪、工资单和 HR。因此，我们必须编写大量固定宽度的数据文件才能导出到其他系统(国家税务申报、ACH 文件等)。有谁知道一个好的库，您可以在其中定义记录类型/结构，然后在 OOP 范例中对其进行操作？

这个想法将是一个类，您可以提交规范，然后使用所述规范的实例。即:

$icesa_file = new FixedWidthFile();
$icesa_file->setSpecification('icesa.xml');
$icesa_file->addEmployer( $some_data_structure );

icesa.xml 是一个包含规范的文件，尽管您可以使用 OOP 调用自己定义它:

$specification = new FixedWidthFileSpecification('ICESA');
$specification->addRecordType(
    $record_type_name = 'Employer',
    $record_fields = array(
         array('Field Name', Width, Vailditation Type, options)
         )
     );

编辑: 我不是在寻找关于如何编写这样一个库的建议——我只是想知道是否已经存在。谢谢!!

Answer 1

我不知道有哪个库可以完全满足您的需求，但是滚动您自己的类来处理这个问题应该是相当简单的。假设您主要对以这些格式编写数据感兴趣，我会使用以下方法:

(1) 为固定宽度的字符串编写一个轻量级的格式化程序类。它必须支持用户定义的记录类型，并且在允许的格式方面应该是灵活的

(2) 为您使用的每种文件格式实例化此类并添加所需的记录类型

(3) 使用此格式化程序来格式化您的数据

按照您的建议，您可以在 XML 中定义记录类型并在步骤 (2) 中加载此 XML 文件。我不知道您对 XML 的经验如何，但根据我的经验，XML 格式经常会引起很多麻烦(可能是由于我自己对 XML 的无能)。如果您打算只在 PHP 程序中使用这些类，那么在 XML 中定义格式并没有什么好处。如果您还需要在许多其他应用程序中使用文件格式定义，那么使用 XML 是一个不错的选择。

为了说明我的想法，我认为你会如何使用这个建议的格式化程序类:

<?php
include 'FixedWidthFormatter.php' // contains the FixedWidthFormatter class
include 'icesa-format-declaration.php' // contains $icesaFormatter
$file = fopen("icesafile.txt", "w");

fputs ($file, $icesaFormatter->formatRecord( 'A-RECORD', array( 
    'year' => 2011, 
    'tein' => '12-3456789-P',
    'tname'=> 'Willie Nelson'
)));
// output: A2011123456789UTAX     Willie Nelson                                     

// etc...

fclose ($file);
?>

文件 icesa-format-declaration.php 可以包含格式的声明，如下所示:

<?php
$icesaFormatter = new FixedWidthFormatter();
$icesaFormatter->addRecordType( 'A-RECORD', array(
    // the first field is the record identifier
    // for A records, this is simply the character A
    'record-identifier' => array(
        'value' => 'A',  // constant string
        'length' => 1 // not strictly necessary
                      // used for error checking
    ),
    // the year is a 4 digit field
    // it can simply be formatted printf style
    // sourceField defines which key from the input array is used
    'year' =>  array(
        'format' => '% -4d',  // 4 characters, left justified, space padded
        'length' => 4,
        'sourceField' => 'year'
    ),
    // the EIN is a more complicated field
    // we must strip hyphens and suffixes, so we define
    // a closure that performs this formatting
    'transmitter-ein' => array(
        'formatter'=> function($EIN){
            $cleanedEIN =  preg_replace('/\D+/','',$EIN); // remove anything that's not a digit
            return sprintf('% -9d', $cleanedEIN); // left justified and padded with blanks
        },
        'length' => 9,
        'sourceField' => 'tein'
    ),
    'tax-entity-code' => array(
        'value' => 'UTAX',  // constant string
        'length' => 4
    ),
    'blanks' => array(
        'value' => '     ',  // constant string
        'length' => 5
    ),
    'transmitter-name' =>  array(
        'format' => '% -50s',  // 50 characters, left justified, space padded
        'length' => 50,
        'sourceField' => 'tname'
    ),
    // etc. etc.
));
?>

那么你只需要 FixedWidthFormatter 类本身，它可能看起来像这样:

<?php

class FixedWidthFormatter {

    var $recordTypes = array();

    function addRecordType( $recordTypeName, $recordTypeDeclaration ){
        // perform some checking to make sure that $recordTypeDeclaration is valid
        $this->recordTypes[$recordTypeName] = $recordTypeDeclaration;
    }

    function formatRecord( $type, $data ) {
        if (!array_key_exists($type, $this->recordTypes)) {
            trigger_error("Undefinded record type: '$type'");
            return "";
        }
        $output = '';
        $typeDeclaration = $this->recordTypes[$type];
        foreach($typeDeclaration as $fieldName => $fieldDeclaration) {
            // there are three possible field variants:
            //  - constant fields
            //  - fields formatted with printf
            //  - fields formatted with a custom function/closure
            if (array_key_exists('value',$fieldDeclaration)) {
                $value = $fieldDeclaration['value'];
            } else if (array_key_exists('format',$fieldDeclaration)) {
                $value = sprintf($fieldDeclaration['format'], $data[$fieldDeclaration['sourceField']]);
            } else if (array_key_exists('formatter',$fieldDeclaration)) {
                $value = $fieldDeclaration['formatter']($data[$fieldDeclaration['sourceField']]);
            } else {
                trigger_error("Invalid field declaration for field '$fieldName' record type '$type'");
                return '';
            }

            // check if the formatted value has the right length
            if (strlen($value)!=$fieldDeclaration['length']) {
                trigger_error("The formatted value '$value' for field '$fieldName' record type '$type' is not of correct length ({$fieldDeclaration['length']}).");
                return '';
            }
            $output .= $value;
        }
        return $output . "\n";
    }
}


?>

如果您还需要读取支持，也可以扩展 Formatter 类以允许读取，但这可能超出了此答案的范围。