tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

DOCS Docblock fixes for ValidationResult

Browse Source
This commit is contained in:
Daniel Hensby 2016-10-31 13:33:59 +00:00
parent 2a3768266e
commit 0b850e0819
No known key found for this signature in database
GPG Key ID: B00D1E9767F0B06E
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
model/ValidationResult.php
View File

@ -8,19 +8,21 @@
*/ */
class ValidationResult extends Object { class ValidationResult extends Object {
/** /**
* Boolean - is the result valid or not * @var bool - is the result valid or not
*/ */
protected $isValid; protected $isValid;
/** /**
* Array of errors * @var array of errors
*/ */
protected $errorList = array(); protected $errorList = array();
/** /**
* Create a new ValidationResult. * Create a new ValidationResult.
* By default, it is a successful result. Call $this->error() to record errors. * By default, it is a successful result. Call $this->error() to record errors.
* @param bool $valid
* @param string|null $message
*/ */
public function __construct($valid = true, $message = null) { public function __construct($valid = true, $message = null) {
$this->isValid = $valid; $this->isValid = $valid;
@ -30,8 +32,8 @@ class ValidationResult extends Object {
/** /**
* Record an error against this validation result, * Record an error against this validation result,
* @param $message The validation error message * @param string $message The validation error message
* @param $code An optional error code string, that can be accessed with {@link $this->codeList()}. * @param string $code An optional error code string, that can be accessed with {@link $this->codeList()}.
* @return ValidationResult this * @return ValidationResult this
*/ */
public function error($message, $code = null) { public function error($message, $code = null) {
@ -99,7 +101,7 @@ class ValidationResult extends Object {
* It will be valid if both this and the other result are valid. * It will be valid if both this and the other result are valid.
* This object will be modified to contain the new validation information. * This object will be modified to contain the new validation information.
* *
* @param ValidationResult the validation result object to combine * @param ValidationResult $other the validation result object to combine
* @return ValidationResult this * @return ValidationResult this
*/ */
public function combineAnd(ValidationResult $other) { public function combineAnd(ValidationResult $other) {