Elgg\Validation\ValidationResults Class Reference

Represents a set of validated parameters. More...

Public Member Functions
	pass ($name, $value, $message='')
	Add parameter and set it as valid. More...
	fail ($name, $value, $error='')
	Add parameter and set it as invalid. More...
	all ()
	Get all results in this bag. More...
	getFailures ()
	Check if the bag has parameters that failed validation. More...

Protected Attributes
	$results = []

Detailed Description

Represents a set of validated parameters.

Definition at line 8 of file ValidationResults.php.

Member Function Documentation

all()

Elgg\Validation\ValidationResults::all

(

)

Get all results in this bag.

Returns

ValidationResult[]

Definition at line 55 of file ValidationResults.php.

fail()

Elgg\Validation\ValidationResults::fail	(		$name,
			$value,
			$error = ''
	)

Add parameter and set it as invalid.

Parameters

string	$name	Parameter name
mixed	$value	Parameter value
string	$error	Error message

Returns

static

Definition at line 42 of file ValidationResults.php.

getFailures()

Elgg\Validation\ValidationResults::getFailures

(

)

Check if the bag has parameters that failed validation.

Returns

ValidationResult[]|false

Definition at line 63 of file ValidationResults.php.

pass()

Elgg\Validation\ValidationResults::pass	(		$name,
			$value,
			$message = ''
	)

Add parameter and set it as valid.

Parameters

string	$name	Parameter name
mixed	$value	Parameter value
string	$message	Success message

Returns

static

Definition at line 24 of file ValidationResults.php.

Member Data Documentation

$results

Elgg\Validation\ValidationResults::$results = []

protected

Definition at line 13 of file ValidationResults.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Validation/ValidationResults.php