mica-project/editorjs-extendable-parser

An extendable server-side bidirectional parser for EditorJS structures

1.0 2025-01-20 11:05 UTC

Requires

• php: ^8.3
• ext-dom: *
• ext-json: *
• ext-libxml: *
• ext-mbstring: *
• masterminds/html5: ^2.7@dev

Requires (Dev)

• phpunit/phpunit: ^11

MIT

README

Extendable PHP Parser for Editor.js

Project is heavily based on Edd-G/editorjs-simple-html-parser and Durlecode/editorjs-simple-html-parser work. Kudos to these guys!

Parse data for Editor.js with 2 way:

1. Parse JSON data to HTML
2. Parse HTML to JSON data

Supported Tools

Installation

composer require mica-project/editorjs-extendable-parser

1. JSON to HTML Parser

Usage

use MicaProject\EJSParser\Parser;

$html = Parser::parse($data)->toHtml();

Where $data is the clean JSON data coming from Editor.js See $data example below

{
    "time" : 1583848289745,
    "blocks" : [
        {
            "type" : "header",
            "data" : {
                "text" : "Hello World",
                "level" : 2
            }
        }
    ],
    "version" : "2.16.1"
}

By default this will generate html with css classes with prs prefix, so if you want to change it, follow example below

use MicaProject\EJSParser\Parser;

$parser = new Parser($data);

$parser->setPrefix("cat");

$parsed = $parser->toHtml();

Methods

toHtml()

Return generated HTML

setPrefix(string $prefix)

Set CSS classes Prefix

getPrefix()

Return current prefix

getVersion()

Return Editor.js content version

getTime()

Return Editor.js content timestamp

getBlocks()

Return Editor.js content blocks

Generated HTML

Header

<h2 class="prs-header prs_center">Lorem</h2>

Paragraph

<p class="prs-paragraph prs_center">
    <code class="inline-code">Pellentesque</code> 
    <i>malesuada fames</i> 
    <mark class="cdx-marker">tempus</mark>
</p>

Ordered List

<ol class="prs-list prs_ordered">
    <li></li>
</ol>

Unordered List

<ul class="prs-list">
    <li></li>
</ul>

Table

<table class="prs-table prs_withheadings">
    <thead>
        <tr>
            <th>1</th><th>2</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>a</td><td>b</td>
        </tr>
    </tbody>
</table>

Code

<pre class="prs-code">
    <code></code>
</pre>

Embed

(Actually working with Youtube, Codepen & Gfycat)

<figure class="prs-embed prs_youtube">
    <iframe width="580" height="320" src="https://www.youtube.com/embed/CwXOrWvPBPk" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen="1"></iframe>
    <figcaption>Shrek (2001) Trailer</figcaption>
</figure>

Delimiter

<hr class="prs-delimiter">

Link

<figure class="prs-link">
    <a href="https://github.com/" target="_blank">
       <img src="https://example.com/cat.png" alt="">
       <p class="prs_title">Title</p>
       <p class="prs_description">Description</p>
       <p class="prs_sitename">example.com</p>
    </a>
</figure>

Image

<figure class="prs-image prs_withborder prs_withbackground prs_stretched">
    <img src="" alt="">
    <figcaption></figcaption>
</figure>

##### SimpleImage

```html
<figure class="prs-simpleimage prs_withborder prs_withbackground prs_stretched">
    <img src="" alt="">
    <figcaption></figcaption>
</figure>

Quote

<figure class="prs-quote prs_center">
    <blockquote></blockquote>
    <figcaption></figcaption>
</figure>

Warning

<div class="prs-warning">
    <i></i>
    <h4>Title</h4>
    <p>Message</p>
</div>

Alert

<p class="prs-alert prs_center prs_success">
    Alert!
</p>

Raw

<div class="prs-raw">
    Raw HTML ...
</div>

2. HTML to JSON Parser

Usage

use MicaProject\EJSParser\HtmlParser;

$parser = new HtmlParser($html);

$blocks = $parser->toBlocks();

header("Content-Type: application/json");
echo $blocks;

Where $html is the HTML specially tagged with CSS classes See examples of the generated HTML code above

By default this will parse html with css classes with prs prefix, so if you want to change it, follow example below

use MicaProject\EJSParser\HtmlParser;

$parser = new HtmlParser($html);

$parser->setPrefix("cat");

$blocks = $parser->toBlocks();

You may set time and version EditorJS generated blocks By default: time generate auto, EditorJS version pass from config.php:

use MicaProject\EJSParser\HtmlParser;

$parser = new HtmlParser($html);

$parser->setTime("1703787424242");
$parser->setVersion("2.28.8");

$blocks = $parser->toBlocks();

Methods

toBlocks()

Return generated EditorJS Blocks

setPrefix(string $prefix)

Set CSS classes Prefix

getPrefix()

Return current prefix

setVersion(string $version)

Set Editor.js content version

getVersion()

Return Editor.js content version

getTime()

Return Editor.js content timestamp

setTime(string $time)

Set Editor.js content timestamp