mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-01 13:48:37 +02:00
5c9044a007
API Introduce HTMLFragment as casting helper for HTMLText with shortcodes disabled API Introduce DBField::CDATA for XML file value encoding API RSSFeed now casts from the underlying model rather than by override API Introduce CustomMethods::getExtraMethodConfig() to allow metadata to be queried BUG Remove _call hack from VirtualPage API Remove FormField::$dontEscape API Introduce HTMLReadonlyField for non-editable readonly HTML API FormField::Field() now returns string in many cases rather than DBField instance. API Remove redundant *_val methods from ViewableData API ViewableData::obj() no longer has a $forceReturnObject parameter as it always returns an object BUG Fix issue with ViewableData caching incorrect field values after being modified. API Remove deprecated DB class methods API Enforce plain text left/right formfield titles
120 lines
2.7 KiB
PHP
120 lines
2.7 KiB
PHP
<?php
|
|
/**
|
|
* Read-only field to display a non-editable value with a label.
|
|
* Consider using an {@link LabelField} if you just need a label-less
|
|
* value display.
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-basic
|
|
*/
|
|
class ReadonlyField extends FormField {
|
|
|
|
protected $readonly = true;
|
|
|
|
/**
|
|
* Include a hidden field in the HTML for the readonly field
|
|
* @var boolean
|
|
*/
|
|
protected $includeHiddenField = false;
|
|
|
|
protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TEXT;
|
|
|
|
/**
|
|
* If true, a hidden field will be included in the HTML for the readonly field.
|
|
*
|
|
* This can be useful if you need to pass the data through on the form submission, as
|
|
* long as it's okay than an attacker could change the data before it's submitted.
|
|
*
|
|
* This is disabled by default as it can introduce security holes if the data is not
|
|
* allowed to be modified by the user.
|
|
*
|
|
* @param boolean $includeHiddenField
|
|
*/
|
|
public function setIncludeHiddenField($includeHiddenField) {
|
|
$this->includeHiddenField = $includeHiddenField;
|
|
}
|
|
|
|
public function performReadonlyTransformation() {
|
|
return clone $this;
|
|
}
|
|
|
|
/**
|
|
* @param array $properties
|
|
* @return string
|
|
*/
|
|
public function Field($properties = array()) {
|
|
// Include a hidden field in the HTML
|
|
if($this->includeHiddenField && $this->readonly) {
|
|
$hidden = clone $this;
|
|
$hidden->setReadonly(false);
|
|
return parent::Field($properties) . $hidden->Field($properties);
|
|
|
|
} else {
|
|
return parent::Field($properties);
|
|
}
|
|
}
|
|
|
|
public function getAttributes() {
|
|
return array_merge(
|
|
parent::getAttributes(),
|
|
array(
|
|
'type' => 'hidden',
|
|
'value' => $this->readonly ? null : $this->value,
|
|
)
|
|
);
|
|
}
|
|
|
|
public function Type() {
|
|
return 'readonly';
|
|
}
|
|
|
|
public function castingHelper($field) {
|
|
// Get dynamic cast for 'Value' field
|
|
if(strcasecmp($field, 'Value') === 0) {
|
|
return $this->getValueCast();
|
|
}
|
|
|
|
// Fall back to default casting
|
|
return parent::castingHelper($field);
|
|
}
|
|
|
|
|
|
/**
|
|
* If $dontEscape is true the returned value will be plain text
|
|
* and should be escaped in templates via .XML
|
|
*
|
|
* If $dontEscape is false the returned value will be safely encoded,
|
|
* but should not be escaped by the frontend.
|
|
*
|
|
* @return mixed|string
|
|
*/
|
|
public function Value() {
|
|
// Get raw value
|
|
$value = $this->dataValue();
|
|
if($value) {
|
|
return $value;
|
|
}
|
|
|
|
// "none" text
|
|
$label = _t('FormField.NONE', 'none');
|
|
return "<i>('{$label}')</i>";
|
|
}
|
|
|
|
/**
|
|
* Get custom cating helper for Value() field
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getValueCast() {
|
|
// Casting class for 'none' text
|
|
$value = $this->dataValue();
|
|
if(empty($value)) {
|
|
return 'HTMLFragment';
|
|
}
|
|
|
|
// Use default casting
|
|
return $this->config()->casting['Value'];
|
|
}
|
|
|
|
}
|