ExerciseFocusedPlugin

Complexity

Total Complexity

20

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getActionTitle()	0	14	5
A	createLinkToCourseTool()	0	17	2
A	create()	0	5	2
A	__construct()	0	17	1
A	install()	0	23	2
A	uninstall()	0	20	3
A	getSessionFieldList()	0	7	1
A	getLinkReporting()	0	25	4

<?php

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

use Chamilo\CourseBundle\Entity\CTool;
use Chamilo\PluginBundle\ExerciseFocused\Entity\Log;
use Doctrine\ORM\Tools\SchemaTool;
use Doctrine\ORM\Tools\ToolsException;

class ExerciseFocusedPlugin extends Plugin
{
    public const SETTING_TOOL_ENABLE = 'tool_enable';
    public const SETTING_TIME_LIMIT = 'time_limit';
    public const SETTING_ENABLE_ABANDONMENT = 'enable_abandonment_limit';
    public const SETTING_ABANDONMENT_LIMIT = 'abandonment_limit';
    public const SETTING_SESSION_FIELD_FILTERS = 'session_field_filters';

    public const FIELD_SELECTED = 'exercisefocused_selected';

    private const TABLE_LOG = 'plugin_exercisefocused_log';

    protected function __construct()
    {
        $settings = [
            self::SETTING_TOOL_ENABLE => 'boolean',
            self::SETTING_TIME_LIMIT => 'text',
            self::SETTING_ENABLE_ABANDONMENT => 'boolean',
            self::SETTING_ABANDONMENT_LIMIT => 'text',
            self::SETTING_SESSION_FIELD_FILTERS => 'text',
        ];

        parent::__construct(
            "0.0.1",
            "Angel Fernando Quiroz Campos <angel.quiroz@beeznest.com>",
            $settings
        );

        $this->isAdminPlugin = true;
    }

    public static function create(): ?ExerciseFocusedPlugin
    {
        static $result = null;

        return $result ?: $result = new self();
    }

    /**
     * @throws ToolsException
     */
    public function install()
    {
        $em = Database::getManager();

        if ($em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_LOG])) {
            return;
        }

        $schemaTool = new SchemaTool($em);
        $schemaTool->createSchema(
            [
                $em->getClassMetadata(Log::class),
            ]
        );

        $objField = new ExtraField('exercise');
        $objField->save([
            'variable' => ExerciseFocusedPlugin::FIELD_SELECTED,
            'field_type' => ExtraField::FIELD_TYPE_CHECKBOX,
            'display_text' => $this->get_title(),
            'visible_to_self' => true,
            'changeable' => true,
            'filter' => false,
        ]);
    }

    public function uninstall()
    {
        $em = Database::getManager();

        if (!$em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_LOG])) {
            return;
        }

        $schemaTool = new SchemaTool($em);
        $schemaTool->dropSchema(
            [
                $em->getClassMetadata(Log::class),
            ]
        );

        $objField = new ExtraField('exercise');
        $extraFieldInfo = $objField->get_handler_field_info_by_field_variable(ExerciseFocusedPlugin::FIELD_SELECTED);

        if ($extraFieldInfo) {
            $objField->delete($extraFieldInfo['id']);
        }
    }

    public function getActionTitle($action): string
    {
        switch ($action) {
            case Log::TYPE_OUTFOCUSED:
                return $this->get_lang('Outfocused');
            case Log::TYPE_RETURN:
                return $this->get_lang('Return');
            case Log::TYPE_ABANDONMENT_LIMIT:
                return $this->get_lang('MaxAbandonments');
            case Log::TYPE_TIME_LIMIT:
                return $this->get_lang('TimeLimit');
        }

        return '';
    }

    public function getLinkReporting(int $exerciseId): string
    {
        if (!$this->isEnabled(true)) {
            return '';
        }

        $values = (new ExtraFieldValue('exercise'))
            ->get_values_by_handler_and_field_variable($exerciseId, self::FIELD_SELECTED);

        if (!$values || !$values['value']) {
            return '';
        }

        $icon = Display::return_icon(
            'window_list_slide.png',
            $this->get_lang('ReportByAttempts'),
            [],
            ICON_SIZE_MEDIUM
        );

        $url = api_get_path(WEB_PLUGIN_PATH)
            .'exercisefocused/pages/reporting.php?'
            .api_get_cidreq().'&'.http_build_query(['id' => $exerciseId]);

        return Display::url($icon, $url);
    }

    public function getSessionFieldList(): array
    {
        $settingField = $this->get(self::SETTING_SESSION_FIELD_FILTERS);

        $fields = explode(',', $settingField);

        return array_map('trim', $fields);
    }

    protected function createLinkToCourseTool($name, $courseId, $iconName = null, $link = null, $sessionId = 0, $category = 'plugin'): ?CTool
    {
        $tool = parent::createLinkToCourseTool($name, $courseId, $iconName, $link, $sessionId, $category);

        if (!$tool) {
            return null;
        }

        $tool->setName(
            $tool->getName().':teacher'
        );

        $em = Database::getManager();
        $em->persist($tool);
        $em->flush();

        return $tool;
    }
}