Heratio Framework API Reference

blade_shims.php

Symfony Template Helper Shims for Heratio Standalone Mode.

These functions provide backward compatibility for plugin PHP templates that call Symfony 1.x view helpers (url_for, link_to, slot, etc.) when running through Heratio instead of Symfony.

Each function is guarded with function_exists() so it NEVER conflicts with Symfony when the template is rendered through index.php.

Loaded by ActionBridge before rendering PHP templates.

Table of Contents

Classes

sfForm
Minimal sfForm stub for standalone mode.

Functions

slot()  : mixed
end_slot()  : mixed
get_slot()  : mixed
has_slot()  : mixed
include_slot()  : mixed
decorate_with()  : mixed
url_for()  : mixed
link_to()  : mixed
esc_specialchars()  : mixed
esc_entities()  : mixed
esc_raw()  : mixed
format_number()  : mixed
format_date()  : mixed
use_helper()  : mixed
use_stylesheet()  : mixed
use_javascript()  : mixed
javascript_tag()  : mixed
image_tag()  : mixed
public_path()  : mixed
get_partial()  : mixed
include_partial()  : mixed
get_component()  : mixed
include_component()  : mixed
get_component_slot()  : mixed
include_component_slot()  : mixed
include_title()  : mixed
__()  : mixed
render_field()  : mixed
Minimal standalone shim for render_field().
render_show()  : mixed
Minimal standalone shim for render_show().
render_show_repository()  : mixed
render_value()  : mixed
render_value_inline()  : mixed
render_value_html()  : mixed
get_search_i18n()  : mixed
Extract an i18n field from a search result document (ES or DB row).
check_field_visibility()  : mixed
format_script()  : mixed
strip_markdown()  : mixed
render_title()  : mixed
Minimal standalone shim for render_title().
format_language()  : mixed
Format an ISO 639 language code as a human-readable name.
format_country()  : mixed
csrf_field()  : string
Render a hidden input field containing the CSRF token.
csrf_token()  : string
Get the current CSRF token string.
csrf_meta()  : string
Render a meta tag containing the CSRF token for JS access.
render_b5_field()  : mixed
render_b5_show_field_css_classes()  : mixed
render_b5_show_subfield_css_classes()  : mixed
render_b5_show()  : mixed
render_b5_show_container()  : mixed
render_b5_show_label_css_classes()  : mixed
render_b5_show_label()  : mixed
render_b5_show_value_css_classes()  : mixed
render_b5_show_value()  : mixed
render_b5_section_heading()  : mixed
render_b5_show_list_css_classes()  : mixed
add_paragraphs_and_linebreaks()  : mixed
hr_filesize()  : mixed
render_treeview_node()  : mixed
render_b5_treeview_node()  : mixed
is_using_cli()  : mixed
get_search_creation_details()  : mixed
render_autocomplete_string()  : mixed
escape_dc()  : mixed
render_search_result_date()  : mixed

Functions

slot()

slot(mixed $name) : mixed
Parameters
$name : mixed

get_slot()

get_slot(mixed $name[, mixed $default = '' ]) : mixed
Parameters
$name : mixed
$default : mixed = ''

has_slot()

has_slot(mixed $name) : mixed
Parameters
$name : mixed

include_slot()

include_slot(mixed $name) : mixed
Parameters
$name : mixed

decorate_with()

decorate_with(mixed $layout) : mixed
Parameters
$layout : mixed

url_for()

url_for(mixed $params[, mixed $absolute = false ]) : mixed
Parameters
$params : mixed
$absolute : mixed = false
link_to(mixed $text, mixed $url[, mixed $options = [] ]) : mixed
Parameters
$text : mixed
$url : mixed
$options : mixed = []

esc_specialchars()

esc_specialchars(mixed $value) : mixed
Parameters
$value : mixed

esc_entities()

esc_entities(mixed $value) : mixed
Parameters
$value : mixed

esc_raw()

