CourseHomeNotifyPlugin::renderRegion() - Code Metrics - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

CourseHomeNotifyPlugin::renderRegion() B
last analyzed 2025-11-26 10:57 UTC

↳ Parent: CourseHomeNotifyPlugin

Complexity

Conditions	8
Paths	6

Size

Total Lines	85
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	42
nc	6
nop	1
dl	0
loc	85
rs	8.0035
c	0
b	0
f	0

How to fix Long Method

<?php
/* For licensing terms, see /license.txt */

use Chamilo\CoreBundle\Framework\Container;
use Chamilo\PluginBundle\CourseHomeNotify\Entity\Notification;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Chamilo\PluginBundle\CourseHomeNotify\Entity\NotificationRelUser;
use Doctrine\ORM\Tools\SchemaTool;

/**
 * Class CourseHomeNotifyPlugin.
 */
class CourseHomeNotifyPlugin extends Plugin
{
    public const SETTING_ENABLED = 'enabled';

    /**
     * CourseHomeNotifyPlugin constructor.
     */
    protected function __construct()
    {
        $settings = [];

        parent::__construct('0.1', 'Angel Fernando Quiroz Campos', $settings);

        $this->isCoursePlugin = true;
        $this->addCourseTool = false;
        $this->setCourseSettings();
    }

