Класс Assert

Открытые статические члены
static	expectInteger ($arg, $argName='', $customMsg='')
static	expectIntegerPositive ($arg, $argName='', $customMsg='')
static	expectIntegerNonNegative ($arg, $argName='', $customMsg='')
static	expectStringNotNull ($arg, $argName='', $customMsg='')
static	expectArray ($arg, $argName='', $customMsg='')
static	expectNotEmptyArray ($arg, $argName='', $customMsg='')
static	expectArrayOfUniqueIntegerNotNull ($arg, $argName='', $customMsg='')
static	expectArrayOfUniqueStringNotNull ($arg, $argName='', $customMsg='')
static	expectEnumerationMember ($arg, $enum=array(), $argName='', $customMsg='')
static	castTrimLC ($value)
static	announceNotImplemented ($msg='')
static	announceNotSupported ($msg='')

Подробное описание

См. определение в файле assert.php строка 16

Методы

announceNotImplemented()

static announceNotImplemented ( $msg = '' )

staticfinal

Method announces that method or action is not implemented

Аргументы

string

$msg

message to be shown

Исключения

Bitrix\Main\NotImplementedException

См. определение в файле assert.php строка 243

announceNotSupported()

static announceNotSupported ( $msg = '' )

staticfinal

Method announces that method or action is not supported

Аргументы

string

$msg

message to be shown

Исключения

Bitrix\Main\NotImplementedException

См. определение в файле assert.php строка 255

castTrimLC()

static castTrimLC ( $value )

static

См. определение в файле assert.php строка 229

expectArray()

static expectArray ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is an array

Аргументы

mixed[]	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

mixed[] value being checked

См. определение в файле assert.php строка 110

expectArrayOfUniqueIntegerNotNull()

static expectArrayOfUniqueIntegerNotNull ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is a non-empty array of unique positive integers (or somehow can be casted to it)

Аргументы

mixed[]	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

integer[] checked and casted value

См. определение в файле assert.php строка 148

expectArrayOfUniqueStringNotNull()

static expectArrayOfUniqueStringNotNull ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is a non-empty array of unique non-zero-length strings (or somehow can be casted to it)

Аргументы

mixed[]	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

string[] checked and casted value

См. определение в файле assert.php строка 178

expectEnumerationMember()

static expectEnumerationMember ( $arg, $enum = array(), $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument belongs to a set of elements

Аргументы

mixed[]	$arg	argument to check
mixed[]	$enum	enumeration to check argument belong to
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

mixed[] checked and casted value

См. определение в файле assert.php строка 209

expectInteger()

static expectInteger ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is an integer value, or can be casted to it

Аргументы

mixed	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

integer checked and casted value

См. определение в файле assert.php строка 31

expectIntegerNonNegative()

static expectIntegerNonNegative ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is a non-negative integer value, or can be casted to it

Аргументы

mixed	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

integer checked and casted value

См. определение в файле assert.php строка 71

expectIntegerPositive()

static expectIntegerPositive ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is a positive integer value, or can be casted to it

Аргументы

mixed	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

integer checked and casted value

См. определение в файле assert.php строка 51

expectNotEmptyArray()

static expectNotEmptyArray ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is a non-empty array

Аргументы

mixed[]	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

mixed[] value being checked

См. определение в файле assert.php строка 129

expectStringNotNull()

static expectStringNotNull ( $arg, $argName = '', $customMsg = '' )

staticfinal

Method checks if the given argument is a non-zero-length string value, or can be casted to it

Аргументы

mixed	$arg	argument to check
string	$argName	argument name to figure in a error message
string	$customMsg	custom message to be shown instead of a standard one

Исключения

Bitrix\Main\ArgumentException

Возвращает

string checked and casted value

См. определение в файле assert.php строка 91