Remove superfluous empty lines

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / form / builder / field / wysiwyg / WysiwygFormField.class.php

<?php
namespace wcf\system\form\builder\field\wysiwyg;
use wcf\system\form\builder\field\AbstractFormField;
use wcf\system\form\builder\field\data\processor\CustomFormFieldDataProcessor;
use wcf\system\form\builder\field\IMaximumLengthFormField;
use wcf\system\form\builder\field\IMinimumLengthFormField;
use wcf\system\form\builder\field\IObjectTypeFormNode;
use wcf\system\form\builder\field\TMaximumLengthFormField;
use wcf\system\form\builder\field\TMinimumLengthFormField;
use wcf\system\form\builder\field\TObjectTypeFormNode;
use wcf\system\form\builder\field\validation\FormFieldValidationError;
use wcf\system\form\builder\IFormDocument;
use wcf\system\html\input\HtmlInputProcessor;
use wcf\util\StringUtil;

/**
 * Implementation of a form field for wysiwyg editors.
 * 
 * @author	Matthias Schmidt
 * @copyright	2001-2019 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	WoltLabSuite\Core\System\Form\Builder\Field
 * @since	5.2
 */
class WysiwygFormField extends AbstractFormField implements IMaximumLengthFormField, IMinimumLengthFormField, IObjectTypeFormNode {
	use TMaximumLengthFormField;
	use TMinimumLengthFormField;
	use TObjectTypeFormNode;
	
	/**
	 * identifier used to autosave the field value; if empty, autosave is disabled
	 * @var	string
	 */
	protected $autosaveId = '';
	
	/**
	 * input processor containing the wysiwyg text
	 * @var	HtmlInputProcessor
	 */
	protected $htmlInputProcessor;
	
	/**
	 * last time the field has been edited; if `0`, the last edit time is unknown
	 * @var	int
	 */
	protected $lastEditTime = 0;
	
	/**
	 * is `true` if this form field should support attachments, otherwise `false`
	 * @var	boolean 
	 */
	protected $supportAttachments = false;
	
	/**
	 * is `true` if this form field should support mentions, otherwise `false`
	 * @var	boolean
	 */
	protected $supportMentions = false;
	
	/**
	 * @inheritDoc
	 */
	protected $templateName = '__wysiwygFormField';
	
	/**
	 * Sets the identifier used to autosave the field value and returns this field.
	 * 
	 * @param	string		$autosaveId	identifier used to autosave field value
	 *
	 * @return        WysiwygFormNode		this field
	 */
	public function autosaveId($autosaveId) {
		$this->autosaveId = $autosaveId;
		
		return $this;
	}
	
	/**
	 * Returns the identifier used to autosave the field value. If autosave is disabled,
	 * an empty string is returned.
	 * 
	 * @return	string
	 */
	public function getAutosaveId() {
		return $this->autosaveId;
	}
	
	/**
	 * @inheritDoc
	 */
	public function getObjectTypeDefinition() {
		return 'com.woltlab.wcf.message';
	}
	
	/**
	 * Returns the last time the field has been edited. If no last edit time has
	 * been set, `0` is returned.
	 * 
	 * @return	int
	 */
	public function getLastEditTime() {
		return $this->lastEditTime;
	}
	
	/**
	 * @inheritDoc
	 */
	public function hasSaveValue() {
		return false;
	}
	
	/**
	 * Sets the last time this field has been edited and returns this field.
	 * 
	 * @param	int	$lastEditTime	last time field has been edited
	 *
	 * @return        WysiwygFormNode	this field
	 */
	public function lastEditTime($lastEditTime) {
		$this->lastEditTime = $lastEditTime;
		
		return $this;
	}
	
	/**
	 * @inheritDoc
	 */
	public function populate() {
		parent::populate();
		
		$this->getDocument()->getDataHandler()->add(new CustomFormFieldDataProcessor('wysiwyg', function(IFormDocument $document, array $parameters) {
			if ($this->checkDependencies()) {
				$parameters[$this->getObjectProperty() . '_htmlInputProcessor'] = $this->htmlInputProcessor;
			}
			
			return $parameters;
		}));
		
		return $this;
	}
	
	/**
	 * @inheritDoc
	 */
	public function readValue() {
		if ($this->getDocument()->hasRequestData($this->getPrefixedId())) {
			$value = $this->getDocument()->getRequestData($this->getPrefixedId());
			
			if (is_string($value)) {
				$this->value = StringUtil::trim($value);
			}
		}
		
		return $this;
	}
	
	/**
	 * Sets if the form field supports attachments and returns this field.
	 * 
	 * @param	boolean		$supportAttachments
	 *
	 * @return        WysiwygFormNode
	 */
	public function supportAttachments($supportAttachments = true) {
		$this->supportAttachments = $supportAttachments;
		
		return $this;
	}
	
	/**
	 * Sets if the form field supports mentions and returns this field.
	 * 
	 * @param	boolean		$supportMentions
	 *
	 * @return        WysiwygFormNode
	 */
	public function supportMentions($supportMentions = true) {
		$this->supportMentions = $supportMentions;
		
		return $this;
	}
	
	/**
	 * Returns `true` if the form field supports attachments and returns `false` otherwise.
	 * 
	 * Important: If this method returns `true`, it does not necessarily mean that attachment
	 * support will also work as that is the task of `WysiwygAttachmentFormField`. This method
	 * is primarily relevant to inform the JavaScript API that the field supports attachments
	 * so that the relevant editor plugin is loaded.
	 * 
	 * By default, attachments are not supported.
	 * 
	 * @return	boolean
	 */
	public function supportsAttachments() {
		return $this->supportAttachments;
	}
	
	/**
	 * Returns `true` if the form field supports mentions and returns `false` otherwise.
	 * 
	 * By default, mentions are not supported.
	 * 
	 * @return	boolean
	 */
	public function supportsMentions() {
		return $this->supportMentions;
	}
	
	/**
	 * @inheritDoc
	 */
	public function validate() {
		if ($this->isRequired() && $this->getValue() === '') {
			$this->addValidationError(new FormFieldValidationError('empty'));
		}
		else {
			$this->validateMinimumLength($this->getValue());
			$this->validateMaximumLength($this->getValue());
		}
		
		$this->htmlInputProcessor = new HtmlInputProcessor();
		$this->htmlInputProcessor->process($this->getValue(), $this->getObjectType()->objectType);
		
		parent::validate();
	}
}