Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Ensure Table::save() always returns documented type. #13816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2019
Merged

Ensure Table::save() always returns documented type. #13816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22d0c75
Ensure Table::save() always returns documented type.
ADmad Oct 29, 2019
ed797c2
Update exception message
ADmad Oct 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/ORM/Table.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1832,7 +1832,19 @@ protected function _processSave(EntityInterface $entity, ArrayObject $options)
$event = $this->dispatchEvent('Model.beforeSave', compact('entity', 'options'));

if ($event->isStopped()) {
return $event->getResult();
$result = $event->getResult();
if ($result === null) {
return false;
}

if ($result !== false && !($result instanceof EntityInterface)) {
throw new RuntimeException(sprintf(
'The beforeSave callback must return `false` or `EntityInterface` instance. Got `%s` instead.',
getTypeName($result)
));
}

return $result;
}

$saved = $this->_associations->saveParents(
Expand Down
47 changes: 47 additions & 0 deletions tests/TestCase/ORM/TableTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
use Cake\Utility\Hash;
use Cake\Validation\Validator;
use InvalidArgumentException;
use RuntimeException;
use TestApp\Model\Entity\ProtectedEntity;
use TestApp\Model\Entity\VirtualUser;
use TestApp\Model\Table\UsersTable;
Expand Down Expand Up @@ -2052,6 +2053,52 @@ public function testBeforeSaveStopEvent()
$this->assertNull($row);
}

/**
* Tests that if beforeSave event is stopped and callback doesn't return any
* value then save() returns false.
*
* @group save
* @return void
*/
public function testBeforeSaveStopEventWithNoResult()
{
$table = $this->getTableLocator()->get('users');
$data = new Entity([
'username' => 'superuser',
'created' => new Time('2013-10-10 00:00'),
'updated' => new Time('2013-10-10 00:00'),
]);
$listener = function (EventInterface $event, $entity) {
$event->stopPropagation();
};
$table->getEventManager()->on('Model.beforeSave', $listener);
$this->assertFalse($table->save($data));
}

/**
* @group save
* @return void
*/
public function testBeforeSaveException()
{
$this->expectException(RuntimeException::class);
$this->expectExceptionMessage('The beforeSave callback must return `false` or `EntityInterface` instance. Got `integer` instead.');

$table = $this->getTableLocator()->get('users');
$data = new Entity([
'username' => 'superuser',
'created' => new Time('2013-10-10 00:00'),
'updated' => new Time('2013-10-10 00:00'),
]);
$listener = function (EventInterface $event, $entity) {
$event->stopPropagation();

return 1;
};
$table->getEventManager()->on('Model.beforeSave', $listener);
$table->save($data);
}

/**
* Asserts that afterSave callback is called on successful save
*
Expand Down