/**
  * Custom handling for objects
  *
  * @param Parameter $param  Parameter for the object
  * @param array     $value  Value that is set for this parameter
  * @param string    $prefix Prefix for the resulting key
  * @param array     $query  Query string array passed by reference
  */
 protected function resolveObject(Parameter $param, array $value, $prefix, array &$query)
 {
     // Maps are implemented using additional properties
     $hasAdditionalProperties = $param->getAdditionalProperties() instanceof Parameter;
     $additionalPropertyCount = 0;
     foreach ($value as $name => $v) {
         if ($subParam = $param->getProperty($name)) {
             // if the parameter was found by name as a regular property
             $key = $prefix . '.' . $subParam->getWireName();
             $this->customResolver($v, $subParam, $query, $key);
         } elseif ($hasAdditionalProperties) {
             // Handle map cases like &Attribute.1.Name=<name>&Attribute.1.Value=<value>
             $additionalPropertyCount++;
             $data = $param->getData();
             $keyName = isset($data['keyName']) ? $data['keyName'] : 'key';
             $valueName = isset($data['valueName']) ? $data['valueName'] : 'value';
             $query["{$prefix}.{$additionalPropertyCount}.{$keyName}"] = $name;
             $newPrefix = "{$prefix}.{$additionalPropertyCount}.{$valueName}";
             if (is_array($v)) {
                 $this->customResolver($v, $param->getAdditionalProperties(), $query, $newPrefix);
             } else {
                 $query[$newPrefix] = $param->filter($v);
             }
         }
     }
 }
示例#2
0
 public function visit(CommandInterface $command, Response $response, Parameter $param, &$value, $context = null)
 {
     if ($param->getType() == 'object' && $param->getAdditionalProperties() instanceof Parameter) {
         $this->processPrefixedHeaders($response, $param, $value);
     } else {
         $value[$param->getName()] = $param->filter((string) $response->getHeader($param->getWireName()));
     }
 }
示例#3
0
 public function visit(CommandInterface $command, RequestInterface $request, Parameter $param, $value)
 {
     $value = $param->filter($value);
     if ($param->getType() == 'object' && $param->getAdditionalProperties() instanceof Parameter) {
         $this->addPrefixedHeaders($request, $param, $value);
     } else {
         $request->setHeader($param->getWireName(), $value);
     }
 }
示例#4
0
 /**
  * Recursively process a parameter while applying filters
  *
  * @param Parameter $param API parameter being validated
  * @param mixed     $value Value to validate and process. The value may change during this process.
  */
 protected function recursiveProcess(Parameter $param, &$value)
 {
     if ($value === null) {
         return;
     }
     if (is_array($value)) {
         $type = $param->getType();
         if ($type == 'array') {
             foreach ($value as &$item) {
                 $this->recursiveProcess($param->getItems(), $item);
             }
         } elseif ($type == 'object' && !isset($value[0])) {
             // On the above line, we ensure that the array is associative and not numerically indexed
             $knownProperties = array();
             if ($properties = $param->getProperties()) {
                 foreach ($properties as $property) {
                     $name = $property->getName();
                     $key = $property->getWireName();
                     $knownProperties[$name] = 1;
                     if (isset($value[$key])) {
                         $this->recursiveProcess($property, $value[$key]);
                         if ($key != $name) {
                             $value[$name] = $value[$key];
                             unset($value[$key]);
                         }
                     }
                 }
             }
             // Remove any unknown and potentially unsafe properties
             if ($param->getAdditionalProperties() === false) {
                 $value = array_intersect_key($value, $knownProperties);
             } elseif (($additional = $param->getAdditionalProperties()) !== true) {
                 // Validate and filter additional properties
                 foreach ($value as &$v) {
                     $this->recursiveProcess($additional, $v);
                 }
             }
         }
     }
     $value = $param->filter($value);
 }
 /**
  * Map nested parameters into the location_key based parameters
  *
  * @param array     $value Value to map
  * @param Parameter $param Parameter that holds information about the current key
  *
  * @return array Returns the mapped array
  */
 protected function resolveRecursively(array $value, Parameter $param)
 {
     foreach ($value as $name => &$v) {
         switch ($param->getType()) {
             case 'object':
                 if ($subParam = $param->getProperty($name)) {
                     $key = $subParam->getWireName();
                     $value[$key] = $this->prepareValue($v, $subParam);
                     if ($name != $key) {
                         unset($value[$name]);
                     }
                 } elseif ($param->getAdditionalProperties() instanceof Parameter) {
                     $v = $this->prepareValue($v, $param->getAdditionalProperties());
                 }
                 break;
             case 'array':
                 if ($items = $param->getItems()) {
                     $v = $this->prepareValue($v, $items);
                 }
                 break;
         }
     }
     return $param->filter($value);
 }
