Join

namespace	bhenk\msdata\abc
predicates	Cloneable | Instantiable
implements	Stringable | EntityInterface
extends	Entity
hierarchy	Join -> Entity

A basic Entity for a join function

Join can be used when expressing a many-to-many relation

---

Constructor

Join::__construct

predicates

public | constructor

Constructs a new Join

public function __construct(
      Parameter #0 [ <optional> ?int $ID = NULL ]
      Parameter #1 [ <optional> ?int $FK_LEFT = NULL ]
      Parameter #2 [ <optional> ?int $FK_RIGHT = NULL ]
      Parameter #3 [ <optional> bool $deleted = false ]
 )

param ?int $ID - ID of this Join

param ?int $FK_LEFT - the left hand foreign key

param ?int $FK_RIGHT - the right hand foreign key

param bool $deleted - false on this location

---

Methods

Join::getFkLeft

predicates

public

Get the left hand foreign key

public function getFkLeft(): ?int

return ?int

---

Join::setFkLeft

predicates

public

Set the left hand foreign key

public function setFkLeft(
      Parameter #0 [ <required> ?int $FK_LEFT ]
 ): void

param ?int $FK_LEFT

return void

---

Join::getFkRight

predicates

public

Get the right hand foreign key

public function getFkRight(): ?int

return ?int

---

Join::setFkRight

predicates

public

Set the right hand foreign key

public function setFkRight(
      Parameter #0 [ <required> ?int $FK_RIGHT ]
 ): void

param ?int $FK_RIGHT

return void

---

Join::isDeleted

predicates

public

Get whether this join-relation is deleted

public function isDeleted(): bool

return bool

---

Join::setDeleted

predicates

public

Sets whether this join-relation is deleted

public function setDeleted(
      Parameter #0 [ <required> bool $deleted ]
 ): void

param bool $deleted

return void

---

Join::clone

predicates	public
implements	EntityInterface::clone
inherited from	Entity::clone

@inheritdoc

Create an Entity that equals this Entity

The newly created Entity gets the given ID or no ID if param $ID is null.

param int | null $ID

return Entity

@inheritdoc from method EntityInterface::clone

public function clone(
      Parameter #0 [ <optional> ?int $ID = NULL ]
 ): Entity

param ?int $ID

return Entity - Entity, similar to this one, with the given ID

throws ReflectionException

---

Join::toArray

predicates	public
implements	EntityInterface::toArray
inherited from	Entity::toArray

@inheritdoc

Express the properties of this Entity in an array

The returned array should be in such order that it can be fet to the static method EntityInterface::fromArray.

return array - array with properties of this Entity

@inheritdoc from method EntityInterface::toArray

see also

Entity::fromArray

public function toArray(): array

return array - array with properties

---

Join::getParents

predicates	public
inherited from	Entity::getParents

Get the (Reflection) parents of this Entity in reverse order

class A extends Entity

class B extends A

returned array = [Entity-Reflection, A-Reflection, B-Reflection]

public function getParents(): array

return array - array with ReflectionClass parents and this Entity

---

Join::fromArray

predicates	public | static
implements	EntityInterface::fromArray
inherited from	Entity::fromArray

Create a new Entity

The order of the given array should be parent-first, i.e.:

class A extends Entity

class B extends A

In __construct(), toArray() and fromArray() functions, properties/parameters have the order:

ID, {props of A}, {props of B}

@inheritdoc

Create a new Entity from an array of properties

The given array should have the same order as the one gotten from EntityInterface::toArray.

param array $arr - property array

return Entity - newly created Entity with the given properties

@inheritdoc from method EntityInterface::fromArray

public static function fromArray(
      Parameter #0 [ <required> array $arr ]
 ): static

param array $arr - array with properties

return static - Entity object

throws ReflectionException

---

Join::isSame

predicates	public
implements	EntityInterface::isSame
inherited from	Entity::isSame

@inheritdoc

Test is same function

The given Entity is similar to this Entity if all properties, including ID, are equal.

param Entity $other - Entity to test

return bool - true if all properties, including ID, are equal, false otherwise

@inheritdoc from method EntityInterface::isSame

public function isSame(
      Parameter #0 [ <required> bhenk\msdata\abc\Entity $other ]
 ): bool

param Entity $other

return bool

---

Join::equals

predicates	public
implements	EntityInterface::equals
inherited from	Entity::equals

@inheritdoc

Test equals function

The given Entity equals this Entity if all properties, except ID, are equal.

param Entity $other - Entity to test

return bool - true if all properties are equal, false otherwise

@inheritdoc from method EntityInterface::equals

public function equals(
      Parameter #0 [ <required> bhenk\msdata\abc\Entity $other ]
 ): bool

param Entity $other

return bool

---

Join::getID

predicates	public
implements	EntityInterface::getID
inherited from	Entity::getID

@inheritdoc

Get the ID of this Entity or null if it has no ID

return int | null - ID of this Entity or null

@inheritdoc from method EntityInterface::getID

public function getID(): ?int

return ?int

---

Join::__toString

predicates	public
implements	Stringable::__toString
inherited from	Entity::__toString

String representation of this Entity

public function __toString(): string

return string - representing this Entity

---

Sat, 01 Jul 2023 13:02:23 +0000