feat: adds validation classes

Author: itsjavi

README.md

@@ -5,7 +5,7 @@
 [![Build Status][ico-travis]][link-travis]
 [![Total Downloads][ico-downloads]][link-downloads]
 
-Open API 3.0 spec generator for PHP.
+Open API 3.0 builder and validation library for PHP that helps you write valid specs.
 
 [PSR-1]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
 [PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
@@ -17,11 +17,13 @@ If you notice compliance oversights, please send a patch via pull request.
 
 ## Features
 
-- Object-oriented representation of the 
-[Open API 3.0+](https://github.com/OAI/OpenAPI-Specification/tree/master/versions) specification.
+- Fully documented object-oriented representation of the 
+[Open API 3.0+](https://github.com/OAI/OpenAPI-Specification/tree/master/versions) specification with helper methods
+to write valid documents.
 - Supports Illuminate (Laravel) [`Jsonable`](https://github.com/illuminate/contracts/blob/v5.4.0/Support/Jsonable.php) 
 and [`Arrayable`](https://github.com/illuminate/contracts/blob/v5.4.0/Support/Arrayable.php).
-- Generates an specification in plain PHP arrays, JSON or YAML.
+- Generates an specification in plain PHP arrays, plain objects, JSON or YAML.
+- Validates Open API documents against the Open API 3.0.x JSON Schema.
 
 
 ## Install

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "erasys/openapi-php",
   "type": "library",
-  "description": "Open API 3.0 spec generator for PHP.",
+  "description": "Open API 3.0 builder and validation library for PHP that helps you write valid specs.",
   "keywords": [
     "openapi",
     "openapi3",
@@ -27,7 +27,8 @@
   "require": {
     "php": "^7.0",
     "illuminate/contracts": "^5.4",
-    "symfony/yaml": "^3.4"
+    "symfony/yaml": "^3.4",
+    "justinrainbow/json-schema": "^5.2"
   },
   "require-dev": {
     "phpunit/phpunit": "^6.5",

src/Spec/v3/AbstractObject.php

@@ -8,11 +8,19 @@
 use Illuminate\Contracts\Support\Jsonable;
 use JsonSerializable;
 use LogicException;
+use stdClass;
 use Symfony\Component\Yaml\Yaml;
 
+/**
+ * Base class for all Open API models.
+ *
+ * Note that defining or accessing properties dynamically is not supported by design
+ * to avoid invalid schema generation. If you need to use specification extensions,
+ * you can always extend the classes and add there your own properties.
+ *
+ */
 abstract class AbstractObject implements ArrayAccess, Arrayable, Jsonable, JsonSerializable
 {
-
     /**
      * @param array $properties
      */
@@ -153,6 +161,16 @@ public function toJson($options = 0)
         return json_encode($this, $options);
     }
 
+    /**
+     * Returns a plain object
+     *
+     * @return object|stdClass
+     */
+    public function toObject(): stdClass
+    {
+        return json_decode($this->toJson());
+    }
+
     /**
      * @param int $inline
      * @param int $indentation