bkdotcom/PHPDebugConsole

<?php

/**
 * This file is part of PHPDebugConsole
 *
 * @package   PHPDebugConsole
 * @author    Brad Kent <bkfake-github@yahoo.com>
 * @license   http://opensource.org/licenses/MIT MIT
 * @copyright 2014-2025 Brad Kent
 * @since     3.0b1
 */

namespace bdk\Debug\Plugin;

use bdk\Debug;

/**
 * Provide assertSetting method
 */
trait AssertSettingTrait
{
    /**
     * Assert ini setting is/is-not specified value
     *
     * Multiple method signatures
     *   assertSetting($name[, $valCompare[, $opts]])
     *   assertSetting($name[, $opts])
     *   assertSetting($opts)
     *
     * @param string              $name       setting name (or array of options)
     * @param mixed               $valCompare comparison value
     * @param array<string,mixed> $opts       comparison operator, filter, message, etc
     *
     * @return void
     *
     * @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundBeforeLastUsed
     */
    protected function assertSetting($name, $valCompare = true, array $opts = array())
    {
        $opts = $this->assertSettingOpts(\func_get_args());
        /** @var array{0:bool,1:string} */
        $params = [
            $this->debug->stringUtil->compare($opts['valActual'], $opts['valCompare'], $opts['operator']),
            $opts['name']
                ? '%c' . $opts['name'] . '%c: ' . $opts['msg']
                : $opts['msg'],
        ];
        $cCount = \substr_count($params[1], '%c');
        for ($i = 0; $i < $cCount; $i += 2) {
            $params[] = 'font-family:monospace;';
            $params[] = '';
        }
        $params = \array_merge($params, $opts['addParams']);
        \call_user_func_array([$this->debug, 'assert'], $params);
    }

    /**
     * Get the assert options from passed arguments
     *
     * @param array $args Arguments passed to assertSetting
     *
     * @return array<string,mixed>
     */
    private function assertSettingOpts(array $args)
    {
        $optsDefault = array(
            'addParams' => array(),
            'filter' => FILTER_DEFAULT, // filter applied if getting value from ini val
            'msg' => '',    // (optional) message displayed if assertion fails
            'name' => '',   // ini name
            'operator' => '==',
            'valActual' => '__use_ini_val__',
            'valCompare' => true,
        );
        $opts = array();
        $argNames = array('name', 'valCompare', 'opts');
        foreach ($args as $i => $arg) {
            if (\is_array($arg)) {
                $opts = \array_merge($opts, $arg);
                break;
            }
            $opts[$argNames[$i]] = $arg;
        }
        $opts = \array_merge($optsDefault, $opts);
        return $this->assertSettingPrep($opts);
    }

    /**
     * Merge in default valActual & msg values
     *
     * @param array<string,mixed> $setting setting name, "type", comparison value, operator
     *
     * @return array
     */
    private function assertSettingPrep(array $setting)
    {
        if (\is_bool($setting['valCompare'])) {
            $setting['filter'] = FILTER_VALIDATE_BOOLEAN;
        } elseif (\is_int($setting['valCompare'])) {
            $setting['filter'] = FILTER_VALIDATE_INT;
        }
        if ($setting['valActual'] === '__use_ini_val__') {
            $setting['valActual'] = \filter_var(\ini_get($setting['name']), $setting['filter']);
        }
        if ($setting['msg']) {
            return $setting;
        }
        $valFriendly = $this->valFriendly($setting);
        $setting['msg'] = \sprintf(
            '%s %s',
            \in_array($setting['operator'], ['===', '==', '=', 'eq'], true)
                ? 'should be'
                : 'should not be',
            $valFriendly
        );
        if (\substr($valFriendly, 0, 1) === '<') {
            $setting['addParams'][] = Debug::meta('sanitize', false);
        }
        return $setting;
    }

    /**
     * Get the friendly expected / not-expected value for default message
     *
     * @param array $setting setting options
     *
     * @return string
     */
    private function valFriendly(array $setting)
    {
        if ($setting['filter'] === FILTER_VALIDATE_BOOLEAN) {
            return $setting['valCompare'] ? 'enabled' : 'disabled';
        }
        if ($setting['valCompare'] === '') {
            return 'empty';
        }
        return \is_string($setting['valCompare'])
            ? '<span class="t_string">' . \htmlspecialchars($setting['valCompare']) . '</span>'
            : $setting['valCompare'];
    }
}