Docs For Class atkColumnConfig

atkColumnConfig	atkColumnConfig()	Constructor
void	addOrderByField()	Add orderby field
void	clearOrder()	Clear order
int	countSortAttribs()	Count sort attributes
void	doUrlCommand()	Do url command
void	doUrlCommands()	Do url commands
void	flatten()	Flatten
atkAttribute	getAttributeByOrder()	Get attribute by order
atkColumnConfig	&getConfig()	Get an instance of the columnconfig class
string	getDirection()	Get direction
string	getDirectionByOrder()	Get direction by order
int	getMinSort()	Get min sort
atkNode	&getNode()	Get the node
string	getOrder()	Get order
string	getOrderByStatement()	Get orderby statement
array	getOrderFields()	Get order fields
string	getSortDirection()	Get sort direction
string	getUrlCommand()	Get url command
string	getUrlCommandParams()	Get url command params
bool	hasSubTotal()	Has subtotal?
bool	hasSubTotalByOrder()	Has subtotal by order?
bool	hasSubTotals()	Has subtotals?
void	hideCol()	Hide a column
void	init()	Initialize
bool	isFirst()	Is this attribute first?
bool	isLast()	Is this attribute last?
void	moveLeft()	Move left
void	moveRight()	Move right
void	setNode()	Set the node
void	setSortDirection()	Set sort direction
void	setSortOrder()	Set sort order
void	setSubTotal()	Set subtotal
void	showCol()	Show a column
array	subtotalColumns()	Get the subtotal columns
bool	totalizable()	Totalizable?
array	totalizableColumns()	Get the totalizable columns
void	_addOrderByStatement()	Add orderby statement
int	_compareSortAttrs()	Compare sortorder of two attributes

[ Top ]

Properties

mixed $m_colcfg = array() [line 38]

[ Top ]

mixed $m_custom_atkorderby [line 41]

[ Top ]

mixed $m_node = NULL [line 39]

[ Top ]

mixed $m_orderbyindex = 0 [line 40]

[ Top ]

Methods

Constructor atkColumnConfig [line 48]

atkColumnConfig atkColumnConfig(
)

Constructor

[ Top ]

addOrderByField [line 236]

void addOrderByField(
string
$field, string
$direction, [string
$extra = ""], [string
$sortorder = NULL] 
)

Add orderby field

Parameters:

string	$field:
string	$direction:
string	$extra:
string	$sortorder:

[ Top ]

clearOrder [line 494]

void clearOrder(
)

Clear order

[ Top ]

countSortAttribs [line 465]

int countSortAttribs(
)

Count sort attributes

[ Top ]

doUrlCommand [line 370]

void doUrlCommand(
array
$cmd 
)

Do url command

Parameters:

array

$cmd:

[ Top ]

doUrlCommands [line 395]

void doUrlCommands(
)

Do url commands

[ Top ]

flatten [line 258]

void flatten(
)

Flatten

[ Top ]

getAttributeByOrder [line 448]

atkAttribute getAttributeByOrder(
int
$order 
)

Get attribute by order

Parameters:

int

$order:

[ Top ]

getConfig [line 81]

atkColumnConfig &getConfig(

&$node, [string
$id = null], [boolean
$forceNew = false], atkNode
$node 
)

Get an instance of the columnconfig class

Parameters:

atkNode	$node:
string	$id:
boolean	$forceNew:	force new instance?
	&$node:

API Tags:

Return:

An instance of the columnconfig class

[ Top ]

getDirection [line 437]

string getDirection(
string
$attribute 
)

Get direction

Parameters:

string

$attribute:

[ Top ]

getDirectionByOrder [line 481]

string getDirectionByOrder(
int
$order 
)

Get direction by order

Parameters:

int

$order:

[ Top ]

getMinSort [line 278]

int getMinSort(
)

Get min sort

[ Top ]

getNode [line 67]

