EC-CUBE4 APIドキュメント

InstallController extends AbstractController

Table of Contents

DEFAULT_AUTH_MAGIC default value of auth magic '<change.me>'
$requiredModules
$recommendedModules
$eccubeDirs
$eccubeFiles
$encoder PasswordEncoder
$cacheUtil CacheUtil
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() mixed
index() 最初からやり直す場合、SESSION情報をクリア. RedirectResponse
step1() ようこそ. array|RedirectResponse
step2() ディレクトリとファイルの書き込み権限をチェック. array
step3() サイトの設定. array|RedirectResponse
step4() データベースの設定. array|RedirectResponse
step5() データベースの初期化. array|RedirectResponse
complete() インストール完了 mixed
getSessionData() mixed
removeSessionData() mixed
setSessionData() mixed
checkModules() mixed
createConnection() mixed
createEntityManager() mixed
createDatabaseUrl() string
extractDatabaseUrl() array
createMailerUrl() string
extractMailerUrl() array
createMigration() mixed
dropTables() mixed
createTables() mixed
importCsv() mixed
insert() mixed
update() mixed
migrate() mixed
createAppData() array
sendAppData() mixed
getDatabaseVersion() string
convertAdminAllowHosts() string
isInstalled() bool
isInstallEnv() bool
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

DEFAULT_AUTH_MAGIC

default value of auth magic

public mixed $DEFAULT_AUTH_MAGIC = '<change.me>'

Properties

$requiredModules

protected mixed $requiredModules = ['pdo', 'phar', 'mbstring', 'zlib', 'ctype', 'session', 'JSON', 'xml', 'libxml', 'OpenSSL', 'zip', 'cURL', 'fileinfo', 'intl']

$recommendedModules

protected mixed $recommendedModules = ['hash', 'mcrypt']

$eccubeDirs

protected mixed $eccubeDirs = ['app/Plugin', 'app/PluginData', 'app/proxy', 'app/template', 'html', 'var', 'vendor']

$eccubeFiles

protected mixed $eccubeFiles = ['composer.json', 'composer.lock']

Methods

index()

最初からやり直す場合、SESSION情報をクリア.

public index( ) : RedirectResponse
Tags
Route

("/", name="homepage")

Route

("/install", name="install")

Template

("index.twig")

Return values
RedirectResponse

step1()

ようこそ.

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

("/install/step1", name="install_step1")

Template

("step1.twig")

Return values
array|RedirectResponse

step2()

ディレクトリとファイルの書き込み権限をチェック.

public step2( ) : array
Tags
Route

("/install/step2", name="install_step2")

Template

("step2.twig")

Return values
array

step3()

サイトの設定.

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

("/install/step3", name="install_step3")

Template

("step3.twig")

throws
DBALException
throws
Exception
Return values
array|RedirectResponse

step4()

データベースの設定.

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

("/install/step4", name="install_step4")

Template

("step4.twig")

throws
Exception
Return values
array|RedirectResponse

step5()

データベースの初期化.

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

("/install/step5", name="install_step5")

Template

("step5.twig")

throws
Exception
Return values
array|RedirectResponse

complete()

インストール完了

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

("/install/complete", name="install_complete")

Template

("complete.twig")

Return values
mixed

getSessionData()

protected getSessionData( $session : SessionInterface ) : mixed
Parameters
$session : SessionInterface
Return values
mixed

removeSessionData()

protected removeSessionData( $session : SessionInterface ) : mixed
Parameters
$session : SessionInterface
Return values
mixed

setSessionData()

protected setSessionData( $session : SessionInterface [, $data : mixed = [] ] ) : mixed
Parameters
$session : SessionInterface
$data : mixed = []
Return values
mixed

createConnection()

protected createConnection( $params : array ) : mixed
Parameters
$params : array
Return values
mixed

createEntityManager()

protected createEntityManager( $conn : Connection ) : mixed
Parameters
$conn : Connection
Return values
mixed

createDatabaseUrl()

public createDatabaseUrl( $params : array ) : string
Parameters
$params : array
Return values
string

extractDatabaseUrl()

public extractDatabaseUrl( $url : string ) : array
Parameters
$url : string
Return values
array

extractMailerUrl()

public extractMailerUrl( $url : string ) : array
Parameters
$url : string
Return values
array

createMigration()

protected createMigration( $conn : Connection ) : mixed
Parameters
$conn : Connection
Return values
mixed

dropTables()

protected dropTables( $em : EntityManager ) : mixed
Parameters
$em : EntityManager
Return values
mixed

createTables()

protected createTables( $em : EntityManager ) : mixed
Parameters
$em : EntityManager
Return values
mixed

importCsv()

protected importCsv( $em : EntityManager ) : mixed
Parameters
$em : EntityManager
Return values
mixed

insert()

protected insert( $conn : Connection , $data : array ) : mixed
Parameters
$conn : Connection
$data : array
Return values
mixed

update()

protected update( $conn : Connection , $data : array ) : mixed
Parameters
$conn : Connection
$data : array
Return values
mixed

migrate()

public migrate( $migration : Migration ) : mixed
Parameters
$migration : Migration
Return values
mixed

createAppData()

public createAppData( $params : array , $em : EntityManager ) : array
Parameters
$params : array
$em : EntityManager
Return values
array

sendAppData()

protected sendAppData( $params : array , $em : EntityManager ) : mixed
Parameters
$params : array
$em : EntityManager
Return values
mixed

getDatabaseVersion()

public getDatabaseVersion( $em : EntityManager ) : string
Parameters
$em : EntityManager
Return values
string

convertAdminAllowHosts()

public convertAdminAllowHosts( $adminAllowHosts : mixed ) : string
Parameters
$adminAllowHosts : mixed
Return values
string

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