chamilo-lms/public/main/dashboard/dashboard_controller.php

<?php

/* For licensing terms, see /license.txt */

/**
 * Controller script. Prepares the common background
 * variables to give to the scripts corresponding to
 * the requested action.
 *
 * @author Christian Fasanando <christian1827@gmail.com>
 *
 * @todo move to main/inc/lib
 */

use Chamilo\CoreBundle\Component\Utils\ActionIcon;
use Chamilo\CoreBundle\Component\Utils\ToolIcon;

class DashboardController
{
    private $user_id;

    /**
     * Constructor.
     */
    public function __construct()
    {
        $this->user_id = api_get_user_id();
    }

    /**
     * Display blocks from dashboard plugin paths
     * render to dashboard.php view.
     */
    public function display()
    {
        $tpl = new Template(get_lang('Dashboard'));
        $user_id = $this->user_id;
        $dashboard_blocks = DashboardManager::get_enabled_dashboard_blocks();
        $user_block_data = DashboardManager::get_user_block_data($user_id);
        $user_blocks_id = array_keys($user_block_data);
        $blocks = null;
        if (!empty($dashboard_blocks)) {
            foreach ($dashboard_blocks as $block) {
                // display only user blocks
                if (!in_array($block['id'], $user_blocks_id)) {
                    continue;
                }

                $path = $block['path'];
                $controller_class = $block['controller'];
                $filename_controller = $path.'.class.php';
                $dashboard_plugin_path = api_get_path(SYS_PLUGIN_PATH).'dashboard/'.$path.'/';
                require_once $dashboard_plugin_path.$filename_controller;
                if (class_exists($controller_class)) {
                    $obj = new $controller_class($user_id);

                    // check if user is allowed to see the block
                    if (method_exists($obj, 'is_block_visible_for_user')) {
                        $is_block_visible_for_user = $obj->is_block_visible_for_user($user_id);
                        if (!$is_block_visible_for_user) {
                            continue;
                        }
                    }

                    $blocks[$path] = $obj->get_block();
                    // set user block column
                    $blocks[$path]['column'] = $user_block_data[$block['id']]['column'];
                }
            }
        }

        $view = isset($_GET['view']) ? $_GET['view'] : 'blocks';
        api_block_anonymous_users();
        $link_blocks_view = $link_list_view = null;
        if ('list' == $view) {
            $link_blocks_view = '<a href="'.api_get_self().'?view=blocks">'.
                Display::getMdiIcon('monitor-dashboard', 'ch-tool-icon', null, ICON_SIZE_MEDIUM, get_lang('Dashboard blocks')).'</a>';
        } else {
            $link_list_view = '<a href="'.api_get_self().'?view=list">'.
                Display::getMdiIcon(ActionIcon::EDIT, 'ch-tool-icon', null, ICON_SIZE_MEDIUM, get_lang('Edit blocks')).'</a>';
        }

        $configuration_link = null;
        if (api_is_platform_admin()) {
            $configuration_link = '<a href="'.api_get_path(WEB_CODE_PATH).'admin/settings.php?category=Plugins">'
                .Display::getMdiIcon(ToolIcon::SETTINGS, 'ch-tool-icon', null, ICON_SIZE_MEDIUM, get_lang('Configure Dashboard Plugin')).'</a>';
        }

        $actions = Display::toolbarAction('toolbar', [$link_blocks_view.$link_list_view.$configuration_link]);
        $tpl->assign('actions', $actions);

        // block dashboard view
        $columns = [];
        $blockList = null;
        if (isset($view) && 'blocks' === $view) {
            if (isset($blocks) && count($blocks) > 0) {
                // group content html by number of column
                if (is_array($blocks)) {
                    $tmp_columns = [];
                    foreach ($blocks as $block) {
                        $tmp_columns[] = $block['column'];
                        if (in_array($block['column'], $tmp_columns)) {
                            $columns['column_'.$block['column']][] = $block['content_html'];
                        }
                    }
                }
            }
        } else {
            $user_id = api_get_user_id();
            $blockList = DashboardManager::display_user_dashboard_list($user_id);
            $tpl->assign('blocklist', $blockList);
        }

        $tpl->assign('columns', $columns);
        $template = $tpl->get_template('dashboard/index.tpl');
        $content = $tpl->fetch($template);
        $tpl->assign('content', $content);
        $tpl->display_one_col_template();
    }

    /**
     * This method allow store user blocks from dashboard manager
     * render to dashboard.php view.
     */
    public function store_user_block()
    {
        if ("POST" == strtoupper($_SERVER['REQUEST_METHOD'])) {
            $enabled_blocks = $_POST['enabled_blocks'];
            $columns = $_POST['columns'];
            DashboardManager::store_user_blocks($this->user_id, $enabled_blocks, $columns);
            Display::addFlash(Display::return_message(get_lang('Saved')));
        }
        header('Location: '.api_get_path(WEB_CODE_PATH).'dashboard/index.php');
        exit;
    }

    /**
     * This method is used when you close a block from dashboard block interface
     * render to dashboard.php view.
     */
    public function close_user_block($path)
    {
        DashboardManager::close_user_block($this->user_id, $path);
        Display::addFlash(Display::return_message(get_lang('Saved')));
        header('Location: '.api_get_path(WEB_CODE_PATH).'dashboard/index.php');
        exit;
    }
}