PHP Class Mgallegos\LaravelJqgrid\Renders\JqGridRender

Inheritance: implements Mgallegos\LaravelJqgrid\Renders\RenderInterface
Datei anzeigen Open project: mgallegos/laravel-jqgrid

Protected Properties

Property Type Description
$clearButton boolean Clear button
$clearButtonText boolean Clear button Text
$colModel array Columns model array
$colModelValidators array PropertyValidatorInterface array
$defaultColModelProperties array Default column model properties array
$defaultExportButtonsOptions array Default Export Buttons Options
$defaultFileProperties array Laravel Excel Default File Properties
$defaultFilterToolbarButtonsOptions array Default filter toolbar button options
$defaultGridOptions array Default grid options array
$defaultGroupHeaderOptions array Default group header options array
$defaultNavigatorOptions array Default navigator options
$defaultPivotGridOptions array Default pivot grid options array
$defaultSheetProperties array Laravel Excel Default Sheet Properties
$defaultfilterToolbarOptions array Default filter toolbar options
$exportButtonsOptions array Filter toolbar button options array
$exportButtonsVisible boolean Check on exist visible export button(s)
$fileProperties array Laravel Excel File Properties
$filterToolbar boolean Filter toolbar
$filterToolbarButtonsOptions array Filter toolbar button options array
$filterToolbarOptions array Filter toolbar options array
$filterToolbarValidators array PropertyValidatorInterface array
$frozenColumn boolean Frozen columns
$functionTypeProperties array Array of JqGrid function type properties
$gridId string Grid ID
$groupHeaderOptions array Group Header options array
$groupHeaderOptionsNames array Group header options names array
$jqPivot boolean Pivot Grid
$navigatorAddOptions array Navigator add options array
$navigatorDeleteOptions array Navigator delete options array
$navigatorEditOptions array Navigator edit options array
$navigatorOptions array Navigator options array
$navigatorSearchOptions array Navigator search options array
$navigatorValidators array PropertyValidatorInterface array
$navigatorViewOptions array Navigator view options array
$optionValidators array PropertyValidatorInterface array
$options array Options array
$pivotOptions array Options array
$pivotOptionsNames array Pivot options names array
$sheetProperties array Laravel Excel Sheet Properties
$toggleButton boolean Toggle button
$toggleButtonText boolean Toggle button Text
$token string Session token

Public Methods

Method Description
__construct ( array $optionValidators = [], array $colModelValidators = [], array $navigatorValidators = [], array $filterToolbarValidators = [], array $defaultGridOptions = [], array $defaultPivotGridOptions = [], array $defaultGroupHeaderOptions = [], array $defaultColModelProperties = [], array $defaultNavigatorOptions = [], array $defaultfilterToolbarOptions = [], array $defaultFilterToolbarButtonsOptions = [], array $defaultExportButtonsOptions = [], array $defaultFileProperties = [], array $defaultSheetProperties = [], array $functionTypeProperties = [], array $pivotOptionsNames = [], array $groupHeaderOptionsNames = [], $token ) Create a new JqGridRender instance.
addAggregate ( array $properties = [] ) Add an aggregate. Use this method only when working with pivot grids.
addColumn ( array $properties = [] ) Add a column at the last position in the columns model.
addExport ( array $properties = [] )
addGroupHeader ( array $properties = [] ) Add a group header. This are columns that can be added above the normal grid columns.
addXDimension ( array $properties = [] ) Add a X dimension. Use this method only when working with pivot grids.
addYDimension ( array $properties = [] ) Add a Y dimension. Use this method only when working with pivot grids.
enableFilterToolbar ( boolean $createToggleButton = null, boolean $createClearButton = null ) Enable filter toolbar.
hideCsvExporter ( ) Hide csv Navigator button.
hideXlsExporter ( ) Hide XLS Navigator button.
renderGrid ( boolean $script = true, boolean $createTableElement = true, boolean $createPagerElement = true, boolean $echo = true ) : mixed Main method that construct the html and javascript code of the grid.
setFileProperty ( string $option, $value ) Set a Laravel Excel file property.
setFilterToolbarEvent ( string $event, string $code ) Set a toolbar event.
setFilterToolbarOptions ( array $options ) Set options for the toolbar filter when enabled. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:toolbar_searching
setGridAsPivot ( ) When this method is called the grid will be treated as Pivot Grid (differents javascript methods are used to generate the grid) according to the official documentation. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotdescription.
setGridEvent ( string $event, string $code ) Set a jqGrid event.
setGridId ( string $id = null ) Add a column at the last position in the columns model.
setGridOption ( string $option, $value ) Set a jqGrid option.
setNavigatorEvent ( string $module, string $event, string $code ) Set an event in the navigator or in the diffrent modules add,edit,del,view, search. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:navigator
setNavigatorOptions ( string $module, array $options ) Set options in the navigator or in any of the following modules add,edit,del,view, search. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:navigator
setSheetProperty ( string $option, $value ) Set a Laravel Excel sheet property.

