App
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\App
- Since
- 3.0.0
App helper.
Public Methods
Method | Description |
---|---|
assetManagerConfig() | Returns the assetManager component config for web requests. |
backtrace() | Returns the backtrace as a string (omitting the final frame where this method was called). |
cacheConfig() | Returns the cache component config. |
checkForValidIconv() | Returns whether the server has a valid version of the iconv extension installed. |
cliOption() | Returns a CLI command option from argv , or null if it wasn’t passed. |
configure() | Configures an object with property values. |
createFormattingLocale() | Creates a locale object that should be used for date and number formatting. |
dbConfig() | Returns the db component config. |
dbMutexConfig() | Returns a database-based mutex driver config. |
devMode() | Returns whether Dev Mode is enabled. |
editionHandle() | Returns the handle of the given Craft edition. |
editionIdByHandle() | Returns the ID of a Craft edition by its handle. |
editionName() | Returns the name of the given Craft edition. |
editions() | Returns an array of all known Craft editions’ IDs. |
env() | Returns an environment-specific value. |
envConfig() | Returns a config array for a given class, based on any environment variables or PHP constants named based on its public properties. |
extensionVersion() | Returns a PHP extension version, without the distribution info. |
humanizeClass() | Returns a humanized class name. |
isEphemeral() | Returns whether Craft is running on an environment with ephemeral storage. |
isPathAllowed() | Returns whether the given path is within PHP’s open_basedir setting. |
isStreamLog() | Returns whether Craft is logging to stdout/stderr. |
isTty() | Returns whether Craft is being run from a TTY terminal. |
isValidEdition() | Returns whether an edition is valid. |
isWindows() | Returns whether Craft is running on a Windows environment |
licenseKey() | |
mailSettings() | Returns the system email settings. |
mailerConfig() | Returns the mailer component config. |
maxPowerCaptain() | Sets PHP’s memory limit to the maximum specified by the config5:phpMaxMemoryLimit config setting, and gives the script an unlimited amount of time to execute. |
mutexConfig() | Returns a file-based mutex driver config. |
normalizePhpPaths() | Normalizes a PHP path setting to an array of paths |
normalizeValue() | Normalizes an environment variable/constant name/CLI command option. |
normalizeVersion() | Removes distribution info from a version string, and returns the highest version number found in the remainder. |
parseBooleanEnv() | Checks if a string references an environment variable ($VARIABLE_NAME ) and returns the referenced boolean value, or null if a boolean value can’t be determined. |
parseEnv() | Checks if a string references an environment variable ($VARIABLE_NAME ) and/or an alias (@aliasName ), and returns the referenced value. |
phpConfigValueAsBool() | Retrieves a bool PHP config setting and normalizes it to an actual bool. |
phpConfigValueAsPaths() | Retrieves a file path PHP config setting and normalizes it to an array of paths. |
phpConfigValueInBytes() | Retrieves a disk size PHP config setting and normalizes it into bytes. |
phpExecutable() | Returns the path to a PHP executable which should be used by sub processes. |
phpSizeToBytes() | Normalizes a PHP file size into bytes. |
phpVersion() | Returns the PHP version, without the distribution info. |
projectConfigConfig() | Returns the projectConfig component config. |
sessionConfig() | Returns the session component config for web requests. |
silence() | Calls the given closure with all error reporting silenced, and returns its response. |
supportsIdn() | Returns whether the server supports IDNA ASCII strings. |
testIniSet() | Tests whether ini_set() works. |
userConfig() | Returns the user component config for web requests. |
viewConfig() | Returns the view component config. |
webRequestConfig() | Returns the request component config for web requests. |
webResponseConfig() | Returns the response component config for web requests. |
assetManagerConfig()
- Since
- 3.0.18
Returns the assetManager
component config for web requests.
Returns
backtrace()
- Since
- 3.0.13
Returns the backtrace as a string (omitting the final frame where this method was called).
Arguments
$limit
(integer) – The max number of stack frames to be included (0 means no limit)
Returns
cacheConfig()
- Since
- 3.0.18
Returns the cache
component config.
Returns
checkForValidIconv()
Returns whether the server has a valid version of the iconv extension installed.
Returns
cliOption()
- Since
- 4.0.0
Returns a CLI command option from argv
, or null
if it wasn’t passed.
Supported option syntaxes are:
name=value
name value
name
(impliestrue
)
name
must begin with --
or -
. Other values will be rejected.
If the value is numeric, a float or int will be returned.
If the value is true
or false
, a boolean will be returned.
If the option has no value (either because the following item begins with -
or it’s the last item), true
will be returned.
Arguments
$name
(string) – The option name, beginning with--
or-
$unset
(boolean) – Whether the option should be removed fromargv
if found
Returns
string, float, integer, true, null
configure()
- Since
- 5.3.0
Configures an object with property values.
This is identical to \BaseYii::configure()
, except this class is safe to be called during application bootstrap, whereas \BaseYii
is not.
Arguments
$object
(object) – The object to be configured$properties
(array) – The property initial values given in terms of name-value pairs.
createFormattingLocale()
- Since
- 3.6.0
Creates a locale object that should be used for date and number formatting.
Returns
dbConfig()
- Since
- 3.0.18
Returns the db
component config.
Arguments
$dbConfig
(craft\config\DbConfig, null) – The database config settings
Returns
dbMutexConfig()
- Since
- 4.6.0
Returns a database-based mutex driver config.
Returns
devMode()
- Since
- 4.0.0
Returns whether Dev Mode is enabled.
Returns
editionHandle()
DEPRECATED
Deprecated in 5.0.0. CmsEdition::handle()
should be used instead.
- Since
- 3.1.0
Returns the handle of the given Craft edition.
Arguments
$edition
(integer) – An edition’s ID.
Returns
string – The edition’s handle.
Throws
- yii\base\InvalidArgumentException
if $edition is invalid
editionIdByHandle()
DEPRECATED
Deprecated in 5.0.0. CmsEdition::fromHandle()
should be used instead.
- Since
- 3.1.0
Returns the ID of a Craft edition by its handle.
Arguments
$handle
(string) – An edition’s handle
Returns
integer – The edition’s ID
Throws
- yii\base\InvalidArgumentException
if $handle is invalid
editionName()
DEPRECATED
Deprecated in 5.0.0. CmsEdition::name
should be used instead.
Returns the name of the given Craft edition.
Arguments
$edition
(integer) – An edition’s ID.
Returns
string – The edition’s name.
Throws
- yii\base\InvalidArgumentException
if $edition is invalid
editions()
DEPRECATED
Deprecated in 5.0.0. CmsEdition::cases()
should be used instead.
Returns an array of all known Craft editions’ IDs.
Returns
integer[] – All the known Craft editions’ IDs.
env()
- Since
- 3.4.18
Returns an environment-specific value.
Values will be looked for in the following places:
- “Secret” values returned by a PHP file identified by a
CRAFT_SECRETS_PATH
environment variable - Environment variables stored in
$_SERVER
- Environment variables returned by
getenv()
- PHP constants
If the value cannot be found, null
will be returned.
Arguments
$name
(string) – The name to search for.
Returns
mixed
– The value, or null
if not found.
Throws
envConfig()
- Since
- 4.0.0
Returns a config array for a given class, based on any environment variables or PHP constants named based on its public properties.
Environment variable/PHP constant names must be capitalized, SNAKE_CASED versions of the object’s property names, possibly with a given prefix.
For example, if an object has a fooBar
property, and X
/X_
is passed as the prefix, the resulting array may contain a fooBar
key set to an X_FOO_BAR
environment variable value, if it exists.
Arguments
Returns
extensionVersion()
Returns a PHP extension version, without the distribution info.
Arguments
$name
(string) – The extension name
Returns
humanizeClass()
Returns a humanized class name.
Arguments
$class
(string)
Returns
isEphemeral()
- Since
- 3.4.0
Returns whether Craft is running on an environment with ephemeral storage.
Returns
isPathAllowed()
- Since
- 3.7.34
Returns whether the given path is within PHP’s open_basedir
setting.
Arguments
$path
(string)
Returns
isStreamLog()
- Since
- 4.0.0
Returns whether Craft is logging to stdout/stderr.
Returns
isTty()
- Since
- 5.4.8
Returns whether Craft is being run from a TTY terminal.
This is copied verbatim from Composer\Util\Platform::isTty()
. Full credit to Nils Adermann and Jordi Boggiano.
Arguments
isValidEdition()
DEPRECATED
Deprecated in 5.0.0. CmsEdition::tryFrom()
should be used instead.
Returns whether an edition is valid.
Arguments
$edition
(mixed
) – An edition’s ID (or is it?)
Returns
boolean – Whether $edition is a valid edition ID.
isWindows()
- Since
- 5.0.0
Returns whether Craft is running on a Windows environment
licenseKey()
Returns
mailSettings()
- Since
- 3.1.0
Returns the system email settings.
Returns
mailerConfig()
- Since
- 3.0.18
Returns the mailer
component config.
Arguments
$settings
(craft\models\MailSettings, null) – The system mail settings
Returns
maxPowerCaptain()
Sets PHP’s memory limit to the maximum specified by the config5:phpMaxMemoryLimit config setting, and gives the script an unlimited amount of time to execute.
mutexConfig()
DEPRECATED
Deprecated in 4.6.0
- Since
- 3.0.18
Returns a file-based mutex driver config.
TIP
If you were calling this to override the yii\mutex\FileMutex::$isWindows property, note that overriding the mutex
component may no longer be necessary, as Craft no longer uses a mutex when Dev Mode is enabled.
Returns
normalizePhpPaths()
- Since
- 3.7.34
Normalizes a PHP path setting to an array of paths
Arguments
$value
(string) – The PHP path setting value
Returns
string[] – The normalized paths
normalizeValue()
- Since
- 4.0.0
Normalizes an environment variable/constant name/CLI command option.
It converts the following:
'true'
→true
'false'
→false
- Numeric string → integer or float
Arguments
$value
(mixed
)
Returns
mixed
normalizeVersion()
Removes distribution info from a version string, and returns the highest version number found in the remainder.
Arguments
$version
(string)
Returns
parseBooleanEnv()
- Since
- 3.7.29
Checks if a string references an environment variable ($VARIABLE_NAME
) and returns the referenced boolean value, or null
if a boolean value can’t be determined.
Arguments
$value
(mixed
)
Returns
Example
$status = App::parseBooleanEnv('$SYSTEM_STATUS') ?? false;
parseEnv()
- Since
- 3.7.29
Checks if a string references an environment variable ($VARIABLE_NAME
) and/or an alias (@aliasName
), and returns the referenced value.
If the string references an environment variable with a value of true
or false
, a boolean value will be returned.
If the string references an environment variable that’s not defined, null
will be returned.
Arguments
Returns
string, boolean, null – The parsed value, or the original value if it didn’t reference an environment variable and/or alias.
Example
$value1 = App::parseEnv('$SMTP_PASSWORD');
$value2 = App::parseEnv('@webroot');
phpConfigValueAsBool()
Retrieves a bool PHP config setting and normalizes it to an actual bool.
Arguments
$var
(string) – The PHP config setting to retrieve.
Returns
boolean – Whether it is set to the php.ini equivalent of true
.
phpConfigValueAsPaths()
- Since
- 3.7.34
Retrieves a file path PHP config setting and normalizes it to an array of paths.
Arguments
$var
(string) – The PHP config setting to retrieve
Returns
string[] – The normalized paths
phpConfigValueInBytes()
- Since
- 3.0.38
Retrieves a disk size PHP config setting and normalizes it into bytes.
Arguments
$var
(string) – The PHP config setting to retrieve.
Returns
integer, float – The value normalized into bytes.
phpExecutable()
- Since
- 4.5.6
Returns the path to a PHP executable which should be used by sub processes.
Returns
string, null – The PHP executable path, or null
if it can’t be determined.
phpSizeToBytes()
- Since
- 3.6.0
Normalizes a PHP file size into bytes.
Arguments
$value
(string) – The file size expressed in PHP config value notation
Returns
integer, float – The value normalized into bytes.
phpVersion()
Returns the PHP version, without the distribution info.
Returns
projectConfigConfig()
Returns the projectConfig
component config.
sessionConfig()
- Since
- 3.0.18
Returns the session
component config for web requests.
Returns
silence()
- Since
- 5.0.0
Calls the given closure with all error reporting silenced, and returns its response.
Arguments
$callable
(Closure, string)$mask
(integer, null) – Error levels to suppress, default value NULL indicates all warnings and below.
Returns
mixed
supportsIdn()
- Since
- 3.7.9
Returns whether the server supports IDNA ASCII strings.
Returns
testIniSet()
- Since
- 3.0.40
Tests whether ini_set() works.
Returns
userConfig()
- Since
- 3.0.18
Returns the user
component config for web requests.
Returns
viewConfig()
- Since
- 3.0.18
Returns the view
component config.
Returns
webRequestConfig()
- Since
- 3.0.18
Returns the request
component config for web requests.
Returns
webResponseConfig()
- Since
- 3.3.0
Returns the response
component config for web requests.