Meeting::getSession() - Code Metrics - Inspection of "Plugin: Zoom: allow attendance signatures - refs B..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.11.x (#4151)

by Angel Fernando Quiroz

created 2022-01-29 01:18 UTC

Meeting::getSession() A

↳ Parent: Meeting

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

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

namespace Chamilo\PluginBundle\Zoom;

use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\CourseRelUser;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CoreBundle\Entity\SessionRelCourseRelUser;
use Chamilo\CourseBundle\Entity\CGroupInfo;
use Chamilo\PluginBundle\Zoom\API\MeetingInfoGet;
use Chamilo\PluginBundle\Zoom\API\MeetingListItem;
use Chamilo\PluginBundle\Zoom\API\MeetingSettings;
use Chamilo\UserBundle\Entity\User;
use Database;
use DateInterval;
use DateTime;
use DateTimeZone;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Exception;

/**
 * Class Meeting.
 *
 * @ORM\Entity(repositoryClass="Chamilo\PluginBundle\Zoom\MeetingRepository")
 * @ORM\Table(
 *     name="plugin_zoom_meeting",
 *     indexes={
 *         @ORM\Index(name="user_id_index", columns={"user_id"}),
 *         @ORM\Index(name="course_id_index", columns={"course_id"}),
 *         @ORM\Index(name="session_id_index", columns={"session_id"})
 *     }
 * )
 * @ORM\HasLifecycleCallbacks
 */
class Meeting
{
    /** @var string meeting type name */
    public $typeName;

    /** @var DateTime meeting start time as a DateTime instance */
    public $startDateTime;

    /** @var string meeting formatted start time */
    public $formattedStartTime;

    /** @var DateInterval meeting duration as a DateInterval instance */
    public $durationInterval;

    /** @var string meeting formatted duration */
    public $formattedDuration;

    /** @var string */
    public $statusName;

    /**
     * @var int
     * @ORM\Column(type="integer", name="id")
     * @ORM\Id
     * @ORM\GeneratedValue()
     */
    protected $id;

    /**
     * @var int the remote zoom meeting identifier
     * @ORM\Column(name="meeting_id", type="string")
     */
    protected $meetingId;

    /**
     * @var User
     * @ORM\ManyToOne(targetEntity="Chamilo\UserBundle\Entity\User")
     * @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=true)
     */
    protected $user;

    /**
     * @var Course
     * @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
     * @ORM\JoinColumn(name="course_id", referencedColumnName="id", nullable=true)
     */
    protected $course;

    /**
     * @var CGroupInfo
     * @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CGroupInfo")
     * @ORM\JoinColumn(name="group_id", referencedColumnName="iid", nullable=true)
     */
    protected $group;

    /**
     * @var Session
     * @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Session")
     * @ORM\JoinColumn(name="session_id", referencedColumnName="id", nullable=true)
     */
    protected $session;

    /**
     * @var string
     * @ORM\Column(type="text", name="meeting_list_item_json", nullable=true)
     */
    protected $meetingListItemJson;

    /**
     * @var string
     * @ORM\Column(type="text", name="meeting_info_get_json", nullable=true)
     */
    protected $meetingInfoGetJson;

    /**
     * @var bool
     *
     * @ORM\Column(type="boolean", name="sign_attendance")
     */
    protected $signAttendance;

    /**
     * @var string|null
     *
     * @ORM\Column(type="text", name="reason_to_sign_attendance", nullable=true)
     */
    protected $reasonToSignAttendance;

    /** @var MeetingListItem */
    protected $meetingListItem;

    /** @var MeetingInfoGet */
    protected $meetingInfoGet;

    /**
     * @var MeetingActivity[]|ArrayCollection
     * @ORM\OrderBy({"createdAt" = "DESC"})
     * @ORM\OneToMany(targetEntity="MeetingActivity", mappedBy="meeting", cascade={"persist", "remove"})
     */
    protected $activities;

    /**
     * @var Registrant[]|ArrayCollection
     *
     * @ORM\OneToMany(targetEntity="Registrant", mappedBy="meeting", cascade={"persist", "remove"})
     */
    protected $registrants;

    /**
     * @var Recording[]|ArrayCollection
     *
     * @ORM\OneToMany(targetEntity="Recording", mappedBy="meeting", cascade={"persist"}, orphanRemoval=true)
     */
    protected $recordings;

