schenke-io/pretty-php-array

Write php array in a pretty way into an file

v1.0.1 2024-11-21 13:48 UTC

Requires

• php: ^8.1
• symfony/var-exporter: ^7.0

MIT

README

The WritePrettyArray class simplifies the creation of well-formatted PHP configuration files. By automatically generating human-readable code, it's ideal for storing data and integrating into CI/CD pipelines.

Key Method: toFile()

public static function toFile(
    string $filePath,
    array  $data,
    array  $comments = [],
    string $header = ''
): void

Parameters

• $filePath: The desired output file path.
• $data: An associative array containing key-value pairs of data to be written.
• $comments: An optional associative array where keys correspond to data keys, and values are arrays of comment headers and lines.
• $header: An optional string to be added at the beginning of the file.

Comment structure

Comments are associated with specific data keys using the following format:

$comments['data_key'] = [
    'Comment Header', // Optional header for the comment block
    [
        'Line 1 of comment',
        'Line 2 of comment',
    ]
    // ...
];

By using WritePrettyArray, you can:

• Streamline Configuration Management: Easily generate and maintain configuration files.
• Enhance Code Readability: Create well-structured and commented configuration files.
• Integrate into CI/CD: Automate configuration file generation as part of your build process.