diff --git a/core/model/DataObject.php b/core/model/DataObject.php index 26f264280..18ddedf1d 100755 --- a/core/model/DataObject.php +++ b/core/model/DataObject.php @@ -97,8 +97,11 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity public $destroyed = false; /** - * Data stored in this objects database record. An array indexed - * by fieldname. + * Data stored in this objects database record. An array indexed 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 */ 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 * @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 * might not equate a database column. * + * Does not include "base fields" like "ID", "ClassName", "Created", "LastEdited", + * see {@link database_fields()}. + * * @uses CompositeDBField->compositeDatabaseFields() * * @param string $class