    /**
     * @var ArrayCollection<int, Signature>
     *
     * @ORM\OneToMany(targetEntity="Signature", mappedBy="meeting")
     */
    protected $signatures;

    public function __construct()
    {
        $this->registrants = new ArrayCollection();
        $this->recordings = new ArrayCollection();
        $this->activities = new ArrayCollection();
        $this->signAttendance = false;
        $this->signatures = new ArrayCollection();
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return sprintf('Meeting %d', $this->id);
    }

    /**
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @return int
     */
    public function getMeetingId()
    {
        return $this->meetingId;
    }

    /**
     * @param int $meetingId
     *
     * @return Meeting
     */
    public function setMeetingId($meetingId)
    {
        $this->meetingId = $meetingId;

        return $this;
    }

    /**
     * @return User
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * @return Course
     */
    public function getCourse()
    {
        return $this->course;
    }

    /**
     * @return Session
     */
    public function getSession()
    {
        return $this->session;
    }

    /**
     * @return Registrant[]|ArrayCollection
     */
    public function getRegistrants()
    {
        return $this->registrants;
    }

    /**
     * @return Recording[]|ArrayCollection
     */
    public function getRecordings()
    {
        return $this->recordings;
    }

    /**
     * @return MeetingActivity[]|ArrayCollection
     */
    public function getActivities()
    {
        return $this->activities;
    }

    public function addActivity(MeetingActivity $activity)
    {
        $activity->setMeeting($this);
        $this->activities[] = $activity;
    }

    /**
     * @param MeetingActivity[]|ArrayCollection $activities
     *
     * @return Meeting
     */
    public function setActivities($activities)
    {
        $this->activities = $activities;

        return $this;
    }

    /**
     * @ORM\PostLoad
     *
     * @throws Exception
     */
    public function postLoad()
    {
        if (null !== $this->meetingListItemJson) {
            $this->meetingListItem = MeetingListItem::fromJson($this->meetingListItemJson);
        }
        if (null !== $this->meetingInfoGetJson) {
            $this->meetingInfoGet = MeetingInfoGet::fromJson($this->meetingInfoGetJson);
        }
        $this->initializeDisplayableProperties();
    }

    /**
     * @ORM\PostUpdate
     *
     * @throws Exception
     */
    public function postUpdate()
    {
        $this->initializeDisplayableProperties();
    }

    /**
     * @ORM\PreFlush
     */
    public function preFlush()
    {
        if (null !== $this->meetingListItem) {
            $this->meetingListItemJson = json_encode($this->meetingListItem);
        }
        if (null !== $this->meetingInfoGet) {
            $this->meetingInfoGetJson = json_encode($this->meetingInfoGet);
        }
    }

    /**
     * @return MeetingListItem
     */
    public function getMeetingListItem()
    {
        return $this->meetingListItem;
    }

    /**
     * @return MeetingInfoGet
     */
    public function getMeetingInfoGet()
    {
        return $this->meetingInfoGet;
    }

    /**
     * @param User $user
     *
     * @return $this
     */
    public function setUser($user)
    {
        $this->user = $user;

        return $this;
    }

    /**
     * @param Course $course
     *
     * @return $this
     */
    public function setCourse($course)
    {
        $this->course = $course;

        return $this;
    }

    /**
     * @param Session $session
     *
     * @return $this
     */
    public function setSession($session)
    {
        $this->session = $session;

        return $this;
    }

    /**
     * @return CGroupInfo
     */
    public function getGroup()
    {
        return $this->group;
    }

    /**
     * @param CGroupInfo $group
     *
     * @return Meeting
     */
    public function setGroup($group)
    {
        $this->group = $group;

        return $this;
    }

    /**
     * @param MeetingListItem $meetingListItem
     *
     * @throws Exception
     *
     * @return Meeting
     */
    public function setMeetingListItem($meetingListItem)
    {
        if (null === $this->meetingId) {
            $this->meetingId = $meetingListItem->id;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        } elseif ($this->meetingId != $meetingListItem->id) {
            throw new Exception('the Meeting identifier differs from the MeetingListItem identifier');
        }
        $this->meetingListItem = $meetingListItem;

        return $this;
    }

    /**
     * @param MeetingInfoGet $meetingInfoGet
     *
     * @throws Exception
     *
     * @return Meeting
     */
    public function setMeetingInfoGet($meetingInfoGet)
    {
        if (null === $this->meetingId) {
            $this->meetingId = $meetingInfoGet->id;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        } elseif ($this->meetingId != $meetingInfoGet->id) {
            throw new Exception('the Meeting identifier differs from the MeetingInfoGet identifier');
        }
        $this->meetingInfoGet = $meetingInfoGet;
        $this->initializeDisplayableProperties();

        return $this;
    }

