Index

  1. \com\setasign\SetaSite
    1. Block
      1. AbstractBlock
      2. AbstractMultiBlock
      3. AbstractTwigBlock
      4. AbstractTwigControllerBlock
      5. AbstractTwigMultiBlock
      6. AbstractViewBlock
      7. AbstractViewControllerBlock
      8. AbstractViewMultiBlock
      9. AnchorInterface
      10. BlockActionInterface
      11. BlockActionReferrerInterface
      12. BlockActionTrait
      13. BlockFactory
      14. BlockInterface
      15. BlockParent
      16. BlockRenderException
      17. ControllerBlockInterface
      18. DefaultBlocks
      19. ForceResponseException
      20. HasCacheInterface
      21. MultiBlockInterface
      22. PageRenderDataChangeCacheValidator

com\setasign\SetaSite\Block

AbstractBlock Interface BlockInterface

File: /SetaSite/src/Block/AbstractBlock.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

PROVIDED_FILES

protected const AbstractBlock::PROVIDED_FILES = array ( 0 => 'icon.png', )

Properties

$blockName

protected string AbstractBlock::$blockName

$blockParent

protected BlockParent\BlockParentInterface AbstractBlock::$blockParent

$cache

private ?\Psr\SimpleCache\CacheInterface AbstractBlock::$cache

$isBlockFinal

protected AbstractBlock::$isBlockFinal

$logger

protected ?\Psr\Log\LoggerInterface AbstractBlock::$logger

$propertyContainer

protected \com\setasign\SetaSite\PropertyContainer\PropertyContainer AbstractBlock::$propertyContainer

$sessionContext

protected \com\setasign\SetaSite\SessionContext AbstractBlock::$sessionContext

Static Methods

getBlockPath()

abstract public static BlockInterface::getBlockPath (
void
): string

Just return DIR

getConfig()

final public static AbstractBlock::getConfig (
void
): \com\setasign\SetaFramework\Config\Config

lookupFile()

public static AbstractBlock::lookupFile (
string $file
): \com\setasign\SetaFramework\FileSystem\File
Parameters
$file : string
 
Exceptions

Throws \com\setasign\SetaSite\FileSystem\InvalidPathException

readConfig()

protected static AbstractBlock::readConfig (
void
): \com\setasign\SetaFramework\Config\Config

Methods

__construct()

public AbstractBlock::__construct (
\com\setasign\SetaSite\SetaSite $setasite,
\com\setasign\SetaSite\SessionContext $sessionContext,
BlockParent\BlockParentInterface $blockParent,
string $blockName,
array $blockData
)
Parameters
$setasite : \com\setasign\SetaSite\SetaSite
 
$sessionContext : \com\setasign\SetaSite\SessionContext
 
$blockParent : BlockParent\BlockParentInterface
 
$blockName : string
 
$blockData : array
 

__clone()

public AbstractBlock::__clone (
void
): void

Implementation of __clone()

__sleep()

final public AbstractBlock::__sleep (
void
): void

Blocks aren't serializable.

Exceptions

Throws \BadMethodCallException

get()

final public AbstractBlock::get (
string $propertyName
): \com\setasign\SetaSite\PropertyContainer\Property\AbstractProperty
Parameters
$propertyName : string
 

getBlockCache()

protected AbstractBlock::getBlockCache (
void
): ?\com\setasign\SetaFramework\SimpleCache\ValidationCacheEntry

getBlockCacheValidators()

protected AbstractBlock::getBlockCacheValidators (
void
): array

getCacheName()

protected AbstractBlock::getCacheName (
void
): string

Overwrite if you need an alternative cache name e.g. for ControllerBlock

getData()

public AbstractBlock::getData (
void
): array

getFullName()

public AbstractBlock::getFullName (
void
): string

getModuleAdapters()

public AbstractBlock::getModuleAdapters (): array

If the block has some special functionality for an external module it will return an adapter for this otherwise the array is empty.

Parameters
$module : \com\setasign\SetaSite\Module\ModuleInterface
 

getName()

public AbstractBlock::getName (
void
): string

getPage()

public AbstractBlock::getPage (
void
): \com\setasign\SetaSite\Page\Page

getPropertyContainer()

final public AbstractBlock::getPropertyContainer (
void
): \com\setasign\SetaSite\PropertyContainer\PropertyContainer

getUid()

public AbstractBlock::getUid (
void
): ?string

isBlockFinal()

public AbstractBlock::isBlockFinal (
void
): bool

render()

abstract public BlockInterface::render (
void
): string
Return Values

The rendered block

Exceptions

Throws ForceResponseException If the block forces a complete response.

Throws \com\setasign\SetaSite\HttpErrorException If the block forces a http error.

Throws \com\setasign\SetaFramework\Bootstrap\MaintenanceException

Throws BlockRenderException If something went wrong on rendering the block.

setCache()

final public AbstractBlock::setCache (
\Psr\SimpleCache\CacheInterface $cache
): void
Parameters
$cache : \Psr\SimpleCache\CacheInterface
 

setLogger()

final public AbstractBlock::setLogger (
\Psr\Log\LoggerInterface $logger
): void

Sets a logger instance on the object.

Parameters
$logger : \Psr\Log\LoggerInterface
 

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