Index

  1. \com\setasign\SetaSite
    1. Page
      1. DeploymentHelper
      2. ExportStringHelper
      3. Page
      4. PageHistory
      5. PageLockException
      6. PageLocks
      7. PagePathAndLanguageNegotiator
      8. PagePermissionHandler
      9. PageRenderer
      10. PageSettings
      11. Pages
      12. PlaceholderFinder
      13. UnapprovedException
      14. UnknownPageException

com\setasign\SetaSite\Page

Page Class Page

File: /SetaSite/src/Page/Page.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$blockManager

protected \com\setasign\SetaSite\BlockManager\PageBlockManager Page::$blockManager

$blocksRenderDateTime

protected ?\DateTimeImmutable Page::$blocksRenderDateTime

$creator

protected ?int Page::$creator

$id

protected ?int Page::$id

$isTemplate

protected Page::$isTemplate

$language

protected Page::$language

$ownPath

protected string Page::$ownPath = ''

$pages

protected Page::$pages

$parentId

protected ?int Page::$parentId

$parentPath

protected string Page::$parentPath = ''

$pathOrder

protected float Page::$pathOrder = 0

$propertyContainer

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

$renderData

protected array Page::$renderData = array()

$version

protected int<\0, \1> Page::$version = 0

Static Methods

createByRow()

public static Page::createByRow (
Pages $pages,
\com\setasign\SetaFramework\Config\Config $config,
\com\setasign\SetaFramework\Database\Table\Row $row
): Page
Parameters
$pages : Pages
 
$config : \com\setasign\SetaFramework\Config\Config
 
$row : \com\setasign\SetaFramework\Database\Table\Row
 

Methods

__construct()

public Page::__construct (
Pages $pages,
string $language,
bool $isTemplate,
\com\setasign\SetaFramework\Config\Config $config,
array $data = array ( ),
array $blockData = array ( )
)
Parameters
$pages : Pages
 
$language : string
 
$isTemplate : bool
 
$config : \com\setasign\SetaFramework\Config\Config
 
$data : array
 
$blockData : array
 

__clone()

public Page::__clone (
void
): void

__get()

public Page::__get (
string $name
): ?mixed
Parameters
$name : string
 

__isset()

public Page::__isset (
string $name
): void
Parameters
$name : string
 

__set()

public Page::__set (
string $name,
mixed $value
): void
Parameters
$name : string
 
$value : mixed
 

getBlockManager()

public Page::getBlockManager (
void
): \com\setasign\SetaSite\BlockManager\PageBlockManager

getBlocksRenderDateTime()

public Page::getBlocksRenderDateTime (
void
): ?\DateTimeImmutable

getCreator()

public Page::getCreator (
void
): ?int

getId()

public Page::getId (
void
): ?int

getLanguage()

public Page::getLanguage (
void
): string

getOwnPath()

public Page::getOwnPath (
void
): string

The path is case-sensitive!

getPages()

public Page::getPages (
void
): Pages

getParentId()

public Page::getParentId (
void
): ?int

getParentPath()

public Page::getParentPath (
void
): string

The path is case-sensitive!

getPath()

public Page::getPath (
void
): string

The path is case-sensitive!

getPathOrder()

public Page::getPathOrder (
void
): float|int

getPropertyContainer()

public Page::getPropertyContainer (
void
): \com\setasign\SetaSite\PropertyContainer\PropertyContainer

getRenderData()

public Page::getRenderData (
void
): array
Return Values

Entries: templateFile

Exceptions

Throws \com\setasign\SetaSite\PropertyContainer\InvalidValueException

Throws UnknownPageException

Throws \com\setasign\SetaFramework\Exception

Throws \com\setasign\SetaSite\BlockManager\BlockFinalException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

getVersion()

public Page::getVersion (
void
): int

hasProperty()

public Page::hasProperty (
string $name
): bool
Parameters
$name : string
 

isTemplate()

public Page::isTemplate (
void
): bool

isValid()

public Page::isValid (
array &$result = array ( )
): bool
Parameters
$result : array
 
Exceptions

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

resetBlocksRenderDateTime()

public Page::resetBlocksRenderDateTime (
void
): void

setCreator()

public Page::setCreator (
int $creator
): void
Parameters
$creator : int
 

setParentId()

public Page::setParentId (
int $parentId
): void
Parameters
$parentId : int
 
Exceptions

Throws \com\setasign\SetaSite\PropertyContainer\InvalidValueException If the parent is invalid.

setPath()

public Page::setPath (
string $path,
bool $completePath = false
): void

The path is case-sensitive!

Parameters
$path : string
 
$completePath : bool
 

setPathOrder()

public Page::setPathOrder (
float $order
): void
Parameters
$order : float
 

setVersion()

public Page::setVersion (
int<\0, \1> $version
): void

Sets the version.

Beware of this method! If you change this entry on an already existing page and save the page, you will create a new page and the old page will stay.

Parameters
$version : int<\0, \1>
 

updateRenderData()

public Page::updateRenderData (
bool $changedPossible = true
): void

If you call this method you shouldn't have a changed template or changed blocks!

Parameters
$changedPossible : bool
 
Exceptions

Throws \com\setasign\SetaSite\PropertyContainer\InvalidValueException

Throws UnknownPageException

Throws \com\setasign\SetaFramework\Exception

Throws \com\setasign\SetaSite\BlockManager\BlockFinalException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException


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