FIX for #4417: Ensuring ->removeValidation() is defined on instances of Validator. Setup new API for enabling/disabling validation. Documentation and better type handling.

This commit is contained in:
Patrick Nelson 2015-08-25 14:32:11 -04:00 committed by Daniel Hensby
parent e741af9127
commit 5fa3c85280
No known key found for this signature in database
GPG Key ID: B00D1E9767F0B06E
4 changed files with 118 additions and 1 deletions

View File

@ -48,6 +48,7 @@ class RequiredFields extends Validator
*/
public function removeValidation()
{
parent::removeValidation();
$this->required = array();
return $this;

View File

@ -29,6 +29,11 @@ abstract class Validator extends Object
*/
protected $result;
/**
* @var bool
*/
private $enabled = true;
/**
* @param Form $form
* @return $this
@ -47,7 +52,9 @@ abstract class Validator extends Object
public function validate()
{
$this->resetResult();
$this->php($this->form->getData());
if ($this->getEnabled()) {
$this->php($this->form->getData());
}
return $this->result;
}
@ -129,6 +136,34 @@ abstract class Validator extends Object
*/
abstract public function php($data);
/**
* @param bool $enabled
* @return $this
*/
public function setEnabled($enabled)
{
$this->enabled = (bool)$enabled;
return $this;
}
/**
* @return bool
*/
public function getEnabled()
{
return $this->enabled;
}
/**
* @return $this
*/
public function removeValidation()
{
$this->setEnabled(false);
$this->resetResult();
return $this;
}
/**
* Clear current result
*

View File

@ -0,0 +1,58 @@
<?php
namespace SilverStripe\Forms\Tests;
use SilverStripe\Control\Controller;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\Tests\ValidatorTest\TestValidator;
use SilverStripe\Forms\TextField;
/**
* @package framework
* @subpackage tests
*/
class ValidatorTest extends SapphireTest
{
/**
* Common method for setting up form, since that will always be a dependency for the validator.
*
* @param array $fieldNames
* @return Form
*/
protected function getForm(array $fieldNames = array())
{
// Setup field list now. We're only worried about names right now.
$fieldList = new FieldList();
foreach ($fieldNames as $name) {
$fieldList->add(new TextField($name));
}
return new Form(new Controller(), "testForm", $fieldList, new FieldList([/* no actions */]));
}
public function testRemoveValidation()
{
$validator = new TestValidator();
// Setup a form with the fields/data we're testing (a form is a dependency for validation right now).
$data = array("foobar" => "");
$form = $this->getForm(array_keys($data)); // We only care right now about the fields we've got setup in this array.
$form->disableSecurityToken();
$form->setValidator($validator); // Setup validator now that we've got our form.
$form->loadDataFrom($data); // Put data into the form so the validator can pull it back out again.
$result = $form->validationResult();
$this->assertFalse($result->isValid());
$this->assertCount(1, $result->getMessages());
// Make sure it doesn't fail after removing validation AND has no errors (since calling validate should reset errors).
$validator->removeValidation();
$result = $form->validationResult();
$this->assertTrue($result->isValid());
$this->assertEmpty($result->getMessages());
}
}

View File

@ -0,0 +1,23 @@
<?php
namespace SilverStripe\Forms\Tests\ValidatorTest;
use SilverStripe\Dev\TestOnly;
use SilverStripe\Forms\Validator;
class TestValidator extends Validator implements TestOnly
{
/**
* Requires a specific field for test purposes.
*
* @param array $data
* @return null
*/
public function php($data)
{
foreach ($data as $field => $data) {
$this->validationError($field, 'error');
}
}
}