File builder/form/field/FormFieldRichTextEditor.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 

<?php
/**
 * This class represents a rich text editor.
 * @package     Builder
 * @subpackage  Form\field
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2018 11 16
 * @since       PHPBoost 3.0 - 2010 01 09
 * @contributor Arnaud GENET <elenwii@phpboost.com>
 * @contributor mipel <mipel@phpboost.com>
*/

class FormFieldRichTextEditor extends FormFieldMultiLineTextEditor
{
    /**
     * @var ContentFormattingFactory
     */
    private $formatter = null;

    private $reset_value = null;

    /**
     * Constructs a rich text edit field.
     * In addition to the parameters of the FormMultiLineEdit ones, there is the formatter which
     * is an instance of the ContentFormattingFactory which ensures the formatting. The default value
     * corresponds to the user's default configuration and will be the one to use 99% of the time.
     * @param string $id Field id
     * @param string $label Field label
     * @param string $value Default value
     * @param string[] $field_options options
     * @param FormFieldConstraint[] $constraints The constraints
     */
    public function __construct($id, $label, $value, array $field_options = array(), array $constraints = array())
    {
        $this->formatter = AppContext::get_content_formatting_service()->get_default_factory();
        parent::__construct($id, $label, '', $field_options, $constraints);

        $this->set_value($value);
    }

    /**
     * @return string The html code for the textarea.
     */
    public function display()
    {
        $template = parent::display();

        $this->assign_editor($template);

        return $template;
    }

    private function assign_editor(Template $template)
    {
        $editor = $this->formatter->get_editor();
        $editor->set_identifier($this->get_html_id());

        $template->put_all(array(
            'C_EDITOR_ENABLED' => true,
            'C_RESET_BUTTON_ENABLED' => $this->reset_value !== null,
            'EDITOR' => $editor->display(),
            'EDITOR_NAME' => TextHelper::strtolower($this->formatter->get_name()),
            'VALUE' => $this->get_raw_value(),
            'PREVIEW_BUTTON' => $this->get_preview_button_code(),
            'RESET_BUTTON' => $this->get_reset_button_code()
        ));
    }

    private function get_preview_button_code()
    {
        $template = new FileTemplate('framework/builder/form/button/FormButtonPreview.tpl');

        $template->put('HTML_ID', $this->get_html_id());

        return $template->render();
    }

    private function get_reset_button_code()
    {
        $template = new FileTemplate('framework/builder/form/button/FormButtonReset.tpl');

        $template->put_all(array(
            'C_ONCLICK_FUNCTION' => true,
            'HTML_ID' => $this->get_html_id(),
            'CLASS' => 'small',
            'L_RESET' => LangLoader::get_message('reset', 'main'),
            'ONCLICK_ACTIONS' => (AppContext::get_current_user()->get_editor() == 'TinyMCE' ? 'setTinyMceContent(' . TextHelper::to_js_string($this->unparse_value($this->reset_value)) . ');' :
                'HTMLForms.getField("' . $this->get_id() . '").setValue(' . TextHelper::to_js_string($this->unparse_value($this->reset_value)) . ');')
        ));

        return $template->render();
    }

    /**
     * {@inheritdoc}
     */
    public function get_value()
    {
        return $this->parse_value($this->get_raw_value());
    }

    private function parse_value($value)
    {
        $parser = $this->formatter->get_parser();
        $parser->set_content($value);
        $parser->parse();
        return $parser->get_content();
    }

    private function get_raw_value()
    {
        return parent::get_value();
    }

    /**
     * {@inheritdoc}
     */
    public function set_value($value)
    {
        $this->set_raw_value($this->unparse_value($value));
    }

    private function set_raw_value($value)
    {
        parent::set_value($value);
    }

    private function unparse_value($value)
    {
        $unparser = $this->formatter->get_unparser();
        $unparser->set_content($value);
        $unparser->parse();
        return $unparser->get_content();
    }

    public function get_onblur_validations()
    {
        return parent::get_onblur_validations();
    }

    /**
     * {@inheritdoc}
     */
    public function retrieve_value()
    {
        $request = AppContext::get_request();
        if ($request->has_parameter($this->get_html_id()))
        {
            $this->set_raw_value($request->get_string($this->get_html_id()));
        }
    }

    protected function compute_options(array &$field_options)
    {
        foreach($field_options as $attribute => $value)
        {
            $attribute = TextHelper::strtolower($attribute);
            switch ($attribute)
            {
                case 'formatter':
                    if ($value instanceof ContentFormattingExtensionPoint)
                    {
                        $this->formatter = $value;
                        unset($field_options['formatter']);
                    }
                    else
                    {
                        throw new FormBuilderException('The value associated to the formatter attribute must be an instance of the ContentFormattingFactory class');
                    }
                    break;
                case 'reset_value':
                    $this->reset_value = $value;
                    unset($field_options['reset_value']);
                    break;
            }
        }
        parent::compute_options($field_options);
    }
}
?>