PHP 클래스 Mgallegos\LaravelJqgrid\Renders\JqGridRender

상속: implements Mgallegos\LaravelJqgrid\Renders\RenderInterface
파일 보기 프로젝트 열기: mgallegos/laravel-jqgrid

보호된 프로퍼티들

프로퍼티 타입 설명
$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