Skip to content

Configuration ​

Set plugin defaults under Carve in config/app_local.php or config/app.php. A render call can override most values. The defaults below match config/app.example.php and CarveRenderer.

Set a default ​

php
'Carve' => [
    'safeMode' => true,
    'profile' => 'comment',
],

Find a key ​

KeyDefaultMeaning
rendererClassCarveRenderer::classRenderer used by the helper and view; implement CarveRendererInterface.
safeModetrueEngine safe rendering policy.
rawHtmlnullRaw HTML handling under normal safe mode.
xhtmlfalseXHTML style empty tags.
strictfalseThrow on parse errors.
warningsfalseCollect parse warnings.
profilenullAllowed markup profile.
onDisallowedstripAction for markup outside the profile.
modeinteractiveInteractive or static rendering.
softBreakModenullRendering of soft line breaks.
smartTypographynullTypography substitutions.
symbols[]Named symbol replacements.
sourceLinesfalseSource line data in HTML.
labels[]Engine generated UI text.
roundTripModefalseCarriers for round trip output.
renderers[]Build time extension renderers.
includeRootnullFilesystem include boundary.
includeResolvernullCustom include source.
extensions[]Extra markup features.
presetsdefault, comment, trustedNamed option maps.
cachefalseCakePHP render cache settings.
debugnullHelper timing comment; null follows app debug.

See rendering and options for values and examples, safe mode for visitor content, extensions for extension names, and caching for cache settings. JSON frontmatter metadata works by default; YAML needs symfony/yaml or PHP's yaml extension.

Released under the MIT License.