Index

  1. \com\setasign\Konquadrat
    1. Object
      1. Custom
        1. CallActionTaskObject
        2. CheckinObject
        3. CheckinRelationObject
        4. CheckinSubjectObject
        5. CheckinSubjectRelationObject
        6. CheckinSubjectTrait
        7. CheckinTplObject
        8. CheckinTplTrait
        9. ConfigExportObject
        10. CrashReportObject
        11. CsvImportFileObject
        12. CustomExportObject
        13. DashboardObject
        14. DashboardTplObject
        15. DashboardTplTrait
        16. DataoriginObject
        17. DataoriginTrait
        18. DatasourceObject
        19. DatasourceTplObject
        20. DatasourceTplTrait
        21. EditColumnTaskObject
        22. ExportTplObject
        23. ExportTplTrait
        24. GridExportTplObject
        25. GridExportTplTrait
        26. GridObject
        27. GridViewObject
        28. HashableObject
        29. HashableTrait
        30. ImportDefinitionObject
        31. ImportFileObject
        32. ImportFileTplObject
        33. ImportFileTplTrait
        34. ImportObject
        35. ImportSchemaObject
        36. ImportTaskObject
        37. Mail
        38. MobileCheckinAuthDeviceObject
        39. MobileCheckinAuthObject
        40. MobileCheckinAuthRelationObject
        41. NamedDashboardObject
        42. NamedDataoriginObject
        43. NamedObjectObject
        44. NamedObjectTrait
        45. NoteObject
        46. NumberRangeObject
        47. SyncableObjectObject
        48. SyncableObjectTrait
        49. TaskTplObject
        50. TaskTplTrait
        51. Traits
        52. TxtExportObject
        53. TxtExportTplObject
        54. TxtExportTplTrait
        55. User
        56. UserObject
        57. UserTplObject
        58. UserTplTrait
        59. WorkflowObject
        60. WorkflowTextItemObject
        61. XlsExportObject
        62. XlsExportTplObject
        63. XlsExportTplTrait
        64. XlsImportFileObject
        65. XlsxImportFileObject

com\setasign\Konquadrat\Object\Custom

DatasourceTplObject Konquadrat ObjectTemplate "DatasourceTpl"

File: /Konquadrat/src/Object/Custom/generated/DatasourceTplObject.php

Implemented in

Implements

Summary

Methods

Constants

Constants

ACTION_DELETE

public const \com\setasign\Konquadrat\Object\AbstractObjectInterface::ACTION_DELETE = 'delete'

ACTION_READ

public const \com\setasign\Konquadrat\Object\AbstractObjectInterface::ACTION_READ = 'read'

ACTION_WRITE

public const \com\setasign\Konquadrat\Object\AbstractObjectInterface::ACTION_WRITE = 'write'

NAME

public const \com\setasign\Konquadrat\Object\AbstractObjectInterface::NAME = 'AbstractObject'

Methods

__call()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::__call (
string $name,
array $arguments
): ?mixed

Give some magic methods:

  • getField{$fieldName}() -> Alias for getField($fieldName)
  • getChild{$objectType}Objects() -> Alias for getChilds($objectType)
  • getReferencing{$objectType}ObjectsBy{$fieldName}Field() -> Alias for getReferencingObjects($objectType, $fieldName)
Parameters
$name : string
 
$arguments : array
 

__get()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::__get (
string $fieldName
): ?mixed

Alias for get($fieldName, true)

Parameters
$fieldName : string
 
Exceptions

Throws \com\setasign\Konquadrat\Object\MissingConfigurationException

See

__isset()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::__isset (
string $fieldName
): bool

Checks whether $fieldName exists and the value is not null.

Parameters
$fieldName : string
 

__set()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::__set (
string $fieldName,
mixed $value
): void

Alias for set($fieldName, $value)

Parameters
$fieldName : string
 
$value : mixed
 
See

addEventListener()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::addEventListener (
string $eventName,
string $name,
callable $callback
): void
Parameters
$eventName : string
 
$name : string

The name of this callback. The name is only unique for this method & object.

$callback : callable
 

