Craft

Type
Class
Inherits
Craft » Yii
Since
3.0

Craft is helper class serving common Craft and Yii framework functionality.

It encapsulates \Yii and ultimately yii\BaseYii, which provides the actual implementation.

View source

Public Properties

PropertyDescription
appcraft\web\Application, craft\console\Application – The application instance.

app

Type
craft\web\Application, craft\console\Application

The application instance.

View source

Public Methods

MethodDescription
autoload()Class autoloader.
cookieConfig()Generates and returns a cookie config.
createGuzzleClient()Creates a Guzzle client configured with the given array merged with any default values in config/guzzle.php.
dd()Displays a variable and ends the request. (“Dump and die”)
dump()Displays a variable.
parseEnv()Checks if a string references an environment variable ($VARIABLE_NAME) and/or an alias (@aliasName), and returns the referenced value.

autoload()

Class autoloader.

View source

Arguments

cookieConfig()

Generates and returns a cookie config.

View source

Arguments

  • $config (array) – Any config options that should be included in the config.
  • $request (yii\web\Request, null) – The request object

Returns

array – The cookie config array.

createGuzzleClient()

Creates a Guzzle client configured with the given array merged with any default values in config/guzzle.php.

View source

Arguments

  • $config (array) – Guzzle client config settings

Returns

\GuzzleHttp\Client

dd()

Displays a variable and ends the request. (“Dump and die”)

View source

Arguments

  • $var (mixed) – The variable to be dumped.
  • $depth (integer) – The maximum depth that the dumper should go into the variable. Defaults to 10.
  • $highlight (boolean) – Whether the result should be syntax-highlighted. Defaults to true.

Throws

dump()

Displays a variable.

View source

Arguments

  • $var (mixed) – The variable to be dumped.
  • $depth (integer) – The maximum depth that the dumper should go into the variable. Defaults to 10.
  • $highlight (boolean) – Whether the result should be syntax-highlighted. Defaults to true.

parseEnv()

Checks if a string references an environment variable ($VARIABLE_NAME) and/or an alias (@aliasName), and returns the referenced value. If the string references an environment variable with a value of true or false, a boolean value will be returned.

View source

Arguments

Returns

string, boolean, null – The parsed value, or the original value if it didn’t reference an environment variable and/or alias.

Example

Constants

ConstantDescription
Client
Personal
Pro
Solo