ENHANCEMENT Consistently allowing for $restrictFields and $fieldClasses parameters passed to DataObject->scaffoldFormFields(), DataObject->scaffoldSearchFields(), DataObject->scaffoldCMSFields()

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@63651 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2008-10-05 19:22:54 +00:00
parent eff1f50041
commit e1e2329c90

View File

@ -1449,14 +1449,22 @@ class DataObject extends ViewableData implements DataObjectInterface {
* how generic or specific the field type is. * how generic or specific the field type is.
* *
* @usedby {@link SearchContext} * @usedby {@link SearchContext}
*
* @param array $restrictFields
* @param array $fieldClasses
* @return FieldSet * @return FieldSet
*/ */
public function scaffoldSearchFields() { public function scaffoldSearchFields($restrictFields = null, $fieldClasses = null) {
$fields = new FieldSet(); $fields = new FieldSet();
foreach($this->searchableFields() as $fieldName => $spec) { foreach($this->searchableFields() as $fieldName => $spec) {
if($restrictFields && !in_array($fieldName, $restrictFields)) continue;
// If a custom fieldclass is provided as a string, use it
if($fieldClasses && isset($fieldClasses[$fieldName])) {
$fieldClass = $fieldClasses[$fieldName];
$field = new $fieldClass($fieldName);
// If we explicitly set a field, then construct that // If we explicitly set a field, then construct that
if(isset($spec['field'])) { } else if(isset($spec['field'])) {
// If it's a string, use it as a class name and construct // If it's a string, use it as a class name and construct
if(is_string($spec['field'])) { if(is_string($spec['field'])) {
$fieldClass = $spec['field']; $fieldClass = $spec['field'];
@ -1493,12 +1501,16 @@ class DataObject extends ViewableData implements DataObjectInterface {
* *
* @uses DBField::scaffoldFormField() * @uses DBField::scaffoldFormField()
* @uses DataObject::fieldLabels() * @uses DataObject::fieldLabels()
*
* @param
* @param array $fieldClasses Optional mapping of fieldnames to subclasses of {@link DBField} * @param array $fieldClasses Optional mapping of fieldnames to subclasses of {@link DBField}
* @return FieldSet * @return FieldSet
*/ */
public function scaffoldFormFields($fieldClasses = null) { public function scaffoldFormFields($restrictFields = null, $fieldClasses = null) {
$fields = new FieldSet(); $fields = new FieldSet();
foreach($this->db() as $fieldName => $fieldType) { foreach($this->db() as $fieldName => $fieldType) {
if($restrictFields && !in_array($fieldName, $restrictFields)) continue;
// @todo Pass localized title // @todo Pass localized title
if(isset($fieldClasses[$fieldName])) { if(isset($fieldClasses[$fieldName])) {
$fieldClass = $fieldClasses[$fieldName]; $fieldClass = $fieldClasses[$fieldName];
@ -1510,6 +1522,8 @@ class DataObject extends ViewableData implements DataObjectInterface {
$fields->push($fieldObject); $fields->push($fieldObject);
} }
foreach($this->has_one() as $relationship => $component) { foreach($this->has_one() as $relationship => $component) {
if($restrictFields && !in_array($relationship, $restrictFields)) continue;
$model = singleton($component); $model = singleton($component);
$records = DataObject::get($component); $records = DataObject::get($component);
$collect = ($model->hasMethod('customSelectOption')) ? 'customSelectOption' : 'Title'; $collect = ($model->hasMethod('customSelectOption')) ? 'customSelectOption' : 'Title';
@ -1530,8 +1544,8 @@ class DataObject extends ViewableData implements DataObjectInterface {
* *
* @return FieldSet Tabbed fields * @return FieldSet Tabbed fields
*/ */
public function scaffoldCMSFields() { public function scaffoldCMSFields($restrictFields = null, $fieldClasses = null) {
$untabbedFields = $this->scaffoldFormFields(); $untabbedFields = $this->scaffoldFormFields($restrictFields, $fieldClasses);
// make sure we have a tabset // make sure we have a tabset
if(!$untabbedFields->hasTabSet()) { if(!$untabbedFields->hasTabSet()) {