TbBulkActions Class Reference

Public Member Functions
	getId ($autoGenerate=true)
	__construct ($grid)
	init ()
	initColumn ()
	initButtons ()
	renderButtons ()
	registerClientScript ()

Public Attributes
	$grid
	$actionButtons = array()
	$checkBoxColumnConfig = array()
	$noCheckedMessage = 'No items are checked'
	$align = 'right'

Protected Member Functions
	renderButton ($actionButton)
	attachCheckBoxColumn ()

Protected Attributes
	$columnName
	$buttons = array()
	$events = array()

Private Member Functions
	convertToTbButtonConfig ($action)

Private Attributes
	$_id

Static Private Attributes
static	$_counter = 0

Detailed Description

Definition at line 18 of file TbBulkActions.php.

Constructor & Destructor Documentation

TbBulkActions::__construct

(

$grid

)

.__construct()

Constructor.

Parameters

CGridView

$grid

the grid view that owns this column.

Definition at line 113 of file TbBulkActions.php.

Member Function Documentation

TbBulkActions::attachCheckBoxColumn ( )

protected

.attachCheckBoxColumn()

Adds a checkbox column to the grid. It is called when

Definition at line 271 of file TbBulkActions.php.

Here is the caller graph for this function:

TbBulkActions::convertToTbButtonConfig (   $action )

private

Parameters

$action

Returns

array

Exceptions

CException

Definition at line 318 of file TbBulkActions.php.

Here is the caller graph for this function:

TbBulkActions::getId

(

$autoGenerate = true

)

.getId()

Returns the ID of the widget or generates a new one if requested.

Parameters

boolean

$autoGenerate

whether to generate an ID if it is not set previously

Returns

string id of the widget.

Definition at line 80 of file TbBulkActions.php.

Here is the caller graph for this function:

TbBulkActions::init

(

)

.init()

Component's initialization method

Definition at line 123 of file TbBulkActions.php.

Here is the call graph for this function:

TbBulkActions::initButtons

(

)

.initButtons()

initializes the buttons to be render

Definition at line 173 of file TbBulkActions.php.

Here is the call graph for this function:

Here is the caller graph for this function:

TbBulkActions::initColumn

(

)

.initColumn()

Returns

bool checks whether they are

Definition at line 135 of file TbBulkActions.php.

Here is the call graph for this function:

Here is the caller graph for this function:

TbBulkActions::registerClientScript

(

)

.registerClientScript()

Registers client script

Definition at line 214 of file TbBulkActions.php.

Here is the call graph for this function:

Here is the caller graph for this function:

TbBulkActions::renderButton (   $actionButton )

protected

.renderButton()

Creates a TbButton and renders it

Parameters

array

$actionButton

the configuration to create the TbButton

Definition at line 243 of file TbBulkActions.php.

Here is the caller graph for this function:

TbBulkActions::renderButtons

(

)

.renderButtons()

Returns

bool renders all initialized buttons

Definition at line 188 of file TbBulkActions.php.

Here is the call graph for this function:

Member Data Documentation

TbBulkActions::$_counter = 0

staticprivate

Definition at line 64 of file TbBulkActions.php.

TbBulkActions::$_id

private

Definition at line 69 of file TbBulkActions.php.

TbBulkActions::$actionButtons = array()

Definition at line 44 of file TbBulkActions.php.

TbBulkActions::$align = 'right'

Definition at line 59 of file TbBulkActions.php.

TbBulkActions::$buttons = array()

protected

Definition at line 99 of file TbBulkActions.php.

TbBulkActions::$checkBoxColumnConfig = array()

Definition at line 49 of file TbBulkActions.php.

TbBulkActions::$columnName

protected

Definition at line 94 of file TbBulkActions.php.

TbBulkActions::$events = array()

protected

Definition at line 104 of file TbBulkActions.php.

TbBulkActions::$grid

Definition at line 23 of file TbBulkActions.php.

TbBulkActions::$noCheckedMessage = 'No items are checked'

Definition at line 54 of file TbBulkActions.php.

---

The documentation for this class was generated from the following file:

• app/protected/extensions/booster/widgets/TbBulkActions.php