Inet\Neuralyzer\Anonymizer\AbstractAnonymizer

Complexity

Total Complexity

13

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

77.14%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	processEntity()	0	6	?
A	setConfiguration()	0	6	1
A	generateFakeData()	0	16	3
A	whatToDoWithEntity()	0	17	4
A	getWhereConditionInConfig()	0	10	2
A	checkEntityIsInConfig()	0	9	3

<?php
/**
 * neuralyzer : Data Anonymization Library and CLI Tool
 *
 * PHP Version 7.0
 *
 * @author Emmanuel Dyan
 * @author Rémi Sauvat
 * @copyright 2017 Emmanuel Dyan
 *
 * @package edyan/neuralyzer
 *
 * @license GNU General Public License v2.0
 *
 * @link https://github.com/edyan/neuralyzer
 */

namespace Inet\Neuralyzer\Anonymizer;

use Inet\Neuralyzer\Configuration\Reader;
use Inet\Neuralyzer\Exception\NeuralizerConfigurationException;

/**
 * Abstract Anonymizer
 */
abstract class AbstractAnonymizer
{
    /**
     * Constant to define the type of action for that table
     */
    const TRUNCATE_TABLE = 1;

    /**
     * Constant to define the type of action for that table
     */
    const UPDATE_TABLE = 2;

    /**
     * Contain the configuration object
     *
     * @var Reader
     */
    protected $configuration;

    /**
     * Configuration of entities
     *
     * @var array
     */
    protected $configEntites = [];

    /**
     * Process the entity according to the anonymizer type
     *
     * @param string        $entity

There is no parameter named $entity. Was it maybe removed?

     * @param callable|null $callback
     * @param bool          $pretend
     * @param bool          $returnResult
     */
    abstract public function processEntity(
        string $table,
        callable $callback = null,
        bool $pretend = true,
        bool $returnResult = false
    );

    /**
     * Set the configuration
     *
     * @param Reader $configuration
     */
    public function setConfiguration(Reader $configuration)
    {
        $this->configuration = $configuration;
        $configEntites = $configuration->getConfigValues();
        $this->configEntites = $configEntites['entities'];
    }

    /**
     * Evaluate, from the configuration if I have to update or Truncate the table
     *
     * @param string $entity
     *
     * @return int
     */
    public function whatToDoWithEntity(string $entity): int
    {
        $this->checkEntityIsInConfig($entity);

        $entityConfig = $this->configEntites[$entity];

        $actions = 0;
        if (array_key_exists('delete', $entityConfig) && $entityConfig['delete'] === true) {
            $actions |= self::TRUNCATE_TABLE;
        }

        if (array_key_exists('cols', $entityConfig)) {
            $actions |= self::UPDATE_TABLE;
        }

        return $actions;
    }

    /**
     * Returns the 'delete_where' parameter for an entity in config (or empty)
     *
     * @param string $entity
     *
     * @return string
     */
    public function getWhereConditionInConfig(string $entity): string
    {
        $this->checkEntityIsInConfig($entity);

        if (!array_key_exists('delete_where', $this->configEntites[$entity])) {
            return '';
        }

        return $this->configEntites[$entity]['delete_where'];
    }

    /**
     * Generate fake data for an entity and return it as an Array
     *
     * @param string $entity
     *
     * @return array
     */
    public function generateFakeData(string $entity): array
    {
        $this->checkEntityIsInConfig($entity);

        $faker = \Faker\Factory::create();

        $entityCols = $this->configEntites[$entity]['cols'];
        $entity = [];
        foreach ($entityCols as $colName => $colProps) {
            $args = empty($colProps['params']) ? [] : $colProps['params'];
            $data = call_user_func_array([$faker, $colProps['method']], $args);
            $entity[$colName] = $data;
        }

        return $entity;
    }

    /**
     * Make sure that entity is defined in the configuration
     *
     * @param string $entity
     *
     * @throws NeuralizerConfigurationException
     */
    private function checkEntityIsInConfig(string $entity)
    {
        if (empty($this->configEntites)) {
            throw new NeuralizerConfigurationException('No entities found. Have you loaded a configuration file ?');
        }
        if (!array_key_exists($entity, $this->configEntites)) {
            throw new NeuralizerConfigurationException("No configuration for that entity ($entity)");
        }
    }
}