README

CakePHP插件，用于Froala JavaScript WYSIWYG文本编辑器。适用于cake 2.3+

关于

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

安装

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

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

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

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

或者，您可以从Github上的master分支下载存档，并将其内容解压缩到Plugin/Froala。

添加

     "froala/wysiwyg-cake2": "^2.9"

到您的composer.json文件的require部分。

或使用composer

php ./composer.phar require froala/wysiwyg-cake2

然后，将FroalaEditor文件夹从/Plugins移动到app/Plugin，并将其重命名为Froala，或直接从git仓库克隆文件夹到app/Plugin。

使用方法

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

您可以使用两种方式使用此插件：简单地使用助手或手动加载编辑器

$this->Html->css('/Froala/css/froala_editor.min.css');
$this->Html->script('/Froala/js/froala_editor.min.js', array('toolbarInline' => false));

并将您自己的脚本放置在页面头部。请注意，助手会自动将Froala编辑器脚本添加到页面头部。如果您使用助手，则无需手动执行此操作。

如果您的应用程序不是设置为在主机/的最高级别工作，而是在/yourapp/中，则自动包含脚本将不会工作。您将手动将js文件添加到应用程序中

$this->Html->css('/yourapp/Froala/css/froala_editor.min.css');
$this->Html->script('/yourapp/Froala/js/froala_editor.min.js', array('toolbarInline' => false));

如果您需要加载插件，则使用

$this->Html->script(
  array(
    '/Froala/js/froala_editor.min.js',
    '/Froala/js/plugins/align.min.js',
    '/Froala/js/plugins/char_counter.min.js',
    '/Froala/js/plugins/code_beautifier.min.js',
    '/Froala/js/plugins/code_view.min.js',
    '/Froala/js/plugins/colors.min.js',
    '/Froala/js/plugins/draggable.min.js',
    '/Froala/js/plugins/emoticons.min.js',
    '/Froala/js/plugins/entities.min.js',
    '/Froala/js/plugins/file.min.js',
    '/Froala/js/plugins/font_family.min.js',
    '/Froala/js/plugins/font_size.min.js',
    '/Froala/js/plugins/fullscreen.min.js',
    '/Froala/js/plugins/help.min.js',
	'/Froala/js/plugins/image.min.js',
    '/Froala/js/plugins/image_manager.min.js',
    '/Froala/js/plugins/inline_style.min.js',
    '/Froala/js/plugins/line_breaker.min.js',
    '/Froala/js/plugins/link.min.js',
    '/Froala/js/plugins/lists.min.js',
    '/Froala/js/plugins/paragraph_format.min.js',
    '/Froala/js/plugins/paragraph_style.min.js',
    '/Froala/js/plugins/print.min.js',
    '/Froala/js/plugins/quick_insert.min.js',
    '/Froala/js/plugins/quote.min.js',
    '/Froala/js/plugins/save.min.js',
    '/Froala/js/plugins/special_characters.min.js',
    '/Froala/js/plugins/table.min.js',
    '/Froala/js/plugins/url.min.js',
    '/Froala/js/plugins/video.min.js'),

  array('toolbarInline' => false)
);


$this->Html->css(
  array(
    '/Froala/css/froala_editor.min.css',
    '/Froala/css/froala_style.min.css',
    '/Froala/css/plugins/char_counter.min.css',
    '/Froala/css/plugins/code_view.min.css',
    '/Froala/css/plugins/colors.min.css',
    '/Froala/css/plugins/draggable.min.css',
    '/Froala/css/plugins/emoticons.min.css',
    '/Froala/css/plugins/file.min.css',
    '/Froala/css/plugins/fullscreen.min.css',
    '/Froala/css/plugins/help.min.css',
    '/Froala/css/plugins/image_manager.min.css',
    '/Froala/css/plugins/image.min.css',
    '/Froala/css/plugins/line_breaker.min.css',
    '/Froala/css/plugins/quick_insert.min.css',
    '/Froala/css/plugins/special_characters.min.css',
    '/Froala/css/plugins/table.min.css',
    '/Froala/css/plugins/video.min.css'
  )
);

如何使用助手

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

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

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

在视图中，只需使用editor()方法，并传递一个包含键/值对的数组作为选项。

<div class="selector">
  <?= $this->Froala->editor('.selector');?>
</div>

这将指示Froala将页面上的所有匹配元素转换为Froala编辑器。如果您需要更精确的控制，或想更改此行为，请查看Froala网站上的Froala配置选项。

默认选项

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

这里是一个可以在bootstrap.php中找到的示例行

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

它将使所有编辑器的高度为300px。您可能想为单个编辑器覆盖此值。要这样做，只需将选项传递给editor()方法，它将覆盖默认值。

您还可以在初始化编辑器时传递选项，如下所示

$this->Froala->editor('.selector', array('option' => value));

您始终可以查看测试以了解如何使用助手。

要求

• PHP版本：PHP 5.2+
• CakePHP版本：CakePHP 2.1+

许可证

wysiwyg-cake 项目遵循 MIT 许可协议。然而，为了使用 Froala WYSIWYG HTML 编辑器插件，您需要为其购买许可证。

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