Parameter::expandFilterArgs() - Code Metrics - Inspection of "WIP: Support Filters Being Bound to Different Stag..." - guzzle/guzzle-services - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — master (#171)

unknown
created 2019-08-21 06:05 UTC
Parameter::expandFilterArgs() A

↳ Parent: Parameter
Complexity

Conditions	3
Paths	3
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	12
Importance

Changes
Metric	Value
dl	0
loc	15
ccs	0
cts	0
cp	0
rs	9.7666
c	0
b	0
f	0
cc	3
nc	3
nop	3
crap	12
<?php
namespace GuzzleHttp\Command\Guzzle;

use GuzzleHttp\Command\ToArrayInterface;

/**
 * API parameter object used with service descriptions
 */
class Parameter implements ToArrayInterface
{
    /**
     * The name of the filter stage that happens before a parameter is
     * validated, for filtering raw data (e.g. clean-up before validation).
     */
    const FILTER_STAGE_BEFORE_VALIDATION = 'before_validation';

    /**
     * The name of the filter stage that happens immediately after a parameter
     * has been validated but before it is evaluated by location handlers to be
     * written out on the wire.
     */
    const FILTER_STAGE_AFTER_VALIDATION = 'after_validation';

    /**
     * The name of the filter stage that happens right before a validated value
     * is being written out "on the wire" (e.g. for adjusting the structure or
     * format of the data before sending it to the server).
     */
    const FILTER_STAGE_REQUEST_WIRE = 'request_wire';

    /**
     * The name of the filter stage that happens right after a value has been
     * read out of a response "on the wire" (e.g. for adjusting the structure or
     * format of the data after receiving it back from the server).
     */
    const FILTER_STAGE_RESPONSE_WIRE = 'response_wire';

    /**
     * A list of all allowed filter stages.
     */
    const FILTER_STAGES = [
        self::FILTER_STAGE_BEFORE_VALIDATION,
        self::FILTER_STAGE_AFTER_VALIDATION,
        self::FILTER_STAGE_REQUEST_WIRE,
        self::FILTER_STAGE_RESPONSE_WIRE
    ];

    private $originalData;

    /** @var string $name */
    private $name;

    /** @var string $description */
    private $description;

    /** @var string|array $type */
    private $type;

    /** @var bool $required*/
    private $required;

    /** @var array|null $enum */
    private $enum;

    /** @var string $pattern */
    private $pattern;

    /** @var int $minimum*/
    private $minimum;

    /** @var int $maximum */
    private $maximum;

    /** @var int $minLength */
    private $minLength;

    /** @var int $maxLength */
    private $maxLength;

    /** @var int $minItems */
    private $minItems;

    /** @var int $maxItems */
    private $maxItems;

    /** @var mixed $default */
    private $default;

    /** @var bool $static */
    private $static;

    /** @var array $filters */
    private $filters;

    /** @var string $location */
    private $location;

    /** @var string $sentAs */
    private $sentAs;

    /** @var array $data */
    private $data;

    /** @var array $properties */
    private $properties = [];

    /** @var array|bool|Parameter $additionalProperties */
    private $additionalProperties;

    /** @var array|Parameter $items */
    private $items;

    /** @var string $format */
    private $format;

    private $propertiesCache = null;

    /** @var Description */
    private $serviceDescription;

    /**
     * Create a new Parameter using an associative array of data.
     *
     * The array can contain the following information:
     *
     * - name: (string) Unique name of the parameter
     *
     * - type: (string|array) Type of variable (string, number, integer,
     *   boolean, object, array, numeric, null, any). Types are used for
     *   validation and determining the structure of a parameter. You can use a
     *   union type by providing an array of simple types. If one of the union
     *   types matches the provided value, then the value is valid.
     *
     * - required: (bool) Whether or not the parameter is required
     *
     * - default: (mixed) Default value to use if no value is supplied
     *
     * - static: (bool) Set to true to specify that the parameter value cannot
     *   be changed from the default.
     *
     * - description: (string) Documentation of the parameter
     *
     * - location: (string) The location of a request used to apply a parameter.
     *   Custom locations can be registered with a command, but the defaults
     *   are uri, query, header, body, json, xml, formParam, multipart.
     *
     * - sentAs: (string) Specifies how the data being modeled is sent over the
     *   wire. For example, you may wish to include certain headers in a
     *   response model that have a normalized casing of FooBar, but the actual
     *   header is x-foo-bar. In this case, sentAs would be set to x-foo-bar.
     *
     * - filters: (array) Array of static method names to run a parameter
     *   value through. Each value in the array must be a string containing the
     *   full class path to a static method or an array of complex filter
     *   information. You can specify static methods of classes using the full
     *   namespace class name followed by '::' (e.g. Foo\Bar::baz). Some
     *   filters require arguments in order to properly filter a value.
     *
     *   For complex filters, use a hash containing a 'method' key pointing to a
     *   static method, an 'args' key containing an array of positional
     *   arguments to pass to the method, and an optional 'stage' key. Arguments
     *   can contain keywords that are replaced when filtering a value: '@value'
     *   is replaced with the value being validated, '@api' is replaced with the
     *   Parameter object, and '@stage' is replaced with the current filter
     *   stage (if any was provided).
     *
     *   The optional 'stage' key can be provided to control when the filter is
     *   invoked. The key can indicate that a filter should only be invoked
     *   'before_validation', 'after_validation', when being written out to the
     *   'request_wire' or being read from the 'response_wire'.
     *
     * - properties: When the type is an object, you can specify nested
     *   parameters
     *
     * - additionalProperties: (array) This attribute defines a schema for all
     *   properties that are not explicitly defined in an object type
     *   definition. If specified, the value MUST be a schema or a boolean. If
     *   false is provided, no additional properties are allowed beyond the
     *   properties defined in the schema. The default value is an empty schema
     *   which allows any value for additional properties.
     *
     * - items: This attribute defines the allowed items in an instance array,
     *   and MUST be a schema or an array of schemas. The default value is an
     *   empty schema which allows any value for items in the instance array.
     *   When this attribute value is a schema and the instance value is an
     *   array, then all the items in the array MUST be valid according to the
     *   schema.
     *
     * - pattern: When the type is a string, you can specify the regex pattern
     *   that a value must match
     *
     * - enum: When the type is a string, you can specify a list of acceptable
     *   values.
     *
     * - minItems: (int) Minimum number of items allowed in an array
     *
     * - maxItems: (int) Maximum number of items allowed in an array
     *
     * - minLength: (int) Minimum length of a string
     *
     * - maxLength: (int) Maximum length of a string
     *
     * - minimum: (int) Minimum value of an integer
     *
     * - maximum: (int) Maximum value of an integer
     *
     * - data: (array) Any additional custom data to use when serializing,
     *   validating, etc
     *
     * - format: (string) Format used to coax a value into the correct format
     *   when serializing or unserializing. You may specify either an array of
     *   filters OR a format, but not both. Supported values: date-time, date,
     *   time, timestamp, date-time-http, and boolean-string.
     *
     * - $ref: (string) String referencing a service description model. The
     *   parameter is replaced by the schema contained in the model.
     *
     * @param array $data    Array of data as seen in service descriptions
     * @param array $options Options used when creating the parameter. You can
     *     specify a Guzzle service description in the 'description' key.
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(array $data = [], array $options = [])
    {
        $this->originalData = $data;

        if (isset($options['description'])) {
            $this->serviceDescription = $options['description'];
            if (!($this->serviceDescription instanceof DescriptionInterface)) {
                throw new \InvalidArgumentException('description must be a Description');
            }
            if (isset($data['$ref'])) {
                if ($model = $this->serviceDescription->getModel($data['$ref'])) {
                    $name = isset($data['name']) ? $data['name'] : null;
                    $data = $model->toArray() + $data;
                    if ($name) {
                        $data['name'] = $name;
                    }
                }
            } elseif (isset($data['extends'])) {
                // If this parameter extends from another parameter then start
                // with the actual data union in the parent's data (e.g. actual
                // supersedes parent)
                if ($extends = $this->serviceDescription->getModel($data['extends'])) {
                    $data += $extends->toArray();
                }
            }
        }

        // Pull configuration data into the parameter
        foreach ($data as $key => $value) {
            $this->{$key} = $value;
        }

        $this->required = (bool) $this->required;
        $this->data = (array) $this->data;

        if (empty($this->filters)) {
            $this->filters = [];
        } else {
            $this->setFilters((array) $this->filters);
        }

        if ($this->type == 'object' && $this->additionalProperties === null) {
            $this->additionalProperties = true;
        }
    }

    /**
     * Convert the object to an array
     *
     * @return array
     */
    public function toArray()
    {
        return $this->originalData;
    }

    /**
     * Get the default or static value of the command based on a value
     *
     * @param string $value Value that is currently set
     *
     * @return mixed Returns the value, a static value if one is present, or a default value
     */
    public function getValue($value)
    {
        if ($this->static || ($this->default !== null && $value === null)) {
            return $this->default;
        }

        return $value;
    }

    /**
     * Run a value through the filters OR format attribute associated with the
     * parameter.
     *
     * @param mixed $value Value to filter
     * @param string $stage An optional specifier of what filter stage to
     *     invoke. If null, then all filters are invoked no matter what stage
     *     they apply to. Otherwise, only filters for the specified stage are
     *     invoked.
     *
     * @return mixed Returns the filtered value
     * @throws \RuntimeException when trying to format when no service
     *     description is available.
     * @throws \InvalidArgumentException if an invalid validation stage is
     *     provided.
     */
    public function filter($value, $stage = null)
    {
        if (($stage !== null) && !in_array($stage, self::FILTER_STAGES)) {
            throw new \InvalidArgumentException(
                sprintf(
                    '$stage must be one of [%s], but was given "%s"',
                    implode(', ', self::FILTER_STAGES),
                    $stage
                )
            );
        }

        // Formats are applied exclusively and supercede filters
        if (!empty($this->format)) {
            if (!$this->serviceDescription) {
                throw new \RuntimeException('No service description was set so '
                    . 'the value cannot be formatted.');
            }
            return $this->serviceDescription->format($this->format, $value);
        }

        // Convert Boolean values
        if ($this->type == 'boolean' && !is_bool($value)) {
            $value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
        }

        // Apply filters to the value
        if (!empty($this->filters)) {
            $value = $this->invokeCustomFilters($value, $stage);
        }

        return $value;
    }

    /**
     * Get the name of the parameter
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set the name of the parameter
     *
     * @param string $name Name to set
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * Get the key of the parameter, where sentAs will supersede name if it is
     * set.
     *
     * @return string
     */
    public function getWireName()
    {
        return $this->sentAs ?: $this->name;
    }

    /**
     * Get the type(s) of the parameter
     *
     * @return string|array
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Get if the parameter is required
     *
     * @return bool
     */
    public function isRequired()
    {
        return $this->required;
    }

    /**
     * Get the default value of the parameter
     *
     * @return string|null
     */
    public function getDefault()
    {
        return $this->default;
    }

    /**
     * Get the description of the parameter
     *
     * @return string|null
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Get the minimum acceptable value for an integer
     *
     * @return int|null
     */
    public function getMinimum()
    {
        return $this->minimum;
    }

    /**
     * Get the maximum acceptable value for an integer
     *
     * @return int|null
     */
    public function getMaximum()
    {
        return $this->maximum;
    }

    /**
     * Get the minimum allowed length of a string value
     *
     * @return int
     */
    public function getMinLength()
    {
        return $this->minLength;
    }

    /**
     * Get the maximum allowed length of a string value
     *
     * @return int|null
     */
    public function getMaxLength()
    {
        return $this->maxLength;
    }

    /**
     * Get the maximum allowed number of items in an array value
     *
     * @return int|null
     */
    public function getMaxItems()
    {
        return $this->maxItems;
    }

    /**
     * Get the minimum allowed number of items in an array value
     *
     * @return int
     */
    public function getMinItems()
    {
        return $this->minItems;
    }

    /**
     * Get the location of the parameter
     *
     * @return string|null
     */
    public function getLocation()
    {
        return $this->location;
    }

    /**
     * Get the sentAs attribute of the parameter that used with locations to
     * sentAs an attribute when it is being applied to a location.
     *
     * @return string|null
     */
    public function getSentAs()
    {
        return $this->sentAs;
    }

    /**
     * Retrieve a known property from the parameter by name or a data property
     * by name. When no specific name value is passed, all data properties
     * will be returned.
     *
     * @param string|null $name Specify a particular property name to retrieve
     *
     * @return array|mixed|null
     */
    public function getData($name = null)
    {
        if (!$name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $this->data;
        } elseif (isset($this->data[$name])) {
            return $this->data[$name];
        } elseif (isset($this->{$name})) {
            return $this->{$name};
        }

        return null;
    }

    /**
     * Get whether or not the default value can be changed
     *
     * @return bool
     */
    public function isStatic()
    {
        return $this->static;
    }

    /**
     * Get an array of filters used by the parameter
     *
     * @return array
     */
    public function getFilters()
    {
        return $this->filters;
    }

    /**
     * Get the properties of the parameter
     *
     * @return Parameter[]
     */
    public function getProperties()
    {
        if (!$this->propertiesCache) {
            $this->propertiesCache = [];
            foreach (array_keys($this->properties) as $name) {
                $this->propertiesCache[$name] = $this->getProperty($name);
            }
        }

        return $this->propertiesCache;
    }

    /**
     * Get a specific property from the parameter
     *
     * @param string $name Name of the property to retrieve
     *
     * @return null|Parameter
     */
    public function getProperty($name)
    {
        if (!isset($this->properties[$name])) {
            return null;
        }

        if (!($this->properties[$name] instanceof self)) {
            $this->properties[$name]['name'] = $name;
            $this->properties[$name] = new static(
                $this->properties[$name],
                ['description' => $this->serviceDescription]
            );
        }

        return $this->properties[$name];
    }

    /**
     * Get the additionalProperties value of the parameter
     *
     * @return bool|Parameter|null
     */
    public function getAdditionalProperties()
    {
        if (is_array($this->additionalProperties)) {
            $this->additionalProperties = new static(
                $this->additionalProperties,
                ['description' => $this->serviceDescription]
            );
        }

        return $this->additionalProperties;
    }

    /**
     * Get the item data of the parameter
     *
     * @return Parameter
     */
    public function getItems()
    {
        if (is_array($this->items)) {
            $this->items = new static(
                $this->items,
                ['description' => $this->serviceDescription]
            );
        }

        return $this->items;
    }

    /**
     * Get the enum of strings that are valid for the parameter
     *
     * @return array|null
     */
    public function getEnum()
    {
        return $this->enum;
    }

    /**
     * Get the regex pattern that must match a value when the value is a string
     *
     * @return string
     */
    public function getPattern()
    {
        return $this->pattern;
    }

    /**
     * Get the format attribute of the schema
     *
     * @return string
     */
    public function getFormat()
    {
        return $this->format;
    }

    /**
     * Set the array of filters used by the parameter
     *
     * @param array $filters Array of functions to use as filters
     *
     * @return self
     */
    private function setFilters(array $filters)
    {
        $this->filters = [];

        foreach ($filters as $filter) {
            $this->addFilter($filter);
        }

        return $this;
    }

    /**
     * Add a filter to the parameter
     *
     * @param string|array $filter Method to filter the value through
     *
     * @return self
     * @throws \InvalidArgumentException
     */
    private function addFilter($filter)
    {
        if (is_array($filter)) {
            if (!isset($filter['method'])) {
                throw new \InvalidArgumentException(
                    'A [method] value must be specified for each complex filter'
                );
            }

            if (isset($filter['stage'])
                && !in_array($filter['stage'], self::FILTER_STAGES)) {
                throw new \InvalidArgumentException(
                    sprintf(
                        '[stage] value must be one of [%s], but was given "%s"',
                        implode(', ', self::FILTER_STAGES),
                        $filter['stage']
                    )
                );
            }
        }

        $this->filters[] = $filter;

        return $this;
    }

    /**
     * Check if a parameter has a specific variable and if it set.
     *
     * @param string $var
     * @return bool
     */
    public function has($var)
    {
        if (!is_string($var)) {
            throw new \InvalidArgumentException('Expected a string. Got: ' . (is_object($var) ? get_class($var) : gettype($var)));
        }
        return isset($this->{$var}) && !empty($this->{$var});
    }

    /**
     * Filters the given data using filter methods specified in the config.
     *
     * If $stage is provided, only filters that apply to the provided filter
     * stage will be invoked. To preserve legacy behavior, filters that do not
     * specify a stage are implicitly invoked only in the pre-validation stage.
     *
     * @param mixed $value The value to filter.
     * @param string $stage An optional specifier of what filter stage to
     *     invoke. If null, then all filters are invoked no matter what stage
     *     they apply to. Otherwise, only filters for the specified stage are
     *     invoked.
     *
     * @return mixed The filtered value.
     */
    private function invokeCustomFilters($value, $stage) {
        $filteredValue = $value;

        foreach ($this->filters as $filter) {
            if (is_array($filter)) {
                $filteredValue =
                    $this->invokeComplexFilter($filter, $value, $stage);
            } else {
                $filteredValue =
                    $this->invokeSimpleFilter($filter, $value, $stage);
            }
        }

        return $filteredValue;
    }

    /**
     * Invokes a filter that uses value substitution and/or should only be
     * invoked for a particular filter stage.
     *
     * If $stage is provided, and the filter specifies a stage, it is not
     * invoked unless $stage matches the stage the filter indicates it applies
     * to. If the filter is not invoked, $value is returned exactly as it was
     * provided to this method.
     *
     * To preserve legacy behavior, if the filter does not specify a stage, it
     * is implicitly invoked only in the pre-validation stage.
     *
     * @param array $filter Information about the filter to invoke.
     * @param mixed $value The value to filter.
     * @param string $stage An optional specifier of what filter stage to
     *     invoke. If null, then the filter is invoked no matter what stage it
     *     indicates it applies to. Otherwise, the filter is only invoked if it
     *     matches the specified stage.
     *
     * @return mixed The filtered value.
     */
    private function invokeComplexFilter(array $filter, $value, $stage) {
        if (isset($filter['stage'])) {
            $filterStage = $filter['stage'];
        } else {
            $filterStage = self::FILTER_STAGE_AFTER_VALIDATION;
        }

        if (($stage === null) || ($filterStage == $stage)) {
            // Convert complex filters that hold value place holders
            $filterArgs =
                $this->expandFilterArgs($filter['args'], $value, $stage);

            $filteredValue =
                call_user_func_array($filter['method'], $filterArgs);
        } else {
            $filteredValue = $value;
        }

        return $filteredValue;
    }

    /**
     * Replaces any placeholders in filter arguments with values from the
     * current context.
     *
     * @param array $filterArgs The array of arguments to pass to the filter
     *     function. Some of the elements of this array are expected to be
     *     placeholders that will be replaced by this function.
     *
     * @return array The array of arguments, with all placeholders replaced.
     */
    private function expandFilterArgs(array $filterArgs, $value, $stage) {
        $replacements = [
            '@value'  => $value,
            '@api'    => $this,
            '@stage'  => $stage,
        ];

        foreach ($filterArgs as &$argValue) {
            if (isset($replacements[$argValue])) {
              $argValue = $replacements[$argValue];
            }
        }

        return $filterArgs;
    }

    /**
     * Invokes a filter only provides a function or method name to invoke,
     * without additional parameters.
     *
     * If $stage is provided, the filter is not invoked unless we are in the
     * pre-validation stage, to preserve legacy behavior.
     *
     * @param array $filter Information about the filter to invoke.
     * @param mixed $value The value to filter.
     * @param string $stage An optional specifier of what filter stage to
     *     invoke. If null, then the filter is invoked no matter what.
     *     Otherwise, the filter is only invoked if the value is
     *     FILTER_STAGE_AFTER_VALIDATION.
     *
     * @return mixed The filtered value.
     */
    private function invokeSimpleFilter($filter, $value, $stage) {
        if ($stage === self::FILTER_STAGE_AFTER_VALIDATION) {
            return $value;
        } else {
            return call_user_func($filter, $value);
        }
    }
}

guzzle / guzzle-services

Pull Request — master (#171)

Parameter::expandFilterArgs() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
