EC-CUBE4 APIドキュメント

AdminController extends AbstractController

Table of Contents

$authorizationChecker AuthorizationCheckerInterface
$helper AuthenticationUtils
$memberRepository MemberRepository
$encoderFactory EncoderFactoryInterface
$orderRepository OrderRepository
$orderStatusRepository OrderStatusRepository
$customerRepository CustomerRepository
$productRepository ProductRepository
$pluginApiService PluginApiService
$excludes array
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() AdminController constructor. mixed
login() mixed
index() 管理画面ホーム array
sale() 売上状況の取得 JsonResponse
changePassword() パスワード変更画面 RedirectResponse|array
searchNonStockProducts() 在庫なし商品の検索結果を表示する. Response
searchCustomer() 本会員の検索結果を表示する. Response
getOrderEachStatus() null|Request
getSalesByDay() array|mixed
getSalesByMonth() array|mixed
countNonStockProducts() 在庫切れ商品数を取得 mixed
countProducts() 商品数を取得 mixed
countCustomers() 本会員数を取得 mixed
getData() 期間指定のデータを取得 array
convert() 期間毎にデータをまとめる array
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

$authorizationChecker

protected AuthorizationCheckerInterface $authorizationChecker

$excludes

private array $excludes = [\Eccube\Entity\Master\OrderStatus::CANCEL, \Eccube\Entity\Master\OrderStatus::PENDING, \Eccube\Entity\Master\OrderStatus::PROCESSING, \Eccube\Entity\Master\OrderStatus::RETURNED]

Methods

__construct()

AdminController constructor.

public __construct( $authorizationChecker : AuthorizationCheckerInterface , $helper : AuthenticationUtils , $memberRepository : MemberRepository , $encoderFactory : EncoderFactoryInterface , $orderRepository : OrderRepository , $orderStatusRepository : OrderStatusRepository , $custmerRepository : CustomerRepository , $productRepository : ProductRepository , $pluginApiService : PluginApiService ) : mixed
Parameters
$authorizationChecker : AuthorizationCheckerInterface
$helper : AuthenticationUtils
$memberRepository : MemberRepository
$encoderFactory : EncoderFactoryInterface
$orderRepository : OrderRepository
$orderStatusRepository : OrderStatusRepository
$custmerRepository : CustomerRepository
$productRepository : ProductRepository
$pluginApiService : PluginApiService
Return values
mixed

login()

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

("/%eccube_admin_route%/login", name="admin_login")

Template

("@admin/login.twig")

Return values
mixed

index()

管理画面ホーム

public index( $request : Request ) : array
Parameters
$request : Request
Tags
throws
NoResultException
throws
NonUniqueResultException
Route

("/%eccube_admin_route%/", name="admin_homepage")

Template

("@admin/index.twig")

Return values
array

sale()

売上状況の取得

public sale( $request : Request ) : JsonResponse
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/sale_chart", name="admin_homepage_sale")

Return values
JsonResponse

changePassword()

パスワード変更画面

public changePassword( $request : Request ) : RedirectResponse|array
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/change_password", name="admin_change_password")

Template

("@admin/change_password.twig")

Return values
RedirectResponse|array

searchNonStockProducts()

在庫なし商品の検索結果を表示する.

public searchNonStockProducts( $request : Request ) : Response
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/search_nonstock", name="admin_homepage_nonstock")

Return values
Response

searchCustomer()

本会員の検索結果を表示する.

public searchCustomer( $request : Request ) : Response
Parameters
$request : Request
Tags
Route

("/%eccube_admin_route%/search_customer", name="admin_homepage_customer")

Return values
Response

getOrderEachStatus()

protected getOrderEachStatus( $excludes : array ) : null|Request
Parameters
$excludes : array
Return values
null|Request

getSalesByDay()

protected getSalesByDay( $dateTime : ) : array|mixed
Parameters
$dateTime :
Tags
throws
NonUniqueResultException
Return values
array|mixed

getSalesByMonth()

protected getSalesByMonth( $dateTime : ) : array|mixed
Parameters
$dateTime :
Tags
throws
NonUniqueResultException
Return values
array|mixed

countNonStockProducts()

在庫切れ商品数を取得

protected countNonStockProducts( ) : mixed
Tags
throws
NonUniqueResultException
Return values
mixed

countProducts()

商品数を取得

protected countProducts( ) : mixed
Tags
throws
NonUniqueResultException
Return values
mixed

countCustomers()

本会員数を取得

protected countCustomers( ) : mixed
Tags
throws
NonUniqueResultException
Return values
mixed

getData()

期間指定のデータを取得

protected getData( $fromDate : Carbon , $toDate : Carbon , $format : ) : array
Parameters
$fromDate : Carbon
$toDate : Carbon
$format :
Return values
array

convert()

期間毎にデータをまとめる

protected convert( $result : , $fromDate : Carbon , $toDate : Carbon , $format : ) : array
Parameters
$result :
$fromDate : Carbon
$toDate : Carbon
$format :
Return values
array

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