README

Editor.js的服务端实现示例。它包含数据验证、HTML清理以及将Editor.js的输出转换为Block对象。

安装

使用composer安装库

composer require codex-team/editor.js:dev-master

指南

在PHP脚本顶部添加此行

use \EditorJS\EditorJS;

此行允许你获取具有以下方法的编辑器类：

getBlocks - 返回已清理的块数组

基本用法

你可以从编辑器获取数据并将其作为参数发送到编辑器的服务器验证器，例如

try {
    // Initialize Editor backend and validate structure
    $editor = new EditorJS( $data, $configuration );
    
    // Get sanitized blocks (according to the rules from configuration)
    $blocks = $editor->getBlocks();
    
} catch (\EditorJSException $e) {
    // process exception
}

Editor.js构造函数有以下参数

$data — 来自CodeX编辑器前端的前端JSON字符串。

$configuration — 来自CodeX编辑器工具配置的JSON字符串（参见下一段示例）。

配置文件

你可以手动配置不同类型Editor.js工具（标题、段落、列表、引言和其他）的验证规则。你还可以通过新工具扩展配置。

示例验证规则集

{
  "tools": {
    "header": {
      "text": {
        "type": "string",
        "required": true,
        "allowedTags": "b,i,a[href]"
      },
      "level": {
        "type": "int",
        "canBeOnly": [2, 3, 4]
      }
    }
  }
}

其中

tools — 支持的Editor.js工具数组。

header — 定义header工具设置。

text和level — header工具结构中的参数。

text是一个必需的 字符串，它将被清理，除了b、i和a[href]标签。

level是一个可选的 整数，只能为0、1或2。

allowedTags参数应遵循HTMLPurifier格式。

每个块有三个常见的参数

type（《必需的》）— 块类型

allowedTags（《可选的》）— 不会删除的字符串中的HTML标签

其他值可以按照HTMLPurifier格式使用。

示例

"paragraph": {
    "text": {
        "type": "string",
        "allowedTags": "i,b,u,a[href]"
    }
}

canBeOnly（《可选的》）— 定义允许值的集合

示例

"quote": {
      "text": {
        "type": "string"
      },
      "caption": {
        "type": "string"
      },
      "alignment": {
        "type": "string",
        "canBeOnly": ["left", "center"]
      }
    }

简写设置语法

添加了一些语法糖。

工具设置可以是string。它定义了具有默认设置的工具体型。

"header": {
  "text": "string",
  "level": "int"
}

它评估为

"header": {
  "text": {
    "type": "string",
    "allowedTags": "",
    "required": true
  },
  "level": {
    "type": "int",
    "allowedTags": "",
    "required": true
  }
}

工具设置可以是array。它定义了一组未经清理的允许值。

"quote": {
  "alignment": ["left", "center"],
  "caption": "string"
}

它评估为

"quote": {
  "alignment": {
    "type": "string",
    "canBeOnly": ["left", "center"]
  },
  "caption": {
      "type": "string",
      "allowedTags": "",
      "required": true
    }
}

另一个配置示例：/tests/samples/syntax-sugar.json

嵌套工具

工具可以包含嵌套值。这是使用array类型实现的。

假设JSON输入如下

{
    "blocks": [
        "type": list,
        "data": {
            "items": [
                "first", "second", "third"
            ],
            "style": {
                "background-color": "red",
                "font-color": "black"
            }
        }
    ]
}

我们可以在配置中为该输入定义验证规则

"list": {
  "items": {
    "type": "array",
    "data": {
      "-": {
        "type": "string",
        "allowedTags": "i,b,u"
      }
    }
  },
  "style": {
      "type": "array",
      "data": {
        "background-color": {
            "type": "string",
            "canBeOnly": ["red", "blue", "green"]
        },
        "font-color": {
            "type": "string",
            "canBeOnly": ["black", "white"]
        }
      }
  }
}

其中data是数组值的容器，而-是数组的特殊快捷方式，如果数组是顺序的。

另一个配置示例：/tests/samples/test-config.json

异常

EditorJS类

BlockHandler类

ConfigLoader类

制作工具

如果你在客户端连接了新的工具，那么你应该为该工具创建一个配置规则，以便在服务器端对其进行验证。

仓库

https://github.com/codex-editor/editorjs-php/

关于CodeX

我们是一支由圣彼得堡俄罗斯国立信息技术、机械与光学大学（IFMO）的学生和毕业生组成的小型网页开发爱好者团队。欢迎您给我们发送反馈至 team@ifmo.su

codex-team / codex.editor

维护者

详情