AppVariable

Type
Class
Namespace
Craft
Inherits
Craft\AppVariable
Since
1.0

Class AppVariable

See also http://craftcms.com

View source (opens new window)

# Public Methods

Method Description
canTestEditions() Returns whether Craft is running on a domain that is eligible to test out the editions.
canUpgradeEdition() Returns whether Craft is elligible to be upgraded to a different edition.
getBuild() Returns the installed Craft build.
getEdition() Returns the Craft edition.
getEditionName() Returns the name of the Craft edition.
getFileKinds() Returns a list of file kinds.
getLicensedEdition() Returns the edition Craft is actually licensed to run in.
getLicensedEditionName() Returns the name of the edition Craft is actually licensed to run in.
getLocale() Returns the site language.
getMaxUploadSize() Return max upload size in bytes.
getReleaseDate() Returns the installed Craft release date.
getSiteName() Returns the site name.
getSiteUid() Returns the site UID.
getSiteUrl() Returns the site URL.
getTotalAvailableUpdates() Returns how many updates are available.
getVersion() Returns the installed Craft version.
hasWrongEdition() Returns whether Craft is running with the wrong edition.
isCriticalUpdateAvailable() Returns whether a critical update is available.
isSystemOn() Returns whether the system is on.
isUpdateInfoCached() Returns whether the update info is cached.

# canTestEditions()

Returns whether Craft is running on a domain that is eligible to test out the editions.

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean canTestEditions ( )

# canUpgradeEdition()

Returns whether Craft is elligible to be upgraded to a different edition.

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean canUpgradeEdition ( )

# getBuild()

Returns the installed Craft build.

View source (opens new window)

Returns

string (opens new window)

Signature

public string getBuild ( )

# getEdition()

Signature

public string getEdition ( )

# getEditionName()

Returns the name of the Craft edition.

View source (opens new window)

Returns

string (opens new window)

Signature

public string getEditionName ( )

# getFileKinds()

Returns a list of file kinds.

View source (opens new window)

Returns

array (opens new window)

Signature

public array getFileKinds ( )

# getLicensedEdition()

Returns the edition Craft is actually licensed to run in.

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

Signature

public integer, null getLicensedEdition ( )

# getLicensedEditionName()

Returns the name of the edition Craft is actually licensed to run in.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

Signature

public string, null getLicensedEditionName ( )

# getLocale()

Signature

public string getLocale ( )

# getMaxUploadSize()

Return max upload size in bytes.

View source (opens new window)

Returns

integer (opens new window)

Signature

public integer getMaxUploadSize ( )

# getReleaseDate()

Returns the installed Craft release date.

View source (opens new window)

Returns

Craft\DateTime

Signature

public Craft\DateTime getReleaseDate ( )

# getSiteName()

Signature

public string getSiteName ( )

# getSiteUid()

Signature

public string getSiteUid ( )

# getSiteUrl()

Signature

public string getSiteUrl ( )

# getTotalAvailableUpdates()

Returns how many updates are available.

View source (opens new window)

Returns

integer (opens new window)

Signature

public integer getTotalAvailableUpdates ( )

# getVersion()

Returns the installed Craft version.

View source (opens new window)

Returns

string (opens new window)

Signature

public string getVersion ( )

# hasWrongEdition()

Returns whether Craft is running with the wrong edition.

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean hasWrongEdition ( )

# isCriticalUpdateAvailable()

Returns whether a critical update is available.

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean isCriticalUpdateAvailable ( )

# isSystemOn()

Returns whether the system is on.

View source (opens new window)

Returns

string (opens new window)

Signature

public string isSystemOn ( )

# isUpdateInfoCached()

Returns whether the update info is cached.

View source (opens new window)

Returns

boolean (opens new window)

Signature

public boolean isUpdateInfoCached ( )