Overview

Namespaces

  • None
  • Peridot
    • Leo
      • Formatter
      • Interfaces
        • Assert
      • Matcher
        • Template
      • ObjectPath
      • Responder
  • PHP

Classes

  • Formatter

Interfaces

  • FormatterInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class Formatter

Class Formatter is the core FormatterInterface for Leo.

Peridot\Leo\Formatter\Formatter implements Peridot\Leo\Formatter\FormatterInterface
Namespace: Peridot\Leo\Formatter
Package: Peridot\Leo\Formatter
Located at Formatter/Formatter.php
Methods summary
public
# __construct( )
public Peridot\Leo\Matcher\Match
# getMatch( )

Return the match being formatted.

Return the match being formatted.

Returns

Peridot\Leo\Matcher\Match

Implementation of

Peridot\Leo\Formatter\FormatterInterface::getMatch()
public mixed
# setMatch( Peridot\Leo\Matcher\Match $match )

Set the match to format results for.

Set the match to format results for.

Parameters

$match

Returns

mixed
$this

Implementation of

Peridot\Leo\Formatter\FormatterInterface::setMatch()
public mixed|string
# getMessage( Peridot\Leo\Matcher\Template\TemplateInterface $template )

Applies the match to the given TemplateInterface and return a formatted string.

Applies the match to the given TemplateInterface and return a formatted string.

Parameters

$template

Returns

mixed|string

Implementation of

Peridot\Leo\Formatter\FormatterInterface::getMessage()
public string
# objectToString( mixed $obj )

Should return a string representation for any PHP type.

Should return a string representation for any PHP type.

Parameters

$obj

Returns

string

Implementation of

Peridot\Leo\Formatter\FormatterInterface::objectToString()
protected array
# getTemplateVars( Peridot\Leo\Matcher\Template\TemplateInterface $template )

Applies match results to other template variables.

Applies match results to other template variables.

Parameters

$template

Returns

array
Properties summary
protected Peridot\Leo\Matcher\Match $match
#
Leo API documentation generated by ApiGen