callAction()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::callAction (
string $action,
array $additionalArguments = array ( )
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Parameters
$action : string
 
$additionalArguments : array
 
Exceptions

Throws \InvalidArgumentException If the action is unknown.

copyObjectData()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::copyObjectData (
\com\setasign\Konquadrat\Object\AbstractObjectInterface $object,
null|string|string[] $onlyTypes = null
): self

Copy the data of $object into this object. All fields of AbstractObject will be ignored (including the parent).

Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObjectInterface
 
$onlyTypes : null|string|string[]
 

delete()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::delete (
bool $recursive = true
): array

Marks the object as deleted and saves the object.

Existing references will not be unlinked, but you could find these objects with ObjectFinder::getReferencingObjects()!

This method will create a transaction if no transaction is active and revert everything if an error is thrown.

Parameters
$recursive : bool

Delete also all childs.

Return Values

Array with the ids of all deleted objects.

Exceptions

Throws \Throwable

get()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::get (
string $fieldName,
bool $resolve = true
): ?mixed

Get the value of $fieldName.

Parameters
$fieldName : string
 
$resolve : bool

Resolve resolvable fields like reference and json fields.

getAs()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getAs (
string $name
): \com\setasign\SetaFramework\FileSystem\File

Get the object as document of type $name

Parameters
$name : string
 
Exceptions

Throws \InvalidArgumentException If the name is invalid!

getChanged()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getChanged (
void
): array

getChilds()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getChilds (
null|\com\setasign\Konquadrat\Object\class-string<\com\setasign\Konquadrat\Object\T>|string[] $type = null
): \com\setasign\Konquadrat\Object\ObjectSet<\com\setasign\Konquadrat\Object\T>|\com\setasign\Konquadrat\Object\SmartObjectSet<\com\setasign\Konquadrat\Object\T>
Parameters
$type : null|\com\setasign\Konquadrat\Object\class-string<\com\setasign\Konquadrat\Object\T>|string[]
 

getData()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getData (
bool $resolveMagicFields = true
): array

Returns the data of the fields of this object.

MultiLangString, MultiLangText and Password fields are ignored.

Parameters
$resolveMagicFields : bool
 

getField()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::getField (
string $fieldName
): \com\setasign\Konquadrat\Field\AbstractField

Gets the field instance of $fieldName.

Parameters
$fieldName : string
 
Exceptions

Throws \com\setasign\Konquadrat\Object\MissingConfigurationException If the field isn't configured.

getFieldContainerName()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::getFieldContainerName (
void
): string

getFields()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::getFields (
void
): array

Return all fields.

getInitialData()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getInitialData (
void
): array

getMagicWithParam()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getMagicWithParam (
string $fieldName,
array $parameters
): string
Parameters
$fieldName : string
 
$parameters : array
 

getObject()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::getObject (
void
): \com\setasign\Konquadrat\Object\AbstractObject

getPath()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getPath (
void
): string

getPermissionResource()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getPermissionResource (
void
): \com\setasign\SetaFramework\Permissions\ResourceDefinition

getReferencingObjects()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getReferencingObjects (
\com\setasign\Konquadrat\Object\class-string<\com\setasign\Konquadrat\Object\T> $type,
string $field
): \com\setasign\Konquadrat\Object\ObjectSet<\com\setasign\Konquadrat\Object\T>|\com\setasign\Konquadrat\Object\SmartObjectSet<\com\setasign\Konquadrat\Object\T>
Parameters
$type : \com\setasign\Konquadrat\Object\class-string<\com\setasign\Konquadrat\Object\T>
 
$field : string
 

getTabHeader()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::getTabHeader (
void
): string

Get the text header which will be shown in the gui.

hasAction()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::hasAction (
string $action
): bool
Parameters
$action : string
 

hasDocument()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::hasDocument (
string $name
): bool
Parameters
$name : string
 

hasField()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::hasField (
string $fieldName
): bool

Checks whether the object has the field $fieldName.

Parameters
$fieldName : string
 

isSettingData()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::isSettingData (
void
): bool

Will be true when the data from the database will be inserted into the object.

reload()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::reload (
void
): void

Reloads the object.

All changed data will be reset!!

Exceptions

Throws \BadMethodCallException If the object was never saved!

Throws \com\setasign\Konquadrat\Object\UnknownObjectException If the object cannot be found!

removeEventListener()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::removeEventListener (
string $eventName,
string $name
): void
Parameters
$eventName : string
 
$name : string
 

resetField()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::resetField (
string $fieldName
): void

Resets the field to the initial value.

Parameters
$fieldName : string
 

save()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::save (
bool $force = false
): \com\setasign\Konquadrat\Object\AbstractObjectInterface

Save the object.

Parameters
$force : bool

Save everytime no matter whether there was a change

Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException If an error occurs during the save process.

set()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::set (
string $fieldName,
mixed|\com\setasign\Konquadrat\Field\DefaultValue $value
): static

Sets the value for the field.

Parameters
$fieldName : string
 
$value : mixed|\com\setasign\Konquadrat\Field\DefaultValue
 

setData()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::setData (
array $data,
bool $ignoreMissingFields = false
): void

Set multiple fields at once.

Parameters
$data : array
 
$ignoreMissingFields : bool

If true unknown fields will just be ignored.

setLogger()

abstract public \com\setasign\Konquadrat\Object\AbstractObjectInterface::setLogger (
\Psr\Log\LoggerInterface $logger
): void
Parameters
$logger : \Psr\Log\LoggerInterface
 

update()

abstract public \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface::update (): void

This field will notify the field container that the field was updated.

Parameters
$field : \com\setasign\Konquadrat\Field\AbstractField
 

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