PHP Class Piwik\API\ApiRenderer

Show file Open project: piwik/piwik Class Usage Examples

Protected Properties

Property	Type	Description
$request

Public Methods

Method	Description
__construct ( $request )
factory ( string $format, array $request ) : ApiRenderer
renderArray ( $array )
renderDataTable ( $dataTable )
renderException ( $message, Exceptio\Exception \| Throwable $exception ) : mixed
renderObject ( $object )
renderResource ( $resource )
renderScalar ( $scalar )
renderSuccess ( $message )
sendHeader ( )

Protected Methods

Method	Description
buildDataTableRenderer ( $dataTable ) : Piwik\DataTable\Renderer
init ( )

Private Methods

Method	Description
getFormatFromClass ( $klassname )

Method Details

__construct() final public method

final public __construct ( $request )

buildDataTableRenderer() protected method

protected buildDataTableRenderer ( $dataTable ) : Piwik\DataTable\Renderer
$dataTable
return	Piwik\DataTable\Renderer

factory() public static method

public static factory ( string $format, array $request ) : ApiRenderer
$format	string
$request	array
return	ApiRenderer

init() protected method

protected init ( )

renderArray() public method

public renderArray ( $array )

renderDataTable() public method

public renderDataTable ( $dataTable )

renderException() public method

public renderException ( $message, Exceptio\Exception \| Throwable $exception ) : mixed
$message
$exception	Exceptio\Exception \| Throwable
return	mixed

renderObject() public method

public renderObject ( $object )

renderResource() public method

public renderResource ( $resource )

renderScalar() public method

public renderScalar ( $scalar )

renderSuccess() public method

public renderSuccess ( $message )

sendHeader() abstract public method

abstract public sendHeader ( )

Property Details

$request protected property

protected $request