EC-CUBE4 APIドキュメント

CsvImportController extends AbstractCsvImportController

Table of Contents

$deliveryDurationRepository DeliveryDurationRepository
$saleTypeRepository SaleTypeRepository
$tagRepository TagRepository
$categoryRepository CategoryRepository
$classCategoryRepository ClassCategoryRepository
$productStatusRepository ProductStatusRepository
$productRepository ProductRepository
$taxRuleRepository TaxRuleRepository
$BaseInfo BaseInfo
$validator ValidatorInterface
$errors
$csvFileName アップロードされたCSVファイル名 string
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() CsvImportController constructor. mixed
csvProduct() 商品登録CSVアップロード array
csvCategory() カテゴリ登録CSVアップロード mixed
csvTemplate() アップロード用CSV雛形ファイルダウンロード StreamedResponse
renderWithError() 登録、更新時のエラー画面表示 array
createProductImage() 商品画像の削除、登録 mixed
createProductCategory() 商品カテゴリの削除、登録 mixed
createProductTag() タグの登録 mixed
createProductClass() 商品規格分類1、商品規格分類2がnullとなる商品規格情報を作成 ProductClass
updateProductClass() 商品規格情報を更新 ProductClass
addErrors() 登録、更新時のエラー画面表示 mixed
getErrors() array
hasErrors() bool
getProductCsvHeader() 商品登録CSVヘッダー定義 array
getCategoryCsvHeader() カテゴリCSVヘッダー定義 mixed
makeProductCategory() ProductCategory作成 ProductCategory
getImportData() アップロードされたCSVファイルの行ごとの処理 CsvImportService|bool
sendTemplateResponse() mixed
removeUploadedFile() アップロードされたCSVファイルの削除 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

Properties

Methods

__construct()

CsvImportController constructor.

public __construct( $deliveryDurationRepository : DeliveryDurationRepository , $saleTypeRepository : SaleTypeRepository , $tagRepository : TagRepository , $categoryRepository : CategoryRepository , $classCategoryRepository : ClassCategoryRepository , $productStatusRepository : ProductStatusRepository , $productRepository : ProductRepository , $taxRuleRepository : TaxRuleRepository , $baseInfoRepository : BaseInfoRepository , $validator : ValidatorInterface ) : mixed
Parameters
$deliveryDurationRepository : DeliveryDurationRepository
$saleTypeRepository : SaleTypeRepository
$tagRepository : TagRepository
$categoryRepository : CategoryRepository
$classCategoryRepository : ClassCategoryRepository
$productStatusRepository : ProductStatusRepository
$productRepository : ProductRepository
$taxRuleRepository : TaxRuleRepository
$baseInfoRepository : BaseInfoRepository
$validator : ValidatorInterface
Tags
throws
Exception
Return values
mixed

csvProduct()

商品登録CSVアップロード

public csvProduct( $request : Request , $cacheUtil : CacheUtil ) : array
Parameters
$request : Request
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/product/product_csv_upload", name="admin_product_csv_import")

Template

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

throws
ConnectionException
throws
NoResultException
Return values
array

csvCategory()

カテゴリ登録CSVアップロード

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

("/%eccube_admin_route%/product/category_csv_upload", name="admin_product_category_csv_import")

Template

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

Return values
mixed

csvTemplate()

アップロード用CSV雛形ファイルダウンロード

public csvTemplate( $request : Request , $type : ) : StreamedResponse
Parameters
$request : Request
$type :
Tags
Route

("/%eccube_admin_route%/product/csv_template/{type}", requirements={"type" = "\w+"}, name="admin_product_csv_template")

Return values
StreamedResponse

renderWithError()

登録、更新時のエラー画面表示

protected renderWithError( $form : FormInterface , $headers : array [, $rollback : bool = true ] ) : array
Parameters
$form : FormInterface
$headers : array
$rollback : bool = true
Tags
throws
ConnectionException
Return values
array

createProductClass()

商品規格分類1、商品規格分類2がnullとなる商品規格情報を作成

protected createProductClass( $row : , $Product : Product , $data : CsvImportService , $headerByKey : [, $ClassCategory1 : null = null ] [, $ClassCategory2 : null = null ] ) : ProductClass
Parameters
$row :
$Product : Product
$data : CsvImportService
$headerByKey :
$ClassCategory1 : null = null
$ClassCategory2 : null = null
Return values
ProductClass

addErrors()

登録、更新時のエラー画面表示

protected addErrors( $message : mixed ) : mixed
Parameters
$message : mixed
Return values
mixed

getProductCsvHeader()

商品登録CSVヘッダー定義

protected getProductCsvHeader( ) : array
Return values
array

getCategoryCsvHeader()

カテゴリCSVヘッダー定義

protected getCategoryCsvHeader( ) : mixed
Return values
mixed

sendTemplateResponse()

protected sendTemplateResponse( $request : Request , $columns : mixed , $filename : mixed ) : mixed
Parameters
$request : Request
$columns : mixed
$filename : mixed
Return values
mixed

removeUploadedFile()

アップロードされたCSVファイルの削除

protected removeUploadedFile( ) : mixed
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