feature-php
Back to top  

A renderer for a product.

This renders a \FeaturePhp\ProductLine\Product analysis as a web page. In particular, a list of generated files and file content summaries is included.

package Default
inherited_from \FeaturePhp\Renderer

 Methods

Creates a product renderer.

__construct(\FeaturePhp\ProductLine\Product $product) 

Parameters

$product

\FeaturePhp\ProductLine\Product

Returns the product analysis.

_render(boolean $textOnly) : string
inherited_from \FeaturePhp\Renderer::_render()

Parameters

$textOnly

boolean

whether to render text or HTML

Returns

string

Returns the renderer's web page.

render(boolean $textOnly = false) : string
Inherited

Parameters

$textOnly

boolean

whether to render text or HTML

Returns

string

Returns the renderer's web page as text only.

renderText() : string
Inherited

This is used by the command-line interface.

Returns

string

Internal function for returning the renderer's web page.

_render(boolean $textOnly) : string
Inherited

Parameters

$textOnly

boolean

whether to render text or HTML

Returns

string

Returns a simple stylesheet.

getStyle() : string
Inherited

Returns

string

 Properties

 

accent color for text only rendering

$accentColor : string

Default

"\033[1;33m"
 

default color for text only rendering

$defaultColor : string

Default

"\033[0m"
 

the product's files

$files : array<mixed,\FeaturePhp\File\File>

Default

 

the product that will be analyzed

$product : \FeaturePhp\ProductLine\Product

Default

 

the product's tracing links

$tracingLinks : array<mixed,\FeaturePhp\Artifact\TracingLink>

Default