Codex.Editor server validation sample

This library allows you to use Codex.Editor server validation. You can easily make your client plugins for Codex Editor and then extend server Tool which will be able to clean dirty data or handle that.

Installation

To install lib use composer:

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

Guide

Add this line at the top of your PHP script

use \CodexEditor\CodexEditor;

this line allows you to get editors class that has the following method:

getBlocks - return array of sanitized blocks

Basic usage

You can get data from editor and send as param to editor's server validator like

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

CodexEditor constructor has the following arguments:

$data — JSON string with data from CodeX Editor frontend.

$configuration — JSON string with CodeX Editor tools configuration (see an example in the following paragraph).

Configuration file

You can configure validation rules for different types of CodeX Editor tools (header, paragraph, list, quote and other).

Sample validation rule set:

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

Where:

tools — array of supported CodeX Editor tools.

header — defines header tool settings.

text and level — parameters in header tool structure.

text is a required string, which will be sanitized except b, i and a[href] tags.

level is an optional integer that can be only 0, 1 or 2.

allowedTags param should follow HTMLPurifier format.

Another configuration example: /tests/samples/test-config.json

Make Tools

If you connect a new Tool on the frontend-side, then you should create a configuration rule for that Tool to validate it on server-side.

Repository

https://github.com/codex-team/codex.editor.backend/

About CodeX

We are small team of Web-developing fans consisting of IFMO students and graduates located in St. Petersburg, Russia. Feel free to give us a feedback on team@ifmo.su