README

CakePHP插件，用于Froala Javascript WYSIWYG文本编辑器。适用于CakePHP >= 3.0。

有关CakePHP 2.x版本的详细信息，请参阅froala/wysiwyg-cake2。

关于

将Froala WYSIWYG编辑器放在插件中的目的是将其与主题视图、常规webroot或应用程序本身分离，这使得更新更方便，总体上遵循保持代码清洁和模块化的理念。

安装

composer require todi1979/cakephp3-froalaeditor

确保您通过添加到您的引导文件中加载插件路由

Plugin::loadAll(); 或 Plugin::load('Froala'); 这将一次性加载所有插件或仅加载Froala插件。

用法

Froala辅助器基本上是一个便利辅助器，允许您使用php和CakePHP约定来生成Froala的配置，并且作为一个额外的功能，它还允许您加载配置。

// Loads Froala Editor javascript also will load all the plugins and css for the plugins
<?= $this->Froala->plugin();?>

// Will target one specific html selector on which the editor will be init.
// Second paramenter is mix can be array/object of options that the Froala Editor will take.

<?= $this->Froala->editor('#froala', array('option' => value));?>

如果您的应用程序未设置在主机/的顶级，而是在/yourapp/中工作，则自动包含脚本将不起作用。您将必须手动将js文件添加到辅助类中的应用程序。

$this->Html->css('/yourapp/Froala/css/froala_editor.min.css');
$this->Html->script('/yourapp/Froala/js/froala_editor.min.js');

如何使用辅助器

从CakePHP 3.0开始，在您的应用程序中激活插件是必要的。要这样做，编辑 app/Config/bootstrap.php 并在底部添加一行 CakePlugin::load('Froala');。如果您已经有 CakePlugin::loadAll(); 用于自动加载所有插件，则可以跳过此步骤。

在任何您想要使用它的地方，在控制器中加载它

class AppController extends Controller
{
	...
	
	public $helpers = array('Froala.Froala');
	
	...
}

在视图中，只需使用插件()方法即可加载所有依赖项，并使用editor()方法，您可以将选项作为键/值对传递到数组或对象中。

这是一个没有Froala编辑器选项的简单初始化示例。请在示例中查看更多特定的初始化方法。

$this->Froala->plugin();
$this->Froala->editor('selector');

这将指示Froala将页面上的匹配元素转换为Froala编辑器。

Froala配置选项的完整列表在此网站上。

默认选项

如果您想快速为应用程序中所有Froala编辑器的默认值进行配置，可以使用 'Froala.editorOptions' 配置。

以下是在 bootstrap.php 中可以包含的一行示例

Configure::write('Froala.editorOptions', array('height' => '300px'));

它将使所有编辑器的高度为300px并应用换行标签。您可能需要为单个编辑器覆盖此值。为此，只需将选项传递给editor()方法，它将覆盖默认值。

用法示例

使用选项数组的初始化示例

// '#comment'  Represents the html element selector.
// 'array()'   Represents the list of options that are passed to the editor.

$this->Froala->editor('#comment', array('minHeight => '200px', 'maxHeight' => '400px'));
                  

要求

• PHP版本：PHP 5.2+
• jQuery JavaScript库 https://jqueryjs.cn/

依赖注意事项

此插件依赖于jQuery (https://jqueryjs.cn)，因此您需要确保它在您要显示编辑器的布局或视图中已加载。以下是如何在布局中加载jQuery的示例

<?= $this->Html->script(array('https://code.jqueryjs.cn/jquery-1.11.0.min.js')); ?>

<?= $this->fetch('script'); ?>

当然，您也可以从您的app/webroot/js文件夹中复制一份jQuery库。

许可证

《CakePHP Froala WYSIWYG 编辑器》项目遵循MIT许可证。然而，为了使用WordPress Froala WYSIWYG 编辑器插件，您应该为其购买许可证。

Froala 编辑器为商业用途提供了3种不同的许可证。详情请见许可协议。