Index

  1. \com\setasign\Konquadrat
    1. Checkin
      1. AbstractCheckin
      2. AlreadyCheckedInException
      3. CheckinFactory
      4. CheckinFactoryInterface

com\setasign\Konquadrat\Checkin

AbstractCheckin

File: /Konquadrat/src/Checkin/AbstractCheckin.php

Class hierarchy

Summary

Methods

Properties

Properties

$backendPath

protected string AbstractCheckin::$backendPath

$checkinObject

protected AbstractCheckin::$checkinObject

$languageManager

protected AbstractCheckin::$languageManager

$objectFinder

protected AbstractCheckin::$objectFinder

$objectManager

protected AbstractCheckin::$objectManager

$objectTableManager

protected AbstractCheckin::$objectTableManager

$sessionContext

protected AbstractCheckin::$sessionContext

$smarty

protected AbstractCheckin::$smarty

Methods

__construct()

public AbstractCheckin::__construct ()

AbstractCheckin constructor.

Note: all implementations MUST have CheckinTpl $checkinObject as last argument!

Parameters
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$objectTableManager : \com\setasign\Konquadrat\Object\ObjectTableManager
 
$smarty : \Smarty\Smarty
 
$konquadrat : \com\setasign\Konquadrat\Konquadrat
 
$checkinObject : \com\setasign\Konquadrat\Object\Custom\CheckinTplObject
 

checkin()

public AbstractCheckin::checkin (): void
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 
Exceptions

Throws \com\setasign\Konquadrat\Exception If $object is invalid object to check in

Throws AlreadyCheckedInException If the object is already checked in

checkout()

public AbstractCheckin::checkout (): void
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 
Exceptions

Throws \com\setasign\Konquadrat\Exception If $object is invalid object to check out

getAlreadyCheckedInMessage()

public AbstractCheckin::getAlreadyCheckedInMessage (): string
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 
$checkinRelation : \com\setasign\Konquadrat\Object\AbstractObject
 

getCheckinRelation()

public AbstractCheckin::getCheckinRelation (): ?\com\setasign\Konquadrat\Object\Custom\CheckinRelationObject
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 

getCheckinSubjects()

protected AbstractCheckin::getCheckinSubjects (
void
): array

getCount()

public AbstractCheckin::getCount (
void
): int

getNotFoundMessage()

protected AbstractCheckin::getNotFoundMessage (
string $code
): string
Parameters
$code : string
 

getObjectByCode()

abstract public AbstractCheckin::getObjectByCode (
string $code
): \com\setasign\Konquadrat\Object\AbstractObject
Parameters
$code : string
 

getSubcheckinMessage()

public AbstractCheckin::getSubcheckinMessage (): string
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 

getSubcheckins()

public AbstractCheckin::getSubcheckins (): array
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 

getSuccessMessage()

public AbstractCheckin::getSuccessMessage (): string
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 

getTotalCount()

abstract public AbstractCheckin::getTotalCount (
void
): int

isCheckedin()

public AbstractCheckin::isCheckedin (): bool
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 

isValidObject()

abstract public AbstractCheckin::isValidObject (): bool
Parameters
$object : \com\setasign\Konquadrat\Object\AbstractObject
 

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