Skip to content

fix: support the latest version of Schema.org #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2020
Merged

fix: support the latest version of Schema.org #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
/vendor/
/*.phar
/.phpunit.result.cache
/tmp
4 changes: 2 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"php": ">=7.4",
"ext-json": "*",
"doctrine/inflector": "^1.4.3 || ^2.0",
"easyrdf/easyrdf": "^0.9",
"easyrdf/easyrdf": "dev-master",
"friendsofphp/php-cs-fixer": "^2.15",
"league/html-to-markdown": "^4.9",
"psr/log": "^1.0",
Expand All @@ -32,7 +32,7 @@
},
"require-dev": {
"api-platform/core": "^2.6",
"doctrine/orm": "^2.8",
"doctrine/orm": "^2.7",
"myclabs/php-enum": "^1.7",
"symfony/doctrine-bridge": "^5.1",
"symfony/filesystem": "^5.1",
Expand Down
51 changes: 29 additions & 22 deletions composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion src/AnnotationGenerator/AbstractAnnotationGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace ApiPlatform\SchemaGenerator\AnnotationGenerator;

use Doctrine\Inflector\Inflector;
use EasyRdf\Graph;
use Psr\Log\LoggerInterface;

/**
Expand All @@ -34,7 +35,7 @@ abstract class AbstractAnnotationGenerator implements AnnotationGeneratorInterfa
protected $logger;

/**
* @var \EasyRdf_Graph[]
* @var Graph[]
*/
protected $graphs;

Expand Down
3 changes: 2 additions & 1 deletion src/AnnotationGenerator/AnnotationGeneratorInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace ApiPlatform\SchemaGenerator\AnnotationGenerator;

use Doctrine\Inflector\Inflector;
use EasyRdf\Graph;
use Psr\Log\LoggerInterface;

/**
Expand All @@ -24,7 +25,7 @@
interface AnnotationGeneratorInterface
{
/**
* @param \EasyRdf_Graph[] $graphs
* @param Graph[] $graphs
*/
public function __construct(Inflector $inflector, LoggerInterface $logger, array $graphs, array $cardinalities, array $config, array $classes);

Expand Down
122 changes: 70 additions & 52 deletions src/AnnotationGenerator/DoctrineOrmAnnotationGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,64 +140,78 @@ public function generateFieldAnnotations(string $className, string $fieldName):
}

$annotations[] = $annotation;
} elseif ($field['isEmbedded']) {

return $annotations;
}

