Class SimpleID\Util\UI\Template

`extends`	`Template`
`implements`	`AttachmentManagerInterface`
`uses`	`AttachmentManagerTrait`

An extension to the Fat-Free Framework Template class.

This class implements a numbner of extensions:

Attachments. This class uses the AttachmentManagerTrait to provide methods to allow templates to retrieve attachments.
Return values. The return custom tag, along with the {@getReturnValue()} function, allows templates to assign and return values back to the calling PHP code.
Custom tags. This class provides custom tags such as capture, mail_callout and mail_button.
Custom filters.. This class provides a number of additional custom filters, including attr, js, markdown and html_to_text.

Template
- SimpleID\Util\UI\Template implements AttachmentManagerInterface uses AttachmentManagerTrait

Located at core/Util/UI/Template.php

Methods


					
	public

__construct()


					
	public

_capture(array<string, mixed> $node): string

Captures the output.

<capture to="varname"><include href="foo"></capture>

Parameters

$node

the template node

Returns

the compiled PHP code


					
	public

_return(array<string, mixed> $node): string

Sets a return value.

<return name="value">

Parameters

$node

the template node

Returns

the compiled PHP code


					
	public

_mail_callout(array<string, mixed> $node): string

Format a callout for use in emails

Parameters

$node

the template node

Returns

the compiled PHP code


					
	public

_mail_button(array<string, mixed> $node): string

Format a button for use in emails

<mail_button href="value">

Parameters

$node

the template node

Returns

the compiled PHP code


					
	protected

setReturnValue(string $path, mixed $val): void

Sets a value in the return values array.

Parameters

`$path`	the ArrayWrapper path to the value to set
`$val`	the value to set


					
	public

getReturnValues(): array<string, mixed>

Returns all return values

Returns

an array of return values


					
	public

getReturnValue(string $path): mixed

Returns a value from the return values.

Parameters

$path

the ArrayWrapper path to the value to return


					
	public

attr(mixed $val = null, string $name = null): string

Filter to create an HTML attribute.

The output should be fed through a raw filter to prevent double-escaping.

Parameters

`$val`	the attribute value
`$name`	the name of the attribute


					
	public

js(mixed $data = null): string

Filter to encode values to be included in Javascript.

This function uses json_encode() to encode the data as JSON. However, it provides additional safety features so that they can be embedded directly within <script> tags, including:

if the input data is a single string, convert the double quotes to single quotes
wrapping arrays and objects with JSON.parse()

The output should be fed through a raw filter to prevent double-escaping.

Parameters

$data

the data to be converted


					
	public

markdown(string $md): string

Converts Markdown to HTML.

Parameters

$md

Markdown string to convert

Returns

the HTML converted from Markdown


					
	public

html_to_text(string $html, int $wordwrap = 70): string

Transforms HTML to text by stripping HTML tags and word wrapping.

The contents within the <head>, <style> and <script> tags are removed altogether

Parameters

`$html`	the HTML text
`$wordwrap`	number of characters for word wrapping

Returns

the plain text

Methods used from SimpleID\Util\UI\AttachmentManagerTrait
`addAttachment(), getAttachments(), getAttachmentTypes(), getAttachmentsByType(), mergeAttachments(), resetAttachments()`

Constants inherited from SimpleID\Util\UI\AttachmentManagerInterface
`CSS_ATTACHMENT, JS_ATTACHMENT`

Properties
`protected`	`ArrayWrapper`	`$returnValues`	#

Properties used from SimpleID\Util\UI\AttachmentManagerTrait
`$attachments`

Namespaces

Classes

Interfaces

Traits

Class SimpleID\Util\UI\Template

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns