Skip to content

Reference

phil/block-editor-bundle

Every class and module of the bundle, with its role.

ClassKindRole
Phil\BlockEditorBundle\PhilBlockEditorBundlefinal class, AbstractBundleThe bundle: the phil_block_editor configuration, the form theme and the AssetMapper paths
Phil\BlockEditorBundle\Application\Toolsetfinal readonly classThe block and inline tools of a field; the full and reduced presets
Phil\BlockEditorBundle\Application\Upload\ImageUploaderinterfaceThe port that keeps uploaded images
Phil\BlockEditorBundle\Application\Upload\ImageUploadfinal readonly classAn image as the request received it
Phil\BlockEditorBundle\Application\Upload\UploadedImagefinal readonly classWhere an image is now: the block's file
Phil\BlockEditorBundle\Application\Reference\ReferenceSearchinterfaceThe port behind the @ and [[ menus
Phil\BlockEditorBundle\Application\Reference\Suggestionfinal readonly classA reference, its label, its address and a hint
Phil\BlockEditorBundle\Application\Reference\DocumentReferencesfinal classThe mentions, page links and files of a document
Phil\BlockEditorBundle\Application\Exception\BlockEditorExceptioninterfaceEvery exception of the bundle
Phil\BlockEditorBundle\Application\Exception\InvalidToolsetfinal classAn unknown tool or preset, or no paragraph
Phil\BlockEditorBundle\Application\Exception\InvalidSuggestionfinal classA suggestion's reference or label of the wrong form
Phil\BlockEditorBundle\Application\Exception\UploadRefusedfinal classAn uploader's refusal, shown to the writer
Phil\BlockEditorBundle\Infrastructure\DependencyInjection\BlockEditorServicesfinal classDeclares the bundle's services
Phil\BlockEditorBundle\Infrastructure\DependencyInjection\CsrfProtectionPassfinal readonly classStops the container with a message that says what to change when framework.csrf_protection is false
Phil\BlockEditorBundle\Infrastructure\Ujo\ToolsetNormalizersfinal classOne phil/ujo normalizer per toolset
Phil\BlockEditorBundle\Infrastructure\Form\BlockEditorTypefinal class, AbstractTypeThe editor as a form field
Phil\BlockEditorBundle\Infrastructure\Form\BlockEditorTransformerfinal readonly class, DataTransformerInterfaceJSON checked and narrowed, to canonical JSON or Document, and back
Phil\BlockEditorBundle\Infrastructure\Http\Endpointsfinal readonly classThe endpoints' URLs, when configured and routed
Phil\BlockEditorBundle\Infrastructure\Http\EditorRequestfinal classWhether a request comes from the editor: its header, the browser's Sec-Fetch-Site and the stateless CSRF token phil_block_editor unless the method is safe; the name of the token's cookie
Phil\BlockEditorBundle\Infrastructure\Http\ImageUploadControllerfinal readonly classThe upload endpoint
Phil\BlockEditorBundle\Infrastructure\Http\ReferenceSearchControllerfinal readonly classThe two search endpoints
FileRole
config/routes.phpThe three routes, imported by the application
templates/form/block_editor.html.twigThe form theme
assets/src/editor_controller.jsThe Stimulus controller
assets/src/lib/*.jsIts modules (javascript.md)
assets/styles/block-editor.cssThe stylesheet
assets/package.jsonThe controller declared for Symfony UX

See configuration.md, forms.md, editor.md and integrations.md.