Class PageEditor in namespace com\setasign\SetaSite\Controller\Backend in SetaSite API Reference

Index

\com\setasign\SetaSite
1. Controller
  1. Backend

com\setasign\SetaSite\Controller\Backend

PageEditor Class Controller Json

File: /SetaSite/src/Controller/Backend/PageEditor.php

Class hierarchy

com\setasign\SetaFramework\Controller\AbstractJsonController
- AbstractBackendJsonController
  - PageEditor

Implements

\com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Properties

$data

protected mixed \com\setasign\SetaFramework\Controller\AbstractJsonController::$data

Result data to convert to JSON.

$encodingOptions

protected int \com\setasign\SetaFramework\Controller\AbstractJsonController::$encodingOptions = 79

Default JSON encoding is performed with the following options, which produces RFC4627-compliant JSON, capable of embedding into HTML.

default value of:

copy

JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES

$httpFactory

protected \com\setasign\SetaFramework\Http\HttpFactoryInterface \com\setasign\SetaFramework\Controller\AbstractController::$httpFactory

$response

protected ?\Psr\Http\Message\ResponseInterface \com\setasign\SetaFramework\Controller\AbstractController::$response

$sessionContext

protected AbstractBackendJsonController::$sessionContext

$setasite

private PageEditor::$setasite

$textContentType

protected bool \com\setasign\SetaFramework\Controller\AbstractJsonController::$textContentType = false

If true the response contentType will be 'text/html; charset=utf-8' instead of 'application/json'.

Needed for the IE. The IE will try to download 'application/json' responses from iframes.

Static Methods

clearSession()

public static PageEditor::clearSession (

\com\setasign\SetaFramework\Session\SessionInterface $session,
int $pageId,
string $language

): void

Parameters

$session : \com\setasign\SetaFramework\Session\SessionInterface
$pageId : int
$language : string

getFromSession()

public static PageEditor::getFromSession (

\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\SetaSite\Page\Page $page,
bool $allowCleanup = false

): void

Parameters

$session : \com\setasign\SetaFramework\Session\SessionInterface
$page : \com\setasign\SetaSite\Page\Page
$allowCleanup : bool

isEdited()

public static PageEditor::isEdited (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\SetaSite\Page\Page $page

): bool

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$session : \com\setasign\SetaFramework\Session\SessionInterface
$page : \com\setasign\SetaSite\Page\Page

saveToSession()

public static PageEditor::saveToSession (

\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\SetaSite\Page\Page $page,
bool $forceNewHash = false

): void

Parameters

$session : \com\setasign\SetaFramework\Session\SessionInterface
$page : \com\setasign\SetaSite\Page\Page
$forceNewHash : bool: When the page is saved we need to generate a new hash!

Methods

__construct()

public PageEditor::__construct (

\com\setasign\SetaSite\SessionContext $sessionContext,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaSite\SetaSite $setasite

)

Parameters

$sessionContext : \com\setasign\SetaSite\SessionContext
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
$setasite : \com\setasign\SetaSite\SetaSite

applyHistoryAction()

public PageEditor::applyHistoryAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageHistory $pageHistory

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$pageHistory : \com\setasign\SetaSite\Page\PageHistory

Exceptions

Throws \com\setasign\SetaSite\Exception

applyPagePropertiesAction()

public PageEditor::applyPagePropertiesAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\Di\Di $di

): void

Veränderung einer Seite; PageProperties

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$di : \com\setasign\SetaFramework\Di\Di

Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

cancelEditModeAction()

public PageEditor::cancelEditModeAction (

\com\setasign\SetaSite\Page\PageLocks $pageLocks

): void

Parameters

$pageLocks : \com\setasign\SetaSite\Page\PageLocks

Exceptions

Throws \com\setasign\SetaSite\Exception

exportBlockAction()

public PageEditor::exportBlockAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\DeploymentHelper $deploymentHelper

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$deploymentHelper : \com\setasign\SetaSite\Page\DeploymentHelper

exportPageAction()

