Index

  1. \com\setasign\SetaSite
    1. Block
      1. DefaultBlocks
        1. BlockContainer
          1. BlockContainer

com\setasign\SetaSite\Block\DefaultBlocks\BlockContainer

BlockContainer Interface BlockInterface

File: /SetaSite/src/Block/DefaultBlocks/BlockContainer/BlockContainer.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

PROVIDED_FILES

protected const \com\setasign\SetaSite\Block\AbstractBlock::PROVIDED_FILES = array ( 0 => 'icon.png', )

Properties

$blockFactory

private \com\setasign\SetaSite\Block\BlockFactory BlockContainer::$blockFactory

$blockInstances

private array BlockContainer::$blockInstances = array()

$blockName

protected string \com\setasign\SetaSite\Block\AbstractBlock::$blockName

$blockParent

protected \com\setasign\SetaSite\Block\BlockParent\BlockParentInterface \com\setasign\SetaSite\Block\AbstractBlock::$blockParent

$isBlockFinal

protected \com\setasign\SetaSite\Block\AbstractBlock::$isBlockFinal

$logger

protected ?\Psr\Log\LoggerInterface \com\setasign\SetaSite\Block\AbstractBlock::$logger

$propertyContainer

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

$sessionContext

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

Static Methods

getBlockPath()

public static BlockContainer::getBlockPath (
void
): string

getConfig()

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

lookupFile()

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

Throws \com\setasign\SetaSite\FileSystem\InvalidPathException

readConfig()

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

Methods

__construct()

public BlockContainer::__construct ()

BlockContainer constructor.

Parameters
$blockFactory: \com\setasign\SetaSite\Block\BlockFactory
 
$setasite: \com\setasign\SetaSite\SetaSite
 
$sessionContext: \com\setasign\SetaSite\SessionContext
 
$blockParent: \com\setasign\SetaSite\Block\BlockParent\BlockParentInterface
 
$blockName: string
 
$blockData: array
 

__clone()

public \com\setasign\SetaSite\Block\AbstractBlock::__clone (
void
): void

Implementation of __clone()

__sleep()

final public \com\setasign\SetaSite\Block\AbstractBlock::__sleep (
void
): void

Blocks aren't serializable.

Exceptions

Throws \BadMethodCallException

get()

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

getAnchors()

public BlockContainer::getAnchors (
void
): array
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

getBlockCache()

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

getBlockCacheValidators()

protected \com\setasign\SetaSite\Block\AbstractBlock::getBlockCacheValidators (
void
): array

getCacheName()

protected \com\setasign\SetaSite\Block\AbstractBlock::getCacheName (
void
): string

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

getData()

public \com\setasign\SetaSite\Block\AbstractBlock::getData (
void
): array

getFullName()

public \com\setasign\SetaSite\Block\AbstractBlock::getFullName (
void
): string

getModuleAdapters()

public BlockContainer::getModuleAdapters (): array
Parameters
$module: \com\setasign\SetaSite\Module\ModuleInterface
 
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

getName()

public \com\setasign\SetaSite\Block\AbstractBlock::getName (
void
): string

getPage()

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

getPropertyContainer()

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

getSourceBlocks()

public BlockContainer::getSourceBlocks (
void
): array
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

getSourcePage()

public BlockContainer::getSourcePage (
void
): \com\setasign\SetaSite\Page\Page
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException

getSubpagesTree()

public BlockContainer::getSubpagesTree (
void
): ?array
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

getUid()

public \com\setasign\SetaSite\Block\AbstractBlock::getUid (
void
): ?string

isBlockFinal()

public \com\setasign\SetaSite\Block\AbstractBlock::isBlockFinal (
void
): bool

lookForBlockAction()

public BlockContainer::lookForBlockAction (
string $uuid
): ?\com\setasign\SetaSite\Block\BlockActionInterface
Parameters
$uuid: string
 

render()

public BlockContainer::render (
void
): string
Exceptions

Throws \com\setasign\SetaSite\Block\BlockRenderException

Throws \com\setasign\SetaSite\Block\ForceResponseException

Throws \com\setasign\SetaSite\HttpErrorException

Throws \com\setasign\SetaSite\Page\UnknownPageException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

setCache()

final public \com\setasign\SetaSite\Block\AbstractBlock::setCache (
\Psr\SimpleCache\CacheInterface $cache
): void
Parameters
$cache: \Psr\SimpleCache\CacheInterface
 

setLogger()

final public \com\setasign\SetaSite\Block\AbstractBlock::setLogger (
\Psr\Log\LoggerInterface $logger
): void

Sets a logger instance on the object.

Parameters
$logger: \Psr\Log\LoggerInterface
 

setParams()

public BlockContainer::setParams (
array $params
): void
Parameters
$params: array
 
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException


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