jtotty / csv-loader

src/CsvLoader/CsvLoader.php

<?php

declare(strict_types=1);

namespace Jtotty\CsvLoader;

use Jtotty\Steps\CheckGroupOptionsStep;
use Jtotty\Steps\CheckPupilDobStep;
use Jtotty\Steps\CheckPupilGenderStep;
use Jtotty\Steps\CheckPupilNamesStep;
use Port\Csv\CsvReader;
use Port\Csv\CsvWriter;
use Port\Steps\Step\FilterStep;
use Port\Steps\Step\MappingStep;
use Port\Steps\Step\ValueConverterStep;
use Port\Steps\StepAggregator as Workflow;
use Port\ValueConverter\DateTimeValueConverter;
use Port\Writer\ArrayWriter;

class CsvLoader
{
    /**
     * Holds an instance of SplFileObject.

The type Jtotty\CsvLoader\SplFileObject was not found. Did you mean SplFileObject? If so, make sure to prefix the type with \.

     *
     * @var SplFileObject
     */
    private $file;

    /**
     * Holds an isntance of file contents as an associative array.
     *
     * @var array
     */
    private $contents = [];

    /**
     * Holds an instance of the column name mappings.
     *
     * @var array
     */
    private $columnMap;

    /**
     * Holds an instance of the \Port\Csv\CsvReader.
     *
     * @var \Port\Csv\CsvReader
     */
    private $reader;

    /**
     * Holds an instanec of the \Port\Steps\StepAggregator.
     *
     * @var \Port\Steps\StepAggregator
     */
    private $workflow;

    /**
     * Constructor method.
     */
    public function __constructor()
    {
    }

    /**
     * Load the file to the SplFileObject.
     *
     * @return void
     */
    public function loadFile(string $file_path)
    {
        // Set the file
        $this->file = new \SplFileObject($file_path);

It seems like new SplFileObject($file_path) of type SplFileObject is incompatible with the declared type Jtotty\CsvLoader\SplFileObject of property $file.

        // Add file to reader
        $this->reader = new CsvReader($this->file);
        $this->reader->setHeaderRowNumber(0, CsvReader::DUPLICATE_HEADERS_INCREMENT);

        // Initialise the workflow!!
        $this->createWorkFlow();
    }

    /**
     * Starts the workflow to process the array data.
     *
     * @return void
     */
    public function createWorkFlow()
    {
        // Initialise Workflow
        $this->workflow = new Workflow($this->reader);

        // The modified array data will be saved to `$this->contents`
        $writer = new ArrayWriter($this->contents);
        $this->workflow->addWriter($writer);
    }

    /**
     * Returns the number of data rows.
     *
     * @return Integer
     */
    public function getDataCount()
    {
        return $this->reader->count();
    }

    /**
     * Returns the column headings from the uploaded csv.
     *
     * @return Array
     */
    public function getColumnHeadings()
    {
        return $this->reader->getColumnHeaders();
    }

    /**
     * Run the workflow.
     *
     * @return void
     */
    public function processData()
    {
        $this->workflow->process();
    }

    /**
     * Stop the workflow so we can unlink the file.
     *
     * @return void
     */
    public function stopWorkflow()
    {
        $this->workflow = null;
    }

    /**
     * Sets the data column mapping array.
     *
     * @return void
     */
    public function setColumnMap(array $columnMap)
    {
        $this->columnMap = $columnMap;
    }

    /**
     * Remove rows that have no data in all columns.
     *
     * @return void
     */
    public function removeEmptyRowsStep()
    {
        $columnCount = count($this->getColumnHeadings());

        $filterStep = new FilterStep();
        $filterStep->add(function ($input) use ($columnCount) {
            $blanks = 0;
            foreach ($input as $value) {
                if (empty($value)) {
                    ++$blanks;
                }
            }

            return $blanks !== $columnCount;
        });

        $this->workflow->addStep($filterStep);
    }

    /**
     * Renames the column names according to the map.
     *
     * @return void
     */
    public function mapColumnNamesStep()
    {
        // Create a mapping step
        $mappingStep = new MappingStep();

        // Iterate through the column names that need changing
        foreach ($this->columnMap as $key => $value) {
            $mappingStep->map('[' . $key . ']', '[' . $value . ']');
        }

        // Add to the workflow
        $this->workflow->addStep($mappingStep);
    }

    /**
     * Converts date of birth to correct format.
     *
     * @return void
     */
    public function convertDobStep()
    {
        // Format the dob string so we can convert it correctly
        $this->workflow->addStep(new CheckPupilDobStep());

        // Convert from input format to output
        $converterStep = new ValueConverterStep();
        $converterStep->add('[DOB]', new DateTimeValueConverter(null, 'Y-m-d'));

        $this->workflow->addStep($converterStep);
    }

    /**
     * Very specific method to check if a user has entered
     * the entire pupil's name into one column (Either forename or surname).
     */
    public function checkPupilNamesStep()
    {
        $this->workflow->addStep(new CheckPupilNamesStep());
    }

    /**
     * Step to check for validity of pupil gender and convert to
     * appropriate 'male' or 'female' string value.
     */
    public function checkPupilGenderStep()
    {
        $this->workflow->addStep(new CheckPupilGenderStep());
    }

    /**
     * Very specific method to convert the additional attributes
     * to.
     */
    public function checkGroupOptionValuesStep(array $options)
    {
        $this->workflow->addStep(new CheckGroupOptionsStep($options));
    }

    /**
     * Returns the content of the csv file as array.
     */
    public function getProcessedContents()
    {
        return $this->contents;
    }

    /**
     * Writes contents of an array to a csv file.
     */
    public function writeToCsv(array $data, string $filePath)
    {
        $writer = new CsvWriter(','); // Set delimiter to comma (default = semicolon)
        $writer->setStream(fopen($filePath, 'w'));

It seems like fopen($filePath, 'w') can also be of type false; however, parameter $stream of Port\Writer\AbstractStreamWriter::setStream() does only seem to accept resource, maybe add an additional type check?

        // Write column headers
        $columnHeaders = array_keys($data[0]);
        $writer->writeItem($columnHeaders);

        // Get row data and write
        foreach ($data as $pupil) {
            $writer->writeItem(array_values($pupil)); // Reset associative keys to indexes
        }

        $writer->finish();
    }
}