Entity 

namespace	bhenk\msdata\abc
predicates	Cloneable \| Instantiable
implements	EntityInterface \| Stringable
known subclasses	Join \| NodeDo \| UserDo

Basic implementation of a data object

Constructor 

Entity::__construct 

predicates

public | constructor

Construct a new Entity

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

param ?int $ID - the ID of the newly created Entity or null if it has no ID

Methods 

Entity::clone 

predicates	public
implements	EntityInterface::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

Entity::toArray 

predicates	public
implements	EntityInterface::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

Entity::getParents 

predicates

public

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

Entity::fromArray 

predicates	public \| static
implements	EntityInterface::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

Entity::isSame 

predicates	public
implements	EntityInterface::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

Entity::equals 

predicates	public
implements	EntityInterface::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

Entity::getID 

predicates	public
implements	EntityInterface::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

Entity::__toString 

predicates	public
implements	Stringable::__toString

String representation of this Entity

public function __toString(): string

return string - representing this Entity

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