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

XlsExportObject Konquadrat Object "XlsExport"

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

Class hierarchy

Uses

Implements

Summary

Static Methods

Methods

Properties

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'

EVENT_AFTER_SAVE

public const \com\setasign\Konquadrat\Object\AbstractObject::EVENT_AFTER_SAVE = 'afterSave'

Event is triggered after save

params:

  • $this
  • array $changes

EVENT_AFTER_SAVE_AND_COMMIT

public const \com\setasign\Konquadrat\Object\AbstractObject::EVENT_AFTER_SAVE_AND_COMMIT = 'afterSaveAndCommit'

Event is triggered after save and after the current transaction is committed.

params:

  • $this
  • array $changes

EVENT_AFTER_SAVE_AND_ROLLBACK

public const \com\setasign\Konquadrat\Object\AbstractObject::EVENT_AFTER_SAVE_AND_ROLLBACK = 'afterSaveAndRollback'

Event is triggered after save and after the current transaction is rolled back.

params:

  • $this
  • ?array $changes

EVENT_AFTER_SAVE_ERROR

public const \com\setasign\Konquadrat\Object\AbstractObject::EVENT_AFTER_SAVE_ERROR = 'afterSaveError'

Event is triggered while saving if something went wrong

params:

  • $this
  • Throwable $exception

EVENT_BEFORE_SAVE

public const \com\setasign\Konquadrat\Object\AbstractObject::EVENT_BEFORE_SAVE = 'beforeSave'

Event is triggered before save

params:

  • $this
  • bool $force

EVENT_CREATE

public const \com\setasign\Konquadrat\Object\AbstractObject::EVENT_CREATE = 'create'

Event is triggered on creation of a new object (before the first save)

params:

  • $this

NAME

public const XlsExportObject::NAME = 'XlsExport'

Properties

$STATUS_FINISHED

protected Traits\TaskTpl::$STATUS_FINISHED = 'finished'

$STATUS_READING_DATA

protected Traits\ExportTpl::$STATUS_READING_DATA = 'reading_data'

$STATUS_READ_DATA

protected Traits\ExportTpl::$STATUS_READ_DATA = 'read_data'

$STATUS_START

protected Traits\TaskTpl::$STATUS_START = 'started'

$STATUS_WRITING_FILE

protected Traits\ExportTpl::$STATUS_WRITING_FILE = 'writing_file'

$data

protected array \com\setasign\Konquadrat\Object\AbstractObject::$data = array()

$directorySettings

protected \com\setasign\Konquadrat\DirectorySettings Traits\ExportTpl::$directorySettings

$grid

protected \com\setasign\Konquadrat\Grid\GridInterface Traits\ExportTpl::$grid

$konquadrat

protected \com\setasign\Konquadrat\Konquadrat Traits\ExportTpl::$konquadrat

$languageManager

protected \com\setasign\Konquadrat\Object\AbstractObject::$languageManager

$logger

protected ?\Psr\Log\LoggerInterface \com\setasign\Konquadrat\Object\AbstractObject::$logger

$objectConfig

protected \com\setasign\Konquadrat\Object\AbstractObject::$objectConfig

$objectFinder

protected \com\setasign\Konquadrat\Object\AbstractObject::$objectFinder

$objectManager

protected \com\setasign\Konquadrat\Object\AbstractObject::$objectManager

$readLimit

protected Traits\ExportTpl::$readLimit = 5000

$resourceDefinitionManager

protected \com\setasign\Konquadrat\Object\AbstractObject::$resourceDefinitionManager

$sessionContext

protected \com\setasign\Konquadrat\SessionContext Traits\ExportTpl::$sessionContext

$sleep

protected array \com\setasign\Konquadrat\Object\AbstractObject::$sleep

All properties which should be serialized.

Note: Private properties cannot be serialized!

$smarty

private Traits\XlsExportTpl::$smarty

$transactionManager

protected \com\setasign\Konquadrat\Object\AbstractObject::$transactionManager

Static Methods

getGuiFormConfig()

public static Traits\XlsExportTpl::getGuiFormConfig (): string
Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 

Methods

__construct()

public \com\setasign\Konquadrat\Object\AbstractObject::__construct (
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\Object\TransactionManager $transactionManager,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Field\FieldFactory\FieldFactoryInterface $fieldFactory,
\com\setasign\Konquadrat\Object\DocumentResolverInterface $documentResolver,
\com\setasign\Konquadrat\Object\ActionResolverInterface $actionResolver,
\com\setasign\Konquadrat\Permission\ResourceDefinitionManager $resourceDefinitionManager,
\com\setasign\Konquadrat\Object\InitTraitResolverInterface $initTraitResolver,
\com\setasign\Konquadrat\Object\WakeupObjectResolverInterface $wakeupResolver,
array $data,
?\com\setasign\Konquadrat\Object\Scope\ScopeInterface $objectScope = null
)
Parameters
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
 
