App
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\App
- Since
- 3.0
App helper.
Public Methods
| Method | Description |
|---|---|
| backtrace() | Returns the backtrace as a string (omitting the final frame where this method was called). |
| checkForValidIconv() | Returns whether the server has a valid version of the iconv extension installed. |
| 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() | |
| 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. |
| 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. |
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 )
checkForValidIconv()
Returns whether the server has a valid version of the iconv extension installed.
Returns
Signature
public static boolean checkForValidIconv ( )
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 ( )
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 ( )
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 ( )