Consolidation\OutputFormatters\Options\FormatterOptions

Complexity

Total Complexity

48

Size/Duplication

Total Lines	478
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	override()	0	8	1
A	get()	0	5	1
A	getWithFallback()	0	4	1
A	getXmlSchema()	0	4	1
A	getFormat()	0	4	1
A	getTableStyle()	0	4	1
A	setTableStyle()	0	4	1
A	getIncludeFieldLables()	0	4	1
A	setIncludeFieldLables()	0	4	1
A	getListOrientation()	0	4	1
A	setListOrientation()	0	4	1
A	getRowLabels()	0	4	1
A	setRowLabels()	0	4	1
A	getFields()	0	4	1
A	getDefaultFields()	0	4	1
A	setDefaultFields()	0	4	1
A	getField()	0	4	1
A	getFieldLabels()	0	4	1
A	setFieldLabels()	0	4	1
A	getDefaultStringField()	0	4	1
A	setDefaultStringField()	0	4	1
A	getDelimiter()	0	4	1
A	setDelimiter()	0	4	1
A	fetch()	0	6	1
A	defaultsForKey()	0	7	2
A	fetchRawValues()	0	9	1
A	parsePropertyList()	0	4	1
A	getOptionFormat()	0	11	2
A	setConfigurationData()	0	5	1
A	setConfigurationValue()	0	5	1
A	setConfigurationDefault()	0	7	2
A	getConfigurationData()	0	4	1
A	setOptions()	0	5	1
A	setOption()	0	5	1
A	getOptions()	0	4	1
A	setInput()	0	5	1
B	getInputOptions()	0	16	5
A	parse()	0	8	3

<?php
namespace Consolidation\OutputFormatters\Options;

use Symfony\Component\Console\Input\InputInterface;
use Consolidation\OutputFormatters\Transformations\PropertyParser;
use Consolidation\OutputFormatters\StructuredData\Xml\XmlSchema;
use Consolidation\OutputFormatters\StructuredData\Xml\XmlSchemaInterface;

/**
 * FormetterOptions holds information that affects the way a formatter
 * renders its output.
 *
 * There are three places where a formatter might get options from:
 *
 * 1. Configuration associated with the command that produced the output.
 *    This is passed in to FormatterManager::write() along with the data
 *    to format.  It might originally come from annotations on the command,
 *    or it might come from another source.  Examples include the field labels
 *    for a table, or the default list of fields to display.
 *
 * 2. Options specified by the user, e.g. by commandline options.
 *
 * 3. Default values associated with the formatter itself.
 *
 * This class caches configuration from sources (1) and (2), and expects
 * to be provided the defaults, (3), whenever a value is requested.
 */
class FormatterOptions
{
    /** var array */
    protected $configurationData = [];
    /** var array */
    protected $options = [];
    /** var InputInterface */
    protected $input;

    const FORMAT = 'format';
    const DEFAULT_FORMAT = 'default-format';
    const TABLE_STYLE = 'table-style';
    const LIST_ORIENTATION = 'list-orientation';
    const FIELDS = 'fields';
    const FIELD = 'field';
    const INCLUDE_FIELD_LABELS = 'include-field-labels';
    const ROW_LABELS = 'row-labels';
    const FIELD_LABELS = 'field-labels';
    const DEFAULT_FIELDS = 'default-fields';
    const DEFAULT_STRING_FIELD = 'default-string-field';
    const DELIMITER = 'delimiter';

    /**
     * Create a new FormatterOptions with the configuration data and the
     * user-specified options for this request.
     *
     * @see FormatterOptions::setInput()
     * @param array $configurationData
     * @param array $options
     */
    public function __construct($configurationData = [], $options = [])
    {
        $this->configurationData = $configurationData;
        $this->options = $options;
    }

    /**
     * Create a new FormatterOptions object with new configuration data (provided),
     * and the same options data as this instance.
     *
     * @param array $configurationData
     * @return FormatterOptions
     */
    public function override($configurationData)
    {
        $override = new self();
        $override
            ->setConfigurationData($configurationData + $this->getConfigurationData())
            ->setOptions($this->getOptions());
        return $override;
    }

    /**
     * Get a formatter option
     *
     * @param string $key
     * @param array $defaults
     * @param mixed $default
     * @return mixed
     */
    public function get($key, $defaults = [], $default = false)
    {
        $value = $this->fetch($key, $defaults, $default);
        return $this->parse($key, $value);
    }