Protected Methods

Method Description
getJavascriptExportFunctionCode ( string $exportFormat ) : void Get exporter's javascript code.
markFunctionTypeProperty ( array &$properties ) : void Mark function type properties.
reset ( ) : void Reset variables to their original state.

Method Details

__construct() public method

Create a new JqGridRender instance.
public __construct ( array $optionValidators = [], array $colModelValidators = [], array $navigatorValidators = [], array $filterToolbarValidators = [], array $defaultGridOptions = [], array $defaultPivotGridOptions = [], array $defaultGroupHeaderOptions = [], array $defaultColModelProperties = [], array $defaultNavigatorOptions = [], array $defaultfilterToolbarOptions = [], array $defaultFilterToolbarButtonsOptions = [], array $defaultExportButtonsOptions = [], array $defaultFileProperties = [], array $defaultSheetProperties = [], array $functionTypeProperties = [], array $pivotOptionsNames = [], array $groupHeaderOptionsNames = [], $token )
$optionValidators array
$colModelValidators array
$navigatorValidators array
$filterToolbarValidators array
$defaultGridOptions array
$defaultPivotGridOptions array
$defaultGroupHeaderOptions array
$defaultColModelProperties array
$defaultNavigatorOptions array
$defaultfilterToolbarOptions array
$defaultFilterToolbarButtonsOptions array
$defaultExportButtonsOptions array
$defaultFileProperties array
$defaultSheetProperties array
$functionTypeProperties array
$pivotOptionsNames array
$groupHeaderOptionsNames array

addAggregate() public method

Add an aggregate. Use this method only when working with pivot grids.
public addAggregate ( array $properties = [] )
$properties array An array of valid aggregate options (all jqGrid column model property can be used). Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings

addColumn() public method

Add a column at the last position in the columns model.
public addColumn ( array $properties = [] )
$properties array An array of valid jqGrid column model property, the index key of the array must correspond to a column model property. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:colmodel_options

addExport() public method

public addExport ( array $properties = [] )
$properties array

addGroupHeader() public method

This method has no effect when working with pivot grid.
public addGroupHeader ( array $properties = [] )
$properties array An array of valid group header options. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:groupingheadar

addXDimension() public method

Add a X dimension. Use this method only when working with pivot grids.
public addXDimension ( array $properties = [] )
$properties array An array of valid xDimension options. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings

addYDimension() public method

Add a Y dimension. Use this method only when working with pivot grids.
public addYDimension ( array $properties = [] )
$properties array An array of valid yDimension options. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings

enableFilterToolbar() public method

Enable filter toolbar.
public enableFilterToolbar ( boolean $createToggleButton = null, boolean $createClearButton = null )
$createToggleButton boolean If true a toggle button will be created in the navigator. Default is null
$createClearButton boolean If true a clear button will be created in the navigator. Default is null

getJavascriptExportFunctionCode() protected method

