1. class
  2. Eccube
  3. Application
  4. ApplicationTrait

ApplicationTrait

class ApplicationTrait extends Application

TODO Traitが使えるようになったら不要になる

Methods

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

Application Shortcut Methods

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

No description

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

No description

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

No description

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

No description

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

No description

clearMessage()

No description

deleteMessage()

No description

setLoginTargetPath($targetPath)

No description

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

Creates and returns a form builder instance

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

Adds a log record.

mixed
user()

Gets a user from the Security context.

string
encodePassword(UserInterface $user, string $password)

Encodes the raw password.

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

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

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

Sends an email.

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

Translates the given message.

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.

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

Renders a view and returns a Response.

Response
renderView(string $view, array $parameters = array())

Renders a view.

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

Generates a path from the given parameters.

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

Generates an absolute URL from the given parameters.

Details

at line 20
addSuccess($message, $namespace = 'front')

Application Shortcut Methods

Parameters

$message
$namespace

at line 25
addError($message, $namespace = 'front')

Parameters

$message
$namespace

at line 30
addDanger($message, $namespace = 'front')

Parameters

$message
$namespace

at line 35
addWarning($message, $namespace = 'front')

Parameters

$message
$namespace

at line 40
addInfo($message, $namespace = 'front')

Parameters

$message
$namespace

at line 45
addRequestError($message, $namespace = 'front')

Parameters

$message
$namespace

at line 50
clearMessage()

at line 55
deleteMessage()

at line 61
setLoginTargetPath($targetPath)

Parameters

$targetPath

at line 86
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

at line 101
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

at line 115
mixed user()

Gets a user from the Security context.

Return Value

mixed

See also

TokenInterface::getUser()

at line 130
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

at line 145
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.

at line 159
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

at line 175
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

at line 191
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

at line 208
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

at line 234
Response 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

Response A Response instance

at line 248
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

at line 261
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