yfix.net
  1. API
  2. form2
  3. yf_form2_ckeditor

yf_form2_ckeditor class

Fileplugins/form2/classes/form2/yf_form2_ckeditor.class.php
Use_class('form2_ckeditor', 'classes/form2/')

Public properties

PropertyDefaultDescription
None declared in this class.

Public methods 1

None without a leading underscore.

Methods starting with _ hooks and helpers; not routable as page actions

_ckeditor_html

public function _ckeditor_html($extra = [], $replace = [], $form = null)

Embedding ckeditor (http://ckeditor.com/) with kcfinder (http://kcfinder.sunhater.com/). You can include it into project like this:.

git submodule add https://github.com/yfix/ckeditor-releases.git www/ckeditor/ && cd www/ckeditor/ && git checkout latest/full
git submodule add https://github.com/yfix/kcfinder.git www/kcfinder

'www/' usually means PROJECT_PATH inside project working copy.
P.S. You can use free CDN for ckeditor as alternate solution.

    public function _ckeditor_html($extra = [], $replace = [], $form = null)
    {
        $content_id = $body = null;
        if ( ! is_array($extra)) {
            return '';
        }
        $params = $extra['ckeditor'];
        if ( ! is_array($params)) {
            $params = [];
        }
        js('ckeditor');
        // Theme-wide ckeditor config inside stpl (so any engine vars can be processed or included there)
        $stpl_name = 'ckeditor_config'; // Example filesystem location: PROJECT_PATH.'templates/admin/ckeditor_config.stpl'
        if ( ! isset($replace['content_id'])) {
            $replace['content_id'] = $content_id;
        }
        $content_id = $extra['id'] ? $extra['id'] : 'content_editable';
        $hidden_id = $params['hidden_id'] ? $params['hidden_id'] : '';
        if (isset($params['config'])) {
            if (is_array($params['config'])) {
                $config_js = '
					try {
						CKEDITOR.' . ($hidden_id ? 'inline' : 'replace') . '("' . $content_id . '", ' . json_encode($params['config']) . ');
					} catch (e) {
						console.error("ckeditor init failed:", e);
					}
				';
            } elseif (is_callable($params['config'])) {
                $func = $params['config'];
                $config_js = $func($extra, $replace, $form);
            } else {
                $config_js = $params['config'];
            }
        } else {
            $config_js = tpl()->_stpl_exists($stpl_name) ? tpl()->parse($stpl_name, (array) $extra + (array) $replace) : '';
        }
        if (strlen($config_js)) {
            js($config_js);
        }
        if (strlen($hidden_id) && strlen($content_id)) {
            jquery('
				var _content_id = "#' . $content_id . '";
				var _hidden_id = "#' . $hidden_id . '";
				$(_content_id).parents("form").submit(function(){
					$("input[type=hidden]" + _hidden_id).val( $(_content_id).html() );
				})
			');
        }
        return null;
    }