Normalising Rows for Validation when using OnEachRow

[MrThePlague]

Hello!

I'm currently working on a CSV Import which uses OnEachRow, and trying to implement some kind of validation; however, some of my columns have various possible column names, e.g.: description/product_description, or price/unit_price, etc.

Is there a way of normalising the column names so that the validator and onRow() can leverage normalised column name? Is the accepted best practice for this to use prepareForValidation(), and return a new array with the normalised columns?

Thanks!

[patrickbrouwers]

For validation yes, but I'm not sure it work with onRow. You'll have to try it out

[MrThePlague]

Thanks @patrickbrouwers, looks like it works!

[MrThePlague]

For anyone that might be trying to accomplish this same thing in the future, I was able to use prepareForValidation() to normalise the row prior to applying validation rules. This also works correctly with SkipsOnFailure and SkipsFailures.

Example Import

class ExampleImport implements OnEachRow, WithHeadingRow, WithChunkReading, SkipsOnFailure, WithValidation
{
    use SkipsFailures, Importable;

    private $example;

    public function __construct(string $exampleId)
    {
        $this->exampleId = $exampleId;
    }

    public function prepareForValidation($data, $index)
    {
        /**
        * Normalise the column names into a standard
        * e.g. name could be either 'name' or 'product_name'
        * /
        $normalisedRow = [
            'name'                  => $data['name'] ?? $data['product_name'] ?? null, 
            'description'           => $data['description'] ?? $data['product_description'] ?? null,
            'size'                  => $data['size'] ?? $data['unit_size'] ?? null,
            'quantity'              => $data['qty_ship'] ?? $data['qty_shipped'] ?? null,
            'unit_price'            => $data['price'] ??$data['unit_price'] ?? null,
            'total'                 => $data['total_price'] ?? $data['total'] ?? null,
        ];

        return $normalisedRow;
    }

    public function rules(): array
    {
        return [
            'description' => 'required',
            'size' => 'required',
            'quantity' => 'required',
            'unit_price' => 'required',
            'total' => 'required',
        ];
    }

    public function onRow(Row $row)
    {
        // Retreive the Example model
        $example = Example::findOrFail($this->exampleId);

        $row = $row->toArray();

        // Some other business logic here

        // Check if the product exists, otherwise create it
        $product = Product::firstOrCreate(['name' => $row['name']],
        [
            'name' => $row['description'],
            'description' => $row['description'],
            'size' => $this->stripSize($row['size']),
        ]);

        $example->products()->attach($product, [
            'unit_price' => $row['unit_price'],
            'quantity' => $row['quantity'],
        ]);

    }