esc_raw(mixed $value) : mixed
Parameters
$value : mixed

format_number()

format_number(mixed $number[, mixed $decimals = 0 ]) : mixed
Parameters
$number : mixed
$decimals : mixed = 0

format_date()

format_date(mixed $date[, mixed $format = 'f' ]) : mixed
Parameters
$date : mixed
$format : mixed = 'f'

use_helper()

use_helper(mixed ...$helpers) : mixed
Parameters
$helpers : mixed

use_stylesheet()

use_stylesheet(mixed $stylesheet[, mixed $position = '' ][, mixed $options = [] ]) : mixed
Parameters
$stylesheet : mixed
$position : mixed = ''
$options : mixed = []

use_javascript()

use_javascript(mixed $javascript[, mixed $position = '' ][, mixed $options = [] ]) : mixed
Parameters
$javascript : mixed
$position : mixed = ''
$options : mixed = []

javascript_tag()

javascript_tag(mixed $content) : mixed
Parameters
$content : mixed

image_tag()

image_tag(mixed $src[, mixed $options = [] ]) : mixed
Parameters
$src : mixed
$options : mixed = []

public_path()

public_path(mixed $file) : mixed
Parameters
$file : mixed

get_partial()

get_partial(mixed $name[, mixed $vars = [] ]) : mixed
Parameters
$name : mixed
$vars : mixed = []

include_partial()

include_partial(mixed $name[, mixed $vars = [] ]) : mixed
Parameters
$name : mixed
$vars : mixed = []

get_component()

get_component(mixed $module, mixed $component[, mixed $vars = [] ]) : mixed
Parameters
$module : mixed
$component : mixed
$vars : mixed = []

include_component()

include_component(mixed $module, mixed $component[, mixed $vars = [] ]) : mixed
Parameters
$module : mixed
$component : mixed
$vars : mixed = []

get_component_slot()

get_component_slot(mixed $name) : mixed
Parameters
$name : mixed

include_component_slot()

include_component_slot(mixed $name) : mixed
Parameters
$name : mixed

__()

__(mixed $text[, mixed $args = [] ][, mixed $catalogue = 'messages' ]) : mixed
Parameters
$text : mixed
$args : mixed = []
$catalogue : mixed = 'messages'

render_field()

Minimal standalone shim for render_field().

render_field(mixed $field[, mixed $resource = null ][, array<string|int, mixed> $options = [] ]) : mixed

In full Symfony mode, this renders a form field with label/error/help. In standalone Heratio mode, we output a basic Bootstrap 5 form group.

Parameters
$field : mixed
$resource : mixed = null
$options : array<string|int, mixed> = []

render_show()

Minimal standalone shim for render_show().

