EC-CUBE4 APIドキュメント

LayoutController extends AbstractController

Table of Contents

DUMMY_BLOCK_ID 9999999999
$blockRepository BlockRepository
$blockPositionRepository BlockPositionRepository
$layoutRepository LayoutRepository
$pageLayoutRepository PageLayoutRepository
$pageRepository PageRepository
$productRepository ProductRepository
$deviceTypeRepository DeviceTypeRepository
$isPreview bool
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() LayoutController constructor. mixed
index() mixed
delete() RedirectResponse
edit() mixed
viewBlock() JsonResponse
preview() mixed
setEccubeConfig() mixed
setEntityManager() mixed
setTranslator() mixed
setSession() mixed
setFormFactory() mixed
setEventDispatcher() mixed
addSuccess() mixed
addError() mixed
addDanger() mixed
addWarning() mixed
addInfo() mixed
addRequestError() mixed
clearMessage() mixed
deleteMessage() mixed
setLoginTargetPath() mixed
forwardToRoute() Forwards the request to another controller. Response
isTokenValid() Checks the validity of a CSRF token. bool

Constants

Properties

Methods

__construct()

LayoutController constructor.

public __construct( $blockRepository : BlockRepository , $blockPositionRepository : BlockPositionRepository , $layoutRepository : LayoutRepository , $pageLayoutRepository : PageLayoutRepository , $pageRepository : pageRepository , $productRepository : ProductRepository , $deviceTypeRepository : DeviceTypeRepository ) : mixed
Parameters
$blockRepository : BlockRepository
$blockPositionRepository : BlockPositionRepository
$layoutRepository : LayoutRepository
$pageLayoutRepository : PageLayoutRepository
$pageRepository : pageRepository
$productRepository : ProductRepository
$deviceTypeRepository : DeviceTypeRepository
Return values
mixed

index()

public index( ) : mixed
Tags
Route

("/%eccube_admin_route%/content/layout", name="admin_content_layout")

Template

("@admin/Content/layout_list.twig")

Return values
mixed

delete()

public delete( $Layout : Layout , $cacheUtil : CacheUtil ) : RedirectResponse
Parameters
$Layout : Layout
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/content/layout/{id}/delete", requirements={"id" = "\d+"}, name="admin_content_layout_delete", methods={"DELETE"})

Return values
RedirectResponse

edit()

public edit( $request : Request [, $id : mixed = null ] [, $previewPageId : mixed = null ] , $cacheUtil : CacheUtil ) : mixed
Parameters
$request : Request
$id : mixed = null
$previewPageId : mixed = null
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/content/layout/new", name="admin_content_layout_new")

Route

("/%eccube_admin_route%/content/layout/{id}/edit", requirements={"id" = "\d+"}, name="admin_content_layout_edit")

Template

("@admin/Content/layout.twig")

Return values
mixed

viewBlock()

public viewBlock( $request : Request , $twig : Environment ) : JsonResponse
Parameters
$request : Request
$twig : Environment
Tags
Route

("/%eccube_admin_route%/content/layout/view_block", name="admin_content_layout_view_block", methods={"GET"})

Return values
JsonResponse

preview()

public preview( $request : Request , $id : mixed , $cacheUtil : CacheUtil ) : mixed
Parameters
$request : Request
$id : mixed
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/content/layout/{id}/preview", requirements={"id" = "\d+"}, name="admin_content_layout_preview")

Return values
mixed

setEntityManager()

public setEntityManager( $entityManager : EntityManagerInterface ) : mixed
Parameters
$entityManager : EntityManagerInterface
Tags
required
Return values
mixed

setTranslator()

public setTranslator( $translator : TranslatorInterface ) : mixed
Parameters
$translator : TranslatorInterface
Tags
required
Return values
mixed

setSession()

public setSession( $session : SessionInterface ) : mixed
Parameters
$session : SessionInterface
Tags
required
Return values
mixed

setFormFactory()

public setFormFactory( $formFactory : FormFactoryInterface ) : mixed
Parameters
$formFactory : FormFactoryInterface
Tags
required
Return values
mixed

setEventDispatcher()

public setEventDispatcher( $eventDispatcher : EventDispatcherInterface ) : mixed
Parameters
$eventDispatcher : EventDispatcherInterface
Tags
required
Return values
mixed

addSuccess()

public addSuccess( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addError()

public addError( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addDanger()

public addDanger( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addWarning()

public addWarning( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addInfo()

public addInfo( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addRequestError()

public addRequestError( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

setLoginTargetPath()

public setLoginTargetPath( $targetPath : string [, $namespace : mixed = null ] ) : mixed
Parameters
$targetPath : string
$namespace : mixed = null
Return values
mixed

forwardToRoute()

Forwards the request to another controller.

public forwardToRoute( $route : string [, $path : array = [] ] [, $query : array = [] ] ) : Response
Parameters
$route : string

The name of the route

$path : array = []

An array of path parameters

$query : array = []

An array of query parameters

Return values
Response —

A Response instance

isTokenValid()

Checks the validity of a CSRF token.

protected isTokenValid( ) : bool

if token is invalid, throws AccessDeniedHttpException.

Tags
throws
AccessDeniedHttpException
Return values
bool

Search results