Docs For Class Bvb_Grid_Mass

Description

LICENSE

This source file is subject to the new BSD license It is available through the world-wide-web at this URL: http://www.petala-azul.com/bsd.txt If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to geral@petala-azul.com so we can send you a copy immediately.

author: Bento Vilas Boas <geral@petala-azul.com>
version: $Id: Actions.php 1653 2011-03-20 22:15:09Z bento.vilas.boas@gmail.com $
copyright: 2010 ZFDatagrid
link: http://zfdatagrid.com
license: New BSD License

Located in /Grid/Mass/Actions.php (line 20)

Variable Summary

string|bool $_decorator

array $_fields

array $_massActions

string $_multipleFieldsSeparator

string $_recordSeparator

string $_submitAttributes

Method Summary

Bvb_Grid addMassAction (type $url, type $caption, [type $confirm = ''])

Bvb_Grid addMassActions ( $options)

Bvb_Grid clearMassActions ()

string getDecorator ()

array getFields ()

array getMassActionsOptions ()

string getMassActionsSeparator ()

string getMultipleFieldsSeparator ()

string getRecordSeparator ()

array getSumitAttributes ()

bool hasMassActions ()

string setDecorator (string $value)

Bvb_Grid setFields (mixed $fields)

Bvb_Grid setMassAction (type $url, type $caption, [type $confirm = ''], type $fields)

Bvb_Grid setMassActions ( $options)

Bvb_Grid setMassActionsSeparator (string $separator)

Bvb_Grid setMultipleFieldsSeparator (string $separator)

Bvb_Grid_Mass_Actions setSubmitAttributes ( $attributes)

Variables

string|bool $_decorator = false (line 48)

access: protected

array $_fields = array() (line 33)

Columns that should be return when submiting the form

access: protected

array $_massActions = array() (line 27)

Mass Actions

access: protected

string $_multipleFieldsSeparator = '-' (line 43)

The defaulf separator for multiple fields values

access: protected

string $_recordSeparator = ',' (line 38)

The defaulf separator for mass actions post values

access: protected

string $_submitAttributes = array() (line 53)

access: protected

Methods

addMassAction (line 134)

Adds a new mass action

access: public

Bvb_Grid addMassAction (type $url, type $caption, [type $confirm = ''])

type $url: Url to post the results
type $caption: Caption for the select option
type $confirm: Confirmation message when submiting

addMassActions (line 150)

Adds a new mass action option

access: public

Bvb_Grid addMassActions ( $options)

array $options: Options to be made available to user

clearMassActions (line 100)

Clears all mass actions previously defined

access: public

Bvb_Grid clearMassActions ()

getDecorator (line 239)

Returns current decorator

access: public

string getDecorator ()

getFields (line 260)

Returns current fields

access: public

array getFields ()

getMassActionsOptions (line 70)

Returns the active mass options

access: public

array getMassActionsOptions ()

getMassActionsSeparator (line 229)

Returns the current Mass Action separator for post values

access: public

string getMassActionsSeparator ()

getMultipleFieldsSeparator (line 200)

Returns the current Mass Action separator for multiple fields

access: public

string getMultipleFieldsSeparator ()

getRecordSeparator (line 270)

Returns current separator

access: public

string getRecordSeparator ()

getSumitAttributes (line 293)

Returns current attributes for submit button for mass actions

access: public

array getSumitAttributes ()

hasMassActions (line 60)

Checks if there are any mass actions registered

access: public

bool hasMassActions ()

setDecorator (line 250)

Set's decorator

access: public

string setDecorator (string $value)

string $value

setFields (line 169)

Defines which fields should be posted.

access: public

Bvb_Grid setFields (mixed $fields)

mixed $fields: Fields to be used as post ids

setMassAction (line 116)

Adds a new mass action and clears all previous

access: public

Bvb_Grid setMassAction (type $url, type $caption, [type $confirm = ''], type $fields)

type $url: Url to post the results
type $caption: Caption for the select option
type $confirm: Confirmation message when submiting
type $fields: Fields to be used

setMassActions (line 86)

Defines mass actions, overriden any previous

access: public

Bvb_Grid setMassActions ( $options)

array $options: Options to be made available to user

setMassActionsSeparator (line 212)

Defines the separator for primary keys or fields for mass actions post values

access: public

Bvb_Grid setMassActionsSeparator (string $separator)

string $separator: Separator to be used in post fields

setMultipleFieldsSeparator (line 183)

Defines the separator for multiple primary keys or fields for mass actions post values

access: public

Bvb_Grid setMultipleFieldsSeparator (string $separator)

string $separator: Separator to be used

setSubmitAttributes (line 282)

Defines attributes to be applyied to submit input for mass actions

access: public

Bvb_Grid_Mass_Actions setSubmitAttributes ( $attributes)

array $attributes

Class Bvb_Grid_Mass_Actions