PHP Class Ip\Internal\Grid\Model\Config

Show file Open project: impresspages/impresspages

Protected Properties

Property	Type	Description
$config	Config
$configChecked
$fieldObjects	Ip\Internal\Grid\Model\Field[]
$multilingual

Public Methods

Method	Description
__construct ( $config )
actions ( )
actionsFilter ( ) : string
afterCreate ( )
afterDelete ( )
afterMove ( )
afterUpdate ( )
allowCreate ( )
allowDelete ( )
allowSearch ( )
allowSort ( )
allowUpdate ( )
beforeCreate ( )
beforeDelete ( )
beforeMove ( )
beforeUpdate ( )
connectionField ( ) : string	Get field name responsible for connection of subgrid to the parent grid.
createFilter ( )
createFormFilter ( )
createLanguageFilter ( )
createPosition ( )
deleteWarning ( )
fieldObject ( $field ) : Ip\Internal\Grid\Model\Field
fields ( )
filter ( ) : string	Get sql part to be used in where clause
getBreadcrumbField ( )
getField ( $fieldName )
getTitle ( )
idField ( )
isMultilingual ( )
joinQuery ( )
languageCodeField ( )
languageForeignKeyField ( )
languageTableName ( )
layout ( )
orderBy ( $statusVariables )
orderDirection ( $statusVariables )
orderField ( $statusVariables )
pageSize ( $statusVariables )
pageVariableName ( )
pagerSize ( )
preventAction ( )
rawLanguageTableName ( )
rawTableName ( )
selectFields ( )
sortDirection ( )
sortField ( )
subgridConfig ( $statusVariables, $depthLimit = null ) : Config	Return nested grid config object
tableName ( )
updateFilter ( )
updateFormFilter ( )
updateLanguageFilter ( )

Protected Methods

Method	Description
checkConfig ( &$config, integer $depth = 1, array $gridBreadcrumb = [] )
getTableFields ( $tableName, $languageTable )

Method Details

__construct() public method

public __construct ( $config )

actions() public method

public actions ( )

actionsFilter() public method

public actionsFilter ( ) : string
return	string

afterCreate() public method

public afterCreate ( )

afterDelete() public method

public afterDelete ( )

afterMove() public method

public afterMove ( )

afterUpdate() public method

public afterUpdate ( )

allowCreate() public method

public allowCreate ( )

allowDelete() public method

public allowDelete ( )

allowSearch() public method

public allowSearch ( )

allowSort() public method

public allowSort ( )

allowUpdate() public method

public allowUpdate ( )

beforeCreate() public method

public beforeCreate ( )

beforeDelete() public method

public beforeDelete ( )

beforeMove() public method

public beforeMove ( )

beforeUpdate() public method

public beforeUpdate ( )

checkConfig() protected method

protected checkConfig ( &$config, integer $depth = 1, array $gridBreadcrumb = [] )
$depth	integer
$gridBreadcrumb	array	//to detect loop

connectionField() public method

You can think of it as a foreign key in SQL

public connectionField ( ) : string
return	string

createFilter() public method

public createFilter ( )

createFormFilter() public method

public createFormFilter ( )

createLanguageFilter() public method

public createLanguageFilter ( )

createPosition() public method

public createPosition ( )

deleteWarning() public method

public deleteWarning ( )

fieldObject() public method

public fieldObject ( $field ) : Ip\Internal\Grid\Model\Field
$field
return	Ip\Internal\Grid\Model\Field

fields() public method

public fields ( )

filter() public method

Get sql part to be used in where clause

public filter ( ) : string
return	string

getBreadcrumbField() public method

public getBreadcrumbField ( )

getField() public method

public getField ( $fieldName )

getTableFields() protected method

protected getTableFields ( $tableName, $languageTable )

getTitle() public method

public getTitle ( )

idField() public method

public idField ( )

isMultilingual() public method

public isMultilingual ( )

joinQuery() public method

public joinQuery ( )

languageCodeField() public method

public languageCodeField ( )

languageForeignKeyField() public method

public languageForeignKeyField ( )

languageTableName() public method

public languageTableName ( )

layout() public method

public layout ( )

orderBy() public method

public orderBy ( $statusVariables )

orderDirection() public method

public orderDirection ( $statusVariables )

orderField() public method

public orderField ( $statusVariables )

pageSize() public method

public pageSize ( $statusVariables )

pageVariableName() public method

public pageVariableName ( )

pagerSize() public method

public pagerSize ( )

preventAction() public method

public preventAction ( )

rawLanguageTableName() public method

public rawLanguageTableName ( )

rawTableName() public method

public rawTableName ( )

selectFields() public method

public selectFields ( )

sortDirection() public method

public sortDirection ( )

sortField() public method

public sortField ( )

subgridConfig() public method

Return nested grid config object

public subgridConfig ( $statusVariables, $depthLimit = null ) : Config
$statusVariables
return	Config

tableName() public method

public tableName ( )

updateFilter() public method

public updateFilter ( )

updateFormFilter() public method

public updateFormFilter ( )

updateLanguageFilter() public method

public updateLanguageFilter ( )

Property Details

$config protected property

protected Config,Ip\Internal\Grid\Model $config
return	Config

$configChecked protected property

protected $configChecked

$fieldObjects protected property

protected Field[],Ip\Internal\Grid\Model $fieldObjects
return	Ip\Internal\Grid\Model\Field[]

$multilingual protected property

protected $multilingual