tflori/orm

» API Reference » ORM\Relation\ManyToMany

ORM\Relation\ManyToMany

Table of Contents

• Abstract
• Methods
  • $manyToMany->__construct - ManyToMany constructor.
  • $manyToMany->addJoin - {@inheritdoc}
  • $manyToMany->addRelated - Add $entities to association table
  • ManyToMany::createRelation - Factory for relation definition object
  • $manyToMany->deleteRelated - Delete $entities from association table
  • $manyToMany->eagerLoad - Load this relation for all $entities with one query
  • $manyToMany->fetch - Fetch the relation
  • $manyToMany->fetchAll - Fetch all from the relation
  • ManyToMany::fromShort - {@inheritDoc}
  • $manyToMany->getReference -
  • $manyToMany->getTable -
  • $manyToMany->setRelated - Set the relation to $entity

Abstract

Extends: ORM\Relation

ManyToMany Relation

Methods

ORM\Relation\ManyToMany::__construct

public function __construct(
    string $class, 
    array $reference, 
    string $opponent, 
    string $table, 
    \ORM\EntityFetcher\FilterInterface[]|callable[] $filters = [], 
)

ManyToMany constructor.

Parameters

ORM\Relation\ManyToMany::__construct

↑ top

ORM\Relation\ManyToMany::addJoin

public function addJoin(
    \ORM\EntityFetcher $fetcher, 
    mixed $join, 
    mixed $alias, 
): mixed

{@inheritdoc}

Parameters

ORM\Relation\ManyToMany::addJoin

↑ top

ORM\Relation\ManyToMany::addRelated

public function addRelated(
    \ORM\Entity $self, 
    \ORM\Entity[] $entities, 
    \ORM\EntityManager $entityManager, 
): mixed

Add $entities to association table

Parameters

ORM\Relation\ManyToMany::addRelated

↑ top

ORM\Relation\ManyToMany::createRelation

public static function createRelation(
    string $parent, 
    string $name, 
    array $relDef, 
): \ORM\Relation

Factory for relation definition object

Parameters

ORM\Relation\ManyToMany::createRelation

↑ top

ORM\Relation\ManyToMany::deleteRelated

public function deleteRelated(
    \ORM\Entity $self, 
    \ORM\Entity[] $entities, 
    \ORM\EntityManager $entityManager, 
): mixed

Delete $entities from association table

Parameters

ORM\Relation\ManyToMany::deleteRelated

↑ top

ORM\Relation\ManyToMany::eagerLoad

public function eagerLoad(\ORM\EntityManager $em, \ORM\Entity $entities): mixed

Load this relation for all $entities with one query

Parameters

ORM\Relation\ManyToMany::eagerLoad

↑ top

ORM\Relation\ManyToMany::fetch

abstract public function fetch(
    \ORM\Entity $self, 
    \ORM\EntityManager $entityManager, 
): mixed

Fetch the relation

Runs fetch on the EntityManager and returns its result.

Parameters

ORM\Relation\ManyToMany::fetch

↑ top

ORM\Relation\ManyToMany::fetchAll

public function fetchAll(
    \ORM\Entity $self, 
    \ORM\EntityManager $entityManager, 
): \ORM\Entity[]|\ORM\Entity

Fetch all from the relation

Runs fetch and returns EntityFetcher::all() if a Fetcher is returned.

Parameters

ORM\Relation\ManyToMany::fetchAll

↑ top

ORM\Relation\ManyToMany::fromShort

public static function fromShort(mixed $parent, array $short): mixed

{@inheritDoc}

Parameters

ORM\Relation\ManyToMany::fromShort

↑ top

ORM\Relation\ManyToMany::getReference

public function getReference(): mixed

ORM\Relation\ManyToMany::getReference

↑ top

ORM\Relation\ManyToMany::getTable

public function getTable(): string

ORM\Relation\ManyToMany::getTable

↑ top

ORM\Relation\ManyToMany::setRelated

public function setRelated(
    \ORM\Entity $self, 
    \ORM\Entity|null $entity = null, 
): mixed

Set the relation to $entity

Parameters

ORM\Relation\ManyToMany::setRelated

↑ top