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

API CHANGE Changing DataObject::$changed to private visiblity. Please use getChangedFields() and isChanged()

Browse Source 
ENHANCEMENT Added DataObject->isChanged() to detect if a field has been changed in this object instance
MINOR Changing call to CompositeDBField->compositeDatabaseFields() in DataObject->hasOwnDatabaseField()
BUGFIX Unsettig "Version" property in DataObject->getChangedField() to allow versioned to write a new version after a call to forceChange()
BUGFIX Introduced $markChanged in Money class
BUGFIX Casting Money->__toString() return value as string
MINOR Changing Member class to use new DataObject->isChanged() API
BUGFIX Using new $markChanged API for CompositeDBFields in DBField::create()

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@77893 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2009-05-27 00:09:23 +00:00
parent c7768d8820
commit dfa44c055c
7 changed files with 106 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
core/model/DataObject.php
View File

@ -105,9 +105,12 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
/** /**
* An array indexed by fieldname, true if the field has been changed. * An array indexed by fieldname, true if the field has been changed.
* Use {@link getChangedFields()} and {@link isChanged()} to inspect
* the changed state.
*
* @var array * @var array
*/ */
protected $changed; private $changed;
/** /**
* The database record (in the same format as $record), before * The database record (in the same format as $record), before
@ -660,6 +663,9 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
foreach($this->record as $fieldName => $fieldVal) { foreach($this->record as $fieldName => $fieldVal) {
if(!isset($this->changed[$fieldName])) $this->changed[$fieldName] = 1; if(!isset($this->changed[$fieldName])) $this->changed[$fieldName] = 1;
} }
// @todo Find better way to allow versioned to write a new version after forceChange
if($this->isChanged('Version')) unset($this->changed['Version']);
} }
/** /**
@ -848,7 +854,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
break; break;
} }
} }
if($hasChanges || $forceWrite || !$this->record['ID']) { if($hasChanges || $forceWrite || !$this->record['ID']) {
// New records have their insert into the base data table done first, so that they can pass the // New records have their insert into the base data table done first, so that they can pass the
@ -1806,7 +1812,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
// write value only if either the field value exists, // write value only if either the field value exists,
// or a valid record has been loaded from the database // or a valid record has been loaded from the database
$value = (isset($this->record[$field])) ? $this->record[$field] : null; $value = (isset($this->record[$field])) ? $this->record[$field] : null;
if($value || $this->exists()) $fieldObj->setValue($value, $this->record); if($value || $this->exists()) $fieldObj->setValue($value, $this->record, false);
$this->record[$field] = $fieldObj; $this->record[$field] = $fieldObj;
@ -1827,9 +1833,10 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
/** /**
* Return the fields that have changed. * Return the fields that have changed.
*
* The change level affects what the functions defines as "changed": * The change level affects what the functions defines as "changed":
* Level 1 will return strict changes, even !== ones. * - Level 1 will return strict changes, even !== ones.
* Level 2 is more lenient, it will onlr return real data changes, for example a change from 0 to null * - Level 2 is more lenient, it will only return real data changes, for example a change from 0 to null
* would not be included. * would not be included.
* *
* Example return: * Example return:
@ -1849,7 +1856,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
// Update the changed array with references to changed obj-fields // Update the changed array with references to changed obj-fields
foreach($this->record as $k => $v) { foreach($this->record as $k => $v) {
if(is_object($v) && method_exists($v, 'isChanged') && $v->isChanged()) { if(is_object($v) && method_exists($v, 'isChanged') && $v->isChanged()) {
$this->changed[$k] = true; $this->changed[$k] = 1;
} }
} }
@ -1862,7 +1869,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
// Filter the list to those of a certain change level // Filter the list to those of a certain change level
if($changeLevel > 1) { if($changeLevel > 1) {
foreach($fields as $name => $level) { if($fields) foreach($fields as $name => $level) {
if($level < $changeLevel) { if($level < $changeLevel) {
unset($fields[$name]); unset($fields[$name]);
} }
@ -1879,6 +1886,19 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
return $changedFields; return $changedFields;
} }
/**
* Uses {@link getChangedFields()} to determine if fields have been changed
* since loading them from the database.
*
* @param string $fieldName Name of the database field
* @param int $changeLevel See {@link getChangedFields()}
* @return boolean
*/
function isChanged($fieldName, $changeLevel = 1) {
$changed = $this->getChangedFields(false, $changeLevel);
return array_key_exists($fieldName, $changed);
}
/** /**
* Set the value of the field * Set the value of the field
@ -1998,7 +2018,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
$fieldMap = $this->uninherited('db', true); $fieldMap = $this->uninherited('db', true);
if($fieldMap) foreach($fieldMap as $fieldname => $fieldtype){ if($fieldMap) foreach($fieldMap as $fieldname => $fieldtype){
if(ClassInfo::classImplements($fieldtype, 'CompositeDBField')){ if(ClassInfo::classImplements($fieldtype, 'CompositeDBField')){
$combined_db = singleton($fieldtype)->composite_db(); $combined_db = singleton($fieldtype)->compositeDatabaseFields();
foreach($combined_db as $name => $type){ foreach($combined_db as $name => $type){
$fieldMap[$fieldname.$name] = $type; $fieldMap[$fieldname.$name] = $type;
} }
@ -2196,7 +2216,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
} else if($helperPair = $this->castingHelperPair($fieldName)) { } else if($helperPair = $this->castingHelperPair($fieldName)) {
$constructor = $helperPair['castingHelper']; $constructor = $helperPair['castingHelper'];
$obj = eval($constructor); $obj = eval($constructor);
$obj->setValue($this->$fieldName, $this->record); $obj->setValue($this->$fieldName, $this->record, false);
return $obj; return $obj;
// Special case for has_one relationships // Special case for has_one relationships

2
core/model/fieldtypes/DBField.php
View File

@ -47,7 +47,7 @@ abstract class DBField extends ViewableData {
*/ */
static function create($className, $value, $name = null, $object = null) { static function create($className, $value, $name = null, $object = null) {
$dbField = Object::create($className, $name, $object); $dbField = Object::create($className, $name, $object);
$dbField->setValue($value); $dbField->setValue($value, null, false);
return $dbField; return $dbField;
} }