render_show(mixed $label, mixed $value[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$label : mixed
$value : mixed
$options : array<string|int, mixed> = []

render_show_repository()

render_show_repository(mixed $label, mixed $resource) : mixed
Parameters
$label : mixed
$resource : mixed

render_value()

render_value(mixed $value) : mixed
Parameters
$value : mixed

render_value_inline()

render_value_inline(mixed $value) : mixed
Parameters
$value : mixed

render_value_html()

render_value_html(mixed $value) : mixed
Parameters
$value : mixed

get_search_i18n()

Extract an i18n field from a search result document (ES or DB row).

get_search_i18n(mixed $doc, mixed $field[, mixed $options = [] ]) : mixed

Tries culture-specific nested field, direct field, then any-language fallback.

Parameters
$doc : mixed
$field : mixed
$options : mixed = []

check_field_visibility()

check_field_visibility(mixed $fieldName[, mixed $options = [] ]) : mixed
Parameters
$fieldName : mixed
$options : mixed = []

format_script()

format_script(mixed $script_iso[, mixed $culture = null ]) : mixed
Parameters
$script_iso : mixed
$culture : mixed = null

strip_markdown()

strip_markdown(mixed $text) : mixed
Parameters
$text : mixed

render_title()

Minimal standalone shim for render_title().

render_title(mixed $resource[, mixed $showUntitled = true ]) : mixed

In full Symfony mode, this renders entity title with escaping/truncation. In standalone Heratio mode, we call __toString() with HTML escaping.

Parameters
$resource : mixed
$showUntitled : mixed = true

format_language()

Format an ISO 639 language code as a human-readable name.

format_language(mixed $language_iso[, mixed $culture = null ]) : mixed

In full Symfony mode, this delegates to sfCultureInfo. In standalone mode, we use a built-in lookup of common language codes.

Parameters
$language_iso : mixed
$culture : mixed = null

format_country()

format_country(mixed $country_iso[, mixed $culture = null ]) : mixed
Parameters
$country_iso : mixed
$culture : mixed = null

csrf_field()

Render a hidden input field containing the CSRF token.

csrf_field() : string
Return values
string

csrf_token()

Get the current CSRF token string.

csrf_token() : string
Return values
string

csrf_meta()

Render a meta tag containing the CSRF token for JS access.

csrf_meta() : string
Return values
string

render_b5_field()

render_b5_field(mixed $field[, mixed $translation = null ][, mixed $options = [] ]) : mixed
Parameters
$field : mixed
$translation : mixed = null
$options : mixed = []

render_b5_show_field_css_classes()

render_b5_show_field_css_classes([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []

render_b5_show_subfield_css_classes()

render_b5_show_subfield_css_classes([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []

render_b5_show()

render_b5_show(mixed $label, mixed $value[, mixed $options = [] ]) : mixed
Parameters
$label : mixed
$value : mixed
$options : mixed = []

render_b5_show_container()

render_b5_show_container(mixed $tag, mixed $content[, mixed $cssClasses = '' ][, mixed $options = [] ]) : mixed
Parameters
$tag : mixed
$content : mixed
$cssClasses : mixed = ''
$options : mixed = []

render_b5_show_label_css_classes()

render_b5_show_label_css_classes([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []

render_b5_show_label()

render_b5_show_label(mixed $label[, mixed $options = [] ]) : mixed
Parameters
$label : mixed
$options : mixed = []

render_b5_show_value_css_classes()

render_b5_show_value_css_classes([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []

render_b5_show_value()

render_b5_show_value(mixed $value[, mixed $options = [] ]) : mixed
Parameters
$value : mixed
$options : mixed = []

render_b5_section_heading()

render_b5_section_heading(mixed $text[, mixed $condition = false ][, mixed $url = null ][, mixed $linkOptions = [] ]) : mixed
Parameters
$text : mixed
$condition : mixed = false
$url : mixed = null
$linkOptions : mixed = []

render_b5_show_list_css_classes()

render_b5_show_list_css_classes([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []

add_paragraphs_and_linebreaks()

add_paragraphs_and_linebreaks(mixed $value) : mixed
Parameters
$value : mixed

hr_filesize()

hr_filesize(mixed $val) : mixed
Parameters
$val : mixed

render_treeview_node()

render_treeview_node(mixed $item[, array<string|int, mixed> $classes = [] ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$item : mixed
$classes : array<string|int, mixed> = []
$options : array<string|int, mixed> = []

render_b5_treeview_node()

render_b5_treeview_node(mixed $item[, array<string|int, mixed> $classes = [] ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$item : mixed
$classes : array<string|int, mixed> = []
$options : array<string|int, mixed> = []

get_search_creation_details()

get_search_creation_details(mixed $hit[, mixed $culture = null ]) : mixed
Parameters
$hit : mixed
$culture : mixed = null

render_autocomplete_string()

render_autocomplete_string(mixed $hit) : mixed
Parameters
$hit : mixed

escape_dc()

escape_dc(mixed $text) : mixed
Parameters
$text : mixed

render_search_result_date()

render_search_result_date(mixed $date) : mixed
Parameters
$date : mixed

        
On this page

Search results