Class Workflow in namespace com\setasign\Konquadrat\Controller\Frontend in Konquadrat API Reference

Index

\com\setasign\Konquadrat
1. Controller
  1. Frontend
    1. Gui
    2. Workflow

com\setasign\Konquadrat\Controller\Frontend

Workflow Class Workflow

File: /Konquadrat/src/Controller/Frontend/Workflow.php

Class hierarchy

\com\setasign\SetaFramework\Controller\AbstractController
- \com\setasign\SetaFramework\Controller\AbstractViewController
  - Workflow

Implements

\com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Properties

$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

$viewScript

protected string \com\setasign\SetaFramework\Controller\AbstractViewController::$viewScript

Static Methods

getWorkflowDataSessionName()

public static Workflow::getWorkflowDataSessionName (

$name

): string

Parameters

$name

getWorkflowSessionName()

public static Workflow::getWorkflowSessionName (

$name

): string

Parameters

$name

resetWorkflows()

public static Workflow::resetWorkflows (

array $workflows,
?string $sessionVersion = null

): void

Parameters

$workflows: array
$sessionVersion: ?string: If null all versions will be reset

Exceptions

Throws \com\setasign\SetaFramework\Session\SessionException

Methods

__construct()

public \com\setasign\SetaFramework\Controller\AbstractViewController::__construct (

\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaFramework\View\View $view

)

Parameters

$httpFactory: \com\setasign\SetaFramework\Http\HttpFactoryInterface
$view: \com\setasign\SetaFramework\View\View

errorAction()

public Workflow::errorAction (

\com\setasign\Konquadrat\SessionContext $context,
\com\setasign\Konquadrat\LanguageManager $languageManager

): string

Parameters

$context: \com\setasign\Konquadrat\SessionContext
$languageManager: \com\setasign\Konquadrat\LanguageManager

Exceptions

Throws \com\setasign\SetaFramework\View\MissingViewException

Throws \com\setasign\SetaFramework\View\RenderException

Throws \com\setasign\SetaFramework\View\ViewException

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

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

getResponse()

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

void

): \Psr\Http\Message\ResponseInterface

getView()

public \com\setasign\SetaFramework\Controller\AbstractViewController::getView (

void

): \com\setasign\SetaFramework\View\View

Returns the view

handlePostRequest()

protected Workflow::handlePostRequest (

\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\SetaFramework\Session\SessionInterface $dataSession

): void

Parameters

$request: \com\setasign\SetaFramework\Request\ServerRequest
$session: \com\setasign\SetaFramework\Session\SessionInterface
$dataSession: \com\setasign\SetaFramework\Session\SessionInterface

Exceptions

Throws \com\setasign\SetaFramework\Helper\CsrfProtectionException

indexAction()

public Workflow::indexAction (

\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\Konquadrat\Konquadrat $konquadrat,
\com\setasign\Konquadrat\Object\History $history,
\com\setasign\Konquadrat\Workflow\WorkflowFactoryInterface $workflowFactory,
\com\setasign\Konquadrat\LanguageManager $languageManager

): string

Parameters

$request: \com\setasign\SetaFramework\Request\ServerRequest
$session: \com\setasign\SetaFramework\Session\SessionInterface
$konquadrat: \com\setasign\Konquadrat\Konquadrat
$history: \com\setasign\Konquadrat\Object\History
$workflowFactory: \com\setasign\Konquadrat\Workflow\WorkflowFactoryInterface
$languageManager: \com\setasign\Konquadrat\LanguageManager

Exceptions

Throws \com\setasign\SetaFramework\Helper\CsrfProtectionException

Throws \com\setasign\Konquadrat\Workflow\ObjectsInitException

Throws \com\setasign\SetaFramework\Session\SessionException

Throws \com\setasign\SetaFramework\View\MissingViewException

Throws \com\setasign\SetaFramework\View\RenderException

renderView()

protected Workflow::renderView (

void

): void

Exceptions

Throws \com\setasign\SetaFramework\View\ViewException

resetResponse()

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

void

): void

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