mattgogerly/tinymce-bundle

这是stfalcon/TinyMCE Bundle的分支，使用了更新版本的TinyMCE

维护者

详细信息

github.com/mattgogerly/TinymceBundle

源代码

问题

安装: 3

依赖: 0

建议: 0

安全: 0

星级: 0

关注者: 1

分支: 154

开放问题: 0

类型:symfony-bundle

v3.0.1 2022-11-09 19:48 UTC

Requires

MIT 944c003ae3e21cf0a9e56c5ba8bd85cbac2f1f17

Symfony2bundlewysiwygtinymceeditor

This package is auto-updated.

Last update: 2024-09-09 23:50:09 UTC

README

📦 此扩展包可以让您非常容易地将TinyMCE WYSIWYG编辑器添加到您的Symfony2项目中。

安装

选择适当的版本

注意！为了升级您的配置，请阅读UPGRADE.md

通过composer将TinyMCE扩展包作为您应用程序的依赖项添加

$ php composer.phar require stfalcon/tinymce-bundle='X.Y'

将StfalconTinymceBundle添加到您的应用程序内核中。

// app/AppKernel.php
<?php
    // ...
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Stfalcon\Bundle\TinymceBundle\StfalconTinymceBundle(),
        );
    }

此扩展包需要将必要的资源复制到web文件夹。您可以使用以下命令

$ php app/console assets:install web/

包含在模板中

此扩展包附带了一个用于Twig的扩展。这使得将TinyMCE Javascript包含到您的页面中变得非常简单。将以下标签添加到您希望使用TinyMCE的位置。它将输出完整的Javascript，包括<script>标签。将其添加到页面底部以优化性能。

    {{ tinymce_init() }}

您还可以通过传递如下选项来覆盖默认配置

    {{ tinymce_init({'use_callback_tinymce_init': true, 'theme': {'simple': {'menubar': false}}}) }}

或

    {{ tinymce_init({
        theme: {'simple':{'language': app.request.locale, 'height': 500 }},
        toolbar: "insertfile undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image",
        autosave_ask_before_unload: false,
        asset_package_name: 'backend'})
    }}

NEW ! 新增指定资产包文档以生成正确的js链接，见上文，参数：asset_package_name

基本配置

默认情况下，tinymce对所有页面上的文本区域都启用。如果您想自定义它，请按照以下操作

将类"tinymce"添加到文本区域字段以初始化TinyMCE。

    <textarea class="tinymce"></textarea>

如果您想使用编辑器的jQuery版本，设置以下参数

    stfalcon_tinymce:
        include_jquery: true
        tinymce_jquery: true
        ...

选项include_jquery允许您从Google CDN加载外部jQuery库。如果您尚未在页面上包含jQuery，请将其设置为true。

如果您正在使用FormBuilder，请使用数组添加类，您还可以使用theme选项将使用的主题更改为除'simple'之外的其他主题（即您的配置中定义的其他主题之一 - 上面的示例定义了'bbcode'）。例如：

<?php
    $builder->add('introtext', 'textarea', array(
        'attr' => array(
            'class' => 'tinymce',
            'data-theme' => 'bbcode' // Skip it if you want to use default theme
        )
    ));

本地化

您可以通过将语言选择器添加到配置的顶层来更改TinyMCE编辑器的语言

    // app/config/config.yml
    stfalcon_tinymce:
        include_jquery: true
        tinymce_jquery: true
        selector: ".tinymce"
        language: %locale%
        theme:
            simple:
                theme: "modern"
        ...

注意！由于无法为每个编辑器实例设置自定义语言，此选项将设置所有实例的语言。

在示例中，我们设置了从参数.ini文件中获取的默认语言。当然，您可以通过传递语言代码（例如ru或ru_RU，en或en_US）来设置默认语言。

如果未设置语言参数，默认语言将从会话中获取。

多选择器

您可以为编辑器的放置指定一个或多个选择器。

    // app/config/config.yml
    stfalcon_tinymce:
        selector: ".tinymce"

或

    // app/config/config.yml
    stfalcon_tinymce:
        selector: 
            - ".tinymce"
            - "#tinymce"

或

    // app/config/config.yml
    stfalcon_tinymce:
        selector: [".tinymce", "#tinymce"]

自定义配置

