mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-07 18:21:23 +02:00
245 lines
6.9 KiB
PHP
245 lines
6.9 KiB
PHP
<?php
|
|
/**
|
|
* An extension that adds additional functionality to a {@link DataObject}.
|
|
*
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
abstract class DataExtension extends Extension {
|
|
|
|
/**
|
|
* Statics on a {@link DataObject} subclass
|
|
* which can be extended by an extension. 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 $extendable_statics = array(
|
|
'db' => true,
|
|
'has_one' => true,
|
|
'belongs_to' => 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();
|
|
|
|
/**
|
|
* Load the extra static definitions for the given extension
|
|
* class name, called by {@link Object::add_extension()}
|
|
*
|
|
* @param string $class Class name of the owner class (or owner base class)
|
|
* @param string $extension Class name of the extension class
|
|
*/
|
|
public static function load_extra_statics($class, $extension) {
|
|
if(!empty(self::$extra_statics_loaded[$class][$extension])) return;
|
|
self::$extra_statics_loaded[$class][$extension] = true;
|
|
|
|
if(preg_match('/^([^(]*)/', $extension, $matches)) {
|
|
$extensionClass = $matches[1];
|
|
} else {
|
|
user_error("Bad extenion '$extension' - can't find classname", E_USER_WARNING);
|
|
return;
|
|
}
|
|
|
|
// @deprecated 2.4 - use extraStatics() now, not extraDBFields()
|
|
if(method_exists($extensionClass, 'extraDBFields')) {
|
|
Deprecation::notice('2.4', 'DataExtension::extraDBFields() is deprecated. Please use extraStatics() instead.');
|
|
$extraStaticsMethod = 'extraDBFields';
|
|
} else {
|
|
$extraStaticsMethod = 'extraStatics';
|
|
}
|
|
|
|
// If the extension has been manually applied to a subclass, we should ignore that.
|
|
if(Object::has_extension(get_parent_class($class), $extensionClass)) return;
|
|
|
|
// If there aren't any extraStatics we shouldn't try to load them.
|
|
if (!method_exists($extensionClass, $extraStaticsMethod) ) return;
|
|
|
|
$statics = call_user_func(array(singleton($extensionClass), $extraStaticsMethod), $class, $extension);
|
|
|
|
if($statics) {
|
|
foreach($statics as $name => $newVal) {
|
|
if(isset(self::$extendable_statics[$name])) {
|
|
|
|
// Array to be merged
|
|
if(self::$extendable_statics[$name]) {
|
|
$origVal = Object::uninherited_static($class, $name);
|
|
// Can't use add_static_var() here as it would merge the array rather than replacing
|
|
Object::set_static($class, $name, array_merge((array)$origVal, $newVal));
|
|
|
|
// Value to be overwritten
|
|
} else {
|
|
Object::set_static($class, $name, $newVal);
|
|
}
|
|
}
|
|
}
|
|
|
|
DataObject::$cache_has_own_table[$class] = null;
|
|
DataObject::$cache_has_own_table_field[$class] = null;
|
|
}
|
|
}
|
|
|
|
public static function unload_extra_statics($class, $extension) {
|
|
self::$extra_statics_loaded[$class][$extension] = false;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* When duplicating a table's structure, remember to duplicate the create options
|
|
* as well. See {@link Versioned->augmentDatabase} for an example.
|
|
*/
|
|
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.
|
|
*
|
|
* @param $class since this method might be called on the class directly
|
|
* @param $extension since this can help to extract parameters to help set indexes
|
|
*
|
|
* @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($class=null, $extension=null) {
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* This function is used to provide modifications to the form in the CMS
|
|
* by the extension. 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 FieldList->addFieldToTab()} to add fields.
|
|
*
|
|
* @param FieldList $fields FieldList with a contained TabSet
|
|
*/
|
|
function updateCMSFields(FieldList $fields) {
|
|
}
|
|
|
|
/**
|
|
* This function is used to provide modifications to the form used
|
|
* for front end forms. {@link DataObject->getFrontEndFields()}
|
|
*
|
|
* Caution: Use {@link FieldList->push()} to add fields.
|
|
*
|
|
* @param FieldList $fields FieldList without TabSet nesting
|
|
*/
|
|
function updateFrontEndFields(FieldList $fields) {
|
|
}
|
|
|
|
/**
|
|
* This is used to provide modifications to the form actions
|
|
* used in the CMS. {@link DataObject->getCMSActions()}.
|
|
*
|
|
* @param FieldList $actions FieldList
|
|
*/
|
|
function updateCMSActions(FieldList $actions) {
|
|
}
|
|
|
|
/**
|
|
* this function is used to provide modifications to the summary fields in CMS
|
|
* by the extension
|
|
* By default, the summaryField() of its owner will merge more fields defined in the extension'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 extension
|
|
* By default, the fieldLabels() of its owner will merge more fields defined in the extension'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() {
|
|
}
|
|
|
|
}
|
|
|