StudentPublicationLink

Complexity

Total Complexity

40

Size/Duplication

Total Lines	343
Duplicated Lines	0 %

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getStudentPublication()	0	8	2
A	needs_results()	0	3	1
A	get_all_links()	0	41	4
A	has_results()	0	17	2
A	needs_max()	0	3	1
A	get_description()	0	5	1
F	calc_score()	0	136	16
A	get_link()	0	9	1
A	get_studpub_table()	0	3	1
A	get_icon_name()	0	3	1
A	needs_name_and_description()	0	3	1
A	is_allowed_to_change_name()	0	3	1
A	get_type_name()	0	3	1
A	delete_linked_data()	0	2	1
A	get_name()	0	6	2
A	is_valid_link()	0	5	1
A	save_linked_data()	0	13	2

<?php

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

use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CStudentPublication;

/**
 * Gradebook link to student publication item.
 *
 * @author Bert Steppé
 */
class StudentPublicationLink extends AbstractLink
{
    private $studpub_table;

    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->set_type(LINK_STUDENTPUBLICATION);
    }

    /**
     * @return string
     */
    public function get_type_name()
    {
        return get_lang('Assignments');
    }

    public function is_allowed_to_change_name()
    {
        return false;
    }

    /**
     * Generate an array of all exercises available.
     *
     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
     */
    public function get_all_links()
    {
        if (empty($this->course_code)) {
            return [];
        }

        $sessionId = $this->get_session_id();
        $session = api_get_session_entity($sessionId);
        /*
        if (empty($session_id)) {
            $session_condition = api_get_session_condition(0, true);
        } else {
            $session_condition = api_get_session_condition($session_id, true, true);
        }
        $sql = "SELECT id, url, title FROM $tbl_grade_links
                WHERE c_id = {$this->course_id}  AND filetype='folder' AND active = 1 $session_condition ";*/

        //Only show works from the session
        //AND has_properties != ''
        $repo = Container::getStudentPublicationRepository();
        $qb = $repo->getResourcesByCourse(api_get_course_entity($this->course_id), $session);
        $qb->andWhere("resource.filetype = 'folder' AND resource.active = true");
        $links = $qb->getQuery()->getResult();

        /*$links = Container::getStudentPublicationRepository()
            ->findBy([
                'cId' => $this->course_id,
                'active' => true,
                'filetype' => 'folder',
                'session' => $session,
            ]);*/
        $cats = [];
        foreach ($links as $data) {
            $work_name = $data->getTitle();
            if (empty($work_name)) {
                $work_name = basename($data->getUrl());
            }
            $cats[] = [$data->getIid(), $work_name];
        }

        return $cats;
    }

    /**
     * Has anyone done this exercise yet ?
     */
    public function has_results()
    {
        $studentPublication = $this->getStudentPublication();

        if (empty($studentPublication)) {
            return '';

The expression return '' returns the type string which is incompatible with the return type mandated by AbstractLink::has_results() of boolean.

        }
        $id = $studentPublication->getIid();
        $session = api_get_session_entity($this->get_session_id());
        $results = Container::getStudentPublicationRepository()
            ->findBy([
                'cId' => $this->course_id,
                'parentId' => $id,
                'session' => $session,
            ]);

        return 0 != count($results);
    }

    /**
     * @param null $studentId

Are you sure the doc-type for parameter $studentId is correct as it would always require null to be passed?

     *
     * @return array
     */
    public function calc_score($studentId = null, $type = null)
    {
        $studentId = (int) $studentId;
        $em = Database::getManager();
        $assignment = $this->getStudentPublication();

        if (empty($assignment)) {
            return [];
        }
        $session = api_get_session_entity($this->get_session_id());

        // @todo check session id / course id access
        /*$id = $studentPublication->getIid();
        $assignment = Container::getStudentPublicationRepository()
            ->findOneBy([
                'cId' => $this->course_id,
                'iid' => $id,
                'session' => $session,
            ])
        ;
        $parentId = !$assignment ? 0 : $assignment->getId();
        */

        $parentId = $assignment->getIid();

        if (empty($session)) {
            $dql = 'SELECT a FROM ChamiloCourseBundle:CStudentPublication a
                   WHERE
                        a.cId = :course AND
                        a.active = :active AND
                        a.parentId = :parent AND
                        a.session is null AND
                        a.qualificatorId <> 0
                    ';

            $params = [
                'course' => $this->course_id,
                'parent' => $parentId,
                'active' => true,
            ];
        } else {
            $dql = 'SELECT a FROM ChamiloCourseBundle:CStudentPublication a
                    WHERE
                        a.cId = :course AND
                        a.active = :active AND
                        a.parentId = :parent AND
                        a.session = :session AND
                        a.qualificatorId <> 0
                    ';

            $params = [
                'course' => $this->course_id,
                'parent' => $parentId,
                'session' => $session,
                'active' => true,
            ];
        }

        if (!empty($studentId)) {
            $dql .= ' AND a.userId = :student ';
            $params['student'] = $studentId;
        }

        $order = api_get_setting('student_publication_to_take_in_gradebook');

        switch ($order) {
            case 'last':
                // latest attempt
                $dql .= ' ORDER BY a.sentDate DESC';
                break;
            case 'first':
            default:
                // first attempt
                $dql .= ' ORDER BY a.iid';
                break;
        }

        $scores = $em->createQuery($dql)->execute($params);

        // for 1 student
        if (!empty($studentId)) {
            if (!count($scores)) {
                return [null, null];
            }

            $data = $scores[0];

            return [
                $data->getQualification(),
                $assignment->getQualification(),
                api_get_local_time($assignment->getDateOfQualification()),
                1,
            ];
        }

        $students = []; // user list, needed to make sure we only
        // take first attempts into account
        $rescount = 0;
        $sum = 0;
        $bestResult = 0;
        $weight = 0;
        $sumResult = 0;

        foreach ($scores as $data) {
            if (!(array_key_exists($data->getUserId(), $students))) {
                if (0 != $assignment->getQualification()) {
                    $students[$data->getUserId()] = $data->getQualification();
                    $rescount++;
                    $sum += $data->getQualification() / $assignment->getQualification();
                    $sumResult += $data->getQualification();

                    if ($data->getQualification() > $bestResult) {
                        $bestResult = $data->getQualification();
                    }
                    $weight = $assignment->getQualification();
                }
            }
        }

        if (0 == $rescount) {
            return [null, null];
        }

        switch ($type) {
            case 'best':
                return [$bestResult, $weight];
                break;

break is not strictly necessary here and could be removed.

            case 'average':
                return [$sumResult / $rescount, $weight];
                break;
            case 'ranking':
                return AbstractLink::getCurrentUserRanking($studentId, $students);
                break;
            default:
                return [$sum, $rescount];
                break;
        }
    }

    public function needs_name_and_description()
    {
        return false;
    }

    public function get_name()
    {
        $studentPublication = $this->getStudentPublication();
        $title = $studentPublication->getTitle();

        return empty($title) ? get_lang('Untitled') : $title;
    }

    public function get_description()
    {
        $studentPublication = $this->getStudentPublication();

        return $studentPublication->getDescription();
    }

    public function get_link()
    {
        $studentPublication = $this->getStudentPublication();
        $sessionId = $this->get_session_id();
        $url = api_get_path(WEB_PATH).'main/work/work.php?'.
            api_get_cidreq_params($this->getCourseId(), $sessionId).
            '&id='.$studentPublication->getIid().'&gradebook=view';

        return $url;
    }

    public function needs_max()
    {
        return false;
    }

    public function needs_results()
    {
        return false;
    }

    public function is_valid_link()
    {
        $studentPublication = $this->getStudentPublication();

        return null !== $studentPublication;
    }

    public function get_icon_name()
    {
        return 'studentpublication';
    }

    public function save_linked_data()
    {
        $studentPublication = $this->getStudentPublication();

        if (empty($studentPublication)) {
            return '';
        }

        $weight = api_float_val($this->get_weight());
        $studentPublication->setWeight($weight);

        $repo = Container::getStudentPublicationRepository();
        $repo->update($studentPublication);
    }

    /**
     * @return string
     */
    public function delete_linked_data()
    {
        /*$data = $this->get_exercise_data();
        if (empty($data)) {
            return '';
        }*/

        /*if (!empty($id)) {
            //Cleans works
            $sql = 'UPDATE '.$this->get_studpub_table().'
                    SET weight = 0
                    WHERE c_id = '.$this->course_id.' AND id ='.$id;
            Database::query($sql);
        }*/
    }

    /**
     * Lazy load function to get the database table of the student publications.
     */
    private function get_studpub_table()

The method get_studpub_table() is not used, and could be removed.

    {
        return $this->studpub_table = Database::get_course_table(TABLE_STUDENT_PUBLICATION);
    }

    private function getStudentPublication(): ?CStudentPublication
    {
        $repo = Container::getStudentPublicationRepository();
        if (!empty($this->get_ref_id())) {
            return $repo->find($this->get_ref_id());
        }

        return null;
    }
}