EC-CUBE4 APIドキュメント

ProductClassController extends AbstractController

Table of Contents

$productRepository ProductRepository
$productClassRepository ProductClassRepository
$classCategoryRepository ClassCategoryRepository
$baseInfoRepository BaseInfoRepository
$taxRuleRepository TaxRuleRepository
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() ProductClassController constructor. mixed
index() 商品規格が登録されていなければ新規登録, 登録されていれば更新画面を表示する mixed
clearProductClasses() 商品規格を初期化する. mixed
createProductClasses() 規格名1/2から, 商品規格の組み合わせを生成する. array|\Eccube\Entity\ProductClass[]
mergeProductClasses() 商品規格の配列をマージする. array|\Eccube\Entity\ProductClass[]
saveProductClasses() 商品規格を登録, 更新する. mixed
createMatrixForm() 商品規格登録フォームを生成する. FormInterface
findProduct() 商品を取得する. Product|null
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()

ProductClassController constructor.

public __construct( $productRepository : ProductRepository , $productClassRepository : ProductClassRepository , $classCategoryRepository : ClassCategoryRepository , $baseInfoRepository : BaseInfoRepository , $taxRuleRepository : TaxRuleRepository ) : mixed
Parameters
$productRepository : ProductRepository
$productClassRepository : ProductClassRepository
$classCategoryRepository : ClassCategoryRepository
$baseInfoRepository : BaseInfoRepository
$taxRuleRepository : TaxRuleRepository
Return values
mixed

index()

商品規格が登録されていなければ新規登録, 登録されていれば更新画面を表示する

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

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

Template

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

Return values
mixed

clearProductClasses()

商品規格を初期化する.

public clearProductClasses( $request : Request , $Product : Product , $cacheUtil : CacheUtil ) : mixed
Parameters
$request : Request
$Product : Product
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/product/product/class/{id}/clear", requirements={"id" = "\d+"}, name="admin_product_product_class_clear")

Return values
mixed

createProductClasses()

規格名1/2から, 商品規格の組み合わせを生成する.

protected createProductClasses( $ClassName1 : ClassName [, $ClassName2 : ClassName|null = null ] ) : array|\Eccube\Entity\ProductClass[]
Parameters
$ClassName1 : ClassName
$ClassName2 : ClassName|null = null
Return values
array|\Eccube\Entity\ProductClass[]

mergeProductClasses()

商品規格の配列をマージする.

protected mergeProductClasses( $ProductClassesForMatrix : , $ProductClasses : ) : array|\Eccube\Entity\ProductClass[]
Parameters
$ProductClassesForMatrix :
$ProductClasses :
Return values
array|\Eccube\Entity\ProductClass[]

saveProductClasses()

商品規格を登録, 更新する.

protected saveProductClasses( $Product : Product [, $ProductClasses : array|\Eccube\Entity\ProductClass[] = [] ] ) : mixed
Parameters
$Product : Product
$ProductClasses : array|\Eccube\Entity\ProductClass[] = []
Return values
mixed

createMatrixForm()

商品規格登録フォームを生成する.

protected createMatrixForm( [ $ProductClasses : array = [] ] [, $ClassName1 : ClassName|null = null ] [, $ClassName2 : ClassName|null = null ] [, $options : array = [] ] ) : FormInterface
Parameters
$ProductClasses : array = []
$ClassName1 : ClassName|null = null
$ClassName2 : ClassName|null = null
$options : array = []
Return values
FormInterface

findProduct()

商品を取得する.

protected findProduct( $id : ) : Product|null

商品規格はvisible=trueのものだけを取得し, 規格分類はsort_no=DESCでソートされている.

Parameters
$id :
Tags
throws
NonUniqueResultException
Return values
Product|null

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