• Página Inicial
• GridHandler

PHP Class GridHandler, pkp-lib

Exibir arquivo Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property	Type	Description
$_actions		Grid actions. The first key represents the position of the action in the grid, the second key represents the action id.
$_columns		The GridColumns of this grid.
$_data		The grid's data source.
$_dataProvider	GridDataProvider
$_emptyRowText		empty row locale key
$_features		The grid features.
$_footNote		Grid foot note locale key
$_itemIterator		The item iterator to be used for paging.
$_template		The grid template.
$_title		grid title locale key
$_urls		The urls that will be used in JS handler.

Public Methods

Method	Description
__construct ( $dataProvider = null )	Constructor.
addAction ( $action, $position = GRID_ACTION_POSITION_ABOVE )	Add an action.
addColumn ( $column )	Add a column.
authorize ( $request, &$args, $roleAssignments, $enforceRestrictedSite = true )
fetchCell ( &$args, $request ) : JSONMessage	Render a cell and send it to the client
fetchGrid ( $args, $request ) : JSONMessage	Render the entire grid controller and send it to the client.
fetchRow ( &$args, $request ) : JSONMessage	Render a row and send it to the client. If the row no longer exists then inform the client.
fetchRows ( $args, $request ) : JSONMessage	Fetch all grid rows from loaded data.
getActions ( $position = GRID_ACTION_POSITION_ABOVE ) : array	Get all actions for a given position within the grid.
getColumn ( $columnId ) : GridColumn	Retrieve a single column by id.
getColumns ( ) : array	Get all columns.
getColumnsByFlag ( $flag ) : array	Get columns by flag.
getColumnsCount ( $flag = null ) : integer	Get columns number. If a flag is passed, the columns using it will not be counted.
getDataElementSequence ( &$gridDataElement ) : integer	Override to return the data element sequence value.
getDataProvider ( ) : FilesGridDataProvider	Get the data provider.
getEmptyRowText ( )	Get the no items locale key
getFeatures ( ) : array	Get all grid attached features.
getFootNote ( ) : string	Get the grid foot note.
getGridDataElements ( $request ) : array	Get the grid data.
getGridRangeInfo ( $request, $rangeName, $contextData = null ) : DBResultRange	Get grid range info.
getIsSubcomponent ( ) : boolean	Override this method to return true if you want to use the grid within another component (e.g. to remove the title or change the layout accordingly).
getItemIterator ( ) : ItemIterator	Get the item iterator that represents this grid data.
getJSHandler ( ) : string	Get the js handler for this component.
getPublishChangeEvents ( ) : array	Get "publish data changed" event list.
getRequestArg ( $key ) : mixed	Get a single grid request parameter.
getRequestArgs ( ) : array	Get the grid request parameters. These are the parameters that uniquely identify the data within a grid.
getRequestedRow ( $request, $args ) : GridRow	Tries to identify the data element in the grids data source that corresponds to the requested row id.
getSelectName ( ) : string	Get the select parameter name to store the selected files.
getTemplate ( ) : string	Get the grid template.
getTitle ( ) : string	Get the grid title.
getUrls ( ) : array	Return all grid urls that will be used in JS handler.
hasColumn ( $columnId ) : boolean	Checks whether a column exists.
hasGridDataElements ( $request ) : boolean	Check whether the grid has rows.
initialize ( $request, $args = null )
isDataElementSelected ( $gridDataElement ) : boolean	Returns the current selection state of the grid data element.
renderRow ( $request, $row ) : string	Render the passed row and return its markup.
saveSequence ( $args, $request ) : JSONMessage	Hook oportunity for grid features to request a save items sequence operation. If no grid feature that implements the saveSequence hook is attached to this grid, this operation will only return the data changed event json message.
setDataElementSequence ( $request, $rowId, &$gridDataElement, $newSequence )	Override to set the data element new sequence.
setEmptyRowText ( $emptyRowText )	Set the no items locale key
setFootNote ( $footNote )	Set the grid foot note.
setGridDataElements ( $data )	Set the grid data.
setTemplate ( $template )	Set the grid template.
setTitle ( $title )	Set the grid title.
setUrls ( $request, $extraUrls = [] )	Define the urls that will be used in JS handler.

Protected Methods

Method	Description
callFeaturesHook ( $hookName, $args )	Call the passed hook in all attached features.
doSpecificFetchGridActions ( $args, $request, $templateMgr )	Override this method if your subclass needs to perform different actions than the ones implemented here.
getDataElementFromRequest ( $request, &$elementId ) : object	Create a data element from a request. This is used to format new rows prior to their insertion or existing rows that have been edited but not saved.
getFilterForm ( ) : Form | string	Returns a Form object or the path name of a filter template.
getFilterSelectionData ( $request ) : array	Method that extracts the user's filter selection from the request either by instantiating the filter's Form object or by reading the request directly (if using a simple filter template only).
getRowDataElement ( $request, &$rowId ) : mixed	Retrieve a single data element from the grid's data source corresponding to the given row id. If none is found then return null.
getRowInstance ( ) : GridRow	Get a new instance of a grid row. May be overridden by subclasses if they want to provide a custom row definition.
getRowsSequence ( $request ) : array	Return the sequence map of the current loaded grid items.
initFeatures ( $request, &$args ) : array	Override to init grid features.
isFilterFormCollapsible ( ) : boolean	Determine whether a filter form should be collapsible.
loadData ( $request, $filter ) : grid	Implement this method to load data into the grid.
noAutocompleteResults ( ) : JSONMessage	Returns a common 'no matches' result when subclasses find no results for AJAX autocomplete requests.
renderFilter ( $request, $filterData = [] ) : string	Render the filter (a template or a Form).
renderGridBodyPartsInternally ( Request $request ) : array	Method that renders tbodys to go in the grid main body.
renderRowInternally ( $request, $row ) : string	Method that renders a single row.
renderRowsInternally ( $request, &$elements ) : array	Cycle through the data and get generate the row HTML.
setFirstDataColumn ( )	Define the first column that will contain grid data.

Private Methods

Method	Description
_addFeatures ( $features )	Add grid features.
_fixColumnWidths ( )	Method that grabs all the existing columns and makes sure the column widths add to exactly 100 N.B. We do some extra column fetching because PHP makes copies of arrays with foreach.
_getInitializedRowInstance ( $request, $elementId, &$element, $isModified = false ) : GridRow	Instantiate a new row.
_renderCellInternally ( $request, $row, $column ) : string	Method that renders a cell.

Method Details

Property Details