Documentation

Decimal extends DataType
in package
implements Primitive

An implementation of Decimal

Table of Contents

Interfaces

Primitive
A ValueObject that has a primitive Value like int or string and is thus returned from a DomainObject as value and not as ValueObject Instance

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 Float value
ifExists()  : callable
in()  : mixed
Stores the $value as int casting it
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 Float value

public equals(mixed $compare) : mixed
Parameters
$compare : 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()

Stores the $value as int casting it

public in(mixed $value) : mixed
Parameters
$value : mixed

length()

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
callable

notNull()

NotNull

public static notNull() : callable
Return values
callable

oneOf()

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
todo

Filters are yet to be implemented!

Return values
string

required()

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

        
On this page

Search results