tflori/orm

» API Reference » ORM\Entity\Relations

ORM\Entity\Relations

Table of Contents

• Abstract
• Methods
  • $relations->addRelated - Add relations for $relation to $entities
  • $relations->deleteRelated - Delete relations for $relation to $entities
  • $relations->fetch - Fetches related objects
  • $relations->getRelated - Get related objects
  • Relations::getRelation - Get the definition for $relation
  • $relations->hasLoaded - Check if $relation got loaded already
  • $relations->load - Load the related objects of $relation
  • $relations->resetRelated - Resets all loaded relations or $relation
  • $relations->setRelated - Set $relation to $entity

Abstract

Methods

ORM\Entity\Relations::addRelated

public function addRelated(string $relation, \ORM\Entity[] $entities): mixed

Add relations for $relation to $entities

This method is only for many-to-many relations.

This method does not take care about already existing relations and will fail hard.

Parameters

ORM\Entity\Relations::addRelated

↑ top

ORM\Entity\Relations::deleteRelated

public function deleteRelated(string $relation, \ORM\Entity[] $entities): mixed

Delete relations for $relation to $entities

This method is only for many-to-many relations.

Parameters

ORM\Entity\Relations::deleteRelated

↑ top

ORM\Entity\Relations::fetch

public function fetch(
    string $relation, 
    bool $getAll = false, 
): \ORM\Entity|\ORM\Entity[]|\ORM\EntityFetcher

Fetches related objects

For relations with cardinality many it returns an EntityFetcher. Otherwise it returns the entity.

It will throw an error for non owner when the key is incomplete.

Parameters

ORM\Entity\Relations::fetch

↑ top

ORM\Entity\Relations::getRelated

public function getRelated(string $relation, bool $refresh = false): mixed

Get related objects

The difference between getRelated and fetch is that getRelated stores the fetched entities. To refresh set $refresh to true.

Parameters

ORM\Entity\Relations::getRelated

↑ top

ORM\Entity\Relations::getRelation

public static function getRelation(string $name): \ORM\Relation

Get the definition for $relation

It normalize the short definition form and create a Relation object from it.

Parameters

ORM\Entity\Relations::getRelation

↑ top

ORM\Entity\Relations::hasLoaded

public function hasLoaded(string $relation): bool

Check if $relation got loaded already

Parameters

ORM\Entity\Relations::hasLoaded

↑ top

ORM\Entity\Relations::load

public function load(string $relation): $this

Load the related objects of $relation

Nested relations can be loaded by separating them by “.” for example load all articles with comments from a user ($this): $user->load('articles.comments').

Parameters

ORM\Entity\Relations::load

↑ top

ORM\Entity\Relations::resetRelated

public function resetRelated(null $relation = null): mixed

Resets all loaded relations or $relation

Helpful to reduce the size of serializations of the object (for caching, or toArray method etc.)

Parameters

ORM\Entity\Relations::resetRelated

↑ top

ORM\Entity\Relations::setRelated

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

Set $relation to $entity

This method is only for the owner of a relation.

Parameters

ORM\Entity\Relations::setRelated

↑ top