assertions.inc

<?php
function assert_true($value, $msg='', $silent=false, $fatal=true)
{
    if ($value !== true) {
        if (empty($msg)) {
            $msg = '['.gettype($value).'] "'.$value.'" was not TRUE';
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_true()


function assert_false($value, $msg='', $silent=false, $fatal=true)
{
    if ($value !== false) {
        if (empty($msg)) {
            $msg = '['.gettype($value).'] "'.$value.'" was not FALSE';
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_false()


function assert_null($value, $msg='', $silent=false, $fatal=true)
{
    if (!is_null($value)) {
        if (empty($msg)) {
            $msg = '['.gettype($value).'] "'.$value.'" was not NULL';
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_null()


function assert_not_null($value, $msg='', $silent=false, $fatal=true)
{
    if (is_null($value)) {
        if (empty($msg)) {
            $msg = translate('passed_value_was_null');
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_not_null()


function assert_empty($value, $msg='', $silent=false, $fatal=true)
{
    if (!empty($value)) {
        if (empty($msg)) {
            $msg = translate('assert_not_empty', gettype($value), $value);
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_empty()


function assert_not_empty($value, $msg='', $silent=false, $fatal=true)
{
    if (empty($value)) {
        if (empty($msg)) {
            $msg = translate('assert_empty', gettype($value), $value);
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_not_empty()


function assert_equals($test, $expected, $msg='', $silent=false, $fatal=true)
{
    if ($test != $expected) {
        if (!empty($msg)) $msg .= ' -';
        $msg .= translate('assert_equals', gettype($expected), $expected, gettype($test), $test);
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_equals()


function assert_not_equals($value1, $value2, $msg='', $silent=false, $fatal=true)
{
    if ($value1 == $value2) {
        if (empty($msg)) $msg = translate('assert_not_equal');
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_not_equals()


function assert_array_contains($test, $expected, $msg='', $silent=false, $fatal=true)
{
    $diff = array_diff($expected, $test);
    if (!empty($diff)) {
        if (!empty($msg)) $msg .= ' -';
        $msg .= translate('assert_contains', print_r($expected,true), print_r($test,true));
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_array_contains()


function assert_array_equals($test, $expected, $msg='', $silent=false, $fatal=true)
{
    if ($test != $expected) {
        if (!empty($msg)) $msg .= ' -';
        $msg .= translate('assert_contains', print_r($expected,true), print_r($test,true));
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_array_equals()


function assert_isset($test, $msg='', $silent=false, $fatal=true)
{
    if (!isset($test)) {
        if (empty($msg)) $msg = translate('assert_isset');
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_isset()


function assert_isset_array_index($test, $index, $msg='', $silent=false, $fatal=true)
{
    assert_type($test, 'array');

    if (!isset($test[$index])) {
        if (empty($msg)) {
            $msg = translate('assert_isset_array', $index);
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_isset_array_index()


function assert_is_a($obj, $class, $msg='', $silent=false, $fatal=true)
{
    if (!($obj instanceof $class)) {
        if (empty($msg)) {
            $msg = translate('assert_object', strtoupper($class));
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_is_a()


function assert_type($obj, $type, $msg='', $silent=false, $fatal=true)
{
    if (strtolower(gettype($obj)) != strtolower($type)) {
        if (empty($msg)) {
            $msg = translate('assert_type', gettype($obj), $obj, strtoupper($type));
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_type()


function assert_valid_db_result($result, $msg='', $silent=false, $fatal=true)
{
    throw new Exception('assert_valid_db_result() is obselete, use try...catch instead');

}//end assert_valid_db_result()


function assert_valid_assetid($assetids, $msg='', $silent=false, $fatal=true)
{
    $valid = false;

    if (!is_array($assetids)) {
        $assetid_array = Array($assetids);
    } else {
        $assetid_array = $assetids;
    }

    $current_id = null;

    foreach ($assetid_array as $one_id) {
        $valid = false;

        if (empty($one_id)) break;

        // valid asset IDs are INTs or STRINGs
        if (!is_int($one_id) && !is_string($one_id)) {
            break;
        }

        $current_id = $one_id;

        // must compare the converted int as string values because a non-numeric string will
        // convert to int(0) which compares TRUE with said non-numeric string - therefore it will
        // be assumed as int! This cast will make it string('0') which compares as FALSE

        $is_int_id = (((string)(int)$one_id) == $one_id);

        if ($is_int_id && !($one_id > 0)) {
            break;
        } else if (!$is_int_id && !preg_match('|^[0-9]+:.*$|', $one_id)) {
            break;
        }
        $valid = true;
    }

    if (!$valid) {
        if (empty($msg)) {
            $msg = translate('assert_assetid', gettype($current_id), htmlspecialchars($current_id));
        }
        trigger_exception($msg, $silent, $fatal);
        return false;
    }
    return true;

}//end assert_valid_assetid()


function trigger_exception($msg, $silent=false, $fatal=false)
{
    $error_type = ($fatal) ? E_USER_ERROR : E_USER_WARNING;
    if (!$silent) {
        if (SQ_CONF_DEBUG & 1) {
            $backtrace = debug_backtrace();
            $line = $backtrace[1]['line'];
            $file = $backtrace[1]['file'];
            if ($fatal) {
                throw new Exception('Assertion failed: '.$msg);
            } else {
                trigger_localised_error('SYS0270', $error_type, $msg, $line, $file);
            }
        } else {
            trigger_localised_error('SYS0320', $error_type, $msg);
        }
    }

    if ($fatal) exit();

}//end trigger_exception()


?>