mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-06 17:51:34 +02:00
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@79107 467b73ca-7a2a-4603-9d3b-597d59a354a9
246 lines
6.4 KiB
PHP
Executable File
246 lines
6.4 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Plug-ins for additional functionality in your DataObjects
|
|
*
|
|
* DataObject decorators add extra functionality to your data objects.
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
abstract class DataObjectDecorator extends Extension {
|
|
|
|
/**
|
|
* Statics on a {@link DataObject} subclass
|
|
* which can be decorated onto. This list is
|
|
* limited for security and performance reasons.
|
|
*
|
|
* Keys are the static names, and the values are whether or not the value is an array that should
|
|
* be merged.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected static $decoratable_statics = array(
|
|
'db' => true,
|
|
'has_one' => true,
|
|
'indexes' => true,
|
|
'defaults' => true,
|
|
'has_many' => true,
|
|
'many_many' => true,
|
|
'belongs_many_many' => true,
|
|
'many_many_extraFields' => true,
|
|
'searchable_fields' => true,
|
|
'api_access' => false,
|
|
);
|
|
|
|
private static $extra_statics_loaded = array();
|
|
|
|
/**
|
|
* Set the owner of this decorator.
|
|
* @param DataObject $owner
|
|
*/
|
|
/*
|
|
function setOwner($owner, $ownerBaseClass = null) {
|
|
if($owner && !($owner instanceof DataObject)) {
|
|
user_error(sprintf(
|
|
"DataObjectDecorator->setOwner(): Trying to decorate an object of class '%s' with '%s',
|
|
only Dataobject subclasses are supported.",
|
|
get_class($owner), $this->class),
|
|
E_USER_ERROR
|
|
);
|
|
return false;
|
|
}
|
|
|
|
parent::setOwner($owner, $ownerBaseClass);
|
|
}
|
|
*/
|
|
|
|
/**
|
|
* Load the extra database fields defined in extraStatics.
|
|
*/
|
|
function loadExtraStatics() {
|
|
if(!empty(self::$extra_statics_loaded[$this->ownerBaseClass][$this->class])) return;
|
|
self::$extra_statics_loaded[$this->ownerBaseClass][$this->class] = true;
|
|
|
|
// If the extension has been manually applied to a subclass, we should ignore that.
|
|
if(Object::has_extension(get_parent_class($this->owner), $this->class)) return;
|
|
|
|
if($fields = $this->extraStatics()) {
|
|
foreach($fields as $relation => $newVal) {
|
|
if(isset(self::$decoratable_statics[$relation])) {
|
|
$origVal = Object::get_static($this->ownerBaseClass, $relation);
|
|
|
|
// Array to be merged
|
|
if(self::$decoratable_statics[$relation]) {
|
|
// Can't use add_static_var() here as it would merge the array rather than replacing
|
|
Object::set_static($this->ownerBaseClass, $relation, array_merge((array)$origVal, $newVal));
|
|
|
|
// Value to be overwritten
|
|
} else {
|
|
Object::set_static ($this->ownerBaseClass, $relation, $newVal);
|
|
}
|
|
}
|
|
}
|
|
|
|
DataObject::$cache_has_own_table[$this->ownerBaseClass] = null;
|
|
DataObject::$cache_has_own_table_field[$this->ownerBaseClass] = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated 2.4 Use loadExtraStatics()
|
|
*/
|
|
function loadExtraDBFields() {
|
|
user_error('DataObjectDecorator::loadExtraDBFields() is deprecated. Please use loadExtraStatics() instead.', E_USER_NOTICE);
|
|
return $this->loadExtraStatics();
|
|
}
|
|
|
|
/**
|
|
* Edit the given query object to support queries for this extension
|
|
*
|
|
* @param SQLQuery $query Query to augment.
|
|
*/
|
|
function augmentSQL(SQLQuery &$query) {
|
|
}
|
|
|
|
/**
|
|
* Update the database schema as required by this extension.
|
|
*/
|
|
function augmentDatabase() {
|
|
}
|
|
|
|
/**
|
|
* Augment a write-record request.
|
|
*
|
|
* @param SQLQuery $manipulation Query to augment.
|
|
*/
|
|
function augmentWrite(&$manipulation) {
|
|
}
|
|
|
|
function onBeforeWrite() {
|
|
}
|
|
|
|
function onAfterWrite() {
|
|
}
|
|
|
|
function onBeforeDelete() {
|
|
}
|
|
|
|
function onAfterDelete() {
|
|
}
|
|
|
|
function requireDefaultRecords() {
|
|
}
|
|
|
|
function populateDefaults() {
|
|
}
|
|
|
|
function can($member) {
|
|
}
|
|
|
|
function canEdit($member) {
|
|
}
|
|
|
|
function canDelete($member) {
|
|
}
|
|
|
|
function canCreate($member) {
|
|
}
|
|
|
|
/**
|
|
* Define extra database fields
|
|
*
|
|
* Return a map where the keys are db, has_one, etc, and the values are
|
|
* additional fields/relations to be defined.
|
|
*
|
|
* @return array Returns a map where the keys are db, has_one, etc, and
|
|
* the values are additional fields/relations to be defined.
|
|
*/
|
|
function extraStatics() {
|
|
return $this->extraDBFields();
|
|
}
|
|
|
|
/**
|
|
* @deprecated 2.4 Use extraStatics()
|
|
*/
|
|
function extraDBFields() {
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* This function is used to provide modifications to the form in the CMS
|
|
* by the decorator. By default, no changes are made. {@link DataObject->getCMSFields()}.
|
|
*
|
|
* Please consider using {@link updateFormFields()} to globally add
|
|
* formfields to the record. The method {@link updateCMSFields()}
|
|
* should just be used to add or modify tabs, or fields which
|
|
* are specific to the CMS-context.
|
|
*
|
|
* Caution: Use {@link FieldSet->addFieldToTab()} to add fields.
|
|
*
|
|
* @param FieldSet $fields FieldSet with a contained TabSet
|
|
*/
|
|
function updateCMSFields(FieldSet &$fields) {
|
|
}
|
|
|
|
/**
|
|
* This function is used to provide modifications to the form used
|
|
* for front end forms. {@link DataObject->getFrontEndFields()}
|
|
*
|
|
* Caution: Use {@link FieldSet->push()} to add fields.
|
|
*
|
|
* @param FieldSet $fields FieldSet without TabSet nesting
|
|
*/
|
|
function updateFrontEndFields(FieldSet &$fields) {
|
|
}
|
|
|
|
/**
|
|
* This is used to provide modifications to the form actions
|
|
* used in the CMS. {@link DataObject->getCMSActions()}.
|
|
*
|
|
* @param FieldSet $actions FieldSet
|
|
*/
|
|
function updateCMSActions(FieldSet &$actions) {
|
|
}
|
|
|
|
/**
|
|
* this function is used to provide modifications to the summary fields in CMS
|
|
* by the decorator
|
|
* By default, the summaryField() of its owner will merge more fields defined in the decorator's
|
|
* $extra_fields['summary_fields']
|
|
*/
|
|
function updateSummaryFields(&$fields){
|
|
$extra_fields = $this->extraStatics();
|
|
if(isset($extra_fields['summary_fields'])){
|
|
$summary_fields = $extra_fields['summary_fields'];
|
|
|
|
// if summary_fields were passed in numeric array,
|
|
// convert to an associative array
|
|
if($summary_fields && array_key_exists(0, $summary_fields)) {
|
|
$summary_fields = array_combine(array_values($summary_fields), array_values($summary_fields));
|
|
}
|
|
if($summary_fields) $fields = array_merge($fields, $summary_fields);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* this function is used to provide modifications to the fields labels in CMS
|
|
* by the decorator
|
|
* By default, the fieldLabels() of its owner will merge more fields defined in the decorator's
|
|
* $extra_fields['field_labels']
|
|
*/
|
|
function updateFieldLabels(&$lables){
|
|
$extra_fields = $this->extraStatics();
|
|
if(isset($extra_fields['field_labels'])){
|
|
$field_labels = $extra_fields['field_labels'];
|
|
if($field_labels) $lables = array_merge($lables, $field_labels);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clear any internal caches.
|
|
*/
|
|
function flushCache() {
|
|
}
|
|
|
|
}
|
|
?>
|