37
core/model/fieldtypes/Money.php
View File

@ -68,14 +68,14 @@ class Money extends DBField implements CompositeDBField {
parent::__construct($name); parent::__construct($name);
} }
public function composite_db(){ function compositeDatabaseFields() {
return self::$composite_db; return self::$composite_db;
} }
function requireField() { function requireField() {
$composite_db = $this->composite_db(); $fields = $this->compositeDatabaseFields();
foreach($composite_db as $name => $type){ if($fields) foreach($fields as $name => $type){
DB::requireField($this->tableName, $this->name.$name, $type); DB::requireField($this->tableName, $this->name.$name, $type);
} }
} }
@ -100,31 +100,32 @@ class Money extends DBField implements CompositeDBField {
$query->select[] = sprintf('"%sCurrency"', $this->name); $query->select[] = sprintf('"%sCurrency"', $this->name);
} }
function setValue($value,$record=null) { function setValue($value, $record = null, $markChanged = true) {
// @todo Allow resetting value to NULL through Money $value field // @todo Allow resetting value to NULL through Money $value field
if ($value instanceof Money && $value->hasValue()) { if ($value instanceof Money && $value->hasValue()) {
$this->setCurrency($value->getCurrency()); $this->setCurrency($value->getCurrency(), $markChanged);
$this->setAmount($value->getAmount()); $this->setAmount($value->getAmount(), $markChanged);
if($markChanged) $this->isChanged = true;
} else if($record && isset($record[$this->name . 'Currency']) && isset($record[$this->name . 'Amount'])) { } else if($record && isset($record[$this->name . 'Currency']) && isset($record[$this->name . 'Amount'])) {
if($record[$this->name . 'Currency'] && $record[$this->name . 'Amount']) { if($record[$this->name . 'Currency'] && $record[$this->name . 'Amount']) {
$this->setCurrency($record[$this->name . 'Currency']); $this->setCurrency($record[$this->name . 'Currency'], $markChanged);
$this->setAmount($record[$this->name . 'Amount']); $this->setAmount($record[$this->name . 'Amount'], $markChanged);
} else { } else {
$this->value = $this->nullValue(); $this->value = $this->nullValue();
} }
if($markChanged) $this->isChanged = true;
} else if (is_array($value)) { } else if (is_array($value)) {
if (array_key_exists('Currency', $value)) { if (array_key_exists('Currency', $value)) {
$this->setCurrency($value['Currency']); $this->setCurrency($value['Currency'], $markChanged);
} }
if (array_key_exists('Amount', $value)) { if (array_key_exists('Amount', $value)) {
$this->setAmount($value['Amount']); $this->setAmount($value['Amount'], $markChanged);
} }
if($markChanged) $this->isChanged = true;
} else { } else {
// @todo Allow to reset a money value by passing in NULL // @todo Allow to reset a money value by passing in NULL
//user_error('Invalid value in Money->setValue()', E_USER_ERROR); //user_error('Invalid value in Money->setValue()', E_USER_ERROR);
} }
$this->isChanged = true;
} }
/** /**
@ -164,9 +165,9 @@ class Money extends DBField implements CompositeDBField {
/** /**
* @param string * @param string
*/ */
function setCurrency($currency) { function setCurrency($currency, $markChanged = true) {
$this->currency = $currency; $this->currency = $currency;
$this->isChanged = true; if($markChanged) $this->isChanged = true;
} }
/** /**
@ -181,9 +182,9 @@ class Money extends DBField implements CompositeDBField {
/** /**
* @param float $amount * @param float $amount
*/ */
function setAmount($amount) { function setAmount($amount, $markChanged = true) {
$this->amount = (float)$amount; $this->amount = (float)$amount;
$this->isChanged = true; if($markChanged) $this->isChanged = true;
} }
/** /**
@ -281,7 +282,7 @@ class Money extends DBField implements CompositeDBField {
* rather than a {@link Nice()} formatting. * rather than a {@link Nice()} formatting.
*/ */
function __toString() { function __toString() {
return $this->getAmount(); return (string)$this->getAmount();
} }
} }
?> ?>

