PHP Класс Mgallegos\LaravelJqgrid\Renders\JqGridRender

Наследование: implements Mgallegos\LaravelJqgrid\Renders\RenderInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
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.

Описание методов

__construct() публичный Метод

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() публичный Метод

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() публичный Метод

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 addExport ( array $properties = [] )
$properties array

addGroupHeader() публичный Метод

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() публичный Метод

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() публичный Метод

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() публичный Метод

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() защищенный Метод

Get exporter's javascript code.
protected getJavascriptExportFunctionCode ( string $exportFormat ) : void
$exportFormat string
Результат void

hideCsvExporter() публичный Метод

Hide csv Navigator button.
public hideCsvExporter ( )

hideXlsExporter() публичный Метод

Hide XLS Navigator button.
public hideXlsExporter ( )

markFunctionTypeProperty() защищенный Метод

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.
Результат void

renderGrid() публичный Метод

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
Результат mixed String if $echo is set to false, void in any other case

reset() защищенный Метод

Reset variables to their original state.
protected reset ( ) : void
Результат void

setFileProperty() публичный Метод

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() публичный Метод

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() публичный Метод

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() публичный Метод

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() публичный Метод

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() публичный Метод

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

setGridOption() публичный Метод

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() публичный Метод

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() публичный Метод

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() публичный Метод

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

Описание свойств

$clearButton защищенное свойство

Clear button
protected bool $clearButton
Результат boolean

$clearButtonText защищенное свойство

Clear button Text
protected bool $clearButtonText
Результат boolean

$colModel защищенное свойство

Columns model array
protected array $colModel
Результат array

$colModelValidators защищенное свойство

PropertyValidatorInterface array
protected array $colModelValidators
Результат array

$defaultColModelProperties защищенное свойство

Default column model properties array
protected array $defaultColModelProperties
Результат array

$defaultExportButtonsOptions защищенное свойство

Default Export Buttons Options
protected array $defaultExportButtonsOptions
Результат array

$defaultFileProperties защищенное свойство

Laravel Excel Default File Properties
protected array $defaultFileProperties
Результат array

$defaultFilterToolbarButtonsOptions защищенное свойство

Default filter toolbar button options
protected array $defaultFilterToolbarButtonsOptions
Результат array

$defaultGridOptions защищенное свойство

Default grid options array
protected array $defaultGridOptions
Результат array

$defaultGroupHeaderOptions защищенное свойство

Default group header options array
protected array $defaultGroupHeaderOptions
Результат array

$defaultNavigatorOptions защищенное свойство

Default navigator options
protected array $defaultNavigatorOptions
Результат array

$defaultPivotGridOptions защищенное свойство

Default pivot grid options array
protected array $defaultPivotGridOptions
Результат array

$defaultSheetProperties защищенное свойство

Laravel Excel Default Sheet Properties
protected array $defaultSheetProperties
Результат array

$defaultfilterToolbarOptions защищенное свойство

Default filter toolbar options
protected array $defaultfilterToolbarOptions
Результат array

$exportButtonsOptions защищенное свойство

Filter toolbar button options array
protected array $exportButtonsOptions
Результат array

$exportButtonsVisible защищенное свойство

Check on exist visible export button(s)
protected bool $exportButtonsVisible
Результат boolean

$fileProperties защищенное свойство

Laravel Excel File Properties
protected array $fileProperties
Результат array

$filterToolbar защищенное свойство

Filter toolbar
protected bool $filterToolbar
Результат boolean

$filterToolbarButtonsOptions защищенное свойство

Filter toolbar button options array
protected array $filterToolbarButtonsOptions
Результат array

$filterToolbarOptions защищенное свойство

Filter toolbar options array
protected array $filterToolbarOptions
Результат array

$filterToolbarValidators защищенное свойство

PropertyValidatorInterface array
protected array $filterToolbarValidators
Результат array

$frozenColumn защищенное свойство

Frozen columns
protected bool $frozenColumn
Результат boolean

$functionTypeProperties защищенное свойство

Array of JqGrid function type properties
protected array $functionTypeProperties
Результат array

$gridId защищенное свойство

Grid ID
protected string $gridId
Результат string

$groupHeaderOptions защищенное свойство

Group Header options array
protected array $groupHeaderOptions
Результат array

$groupHeaderOptionsNames защищенное свойство

Group header options names array
protected array $groupHeaderOptionsNames
Результат array

$jqPivot защищенное свойство

Pivot Grid
protected bool $jqPivot
Результат boolean

$navigatorAddOptions защищенное свойство

Navigator add options array
protected array $navigatorAddOptions
Результат array

$navigatorDeleteOptions защищенное свойство

Navigator delete options array
protected array $navigatorDeleteOptions
Результат array

$navigatorEditOptions защищенное свойство

Navigator edit options array
protected array $navigatorEditOptions
Результат array

$navigatorOptions защищенное свойство

Navigator options array
protected array $navigatorOptions
Результат array

$navigatorSearchOptions защищенное свойство

Navigator search options array
protected array $navigatorSearchOptions
Результат array

$navigatorValidators защищенное свойство

PropertyValidatorInterface array
protected array $navigatorValidators
Результат array

$navigatorViewOptions защищенное свойство

Navigator view options array
protected array $navigatorViewOptions
Результат array

$optionValidators защищенное свойство

PropertyValidatorInterface array
protected array $optionValidators
Результат array

$options защищенное свойство

Options array
protected array $options
Результат array

$pivotOptions защищенное свойство

Options array
protected array $pivotOptions
Результат array

$pivotOptionsNames защищенное свойство

Pivot options names array
protected array $pivotOptionsNames
Результат array

$sheetProperties защищенное свойство

Laravel Excel Sheet Properties
protected array $sheetProperties
Результат array

$toggleButton защищенное свойство

Toggle button
protected bool $toggleButton
Результат boolean

$toggleButtonText защищенное свойство

Toggle button Text
protected bool $toggleButtonText
Результат boolean

$token защищенное свойство

Session token
protected string $token
Результат string