    /**
     * Get a formatter option. If the option does not exist, then fetch
     * a fallback option instead.
     *
     * @param string $key
     * @param string $fallbackKey
     * @param array $defaults
     * @param mixed $default
     * @return mixed
     */
    protected function getWithFallback($key, $fallbackKey, $defaults = [], $default = false)
    {
        return $this->get($key, [], $this->get($fallbackKey, $defaults, $default));
    }

    /**
     * Return the XmlSchema to use with --format=xml for data types that support
     * that.  This is used when an array needs to be converted into xml.
     *
     * @return XmlSchema
     */
    public function getXmlSchema()
    {
        return new XmlSchema();
    }

    /**
     * Determine the format that was requested by the caller.
     *
     * @param array $defaults
     * @return string
     */
    public function getFormat($defaults = [])
    {
        return $this->getWithFallback(self::FORMAT, self::DEFAULT_FORMAT, $defaults, '');
    }

    /**
     * Get the table style. Used by the table formatter to set the Symfony Table style.
     *
     * @param array $defaults
     * @return string
     */
    public function getTableStyle($defaults = [])
    {
        return $this->get(self::TABLE_STYLE, $defaults);
    }

    public function setTableStyle($style)
    {
        return $this->setConfigurationValue(self::TABLE_STYLE, $style);
    }

    /**
     * Determine whether or not field labels should be included.
     *
     * @param array $defaults
     * @return boolean
     */
    public function getIncludeFieldLables($defaults = [])
    {
        return $this->get(self::INCLUDE_FIELD_LABELS, $defaults);
    }

    public function setIncludeFieldLables($includFieldLables)
    {
        return $this->setConfigurationValue(self::INCLUDE_FIELD_LABELS, $includFieldLables);
    }

    /**
     * Set the table orientation. The RowsOfFields data type uses 'horizontal'
     * orientation, which means the headers (keys) are in the first row.  The
     * AssociativeList data type uses 'vertical' orientation, which means that
     * the headers (keys) are in the first column.
     *
     * @param array $defaults
     * @return string
     */
    public function getListOrientation($defaults = [])
    {
        return $this->get(self::LIST_ORIENTATION, $defaults);
    }

    public function setListOrientation($listOrientation)
    {
        return $this->setConfigurationValue(self::LIST_ORIENTATION, $listOrientation);
    }

    /**
     * Get the row labels. These are used by structured list data structure during
     * list tranformation to replace row machine IDs with human-readable labels
     *
     * @param array $defaults
     * @return string
     */
    public function getRowLabels($defaults = [])
    {
        return $this->get(self::ROW_LABELS, $defaults);
    }

    public function setRowLabels($rowLabels)
    {
        return $this->setConfigurationValue(self::ROW_LABELS, $rowLabels);
    }

    /**
     * Get the user-specified set of fields to include in the table.
     *
     * @param array $defaults
     * @return string
     */
    public function getFields($defaults = [])
    {
        return $this->getWithFallback(self::FIELDS, self::DEFAULT_FIELDS, $defaults, '');
    }

    /**
     * Get the list of fields that are displayed when the user does not
     * explicitly request specific fields.
     *
     * @param array $defaults
     * @return string
     */
    public function getDefaultFields($defaults = [])
    {
        return $this->get(self::DEFAULT_FIELDS, $defaults, '');
    }

    public function setDefaultFields($fields)
    {
        return $this->setConfigurationValue(self::DEFAULT_FIELDS, $fields);
    }

    /**
     * Get the single-field user selection, specified by --field. The
     * single-field option is just like the regular --fields option,
     * except that it also forces the output format to 'string'.
     *
     * @param array $defaults
     * @return string
     */
    public function getField($defaults = [])
    {
        return $this->get(self::FIELD, $defaults);
    }

    /**
     * Get the field labels
     *
     * @param array $defaults
     * @return string
     */
    public function getFieldLabels($defaults = [])
    {
        return $this->get(self::FIELD_LABELS, $defaults);
    }

    public function setFieldLabels($fieldLabels)
    {
        return $this->setConfigurationValue(self::FIELD_LABELS, $fieldLabels);
    }

    /**
     * Get the single field that should be returned when a table is requested
     * in 'string' format.
     *
     * @param array $defaults
     * @return string
     */
    public function getDefaultStringField($defaults = [])
    {
        return $this->get(self::DEFAULT_STRING_FIELD, $defaults, '');
    }

    public function setDefaultStringField($defaultStringField)
    {
        return $this->setConfigurationValue(self::DEFAULT_STRING_FIELD, $defaultStringField);
    }

    /**
     * Get the delimiter to use in a list
     *
     * @param array $defaults
     * @return string
     */
    public function getDelimiter($defaults = [])
    {
        return $this->get(self::DELIMITER, $defaults);
    }

