tflori/orm

» API Reference » ORM\Relation\Morphed

ORM\Relation\Morphed

Table of Contents

• Abstract
• Methods
  • $morphed->__construct - Owner constructor.
  • $morphed->addJoin - {@inheritdoc}
  • $morphed->addRelated - Add $entities to association table
  • $morphed->apply - Apply where conditions for $entity on $fetcher
  • $morphed->applyJoin - Adds the join clause to the entity fetcher
  • Morphed::createRelation - Factory for relation definition object
  • $morphed->deleteRelated - Delete $entities from association table
  • $morphed->eagerLoad - Load all foreign objects of all $entities with one query
  • $morphed->eagerLoadSelf -
  • $morphed->fetch - Fetch the relation
  • $morphed->fetchAll - Fetch all from the relation
  • Morphed::fromAssoc - {@inheritDoc}
  • Morphed::fromShort - {@inheritDoc}
  • $morphed->getReference -
  • $morphed->setRelated - Set the relation to $entity

Abstract

Extends: ORM\Relation\Owner

Owner Relation

Methods

ORM\Relation\Morphed::__construct

public function __construct(string $class, array $reference)

Owner constructor.

Parameters

ORM\Relation\Morphed::__construct

↑ top

ORM\Relation\Morphed::addJoin

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

{@inheritdoc}

Parameters

ORM\Relation\Morphed::addJoin

↑ top

ORM\Relation\Morphed::addRelated

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

Add $entities to association table

Parameters

ORM\Relation\Morphed::addRelated

↑ top

ORM\Relation\Morphed::apply

public function apply(\ORM\EntityFetcher $fetcher, \ORM\Entity $entity): mixed

Apply where conditions for $entity on $fetcher

Called from non-owner to find related elements. Example: $user->fetch(‘articles’) creates an EntityFetcher for Article and calls $opponent->apply($fetcher, $user) that will call $fetcher->where(‘authorId’, $user->id)

Parameters

ORM\Relation\Morphed::apply

↑ top

ORM\Relation\Morphed::applyJoin

public function applyJoin(
    \ORM\QueryBuilder\Parenthesis $join, 
    string $yourAlias, 
    \ORM\Relation\OneToMany $opponent, 
): mixed

Adds the join clause to the entity fetcher

Parameters

ORM\Relation\Morphed::applyJoin

↑ top

ORM\Relation\Morphed::createRelation

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

Factory for relation definition object

Parameters

ORM\Relation\Morphed::createRelation

↑ top

ORM\Relation\Morphed::deleteRelated

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

Delete $entities from association table

Parameters

ORM\Relation\Morphed::deleteRelated

↑ top

ORM\Relation\Morphed::eagerLoad

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

Load all foreign objects of all $entities with one query

Parameters

ORM\Relation\Morphed::eagerLoad

↑ top

ORM\Relation\Morphed::eagerLoadSelf

public function eagerLoadSelf(
    \ORM\EntityManager $em, 
    \ORM\Entity $foreignObjects, 
): mixed

Parameters

ORM\Relation\Morphed::eagerLoadSelf

↑ top

ORM\Relation\Morphed::fetch

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

Fetch the relation

Parameters

ORM\Relation\Morphed::fetch

↑ top

ORM\Relation\Morphed::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\Morphed::fetchAll

↑ top

ORM\Relation\Morphed::fromAssoc

public static function fromAssoc(mixed $parent, array $relDef): mixed

{@inheritDoc}

Parameters

ORM\Relation\Morphed::fromAssoc

↑ top

ORM\Relation\Morphed::fromShort

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

{@inheritDoc}

Parameters

ORM\Relation\Morphed::fromShort

↑ top

ORM\Relation\Morphed::getReference

public function getReference(): mixed

ORM\Relation\Morphed::getReference

↑ top

ORM\Relation\Morphed::setRelated

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

Set the relation to $entity

Parameters

ORM\Relation\Morphed::setRelated

↑ top