Aller au contenu

Configuration

phil/block-editor-bundle
# config/packages/phil_block_editor.yaml
phil_block_editor:
    preset: full              # full, or reduced for simple sites
    tools: ~                  # the block types offered, replacing those of the preset
    inline_tools: ~           # the inline tools offered, replacing those of the preset
    colors: [accent, muted, success, warning, danger]
    image_uploader: ~         # an ImageUploader service; none takes image addresses only
    mention_search: ~         # a ReferenceSearch service behind "@"
    link_search: ~            # a ReferenceSearch service behind "[["
    max_upload_bytes: 10485760
    access: IS_AUTHENTICATED  # the attribute callers of the endpoints must be granted; ~ for none
OptionValeur par défautEffet
presetfullLe jeu d'outils de départ de chaque champ
toolsceux du préréglageLes types de blocs offerts, dans n'importe quel ordre ; paragraph est obligatoire
inline_toolsceux du préréglageLes outils en ligne offerts, dans n'importe quel ordre
colorscinq jetonsLes jetons de couleur de l'outil de couleur du texte, écrits data-color="token" ; la feuille de style du site donne sa couleur à chacun
image_uploaderaucuneL'identifiant de service d'un ImageUploader
mention_searchaucuneL'identifiant de service d'un ReferenceSearch pour @
link_searchaucuneL'identifiant de service d'un ReferenceSearch pour [[
max_upload_bytes10 MioLa plus grande image que le point de terminaison de téléversement transmet au téléverseur. Au moins 1
accessIS_AUTHENTICATEDL'attribut que le vérificateur d'autorisations de l'application doit accorder pour appeler les points de terminaison ; sans SecurityBundle, tout appel est refusé. ~ ne vérifie rien : protégez les routes par access_control

Un outil ou un préréglage inconnu, ou un jeu d'outils sans paragraph, est refusé à la construction du conteneur.

Jeux d'outils

Outil de blocType UJOOutil en ligneÉcrit sous la forme
paragraphparagraphbold<b>
headerheader, niveaux 1 à 6italic<i>
listlist : à puces, numérotée, de tâches, imbriquéeunderline<u class="cdx-underline">
quotequote, avec son auteurstrikethrough<s class="cdx-strikethrough">
codecode, avec son langageinlineCode<code class="inline-code">
alertalert : un encadrélink<a href>
toggletoggle, qui contient des blocsmarker<mark class="cdx-marker">
columnscolumns, 2 à 4, qui contiennent des blocstextColor<span class="text-color" data-color>
tabletablesuperscript, subscript<sup>, <sub>
imageimagemention<a data-mention="kind:id">
delimiterdelimiterwikiLink<a data-ref="kind:id">
lineBreak<br>

Le préréglage reduced comprend paragraph, header, list et quote, avec bold, italic, link et lineBreak. Un champ peut nommer son propre jeu d'outils (forms.md).

Services

ServiceConstruit
Phil\BlockEditorBundle\Application\Toolsetpar Toolset::preset() avec preset, tools et inline_tools
Phil\BlockEditorBundle\Infrastructure\Ujo\ToolsetNormalizerssur le BlockTypeRegistry de phil/ujo-bundle
Phil\BlockEditorBundle\Infrastructure\Http\EditorRequestsur le gestionnaire de jetons CSRF de FrameworkBundle, le vérificateur d'autorisations, s'il y en a un, et access
Phil\BlockEditorBundle\Infrastructure\Http\Endpointssur le routeur, s'il y en a un, et les points de terminaison dont le service est configuré
Phil\BlockEditorBundle\Infrastructure\Form\BlockEditorTypesur Ujo, les normaliseurs, le jeu d'outils, les points de terminaison, colors et la pile de requêtes ; un type de formulaire
Phil\BlockEditorBundle\Infrastructure\Http\ImageUploadControllersur image_uploader et max_upload_bytes ; public
Phil\BlockEditorBundle\Infrastructure\Http\ReferenceSearchControllersur mention_search et link_search ; public

Le registre vient de phil/ujo-bundle : son réglage allow_raw et tout type qu'une application y ajoute s'appliquent donc aussi aux champs de l'éditeur. L'éditeur lui-même n'écrit jamais de bloc raw.