TechDivision\Import\Observers\CleanUpEmptyColumnsTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	49
Duplicated Lines	36.73 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
B	clearRow()	18	34	10

<?php

/**
 * TechDivision\Import\Observers\CleanUpEmptyColumnsTrait
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Martin Eissenführer <m.eisenfuehrer@techdivision.com>
 * @copyright 2021 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Observers;

use TechDivision\Import\Subjects\CleanUpColumnsSubjectInterface;
use TechDivision\Import\Utils\ConfigurationKeys;

/**
 * Observer that extracts the missing attribute option values from a customer CSV.
 *
 * @author    Martin Eissenführer <m.eisenfuehrer@techdivision.com>
 * @copyright 2021 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-converter-customer-attribute
 * @link      http://www.techdivision.com
 */
trait CleanUpEmptyColumnsTrait
{
    /**
     * The array with the column keys that has to be cleaned up when their values are empty.
     *
     * @var array
     */
    protected $cleanUpEmptyColumnKeys;

    /**
     * Remove all the empty values from the row and return the cleared row.
     *
     * @return array The cleared row
     */
    protected function clearRow()
    {

        // query whether or not the column keys has been initialized
        if ($this->cleanUpEmptyColumnKeys === null) {
            // initialize the array with the column keys that has to be cleaned-up
            $this->cleanUpEmptyColumnKeys = array();

            // query whether or not column names that has to be cleaned up have been configured
            if ($this->getSubject()->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)

This code seems to be duplicated across your project.

It seems like getSubject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                && ($this->getSubject() instanceof CleanUpColumnsSubjectInterface)) {

It seems like getSubject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                // if yes, load the column names
                $cleanUpEmptyColumns = $this->getSubject()->getCleanUpColumns();

It seems like getSubject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                // translate the column names into column keys
                foreach ($cleanUpEmptyColumns as $cleanUpEmptyColumn) {
                    if ($this->hasHeader($cleanUpEmptyColumn)) {

It seems like hasHeader() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                        $this->cleanUpEmptyColumnKeys[] = $this->getHeader($cleanUpEmptyColumn);

It seems like getHeader() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    }
                }
            }
        }

        // remove all the empty values from the row, expected the columns has to be cleaned-up
        foreach ($this->row as $key => $value) {

The property row does not exist. Did you maybe forget to declare it?

This code seems to be duplicated across your project.

            // query whether or not the value is empty AND the column has NOT to be cleaned-up
            if (($value === null || $value === '') && in_array($key, $this->cleanUpEmptyColumnKeys) === false) {
                unset($this->row[$key]);
            }
        }

        // finally return the clean row
        return $this->row;
    }
}