API リファレンス

PHP Value Object ライブラリの全クラスの API リファレンスです。

概要

すべての値オブジェクトは以下の共通インターフェースを実装しています。

IValueObject

interface IValueObject extends JsonSerializable
{
    public function equals(IValueObject $other): bool;
}

Boolean

クラス	説明
BooleanValue	真偽値を扱う値オブジェクト

String

クラス	説明
StringValue	汎用文字列値オブジェクト
EmailAddress	メールアドレス値オブジェクト
Ulid	ULID 値オブジェクト

Number

整数

クラス	説明
IntegerValue	任意の整数値
PositiveIntegerValue	正の整数値
NegativeIntegerValue	負の整数値

小数

クラス	説明
DecimalValue	任意の小数値
PositiveDecimalValue	正の小数値
NegativeDecimalValue	負の小数値

DateTime

クラス	説明
LocalDate	日付
LocalTime	時刻
LocalDateTime	日時
LocalDateRange	日付範囲

Collection

クラス	説明
ArrayList	順序付きリスト
Map	キーと値のマップ
Pair	キーと値のペア
ValueObjectList	値オブジェクトのリスト

Enum

クラス	説明
EnumValue	Enum を値オブジェクトとして扱う

共通のファクトリメソッド

ほとんどの値オブジェクトは以下のファクトリメソッドを持ちます。

メソッド	戻り値	説明
from($value)	static	値からインスタンスを作成
tryFrom($value)	Result<static, ValueObjectError>	検証付きで作成
fromNullable($value)	Option<static>	null 許容で作成
tryFromNullable($value)	Result<Option<static>, ValueObjectError>	検証 + null 許容

エラー型

値オブジェクトのバリデーションエラーは ValueObjectError クラスで表現されます。

interface IErrorValue
{
    public function getCode(): string;
    public function getMessage(): string;
    public function getDetails(): array;
}