public PageEditor::exportPageAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\DeploymentHelper $pageLocks,
\com\setasign\SetaSite\Page\DeploymentHelper $deploymentHelper

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$pageLocks : \com\setasign\SetaSite\Page\DeploymentHelper
$deploymentHelper : \com\setasign\SetaSite\Page\DeploymentHelper

Exceptions

Throws \JsonException

exportPlaceholderAction()

public PageEditor::exportPlaceholderAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\DeploymentHelper $deploymentHelper

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$deploymentHelper : \com\setasign\SetaSite\Page\DeploymentHelper

getParam()

public \com\setasign\SetaFramework\Controller\AbstractController::getParam (

string $name,
mixed $default = null

): ?mixed

Returns a param if it exists otherwise this will return $default

Parameters

$name : string
$default : mixed

getParams()

public \com\setasign\SetaFramework\Controller\AbstractController::getParams (

void

): array

Get all existing params

getRequest()

protected AbstractBackendJsonController::getRequest (

void

): \com\setasign\SetaFramework\Request\ServerRequest

getResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (

void

): \Psr\Http\Message\ResponseInterface

getSession()

protected AbstractBackendJsonController::getSession (

void

): \com\setasign\SetaFramework\Session\SessionInterface

importBlockAction()

public PageEditor::importBlockAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\DeploymentHelper $deploymentHelper

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$deploymentHelper : \com\setasign\SetaSite\Page\DeploymentHelper

importPageAction()

public PageEditor::importPageAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\DeploymentHelper $deploymentHelper

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$deploymentHelper : \com\setasign\SetaSite\Page\DeploymentHelper

Exceptions

Throws \com\setasign\SetaSite\BlockManager\BlockFinalException

Throws \com\setasign\SetaSite\Controller\MultiLangException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

importPlaceholderAction()

public PageEditor::importPlaceholderAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\DeploymentHelper $deploymentHelper

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$deploymentHelper : \com\setasign\SetaSite\Page\DeploymentHelper

renderBlockAction()

public PageEditor::renderBlockAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\View\View $view

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$view : \com\setasign\SetaFramework\View\View

Exceptions

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

Throws \com\setasign\SetaSite\Exception

renderPlaceholderAction()

public PageEditor::renderPlaceholderAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PlaceholderFinder $placeholderFinder,
\com\setasign\SetaFramework\View\View $view

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$placeholderFinder : \com\setasign\SetaSite\Page\PlaceholderFinder
$view : \com\setasign\SetaFramework\View\View

Exceptions

Throws \Throwable

renderView()

protected \com\setasign\SetaFramework\Controller\AbstractJsonController::renderView (

void

): void

Exceptions

Throws \JsonException

resetResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::resetResponse (

void

): void

saveAction()

public PageEditor::saveAction (

\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaFramework\Di\Di $di

): void

Parameters

$pages : \com\setasign\SetaSite\Page\Pages
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
$di : \com\setasign\SetaFramework\Di\Di

Exceptions

Throws \Throwable

setParam()

public \com\setasign\SetaFramework\Controller\AbstractController::setParam (

string $name,
mixed $value

): \com\setasign\SetaFramework\Controller\ControllerInterface

Sets a param

Parameters

$name : string
$value : mixed

setParams()

public \com\setasign\SetaFramework\Controller\AbstractController::setParams (

array $params

): \com\setasign\SetaFramework\Controller\ControllerInterface

Set a array of params

Note: The params will be merged with the existing params!!

Parameters

$params : array

startEditModeAction()

public PageEditor::startEditModeAction (

\com\setasign\SetaFramework\Database\Database $db,
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaSite\User\Users $users,
\com\setasign\SetaFramework\Di\Di $di

): void

Parameters

$db : \com\setasign\SetaFramework\Database\Database
$pages : \com\setasign\SetaSite\Page\Pages
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
$users : \com\setasign\SetaSite\User\Users
$di : \com\setasign\SetaFramework\Di\Di

Exceptions

Throws \com\setasign\SetaSite\Exception

Throws \com\setasign\SetaFramework\Permissions\PermissionException

Throws \Throwable