UserDo 

namespace	bhenk\msdata\user
predicates	Cloneable \| Instantiable
implements	Stringable \| EntityInterface
extends	Entity
hierarchy	UserDo -> Entity
known subclasses	PersonDo

A simple user

This line has Entity, OutOfBoundsException, Entity 3 links.

A box of roses: with content

Constructor 

UserDo::__construct 

predicates

public | constructor

public function __construct(
      Parameter #0 [ <optional> ?int $ID = NULL ]
      Parameter #1 [ <optional> ?string $first_name = NULL ]
      Parameter #2 [ <optional> ?string $prefixes = NULL ]
      Parameter #3 [ <optional> ?string $last_name = NULL ]
      Parameter #4 [ <optional> ?string $email = NULL ]
 )

param ?int $ID
param ?string $first_name
param ?string $prefixes
param ?string $last_name
param ?string $email

Methods 

UserDo::getFirstName 

predicates

public

public function getFirstName(): ?string

return ?string

UserDo::setFirstName 

predicates

public

public function setFirstName(
      Parameter #0 [ <required> ?string $first_name ]
 ): void

param ?string $first_name

return void

UserDo::getPrefixes 

predicates

public

public function getPrefixes(): ?string

return ?string

UserDo::setPrefixes 

predicates

public

public function setPrefixes(
      Parameter #0 [ <required> ?string $prefixes ]
 ): void

param ?string $prefixes

return void

UserDo::getLastName 

predicates

public

public function getLastName(): ?string

return ?string

UserDo::setLastName 

predicates

public

public function setLastName(
      Parameter #0 [ <required> ?string $last_name ]
 ): void

param ?string $last_name

return void

UserDo::getEmail 

predicates

public

public function getEmail(): ?string

return ?string

UserDo::setEmail 

predicates

public

public function setEmail(
      Parameter #0 [ <required> ?string $email ]
 ): void

param ?string $email

return void

UserDo::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

UserDo::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

UserDo::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

UserDo::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

UserDo::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

UserDo::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

UserDo::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

UserDo::__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