README

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

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

关于

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

安装

要使用Froala WYSIWYG编辑器，您需要克隆git仓库

git clone git://github.com/froala/wysiwyg-cake.git Plugin/Froala

或者，如果您的CakePHP应用程序已设置为git仓库，您可以将其添加为子模块

git submodule add git://github.com/froala/wysiwyg-cake.git Plugin/Froala

或者打开终端/命令提示符（Windows）并输入composer require froala/wysiwyg-cake

或者，您可以从Github的master分支下载存档，并将其内容提取到Froala插件。

请确保通过在配置文件夹中的引导文件(bootstrap.php)中添加来加载插件路由

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));?>

如何使用助手

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

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

打开AppController.php（您的项目/src/controller/AppController），声明变量public $helpers = array('Froala.Froala');

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

在视图页面（模板）中添加

<?= $this->Froala->editor('#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+

许可

CakePHP Froala WYSIWYG Editor项目采用MIT许可。然而，为了使用WordPress Froala WYSIWYG Editor插件，您应该购买它的许可证。

福来拉编辑器为商业使用提供了3种不同的许可协议。有关详细信息，请参阅许可协议。