Index

  1. \com\setasign\Konquadrat
    1. Grid
      1. Grid
      2. GridConfigReader
      3. GridConfigReaderInterface
      4. GridFactory
      5. GridFactoryInterface
      6. GridFinder
      7. GridInterface
      8. ImportDataGrid
      9. ObjectGrid

com\setasign\Konquadrat\Grid

Grid Interface GridInterface

File: /Konquadrat/src/Grid/Grid.php

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$aliases

protected array<string, string|false> Grid::$aliases

$datasource

protected Grid::$datasource

$gridConfig

protected Grid::$gridConfig

$languageManager

protected Grid::$languageManager

Methods

__construct()

public Grid::__construct (
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Datasource\DatasourceInterface $datasource,
\com\setasign\SetaFramework\Config\Config $gridConfig
)

Grid constructor.

Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$datasource : \com\setasign\Konquadrat\Datasource\DatasourceInterface
 
$gridConfig : \com\setasign\SetaFramework\Config\Config
 

__clone()

public Grid::__clone (
void
): void

addSearch()

public Grid::addSearch (
string $field,
string $comparator,
mixed $value
): void
Parameters
$field : string
 
$comparator : string
 
$value : mixed
 

addSort()

public Grid::addSort (
string $field,
string $direction = 'ASC'
): void
Parameters
$field : string
 
$direction : string
 

createAliasesByColumns()

protected Grid::createAliasesByColumns (
\com\setasign\SetaFramework\Config\Config $columns,
array $allowedFields
): array
Parameters
$columns : \com\setasign\SetaFramework\Config\Config
 
$allowedFields : array
 

deleteRows()

public Grid::deleteRows (
int[] $ids
): void
Parameters
$ids : int[]
 

edit()

public Grid::edit (
int $id,
string $field,
mixed $value,
\com\setasign\Konquadrat\Datasource\IgnoreOldValue|mixed $oldValue
): void
Parameters
$id : int
 
$field : string
 
$value : mixed
 
$oldValue : \com\setasign\Konquadrat\Datasource\IgnoreOldValue|mixed
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

getColumns()

protected Grid::getColumns (
void
): array

getCount()

public Grid::getCount (
void
): int

getData()

public Grid::getData (
?int $limit = null,
?int $offset = null
): array
Parameters
$limit : ?int
 
$offset : ?int
 

getDatasource()

public Grid::getDatasource (
void
): \com\setasign\Konquadrat\Datasource\DatasourceInterface

getFieldName()

protected Grid::getFieldName (
string $name
): string
Parameters
$name : string
 

getGuiConfig()

public Grid::getGuiConfig (
void
): \com\setasign\SetaFramework\Config\Config
Exceptions

Throws \com\setasign\Konquadrat\Exception

isEditable()

public Grid::isEditable (
?string $field = null
): bool
Parameters
$field : ?string
 

isLimitable()

public Grid::isLimitable (
void
): bool

isSearchable()

public Grid::isSearchable (
?string $field = null
): bool
Parameters
$field : ?string
 

isSortable()

public Grid::isSortable (
?string $field = null
): bool
Parameters
$field : ?string
 

prepareColumns()

protected Grid::prepareColumns (
array $columns,
bool $gridReadOnly
): \com\setasign\SetaFramework\Config\Config
Parameters
$columns : array
 
$gridReadOnly : bool
 

sortColumnsByPosition()

protected Grid::sortColumnsByPosition (
array $columns
): array
Parameters
$columns : array
 

useContext()

public Grid::useContext (
void
): bool

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)