com\setasign\Konquadrat\Datasource

ObjectDatasource Interface Deletable

File: /Konquadrat/src/Datasource/ObjectDatasource.php

Class hierarchy

Implements

Summary

Constants

CONDITION_CONNECTOR_AND

protected const ObjectDatasource::CONDITION_CONNECTOR_AND = 'and'

CONDITION_CONNECTOR_OR

CONDITION_CONNECTOR_XOR

protected const ObjectDatasource::CONDITION_CONNECTOR_XOR = 'xor'

SPECIAL_SEARCH_FIELDS

public const Searchable::SPECIAL_SEARCH_FIELDS = array ( 0 => '_fullSearch', 1 => '_doubletFilter', 2 => '_customFilter', 3 => '_history', )

SPECIAL_SORT_FIELDS

public const Sortable::SPECIAL_SORT_FIELDS = array ( 0 => 'doubletCheck', )

Properties

$aliases

protected array ObjectDatasource::$aliases = array()

$applicationConfig

$config

protected \com\setasign\SetaFramework\Config\Config ObjectDatasource::$config

$context

protected ?int ObjectDatasource::$context

$db

protected ObjectDatasource::$db

$languageManager

$objectConfig

$objectFinder

$resourceDefinition

protected \com\setasign\SetaFramework\Permissions\ResourceDefinition ObjectDatasource::$resourceDefinition

$select

protected ?\com\setasign\SetaFramework\Database\Query\Select ObjectDatasource::$select

$sessionContext


Methods

__construct()

public ObjectDatasource::__construct (
\com\setasign\SetaFramework\Database\Database $db,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\Konquadrat\Permission\ResourceDefinitionManager $resourceDefinitionManager,
\com\setasign\SetaFramework\Config\Config $gridConfig
)
Parameters
$db : \com\setasign\SetaFramework\Database\Database
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$resourceDefinitionManager : \com\setasign\Konquadrat\Permission\ResourceDefinitionManager
 
$gridConfig : \com\setasign\SetaFramework\Config\Config
 

__clone()

public ObjectDatasource::__clone (
void
): void

addCondition()

protected ObjectDatasource::addCondition (
\com\setasign\SetaFramework\Database\Query\Select $select,
string $connector,
string|array|\com\setasign\SetaFramework\Database\Expression|\com\setasign\SetaFramework\Database\ValueExpression $field,
string $operator,
$value,
bool $ignoreComma = false
): void
Parameters
$select : \com\setasign\SetaFramework\Database\Query\Select
 
$connector : string
 
$field : string|array|\com\setasign\SetaFramework\Database\Expression|\com\setasign\SetaFramework\Database\ValueExpression
 
$operator : string
 
$value
 
$ignoreComma : bool
 

addCustomFilter()

public ObjectDatasource::addCustomFilter (
array $filters
): void
Parameters
$filters : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

addDoubletFilter()

public ObjectDatasource::addDoubletFilter (
array $columns
): void
Parameters
$columns : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

addFullSearch()

public ObjectDatasource::addFullSearch (
$value
): void
Parameters
$value
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

addGroup()

public ObjectDatasource::addGroup (
string $field
): void
Parameters
$field : string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

addHistorySearch()

public ObjectDatasource::addHistorySearch (
array $historySearches
): void
Parameters
$historySearches : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

addReferenceConditions()

public ObjectDatasource::addReferenceConditions (
array $value
): void
Parameters
$value : array
 

addSearch()

public ObjectDatasource::addSearch (
string $field,
string $comparator,
mixed $value,
string $connector = 'and'
): void
Parameters
$field : string
 
$comparator : string
 
$value : mixed
 
$connector : string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

addSort()

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

'ASC' or 'DESC'

Exceptions

Throws \com\setasign\Konquadrat\Exception

buildFilter()

protected ObjectDatasource::buildFilter (
\com\setasign\SetaFramework\Database\Query\Select $select,
array $filter,
$connector
): void
Parameters
$select : \com\setasign\SetaFramework\Database\Query\Select
 
$filter : array
 
$connector
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

deleteRows()

public ObjectDatasource::deleteRows (
array $ids
): void
Parameters
$ids : array
 
Exceptions

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

Throws \Throwable

Throws \com\setasign\SetaFramework\Permissions\PermissionException

edit()

public ObjectDatasource::edit (
int $id,
string $field,
mixed $value,
IgnoreOldValue|mixed $oldValue
): void
Parameters
$id : int
 
$field : string
 
$value : mixed
 
$oldValue : 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

getConfig()

public ObjectDatasource::getConfig (
void
): \com\setasign\SetaFramework\Config\Config

getCount()

public ObjectDatasource::getCount (
void
): int
Exceptions

Throws \com\setasign\Konquadrat\Exception

getData()

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

Throws \com\setasign\Konquadrat\Exception

getFilters()

public ObjectDatasource::getFilters (
void
): array

getGridClass()

public ObjectDatasource::getGridClass (
void
): string

getSelect()

public ObjectDatasource::getSelect (
void
): \com\setasign\SetaFramework\Database\Query\Select
Exceptions

Throws \com\setasign\Konquadrat\Exception

getType()

public ObjectDatasource::getType (
void
): string

isEditable()

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

Throws \com\setasign\Konquadrat\Exception

isGroupable()

public ObjectDatasource::isGroupable (
?string $field = null
): bool
Parameters
$field : ?string
 

isLimitable()

public ObjectDatasource::isLimitable (
void
): bool

isSearchable()

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

Throws \com\setasign\Konquadrat\Exception

isSortable()

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

Throws \com\setasign\Konquadrat\Exception

isTemplate()

public ObjectDatasource::isTemplate (
void
): bool

setContext()

public ObjectDatasource::setContext (
?int $context
): void
Parameters
$context : ?int
 

splitSearchPhrase()

protected ObjectDatasource::splitSearchPhrase (
string $inputPhrase,
string $splitChar
): array
Parameters
$inputPhrase : string
 
$splitChar : string