    public function setDelimiter($delimiter)
    {
        return $this->setConfigurationValue(self::DELIMITER, $delimiter);
    }

    /**
     * Look up a key, and return its raw value.
     *
     * @param string $key
     * @param array $defaults
     * @param mixed $default
     * @return mixed
     */
    protected function fetch($key, $defaults = [], $default = false)
    {
        $defaults = $this->defaultsForKey($key, $defaults, $default);
        $values = $this->fetchRawValues($defaults);
        return $values[$key];
    }

    /**
     * Reduce provided defaults to the single item identified by '$key',
     * if it exists, or an empty array otherwise.
     *
     * @param string $key
     * @param array $defaults
     * @return array
     */
    protected function defaultsForKey($key, $defaults, $default = false)
    {
        if (array_key_exists($key, $defaults)) {
            return [$key => $defaults[$key]];
        }
        return [$key => $default];
    }

    /**
     * Look up all of the items associated with the provided defaults.
     *
     * @param array $defaults
     * @return array
     */
    protected function fetchRawValues($defaults = [])
    {
        return array_merge(
            $defaults,
            $this->getConfigurationData(),
            $this->getOptions(),
            $this->getInputOptions($defaults)
        );
    }

    /**
     * Given the raw value for a specific key, do any type conversion
     * (e.g. from a textual list to an array) needed for the data.
     *
     * @param string $key
     * @param mixed $value
     * @return mixed
     */
    protected function parse($key, $value)
    {
        $optionFormat = $this->getOptionFormat($key);
        if (!empty($optionFormat) && is_string($value)) {
            return $this->$optionFormat($value);
        }
        return $value;
    }

    /**
     * Convert from a textual list to an array
     *
     * @param string $value
     * @return array
     */
    public function parsePropertyList($value)
    {
        return PropertyParser::parse($value);
    }

    /**
     * Given a specific key, return the class method name of the
     * parsing method for data stored under this key.
     *
     * @param string $key
     * @return string
     */
    protected function getOptionFormat($key)
    {
        $propertyFormats = [
            self::ROW_LABELS => 'PropertyList',
            self::FIELD_LABELS => 'PropertyList',
        ];
        if (array_key_exists($key, $propertyFormats)) {
            return "parse{$propertyFormats[$key]}";
        }
        return '';
    }

    /**
     * Change the configuration data for this formatter options object.
     *
     * @param array $configurationData
     * @return FormatterOptions
     */
    public function setConfigurationData($configurationData)
    {
        $this->configurationData = $configurationData;
        return $this;
    }

    /**
     * Change one configuration value for this formatter option.
     *
     * @param string $key
     * @param mixed $value
     * @return FormetterOptions
     */
    protected function setConfigurationValue($key, $value)
    {
        $this->configurationData[$key] = $value;
        return $this;
    }

    /**
     * Change one configuration value for this formatter option, but only
     * if it does not already have a value set.
     *
     * @param string $key
     * @param mixed $value
     * @return FormetterOptions
     */
    public function setConfigurationDefault($key, $value)
    {
        if (!array_key_exists($key, $this->configurationData)) {
            return $this->setConfigurationValue($key, $value);
        }
        return $this;
    }

    /**
     * Return a reference to the configuration data for this object.
     *
     * @return array
     */
    public function getConfigurationData()
    {
        return $this->configurationData;
    }

    /**
     * Set all of the options that were specified by the user for this request.
     *
     * @param array $options
     * @return FormatterOptions
     */
    public function setOptions($options)
    {
        $this->options = $options;
        return $this;
    }

    /**
     * Change one option value specified by the user for this request.
     *
     * @param string $key
     * @param mixed $value
     * @return FormatterOptions
     */
    public function setOption($key, $value)
    {
        $this->options[$key] = $value;
        return $this;
    }

    /**
     * Return a reference to the user-specified options for this request.
     *
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Provide a Symfony Console InputInterface containing the user-specified
     * options for this request.
     *
     * @param InputInterface $input
     * @return FormatterOptions
     */
    public function setInput(InputInterface $input)
    {
        $this->input = $input;
        return $this;
    }

    /**
     * Return all of the options from the provided $defaults array that
     * exist in our InputInterface object.
     *
     * @param array $defaults
     * @return array
     */
    public function getInputOptions($defaults)
    {
        if (!isset($this->input)) {
            return [];
        }
        $options = [];
        foreach ($defaults as $key => $value) {
            if ($this->input->hasOption($key)) {
                $result = $this->input->getOption($key);
                if (isset($result)) {
                    $options[$key] = $this->input->getOption($key);
                }
            }
        }
        return $options;
    }
}