Get exporter's javascript code.
protected getJavascriptExportFunctionCode ( string $exportFormat ) : void
$exportFormat string
return void

hideCsvExporter() public method

Hide csv Navigator button.
public hideCsvExporter ( )

hideXlsExporter() public method

Hide XLS Navigator button.
public hideXlsExporter ( )

markFunctionTypeProperty() protected method

First and last quotes will be removed from the javascript code to all properties marked by this method
protected markFunctionTypeProperty ( array &$properties ) : void
$properties array An array of valid jqGrid column model property, the key of the array must correspond to a column model property.
return void

renderGrid() public method

Main method that construct the html and javascript code of the grid.
public renderGrid ( boolean $script = true, boolean $createTableElement = true, boolean $createPagerElement = true, boolean $echo = true ) : mixed
$script boolean If true javascript tags will be included within the output. Default is true
$createTableElement boolean If true the table element is created automatically from this method. Default is true
$createPagerElement boolean If true the pager element is created automatically from this method. Default is true
$echo boolean If false the function return the string representing the grid. Default is true
return mixed String if $echo is set to false, void in any other case

reset() protected method

Reset variables to their original state.
protected reset ( ) : void
return void

setFileProperty() public method

Set a Laravel Excel file property.
public setFileProperty ( string $option, $value )
$option string A valid Laravel Excel file property, online documentation available at http://www.maatwebsite.nl/laravel-excel/docs/reference-guide

setFilterToolbarEvent() public method

Set a toolbar event.
public setFilterToolbarEvent ( string $event, string $code )
$event string Valid toolbar grid event, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:toolbar_searching
$code string Javascript code which will be executed when the event raises

setFilterToolbarOptions() public method

Set options for the toolbar filter when enabled. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:toolbar_searching
public setFilterToolbarOptions ( array $options )
$options array Options that are applicable to the filter toolbar

setGridAsPivot() public method

When this method is called the grid will be treated as Pivot Grid (differents javascript methods are used to generate the grid) according to the official documentation. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotdescription.
public setGridAsPivot ( )

setGridEvent() public method

Set a jqGrid event.
public setGridEvent ( string $event, string $code )
$event string Valid grid event, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:events&s[]=event
$code string Javascript code which will be executed when the event raises

setGridId() public method

Add a column at the last position in the columns model.
public setGridId ( string $id = null )
$id string

setGridOption() public method

Set a jqGrid option.
public setGridOption ( string $option, $value )
$option string A valid jqGrid option, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:options or a valid pivot grid option, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings a valid group header option, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:groupingheadar

setNavigatorEvent() public method

Set an event in the navigator or in the diffrent modules add,edit,del,view, search. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:navigator
public setNavigatorEvent ( string $module, string $event, string $code )
$module string Can be navigator, edit, add, del, search, view.
$event string Valid event for the particular module
$code string Javascript code which will be executed when the event raises

setNavigatorOptions() public method

Set options in the navigator or in any of the following modules add,edit,del,view, search. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:navigator
public setNavigatorOptions ( string $module, array $options )
$module string Can be navigator, add, edit, del, view, search.
$options array Options that are applicable to this module The key correspond to the options in jqGrid

setSheetProperty() public method

Set a Laravel Excel sheet property.
public setSheetProperty ( string $option, $value )
$option string A valid Laravel Excel sheet property, online documentation available at http://www.maatwebsite.nl/laravel-excel/docs/reference-guide

Property Details

$clearButton protected_oe property

Clear button
protected bool $clearButton
return boolean

$clearButtonText protected_oe property

Clear button Text
protected bool $clearButtonText
return boolean

$colModel protected_oe property

Columns model array
protected array $colModel
return array

$colModelValidators protected_oe property

PropertyValidatorInterface array
protected array $colModelValidators
return array

$defaultColModelProperties protected_oe property

Default column model properties array
protected array $defaultColModelProperties
return array

