Documentation

ReportsManager
in package

Table of Contents

COL_ID  = 'id'
COL_NAME  = 'name'
COL_PARAMS  = 'parameters'
COL_SUBSCRIBERS  = 'subscribers'
COL_TEMPLATE  = 'templates'
COL_TITLE  = 'title'
PARAM_SELECT_REPORT_FROM  = 'take_file_from'
PARAM_STRUCTURE_LEVEL  = 'structure_level'
PARAM_TRIGGER_TYPE  = 'type'
SERVICE_NAME  = 'email.reports.manager'
TABLE_NAME  = 'ema_reports'
$database  : Explorer
$reports  : array<string|int, mixed>
__construct()  : mixed
delete()  : void
getReport()  : Report
getReports()  : array<string|int, Report>
getSubscribesByUser()  : ResultSet
register()  : void
unregisterReport()  : void
updateSubscribers()  : void
add()  : void
addUserToSubscribers()  : void
find()  : Selection
get()  : ActiveRow
removeUserFromSubscribers()  : void

Constants

PARAM_SELECT_REPORT_FROM

public mixed PARAM_SELECT_REPORT_FROM = 'take_file_from'

PARAM_STRUCTURE_LEVEL

public mixed PARAM_STRUCTURE_LEVEL = 'structure_level'

SERVICE_NAME

public mixed SERVICE_NAME = 'email.reports.manager'

Properties

Methods

__construct()

public __construct(Explorer $database) : mixed
Parameters
$database : Explorer
Return values
mixed —

getSubscribesByUser()

public getSubscribesByUser(int $userId) : ResultSet
Parameters
$userId : int
Return values
ResultSet —

updateSubscribers()

public updateSubscribers(int $userId, iteratable<string|int, mixed> $reports) : void
Parameters
$userId : int
$reports : iteratable<string|int, mixed>
Tags
throws
UpdateSubscribeException
Return values
void —

add()

private add(iteratable<string|int, mixed> $value) : void
Parameters
$value : iteratable<string|int, mixed>
Return values
void —

addUserToSubscribers()

private addUserToSubscribers(int $userId, string $name, iteratable<string|int, mixed> $args) : void
Parameters
$userId : int
$name : string
$args : iteratable<string|int, mixed>
Tags
throws
ReportNotFountException
Return values
void —

removeUserFromSubscribers()

private removeUserFromSubscribers(int $userId, string $name) : void
Parameters
$userId : int
$name : string
Tags
throws
ReportNotFountException
Return values
void —

Search results