$transactionManager : \com\setasign\Konquadrat\Object\TransactionManager
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$fieldFactory : \com\setasign\Konquadrat\Field\FieldFactory\FieldFactoryInterface
 
$documentResolver : \com\setasign\Konquadrat\Object\DocumentResolverInterface
 
$actionResolver : \com\setasign\Konquadrat\Object\ActionResolverInterface
 
$resourceDefinitionManager : \com\setasign\Konquadrat\Permission\ResourceDefinitionManager
 
$initTraitResolver : \com\setasign\Konquadrat\Object\InitTraitResolverInterface
 
$wakeupResolver : \com\setasign\Konquadrat\Object\WakeupObjectResolverInterface
 
$data : array
 
$objectScope : ?\com\setasign\Konquadrat\Object\Scope\ScopeInterface
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

__call()

public \com\setasign\Konquadrat\Object\AbstractObject::__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
 

__clone()

public \com\setasign\Konquadrat\Object\AbstractObject::__clone (
void
): void
Exceptions

Throws \com\setasign\Konquadrat\Exception

__get()

public \com\setasign\Konquadrat\Object\AbstractObject::__get (
string $fieldName
): ?mixed

Alias for get($fieldName, true)

Parameters
$fieldName : string
 
Exceptions

Throws \com\setasign\Konquadrat\Object\MissingConfigurationException

See

__isset()

public \com\setasign\Konquadrat\Object\AbstractObject::__isset (
string $fieldName
): bool

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

Parameters
$fieldName : string
 

__set()

public \com\setasign\Konquadrat\Object\AbstractObject::__set (
string $fieldName,
mixed $value
): void

Alias for set($fieldName, $value)

Parameters
$fieldName : string
 
$value : mixed
 
See

__sleep()

final public \com\setasign\Konquadrat\Object\AbstractObject::__sleep (
void
): array

__wakeup()

final public \com\setasign\Konquadrat\Object\AbstractObject::__wakeup (
void
): void
Exceptions

Throws \Throwable

addEventListener()

final public \com\setasign\Konquadrat\Object\AbstractObject::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
 

calculateHash()

protected Traits\ExportTpl::calculateHash (
string $dataHash
): string
Parameters
$dataHash : string
 

callAction()

final public \com\setasign\Konquadrat\Object\AbstractObject::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.

checkHash()

protected Traits\ExportTpl::checkHash (
string $hash
): void
Parameters
$hash : string
 
Exceptions

Throws \com\setasign\Konquadrat\Controller\Backend\ExportAlreadyExistsException

continueTaskAction()

public Traits\TaskTpl::continueTaskAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Exceptions

Throws \com\setasign\Konquadrat\Exception

copyObjectData()

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

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[]
 

create()

private \com\setasign\Konquadrat\Object\AbstractObject::create (
void
): void

The method will be called when a new object is created.

customRenderer()

protected Traits\XlsExportTpl::customRenderer (
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $worksheet,
\PhpOffice\PhpSpreadsheet\Cell\Cell $cell,
$value,
$columnConfig
): void
Parameters
$worksheet : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
 
$cell : \PhpOffice\PhpSpreadsheet\Cell\Cell
 
$value
 
$columnConfig
 
Exceptions

Throws \PhpOffice\PhpSpreadsheet\Exception

Throws \Exception

deactivateTaskIsRunningFlagAction()

public Traits\TaskTpl::deactivateTaskIsRunningFlagAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Exceptions

Throws \com\setasign\Konquadrat\Exception

delete()

public \com\setasign\Konquadrat\Object\AbstractObject::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

fillCell()

protected Traits\XlsExportTpl::fillCell (
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $worksheet,
\PhpOffice\PhpSpreadsheet\Cell\Cell $cell,
$dataRow,
$column,
$gridConfig,
$gridId
): void
Parameters
$worksheet : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
 
$cell : \PhpOffice\PhpSpreadsheet\Cell\Cell
 
$dataRow
 
$column
 
$gridConfig
 
$gridId
 
Exceptions

Throws \PhpOffice\PhpSpreadsheet\Exception

Throws \Exception

fillHeadings()

protected Traits\XlsExportTpl::fillHeadings (
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $worksheet,
array $columns,
array $gridConfig
): void
Parameters
$worksheet : \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
 
$columns : array
 
$gridConfig : array
 
Exceptions

Throws \PhpOffice\PhpSpreadsheet\Exception

filterDataChunk()

protected Traits\ExportTpl::filterDataChunk (
array $dataChunk
): array
Parameters
$dataChunk : array
 

get()

final public \com\setasign\Konquadrat\Object\AbstractObject::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()

final public \com\setasign\Konquadrat\Object\AbstractObject::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()

