Oihana PHP

documents

Table of Contents

Functions

formatDocument()  : array<string|int, mixed>|object
Recursively formats all string values in a document (array or object) by replacing placeholders with their corresponding values found in the root document.
formatDocumentWith()  : array<string|int, mixed>|object
Formats a document (array or object) using placeholders resolved from another source document.
resolvePlaceholders()  : void
Hydrates or formats a document (array or object) in place by replacing placeholders with corresponding values from a source document.

Functions

formatDocument()

Recursively formats all string values in a document (array or object) by replacing placeholders with their corresponding values found in the root document.

formatDocument(array<string|int, mixed>|object $document[, string $prefix = '{{' ][, string $suffix = '}}' ][, string $separator = '.' ][, string|null $pattern = null ][, callable|null $formatter = null ][, bool $preserveMissing = false ]) : array<string|int, mixed>|object

This function uses the formatFromDocument() helper to replace placeholders in string values using values from the root document. It supports nested keys with a custom separator (default is '.').

Placeholders are defined by a prefix and suffix (default '{{' and '}}'), e.g. "{{key.subkey}}". If a referenced key does not exist, the placeholder is replaced with an empty string by default, or preserved as-is if preserveMissing is set to true.

Example:

$config =
[
    'dir'    => '/var/www/project',
    'htdocs' => '{{dir}}/htdocs',
    'env'    => 'production',
    'config' =>
     [
        'production' => [ 'url' => 'https://example.com' ]
     ],
    'api' => '{{config.{{env}}.url}}/api' ,
    'wordpress' => [
        'server' => [
            'subdomain' => 'www',
            'domain' => 'example.com',
            'url' => 'https://{{wordpress.server.subdomain}}.{{wordpress.server.domain}}/'
        ]
    ]
];
$formatted = formatDocument($config);

echo $formatted['htdocs'] ; // outputs: /var/www/project/htdocs
echo $formatted['wordpress']['server']['url'] ; // outputs: https://www.example.com/

$formatted = formatDocument($config);
echo $formatted['api']; // outputs: https://example.com/api
Parameters
$document : array<string|int, mixed>|object

The document (array or object) to recursively format.

$prefix : string = '{{'

Placeholder prefix (default '{{').

$suffix : string = '}}'

Placeholder suffix (default '}}').

$separator : string = '.'

Separator used in nested keys (default '.').

$pattern : string|null = null

Optional regex pattern to match placeholders.

$formatter : callable|null = null

Optional custom formatter callable.

$preserveMissing : bool = false

If true, unresolved placeholders will be preserved (default false).

Tags
author

Marc Alcaraz (ekameleon)

since
1.0.0
Return values
array<string|int, mixed>|object —

A new formatted document with same structure and class.

formatDocumentWith()

Formats a document (array or object) using placeholders resolved from another source document.

formatDocumentWith(array<string|int, mixed>|object $target, array<string|int, mixed>|object $source[, string $prefix = '{{' ][, string $suffix = '}}' ][, string $separator = '.' ][, string|null $pattern = null ][, callable|null $formatter = null ][, bool $preserveMissing = false ]) : array<string|int, mixed>|object
Parameters
$target : array<string|int, mixed>|object

The target document to format.

$source : array<string|int, mixed>|object

The source document used for placeholder resolution.

$prefix : string = '{{'

Placeholder prefix (default '{{').

$suffix : string = '}}'

Placeholder suffix (default '}}').

$separator : string = '.'

Separator used in nested keys (default '.').

$pattern : string|null = null

Optional regex pattern to match placeholders.

$formatter : callable|null = null

Optional custom formatter with signature: function(string $value, array|object $source, string $prefix, string $suffix, string $separator, ?string $pattern, bool $preserveMissing): string

$preserveMissing : bool = false

If true, preserves unresolved placeholders instead of removing them (default false).

Tags
see
formatDocument()
example 
$source =
[
    'base_dir' => '/var/www',
    'env'      => 'prod',
    'config'   =>
    [
        'prod' => [ 'url' => 'https://example.com' ]
    ]
];

$target =
[
    'htdocs' => '{{base_dir}}/htdocs',
    'api'    => '{{config.{{env}}.url}}/api'
];

$result = formatDocumentWith($target, $source);
echo $result['htdocs']; // /var/www/htdocs
echo $result['api'];    // https://example.com/api
Return values
array<string|int, mixed>|object —

A new document with the same structure and class as $target, where all string placeholders have been resolved using $source.

resolvePlaceholders()

Hydrates or formats a document (array or object) in place by replacing placeholders with corresponding values from a source document.

resolvePlaceholders(array<string|int, mixed>|object &$target, array<string|int, mixed>|object $source[, string $prefix = '{{' ][, string $suffix = '}}' ][, string $separator = '.' ][, string|null $pattern = null ][, callable|null $formatter = null ][, bool $preserveMissing = false ]) : void
Parameters
$target : array<string|int, mixed>|object

The target document to format.

$source : array<string|int, mixed>|object

The source document used for placeholder resolution.

$prefix : string = '{{'

Placeholder prefix (default '{{').

$suffix : string = '}}'

Placeholder suffix (default '}}').

$separator : string = '.'

Separator used in nested keys (default '.').

$pattern : string|null = null

Optional regex pattern to match placeholders.

$formatter : callable|null = null

Optional custom formatter callable with signature fn(string $value, array|object $source, string $prefix, string $suffix, string $separator, ?string $pattern, bool $preserveMissing): string

$preserveMissing : bool = false

If true, preserves unresolved placeholders instead of removing them (default false).

Tags
example 
$target =
[
    'host'        => '{{server.name}}',
    'port'        => '{{server.port}}',
    'enabled'     => '{{feature.enabled}}',
    'description' => 'Connect to {{server.name}} on port {{server.port}}',
];

$source =
[
    'server' => [
        'name' => 'localhost',
        'port' => 8080,
    ],
    'feature' =>
    [
        'enabled' => false,
    ],
];

resolvePlaceholders($target, $source);

// Result:
// $target['host']    === 'localhost' (string)
// $target['port']    === 8080 (int)
// $target['enabled'] === false (bool)
// $


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results