<?php

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

/**
 * Class LinkForm
 * Forms related to links.
 *
 * @author Stijn Konings
 * @author Bert Steppé (made more generic)
 */
class LinkForm extends FormValidator
{
    const TYPE_CREATE = 1;
    const TYPE_MOVE = 2;
    /** @var Category */
    private $category_object;
    private $link_object;
    private $extra;

    /**
     * Builds a form containing form items based on a given parameter.
     *
     * @param int          $form_type       1=choose link
     * @param Category     $category_object the category object
     * @param AbstractLink $link_object
     * @param string       $form_name       name
     * @param string       $method
     * @param string       $action
     */
    public function __construct(
        $form_type,
        $category_object,
        $link_object,
        $form_name,
        $method = 'post',
        $action = null,
        $extra = null
    ) {
        parent::__construct($form_name, $method, $action);

        if (isset($category_object)) {
            $this->category_object = $category_object;
        } else {
            if (isset($link_object)) {
                $this->link_object = $link_object;
            }
        }

        if (isset($extra)) {
            $this->extra = $extra;
        }
        if (self::TYPE_CREATE == $form_type) {
            $this->build_create();
        } elseif (self::TYPE_MOVE == $form_type) {
            $this->build_move();
        }
    }

    protected function build_move()
    {
        $renderer = &$this->defaultRenderer();
        $renderer->setCustomElementTemplate('<span>{element}</span> ');
        $this->addElement(
            'static',
            null,
            null,
            '"'.$this->link_object->get_name().'" '
        );
        $this->addElement('static', null, null, get_lang('Move to').' : ');
        $select = $this->addSelect('move_cat', null, []);
        $line = '';
        foreach ($this->link_object->get_target_categories() as $cat) {
            for ($i = 0; $i < $cat[2]; $i++) {
                $line .= '&mdash;';
            }
            $select->addOption($line.' '.$cat[1], $cat[0]);
            $line = '';
        }
        $this->addButtonSave(get_lang('Validate'));
    }

    /**
     * Builds the form.
     */
    protected function build_create()
    {
        $this->addHeader(get_lang('Add online activity'));
        $select = $this->addSelect(
            'select_link',
            get_lang('Choose type of activity to assess'),
            [],
            ['onchange' => 'document.create_link.submit()']
        );

        $select->addOption('['.get_lang('Choose type of activity to assess').']', 0);
        $courseId = $this->category_object->getCourseId();

        $linkTypes = LinkFactory::get_all_types();
        foreach ($linkTypes as $linkType) {
            // The hotpotatoes link will be added "inside" the exercise option.
            if (LINK_HOTPOTATOES == $linkType) {
                continue;
            }
            $link = $this->createLink($linkType, $courseId);
            // disable this element if the link works with a drop-down list
            $link->set_session_id(api_get_session_id());
            // and if there are no links left
            if (!$link->needs_name_and_description() && '0' == count($link->get_all_links())) {
                $select->addOption($link->get_type_name(), $linkType, 'disabled');
            } else {
                $select->addOption($link->get_type_name(), $linkType);
            }

            if (LINK_EXERCISE == $link->get_type()) {
                // Adding hot potatoes
                /*$linkHot = $this->createLink(LINK_HOTPOTATOES, $courseId);
                $linkHot->setHp(true);
                if ($linkHot->get_all_links(true)) {
                    $select->addOption(
                        '&nbsp;&nbsp;&nbsp;'.$linkHot->get_type_name(),
                        LINK_HOTPOTATOES
                    );
                } else {
                    $select->addOption(
                        '&nbsp;&nbsp;&nbsp;'.$linkHot->get_type_name(),
                        LINK_HOTPOTATOES,
                        'disabled'
                    );
                }*/
            }
        }

        if (isset($this->extra)) {
            $this->setDefaults(['select_link' => $this->extra]);
        }
    }

    /**
     * @param int  $link
     * @param ?int $courseId
     *
     * @return AttendanceLink|DropboxLink|ExerciseLink|ForumThreadLink|LearnpathLink|StudentPublicationLink|SurveyLink|null
     */
    private function createLink(int $link, ?int $courseId = null)
    {
        $link = LinkFactory::create($link);
        if (!empty($courseId)) {
            $link->setCourseId($courseId);
        } elseif (!empty($_GET['course_code'])) {
            $courseInfo = api_get_course_info($_GET['course_code']);
            $link->setCourseId($courseInfo['real_id']);
        }

        return $link;
    }
}
