Equip\Command\Options

Complexity

Total Complexity

9

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	2
	required()	0	1	?
A	valid()	0	4	1
A	toArray()	0	4	1
A	__get()	0	4	1
A	__set()	0	4	1
A	__unset()	0	4	1
A	ensureRequired()	0	12	2

<?php

namespace Equip\Command;

/**
 * A general purpose value object for command options.
 *
 * When constructed, all required options must be passed.
 *
 * @since 1.3.0
 */
abstract class Options
{
    /**
     * Check that all required options are defined, then hydrate.
     *
     * @param array $values
     */
    final public function __construct(array $values)
    {
        // Remove any values that are invalid for this set of options
        $values = array_intersect_key(
            $values,
            array_flip($this->valid())
        );

        $this->ensureRequired($values);

        foreach ($values as $key => $value) {
            $this->$key = $value;
        }
    }

    /**
     * Get a list of all required options.
     *
     *     return [
     *         'email',
     *         'password',
     *     ];
     *
     * @return array
     */
    abstract public function required();

    /**
     * Get a list of all valid options.
     *
     * @return array
     */
    public function valid()
    {
        return array_keys($this->toArray());
    }

    /**
     * Get all options as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return get_object_vars($this);
    }

    /**
     * Provide read-only access to attributes.
     *
     * @param string $key
     *
     * @return mixed
     */
    final public function __get($key)
    {
        return $this->{$key};
    }

    /**
     * Prevent modification.
     *
     * @throws ImmutableException
     *
     * @param string $key
     * @param mixed $value
     *
     * @return void
     */
    final public function __set($key, $value)

The parameter $key is not used and could be removed.

The parameter $value is not used and could be removed.

    {
        throw ImmutableException::cannotModify($this);
    }

    /**
     * Prevent modification.
     *
     * @throws ImmutableException
     *
     * @param string $key
     *
     * @return void
     */
    final public function __unset($key)

The parameter $key is not used and could be removed.

    {
        throw ImmutableException::cannotModify($this);
    }

    /**
     * Ensure that all required options are included in the given values.
     *
     * @param array $values
     *
     * @return void
     *
     * @throws CommandException
     *  If any required options have not been defined.
     */
    private function ensureRequired(array $values)
    {
        $defined = array_filter($values, static function ($value) {
            return $value !== null;
        });

        $missing = array_diff($this->required(), array_keys($defined));

        if ($missing) {

The expression $missing of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            throw CommandException::missingOptions($missing);
        }
    }
}