netdudes/DataSourceryBundle

View on GitHub
Transformers/TransformerInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace Netdudes\DataSourceryBundle\Transformers;

use Netdudes\DataSourceryBundle\DataSource\DataSourceInterface;

/**
 * A minimal interface for a data transformer
 */
interface TransformerInterface
{
    /**
     * The transformer accepts a FieldCollection (a row) and returns it back with
     * arbitrary changes to it.
     *
     * Miscellaneous parameters can be passed through the $parameters array
     *
     * @param array              $record
     * @param DataSourceInterface $dataSource
     *
     * @return array
     */
    public function transform(array $record, DataSourceInterface $dataSource);

    public function getRequiredFieldNames();
}