$defaultExportButtonsOptions protected_oe property

Default Export Buttons Options
protected array $defaultExportButtonsOptions
return array

$defaultFileProperties protected_oe property

Laravel Excel Default File Properties
protected array $defaultFileProperties
return array

$defaultFilterToolbarButtonsOptions protected_oe property

Default filter toolbar button options
protected array $defaultFilterToolbarButtonsOptions
return array

$defaultGridOptions protected_oe property

Default grid options array
protected array $defaultGridOptions
return array

$defaultGroupHeaderOptions protected_oe property

Default group header options array
protected array $defaultGroupHeaderOptions
return array

$defaultNavigatorOptions protected_oe property

Default navigator options
protected array $defaultNavigatorOptions
return array

$defaultPivotGridOptions protected_oe property

Default pivot grid options array
protected array $defaultPivotGridOptions
return array

$defaultSheetProperties protected_oe property

Laravel Excel Default Sheet Properties
protected array $defaultSheetProperties
return array

$defaultfilterToolbarOptions protected_oe property

Default filter toolbar options
protected array $defaultfilterToolbarOptions
return array

$exportButtonsOptions protected_oe property

Filter toolbar button options array
protected array $exportButtonsOptions
return array

$exportButtonsVisible protected_oe property

Check on exist visible export button(s)
protected bool $exportButtonsVisible
return boolean

$fileProperties protected_oe property

Laravel Excel File Properties
protected array $fileProperties
return array

$filterToolbar protected_oe property

Filter toolbar
protected bool $filterToolbar
return boolean

$filterToolbarButtonsOptions protected_oe property

Filter toolbar button options array
protected array $filterToolbarButtonsOptions
return array

$filterToolbarOptions protected_oe property

Filter toolbar options array
protected array $filterToolbarOptions
return array

$filterToolbarValidators protected_oe property

PropertyValidatorInterface array
protected array $filterToolbarValidators
return array

$frozenColumn protected_oe property

Frozen columns
protected bool $frozenColumn
return boolean

$functionTypeProperties protected_oe property

Array of JqGrid function type properties
protected array $functionTypeProperties
return array

$gridId protected_oe property

Grid ID
protected string $gridId
return string

$groupHeaderOptions protected_oe property

Group Header options array
protected array $groupHeaderOptions
return array

$groupHeaderOptionsNames protected_oe property

Group header options names array
protected array $groupHeaderOptionsNames
return array

$jqPivot protected_oe property

Pivot Grid
protected bool $jqPivot
return boolean

$navigatorAddOptions protected_oe property

Navigator add options array
protected array $navigatorAddOptions
return array

$navigatorDeleteOptions protected_oe property

Navigator delete options array
protected array $navigatorDeleteOptions
return array

$navigatorEditOptions protected_oe property

Navigator edit options array
protected array $navigatorEditOptions
return array

$navigatorOptions protected_oe property

Navigator options array
protected array $navigatorOptions
return array

$navigatorSearchOptions protected_oe property

Navigator search options array
protected array $navigatorSearchOptions
return array

$navigatorValidators protected_oe property

PropertyValidatorInterface array
protected array $navigatorValidators
return array

$navigatorViewOptions protected_oe property

Navigator view options array
protected array $navigatorViewOptions
return array

$optionValidators protected_oe property

PropertyValidatorInterface array
protected array $optionValidators
return array

$options protected_oe property

Options array
protected array $options
return array

$pivotOptions protected_oe property

Options array
protected array $pivotOptions
return array

$pivotOptionsNames protected_oe property

Pivot options names array
protected array $pivotOptionsNames
return array

$sheetProperties protected_oe property

Laravel Excel Sheet Properties
protected array $sheetProperties
return array

$toggleButton protected_oe property

Toggle button
protected bool $toggleButton
return boolean

$toggleButtonText protected_oe property

Toggle button Text
protected bool $toggleButtonText
return boolean

$token protected_oe property

Session token
protected string $token
return string