Number

Type

Class

Namespace

craft\helpers

Inherits

craft\helpers\Number

Since

3.0.0

Class Number

View source

Public Methods

Method	Description
isInt()	Returns whether the given number lacks decimal points when typecast to a float.
isIntOrFloat()	Returns whether the given value is an int or float, or a string that represents an int or float.
lowerAlpha()	Returns the lowercase alphabetic version of a number
lowerRoman()	Returns the lowercase roman numeral version of a number
makeNumeric()	Returns the numeric value of a variable.
toIntOrFloat()	Typecasts the given number into an integer or a float.
upperAlpha()	Returns the uppercase alphabetic version of a number
upperRoman()	Returns the uppercase roman numeral version of a number
word()	Returns the "word" version of a number

isInt()

Since

4.0.0

Returns whether the given number lacks decimal points when typecast to a float.

View source

Arguments

• $value (float, integer, string)

Returns

boolean

Throws

• yii\base\InvalidArgumentException
  if $value isn’t numeric

isIntOrFloat()

Since

4.0.5

Returns whether the given value is an int or float, or a string that represents an int or float.

View source

Arguments

• $value (mixed)

Returns

boolean

lowerAlpha()

Returns the lowercase alphabetic version of a number

View source

Arguments

• $num (integer) – The number

Returns

string – The alphabetic version of the number

lowerRoman()

Returns the lowercase roman numeral version of a number

View source

Arguments

• $num (integer) – The number

Returns

string – The roman numeral version of the number

makeNumeric()

Returns the numeric value of a variable.

If the variable is an object with a __toString() method, the numeric value of its string representation will be returned.

View source

Arguments

• $var (mixed)

Returns

float, integer, string

toIntOrFloat()

Since

4.0.0

Typecasts the given number into an integer or a float.

View source

Arguments

• $value (float, integer, string)

Returns

integer, float

Throws

• yii\base\InvalidArgumentException
  if $value isn’t numeric

upperAlpha()

Returns the uppercase alphabetic version of a number

View source

Arguments

• $num (integer) – The number

Returns

string – The alphabetic version of the number

upperRoman()

Returns the uppercase roman numeral version of a number

View source

Arguments

• $num (integer) – The number

Returns

string – The roman numeral version of the number

word()

Returns the "word" version of a number

View source

Arguments

• $num (integer) – The number

Returns

string – The number word, or the original number if it's >= 10