18
security/Member.php
View File

@ -484,7 +484,7 @@ class Member extends DataObject {
// Merge existing data into the local record // Merge existing data into the local record
foreach($existingRecord->getAllFields() as $k => $v) { foreach($existingRecord->getAllFields() as $k => $v) {
if(!isset($this->changed[$k]) || !$this->changed[$k]) $this->record[$k] = $v; if(!$this->isChanged($k)) $this->record[$k] = $v;
} }
$existingRecord->destroy(); $existingRecord->destroy();
} }
@ -494,8 +494,7 @@ class Member extends DataObject {
// However, if TestMailer is in use this isn't a risk. // However, if TestMailer is in use this isn't a risk.
if( if(
(Director::isLive() || Email::mailer() instanceof TestMailer) (Director::isLive() || Email::mailer() instanceof TestMailer)
&& isset($this->changed['Password']) && $this->isChanged('Password')
&& $this->changed['Password']
&& $this->record['Password'] && $this->record['Password']
&& Member::$notify_password_change && Member::$notify_password_change
) { ) {
@ -503,18 +502,15 @@ class Member extends DataObject {
} }
// The test on $this->ID is used for when records are initially created // The test on $this->ID is used for when records are initially created
if(!$this->ID || (isset($this->changed['Password']) && $this->changed['Password'])) { if(!$this->ID || $this->isChanged('Password')) {
// Password was changed: encrypt the password according the settings // Password was changed: encrypt the password according the settings
$encryption_details = Security::encrypt_password($this->Password); $encryption_details = Security::encrypt_password($this->Password);
$this->Password = $encryption_details['password']; $this->Password = $encryption_details['password'];
$this->Salt = $encryption_details['salt']; $this->Salt = $encryption_details['salt'];
$this->PasswordEncryption = $encryption_details['algorithm']; $this->PasswordEncryption = $encryption_details['algorithm'];
$this->changed['Salt'] = true;
$this->changed['PasswordEncryption'] = true;
// If we haven't manually set a password expiry // If we haven't manually set a password expiry
if(!isset($this->changed['PasswordExpiry']) || !$this->changed['PasswordExpiry']) { if(!$this->isChanged('PasswordExpiry')) {
// then set it for us // then set it for us
if(self::$password_expiry_days) { if(self::$password_expiry_days) {
$this->PasswordExpiry = date('Y-m-d', time() + 86400 * self::$password_expiry_days); $this->PasswordExpiry = date('Y-m-d', time() + 86400 * self::$password_expiry_days);
@ -535,7 +531,7 @@ class Member extends DataObject {
function onAfterWrite() { function onAfterWrite() {
parent::onAfterWrite(); parent::onAfterWrite();
if(isset($this->changed['Password']) && $this->changed['Password']) { if($this->isChanged('Password')) {
MemberPassword::log($this); MemberPassword::log($this);
} }
} }
@ -985,13 +981,13 @@ class Member extends DataObject {
function validate() { function validate() {
$valid = parent::validate(); $valid = parent::validate();
if(!$this->ID || (isset($this->changed['Password']) && $this->changed['Password'])) { if(!$this->ID || $this->isChanged('Password')) {
if($this->Password && self::$password_validator) { if($this->Password && self::$password_validator) {
$valid->combineAnd(self::$password_validator->validate($this->Password, $this)); $valid->combineAnd(self::$password_validator->validate($this->Password, $this));
} }
} }
if((!$this->ID && $this->SetPassword) || (isset($this->changed['SetPassword']) && $this->changed['SetPassword'])) { if((!$this->ID && $this->SetPassword) || $this->isChanged('SetPassword')) {
if($this->SetPassword && self::$password_validator) { if($this->SetPassword && self::$password_validator) {
$valid->combineAnd(self::$password_validator->validate($this->SetPassword, $this)); $valid->combineAnd(self::$password_validator->validate($this->SetPassword, $this));
} }

31
tests/DataObjectTest.php
View File

@ -272,6 +272,37 @@ class DataObjectTest extends SapphireTest {
); );
} }
function testIsChanged() {
$page = $this->fixture->objFromFixture('Page', 'home');
$page->Title = 'Home-Changed';
$page->ShowInMenus = true; // type change only, database stores "1"
$this->assertTrue($page->isChanged('Title', 1));
$this->assertTrue($page->isChanged('Title', 2));
$this->assertTrue($page->isChanged('ShowInMenus', 1));
$this->assertFalse($page->isChanged('ShowInMenus', 2));
$this->assertFalse($page->isChanged('Content', 1));
$this->assertFalse($page->isChanged('Content', 2));
$newPage = new Page();
$newPage->Title = "New Page Title";
$this->assertTrue($newPage->isChanged('Title', 1));
$this->assertTrue($newPage->isChanged('Title', 2));
$this->assertFalse($newPage->isChanged('Content', 1));
$this->assertFalse($newPage->isChanged('Content', 2));
$newPage->write();
$this->assertFalse($newPage->isChanged('Title', 1));
$this->assertFalse($newPage->isChanged('Title', 2));
$this->assertFalse($newPage->isChanged('Content', 1));
$this->assertFalse($newPage->isChanged('Content', 2));
$page = $this->fixture->objFromFixture('Page', 'home');
$page->Title = null;
$this->assertTrue($page->isChanged('Title', 1));
$this->assertTrue($page->isChanged('Title', 2));
}
function testRandomSort() { function testRandomSort() {
/* If we perforn the same regularly sorted query twice, it should return the same results */ /* If we perforn the same regularly sorted query twice, it should return the same results */
$itemsA = DataObject::get("PageComment", "", "ID"); $itemsA = DataObject::get("PageComment", "", "ID");

7
tests/model/MoneyTest.php
View File

@ -25,6 +25,13 @@ class MoneyTest extends SapphireTest {
function testDataObjectChangedFields() { function testDataObjectChangedFields() {
$obj = $this->objFromFixture('MoneyTest_DataObject', 'test1'); $obj = $this->objFromFixture('MoneyTest_DataObject', 'test1');
// Without changes
$curr = $obj->obj('MyMoney');
$changed = $obj->getChangedFields();
$this->assertNotContains('MyMoney', array_keys($changed));
// With changes
$obj->MyMoney->setAmount(99); $obj->MyMoney->setAmount(99);
$changed = $obj->getChangedFields(); $changed = $obj->getChangedFields();
$this->assertContains('MyMoney', array_keys($changed)); $this->assertContains('MyMoney', array_keys($changed));

12
tests/model/VersionedTest.php
View File

@ -3,6 +3,18 @@
class VersionedTest extends SapphireTest { class VersionedTest extends SapphireTest {
static $fixture_file = 'sapphire/tests/model/VersionedTest.yml'; static $fixture_file = 'sapphire/tests/model/VersionedTest.yml';
function testForceChangeUpdatesVersion() {
$page = $this->objFromFixture('Page', 'page3');
$oldVersion = $page->Version;
$page->forceChange();
$page->write();
$this->assertTrue(
($page->Version > $oldVersion),
"A object Version is increased when just calling forceChange() without any other changes"
);
}
/** /**
* Test Versioned::get_including_deleted() * Test Versioned::get_including_deleted()
*/ */