silverstripe-framework/Forms/HTMLEditor/HTMLEditorField.php
Damian Mooyman 8dd644d25d
API Namespace all classes
Namespace all templates
Move difflib and BBCodeParser2 to thirdparty
Remove deprecated API marked for removal in 4.0
2016-09-08 10:23:17 +12:00

153 lines
3.7 KiB
PHP

<?php
namespace SilverStripe\Forms\HTMLEditor;
use SilverStripe\Assets\Image;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\TextareaField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DataObjectInterface;
use Exception;
/**
* A TinyMCE-powered WYSIWYG HTML editor field with image and link insertion and tracking capabilities. Editor fields
* are created from <textarea> tags, which are then converted with JavaScript.
*/
class HTMLEditorField extends TextareaField {
private static $casting = [
'Value' => 'HTMLText',
];
/**
* Use TinyMCE's GZIP compressor
*
* @config
* @var bool
*/
private static $use_gzip = true;
/**
* Should we check the valid_elements (& extended_valid_elements) rules from HTMLEditorConfig server side?
*
* @config
* @var bool
*/
private static $sanitise_server_side = false;
/**
* Number of rows
*
* @config
* @var int
*/
private static $default_rows = 30;
/**
* ID or instance of editorconfig
*
* @var string|HTMLEditorConfig
*/
protected $editorConfig = null;
/**
* Gets the HTMLEditorConfig instance
*
* @return HTMLEditorConfig
*/
public function getEditorConfig() {
// Instance override
if($this->editorConfig instanceof HTMLEditorConfig) {
return $this->editorConfig;
}
// Get named / active config
return HTMLEditorConfig::get($this->editorConfig);
}
/**
* Assign a new configuration instance or identifier
*
* @param string|HTMLEditorConfig $config
* @return $this
*/
public function setEditorConfig($config) {
$this->editorConfig = $config;
return $this;
}
/**
* Creates a new HTMLEditorField.
* @see TextareaField::__construct()
*
* @param string $name The internal field name, passed to forms.
* @param string $title The human-readable field label.
* @param mixed $value The value of the field.
* @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
*/
public function __construct($name, $title = null, $value = '', $config = null) {
parent::__construct($name, $title, $value);
if($config) {
$this->setEditorConfig($config);
}
$this->setRows($this->config()->default_rows);
}
public function getAttributes() {
return array_merge(
parent::getAttributes(),
$this->getEditorConfig()->getAttributes()
);
}
/**
* @param DataObject|DataObjectInterface $record
* @throws Exception
*/
public function saveInto(DataObjectInterface $record) {
if($record->hasField($this->name) && $record->escapeTypeForField($this->name) != 'xml') {
throw new Exception (
'HTMLEditorField->saveInto(): This field should save into a HTMLText or HTMLVarchar field.'
);
}
// Sanitise if requested
$htmlValue = Injector::inst()->create('HTMLValue', $this->Value());
if($this->config()->sanitise_server_side) {
$santiser = HTMLEditorSanitiser::create(HTMLEditorConfig::get_active());
$santiser->sanitise($htmlValue);
}
// optionally manipulate the HTML after a TinyMCE edit and prior to a save
$this->extend('processHTML', $htmlValue);
// Store into record
$record->{$this->name} = $htmlValue->getContent();
}
public function setValue($value) {
// Regenerate links prior to preview, so that the editor can see them.
$value = Image::regenerate_html_links($value);
return parent::setValue($value);
}
/**
* @return HTMLEditorField_Readonly
*/
public function performReadonlyTransformation() {
return $this->castedCopy('SilverStripe\\Forms\\HTMLEditor\\HTMLEditorField_Readonly');
}
public function performDisabledTransformation() {
return $this->performReadonlyTransformation();
}
public function Field($properties = array()) {
// Include requirements
$this->getEditorConfig()->init();
return parent::Field($properties);
}
}