1. class
  2. Eccube
  3. Application

Application

class Application extends ApplicationTrait

Properties

static protected $instance
protected $initialized
protected $initializedPlugin
protected $testMode

Methods

addSuccess($message, $namespace = 'front')

Application Shortcut Methods

from ApplicationTrait
addError($message, $namespace = 'front')

No description

from ApplicationTrait
addDanger($message, $namespace = 'front')

No description

from ApplicationTrait
addWarning($message, $namespace = 'front')

No description

from ApplicationTrait
addInfo($message, $namespace = 'front')

No description

from ApplicationTrait
addRequestError($message, $namespace = 'front')

No description

from ApplicationTrait
clearMessage()

No description

from ApplicationTrait
deleteMessage()

No description

from ApplicationTrait
setLoginTargetPath($targetPath, $namespace = null)

No description

from ApplicationTrait
isAdminRequest()

No description

from ApplicationTrait
isFrontRequest()

No description

from ApplicationTrait
FormBuilder
form(mixed $data = null, array $options = array())

Creates and returns a form builder instance

from ApplicationTrait
bool
log(string $message, array $context = array(), int $level = Logger::INFO)

Adds a log record.

from ApplicationTrait
mixed
user()

Gets a user from the Security context.

from ApplicationTrait
string
encodePassword(UserInterface $user, string $password)

Encodes the raw password.

from ApplicationTrait
bool
isGranted(mixed $attributes, mixed $object = null)

Checks if the attributes are granted against the current authentication token and optionally supplied object.

from ApplicationTrait
int
mail(Swift_Message $message, array $failedRecipients = null)

Sends an email.

from ApplicationTrait
string
trans(string $id, array $parameters = array(), string $domain = 'messages', string $locale = null)

Translates the given message.

from ApplicationTrait
string
transChoice(string $id, int $number, array $parameters = array(), string $domain = 'messages', string $locale = null)

Translates the given choice message by choosing a translation according to a number.

from ApplicationTrait
Response
render(string $view, array $parameters = array(), Response $response = null)

Renders a view and returns a Response.

from ApplicationTrait
string
renderView(string $view, array $parameters = array())

Renders a view.

from ApplicationTrait
string
path(string $route, mixed $parameters = array())

Generates a path from the given parameters.

from ApplicationTrait
string
url(string $route, mixed $parameters = array())

Generates an absolute URL from the given parameters.

from ApplicationTrait
static 
getInstance(array $values = array())

No description

static 
clearInstance()

No description

__clone()

No description

__construct(array $values = array())

No description

bool
isBooted()

Application::runが実行されているか親クラスのプロパティから判定

initConfig()

No description

initLogger()

No description

initialize()

No description

initLocale()

No description

initSession()

No description

initRendering()

No description

initMailer()

No description

initDoctrine()

No description

initSecurity()

No description

initializePlugin()

No description

initPluginEventDispatcher()

No description

loadPlugin()

No description

setTestMode(boolean $testMode)

PHPUnit を実行中かどうかを設定する.

boolean
isTestMode()

PHPUnit を実行中かどうか.

boolean
checkDatabaseConnection()

データベースの接続を確認 成功 : trueを返却 失敗 : \Doctrine\DBAL\DBALExceptionエラーが発生( 接続に失敗した場合 )、エラー画面を表示しdie() 備考 : app['debug']がtrueの際は処理を行わない

Application
parseConfig(string $config_name, array $configAll, boolean $wrap_key = false, string $ymlPath = null, string $distPath = null)

Config ファイルをパースし、連想配列を返します.

boolean
isSessionStarted()

セッションが開始されているかどうか.

initCacheRequest()

Http Cache対応

array
getPluginConfigAll()

すべてのプラグインの設定情報を返す.

int|boolean
writePluginConfigCache(string $cacheFile = null)

プラグイン設定情報のキャッシュを書き込む.

boolean
removePluginConfigCache()

プラグイン設定情報のキャッシュファイルを削除する.

string
getPluginConfigCacheFile()

プラグイン設定情報のキャッシュファイルパスを返す.

array
parsePluginConfigs()

プラグイン設定情報をパースし, 連想配列で返す.

Details

in ApplicationTrait at line 21
addSuccess($message, $namespace = 'front')

Application Shortcut Methods

Parameters

$message
$namespace

in ApplicationTrait at line 26
addError($message, $namespace = 'front')

Parameters

$message
$namespace

in ApplicationTrait at line 31
addDanger($message, $namespace = 'front')

Parameters

$message
$namespace

in ApplicationTrait at line 36
addWarning($message, $namespace = 'front')

Parameters

$message
$namespace

in ApplicationTrait at line 41
addInfo($message, $namespace = 'front')

Parameters

$message
$namespace

in ApplicationTrait at line 46
addRequestError($message, $namespace = 'front')

Parameters

$message
$namespace

in ApplicationTrait at line 51
clearMessage()

in ApplicationTrait at line 56
deleteMessage()

in ApplicationTrait at line 62
setLoginTargetPath($targetPath, $namespace = null)

Parameters

$targetPath
$namespace

in ApplicationTrait at line 71
isAdminRequest()

in ApplicationTrait at line 76
isFrontRequest()

in ApplicationTrait at line 101
FormBuilder form(mixed $data = null, array $options = array())

Creates and returns a form builder instance

Parameters

mixed $data The initial data for the form
array $options Options for the form

Return Value

FormBuilder

in ApplicationTrait at line 116
bool log(string $message, array $context = array(), int $level = Logger::INFO)

Adds a log record.

Parameters

string $message The log message
array $context The log context
int $level The logging level

Return Value

bool Whether the record has been processed

in ApplicationTrait at line 130
mixed user()

Gets a user from the Security context.

Return Value

mixed

See also

