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

MINOR Documentation in DataObject

Browse Source
This commit is contained in:
Ingo Schommer 2010-12-07 10:46:24 +13:00
parent 04c8124f39
commit c36ac4278d
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
core/model/DataObject.php
View File

@ -97,8 +97,11 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
public $destroyed = false; public $destroyed = false;
/** /**
* Data stored in this objects database record. An array indexed * Data stored in this objects database record. An array indexed by fieldname.
* by fieldname. *
* Use {@link toMap()} if you want an array representation
* of this object, as the $record array might contain lazy loaded field aliases.
*
* @var array * @var array
*/ */
protected $record; protected $record;
@ -161,7 +164,8 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
} }
/** /**
* Return the complete map of fields on this object, including Created, LastEdited and ClassName * Return the complete map of fields on this object, including "Created", "LastEdited" and "ClassName".
* See {@link custom_database_fields()} for a getter that excludes these "base fields".
* *
* @param string $class * @param string $class
* @return array * @return array
@ -187,6 +191,9 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* into the actual database fields, rather than the name of the field which * into the actual database fields, rather than the name of the field which
* might not equate a database column. * might not equate a database column.
* *
* Does not include "base fields" like "ID", "ClassName", "Created", "LastEdited",
* see {@link database_fields()}.
*
* @uses CompositeDBField->compositeDatabaseFields() * @uses CompositeDBField->compositeDatabaseFields()
* *
* @param string $class * @param string $class