根据TinyMCE文档，您可以根据自己的意愿配置您的编辑器。以下是您可以自行配置的几乎完整的参数列表

    // app/config/config.yml
    stfalcon_tinymce:
        include_jquery: true
        tinymce_jquery: true
        selector:
            - ".tinymce"
            - "#editor1"
            - "#editor2"
        base_url: "http://yourdomain.com/" # this parameter may be included if you need to override the assets_base_urls for your template engine (to override a CDN base url)
        # Get current language from the parameters.ini
        language: %locale%
        # Custom buttons
        tinymce_buttons:
            stfalcon: # Id of the first button
                title: "Stfalcon"
                image: "http://stfalcon.com/favicon.ico"
        theme:
            # Simple theme: same as default theme
            simple: ~
            # Advanced theme with almost all enabled plugins
            advanced:
                 plugins:
                     - "advlist autolink lists link image charmap print preview hr anchor pagebreak"
                     - "searchreplace wordcount visualblocks visualchars code fullscreen"
                     - "insertdatetime media nonbreaking save table contextmenu directionality"
                     - "emoticons template paste textcolor"
                 toolbar1: "insertfile undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image"
                 toolbar2: "print preview media | forecolor backcolor emoticons | stfalcon | example"
                 image_advtab: true
                 templates:
                     - {title: 'Test template 1', content: 'Test 1'}
                     - {title: 'Test template 2', content: 'Test 2'}
            # BBCode tag compatible theme (see http://www.bbcode.org/reference.php)
            bbcode:
                 plugins: ["bbcode, code, link, preview"]
                 menubar: false
                 toolbar1: "bold,italic,underline,undo,redo,link,unlink,removeformat,cleanup,code,preview"

外部插件支持

如果您想加载一些位于您扩展包中的外部插件，您应按以下示例进行配置

    stfalcon_tinymce:
        external_plugins:
            filemanager:
                url: "asset[bundles/acmedemo/js/tinymce-plugin/filemanager/editor_plugin.js]"
            imagemanager:
                url: "asset[bundles/acmedemo/js/tinymce-plugin/imagemanager/editor_plugin.js]"
        ...
        theme:
            simple:
                theme: "modern"
                ...

自定义按钮

您可以为编辑器工具栏添加一些自定义按钮（参见：http://www.tinymce.com/tryit/button.php，http://www.tinymce.com/wiki.php/api4:method.tinymce.Editor.addButton）

首先，您应该在您的配置中描述它

    stfalcon_tinymce:
        tinymce_buttons:
            stfalcon: # Id of the first button
                title: "Stfalcon"
                image: "http://stfalcon.com/favicon.ico"
            hello_world: # Id of the second button
                title: "Google"
                image: "http://google.com/favicon.ico"
                ...
                or for the local images
                ...
                image: "asset[bundles/somebundle/images/icon.ico]"

        theme:
            simple:
                     ...
                 toolbar1: "insertfile undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image"
                 toolbar2: "print preview media | forecolor backcolor emoticons | stfalcon | hello_world"

然后，您应该根据按钮的ID创建一个名为tinymce_button_的回调函数，用于您的按钮

function tinymce_button_stfalcon(ed) {
    ed.focus();
    ed.selection.setContent("Hello from stfalcon.com :)");
}

function tinymce_button_hello_world(ed) {
    ed.focus();
    ed.selection.setContent("Hello world!");
}

自定义CSS

此选项允许您指定一个自定义CSS文件，以扩展主题内容的CSS。此CSS文件是在编辑器内使用的（可编辑区域）。此选项也可以是一个以逗号分隔的URL列表。

如果您指定了一个相对路径，它将相对于包含TinyMCE的（HTML）文件的URL进行解析，而不是相对于TinyMCE本身。

    stfalcon_tinymce:
        ...
        theme:
            simple:
                content_css: "asset[bundles/mybundle/css/tinymce-content.css]"
                ...

注意！请阅读官方TinyMCE文档以获取更多详细信息：http://www.tinymce.com/wiki.php/Configuration:content_css

初始化事件

在Tinymce中，您也可以像在jQuery中的$(document).ready()一样监听init事件。

要这样做，您必须编辑您的配置并将use_callback_tinymce_init设置为true。

app/config/config.yml:

    stfalcon_tinymce:
        ...
        use_callback_tinymce_init: true
        ...

然后创建一个名为callback_tinymce_init的javascript回调函数，如下所示

function callback_tinymce_init(editor) {
    // execute your best script ever
}

如何为动态加载的元素初始化TinyMCE

为了初始化TinyMCE为新加载的textarea，您只需调用initTinyMCE()函数。

Sonata Admin Bundle的示例

    jQuery(document).ready(function() {
        $('form').on('sonata.add_element', function(){
            initTinyMCE();
        });
    });