Examples.md

How to use the helper

Load it in the controller where you want to use it.

public $helpers = ['TinyMCE.TinyMCE'];

At the view's top where you want to use it, simply add the editor() method and pass config key/value pairs in an array.

$this->TinyMCE->editor(['theme' => 'modern', 'selector' => 'textarea']);

This will instruct TinyMCE to convert all textarea elements on the page to TinyMCE editors. If you require some more precise control, or want to change this behavior, checkout the TinyMCE configuration options on the TinyMCE website.

You need to add the jQuery file to make it work the helper.

echo $this->Html->script('jquery-x.x.x.min');

Multiple configurations

The helper has a configs property which can be filled with data from database or a config file. How you store, get and pass that data to the helper is up to you. The configs property of the helper takes an array with named keys where the keys are used to load the configs.

Here is a basic example of configuration data:

$configs = [
	'modern' => [
		'selector' => 'textarea',
		'theme' => 'modern'
	],
	'withoutPath' => [
	    'selector' => 'textarea',
	    'theme' => 'modern',
	    'elementpath' => false
	]
];
$this->TinyMCE->configs = $configs;

You can also put the configuration in APP/config/bootstrap.php or another config file and load it. Inside the config file you have you can write the config as above to the TinyMce configuration:

Configure::write('TinyMCE.configs', [
	'modern' => ...,
	'withoutPath' => ...]);

The different sets of configuration data will be auto loaded by the helper inside its constructor. It is suggested that you use this way of passing different configs to the helper because by this you'll be able to store all of them in one place.

When you passed the configuration to the helper you can simply use it by calling the editor() method of the helper with a string that is equal to the key of the configuration in the array:

$this->TinyMCE->editor('modern'); // This matches the 'modern' config name we passed in earlier.

Application wide default options

If you want a quick way to configure default values for all the TinyMCE Editors of an application, you could use the 'TinyMCE.editorOptions' configuration.

Here is an example of a line you could have in bootstrap.php:

Configure::write('TinyMCE.editorOptions', ['height' => '300px'])

It will make all editors to have a 300px height. You may want to override this value for a single editor. To do so, just pass the option to the editor() method and it will override the default value.

You can always check the tests to see how to use the helper.