How do I define a OneToMany relationship in the schema.yml file

[toby-griffiths]

I'm trying to create a OneToMany relationship in my schema.yml file, as I can see the documentation that the Person class has an $address that's a @ManyToOne, but I cannot find info on how to configure this from the schema.yml file.

Is this possible, and if so, is it documented anywhere?

[Charl13]

Noticed this as well. It automatically generates a many-to-many relationship when setting the cardinality:

schema.yml

namespaces:
  entity: App\Model
types:
   Test:
    properties:
      name: { nullable: false, range: "Text", ormColumn: 'type="string", nullable=false, unique=true' }
      roles: { range: "Role", cardinality: "(1..*)"}

  Role:
    properties:
      name: { nullable: false, range: "Text", ormColumn: 'type="string", nullable=false' }
      score: { nullable: false, range: "Integer", ormColumn: 'type="integer", nullable=false' }

Role.php

<?php

declare(strict_types=1);

namespace App\Model;

use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Represents additional information about a relationship or property. For example a Role can be used to say that a 'member' role linking some SportsTeam to a player occurred during a particular time period. Or that a Person's 'actor' role in a Movie was for some particular characterName. Such properties can be attached to a Role entity, which is then associated with the main entities using ordinary properties like 'member' or 'actor'.\\n\\nSee also \[blog post\](http://blog.schema.org/2014/06/introducing-role.html).
 *
 * @see http://schema.org/Role Documentation on Schema.org
 *
 * @author Charlie Vieillard <charlie@labrooms.com>
 *
 * @ORM\Entity
 * @ApiResource(iri="http://schema.org/Role")
 */
class Role
{
    /**
     * @var int|null
     *
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @var string the name of the item
     *
     * @ORM\Column(type="string", nullable=false)
     * @ApiProperty(iri="http://schema.org/name")
     * @Assert\NotNull
     */
    private $name;

    /**
     * @var int
     *
     * @ORM\Column(type="integer", nullable=false)
     * @Assert\NotNull
     */
    private $score;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setScore(int $score): void
    {
        $this->score = $score;
    }

    public function getScore(): int
    {
        return $this->score;
    }
}

Test.php

<?php

declare(strict_types=1);

namespace App\Model;

use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * The most generic type of item.
 *
 * @see http://schema.org/Thing Documentation on Schema.org
 *
 * @author Charlie Vieillard <charlie@labrooms.com>
 *
 * @ORM\Entity
 * @ApiResource(iri="http://schema.org/Thing")
 */
class Test
{
    /**
     * @var int|null
     *
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @var string the name of the item
     *
     * @ORM\Column(type="string", nullable=false, unique=true)
     * @ApiProperty(iri="http://schema.org/name")
     * @Assert\NotNull
     */
    private $name;

    /**
     * @var Collection<Role>
     *
     * @ORM\ManyToMany(targetEntity="App\Model\Role")
     * @ORM\JoinTable(inverseJoinColumns={@ORM\JoinColumn(nullable=false, unique=true)})
     * @Assert\NotNull
     */
    private $roles;

    public function __construct()
    {
        $this->roles = new ArrayCollection();
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function addRole(Role $role): void
    {
        $this->roles[] = $role;
    }

    public function removeRole(Role $role): void
    {
        $this->roles->removeElement($role);
    }

    public function getRoles(): Collection
    {
        return $this->roles;
    }
}

I would expect to be able to generate something like:

Role.php

class Role
{
    // ...
    /**
     * @ManyToOne(targetEntity="App\Model\Test", inversedBy="roles")
     * @JoinColumn(name="test_id", referencedColumnName="id")
     */
    private $test;
    // ...
}

Test.php

class Test
{
    // ...
    /**
     * @OneToMany(targetEntity="App\Model\Role", mappedBy="test")
     */
    private $roles;
    // ...
}

[comxd]

Hi :)

We can use an ManyToOne relation using: (*..0), for the OneToMany relation, take a look at https://github.com/api-platform/schema-generator/blob/master/src/CardinalitiesExtractor.php for all available options.

    public const CARDINALITY_0_1 = '(0..1)';
    public const CARDINALITY_0_N = '(0..*)';
    public const CARDINALITY_1_1 = '(1..1)';
    public const CARDINALITY_1_N = '(1..*)';
    public const CARDINALITY_N_0 = '(*..0)';
    public const CARDINALITY_N_1 = '(*..1)';
    public const CARDINALITY_N_N = '(*..*)';
    public const CARDINALITY_UNKNOWN = 'unknown';

[toby-griffiths]

Ah. Thanks for the advice. I'll give it a go.

[toby-griffiths]

@comxd I've tested this now, and it works OK from the Many side of the relationship (cardinality: '(*..0)', however the opposite side (cardinality: '(0..*)') still returns a ManyToMany relationship.

I found the faulty code in DoctrineOrmAnnotationGenerator …

            switch ($field['cardinality']) {
                // ....
                case CardinalitiesExtractor::CARDINALITY_0_N:
                    $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;
                // ....
            }

[toby-griffiths]

Would I be OK to simply update this to return…

$annotations[] = sprintf('@ORM\OneToMany(targetEntity="%s")', $this->getRelationName($field['range']));

Also, is there any way of defining the mappedBy or inversedBy annotations at all?

[toby-griffiths]

Thinking about this, it probably wants a little more thought, as if the cardinality is 0..N then the field should be nullable as well.

If I can get time I'll submit a PR, but not sure when I'll get around to it.

[janklan]

@toby-griffiths have you had a chance to work on this?