示例#6
0
 /**
  * Recursively validate a parameter
  *
  * @param Parameter $param  API parameter being validated
  * @param mixed     $value  Value to validate and validate. The value may change during this validate.
  * @param string    $path   Current validation path (used for error reporting)
  * @param int       $depth  Current depth in the validation validate
  *
  * @return bool Returns true if valid, or false if invalid
  */
 protected function recursiveProcess(Parameter $param, &$value, $path = '', $depth = 0)
 {
     // Update the value by adding default or static values
     $value = $param->getValue($value);
     $required = $param->getRequired();
     // if the value is null and the parameter is not required or is static, then skip any further recursion
     if (null === $value && !$required || $param->getStatic()) {
         return true;
     }
     $type = $param->getType();
     // Attempt to limit the number of times is_array is called by tracking if the value is an array
     $valueIsArray = is_array($value);
     // If a name is set then update the path so that validation messages are more helpful
     if ($name = $param->getName()) {
         $path .= "[{$name}]";
     }
     if ($type == 'object') {
         // Objects are either associative arrays, ToArrayInterface, or some other object
         if ($param->getInstanceOf()) {
             $instance = $param->getInstanceOf();
             if (!$value instanceof $instance) {
                 $this->errors[] = "{$path} must be an instance of {$instance}";
                 return false;
             }
         }
         // Determine whether or not this "value" has properties and should be traversed
         $traverse = $temporaryValue = false;
         // Convert the value to an array
         if (!$valueIsArray && $value instanceof ToArrayInterface) {
             $value = $value->toArray();
         }
         if ($valueIsArray) {
             // Ensure that the array is associative and not numerically indexed
             if (isset($value[0])) {
                 $this->errors[] = "{$path} must be an array of properties. Got a numerically indexed array.";
                 return false;
             }
             $traverse = true;
         } elseif ($value === null) {
             // Attempt to let the contents be built up by default values if possible
             $value = array();
             $temporaryValue = $valueIsArray = $traverse = true;
         }
         if ($traverse) {
             if ($properties = $param->getProperties()) {
                 // if properties were found, the validate each property of the value
                 foreach ($properties as $property) {
                     $name = $property->getName();
                     if (isset($value[$name])) {
                         $this->recursiveProcess($property, $value[$name], $path, $depth + 1);
                     } else {
                         $current = null;
                         $this->recursiveProcess($property, $current, $path, $depth + 1);
                         // Only set the value if it was populated with something
                         if (null !== $current) {
                             $value[$name] = $current;
                         }
                     }
                 }
             }
             $additional = $param->getAdditionalProperties();
             if ($additional !== true) {
                 // If additional properties were found, then validate each against the additionalProperties attr.
                 $keys = array_keys($value);
                 // Determine the keys that were specified that were not listed in the properties of the schema
                 $diff = array_diff($keys, array_keys($properties));
                 if (!empty($diff)) {
                     // Determine which keys are not in the properties
                     if ($additional instanceof Parameter) {
                         foreach ($diff as $key) {
                             $this->recursiveProcess($additional, $value[$key], "{$path}[{$key}]", $depth);
                         }
                     } else {
                         // if additionalProperties is set to false and there are additionalProperties in the values, then fail
                         foreach ($diff as $prop) {
                             $this->errors[] = sprintf('%s[%s] is not an allowed property', $path, $prop);
                         }
                     }
                 }
             }
             // A temporary value will be used to traverse elements that have no corresponding input value.
             // This allows nested required parameters with default values to bubble up into the input.
             // Here we check if we used a temp value and nothing bubbled up, then we need to remote the value.
             if ($temporaryValue && empty($value)) {
                 $value = null;
                 $valueIsArray = false;
             }
         }
     } elseif ($type == 'array' && $valueIsArray && $param->getItems()) {
         foreach ($value as $i => &$item) {
             // Validate each item in an array against the items attribute of the schema
             $this->recursiveProcess($param->getItems(), $item, $path . "[{$i}]", $depth + 1);
         }
     }
     // If the value is required and the type is not null, then there is an error if the value is not set
     if ($required && $value === null && $type != 'null') {
         $message = "{$path} is " . ($param->getType() ? 'a required ' . implode(' or ', (array) $param->getType()) : 'required');
         if ($param->getDescription()) {
             $message .= ': ' . $param->getDescription();
         }
         $this->errors[] = $message;
         return false;
     }
     // Validate that the type is correct. If the type is string but an integer was passed, the class can be
     // instructed to cast the integer to a string to pass validation. This is the default behavior.
     if ($type && !($type = $this->determineType($type, $value))) {
         if ($this->castIntegerToStringType && $param->getType() == 'string' && is_integer($value)) {
             $value = (string) $value;
         } else {
             $this->errors[] = "{$path} must be of type " . implode(' or ', (array) $param->getType());
         }
     }
     // Perform type specific validation for strings, arrays, and integers
     if ($type == 'string') {
         // Strings can have enums which are a list of predefined values
         if (($enum = $param->getEnum()) && !in_array($value, $enum)) {
             $this->errors[] = "{$path} must be one of " . implode(' or ', array_map(function ($s) {
                 return '"' . addslashes($s) . '"';
             }, $enum));
         }
         // Strings can have a regex pattern that the value must match
         if (($pattern = $param->getPattern()) && !preg_match($pattern, $value)) {
             $this->errors[] = "{$path} must match the following regular expression: {$pattern}";
         }
         $strLen = null;
         if ($min = $param->getMinLength()) {
             $strLen = strlen($value);
             if ($strLen < $min) {
                 $this->errors[] = "{$path} length must be greater than or equal to {$min}";
             }
         }
         if ($max = $param->getMaxLength()) {
             if (($strLen ?: strlen($value)) > $max) {
                 $this->errors[] = "{$path} length must be less than or equal to {$max}";
             }
         }
     } elseif ($type == 'array') {
         $size = null;
         if ($min = $param->getMinItems()) {
             $size = count($value);
             if ($size < $min) {
                 $this->errors[] = "{$path} must contain {$min} or more elements";
             }
         }
         if ($max = $param->getMaxItems()) {
             if (($size ?: count($value)) > $max) {
                 $this->errors[] = "{$path} must contain {$max} or fewer elements";
             }
         }
     } elseif ($type == 'integer' || $type == 'number' || $type == 'numeric') {
         if (($min = $param->getMinimum()) && $value < $min) {
             $this->errors[] = "{$path} must be greater than or equal to {$min}";
         }
         if (($max = $param->getMaximum()) && $value > $max) {
             $this->errors[] = "{$path} must be less than or equal to {$max}";
         }
     }
     return empty($this->errors);
 }
