Documentation

Report
in package

Table of Contents

$currentSubscriber  : array<string|int, mixed>
$currentTemplate  : string
$name  : string
$parameters  : array<string|int, mixed>
$subscribers  : array<string|int, mixed>
$templates  : array<string|int, mixed>
$title  : string
__construct()  : mixed
addSubscriber()  : void
addTemplate()  : void
build()  : Report
getCurrentSubscriber()  : array<string|int, mixed>
getCurrentTemplate()  : string
getDefaultTemplates()  : mixed
getName()  : string
getParameter()  : mixed
getParameters()  : mixed
getSubscribers()  : array<string|int, mixed>
getTemplates()  : array<string|int, mixed>
getTitle()  : string
setCurrentSubscriber()  : void
setCurrentTemplate()  : void
setParameter()  : void
setParameters()  : void
toArray()  : array<string|int, mixed>
setSubscribers()  : void
setTemplates()  : void

Properties

$currentSubscriber

private array<string|int, mixed> $currentSubscriber = []

$currentTemplate

private string $currentTemplate

$parameters

private array<string|int, mixed> $parameters = []

$subscribers

private array<string|int, mixed> $subscribers

$templates

private array<string|int, mixed> $templates

Methods

__construct()

public __construct(string $name[, string $title = '' ]) : mixed
Parameters
$name : string
$title : string = ''
Return values
mixed

addTemplate()

public addTemplate(string $path, string $title) : void
Parameters
$path : string
$title : string
Return values
void

build()

public static build(ActiveRow $report) : Report
Parameters
$report : ActiveRow
Return values
Report

getCurrentSubscriber()

public getCurrentSubscriber() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCurrentTemplate()

public getCurrentTemplate() : string
Return values
string

getDefaultTemplates()

public getDefaultTemplates() : mixed
Return values
mixed

getName()

public getName() : string
Return values
string

getParameter()

public getParameter(string $name[, mixed $default_value = null ]) : mixed
Parameters
$name : string
$default_value : mixed = null
Return values
mixed

getParameters()

public getParameters() : mixed
Return values
mixed

getSubscribers()

public getSubscribers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTemplates()

public getTemplates() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTitle()

public getTitle() : string
Return values
string

setCurrentSubscriber()

public setCurrentSubscriber(array<string|int, mixed> $currentSubscriber) : void
Parameters
$currentSubscriber : array<string|int, mixed>
Return values
void

setCurrentTemplate()

public setCurrentTemplate(string $currentTemplate) : void
Parameters
$currentTemplate : string
Return values
void

setParameter()

public setParameter(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed
Return values
void

setParameters()

public setParameters(mixed $parameters) : void
Parameters
$parameters : mixed
Return values
void

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

setSubscribers()

private setSubscribers(array<string|int, mixed> $subscribers) : void
Parameters
$subscribers : array<string|int, mixed>
Return values
void

setTemplates()

private setTemplates(mixed $templates) : void
Parameters
$templates : mixed
Return values
void

Search results