Storing content
Last updated:
On this page
Content is TipTap/ProseMirror JSON: a doc node whose content is the list of blocks. Store it in a json (or text) column:
Schema::create('posts', function (Blueprint $table) {
$table->id();
$table->string('title');
$table->json('body')->nullable();
$table->timestamps();
});
The cast
use Javaabu\BlockEditor\Casts\AsBlockDocument;
class Post extends Model
{
protected function casts(): array
{
return [
'body' => AsBlockDocument::class,
'summary' => AsBlockDocument::class . ':minimal', // sanitized for the "minimal" profile
];
}
}
Document::class works as a cast too (Document::class . ':minimal').
- Setting accepts a
Document, an array, a JSON string (what the editor posts) ornull. The value is sanitized for the cast's profile before it's stored, unlessblock-editor.sanitize.on_saveisfalse. - Getting returns a
Javaabu\BlockEditor\Document. Anullcolumn reads as an empty document, so$post->body->isEmpty()always works. - Serializing (
toArray(), JSON responses, Inertia props) gives the JSON array, ready for<BlockContent>and the React editor.
$post->update(['body' => $request->input('body')]); // the JSON string from the form
Documents
use Javaabu\BlockEditor\Document;
$document = Document::make($json); // Document, Node, array, JSON string or null
$document = Document::empty();
$document->blocks(); // array of Node: the top-level blocks
$document->isEmpty(); // no blocks, or only empty paragraphs
$document->isNotEmpty();
$document->render(); // HtmlString, sanitized (default profile)
$document->render('minimal');
$document->toHtml(); // string; also what {{ $document }} prints
$document->toText(); // plain text, a blank line between blocks
$document->excerpt(160); // the start of the text, on a word boundary
$document->sanitize('minimal'); // a sanitized copy
$document->toArray(); // ['type' => 'doc', 'content' => [...]]
$document->toJson();
Node is the value object for one node: $node->type, $node->attrs, $node->content (child nodes), $node->marks, $node->text, $node->attr('level'), $node->textContent() and $node->walk(fn (Node $node, array $path) => …).
The BlockEditor facade has the same operations for any value:
use Javaabu\BlockEditor\Facades\BlockEditor;
BlockEditor::render($post->body, 'default'); // HTML string
BlockEditor::sanitize($request->input('body')); // Document
Search and excerpts
toText() gives the text of every block, including table cells, columns, captions and button labels, which suits a search index:
public function toSearchableArray(): array
{
return ['title' => $this->title, 'body' => $this->body->toText()];
}