# MessageInterface

Chevere\Interfaces\Message\MessageInterface

view source

# Extends

ToStringInterface

# Description

Describes the component in charge of handling rich system messages for CLI and HTML.

# Constants

# CLI_TABLE

Type array

array (
  'emphasis' => 
  array (
    'bold' => 3,
  ),
  'strong' => 
  array (
    'bold' => 1,
  ),
  'underline' => 
  array (
    'bold' => 4,
  ),
  'code' => 
  array (
    'bg' => 37,
    'fg' => 30,
  ),
)

# HTML_TABLE

Type array

array (
  'emphasis' => 'em',
  'underline' => 'u',
)

# Methods

# __construct()

# Parameters

string $template

# template()

Provides access to the message template.

RETURN

string

# trTable()

Provides access to the message translation table.

RETURN

array

# toConsole()

Returns a console message representation.

RETURN

string

# toHtml()

Returns a HTML message representation.

RETURN

string

# toString()

Returns a text message representation.

RETURN

string

# strtr()

Return an instance with the specified string translation.

# Parameters

string $search
string $replace

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified string translation.

# emphasis()

Return an instance with the specified $search replaced with $replace emphasis tag.

# Parameters

string $search
string $replace

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $search replaced with $replace emphasis tag.

# strong()

Return an instance with the specified $search replaced with $replace as strong tag.

# Parameters

string $search
string $replace

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $search replaced with $replace as strong tag.

# underline()

Return an instance with the specified underline.

# Parameters

string $search
string $replace

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified underline.

# code()

Return an instance with the specified $search replaced with $replace as code tag.

# Parameters

string $search
string $replace

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $search replaced with $replace as code tag.