silverstripe-framework/ORM/DataObjectInterface.php

51 lines
1.5 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\ORM;
2014-08-15 08:53:05 +02:00
/**
* DataObjectInterface is an interface that other data systems in your application can implement in order to behave in
* a manner similar to DataObject.
*
* In addition to the methods defined below, the data of the object should be directly accessible as fields.
*/
interface DataObjectInterface {
/**
* Create a new data object, not yet in the database. To load an object into the database, a null object should be
* constructed, its fields set, and the write() method called.
*/
public function __construct();
/**
* Write the current object back to the database. It should know whether this is a new object, in which case this
* would be an insert command, or if this is an existing object queried from the database, in which case thes would
2014-08-15 08:53:05 +02:00
* be
*/
public function write();
2014-08-15 08:53:05 +02:00
/**
* Remove this object from the database. Doesn't do anything if this object isn't in the database.
*/
public function delete();
2014-08-15 08:53:05 +02:00
/**
* Get the named field.
* This function is sometimes called explicitly by the form system, so you need to define it, even if you use the
* default field system.
*
* @param string $fieldName
* @return mixed
*/
public function __get($fieldName);
2014-08-15 08:53:05 +02:00
/**
* Save content from a form into a field on this data object.
* Since the data comes straight from a form it can't be trusted and will need to be validated / escaped.'
*
* @param string $fieldName
* @param mixed $val
* @return $this
*/
public function setCastedField($fieldName, $val);
2014-08-15 08:53:05 +02:00
}