Doc for Schema Generator 3.0 (#1251)

Author: dunglas

schema-generator/configuration.md

@@ -114,7 +114,6 @@ Example:
         abstract: true
 ```
 
-
 ## Forcing a Nullable Property
 
 Force a property to be (or to not be) `nullable`.
@@ -135,13 +134,12 @@ The `@Assert\NotNull` constrain is automatically added.
 <?php
 
 /**
- * @var string The name of the item.
+ * The name of the item.
  *
  * @ORM\Column
- * @Assert\Type(type="string")
  * @Assert\NotNull
  */
-  private $name;
+  private string $name;
 ```
 
 ## Forcing a Unique Property
@@ -178,12 +176,12 @@ use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 class Person
 {
     /**
-     * @var string Email address.
+     * Email address.
      *
      * @ORM\Column
      * @Assert\Email
      */
-    private $email;
+    private string $email;
 ```
 
 ## Making a Property Read-Only
@@ -251,14 +249,16 @@ use Symfony\Component\Serializer\Annotation\Groups;
 class Person
 {
     /**
-     * @var string The name of the item.
+     * The name of the item.
+     *
+     * @see https://schema.org/name
      *
      * @ORM\Column(nullable=true)
      * @Assert\Type(type="string")
      * @Iri("https://schema.org/name")
      * @Groups({"public"})
      */
-    private $name;
+    private string $name;
 
 ```
 
@@ -304,12 +304,14 @@ use Doctrine\ORM\Mapping as ORM;
 class Product
 {
     /**
-     * @var QuantitativeValue|null the weight of the product or person
+     * the weight of the product or person
+     *
+     * @see http://schema.org/weight
      *
      * @ORM\Embedded(class="App\Entity\QuantitativeValue", columnPrefix="weight_")
      * @ApiProperty(iri="http://schema.org/weight")
      */
-    private $weight;
+    private ?QuantitativeValue $weight = null;
 
 ```
 
@@ -479,7 +481,7 @@ You can also use any other vocabulary. Check the [Linked Open Vocabularies](http
 
 For instance, to generate a data model from the [Video Game Ontology](http://purl.org/net/VideoGameOntology), use the following config file:
 
-```
+```yaml
 rdfa:
   - http://vocab.linkeddata.es/vgo/GameOntologyv3.owl # The URL of the vocabulary definition
 
@@ -508,33 +510,35 @@ header: |
     /*
      * This file is part of the Ecommerce package.
      *
-     * (c) Kévin Dunglas <[email protected]>
+     * (c) Kévin Dunglas <[email protected]>
      *
      * For the full copyright and license information, please view the LICENSE
      * file that was distributed with this source code.
      */
 ```
 
-
 ## Full Configuration Reference
 
 ```yaml
 config:
 
-    # RDFa files
-    rdfa:
+    # RDF vocabularies
+    vocabularies:
 
         # Prototype
         -
 
-            # RDFa URI to use
-            uri:                  'https://schema.org/docs/schema_org_rdfa.html' # Example: https://schema.org/docs/schema_org_rdfa.html
+            # RDF vocabulary to use
+            uri:                  'https://schema.org/version/latest/schemaorg-current-http.rdf' # Example: 'https://schema.org/version/latest/schemaorg-current-http.rdf'
 
-            # RDFa URI data format
+            # RDF vocabulary format
             format:               null # Example: rdfxml
 
-    # OWL relation files to use
-    relations:
+    # Namespace of the vocabulary to import
+    vocabularyNamespace:  'http://schema.org/' # Example: 'http://www.w3.org/ns/activitystreams#'
+
+    # OWL relation files containing cardinality information in the GoodRelations format
+    relations:            # Example: 'https://purl.org/goodrelations/v1.owl'
 
         # Default:
         - https://purl.org/goodrelations/v1.owl
@@ -554,26 +558,32 @@ config:
         # Is the ID writable? Only applicable if "generationStrategy" is "uuid".
         writable:             false
 
+        # Set to "child" to generate the id on the child class, and "parent" to use the parent class instead.
+        onClass:              child # One of "child"; "parent"
+
     # Generate interfaces and use Doctrine's Resolve Target Entity feature
     useInterface:         false
 
     # Emit a warning if a property is not derived from GoodRelations
     checkIsGoodRelations: false
 
     # A license or any text to use as header of generated files
-    header:               false # Example: // (c) Kévin Dunglas <[email protected]>
+    header:               false # Example: '// (c) Kévin Dunglas <[email protected]>'
 
     # PHP namespaces
     namespaces:
 
+        # The global namespace's prefix
+        prefix:               null # Example: App\
+
         # The namespace of the generated entities
-        entity:               App\Entity # Example: Acme\Entity
+        entity:               App\Entity # Example: App\Entity
 
         # The namespace of the generated enumerations
-        enum:                 App\Enum # Example: Acme\Enum
+        enum:                 App\Enum # Example: App\Enum
 
         # The namespace of the generated interfaces
-        interface:            App\Model # Example: Acme\Model
+        interface:            App\Model # Example: App\Model
 
     # Doctrine
     doctrine:
@@ -584,14 +594,17 @@ config:
         # The Resolve Target Entity Listener config file pass
         resolveTargetEntityConfigPath: null
 
+        # Doctrine inheritance annotations (if set, no other annotations are generated)
+        inheritanceAnnotations: []
+
     # Symfony Validator Component
     validator:
 
         # Generate @Assert\Type annotation
         assertType:           false
 
     # The value of the phpDoc's @author annotation
-    author:               false # Example: Kévin Dunglas <[email protected]>
+    author:               false # Example: 'Kévin Dunglas <[email protected]>'
 
     # Visibility of entities fields
     fieldVisibility:      private # One of "private"; "protected"; "public"
@@ -601,15 +614,25 @@ config:
 
     # Set this flag to true to generate fluent setter, adder and remover methods
     fluentMutatorMethods: false
+    rangeMapping:
+
+        # Prototype
+        name:                 ~
 
-    # Schema.org's types to use
+    # Generate all types, even if an explicit configuration exists
+    allTypes:             false
+
+    # Types to import from the vocabulary
     types:
 
         # Prototype
         id:
 
-            # Namespace of the vocabulary the type belongs to.
-            vocabularyNamespace:  'http://schema.org/'
+            # Exclude this type, even if "allTypes" is set to true"
+            exclude:              false
+
+            # Namespace of the vocabulary of this type (defaults to the global "vocabularyNamespace" entry)
+            vocabularyNamespace:  null # Example: 'http://www.w3.org/ns/activitystreams#'
 
             # Is the class abstract? (null to guess)
             abstract:             null
@@ -627,8 +650,8 @@ config:
                 interface:            null
             doctrine:
 
-                # The Doctrine inheritance mapping type (override the guessed one)
-                inheritanceMapping:   null
+                # Doctrine annotations (if set, no other annotations are generated)
+                annotations:          []
 
             # The parent class, set to false for a top level class
             parent:               false
@@ -645,6 +668,9 @@ config:
                 # Prototype
                 id:
 
+                    # Exclude this property, even if "allProperties" is set to true"
+                    exclude:              false
+
                     # The property range
                     range:                null # Example: Offer
 
@@ -653,11 +679,17 @@ config:
                     cardinality:          unknown # One of "(0..1)"; "(0..*)"; "(1..1)"; "(1..*)"; "(*..0)"; "(*..1)"; "(*..*)"; "unknown"
 
                     # The doctrine column annotation content
-                    ormColumn:            null # Example: type="decimal", precision=5, scale=1, options={"comment" = "my comment"}
+                    ormColumn:            null # Example: 'type="decimal", precision=5, scale=1, options={"comment" = "my comment"}'
 
                     # Symfony Serialization Groups
                     groups:               []
 
+                    # The doctrine mapped by attribute
+                    mappedBy:             null # Example: partOfSeason
+
+                    # The doctrine inversed by attribute
+                    inversedBy:           null # Example: episodes
+
                     # Is the property readable?
                     readable:             true
 
@@ -674,7 +706,7 @@ config:
                     embedded:             false
 
                     # The property columnPrefix
-                    columnPrefix:         false # Example: "weight_"
+                    columnPrefix:         false
 
     # Annotation generators to use
     annotationGenerators:
@@ -685,4 +717,7 @@ config:
         - ApiPlatform\SchemaGenerator\AnnotationGenerator\ApiPlatformCoreAnnotationGenerator
         - ApiPlatform\SchemaGenerator\AnnotationGenerator\ConstraintAnnotationGenerator
         - ApiPlatform\SchemaGenerator\AnnotationGenerator\SerializerGroupsAnnotationGenerator
+
+    # Directories for custom generator twig templates
+    generatorTemplates:   []
 ```