示例#7
0
 /**
  * Perform transformations on the result array
  *
  * @param Parameter        $model    Model that defines the structure
  * @param CommandInterface $command  Command that performed the operation
  * @param Response         $response Response received
  *
  * @return array Returns the array of result data
  */
 protected function visitResult(Parameter $model, CommandInterface $command, Response $response)
 {
     $foundVisitors = $result = $knownProps = array();
     $props = $model->getProperties();
     foreach ($props as $schema) {
         if ($location = $schema->getLocation()) {
             // Trigger the before method on the first found visitor of this type
             if (!isset($foundVisitors[$location])) {
                 $foundVisitors[$location] = $this->factory->getResponseVisitor($location);
                 $foundVisitors[$location]->before($command, $result);
             }
         }
     }
     // Visit additional properties when it is an actual schema
     if (($additional = $model->getAdditionalProperties()) instanceof Parameter) {
         $this->visitAdditionalProperties($model, $command, $response, $additional, $result, $foundVisitors);
     }
     // Apply the parameter value with the location visitor
     foreach ($props as $schema) {
         $knownProps[$schema->getName()] = 1;
         if ($location = $schema->getLocation()) {
             $foundVisitors[$location]->visit($command, $response, $schema, $result);
         }
     }
     // Remove any unknown and potentially unsafe top-level properties
     if ($additional === false) {
         $result = array_intersect_key($result, $knownProps);
     }
     // Call the after() method of each found visitor
     foreach ($foundVisitors as $visitor) {
         $visitor->after($command);
     }
     return $result;
 }