atkNode &getNode(
)

Get the node

API Tags:

Return:

The node

[ Top ]

getOrder [line 426]

string getOrder(
string
$attribute 
)

Get order

Parameters:

string

$attribute:

[ Top ]

getOrderByStatement [line 296]

string getOrderByStatement(
)

Get orderby statement

API Tags:

Return:

Orderby statement

[ Top ]

getOrderFields [line 317]

array getOrderFields(
)

Get order fields

[ Top ]

getSortDirection [line 336]

string getSortDirection(
string
$attribute 
)

Get sort direction

Parameters:

string

$attribute:

API Tags:

Return:

The sort direction

[ Top ]

getUrlCommand [line 348]

string getUrlCommand(
string
$attribute, string
$command 
)

Get url command

Parameters:

string	$attribute:
string	$command:

[ Top ]

getUrlCommandParams [line 360]

string getUrlCommandParams(
string
$attribute, string
$command 
)

Get url command params

Parameters:

string	$attribute:
string	$command:

[ Top ]

hasSubTotal [line 519]

bool hasSubTotal(
string
$attribute 
)

Has subtotal?

Parameters:

string

$attribute:

API Tags:

Return:

True or false

[ Top ]

hasSubTotalByOrder [line 530]

bool hasSubTotalByOrder(
int
$order 
)

Has subtotal by order?

Parameters:

int

$order:

API Tags:

Return:

True or false

[ Top ]

hasSubTotals [line 504]

bool hasSubTotals(
)

Has subtotals?

API Tags:

Return:

True or false

[ Top ]

hideCol [line 184]

void hideCol(
string
$attribute 
)

Hide a column

Parameters:

string

$attribute:

[ Top ]

init [line 166]

void init(
)

Initialize

[ Top ]

isFirst [line 137]

bool isFirst(
string
$attribute 
)

Is this attribute first?

Parameters:

string

$attribute:

API Tags:

Return:

False

[ Top ]

isLast [line 126]

bool isLast(
string
$attribute 
)

Is this attribute last?

Parameters:

string

$attribute:

API Tags:

Return:

False

[ Top ]

moveLeft [line 147]

void moveLeft(
string
$attribute 
)

Move left

Parameters:

string

$attribute:

[ Top ]

moveRight [line 157]

void moveRight(
string
$attribute 
)

Move right

Parameters:

string

$attribute:

[ Top ]

setNode [line 57]

void setNode(

&$node, atkNode
$node 
)

Set the node

Parameters:

atkNode	$node:
	&$node:

[ Top ]

setSortDirection [line 205]

void setSortDirection(
string
$attribute, string
$direction 
)

Set sort direction

Parameters:

string	$attribute:
string	$direction:

[ Top ]

setSortOrder [line 216]

void setSortOrder(
string
$attribute, string
$value 
)

Set sort order

Parameters:

string	$attribute:
string	$value:

[ Top ]

setSubTotal [line 545]

void setSubTotal(
string
$attribute, bool
$active 
)

Set subtotal

Parameters:

string	$attribute:
bool	$active:

[ Top ]

showCol [line 194]

void showCol(
string
$attribute 
)

Show a column

Parameters:

string

$attribute:

[ Top ]

subtotalColumns [line 598]

array subtotalColumns(
)

Get the subtotal columns

[ Top ]

totalizable [line 567]

bool totalizable(
)

Totalizable?

API Tags:

Return:

True or false

[ Top ]

totalizableColumns [line 582]

array totalizableColumns(
)

Get the totalizable columns

[ Top ]

_addOrderByStatement [line 613]

void _addOrderByStatement(
string
$orderby 
)

Add orderby statement

Parameters:

string

$orderby:

[ Top ]

_compareSortAttrs [line 557]

int _compareSortAttrs(
array
$a, array
$b 
)

Compare sortorder of two attributes

Parameters:

array	$a:
array	$b:

[ Top ]