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. |
| dbConfig() | Returns the db component config. |
| 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. |
| 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. |
| isValidEdition() | Returns whether an edition is valid. |
| licenseKey() | |
| logConfig() | Returns the log component config. |
| mailSettings() | Returns the system email settings. |
| mailerConfig() | Returns the mailer component config. |
| maxPowerCaptain() | Sets PHP’s memory limit to the maximum specified by the phpMaxMemoryLimit config setting, and gives the script an unlimited amount of time to execute. |
| mutexConfig() | Returns the mutex component config. |
| normalizeVersion() | Removes distribution info from a version |
| phpConfigValueAsBool() | Retrieves a bool PHP config setting and normalizes it to an actual bool. |
| phpConfigValueInBytes() | Retrieves a disk size PHP config setting and normalizes it 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. |
| 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
dbConfig()
- Since
- 3.0.18
Returns the db component config.
Arguments
$dbConfig(craft\config\DbConfig, null) – The database config settings
Returns
editionHandle()
- Since
- 3.1.0
Returns the handle of the given Craft edition.
Arguments
$edition(integer) – An edition’s ID.
Returns
string – The edition’s name.
editionIdByHandle()
- 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()
Returns the name of the given Craft edition.
Arguments
$edition(integer) – An edition’s ID.
Returns
string – The edition’s name.
editions()
Returns an array of all known Craft editions’ IDs.
Returns
array – All the known Craft editions’ IDs.
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
isValidEdition()
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.
licenseKey()
Returns
logConfig()
- Since
- 3.0.18
Returns the log component config.
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 phpMaxMemoryLimit config setting, and gives the script an unlimited amount of time to execute.
mutexConfig()
- Since
- 3.0.18
Returns the mutex component config.
Returns
normalizeVersion()
Removes distribution info from a version
Arguments
$version(string)
Returns
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 equivelant of true.
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.
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
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.