protected function generateType(PropertyInterface $type)
{
if ($type instanceof Property\ComplexType) {
$properties = $type->getProperties();
$props = array();
$required = array();
foreach ($properties as $property) {
$props[$property->getName()] = $this->generateType($property);
if ($property->isRequired()) {
$required[] = $property->getName();
}
}
$result = array('type' => 'object', 'properties' => $props);
$description = $type->getDescription();
if (!empty($description)) {
$result['description'] = $description;
}
if (!empty($required)) {
$result['required'] = $required;
}
$result['additionalProperties'] = false;
$key = 'ref' . $type->getId();
$this->definitions[$key] = $result;
return ['$ref' => '#/definitions/' . $key];
} elseif ($type instanceof Property\ArrayType) {
$result = array('type' => 'array', 'items' => $this->generateType($type->getPrototype()));
$description = $type->getDescription();
if (!empty($description)) {
$result['description'] = $description;
}
$minLength = $type->getMinLength();
if ($minLength) {
$result['minItems'] = $minLength;
}
$maxLength = $type->getMaxLength();
if ($maxLength) {
$result['maxItems'] = $maxLength;
}
return $result;
} elseif ($type instanceof Property\ChoiceType) {
$properties = $type->getProperties();
$props = array();
foreach ($properties as $property) {
$props[] = $this->generateType($property);
}
$result = array('oneOf' => $props);
$description = $type->getDescription();
if (!empty($description)) {
$result['description'] = $description;
}
return $result;
} else {
$result = array();
$result['type'] = $this->getPropertyTypeName($type);
$description = $type->getDescription();
if (!empty($description)) {
$result['description'] = $description;
}
if ($type instanceof Property\StringType) {
$minLength = $type->getMinLength();
if ($minLength) {
$result['minLength'] = $minLength;
}
$maxLength = $type->getMaxLength();
if ($maxLength) {
$result['maxLength'] = $maxLength;
}
$pattern = $type->getPattern();
if ($pattern) {
$result['pattern'] = $pattern;
}
} elseif ($type instanceof Property\DecimalType) {
$min = $type->getMin();
if ($min) {
$result['minimum'] = $min;
}
$max = $type->getMax();
if ($max) {
$result['maximum'] = $max;
}
}
$enumeration = $type->getEnumeration();
if ($enumeration) {
$result['enum'] = $enumeration;
}
return $result;
}
}
protected function setParameterType(PropertyInterface $parameter, &$raml, $indent)
{
$indent = str_repeat(' ', $indent);
switch (true) {
case $parameter instanceof Property\IntegerType:
$raml .= $indent . 'type: integer' . "\n";
break;
case $parameter instanceof Property\FloatType:
$raml .= $indent . 'type: number' . "\n";
break;
case $parameter instanceof Property\BooleanType:
$raml .= $indent . 'type: boolean' . "\n";
break;
case $parameter instanceof Property\DateType:
case $parameter instanceof Property\DateTimeType:
$raml .= $indent . 'type: date' . "\n";
break;
default:
$raml .= $indent . 'type: string' . "\n";
break;
}
$description = $parameter->getDescription();
if (!empty($description)) {
$raml .= $indent . 'description: ' . Inline::dump($parameter->getDescription()) . "\n";
}
$raml .= $indent . 'required: ' . ($parameter->isRequired() ? 'true' : 'false') . "\n";
if ($parameter instanceof Property\DecimalType) {
$min = $parameter->getMin();
$max = $parameter->getMax();
if ($min !== null) {
$raml .= $indent . 'minimum: ' . $min . "\n";
}
if ($max !== null) {
$raml .= $indent . 'maximum: ' . $max . "\n";
}
} elseif ($parameter instanceof Property\StringType) {
$minLength = $parameter->getMinLength();
$maxLength = $parameter->getMaxLength();
$enumeration = $parameter->getEnumeration();
$pattern = $parameter->getPattern();
if ($minLength !== null) {
$raml .= $indent . 'minLength: ' . $minLength . "\n";
}
if ($maxLength !== null) {
$raml .= $indent . 'maxLength: ' . $maxLength . "\n";
}
if (!empty($enumeration)) {
$raml .= $indent . 'enum: ' . Inline::dump($enumeration) . "\n";
}
if (!empty($pattern)) {
$raml .= $indent . 'pattern: ' . Inline::dump($pattern) . "\n";
}
}
}
protected function hasConstraints(PropertyInterface $type)
{
if ($type instanceof Property\CompositeTypeAbstract) {
return true;
} elseif ($type instanceof PropertySimpleAbstract) {
if ($type instanceof Property\DecimalType) {
if ($type->getMin() !== null || $type->getMax() !== null) {
return true;
}
} elseif ($type instanceof Property\StringType) {
if ($type->getMinLength() !== null || $type->getMaxLength() !== null) {
return true;
}
}
if ($type->getPattern() !== null || $type->getEnumeration() !== null) {
return true;
}
}
return false;
}
protected function getValueDescription(PropertyInterface $type)
{
if ($type instanceof Property\ComplexType) {
$span = '<span class="psx-property-type psx-property-type-complex"><a href="#psx-type-' . $type->getId() . '">' . $type->getName() . '</a></span>';
return [$span, null];
} elseif ($type instanceof Property\ArrayType) {
$constraints = array();
$min = $type->getMinLength();
if ($min !== null) {
$constraints['minimum'] = '<span class="psx-constraint-minimum">' . $min . '</span>';
}
$max = $type->getMaxLength();
if ($max !== null) {
$constraints['maximum'] = '<span class="psx-constraint-maximum">' . $max . '</span>';
}
$constraint = $this->constraintToString($constraints);
$property = $this->getValueDescription($type->getPrototype());
$span = '<span class="psx-property-type psx-property-type-array">Array<' . $property[0] . '></span>';
return [$span, $constraint];
} elseif ($type instanceof Property\ChoiceType) {
$choice = array();
$properties = $type->getProperties();
foreach ($properties as $prop) {
$property = $this->getValueDescription($prop);
$choice[] = $property[0];
}
$span = '<span class="psx-property-type psx-property-type-choice">' . implode('|', $choice) . '</span>';
return [$span, null];
} elseif ($type instanceof PropertySimpleAbstract) {
$typeName = ucfirst($type->getTypeName());
$constraints = array();
if ($type->getPattern() !== null) {
$constraints['pattern'] = '<span class="psx-constraint-pattern">' . $type->getPattern() . '</span>';
}
if ($type->getEnumeration() !== null) {
$enumeration = '<ul class="psx-property-enumeration">';
foreach ($type->getEnumeration() as $enum) {
$enumeration .= '<li><span class="psx-constraint-enumeration-value">' . $enum . '</span></li>';
}
$enumeration .= '</ul>';
$constraints['enumeration'] = '<span class="psx-constraint-enumeration">' . $enumeration . '</span>';
}
if ($type instanceof Property\DecimalType) {
$min = $type->getMin();
if ($min !== null) {
$constraints['minimum'] = '<span class="psx-constraint-minimum">' . $min . '</span>';
}
$max = $type->getMax();
if ($max !== null) {
$constraints['maximum'] = '<span class="psx-constraint-maximum">' . $max . '</span>';
}
} elseif ($type instanceof Property\StringType) {
$min = $type->getMinLength();
if ($min !== null) {
$constraints['minimum'] = '<span class="psx-constraint-minimum">' . $min . '</span>';
}
$max = $type->getMaxLength();
if ($max !== null) {
$constraints['maximum'] = '<span class="psx-constraint-maximum">' . $max . '</span>';
}
}
$constraint = $this->constraintToString($constraints);
$cssClass = 'psx-property-type-' . strtolower($typeName);
if ($type instanceof Property\DateType) {
$typeName = '<a href="http://tools.ietf.org/html/rfc3339#section-5.6" title="RFC3339">Date</a>';
} elseif ($type instanceof Property\DateTimeType) {
$typeName = '<a href="http://tools.ietf.org/html/rfc3339#section-5.6" title="RFC3339">DateTime</a>';
} elseif ($type instanceof Property\TimeType) {
$typeName = '<a href="http://tools.ietf.org/html/rfc3339#section-5.6" title="RFC3339">Time</a>';
} elseif ($type instanceof Property\DurationType) {
$typeName = '<span title="ISO 8601">Duration</span>';
}
$span = '<span class="psx-property-type ' . $cssClass . '">' . $typeName . '</span>';
return [$span, $constraint];
}
}
protected function setParameterType(PropertyInterface $parameter, Parameter $param)
{
switch (true) {
case $parameter instanceof Property\IntegerType:
$param->setType('integer');
break;
case $parameter instanceof Property\FloatType:
$param->setType('number');
break;
case $parameter instanceof Property\BooleanType:
$param->setType('boolean');
break;
case $parameter instanceof Property\DateType:
$param->setType('string');
$param->setFormat('date');
break;
case $parameter instanceof Property\DateTimeType:
$param->setType('string');
$param->setFormat('date-time');
break;
default:
$param->setType('string');
break;
}
$param->setDescription($parameter->getDescription());
$param->setRequired($parameter->isRequired());
if ($parameter instanceof Property\DecimalType) {
$param->setMinimum($parameter->getMin());
$param->setMaximum($parameter->getMax());
} elseif ($parameter instanceof Property\StringType) {
$param->setMinimum($parameter->getMinLength());
$param->setMaximum($parameter->getMaxLength());
$param->setEnum($parameter->getEnumeration());
}
}