\CGExtensions\reportstabular_report_cellfmt

A class that defines a cell format for a tabular report.

This class is used to indicate how to display a value for a certain cell.

Summary

Methods
Properties
Constants
__construct()
get_key()
get_template()
set_template()
get_alignment()
get_span()
get_class()
set_class()
No public properties found
ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

ALIGN_LEFT

ALIGN_LEFT

ALIGN_RIGHT

ALIGN_RIGHT

ALIGN_CENTER

ALIGN_CENTER

Methods

__construct()

__construct(string $key, string $tpl, string $align, int $span)

Construct a new tabular_report_cellfmt.

Parameters

string $key

The name of the column (must match a defined column).

string $tpl

The smarty template for displaying values for this cell. Default value is '{$val}'.

string $align

The alignment for this cell. See the ALIGN constants in this class.

int $span

The number of columns this cell should span. Some generators may ignore this.

get_key()

get_key() : string

Get the key (column name) for this object.

Returns

string

get_template()

get_template() : string

Get the template for values in this cell format

Returns

string

set_template()

set_template(string $tpl)

Set the template for values in this cell format.

Parameters

string $tpl

Smarty template. It should be simple, and used for displaying a single value.

get_alignment()

get_alignment() : string

Get the alignment for cells using this format.

Returns

string

get_span()

get_span() : int

Get the cell span for cells using this format.

Returns

int

get_class()

get_class() : string

Get the class name (if any) assigned to this cell format

Returns

string

set_class()

set_class(string $class)

Set a class name to use when outputting cells using this format.

Some generators may ignore this value. But HTML type generators will typically use this as a class name for the table cell.

Parameters

string $class