Contentserv PHP API

CSFlatplanReport extends CSReportPlugin
in package

Report Plugin that shows data about the publications

Tags
since

CS14.0

access

public

Table of Contents

addPublicationSections()  : void
Adds the sections for a given publication
addSections()  : mixed
getBarChart()  : string
Draws a stacked bar section
getCSSLinks()  : mixed
getDefaultFooter()  : mixed
getDefaultIntro()  : mixed
getDefaultRightFooter()  : mixed
getDefaultSubtitle()  : mixed
getDefaultTitle()  : mixed
getOverviewSection()  : string
Draws an overview section
getPlacementColorByState()  : string
Returns a color matching a placement state
getPlacementColorByStateName()  : string
Returns a color matching a placement state name.
getPluginName()  : string
The Plugin name
isAvailableForContext()  : mixed

Methods

addPublicationSections()

Adds the sections for a given publication

public addPublicationSections(CSFlatplanPage $pub) : void
Parameters
$pub : CSFlatplanPage

the current publication

Tags
Return values
void —

addSections()

public addSections() : mixed
Tags
see
CSReports::addSections()
Return values
mixed —

getBarChart()

Draws a stacked bar section

public getBarChart(mixed $data, mixed $sum, mixed $width) : string
Parameters
$data : mixed
$sum : mixed
$width : mixed
Tags
Return values
string —

getCSSLinks()

public getCSSLinks() : mixed
Tags
Return values
mixed —

getDefaultFooter()

public getDefaultFooter() : mixed
Tags
see
CSReports::getDefaultFooter()
Return values
mixed —

getDefaultIntro()

public getDefaultIntro() : mixed
Tags
see
CSReports::getDefaultInfo()
Return values
mixed —

getDefaultRightFooter()

public getDefaultRightFooter() : mixed
Tags
see
CSReports::getDefaultRightFooter()
Return values
mixed —

getDefaultSubtitle()

public getDefaultSubtitle() : mixed
Tags
see
CSReports::getDefaultSubtitle()
Return values
mixed —

getDefaultTitle()

public getDefaultTitle() : mixed
Tags
see
CSReports::getDefaultTitle()
Return values
mixed —

getOverviewSection()

Draws an overview section

public getOverviewSection(mixed $title, mixed $data, mixed $unit[, null $total = null ]) : string
Parameters
$title : mixed
$data : mixed
$unit : mixed
$total : null = null
Tags
Return values
string —

the html

getPlacementColorByState()

Returns a color matching a placement state

public getPlacementColorByState(int $iState) : string
Parameters
$iState : int
Tags
Return values
string —

getPlacementColorByStateName()

Returns a color matching a placement state name.

public getPlacementColorByStateName(string $sStateName) : string
Parameters
$sStateName : string

the state name as string (the translation key)

Tags
Return values
string —

the color

getPluginName()

The Plugin name

public getPluginName() : string
Tags
access

public

Return values
string —

the name of the plugin

isAvailableForContext()

public isAvailableForContext([mixed $context = null ][, mixed $subcontext = null ]) : mixed
Parameters
$context : mixed = null
$subcontext : mixed = null
Tags
see
CSReports::isAvailableForContext()

is here overwritten to limit for Restservices

Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results