trehinos/thor-safe-types

Some safe types for PHP 8.4 and above.

dev-master 2025-02-01 08:24 UTC

Requires

• php: ^8.4

Requires (Dev)

• phpunit/phpunit: ^11

MIT

• Sébastien GELDREICH

• option
• validate
• maybe
• result
• either
• unwrap
• safe types

README

Provides some safe types.

Interfaces

• Unwrap &Matchable, extended by :
  • Option
  • Either
  • Validate

Types hierarchy

• Validator : a derivable Closure class which encapsulate a fn(mixed): bool.
• Unwrap :
  • final Result (with enum ResultType),
  • with Matchable :
    • Option (with enum Maybe) :
      • abstract SomeOrNone :
        • final Some
        • final None,
    • Either (with enum EitherCase) :
      • final Neither
      • final Both,
      • abstract LeftOrRight :
        • final Left
        • final Right,
    • Validate :
      • final Validated

Types details

Unwrap

An interface defining utility methods for extracting contained values from a structure.

• unwrapOrElse(callable $ifNot): mixed : returns the contained value if it is safe to return or else calls the function $ifNot and returns its returned value.
• unwrapOr(mixed $default): mixed : returns the contained value if it is safe to return or else returns $default.
• unwrapOrThrow(Throwable): mixed : returns the contained value if it is safe to return or else throws the specified Throwable.
• unwrap(): mixed : returns the contained value if it is safe to return or else throws a predefined Throwable.

• Extended by the interfaces Option, Either and Validate.
• Implemented partially by the trait UnwrapOrThrow :
  • needs unwrapOrElse().
• Implemented by the final class Result.

Matchable

• match(callable $ifA, callable $ifB) : Call the function $ifA if some conditions are met or else $ifB. It returns the value returned by the called function.

• Extended by the interfaces Option, Either and Validate.

Option

Extends Unwrap and Matchable.

The Maybe enumeration has the cases SOME and NONE.

• is(): Maybe : returns the nature of the Option Maybe::SOME or Maybe::NONE.
• isNone(): bool : this function return true if the Option contains no value.
• isSome(): bool : this function return false if the Option contains a value.
• isA(Maybe $maybe): bool : returns true if the Option corresponds the nature described by the specified Maybe.
• map(callable(mixed): mixed $f): $this : returns a Some($value) if this Option::isSome() else returns a None.
• from(mixed $data): static : creates an Option according to the specified value.

• Partially implemented by the abstract class SomeOrNone :
  • needs match() and is(),
• Implemented by the final types Some and None.

Either

Extends Unwrap and Matchable.

The EitherCase enumeration has the cases LEFT and RIGHT.

• isA(EitherCAse): bool
• isLeft(): bool
• toLeft(): Left
• left(): Option
• leftOr(mixed): mixed
• isRight(): bool
• toRight(): Right
• right(): Option
• rightOr(mixed): mixed

• Partially implemented by the abstract class LeftOrRight :
  • needs is(),
  • implemented by the final types Left and Right,
• Implemented by the final types Both and Neither.

Validate

Extends Unwrap and Matchable.

• toOption(): Option
• isValid(): bool
• isInvalid(): bool

Implemented by Validated.

License

Copyright 2025 Sébastien GELDREICH

License MIT