    /**
     * @return CourseHomeNotifyPlugin|null
     */
    public static function create()
    {
        static $result = null;

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

    /**
     * Install process.
     * Create table in database. And setup Doctrine entity.
     *
     * @throws \Doctrine\ORM\Tools\ToolsException
     * @throws \Doctrine\DBAL\Exception
     */
    public function install()
    {
        $em = Database::getManager();

        if ($em->getConnection()->createSchemaManager()->tablesExist(['course_home_notify_notification'])) {
            return;
        }

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

    /**
     * Uninstall process.
     * Remove Doctrine entity. And drop table in database.
     *
     * @throws \Doctrine\DBAL\Exception
     */
    public function uninstall()
    {
        $em = Database::getManager();

        if (!$em->getConnection()->createSchemaManager()->tablesExist(['course_home_notify_notification'])) {
            return;
        }

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

    /**
     * @param string $region
     *
     * @return string
     */
    public function renderRegion($region)
    {
        if (
            'main_bottom' !== $region
            || strpos($_SERVER['SCRIPT_NAME'], 'course_home/course_home.php') === false
        ) {
            return '';
        }

        $courseId = api_get_course_int_id();
        $userId = api_get_user_id();

        if (empty($courseId) || empty($userId)) {
            return '';
        }

        $course = api_get_course_entity($courseId);
        $user = api_get_user_entity($userId);

        $em = Database::getManager();
        /** @var Notification $notification */
        $notification = $em
            ->getRepository('ChamiloPluginBundle:CourseHomeNotify\Notification')
            ->findOneBy(['course' => $course]);

        if (!$notification) {

            return '';
        }

        $modalFooter = '';
        $modalConfig = ['show' => true];

        if ($notification->getExpirationLink()) {
            /** @var NotificationRelUser $notificationUser */
            $notificationUser = $em
                ->getRepository('ChamiloPluginBundle:CourseHomeNotify\NotificationRelUser')
                ->findOneBy(['notification' => $notification, 'user' => $user]);

            if ($notificationUser) {

                return '';
            }

            $contentUrl = api_get_path(WEB_PLUGIN_PATH).$this->get_name().'/content.php?hash='.$notification->getHash();
            $link = Display::toolbarButton(
                $this->get_lang('PleaseFollowThisLink'),
                $contentUrl,
                'external-link',
                'link',
                ['id' => 'course-home-notify-link', 'target' => '_blank']
            );

            $modalConfig['keyboard'] = false;
            $modalConfig['backdrop'] = 'static';

            $modalFooter = '<div class="modal-footer">'.$link.'</div>';
        }

        $modal = '<div id="course-home-notify-modal" class="modal" tabindex="-1" role="dialog">
            <div class="modal-dialog" role="document">
                <div class="modal-content">
                    <div class="modal-header">
                        <button type="button" class="close" data-dismiss="modal" aria-label="'.get_lang('Close').'">
                            <span aria-hidden="true">&times;</span>
                        </button>
                        <h4 class="modal-title">'.$this->get_lang('CourseNotice').'</h4>
                    </div>
                    <div class="modal-body">
                        '.$notification->getContent().'
                    </div>
                    '.$modalFooter.'
                </div>
            </div>
        </div>';

        $modal .= "<script>
            $(document).ready(function () {
                \$('#course-home-notify-modal').modal(".json_encode($modalConfig).");

                \$('#course-home-notify-link').on('click', function () {
                    $('#course-home-notify-modal').modal('hide');
                });
            });
        </script>";

        return $modal;
    }

    /**
     * Set the course settings.
     */
    private function setCourseSettings()
    {
        if (!Container::getPluginHelper()->isPluginEnabled($this->get_name())) {
            return;
        }

        $name = $this->get_name();

        $button = Display::toolbarButton(
            $this->get_lang('SetNotification'),
            api_get_path(WEB_PLUGIN_PATH).$name.'/configure.php?'.api_get_cidreq(),
            'cog',
            'primary'
        );

        $this->course_settings = [
            [
                'name' => '<p>'.$this->get_comment().'</p>'.$button.'<hr>',
                'type' => 'html',
            ],
        ];
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			use Chamilo\CoreBundle\Framework\Container;
5			use Chamilo\PluginBundle\CourseHomeNotify\Entity\Notification;
			0 ignored issues – show Bug introduced 2019-06-26 22:33 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Notification`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6			use Chamilo\PluginBundle\CourseHomeNotify\Entity\NotificationRelUser;
7			use Doctrine\ORM\Tools\SchemaTool;
8
9			/**
10			* Class CourseHomeNotifyPlugin.
11			*/
12			class CourseHomeNotifyPlugin extends Plugin
13			{
14			public const SETTING_ENABLED = 'enabled';
15
16			/**
17			* CourseHomeNotifyPlugin constructor.
18			*/
19			protected function __construct()
20			{
21			$settings = [];
22
23			parent::__construct('0.1', 'Angel Fernando Quiroz Campos', $settings);
24
25			$this->isCoursePlugin = true;
26			$this->addCourseTool = false;
27			$this->setCourseSettings();
28			}
29
30			/**
31			* @return CourseHomeNotifyPlugin\|null
32			*/
33			public static function create()
34			{
35			static $result = null;
36
37			return $result ? $result : $result = new self();
38			}
39
40			/**
41			* Install process.
42			* Create table in database. And setup Doctrine entity.
43			*
44			* @throws \Doctrine\ORM\Tools\ToolsException
45			* @throws \Doctrine\DBAL\Exception
46			*/
47			public function install()
48			{
49			$em = Database::getManager();
50
51			if ($em->getConnection()->createSchemaManager()->tablesExist(['course_home_notify_notification'])) {
52			return;
53			}
54
55			$schemaTool = new SchemaTool($em);
56			$schemaTool->createSchema(
57			[
58			$em->getClassMetadata(Notification::class),
59			$em->getClassMetadata(NotificationRelUser::class),
60			]
61			);
62			}
63
64			/**
65			* Uninstall process.
66			* Remove Doctrine entity. And drop table in database.
67			*
68			* @throws \Doctrine\DBAL\Exception
69			*/
70			public function uninstall()
71			{
72			$em = Database::getManager();
73
74			if (!$em->getConnection()->createSchemaManager()->tablesExist(['course_home_notify_notification'])) {
75			return;
76			}
77
78			$schemaTool = new SchemaTool($em);
79			$schemaTool->dropSchema(
80			[
81			$em->getClassMetadata(Notification::class),
82			$em->getClassMetadata(NotificationRelUser::class),
83			]
84			);
85			}
86
87			/**
88			* @param string $region
89			*
90			* @return string
91			*/
92			public function renderRegion($region)
93			{
94			if (
95			'main_bottom' !== $region
96			\|\| strpos($_SERVER['SCRIPT_NAME'], 'course_home/course_home.php') === false
97			) {
98			return '';
99			}
100
101			$courseId = api_get_course_int_id();
102			$userId = api_get_user_id();
103
104			if (empty($courseId) \|\| empty($userId)) {
105			return '';
106			}
107
108			$course = api_get_course_entity($courseId);
109			$user = api_get_user_entity($userId);
110
111			$em = Database::getManager();
112			/** @var Notification $notification */
113			$notification = $em
114			->getRepository('ChamiloPluginBundle:CourseHomeNotify\Notification')
115			->findOneBy(['course' => $course]);
116
117			if (!$notification) {
			0 ignored issues – show introduced 2025-03-31 17:56 UTC by Report Bug Copy Issue Report `$notification` is of type `Chamilo\PluginBundle\Cou...ify\Entity\Notification`, thus it always evaluated to `true`. Loading history...
118			return '';
119			}
120
121			$modalFooter = '';
122			$modalConfig = ['show' => true];
123
124			if ($notification->getExpirationLink()) {
125			/** @var NotificationRelUser $notificationUser */
126			$notificationUser = $em
127			->getRepository('ChamiloPluginBundle:CourseHomeNotify\NotificationRelUser')
128			->findOneBy(['notification' => $notification, 'user' => $user]);
129
130			if ($notificationUser) {
			0 ignored issues – show introduced 2025-03-31 17:56 UTC by Report Bug Copy Issue Report `$notificationUser` is of type `Chamilo\PluginBundle\Cou...ity\NotificationRelUser`, thus it always evaluated to `true`. Loading history...
131			return '';
132			}
133
134			$contentUrl = api_get_path(WEB_PLUGIN_PATH).$this->get_name().'/content.php?hash='.$notification->getHash();
135			$link = Display::toolbarButton(
136			$this->get_lang('PleaseFollowThisLink'),
137			$contentUrl,
138			'external-link',
139			'link',
140			['id' => 'course-home-notify-link', 'target' => '_blank']
141			);
142
143			$modalConfig['keyboard'] = false;
144			$modalConfig['backdrop'] = 'static';
145
146			$modalFooter = '<div class="modal-footer">'.$link.'</div>';
147			}
148
149			$modal = '<div id="course-home-notify-modal" class="modal" tabindex="-1" role="dialog">
150			<div class="modal-dialog" role="document">
151			<div class="modal-content">
152			<div class="modal-header">
153			<button type="button" class="close" data-dismiss="modal" aria-label="'.get_lang('Close').'">
154			<span aria-hidden="true">×</span>
155			</button>
156			<h4 class="modal-title">'.$this->get_lang('CourseNotice').'</h4>
157			</div>
158			<div class="modal-body">
159			'.$notification->getContent().'
160			</div>
161			'.$modalFooter.'
162			</div>
163			</div>
164			</div>';
165
166			$modal .= "<script>
167			$(document).ready(function () {
168			\$('#course-home-notify-modal').modal(".json_encode($modalConfig).");
169
170			\$('#course-home-notify-link').on('click', function () {
171			$('#course-home-notify-modal').modal('hide');
172			});
173			});
174			</script>";
175
176			return $modal;
177			}
178
179			/**
180			* Set the course settings.
181			*/
182			private function setCourseSettings()
183			{
184			if (!Container::getPluginHelper()->isPluginEnabled($this->get_name())) {
185			return;
186			}
187
188			$name = $this->get_name();
189
190			$button = Display::toolbarButton(
191			$this->get_lang('SetNotification'),
192			api_get_path(WEB_PLUGIN_PATH).$name.'/configure.php?'.api_get_cidreq(),
193			'cog',
194			'primary'
195			);
196
197			$this->course_settings = [
198			[
199			'name' => '<p>'.$this->get_comment().'</p>'.$button.'<hr>',
200			'type' => 'html',
201			],
202			];
203			}
204			}
205

chamilo / chamilo-lms

CourseHomeNotifyPlugin::renderRegion() B last analyzed 2025-11-26 10:57 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

CourseHomeNotifyPlugin::renderRegion() B
last analyzed 2025-11-26 10:57 UTC