TokenInterface::getUser()

in ApplicationTrait at line 145
string encodePassword(UserInterface $user, string $password)

Encodes the raw password.

Parameters

UserInterface $user A UserInterface instance
string $password The password to encode

Return Value

string The encoded password

Exceptions

RuntimeException when no password encoder could be found for the user

in ApplicationTrait at line 160
bool isGranted(mixed $attributes, mixed $object = null)

Checks if the attributes are granted against the current authentication token and optionally supplied object.

Parameters

mixed $attributes
mixed $object

Return Value

bool

Exceptions

AuthenticationCredentialsNotFoundException when the token storage has no authentication token.

in ApplicationTrait at line 174
int mail(Swift_Message $message, array $failedRecipients = null)

Sends an email.

Parameters

Swift_Message $message A \Swift_Message instance
array $failedRecipients An array of failures by-reference

Return Value

int The number of sent messages

in ApplicationTrait at line 190
string trans(string $id, array $parameters = array(), string $domain = 'messages', string $locale = null)

Translates the given message.

Parameters

string $id The message id
array $parameters An array of parameters for the message
string $domain The domain for the message
string $locale The locale

Return Value

string The translated string

in ApplicationTrait at line 206
string transChoice(string $id, int $number, array $parameters = array(), string $domain = 'messages', string $locale = null)

Translates the given choice message by choosing a translation according to a number.

Parameters

string $id The message id
int $number The number to use to find the indice of the message
array $parameters An array of parameters for the message
string $domain The domain for the message
string $locale The locale

Return Value

string The translated string

in ApplicationTrait at line 223
Response render(string $view, array $parameters = array(), Response $response = null)

Renders a view and returns a Response.

To stream a view, pass an instance of StreamedResponse as a third argument.

Parameters

string $view The view name
array $parameters An array of parameters to pass to the view
Response $response A Response instance

Return Value

Response A Response instance

in ApplicationTrait at line 271
string renderView(string $view, array $parameters = array())

Renders a view.

Parameters

string $view The view name
array $parameters An array of parameters to pass to the view

Return Value

string The rendered view

in ApplicationTrait at line 285
string path(string $route, mixed $parameters = array())

Generates a path from the given parameters.

Parameters

string $route The name of the route
mixed $parameters An array of parameters

Return Value

string The generated path

in ApplicationTrait at line 298
string url(string $route, mixed $parameters = array())

Generates an absolute URL from the given parameters.

Parameters

string $route The name of the route
mixed $parameters An array of parameters

Return Value

string The generated URL

at line 48
static getInstance(array $values = array())

Parameters

array $values

at line 57
static clearInstance()

at line 62
final __clone()

at line 67
__construct(array $values = array())

Parameters

array $values

at line 87
bool isBooted()

Application::runが実行されているか親クラスのプロパティから判定

Return Value

bool

at line 92
initConfig()

at line 113
initLogger()

at line 119
initialize()

at line 203
initLocale()

at line 232
initSession()

at line 257
initRendering()

at line 387
initMailer()

at line 417
initDoctrine()

at line 505
initSecurity()

at line 606
initializePlugin()

at line 621
initPluginEventDispatcher()

at line 826
loadPlugin()

at line 937
setTestMode(boolean $testMode)

PHPUnit を実行中かどうかを設定する.

Parameters

boolean $testMode PHPUnit を実行中の場合 true

at line 947
boolean isTestMode()

PHPUnit を実行中かどうか.

Return Value

boolean PHPUnit を実行中の場合 true

at line 962
protected boolean checkDatabaseConnection()

データベースの接続を確認 成功 : trueを返却 失敗 : \Doctrine\DBAL\DBALExceptionエラーが発生( 接続に失敗した場合 )、エラー画面を表示しdie() 備考 : app['debug']がtrueの際は処理を行わない

Return Value

boolean true

at line 1000
Application parseConfig(string $config_name, array $configAll, boolean $wrap_key = false, string $ymlPath = null, string $distPath = null)

Config ファイルをパースし、連想配列を返します.

$configname.yml ファイルをパースし、連想配列を返します. $configname.php が存在する場合は、 PHP ファイルに記述された連想配列を使用します。

Parameters

string $config_name Config 名称
array $configAll Config の連想配列
boolean $wrap_key Config の連想配列に config_name のキーを生成する場合 true, デフォルト false
string $ymlPath config yaml を格納したディレクトリ
string $distPath config yaml dist を格納したディレクトリ

Return Value

Application

at line 1048
protected boolean isSessionStarted()

セッションが開始されているかどうか.

Return Value

boolean セッションが開始済みの場合 true

at line 1064
protected initCacheRequest()

Http Cache対応

at line 1138
array getPluginConfigAll()

すべてのプラグインの設定情報を返す.

すべてのプラグインの config.yml 及び event.yml を読み込み、連想配列で返す. キャッシュファイルが存在する場合は、キャッシュを利用する. キャッシュファイルが存在しない場合は、キャッシュを生成する. $app['debug'] = true の場合は、キャッシュを利用しない.

Return Value

array

at line 1160
int|boolean writePluginConfigCache(string $cacheFile = null)

プラグイン設定情報のキャッシュを書き込む.

Parameters

string $cacheFile

Return Value

int|boolean fileputcontents() の結果

at line 1178
boolean removePluginConfigCache()

プラグイン設定情報のキャッシュファイルを削除する.

Return Value

boolean

at line 1193
string getPluginConfigCacheFile()

プラグイン設定情報のキャッシュファイルパスを返す.

Return Value

string

at line 1206
array parsePluginConfigs()

プラグイン設定情報をパースし, 連想配列で返す.

すべてのプラグインを探索し、 config.yml 及び event.yml をパースする. パースした情報を連想配列で返す.

Return Value

array