class HtmlOutputFormatter implements OutputFormatterInterface (View source)

Wraps an ANSI formatter and converts the ANSI formatting to styled HTML.

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
__construct(OutputFormatterInterface $formatter)

No description

public
void
setDecorated(bool $decorated)

No description

public
bool
isDecorated()

No description

public
void
setStyle(string $name, OutputFormatterStyleInterface $style)

No description

public
bool
hasStyle(string $name)

No description

public
OutputFormatterStyleInterface
getStyle(string $name)

No description

public
string|null
format(string|null $message)

No description

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(OutputFormatterInterface $formatter)

No description

Parameters

OutputFormatterInterface $formatter

void setDecorated(bool $decorated)

No description

Parameters

bool $decorated

Return Value

void

bool isDecorated()

No description

Return Value

bool

void setStyle(string $name, OutputFormatterStyleInterface $style)

No description

Parameters

string $name
OutputFormatterStyleInterface $style

Return Value

void

bool hasStyle(string $name)

No description

Parameters

string $name

Return Value

bool

OutputFormatterStyleInterface getStyle(string $name)

No description

Parameters

string $name

Return Value

OutputFormatterStyleInterface

string|null format(string|null $message)

No description

Parameters

string|null $message

Return Value

string|null