Result

Result object for operations dealing with objects, such as the Property Mapper or the Validators.

Table of Contents

Properties

$errors  : array<string|int, Error>

$errorsExist  : bool

Caches the existence of errors

$notices  : array<string|int, Notice>

$noticesExist  : bool

Caches the existence of notices

$parent  : Result

$propertyResults  : array<string|int, Result>

The result objects for the sub properties

$warnings  : array<string|int, Warning>

$warningsExist  : bool

Caches the existence of warning

Methods

addError()  : void

Add an error to the current Result object

addNotice()  : void

Add a notice to the current Result object

addWarning()  : void

Add a warning to the current Result object

clear()  : void

Clears the result

forProperty()  : Result

Return a Result object for the given property path. This is a fluent interface, so you will probably use it like: $result->forProperty('foo.bar')->getErrors() -- to get all errors for property "foo.bar"

getErrors()  : array<string|int, Error>

Get all errors in the current Result object (non-recursive)

getFirstError()  : bool|Error

Get the first error object of the current Result object (non-recursive)

getFirstNotice()  : bool|Notice

Get the first notice object of the current Result object (non-recursive)

getFirstWarning()  : bool|Warning

Get the first warning object of the current Result object (non-recursive)

getFlattenedErrors()  : array<string, array<string|int, Error>>

Get a list of all Error objects recursively. The result is an array, where the key is the property path where the error occurred, and the value is a list of all errors (stored as array)

getFlattenedNotices()  : array<string, array<string|int, Notice>>

Get a list of all Notice objects recursively. The result is an array, where the key is the property path where the notice occurred, and the value is a list of all notices (stored as array)

getFlattenedWarnings()  : array<string, array<string|int, Warning>>

Get a list of all Warning objects recursively. The result is an array, where the key is the property path where the warning occurred, and the value is a list of all warnings (stored as array)

getNotices()  : array<string|int, Notice>

Get all notices in the current Result object (non-recursive)

getSubResults()  : array<string|int, Result>

Get a list of all sub Result objects available.

getWarnings()  : array<string|int, Warning>

Get all warnings in the current Result object (non-recursive)

hasErrors()  : bool

Does the current Result object have Errors? (Recursively)

hasMessages()  : bool

Does the current Result object have Notices, Errors or Warnings? (Recursively)

hasNotices()  : bool

Does the current Result object have Notices? (Recursively)

hasWarnings()  : bool

Does the current Result object have Warnings? (Recursively)

merge()  : void

Merge the given Result object into this one.

recurseThroughResult()  : Result

setParent()  : void

Injects the parent result and propagates the cached error states upwards

flattenErrorTree()  : void

flattenNoticesTree()  : void

flattenWarningsTree()  : void

mergeProperty()  : void

Merge a single property from the other result object.

setErrorsExist()  : void

Sets the error cache to TRUE and propagates the information upwards the Result-Object Tree

setNoticesExist()  : void

Sets the notices cache to TRUE and propagates the information upwards the Result-Object Tree

setWarningsExist()  : void

Sets the warning cache to TRUE and propagates the information upwards the Result-Object Tree