NerdsAndCompany\Schematic\ConsoleCommands\ExportCommand

Complexity

Total Complexity

12

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	options()	0	4	1
A	actionIndex()	0	19	3
A	exportToYaml()	0	20	4
A	applyIncludes()	0	16	2
A	applyExcludes()	0	16	2

<?php

namespace NerdsAndCompany\Schematic\ConsoleCommands;

use Craft;
use craft\helpers\FileHelper;
use NerdsAndCompany\Schematic\Schematic;
use NerdsAndCompany\Schematic\Interfaces\MappingInterface;
use Symfony\Component\Yaml\Yaml;
use yii\console\Controller as Base;

/**
 * Schematic Export Command.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class ExportCommand extends Base
{
    public $file = 'config/schema.yml';
    public $exclude;
    public $include;

    /**
     * {@inheritdoc}
     *
     * @return array
     */
    public function options($actionID)
    {
        return ['file', 'include', 'exclude'];
    }

    /**
     * Exports the Craft datamodel.
     *
     * @param string $file    file to write the schema to

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

     * @param array  $exclude Data to not export

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

     *
     * @return int
     */
    public function actionIndex()
    {
        $dataTypes = Schematic::DATA_TYPES;

        // If include is specified.
        if ($this->include !== null) {
            $dataTypes = $this->applyIncludes($dataTypes);
        }

        // If there are exclusions.
        if ($this->exclude !== null) {
            $dataTypes = $this->applyExcludes($dataTypes);
        }

        $this->exportToYaml($this->file, $dataTypes);
        Craft::info('Exported schema to '.$this->file, 'schematic');

        return 0;
    }

    /**
     * Export to Yaml file.
     *
     * @param string $file
     * @param bool   $autoCreate

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

     *
     * @return Result
     */
    public function exportToYaml($file, $dataTypes)
    {
        $result = [];
        foreach (array_keys($dataTypes) as $dataType) {
            $component = 'schematic_'.$dataType;
            if (Craft::$app->$component instanceof MappingInterface) {
                Craft::info('Exporting '.$dataType, 'schematic');
                $result[$dataType] = Craft::$app->$component->export();
            } else {
                Craft::error(get_class(Craft::$app->$component).' does not implement MappingInterface', 'schematic');
            }
        }

        $yaml = Yaml::dump($result, 10);
        if (!FileHelper::writeToFile($file, $yaml)) {
            Craft::error('error', "Failed to write contents to \"$file\"", 'schematic');

The call to Craft::error() has too many arguments starting with 'schematic'.

        }

        return true;
    }

    /**
     * Apply given includes
     *
     * @param  array $dataTypes
     * @return array
     */
    private function applyIncludes($dataTypes)
    {
        $inclusions = explode(',', $this->include);
        // Find any invalid data to include.
        $invalidIncludes = array_diff($inclusions, $dataTypes);
        if (count($invalidIncludes) > 0) {
            $errorMessage = 'WARNING: Invalid include(s)';
            $errorMessage .= ': '.implode(', ', $invalidIncludes).'.'.PHP_EOL;
            $errorMessage .= ' Valid inclusions are '.implode(', ', $dataTypes);

            // Output an error message outlining what invalid exclusions were specified.
            Craft::warning($errorMessage, 'schematic');
        }
        // Remove any explicitly included data types from the list of data types to export.
        return array_intersect($dataTypes, $inclusions);
    }

    /**
     * Apply given excludes
     *
     * @param  array $dataTypes
     * @return array
     */
    private function applyExcludes(array $dataTypes)
    {
        $exclusions = explode(',', $this->exclude);
        // Find any invalid data to exclude.
        $invalidExcludes = array_diff($exclusions, $dataTypes);
        if (count($invalidExcludes) > 0) {
            $errorMessage = 'WARNING: Invalid exlude(s)';
            $errorMessage .= ': '.implode(', ', $invalidExcludes).'.'.PHP_EOL;
            $errorMessage .= ' Valid exclusions are '.implode(', ', $dataTypes);

            // Output an error message outlining what invalid exclusions were specified.
            Craft::warning($errorMessage, 'schematic');
        }
        // Remove any explicitly excluded data types from the list of data types to export.
        return array_diff($dataTypes, $exclusions);
    }
}