    /**
     * @return bool
     */
    public function isCourseMeeting()
    {
        return null !== $this->course;
    }

    /**
     * @return bool
     */
    public function isCourseGroupMeeting()
    {
        return null !== $this->course && null !== $this->group;
    }

    /**
     * @return bool
     */
    public function isUserMeeting()
    {
        return null !== $this->user && null === $this->course;
    }

    /**
     * @return bool
     */
    public function isGlobalMeeting()
    {
        return null === $this->user && null === $this->course;
    }

    public function setStatus($status)
    {
        $this->meetingInfoGet->status = $status;
    }

    /**
     * Builds the list of users that can register into this meeting.
     * Zoom requires an email address, therefore users without an email address are excluded from the list.
     *
     * @return User[] the list of users
     */
    public function getRegistrableUsers()
    {
        $users = [];
        if (!$this->isCourseMeeting()) {
            $criteria = ['active' => true];
            $users = Database::getManager()->getRepository('ChamiloUserBundle:User')->findBy($criteria);
        } elseif (null === $this->session) {
            if (null !== $this->course) {
                /** @var CourseRelUser $courseRelUser */
                foreach ($this->course->getUsers() as $courseRelUser) {
                    $users[] = $courseRelUser->getUser();
                }
            }
        } else {
            if (null !== $this->course) {
                $subscriptions = $this->session->getUserCourseSubscriptionsByStatus($this->course, Session::STUDENT);
                if ($subscriptions) {
                    /** @var SessionRelCourseRelUser $sessionCourseUser */
                    foreach ($subscriptions as $sessionCourseUser) {
                        $users[] = $sessionCourseUser->getUser();
                    }
                }
            }
        }

        $activeUsersWithEmail = [];
        foreach ($users as $user) {
            if ($user->isActive() && !empty($user->getEmail())) {
                $activeUsersWithEmail[] = $user;
            }
        }

        return $activeUsersWithEmail;
    }

    /**
     * @return bool
     */
    public function requiresDateAndDuration()
    {
        return MeetingInfoGet::TYPE_SCHEDULED === $this->meetingInfoGet->type
            || MeetingInfoGet::TYPE_RECURRING_WITH_FIXED_TIME === $this->meetingInfoGet->type;
    }

    /**
     * @return bool
     */
    public function requiresRegistration()
    {
        return MeetingSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE === $this->meetingInfoGet->settings->approval_type;
        /*return
            MeetingSettings::APPROVAL_TYPE_NO_REGISTRATION_REQUIRED != $this->meetingInfoGet->settings->approval_type;*/
    }

    /**
     * @return bool
     */
    public function hasCloudAutoRecordingEnabled()
    {
        return \ZoomPlugin::RECORDING_TYPE_NONE !== $this->meetingInfoGet->settings->auto_recording;
    }

    /**
     * @param User $user
     *
     * @return bool
     */
    public function hasRegisteredUser($user)
    {
        return $this->getRegistrants()->exists(
            function (Registrant $registrantEntity) use (&$user) {
                return $registrantEntity->getUser() === $user;
            }
        );
    }

    /**
     * @param User $user
     *
     * @return Registrant|null
     */
    public function getRegistrant($user)
    {
        foreach ($this->getRegistrants() as $registrant) {
            if ($registrant->getUser() === $user) {
                return $registrant;
            }
        }

        return null;
    }

    /**
     * Generates a short presentation of the meeting for the future participant.
     * To be displayed above the "Enter meeting" link.
     *
     * @return string
     */
    public function getIntroduction()
    {
        $introduction = sprintf('<h1>%s</h1>', $this->meetingInfoGet->topic).PHP_EOL;
        if (!$this->isGlobalMeeting()) {
            if (!empty($this->formattedStartTime)) {
                $introduction .= $this->formattedStartTime;
                if (!empty($this->formattedDuration)) {
                    $introduction .= ' ('.$this->formattedDuration.')';
                }
                $introduction .= PHP_EOL;
            }
        }
        if ($this->user) {
            $introduction .= sprintf('<p>%s</p>', $this->user->getFullname()).PHP_EOL;
        } elseif ($this->isCourseMeeting()) {
            if (null === $this->session) {
                $introduction .= sprintf('<p class="main">%s</p>', $this->course).PHP_EOL;
            } else {
                $introduction .= sprintf('<p class="main">%s (%s)</p>', $this->course, $this->session).PHP_EOL;
            }
        }
        if (!empty($this->meetingInfoGet->agenda)) {
            $introduction .= sprintf('<p>%s</p>', $this->meetingInfoGet->agenda).PHP_EOL;
        }

        return $introduction;
    }

