Updated composer.json. Enhanced doc.

Author: dunglas

README.md

@@ -1,8 +1,8 @@
 {
-    "name": "dunglas/php-schema.org-model",
+    "name": "dunglas/php-schema",
     "type": "library",
     "description": "Various tools to generate a data model based on Schema.org vocables",
-    "keywords": ["schema.org", "model", "doctrine", "entity"],
+    "keywords": ["schema.org", "semantic", "model", "doctrine", "symfony", "entity", "enum"],
     "homepage": "http://dunglas.fr",
     "license": "MIT",
     "authors": [
@@ -29,9 +29,10 @@
         "fabpot/php-cs-fixer": "~1.0"
     },
     "suggest": {
-        "doctrine/orm": "For Doctrine annotations and collections",
-        "symfony/validator": "For constraint annotations",
-        "myclabs/php-enum": "For PHP Enum support"
+        "myclabs/php-enum": "For enumerations",
+        "doctrine/collections": "For Doctrine collections",
+        "doctrine/orm": "For Doctrine annotations",
+        "symfony/validator": "For constraint annotations"
     },
     "bin": ["bin/schema"]
 }

composer.json

@@ -65,6 +65,18 @@ public function generateFieldAnnotations($className, $fieldName)
             $asserts[] = '@Assert\NotNull';
         }
 
+        if ($field['isEnum']) {
+            $assert = sprintf('@Assert\Choice(callback={"%s", "toArray"}', $field['range']);
+
+            if ($field['isArray']) {
+                $assert .= ', multiple=true';
+            }
+
+            $assert .= ')';
+
+            $asserts[] = $assert;
+        }
+
         return $asserts;
     }
 
@@ -73,6 +85,25 @@ public function generateFieldAnnotations($className, $fieldName)
      */
     public function generateUses($className)
     {
-        return $this->classes[$className]['isEnum'] ? [] : ['Symfony\Component\Validator\Constraints as Assert'];
+        if ($this->classes[$className]['isEnum']) {
+            return [];
+        }
+
+        $uses = [];
+        $uses[] = 'Symfony\Component\Validator\Constraints as Assert';
+
+        foreach ($this->classes[$className]['fields'] as $field) {
+            if ($field['isEnum']) {
+                $enumClass = $this->classes[$field['range']];
+                $enumNamespace = isset($enumClass['namespaces']['class']) && $enumClass['namespaces']['class'] ? $enumClass['namespaces']['class'] : $this->config['namespaces']['enum'];
+                $use = sprintf('%s\%s', $enumNamespace, $field['range']);
+
+                if (!in_array($use, $uses)) {
+                    $uses[] = $use;
+                }
+            }
+        }
+
+        return $uses;
     }
 }

src/SchemaOrgModel/AnnotationGenerator/ConstraintAnnotationGenerator.php

@@ -94,7 +94,7 @@ private function extractForProperty(\EasyRdf_Resource $property)
         ||
             preg_match('/^The /', $comment)
         ) {
-            return self::CARDINALITY_1_1;
+            return self::CARDINALITY_0_1;
         }
 
         return self::CARDINALITY_UNKNOWN;

src/SchemaOrgModel/CardinalitiesExtractor.php

@@ -28,7 +28,7 @@ class DumpConfigurationCommand extends Command
     protected function configure()
     {
         $this
-            ->setName('schema:dump-configuration')
+            ->setName('dump-configuration')
             ->setDescription('Dump configuration')
         ;
     }

src/SchemaOrgModel/Command/DumpConfigurationCommand.php

@@ -29,7 +29,7 @@ class ExtractCardinalitiesCommand extends Command
     protected function configure()
     {
         $this
-            ->setName('schema:extract-cardinalities')
+            ->setName('extract-cardinalities')
             ->setDescription('Extract properties\' cardinality')
         ;
     }

src/SchemaOrgModel/Command/ExtractCardinalitiesCommand.php

@@ -34,7 +34,7 @@ class GenerateTypesCommand extends Command
     protected function configure()
     {
         $this
-            ->setName('schema:generate-types')
+            ->setName('generate-types')
             ->setDescription('Generate types')
             ->addArgument('output', InputArgument::REQUIRED, 'The output directory')
             ->addArgument('config', InputArgument::OPTIONAL, 'The config file to use')

src/SchemaOrgModel/Command/GenerateTypesCommand.php

@@ -150,6 +150,7 @@ public function generate($config)
             $class['name'] = $type->localName();
             $class['label'] = $type->get('rdfs:comment')->getValue();
             $class['resource'] = $type;
+            $class['config'] = $typeConfig;
 
             $class['isEnum'] = $this->isEnum($type);
             if ($class['isEnum']) {

src/SchemaOrgModel/TypesGenerator.php

@@ -19,7 +19,7 @@
  */
 class TypesGeneratorConfiguration implements ConfigurationInterface
 {
-    const SCHEMA_ORG_RDFA_URL = 'https://raw.githubusercontent.com/rvguha/schemaorg/master/data/schema.rdfa';
+    const SCHEMA_ORG_RDFA_URL = 'http://schema.org/docs/schema_org_rdfa.html';
     const GOOD_RELATIONS_OWL_URL = 'http://purl.org/goodrelations/v1.owl';
 
     /**

src/SchemaOrgModel/TypesGeneratorConfiguration.php

@@ -1,34 +1,32 @@
+# The PHP namespace of generated entities
 namespaces:
   entity: "AddressBook\Entity"
+# The list of types and properties we want to use
 types:
+  # Parent class of Person
   Thing:
     properties:
       name: ~
-      url: ~
   Person:
     properties:
+      familyName: ~
+      givenName: ~
       additionalName: ~
+      gender: ~
       address: ~
       birthDate: ~
-      email: ~
-      familyName: ~
-      faxNumber: ~
-      gender: ~
-      givenName: ~
-      honorificPrefix: ~
-      honorificSuffix: ~
-      jobTitle: ~
       telephone: ~
+      email: ~
       url: ~
-      worksFor: ~
+      jobTitle: ~
   PostalAddress:
+    # Disable the generation of the class hierarchy for this type
     parent: false
     properties:
-      addressCountry: { range: Text }
+      # Force the type of the addressCountry property to text
+      addressCountry: { range: "Text" }
       addressLocality: ~
       addressRegion: ~
       postOfficeBoxNumber: ~
       postalCode: ~
       streetAddress: ~
-  Organization:
-    properties: {}