assert.php

<?
namespace Bitrix\Sale\Location\Util;
 
use Bitrix\Main;
use Bitrix\Main\Localization\Loc;
 
Loc::loadMessages(__FILE__);
 
class Assert
{
    // checkers
 
    public final static function expectInteger($arg, $argName = '', $customMsg = '')
    {
        $argInt = intval($arg);
        if($arg != $argInt)
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_INTEGER_EXPECTED', $argName, $customMsg));
 
        return $argInt;
    }
 
    public final static function expectIntegerPositive($arg, $argName = '', $customMsg = '')
    {
        $argInt = intval($arg);
        if($arg != $argInt || $argInt <= 0)
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_INTEGER_NOTNULL_EXPECTED', $argName, $customMsg));
 
        return $argInt;
    }
 
    public final static function expectIntegerNonNegative($arg, $argName = '', $customMsg = '')
    {
        $argInt = intval($arg);
        if($arg != $argInt || $argInt < 0)
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_INTEGER_NONNEGATIVE_EXPECTED', $argName, $customMsg));
 
        return $argInt;
    }
 
    public final static function expectStringNotNull($arg, $argName = '', $customMsg = '')
    {
        if($arg == '')
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_STRING_NOTNULL_EXPECTED', $argName, $customMsg));
 
        return (string) $arg;
    }
 
    public final static function expectArray($arg, $argName = '', $customMsg = '')
    {
        if(!is_array($arg))
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ARRAY_EXPECTED', $argName, $customMsg));
 
        return $arg;
    }
 
    public final static function expectNotEmptyArray($arg, $argName = '', $customMsg = '')
    {
        if(!is_array($arg) || empty($arg))
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ARRAY_NOT_EMPTY_EXPECTED', $argName, $customMsg));
 
        return $arg;
    }
 
    public final static function expectArrayOfUniqueIntegerNotNull($arg, $argName = '', $customMsg = '')
    {
        if(!is_array($arg))
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ARRAY_EXPECTED', $argName, $customMsg));
 
        $arg = array_unique(array_values($arg));
 
        foreach($arg as $k => $v)
        {
            $vInt = intval($v);
            if($v != $vInt || $vInt == 0)
                throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ARRAY_OF_INTEGER_NOT_NULL_EXPECTED', $argName, $customMsg));
 
            $arg[$k] = $vInt; // it can be casted to integer
        }
 
        return $arg;
    }
 
    public final static function expectArrayOfUniqueStringNotNull($arg, $argName = '', $customMsg = '')
    {
        if(!is_array($arg))
            throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ARRAY_EXPECTED', $argName, $customMsg));
 
        $arg = array_unique(array_values($arg));
 
        foreach($arg as $k => $v)
        {
            $v = (string) $v;
            if($v == '')
                throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ARRAY_OF_STRING_NOT_NULL_EXPECTED', $argName, $customMsg));
 
            $arg[$k] = $v;
        }
 
        return $arg;
    }
 
    public final static function expectEnumerationMember($arg, $enum = array(), $argName = '', $customMsg = '')
    {
        if($arg == '')
            throw new Main\ArgumentException(Loc::getMessage('SALE_LOCATION_ASSERT_EMPTY_ARGUMENT'));
 
        if(!is_array($enum) || empty($enum))
            throw new Main\ArgumentException(Loc::getMessage('SALE_LOCATION_ASSERT_EMPTY_ENUMERATION'));
 
        // we cannot use in_array() here, kz we need for real data type
        foreach($enum as $variant)
        {
            if($variant == $arg)
                return $variant;
        }
 
        throw new Main\ArgumentException(self::formMessage('SALE_LOCATION_ASSERT_ITEM_NOT_IN_ENUMERATION', $argName, $customMsg));
    }
 
    // casters
 
    public static function castTrimLC($value)
    {
        return ToLower(trim($value));
    }
 
    // announcers
 
    public final static function announceNotImplemented($msg = '')
    {
        throw new Main\NotImplementedException($msg);
    }
 
    public final static function announceNotSupported($msg = '')
    {
        throw new Main\NotSupportedException($msg);
    }
 
    private static function formMessage($msgCode, $argName = '', $customMsg = '')
    {
        if($customMsg <> '')
        {
            return str_replace('#ARG_NAME#', $argName, $customMsg);
        }
 
        return Loc::getMessage($msgCode, array('#ARG_NAME#' => $argName <> ''? ' "'.$argName.'" ' : ' '));
    }
}