ZSR
extends DataType
in package
implements
Complex
An implementation of a ZSR Number
Allowed Format /^[A-Z][0-9]{6}$/
Table of Contents
Interfaces
- Complex
- A ValueObject that has a complex Value such as Date or Money which cannot be represented directly as a string and is thus returned from a DomainObject as is
Properties
- $value : mixed
Methods
- __construct() : mixed
- The constructor is normally called from the DomainObject when instatiated.
- __toString() : string
- Make sure to overwrite this method in the implementations
- defaultValidators() : array<string|int, mixed>
- Overwrite this message if a DataType needs validation methods that are always applied
- equals() : mixed
- Compares the internal value with the $compare argument
- ifExists() : callable
- in() : mixed
- Converts the $value stripping of all dots
- isComplex() : bool
- length() : callable
- maxLength() : callable
- minLength() : callable
- notBlank() : callable
- NotBlank
- notNull() : callable
- NotNull
- oneOf() : callable
- out() : string
- Returns the $value applying the output filters
- required() : callable
- unique() : callable
- not implemented - remove?
- value() : mixed
- Returns the internal value
Properties
$value
protected
mixed
$value
The internal value of the DataType
Methods
__construct()
The constructor is normally called from the DomainObject when instatiated.
public
__construct([mixde $value = null ]) : mixed
Parameters
- $value : mixde = null
__toString()
Make sure to overwrite this method in the implementations
public
__toString() : string
Return values
string —The string representation of the DataType
defaultValidators()
Overwrite this message if a DataType needs validation methods that are always applied
public
static defaultValidators() : array<string|int, mixed>
Return values
array<string|int, mixed>equals()
Compares the internal value with the $compare argument
public
equals(DataType|mixed $compare) : mixed
Remember that you get a DomainObject when using the DomainObjects values, thus comparison can have
undesired results, use the equals method to compare ValueObjects
This has to be overwritten in the descendants to get the desired comparison behaviour
Parameters
- $compare : DataType|mixed
-
The value to be compared
ifExists()
public
static ifExists(callable $test) : callable
Parameters
- $test : callable
Return values
callable —Returns a predicate that tests a value using $test if it exists.
in()
Converts the $value stripping of all dots
public
in(mixed $value) : mixed
Parameters
- $value : mixed
isComplex()
public
isComplex() : bool
Return values
boollength()
public
static length(int $n) : callable
Parameters
- $n : int
Return values
callable —Returns a predicate that tests if its argument is of length $n.
maxLength()
public
static maxLength(int $n) : callable
Parameters
- $n : int
Return values
callable —Returns a predicate that tests if its argument is of length $n or less.
minLength()
public
static minLength(int $n) : callable
Parameters
- $n : int
Return values
callable —Returns a predicate that tests if its argument is of length $n or greater.
notBlank()
NotBlank
public
static notBlank() : callable
Return values
callablenotNull()
NotNull
public
static notNull() : callable
Return values
callableoneOf()
public
static oneOf(mixed $lst) : callable
Parameters
- $lst : mixed
Return values
callable —Returns a predicate that test if it's argument is one of several elements.
out()
Returns the $value applying the output filters
public
out() : string
This method should be overwritten in the concrete implementation
Tags
Return values
stringrequired()
public
static required() : callable
Return values
callable —Returns a predicate that tests for the existence of it's argument.
unique()
not implemented - remove?
public
static unique() : callable
Return values
callable —Returns a predicate that tests if it's argument is unique in it's environment.
value()
Returns the internal value
public
value() : mixed