final public \com\setasign\Konquadrat\Object\AbstractObject::getChanged (
void
): array

getChilds()

final public \com\setasign\Konquadrat\Object\AbstractObject::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()

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

Returns the data of the fields of this object.

MultiLangString, MultiLangText and Password fields are ignored.

Parameters
$resolveMagicFields : bool
 

getDataoriginName()

public Traits\TaskTpl::getDataoriginName (
void
): string

getField()

final public \com\setasign\Konquadrat\Object\AbstractObject::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()

final public \com\setasign\Konquadrat\Object\AbstractObject::getFieldContainerName (
void
): string

getFields()

final public \com\setasign\Konquadrat\Object\AbstractObject::getFields (
void
): array

Get all fields

getInitialData()

final public \com\setasign\Konquadrat\Object\AbstractObject::getInitialData (
void
): array

getMagicWithParam()

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

getPath()

final public \com\setasign\Konquadrat\Object\AbstractObject::getPath (
void
): string

getPermissionResource()

final public \com\setasign\Konquadrat\Object\AbstractObject::getPermissionResource (
void
): \com\setasign\SetaFramework\Permissions\ResourceDefinition

getProgress()

public Traits\ExportTpl::getProgress (
void
): float

getReferencingObjects()

final public \com\setasign\Konquadrat\Object\AbstractObject::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
 

getResultData()

public Traits\ExportTpl::getResultData (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse

getSanitizedFilename()

protected Traits\ExportTpl::getSanitizedFilename (
void
): string

getTabHeader()

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

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

getTaskFinished()

public Traits\TaskTpl::getTaskFinished (
void
): string

getTaskInfo()

public Traits\TaskTpl::getTaskInfo (
void
): array

hasAction()

final public \com\setasign\Konquadrat\Object\AbstractObject::hasAction (
string $action
): bool
Parameters
$action : string
 

hasDocument()

final public \com\setasign\Konquadrat\Object\AbstractObject::hasDocument (
string $name
): bool
Parameters
$name : string
 

hasField()

final public \com\setasign\Konquadrat\Object\AbstractObject::hasField (
string $fieldName
): bool

Checks whether the object has the field $fieldName.

Parameters
$fieldName : string
 

initAndWakeupExportTpl()

public Traits\ExportTpl::initAndWakeupExportTpl (): void
Parameters
$directorySettings : \com\setasign\Konquadrat\DirectorySettings
 
$sessionContext : \com\setasign\Konquadrat\SessionContext
 

initAndWakeupXlsExportTpl()

public Traits\XlsExportTpl::initAndWakeupXlsExportTpl (
\Smarty\Smarty $smarty
): void
Parameters
$smarty : \Smarty\Smarty
 

initTaskTpl()

public Traits\TaskTpl::initTaskTpl (
void
): void

isSettingData()

public \com\setasign\Konquadrat\Object\AbstractObject::isSettingData (
void
): bool

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

For the most set-methods you will need to react on this.

parseTime()

protected Traits\XlsExportTpl::parseTime (
$value
): float|int
Parameters
$value
 
Exceptions

Throws \Exception

prepareParamsForGridExport()

public Traits\ExportTpl::prepareParamsForGridExport (
array $params
): array
Parameters
$params : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

process()

public Traits\ExportTpl::process (
void
): void
Exceptions

Throws \Throwable

processExport()

protected Traits\XlsExportTpl::processExport (
void
): void
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \PhpOffice\PhpSpreadsheet\Exception

Throws \PhpOffice\PhpSpreadsheet\Reader\Exception

Throws \PhpOffice\PhpSpreadsheet\Writer\Exception

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

reload()

final public \com\setasign\Konquadrat\Object\AbstractObject::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()

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

resetField()

final public \com\setasign\Konquadrat\Object\AbstractObject::resetField (
string $fieldName
): void

Resets the field to the initial value.

Parameters
$fieldName : string
 

restartTaskAction()

WARNING: This method is marked as deprecated!

Use continueTaskAction() instead.

public Traits\TaskTpl::restartTaskAction (
void
): ?\com\setasign\Konquadrat\Object\Action\ActionResponse
Exceptions

Throws \com\setasign\Konquadrat\Exception

save()

final public \com\setasign\Konquadrat\Object\AbstractObject::save (
bool $force = false
): \com\setasign\Konquadrat\Object\AbstractObject

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()

final public \com\setasign\Konquadrat\Object\AbstractObject::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()

final public \com\setasign\Konquadrat\Object\AbstractObject::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.

setGrid()

public Traits\ExportTpl::setGrid (): void
Parameters
$grid : \com\setasign\Konquadrat\Grid\GridInterface
 

setLogger()

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

setParams()

public Traits\XlsExportTpl::setParams (
$params
): void
Parameters
$params
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \JsonException

Throws \com\setasign\SetaFramework\Permissions\PermissionException


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