Templating Helper

A CakePHP helper for common templating use cases. It contains convenience wrappers for colored status indicators.

Setup

Include the helper in your AppView class:

$this->loadHelper('Templating.Templating', [
    // ...
]);

It provides the following methods:

• ok() — print content with markup to color it green/red.
• warning() — wrap ok() to always show "red" right away.
• yesNo() — convenience method combining icon rendering with colored output.

ok()

Returns green text on true/ok, red text otherwise.

// Basic usage
echo $this->Templating->ok('Success', true);  // Green text
echo $this->Templating->ok('Failed', false);  // Red text

// With HtmlStringable (icons)
echo $this->Templating->ok($this->Icon->render('check'), true);

// With attributes
echo $this->Templating->ok('Status', $isActive, ['class' => 'status-badge']);

// Disable escaping if needed
echo $this->Templating->ok('<strong>Bold</strong>', true, ['escape' => false]);

By default, this method escapes the content. Use the escape attribute set to false to disable escaping.

warning()

Convenience wrapper for ok() that always returns red text unless explicitly ok.

// Only shows red when not ok
echo $this->Templating->warning('Error occurred', false);  // Red text
echo $this->Templating->warning('All good', true);  // Plain text (not colored)

// With attributes
echo $this->Templating->warning($errorMessage, $hasError, ['class' => 'alert']);

yesNo()

Convenience method that combines icon rendering with colored output. Returns a yes/no icon colored green/red based on the value.

Make sure to configure these icons in your Icon.map app config:

'Icon' => [
    'map' => [
        'yes' => 'fa4:check',
        'no' => 'fa4:times',
    ],
],

Usage:

// Basic usage
echo $this->Templating->yesNo($user->is_active);  // Green check icon
echo $this->Templating->yesNo($user->is_banned);  // Red times icon

// With options
echo $this->Templating->yesNo($value, [
    'onTitle' => __('Active'),
    'offTitle' => __('Inactive'),
]);

// Invert colors (green for no, red for yes)
echo $this->Templating->yesNo($hasErrors, [
    'invert' => true,  // Green when false, red when true
]);

// With attributes
echo $this->Templating->yesNo($status, [], [
    'class' => 'status-icon',
    'data-toggle' => 'tooltip',
]);

Parameters:

• $value (mixed) — value internally cast to bool.
• $options (array) — optional configuration:
  • onTitle (string) — title/tooltip for the true value (default: "Yes").
  • offTitle (string) — title/tooltip for the false value (default: "No").
  • invert (bool) — if true, green for no/false, red for yes/true.
• $attributes (array) — HTML attributes for the icon element:
  • title — custom title attribute.
  • Any other HTML attributes.

Returns: a string with the colored icon HTML.