$relationName = $field['range'] ? $this->getRelationName($field['range']) : null;
if ($field['isEmbedded']) {
$columnPrefix = ', columnPrefix=';
if (\is_bool($field['columnPrefix'])) {
$columnPrefix .= $field['columnPrefix'] ? 'true' : 'false';
} else {
$columnPrefix .= sprintf('"%s"', $field['columnPrefix']);
}
$annotations[] = sprintf('@ORM\Embedded(class="%s"%s)', $this->getRelationName($field['range']), $columnPrefix);
} else {
switch ($field['cardinality']) {
case CardinalitiesExtractor::CARDINALITY_0_1:
$annotations[] = sprintf('@ORM\OneToOne(targetEntity="%s")', $this->getRelationName($field['range']));
break;
case CardinalitiesExtractor::CARDINALITY_1_1:
$annotations[] = sprintf('@ORM\OneToOne(targetEntity="%s")', $this->getRelationName($field['range']));
$annotations[] = '@ORM\JoinColumn(nullable=false)';
break;
case CardinalitiesExtractor::CARDINALITY_UNKNOWN:
case CardinalitiesExtractor::CARDINALITY_N_0:
if ($field['inversedBy'] ?? false) {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s", inversedBy="%s")', $this->getRelationName($field['range']), $field['inversedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s")', $this->getRelationName($field['range']));
}
break;
case CardinalitiesExtractor::CARDINALITY_N_1:
if ($field['inversedBy'] ?? false) {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s", inversedBy="%s")', $this->getRelationName($field['range']), $field['inversedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s")', $this->getRelationName($field['range']));
}
$annotations[] = '@ORM\JoinColumn(nullable=false)';
break;
case CardinalitiesExtractor::CARDINALITY_0_N:
if ($field['mappedBy'] ?? false) {
$annotations[] = sprintf('@ORM\OneToMany(targetEntity="%s", mappedBy="%s")', $this->getRelationName($field['range']), $field['mappedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToMany(targetEntity="%s")', $this->getRelationName($field['range']));
}
$name = $field['relationTableName'] ? sprintf('name="%s", ', $field['relationTableName']) : '';
$annotations[] = '@ORM\JoinTable('.$name.'inverseJoinColumns={@ORM\JoinColumn(unique=true)})';
break;
case CardinalitiesExtractor::CARDINALITY_1_N:
if ($field['mappedBy'] ?? false) {
$annotations[] = sprintf('@ORM\OneToMany(targetEntity="%s", mappedBy="%s")', $this->getRelationName($field['range']), $field['mappedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToMany(targetEntity="%s")', $this->getRelationName($field['range']));
}
$name = $field['relationTableName'] ? sprintf('name="%s", ', $field['relationTableName']) : '';
$annotations[] = '@ORM\JoinTable('.$name.'inverseJoinColumns={@ORM\JoinColumn(nullable=false, unique=true)})';
break;
case CardinalitiesExtractor::CARDINALITY_N_N:
$annotations[] = sprintf('@ORM\ManyToMany(targetEntity="%s")', $this->getRelationName($field['range']));
if ($field['relationTableName']) {
$annotations[] = sprintf('@ORM\JoinTable(name="%s")', $field['relationTableName']);
}
break;

if ($relationName) {
$annotations[] = sprintf('@ORM\Embedded(class="%s"%s)', $relationName, $columnPrefix);
}

return $annotations;
}

if (!$relationName) {
return $annotations;
}

switch ($field['cardinality']) {
case CardinalitiesExtractor::CARDINALITY_0_1:
$annotations[] = sprintf('@ORM\OneToOne(targetEntity="%s")', $relationName);
break;
case CardinalitiesExtractor::CARDINALITY_1_1:
$annotations[] = sprintf('@ORM\OneToOne(targetEntity="%s")', $relationName);
$annotations[] = '@ORM\JoinColumn(nullable=false)';
break;
case CardinalitiesExtractor::CARDINALITY_UNKNOWN:
case CardinalitiesExtractor::CARDINALITY_N_0:
if ($field['inversedBy'] ?? false) {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s", inversedBy="%s")', $relationName, $field['inversedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s")', $relationName);
}
break;
case CardinalitiesExtractor::CARDINALITY_N_1:
if ($field['inversedBy'] ?? false) {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s", inversedBy="%s")', $relationName, $field['inversedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToOne(targetEntity="%s")', $relationName);
}
$annotations[] = '@ORM\JoinColumn(nullable=false)';
break;
case CardinalitiesExtractor::CARDINALITY_0_N:
if ($field['mappedBy'] ?? false) {
$annotations[] = sprintf('@ORM\OneToMany(targetEntity="%s", mappedBy="%s")', $relationName, $field['mappedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToMany(targetEntity="%s")', $relationName);
}
$name = $field['relationTableName'] ? sprintf('name="%s", ', $field['relationTableName']) : '';
$annotations[] = '@ORM\JoinTable('.$name.'inverseJoinColumns={@ORM\JoinColumn(unique=true)})';
break;
case CardinalitiesExtractor::CARDINALITY_1_N:
if ($field['mappedBy'] ?? false) {
$annotations[] = sprintf('@ORM\OneToMany(targetEntity="%s", mappedBy="%s")', $relationName, $field['mappedBy']);
} else {
$annotations[] = sprintf('@ORM\ManyToMany(targetEntity="%s")', $relationName);
}
$name = $field['relationTableName'] ? sprintf('name="%s", ', $field['relationTableName']) : '';
$annotations[] = '@ORM\JoinTable('.$name.'inverseJoinColumns={@ORM\JoinColumn(nullable=false, unique=true)})';
break;
case CardinalitiesExtractor::CARDINALITY_N_N:
$annotations[] = sprintf('@ORM\ManyToMany(targetEntity="%s")', $relationName);
if ($field['relationTableName']) {
$annotations[] = sprintf('@ORM\JoinTable(name="%s")', $field['relationTableName']);
}
break;
}

return $annotations;
Expand Down Expand Up @@ -243,8 +257,12 @@ private function generateIdAnnotations(): array
/**
* Gets class or interface name to use in relations.
*/
private function getRelationName(string $range): string
private function getRelationName(string $range): ?string
{
if (!isset($this->classes[$range])) {
return null;
}

$class = $this->classes[$range];

if (isset($class['interfaceName'])) {
Expand Down
9 changes: 6 additions & 3 deletions src/CardinalitiesExtractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

namespace ApiPlatform\SchemaGenerator;

use EasyRdf\Graph;
use EasyRdf\Resource;

/**
* Cardinality extractor.
*
Expand All @@ -30,14 +33,14 @@ class CardinalitiesExtractor
public const CARDINALITY_UNKNOWN = 'unknown';

/**
* @var \EasyRdf_Graph[]
* @var Graph[]
*/
private $graphs;

private $goodRelationsBridge;

/**
* @param \EasyRdf_Graph[] $graphs
* @param Graph[] $graphs
*/
public function __construct(array $graphs, GoodRelationsBridge $goodRelationsBridge)
{
Expand Down Expand Up @@ -68,7 +71,7 @@ public function extract(): array
*
* @return string The cardinality
*/
private function extractForProperty(\EasyRdf_Resource $property): string
private function extractForProperty(Resource $property): string
{
$localName = $property->localName();
$fromGoodRelations = $this->goodRelationsBridge->extractCardinality($localName);
Expand Down
Loading