security/flags

source < >

return function () {
    $docs = _class('docs');
    $intro = '<p class="docs-demo-intro">The opt-in security switches, from the same list as the
        <a href="' . url('/@object/install') . '#harden">Install page</a> (<code>yf_docs::$HARDEN</code>). Each one is off by default so that
        existing sites keep their behaviour; a default changes only in a major release.
        <b>Default</b> is the class property, <b>this site</b> is what the docs site\'s own <code>$PROJECT_CONF</code> sets.
        Details: the <a href="https://github.com/yfix/yf/blob/master/docs/UPGRADING.md">upgrade notes</a> and the API reference of each class.</p>';
    $show = function ($v) {
        return '<code>' . _prepare_html(is_array($v) ? json_encode($v) : var_export($v, true), 0) . '</code>';
    };
    $rows = '';
    foreach ($docs->HARDEN as $name => $info) {
        $flags = [];
        $defaults = [];
        $current = [];
        foreach ($info['flags'] as [$class, $property, $dir]) {
            $v = $docs->_flag_values($class, $property, $dir);
            $flags[] = '<code>' . $class . '.' . $property . '</code>';
            $defaults[] = $v['known'] ? $show($v['default']) : '<span class="text-muted">?</span>';
            // live values (proxy ranges, cookie settings) are not shown to visitors: only whether the site changed the default
            $current[] = $v['known'] ? ($v['current'] === $v['default'] ? '<span class="text-muted">default</span>' : '<b>set</b>') : '<span class="text-muted">?</span>';
        }
        $rows .= '<tr><td><b>' . _prepare_html($info['title'], 0) . '</b>' . $info['note']
            . '<pre class="docs-demo-snippet"><code class="php">' . _prepare_html($info['snippet'], 0) . '</code></pre></td>'
            . '<td>' . implode('<br>', $flags) . '</td><td>' . implode('<br>', $defaults) . '</td><td>' . implode('<br>', $current) . '</td></tr>';
    }
    css('.docs-demo-flags code { white-space:normal; word-break:break-word; }
        pre.docs-demo-snippet { margin:6px 0 0; } pre.docs-demo-snippet code { white-space:pre-wrap; word-break:break-word; }');
    return $intro . '<div class="table-responsive"><table class="table table-bordered table-condensed table-sm docs-demo-flags" style="width:100%">'
        . '<thead><tr><th style="width:55%">Switch and how to turn it on</th><th>Property</th><th>Default</th><th>This site</th></tr></thead><tbody>' . $rows . '</tbody></table></div>';
};