    public function isSignAttendance(): bool
    {
        return $this->signAttendance;
    }

    public function setSignAttendance(bool $signAttendance): Meeting
    {
        $this->signAttendance = $signAttendance;

        return $this;
    }

    public function getReasonToSignAttendance(): ?string
    {
        return $this->reasonToSignAttendance;
    }

    public function setReasonToSignAttendance(string $reasonToSignAttendance): Meeting
    {
        $this->reasonToSignAttendance = $reasonToSignAttendance;

        return $this;
    }

    /**
     * @return ArrayCollection<int, Signature>
     */
    public function getSignatures(): ArrayCollection
    {
        return $this->signatures;
    }

    /**
     * @throws Exception on unexpected start_time or duration
     */
    private function initializeDisplayableProperties()
    {
        $zoomPlugin = new \ZoomPlugin();

        $typeList = [
            API\Meeting::TYPE_INSTANT => $zoomPlugin->get_lang('InstantMeeting'),
            API\Meeting::TYPE_SCHEDULED => $zoomPlugin->get_lang('ScheduledMeeting'),
            API\Meeting::TYPE_RECURRING_WITH_NO_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithNoFixedTime'),
            API\Meeting::TYPE_RECURRING_WITH_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithFixedTime'),
        ];
        $this->typeName = $typeList[$this->meetingInfoGet->type];

        if (property_exists($this, 'status')) {
            $statusList = [
                'waiting' => $zoomPlugin->get_lang('Waiting'),
                'started' => $zoomPlugin->get_lang('Started'),
                'finished' => $zoomPlugin->get_lang('Finished'),
            ];
            $this->statusName = $statusList[$this->meetingInfoGet->status];
        }
        $this->startDateTime = null;
        $this->formattedStartTime = '';
        $this->durationInterval = null;
        $this->formattedDuration = '';
        if (!empty($this->meetingInfoGet->start_time)) {
            $this->startDateTime = new DateTime($this->meetingInfoGet->start_time);
            $this->startDateTime->setTimezone(new DateTimeZone(api_get_timezone()));
            $this->formattedStartTime = $this->startDateTime->format('Y-m-d H:i');
        }

        if (!empty($this->meetingInfoGet->duration)) {
            $now = new DateTime();
            $later = new DateTime();
            $later->add(new DateInterval('PT'.$this->meetingInfoGet->duration.'M'));
            $this->durationInterval = $later->diff($now);
            $this->formattedDuration = $this->durationInterval->format($zoomPlugin->get_lang('DurationFormat'));
        }
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			namespace Chamilo\PluginBundle\Zoom;
6
7			use Chamilo\CoreBundle\Entity\Course;
8			use Chamilo\CoreBundle\Entity\CourseRelUser;
9			use Chamilo\CoreBundle\Entity\Session;
10			use Chamilo\CoreBundle\Entity\SessionRelCourseRelUser;
11			use Chamilo\CourseBundle\Entity\CGroupInfo;
12			use Chamilo\PluginBundle\Zoom\API\MeetingInfoGet;
13			use Chamilo\PluginBundle\Zoom\API\MeetingListItem;
14			use Chamilo\PluginBundle\Zoom\API\MeetingSettings;
15			use Chamilo\UserBundle\Entity\User;
16			use Database;
17			use DateInterval;
18			use DateTime;
19			use DateTimeZone;
20			use Doctrine\Common\Collections\ArrayCollection;
21			use Doctrine\ORM\Mapping as ORM;
22			use Exception;
23
24			/**
25			* Class Meeting.
26			*
27			* @ORM\Entity(repositoryClass="Chamilo\PluginBundle\Zoom\MeetingRepository")
28			* @ORM\Table(
29			* name="plugin_zoom_meeting",
30			* indexes={
31			* @ORM\Index(name="user_id_index", columns={"user_id"}),
32			* @ORM\Index(name="course_id_index", columns={"course_id"}),
33			* @ORM\Index(name="session_id_index", columns={"session_id"})
34			* }
35			* )
36			* @ORM\HasLifecycleCallbacks
37			*/
38			class Meeting
39			{
40			/** @var string meeting type name */
41			public $typeName;
42
43			/** @var DateTime meeting start time as a DateTime instance */
44			public $startDateTime;
45
46			/** @var string meeting formatted start time */
47			public $formattedStartTime;
48
49			/** @var DateInterval meeting duration as a DateInterval instance */
50			public $durationInterval;
51
52			/** @var string meeting formatted duration */
53			public $formattedDuration;
54
55			/** @var string */
56			public $statusName;
57
58			/**
59			* @var int
60			* @ORM\Column(type="integer", name="id")
61			* @ORM\Id
62			* @ORM\GeneratedValue()
63			*/
64			protected $id;
65
66			/**
67			* @var int the remote zoom meeting identifier
68			* @ORM\Column(name="meeting_id", type="string")
69			*/
70			protected $meetingId;
71
72			/**
73			* @var User
74			* @ORM\ManyToOne(targetEntity="Chamilo\UserBundle\Entity\User")
75			* @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=true)
76			*/
77			protected $user;
78
79			/**
80			* @var Course
81			* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
82			* @ORM\JoinColumn(name="course_id", referencedColumnName="id", nullable=true)
83			*/
84			protected $course;
85
86			/**
87			* @var CGroupInfo
88			* @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CGroupInfo")
89			* @ORM\JoinColumn(name="group_id", referencedColumnName="iid", nullable=true)
90			*/
91			protected $group;
92
93			/**
94			* @var Session
95			* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Session")
96			* @ORM\JoinColumn(name="session_id", referencedColumnName="id", nullable=true)
97			*/
98			protected $session;
99
100			/**
101			* @var string
102			* @ORM\Column(type="text", name="meeting_list_item_json", nullable=true)
103			*/
104			protected $meetingListItemJson;
105
106			/**
107			* @var string
108			* @ORM\Column(type="text", name="meeting_info_get_json", nullable=true)
109			*/
110			protected $meetingInfoGetJson;
111
112			/**
113			* @var bool
114			*
115			* @ORM\Column(type="boolean", name="sign_attendance")
116			*/
117			protected $signAttendance;
118
119			/**
120			* @var string\|null
121			*
122			* @ORM\Column(type="text", name="reason_to_sign_attendance", nullable=true)
123			*/
124			protected $reasonToSignAttendance;
125
126			/** @var MeetingListItem */
127			protected $meetingListItem;
128
129			/** @var MeetingInfoGet */
130			protected $meetingInfoGet;
131
132			/**
133			* @var MeetingActivity[]\|ArrayCollection
134			* @ORM\OrderBy({"createdAt" = "DESC"})
135			* @ORM\OneToMany(targetEntity="MeetingActivity", mappedBy="meeting", cascade={"persist", "remove"})
136			*/
137			protected $activities;
138
139			/**
140			* @var Registrant[]\|ArrayCollection
141			*
142			* @ORM\OneToMany(targetEntity="Registrant", mappedBy="meeting", cascade={"persist", "remove"})
143			*/
144			protected $registrants;
145
146			/**
147			* @var Recording[]\|ArrayCollection
148			*
149			* @ORM\OneToMany(targetEntity="Recording", mappedBy="meeting", cascade={"persist"}, orphanRemoval=true)
150			*/
151			protected $recordings;
152
153			/**
154			* @var ArrayCollection<int, Signature>
155			*
156			* @ORM\OneToMany(targetEntity="Signature", mappedBy="meeting")
157			*/
158			protected $signatures;
159
160			public function __construct()
161			{
162			$this->registrants = new ArrayCollection();
163			$this->recordings = new ArrayCollection();
164			$this->activities = new ArrayCollection();
165			$this->signAttendance = false;
166			$this->signatures = new ArrayCollection();
167			}
168
169			/**
170			* @return string
171			*/
172			public function __toString()
173			{
174			return sprintf('Meeting %d', $this->id);
175			}
176
177			/**
178			* @return int
179			*/
180			public function getId()
181			{
182			return $this->id;
183			}
184
185			/**
186			* @return int
187			*/
188			public function getMeetingId()
189			{
190			return $this->meetingId;
191			}
192
193			/**
194			* @param int $meetingId
195			*
196			* @return Meeting
197			*/
198			public function setMeetingId($meetingId)
199			{
200			$this->meetingId = $meetingId;
201
202			return $this;
203			}
204
205			/**
206			* @return User
207			*/
208			public function getUser()
209			{
210			return $this->user;
211			}
212
213			/**
214			* @return Course
215			*/
216			public function getCourse()
217			{
218			return $this->course;
219			}
220
221			/**
222			* @return Session
223			*/
224			public function getSession()
225			{
226			return $this->session;
227			}
228
229			/**
230			* @return Registrant[]\|ArrayCollection
231			*/
232			public function getRegistrants()
233			{
234			return $this->registrants;
235			}
236
237			/**
238			* @return Recording[]\|ArrayCollection
239			*/
240			public function getRecordings()
241			{
242			return $this->recordings;
243			}
244
245			/**
246			* @return MeetingActivity[]\|ArrayCollection
247			*/
248			public function getActivities()
249			{
250			return $this->activities;
251			}
252
253			public function addActivity(MeetingActivity $activity)
254			{
255			$activity->setMeeting($this);
256			$this->activities[] = $activity;
257			}
258
259			/**
260			* @param MeetingActivity[]\|ArrayCollection $activities
261			*
262			* @return Meeting
263			*/
264			public function setActivities($activities)
265			{
266			$this->activities = $activities;
267
268			return $this;
269			}
270
271			/**
272			* @ORM\PostLoad
273			*
274			* @throws Exception
275			*/
276			public function postLoad()
277			{
278			if (null !== $this->meetingListItemJson) {
279			$this->meetingListItem = MeetingListItem::fromJson($this->meetingListItemJson);
280			}
281			if (null !== $this->meetingInfoGetJson) {
282			$this->meetingInfoGet = MeetingInfoGet::fromJson($this->meetingInfoGetJson);
283			}
284			$this->initializeDisplayableProperties();
285			}
286
287			/**
288			* @ORM\PostUpdate
289			*
290			* @throws Exception
291			*/
292			public function postUpdate()
293			{
294			$this->initializeDisplayableProperties();
295			}
296
297			/**
298			* @ORM\PreFlush
299			*/
300			public function preFlush()
301			{
302			if (null !== $this->meetingListItem) {
303			$this->meetingListItemJson = json_encode($this->meetingListItem);
304			}
305			if (null !== $this->meetingInfoGet) {
306			$this->meetingInfoGetJson = json_encode($this->meetingInfoGet);
307			}
308			}
309
310			/**
311			* @return MeetingListItem
312			*/
313			public function getMeetingListItem()
314			{
315			return $this->meetingListItem;
316			}
317
318			/**
319			* @return MeetingInfoGet
320			*/
321			public function getMeetingInfoGet()
322			{
323			return $this->meetingInfoGet;
324			}
325
326			/**
327			* @param User $user
328			*
329			* @return $this
330			*/
331			public function setUser($user)
332			{
333			$this->user = $user;
334
335			return $this;
336			}
337
338			/**
339			* @param Course $course
340			*
341			* @return $this
342			*/
343			public function setCourse($course)
344			{
345			$this->course = $course;
346
347			return $this;
348			}
349
350			/**
351			* @param Session $session
352			*
353			* @return $this
354			*/
355			public function setSession($session)
356			{
357			$this->session = $session;
358
359			return $this;
360			}
361
362			/**
363			* @return CGroupInfo
364			*/
365			public function getGroup()
366			{
367			return $this->group;
368			}
369
370			/**
371			* @param CGroupInfo $group
372			*
373			* @return Meeting
374			*/
375			public function setGroup($group)
376			{
377			$this->group = $group;
378
379			return $this;
380			}
381
382			/**
383			* @param MeetingListItem $meetingListItem
384			*
385			* @throws Exception
386			*
387			* @return Meeting
388			*/
389			public function setMeetingListItem($meetingListItem)
390			{
391			if (null === $this->meetingId) {
392			$this->meetingId = $meetingListItem->id;
			0 ignored issues – show Documentation Bug introduced 2020-08-03 13:26 UTC by Report Bug Copy Issue Report The property `$meetingId` was declared of type `integer`, but `$meetingListItem->id` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
393			} elseif ($this->meetingId != $meetingListItem->id) {
394			throw new Exception('the Meeting identifier differs from the MeetingListItem identifier');
395			}
396			$this->meetingListItem = $meetingListItem;
397
398			return $this;
399			}
400
401			/**
402			* @param MeetingInfoGet $meetingInfoGet
403			*
404			* @throws Exception
405			*
406			* @return Meeting
407			*/
408			public function setMeetingInfoGet($meetingInfoGet)
409			{
410			if (null === $this->meetingId) {
411			$this->meetingId = $meetingInfoGet->id;
			0 ignored issues – show Documentation Bug introduced 2020-08-03 13:26 UTC by Report Bug Copy Issue Report The property `$meetingId` was declared of type `integer`, but `$meetingInfoGet->id` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
412			} elseif ($this->meetingId != $meetingInfoGet->id) {
413			throw new Exception('the Meeting identifier differs from the MeetingInfoGet identifier');
414			}
415			$this->meetingInfoGet = $meetingInfoGet;
416			$this->initializeDisplayableProperties();
417
418			return $this;
419			}
420
421			/**
422			* @return bool
423			*/
424			public function isCourseMeeting()
425			{
426			return null !== $this->course;
427			}
428
429			/**
430			* @return bool
431			*/
432			public function isCourseGroupMeeting()
433			{
434			return null !== $this->course && null !== $this->group;
435			}
436
437			/**
438			* @return bool
439			*/
440			public function isUserMeeting()
441			{
442			return null !== $this->user && null === $this->course;
443			}
444
445			/**
446			* @return bool
447			*/
448			public function isGlobalMeeting()
449			{
450			return null === $this->user && null === $this->course;
451			}
452
453			public function setStatus($status)
454			{
455			$this->meetingInfoGet->status = $status;
456			}
457
458			/**
459			* Builds the list of users that can register into this meeting.
460			* Zoom requires an email address, therefore users without an email address are excluded from the list.
461			*
462			* @return User[] the list of users
463			*/
464			public function getRegistrableUsers()
465			{
466			$users = [];
467			if (!$this->isCourseMeeting()) {
468			$criteria = ['active' => true];
469			$users = Database::getManager()->getRepository('ChamiloUserBundle:User')->findBy($criteria);
470			} elseif (null === $this->session) {
471			if (null !== $this->course) {
472			/** @var CourseRelUser $courseRelUser */
473			foreach ($this->course->getUsers() as $courseRelUser) {
474			$users[] = $courseRelUser->getUser();
475			}
476			}
477			} else {
478			if (null !== $this->course) {
479			$subscriptions = $this->session->getUserCourseSubscriptionsByStatus($this->course, Session::STUDENT);
480			if ($subscriptions) {
481			/** @var SessionRelCourseRelUser $sessionCourseUser */
482			foreach ($subscriptions as $sessionCourseUser) {
483			$users[] = $sessionCourseUser->getUser();
484			}
485			}
486			}
487			}
488
489			$activeUsersWithEmail = [];
490			foreach ($users as $user) {
491			if ($user->isActive() && !empty($user->getEmail())) {
492			$activeUsersWithEmail[] = $user;
493			}
494			}
495
496			return $activeUsersWithEmail;
497			}
498
499			/**
500			* @return bool
501			*/
502			public function requiresDateAndDuration()
503			{
504			return MeetingInfoGet::TYPE_SCHEDULED === $this->meetingInfoGet->type
505			\|\| MeetingInfoGet::TYPE_RECURRING_WITH_FIXED_TIME === $this->meetingInfoGet->type;
506			}
507
508			/**
509			* @return bool
510			*/
511			public function requiresRegistration()
512			{
513			return MeetingSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE === $this->meetingInfoGet->settings->approval_type;
514			/*return
515			MeetingSettings::APPROVAL_TYPE_NO_REGISTRATION_REQUIRED != $this->meetingInfoGet->settings->approval_type;*/
516			}
517
518			/**
519			* @return bool
520			*/
521			public function hasCloudAutoRecordingEnabled()
522			{
523			return \ZoomPlugin::RECORDING_TYPE_NONE !== $this->meetingInfoGet->settings->auto_recording;
524			}
525
526			/**
527			* @param User $user
528			*
529			* @return bool
530			*/
531			public function hasRegisteredUser($user)
532			{
533			return $this->getRegistrants()->exists(
534			function (Registrant $registrantEntity) use (&$user) {
535			return $registrantEntity->getUser() === $user;
536			}
537			);
538			}
539
540			/**
541			* @param User $user
542			*
543			* @return Registrant\|null
544			*/
545			public function getRegistrant($user)
546			{
547			foreach ($this->getRegistrants() as $registrant) {
548			if ($registrant->getUser() === $user) {
549			return $registrant;
550			}
551			}
552
553			return null;
554			}
555
556			/**
557			* Generates a short presentation of the meeting for the future participant.
558			* To be displayed above the "Enter meeting" link.
559			*
560			* @return string
561			*/
562			public function getIntroduction()
563			{
564			$introduction = sprintf('<h1>%s</h1>', $this->meetingInfoGet->topic).PHP_EOL;
565			if (!$this->isGlobalMeeting()) {
566			if (!empty($this->formattedStartTime)) {
567			$introduction .= $this->formattedStartTime;
568			if (!empty($this->formattedDuration)) {
569			$introduction .= ' ('.$this->formattedDuration.')';
570			}
571			$introduction .= PHP_EOL;
572			}
573			}
574			if ($this->user) {
575			$introduction .= sprintf('<p>%s</p>', $this->user->getFullname()).PHP_EOL;
576			} elseif ($this->isCourseMeeting()) {
577			if (null === $this->session) {
578			$introduction .= sprintf('<p class="main">%s</p>', $this->course).PHP_EOL;
579			} else {
580			$introduction .= sprintf('<p class="main">%s (%s)</p>', $this->course, $this->session).PHP_EOL;
581			}
582			}
583			if (!empty($this->meetingInfoGet->agenda)) {
584			$introduction .= sprintf('<p>%s</p>', $this->meetingInfoGet->agenda).PHP_EOL;
585			}
586
587			return $introduction;
588			}
589
590			public function isSignAttendance(): bool
591			{
592			return $this->signAttendance;
593			}
594
595			public function setSignAttendance(bool $signAttendance): Meeting
596			{
597			$this->signAttendance = $signAttendance;
598
599			return $this;
600			}
601
602			public function getReasonToSignAttendance(): ?string
603			{
604			return $this->reasonToSignAttendance;
605			}
606
607			public function setReasonToSignAttendance(string $reasonToSignAttendance): Meeting
608			{
609			$this->reasonToSignAttendance = $reasonToSignAttendance;
610
611			return $this;
612			}
613
614			/**
615			* @return ArrayCollection<int, Signature>
616			*/
617			public function getSignatures(): ArrayCollection
618			{
619			return $this->signatures;
620			}
621
622			/**
623			* @throws Exception on unexpected start_time or duration
624			*/
625			private function initializeDisplayableProperties()
626			{
627			$zoomPlugin = new \ZoomPlugin();
628
629			$typeList = [
630			API\Meeting::TYPE_INSTANT => $zoomPlugin->get_lang('InstantMeeting'),
631			API\Meeting::TYPE_SCHEDULED => $zoomPlugin->get_lang('ScheduledMeeting'),
632			API\Meeting::TYPE_RECURRING_WITH_NO_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithNoFixedTime'),
633			API\Meeting::TYPE_RECURRING_WITH_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithFixedTime'),
634			];
635			$this->typeName = $typeList[$this->meetingInfoGet->type];
636
637			if (property_exists($this, 'status')) {
638			$statusList = [
639			'waiting' => $zoomPlugin->get_lang('Waiting'),
640			'started' => $zoomPlugin->get_lang('Started'),
641			'finished' => $zoomPlugin->get_lang('Finished'),
642			];
643			$this->statusName = $statusList[$this->meetingInfoGet->status];
644			}
645			$this->startDateTime = null;
646			$this->formattedStartTime = '';
647			$this->durationInterval = null;
648			$this->formattedDuration = '';
649			if (!empty($this->meetingInfoGet->start_time)) {
650			$this->startDateTime = new DateTime($this->meetingInfoGet->start_time);
651			$this->startDateTime->setTimezone(new DateTimeZone(api_get_timezone()));
652			$this->formattedStartTime = $this->startDateTime->format('Y-m-d H:i');
653			}
654
655			if (!empty($this->meetingInfoGet->duration)) {
656			$now = new DateTime();
657			$later = new DateTime();
658			$later->add(new DateInterval('PT'.$this->meetingInfoGet->duration.'M'));
659			$this->durationInterval = $later->diff($now);
660			$this->formattedDuration = $this->durationInterval->format($zoomPlugin->get_lang('DurationFormat'));
661			}
662			}
663			}
664

chamilo / chamilo-lms

Pull Request — 1.11.x (#4151)

Meeting::getSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like