Craft 3 Class Reference

Class craft\helpers\App

Inheritance
craft\helpers\App
Available since version
3.0
Source Code
https://github.com/craftcms/cms/blob/master/src/helpers/App.php

App helper.

Public Methods
Method Description Defined By
checkForValidIconv() Returns whether the server has a valid version of the iconv extension installed. craft\helpers\App
editionName() Returns the name of the given Craft edition. craft\helpers\App
editions() Returns an array of all known Craft editions’ IDs. craft\helpers\App
extensionVersion() Returns a PHP extension version, without the distribution info. craft\helpers\App
humanizeClass() Returns a humanized class name. craft\helpers\App
isValidEdition() Returns whether an edition is valid. craft\helpers\App
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. craft\helpers\App
normalizeVersion() Removes distribution info from a version craft\helpers\App
phpConfigValueAsBool() Retrieves a bool PHP config setting and normalizes it to an actual bool. craft\helpers\App
phpVersion() Returns the PHP version, without the distribution info. craft\helpers\App

Method Details

checkForValidIconv() public static method #

Returns whether the server has a valid version of the iconv extension installed.

public static boolean checkForValidIconv ( )

editionName() public static method #

Returns the name of the given Craft edition.

public static string editionName ( \craft\helpers\int $edition )
$edition integer An edition’s ID.
return string The edition’s name.

editions() public static method #

Returns an array of all known Craft editions’ IDs.

public static array editions ( )
return array All the known Craft editions’ IDs.

extensionVersion() public static method #

Returns a PHP extension version, without the distribution info.

public static string extensionVersion ( \craft\helpers\string $name )
$name string The extension name

humanizeClass() public static method #

Returns a humanized class name.

public static string humanizeClass ( \craft\helpers\string $class )
$class string

isValidEdition() public static method #

Returns whether an edition is valid.

public static boolean isValidEdition ( $edition )
$edition mixed An edition’s ID (or is it?)
return boolean Whether $edition is a valid edition ID.

maxPowerCaptain() public static method #

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.

public static void maxPowerCaptain ( )

normalizeVersion() public static method #

Removes distribution info from a version

public static string normalizeVersion ( \craft\helpers\string $version )
$version string

phpConfigValueAsBool() public static method #

Retrieves a bool PHP config setting and normalizes it to an actual bool.

public static boolean phpConfigValueAsBool ( \craft\helpers\string $var )
$var string The PHP config setting to retrieve.
return boolean Whether it is set to the php.ini equivelant of true.

phpVersion() public static method #

Returns the PHP version, without the distribution info.

public static string phpVersion ( )