PortPHP

The OneToManyReader allows you to nest data from a 'child' reader into a 'parent' reader based on matching keys. This is useful for associating items (like order items) with a parent record (like an order).

Constructor Parameters:

1. $parentReader: The primary reader.
2. $childReader: The reader containing the nested data.
3. $nestingKey: The key name under which the child data will be nested in the parent row (e.g., 'items').
4. $primaryKey: The key in the parent data used for matching.
5. $foreignKey (optional): The key in the child data used for matching. If omitted, the reader uses the same name as the $primaryKey.

use Port\Csv\CsvReader;
use Port\Reader\OneToManyReader;

$orderReader = new CsvReader(new \SplFileObject("orders.csv"));
$orderReader->setHeaderRowNumber(0);

$orderItemReader = new CsvReader(new \SplFileObject("order_items.csv"));
$orderItemReader->setHeaderRowNumber(0);

$oneToManyReader = new OneToManyReader(
    $orderReader,
    $orderItemReader,
    'items',    // Nesting key
    'OrderId',  // Primary key
    'OrderId'   // Foreign key
);

To export data (from an ArrayReader or other source) to a CSV file, use CsvWriter within a StepAggregator workflow. You can use ValueConverterStep to transform data (e.g., capitalizing strings) during the export process.

1. Initialize the Reader: Provide your data source (e.g., ArrayReader).
2. Configure the Writer: Instantiate CsvWriter and use setStream() to specify the output file handle.
3. Apply Transformations: Use ValueConverterStep to modify specific fields using closures or converters.
4. Execute: Call $workflow->process().

<?php

use Port\Csv\CsvWriter;
use Port\Reader\ArrayReader;
use Port\Steps\StepAggregator;
use Port\Steps\Step\ValueConverterStep;

// Your input data
$reader = new ArrayReader(array(
    array(
        'first',        // This is for the CSV header
        'last',
        array(
            'first' => 'james',
            'last'  => 'Bond'
        ),
        array(
            'first' => 'hugo',
            'last'  => 'Drax'
        )
    )
));

// Create the workflow from the reader
$workflow = new StepAggregator($reader);

// Add the writer to the workflow
$writer = new CsvWriter();
$writer->setStream(fopen('output.csv', 'w'));
$workflow->addWriter($writer);

// Fix capitalization using a value converter
$valueConverterStep = new ValueConverterStep();
$valueConverterStep->add('first', function ($value) {
    return ucfirst($value);
});
$workflow->addStep($valueConverterStep);

// Process the workflow
$workflow->process();

The ValidatorFilter validates data before it is saved to a database. It requires the Symfony Validator component.

Setup

Install the Symfony Validator component via composer:

$ compose require symfony/validator

Usage

Manual Assertions

You can manually add constraints to specific fields using the add() method:

<?php

use Port\Filter\ValidatorFilter;
use Symfony\Component\Validator\Constraints as Assert;

// $validator is a Symfony Validator instance
$filter = new ValidatorFilter($validator);
$filter->add('email', new Assert\Email());
$filter->add('sku', new Assert\NotBlank());

Using Metadata/Annotations

If you use a Symfony validator pre-configured with metadata resources (like object annotations), you do not need to add assertions manually:

<?php

use Port\Filter\ValidatorFilter;

// $container is your Symfony service container
$validator = $container->get('validator'); 
$filter = new ValidatorFilter($validator);

Error Handling

• Default behavior: The filter collects all violations and skips each invalid row.
• Stop on failure: To stop processing immediately upon encountering an error, call $filter->throwExceptions(). This will throw a ValidationException containing the line number and the list of violations.

<?php

use Port\Filter\ValidatorFilter;
use Symfony\Component\Validator\Constraints as Assert;

$filter = new ValidatorFilter($validator);
$filter->add('email', new Assert\Email());
$filter->add('sku', new Assert\NotBlank());

// To stop on the first failing row:
$filter->throwExceptions();