root/dev/common/class.options.php @ 181

<?php

/*
* This is the class which should make it easier to add new options to the admin menu
* It may only be invoked statically like: options::add(...);
* more functions will be added as needed, if you want one, add it or contact exi
*/

class options
{
    // i just want to make sure....
    function options()
    {
        trigger_error('The class "options" may only be invoked statically.', E_USER_ERROR);
    }

    // field = generic, subfield = look and feel, name = banner, type = select
    function add($field, $subfield, $set, $description, $name, $type, $buildcallback = '', $onchange = '', $hint = '')
    {
        $data = &options::_getData();
        $data[$field][$subfield][$set][] = array('descr' => $description, 'name' => $name, 'type' => $type,
                                                 'callback' => $buildcallback,
                                                 'onchange' => $onchange, 'hint' => $hint);
    }

    // fast add uses the last used category by options::cat so you don't have to retype everything
    function fadd($description, $name, $type, $buildcallback = '', $onchange = '', $hint = '')
    {
        global $options_faddcat;

        $data = &options::_getData();
        $data[$options_faddcat[0]][$options_faddcat[1]][$options_faddcat[2]][] = array('descr' => $description, 'name' => $name, 'type' => $type,
                                                 'callback' => $buildcallback,
                                                 'onchange' => $onchange, 'hint' => $hint);
    }

    function cat($field, $subfield, $set)
    {
        global $options_faddcat;

        $options_faddcat = array($field, $subfield, $set);
    }

    // this will emulate the old options menu
    function oldMenu($field, $subfield, $link)
    {
        $data = &options::_getData();

        $data[$field][$subfield] = $link;
    }

    // this handles the submit from the optionspage
    function handlePost()
    {
        $data = &options::_getData();

        $current = &$data[$_POST['field']][$_POST['sub']];
        foreach ($current as $elements)
        {
            foreach ($elements as $element)
            {
                // for callbacks we check their callback function on postdata to deal with it
                if ($element['callback'])
                {
                    if (!is_callable($element['callback']))
                    {
                        trigger_error('Unable to callback to '.$element['callback'][0].'::'.$element['callback'][1], E_USER_ERROR);
                        return false;
                    }
                    call_user_func($element['callback']);
                    continue;
                }

                // for checkboxes we need to set the value to zero if the option is not there
                if ($element['type'] == 'checkbox')
                {
                    if ($_POST['option'][$element['name']] == 'on')
                    {
                        config::set($element['name'], '1');
                    }
                    else
                    {
                        config::set($element['name'], '0');
                    }
                }
                else
                {
                    // edits and options will be set directly
                    config::set($element['name'], $_POST['option'][$element['name']]);
                }
            }
        }
    }

    function genOptionsPage()
    {
        $data = &options::_getData();

        $field = $_REQUEST['field'];
        $sub = $_REQUEST['sub'];

        global $smarty, $page;

        if (is_object($page))
        {
            $page->setTitle('Administration - '.$sub);
        }

        // create the option field
        $smarty->assign('field', $field);
        $smarty->assign('sub', $sub);
        $html = $smarty->fetch(get_tpl('admin_options_field_head'));

        // create all option sets
        foreach ($data[$field][$sub] as $set => $options)
        {
            $smarty->assign('set', $set);
            $html .= $smarty->fetch(get_tpl('admin_options_set_head'));

            // create all options in the set
            foreach ($options as $option)
            {
                $html .= options::assembleElement($option);
            }
            $html .= $smarty->fetch(get_tpl('admin_options_set_foot'));
        }
        $html .= $smarty->fetch(get_tpl('admin_options_field_foot'));
        return $html;
    }

    function assembleElement(&$element)
    {
        global $smarty;

        // this will extract all options into an array
        $options = array();
        if (strpos($element['type'], ':'))
        {
            $array = explode(':', $element['type']);
            $element['type'] = array_shift($array);

            $max = count($array);
            for ($i=0; $i<=$max; $i+=2)
            {
                // make sure we assign a value
                if (isset($array[$i+1]))
                {
                    $options[$array[$i]] = $array[$i+1];
                }
            }
        }

        if ($element['type'] == 'select')
        {
            if (!is_callable($element['callback']))
            {
                trigger_error('Unable to callback to '.$element['callback'][0].'::'.$element['callback'][1], E_USER_ERROR);
                return false;
            }

            $option = call_user_func($element['callback']);
            $smarty->assign('options', $option);
            $smarty->assign_by_ref('opt', $element);
            return $smarty->fetch(get_tpl('admin_options_select'));
        }

        if ($element['type'] == 'checkbox')
        {
            $smarty->assign_by_ref('opt', $element);
            return $smarty->fetch(get_tpl('admin_options_checkbox'));
        }

        if ($element['type'] == 'edit')
        {
            $smarty->assign_by_ref('opt', $element);

            if (!$options['size'])
            {
                $options['size'] = 20;
            }
            if (!$options['maxlength'])
            {
                $options['maxlength'] = 80;
            }
            $smarty->assign_by_ref('options', $options);
            return $smarty->fetch(get_tpl('admin_options_edit'));
        }

        // for a custom element we call the callback to get the html we want
        if ($element['type'] == 'custom')
        {
            if (!is_callable($element['callback']))
            {
                trigger_error('Unable to callback to '.$element['callback'][0].'::'.$element['callback'][1], E_USER_ERROR);
                return false;
            }

            $element['html'] = call_user_func($element['callback']);
            $smarty->assign_by_ref('opt', $element);
            return $smarty->fetch(get_tpl('admin_options_custom'));
        }

        // unknown/not implemented element type
        return $element['name'];
    }

    function genAdminMenu()
    {
        $data = &options::_getData();

        // sort the menu alphabetically
        ksort($data);

        // create a standardbox to print all links into
        $menubox = new Box('Options');
        $menubox->setIcon('menu-item.gif');
        foreach ($data as $field => $subfields)
        {
            $menubox->addOption('caption', $field);

            foreach ($subfields as $subfield => $array)
            {
                // if this subfield has no options then it is a category
                if (!is_array($array))
                {
                    $menubox->addOption('link', $subfield, $array);
                    continue;
                }

                // we're not a category, make it klickable
                $menubox->addOption('link', $subfield, '?a=admin&amp;field='.$field.'&amp;sub='.$subfield);
            }
            $lastfield = $field;
        }
        return $menubox->generate();
    }

    // private data storage to store all options
    function &_getData()
    {
        static $data;

        if (!isset($data))
        {
            $data = array();
        }
        return $data;
    }
}
?>