App
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\App
- Since
- 3.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. |
| 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. |
| phpVersion() | Returns the PHP version, without the distribution info. |
| projectConfigConfig() | Returns the projectConfig component config. |
| sessionConfig() | Returns the session component config for web requests. |
| userConfig() | Returns the user component config for web requests. |
| viewConfig() | Returns the view component config. |
| webRequestConfig() | Returns the request component config for web requests. |
assetManagerConfig()
Signature
public static array assetManagerConfig ( )
backtrace()
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)
Signature
public static void backtrace ( \craft\helpers\int $limit = 0 )
cacheConfig()
Signature
public static array cacheConfig ( )
checkForValidIconv()
Returns whether the server has a valid version of the iconv extension installed.
Returns
Signature
public static boolean checkForValidIconv ( )
dbConfig()
Returns the db component config.
Arguments
$dbConfig(craft\config\DbConfig, null) – The database config settings
Returns
Signature
public static array dbConfig ( craft\config\DbConfig $dbConfig = null )
editionHandle()
Returns the handle of the given Craft edition.
Arguments
$edition(integer) – An edition’s ID.
Returns
string – The edition’s name.
Signature
public static string editionHandle ( \craft\helpers\int $edition )
editionIdByHandle()
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
Signature
public static integer editionIdByHandle ( \craft\helpers\string $handle )
editionName()
Returns the name of the given Craft edition.
Arguments
$edition(integer) – An edition’s ID.
Returns
string – The edition’s name.
Signature
public static string editionName ( \craft\helpers\int $edition )
editions()
Signature
public static array editions ( )
extensionVersion()
Returns a PHP extension version, without the distribution info.
Arguments
$name(string) – The extension name
Returns
Signature
public static string extensionVersion ( \craft\helpers\string $name )
humanizeClass()
Signature
public static string humanizeClass ( \craft\helpers\string $class )
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.
Signature
public static boolean isValidEdition ( $edition )
licenseKey()
Signature
public static string, null licenseKey ( )
logConfig()
Signature
public static array, null logConfig ( )
mailSettings()
Signature
public static craft\models\MailSettings mailSettings ( )
mailerConfig()
Returns the mailer component config.
Arguments
$settings(craft\models\MailSettings, null) – The system mail settings
Returns
Signature
public static array mailerConfig ( craft\models\MailSettings $settings = null )
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.
Signature
public static void maxPowerCaptain ( )
mutexConfig()
Signature
public static array mutexConfig ( )
normalizeVersion()
Signature
public static string normalizeVersion ( \craft\helpers\string $version )
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.
Signature
public static boolean phpConfigValueAsBool ( \craft\helpers\string $var )
phpVersion()
Signature
public static string phpVersion ( )
projectConfigConfig()
Returns the projectConfig component config.
Signature
public static void projectConfigConfig ( )
sessionConfig()
Signature
public static array sessionConfig ( )
userConfig()
Signature
public static array userConfig ( )
viewConfig()
Signature
public static array viewConfig ( )
webRequestConfig()
Signature
public static array webRequestConfig ( )