EC-CUBE4 APIドキュメント

ProductController extends AbstractController

Table of Contents

$csvExportService CsvExportService
$productClassRepository ProductClassRepository
$productImageRepository ProductImageRepository
$taxRuleRepository TaxRuleRepository
$categoryRepository CategoryRepository
$productRepository ProductRepository
$BaseInfo BaseInfo
$pageMaxRepository PageMaxRepository
$productStatusRepository ProductStatusRepository
$tagRepository TagRepository
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() ProductController constructor. mixed
index() mixed
loadProductClasses() mixed
addImage() mixed
edit() mixed
delete() mixed
copy() mixed
display() mixed
export() 商品CSVの出力. StreamedResponse
createProductCategory() ProductCategory作成 ProductCategory
bulkProductStatus() Bulk public action RedirectResponse
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

Properties

Methods

__construct()

ProductController constructor.

public __construct( $csvExportService : CsvExportService , $productClassRepository : ProductClassRepository , $productImageRepository : ProductImageRepository , $taxRuleRepository : TaxRuleRepository , $categoryRepository : CategoryRepository , $productRepository : ProductRepository , $baseInfoRepository : BaseInfoRepository , $pageMaxRepository : PageMaxRepository , $productStatusRepository : ProductStatusRepository , $tagRepository : TagRepository ) : mixed
Parameters
$csvExportService : CsvExportService
$productClassRepository : ProductClassRepository
$productImageRepository : ProductImageRepository
$taxRuleRepository : TaxRuleRepository
$categoryRepository : CategoryRepository
$productRepository : ProductRepository
$baseInfoRepository : BaseInfoRepository
$pageMaxRepository : PageMaxRepository
$productStatusRepository : ProductStatusRepository
$tagRepository : TagRepository
Return values
mixed

index()

public index( $request : Request [, $page_no : mixed = null ] , $paginator : Paginator ) : mixed
Parameters
$request : Request
$page_no : mixed = null
$paginator : Paginator
Tags
Route

("/%eccube_admin_route%/product", name="admin_product")

Route

("/%eccube_admin_route%/product/page/{page_no}", requirements={"page_no" = "\d+"}, name="admin_product_page")

Template

("@admin/Product/index.twig")

Return values
mixed

loadProductClasses()

public loadProductClasses( $request : Request , $Product : Product ) : mixed
Parameters
$request : Request
$Product : Product
Tags
Route

("/%eccube_admin_route%/product/classes/{id}/load", name="admin_product_classes_load", methods={"GET"}, requirements={"id" = "\d+"})

Template

("@admin/Product/product_class_popup.twig")

ParamConverter

("Product")

Return values
mixed

addImage()

public addImage( $request : Request ) : mixed
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/product/product/image/add", name="admin_product_image_add", methods={"POST"})

Return values
mixed

edit()

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

("/%eccube_admin_route%/product/product/new", name="admin_product_product_new")

Route

("/%eccube_admin_route%/product/product/{id}/edit", requirements={"id" = "\d+"}, name="admin_product_product_edit")

Template

("@admin/Product/product.twig")

Return values
mixed

delete()

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

("/%eccube_admin_route%/product/product/{id}/delete", requirements={"id" = "\d+"}, name="admin_product_product_delete", methods={"DELETE"})

Return values
mixed

copy()

public copy( $request : Request [, $id : mixed = null ] ) : mixed
Parameters
$request : Request
$id : mixed = null
Tags
Route

("/%eccube_admin_route%/product/product/{id}/copy", requirements={"id" = "\d+"}, name="admin_product_product_copy", methods={"POST"})

Return values
mixed

display()

public display( $request : Request [, $id : mixed = null ] ) : mixed
Parameters
$request : Request
$id : mixed = null
Tags
Route

("/%eccube_admin_route%/product/product/{id}/display", requirements={"id" = "\d+"}, name="admin_product_product_display")

Return values
mixed

export()

商品CSVの出力.

public export( $request : Request ) : StreamedResponse
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/product/export", name="admin_product_export")

Return values
StreamedResponse

bulkProductStatus()

Bulk public action

public bulkProductStatus( $request : Request , $ProductStatus : ProductStatus , $cacheUtil : CacheUtil ) : RedirectResponse
Parameters
$request : Request
$ProductStatus : ProductStatus
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/product/bulk/product-status/{id}", requirements={"id" = "\d+"}, name="admin_product_bulk_product_status", methods={"POST"})

Return values
RedirectResponse

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