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

NEW Allow skipping validation on write (#11202)

Browse Source
This commit is contained in:
Guy Sartorelli 2024-04-19 10:35:36 +12:00 committed by GitHub
parent 4be3dd5cd1
commit dcc6863401
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/ORM/DataObject.php
View File

@ -1345,7 +1345,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* *
* @return ValidationException Exception generated by this write, or null if valid * @return ValidationException Exception generated by this write, or null if valid
*/ */
protected function validateWrite() protected function validateWrite(bool $skipValidation = false)
{ {
if ($this->ObsoleteClassName) { if ($this->ObsoleteClassName) {
return new ValidationException( return new ValidationException(
@ -1354,6 +1354,10 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
); );
} }
if ($skipValidation) {
return null;
}
// Note: Validation can only be disabled at the global level, not per-model // Note: Validation can only be disabled at the global level, not per-model
if (DataObject::config()->uninherited('validation_enabled')) { if (DataObject::config()->uninherited('validation_enabled')) {
$result = $this->validate(); $result = $this->validate();
@ -1369,10 +1373,10 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* *
* @throws ValidationException * @throws ValidationException
*/ */
protected function preWrite() protected function preWrite(bool $skipValidation = false)
{ {
// Validate this object // Validate this object
if ($writeException = $this->validateWrite()) { if ($writeException = $this->validateWrite($skipValidation)) {
// Used by DODs to clean up after themselves, eg, Versioned // Used by DODs to clean up after themselves, eg, Versioned
$this->invokeWithExtensions('onAfterSkippedWrite'); $this->invokeWithExtensions('onAfterSkippedWrite');
throw $writeException; throw $writeException;
@ -1560,15 +1564,16 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* {@link getManyManyComponents()}. Default to `false`. The parameter can also be provided in * {@link getManyManyComponents()}. Default to `false`. The parameter can also be provided in
* the form of an array: `['recursive' => true, skip => ['Page'=>[1,2,3]]`. This avoid infinite * the form of an array: `['recursive' => true, skip => ['Page'=>[1,2,3]]`. This avoid infinite
* loops when one DataObject are components of each other. * loops when one DataObject are components of each other.
* @param boolean $skipValidation Skip validation of data
* @return int The ID of the record * @return int The ID of the record
* @throws ValidationException Exception that can be caught and handled by the calling function * @throws ValidationException Exception that can be caught and handled by the calling function
*/ */
public function write($showDebug = false, $forceInsert = false, $forceWrite = false, $writeComponents = false) public function write($showDebug = false, $forceInsert = false, $forceWrite = false, $writeComponents = false, bool $skipValidation = false)
{ {
$now = DBDatetime::now()->Rfc2822(); $now = DBDatetime::now()->Rfc2822();
// Execute pre-write tasks // Execute pre-write tasks
$this->preWrite(); $this->preWrite($skipValidation);
// Check if we are doing an update or an insert // Check if we are doing an update or an insert
$isNewRecord = !$this->isInDB() || $forceInsert; $isNewRecord = !$this->isInDB() || $forceInsert;

7
tests/php/ORM/DataObjectTest.php
View File

@ -1519,6 +1519,13 @@ class DataObjectTest extends SapphireTest
$this->assertTrue($validatedObject->isInDB(), "Validated object was not saved to database"); $this->assertTrue($validatedObject->isInDB(), "Validated object was not saved to database");
} }
public function testWriteSkipValidation(): void
{
$validatedObject = new DataObjectTest\ValidatedObject();
$validatedObject->write(skipValidation: true);
$this->assertTrue($validatedObject->isInDB(), "Validated object was not saved to database");
}
public function testSubclassCreation() public function testSubclassCreation()
{ {
/* Creating a new object of a subclass should set the ClassName field correctly */ /* Creating a new object of a subclass should set the ClassName field correctly */

4
tests/php/ORM/DataObjectTest/TreeNode.php
View File

@ -33,7 +33,7 @@ class TreeNode extends DataObject implements TestOnly
'Children' => self::class, 'Children' => self::class,
]; ];
public function write($showDebug = false, $forceInsert = false, $forceWrite = false, $writeComponents = false) public function write($showDebug = false, $forceInsert = false, $forceWrite = false, $writeComponents = false, bool $skipValidation = false)
{ {
// Force the component to fetch its Parent and Cycle relation so we have components to recursively write // Force the component to fetch its Parent and Cycle relation so we have components to recursively write
$this->Parent; $this->Parent;
@ -42,7 +42,7 @@ class TreeNode extends DataObject implements TestOnly
// Count a write attempts // Count a write attempts
$this->WriteCount++; $this->WriteCount++;
return parent::write($showDebug, $forceInsert, $forceWrite, $writeComponents); return parent::write($showDebug, $forceInsert, $forceWrite, $writeComponents, $skipValidation);
} }
/** /**