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

ObjectGrid Class ObjectGrid

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$config

protected ObjectGrid::$config

$datasource

protected ObjectGrid::$datasource

$languageManager

protected ObjectGrid::$languageManager

Methods

__construct()

public ObjectGrid::__construct (
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Datasource\ObjectDatasource $datasource,
\com\setasign\SetaFramework\Config\Config $config
)

Grid constructor.

Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$datasource : \com\setasign\Konquadrat\Datasource\ObjectDatasource
 
$config : \com\setasign\SetaFramework\Config\Config
 

__clone()

public ObjectGrid::__clone (
void
): void

addSearch()

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

Throws \com\setasign\Konquadrat\Exception

addSort()

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

Throws \com\setasign\Konquadrat\Exception

deleteRows()

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

Throws \Throwable

Throws \com\setasign\Konquadrat\Controller\Backend\ObjectIsReferencedException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

edit()

public ObjectGrid::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

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

getColumns()

protected ObjectGrid::getColumns (
void
): array

getCount()

public ObjectGrid::getCount (
void
): int
Exceptions

Throws \com\setasign\Konquadrat\Exception

getData()

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

Throws \com\setasign\Konquadrat\Exception

getDatasource()

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

getGuiConfig()

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

Throws \com\setasign\Konquadrat\Exception

isEditable()

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

Throws \com\setasign\Konquadrat\Exception

isLimitable()

public ObjectGrid::isLimitable (
void
): bool

isSearchable()

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

Throws \com\setasign\Konquadrat\Exception

isSortable()

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

Throws \com\setasign\Konquadrat\Exception

prepareColumns()

protected ObjectGrid::prepareColumns (
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
bool $readOnly,
string $gridObjectType,
array $columns
): array
Parameters
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$readOnly : bool
 
$gridObjectType : string
 
$columns : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

sortColumnsByPosition()

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

useContext()

public ObjectGrid::useContext (
void
): bool

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