UserRemoteServicePlugin::updateService() - Code Metrics - Inspection of "Merge pull request #3353 from sebastiendu/16297-cu..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.11.x ( 24970b...636aa7 )

by Julito

created 2020-07-08 10:09 UTC

UserRemoteServicePlugin::updateService() A

↳ Parent: UserRemoteServicePlugin

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

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

use Chamilo\PluginBundle\UserRemoteService\UserRemoteService;
use Doctrine\ORM\OptimisticLockException;

class UserRemoteServicePlugin extends Plugin
{
    const TABLE = 'plugin_user_remote_service';

    /**
     * UserRemoteServicePlugin constructor.
     */
    protected function __construct()
    {
        parent::__construct(
            '1.0',
            'Sébastien Ducoulombier',
            [
                'salt' => 'text',
            ]
        );
        $this->isAdminPlugin = true;
    }

    /**
     * Caches and returns a single instance.
     *
     * @return UserRemoteServicePlugin
     */
    public static function create()
    {
        static $result = null;

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

    /**
     * Creates the plugin table.
     */
    public function install()
    {
        Database::query(
            sprintf(
                <<<OEQ
create table if not exists %s (
    id int unsigned not null auto_increment primary key,
    title varchar(255) not null,
    url varchar(255) not null
)
OEQ,
                Database::get_main_table(self::TABLE)
            )
        );
    }

    /**
     * Drops the plugin table.
     */
    public function uninstall()
    {
        Database::query('drop table if exists '.Database::get_main_table(self::TABLE));
    }

    /**
     * @return string the salt setting
     */
    public function salt()
    {
        return $this->get('salt');
    }

    /**
     * Retrieves the list of all services.
     *
     * @return UserRemoteService[]
     */
    public function getServices()
    {
        return Database::getManager()->getRepository(
            'Chamilo\PluginBundle\UserRemoteService\UserRemoteService'
        )->findAll();
    }

    /**
     * Adds a new service.
     *
     * @param string $title
     * @param string $url
     *
     * @throws OptimisticLockException
     */
    public function addService($title, $url)
    {
        $service = new UserRemoteService;
        $service->setTitle($title);
        $service->setURL($url);
        Database::getManager()->persist($service);
        Database::getManager()->flush();
    }

    /**
     * Removes a service.
     *
     * @param UserRemoteService $service
     *
     * @throws OptimisticLockException
     */
    public function removeService($service)
    {
        Database::getManager()->remove($service);
        Database::getManager()->flush();
    }

    /**
     * Updates a service.
     *
     * @param UserRemoteService $service
     *
     * @throws OptimisticLockException
     */
    public function updateService($service)
    {
        Database::getManager()->persist($service);
        Database::getManager()->flush();
    }

    /**
     * Returns the active service id.
     *
     * @return int|null
     */
    public function getActiveServiceId()
    {
        return array_key_exists('serviceId', $_REQUEST) ? intval($_REQUEST['serviceId']) : null;
    }

    /**
     * Generates the menu items to be appended to the navigation array
     *
     * @see \return_navigation_array
     *
     * @return array menu items
     */
    public function getNavigationMenu()
    {
        $menu = [];
        $activeServiceId = $this->getActiveServiceId();
        foreach ($this->getServices() as $service) {
            $key = 'service_'.$service->getId();
            $current = $service->getId() == $activeServiceId;
            $menu[$key] = [
                'key' => $key,
                'current' => $current ? 'active' : '',
                'url' => sprintf(
                    '%s%s/iframe.php?serviceId=%d',
                    api_get_path(WEB_PLUGIN_PATH),
                    $this->get_name(),
                    $service->getId()
                ),
                'title' => $service->getTitle(),
            ];
        }
        return $menu;
    }

    /**
     * Generates and handles submission of the creation form.
     *
     * @throws OptimisticLockException
     *
     * @return FormValidator
     */
    public function getCreationForm()
    {
        $form = new FormValidator('creationForm');
        $titleText = $form->addText('title', get_lang('ServiceTitle'));
        $urlText = $form->addText('url', get_lang('ServiceURL'));
        $form->addButtonCreate(get_lang('CreateService'));
        if ($form->validate()) {
            $this->addService($titleText->getValue(), $urlText->getValue());
        }
        return $form;
    }

    /**
     * Generates and handles submission of the service deletion form.
     *
     * @throws OptimisticLockException
     *
     * @return FormValidator
     */
    public function getDeletionForm()
    {
        $form = new FormValidator('deletionForm');
        $services = $this->getServices();
        $options = [];
        foreach ($services as $service) {
            $options[$service->getId()] = $service->getTitle();
        }
        $serviceIdSelect = $form->addSelect('serviceId', get_lang('ServicesToDelete'), $options);
        $serviceIdSelect->setMultiple(true);
        $form->addButtonDelete(get_lang('DeleteServices'));
        if ($form->validate()) {
            foreach ($serviceIdSelect->getValue() as $serviceId) {
                foreach ($services as $service) {
                    if ($service->getId() == $serviceId) {
                        $this->removeService($service);
                    }
                }
            }
        }
        return $form;
    }

    /**
     * Generates the service HTML table.
     *
     * @return string
     */
    public function getServiceHTMLTable()
    {
        $html = '';
        $services = $this->getServices();
        if (!empty($services)) {
            $table = new HTML_Table('class="table"');
            $table->addRow(
                [
                    get_lang('ServiceTitle'),
                    get_lang('ServiceURL'),
                ],
                null,
                'th'
            );
            foreach ($services as $service) {
                $table->addRow([
                    $service->getTitle(),
                    $service->getURL(),
                ]);
            }
            $html = $table->toHtml();
        }
        return $html;
    }

    /**
     * Retrieves one service.
     *
     * @param int $id the service identifier
     *
     * @return UserRemoteService the service
     */
    public function getService($id)
    {
        return Database::getManager()->getRepository(
            'Chamilo\PluginBundle\UserRemoteService\UserRemoteService'
        )->find($id);
    }

    /**
     * Generates the iframe HTML element to load a service URL
     *
     * @throws Exception on hash generation failure
     *
     * @return string the iframe HTML element
     */
    public function getIFrame()
    {
        $userInfo = api_get_user_info();
        return sprintf(
            <<<HTML
<div class="embed-responsive embed-responsive-16by9">
 <iframe class="embed-responsive-item" src="%s"></iframe>
</div>
HTML,
            $this->getService(
                $this->getActiveServiceId()
            )->getCustomUserURL($userInfo['username'], $userInfo['id'], $this->salt())
        );
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			use Chamilo\PluginBundle\UserRemoteService\UserRemoteService;
5			use Doctrine\ORM\OptimisticLockException;
6
7			class UserRemoteServicePlugin extends Plugin
8			{
9			const TABLE = 'plugin_user_remote_service';
10
11			/**
12			* UserRemoteServicePlugin constructor.
13			*/
14			protected function __construct()
15			{
16			parent::__construct(
17			'1.0',
18			'Sébastien Ducoulombier',
19			[
20			'salt' => 'text',
21			]
22			);
23			$this->isAdminPlugin = true;
24			}
25
26			/**
27			* Caches and returns a single instance.
28			*
29			* @return UserRemoteServicePlugin
30			*/
31			public static function create()
32			{
33			static $result = null;
34
35			return $result ? $result : $result = new self();
36			}
37
38			/**
39			* Creates the plugin table.
40			*/
41			public function install()
42			{
43			Database::query(
44			sprintf(
45			<<<OEQ
46			create table if not exists %s (
47			id int unsigned not null auto_increment primary key,
48			title varchar(255) not null,
49			url varchar(255) not null
50			)
51			OEQ,
52			Database::get_main_table(self::TABLE)
53			)
54			);
55			}
56
57			/**
58			* Drops the plugin table.
59			*/
60			public function uninstall()
61			{
62			Database::query('drop table if exists '.Database::get_main_table(self::TABLE));
63			}
64
65			/**
66			* @return string the salt setting
67			*/
68			public function salt()
69			{
70			return $this->get('salt');
71			}
72
73			/**
74			* Retrieves the list of all services.
75			*
76			* @return UserRemoteService[]
77			*/
78			public function getServices()
79			{
80			return Database::getManager()->getRepository(
81			'Chamilo\PluginBundle\UserRemoteService\UserRemoteService'
82			)->findAll();
83			}
84
85			/**
86			* Adds a new service.
87			*
88			* @param string $title
89			* @param string $url
90			*
91			* @throws OptimisticLockException
92			*/
93			public function addService($title, $url)
94			{
95			$service = new UserRemoteService;
96			$service->setTitle($title);
97			$service->setURL($url);
98			Database::getManager()->persist($service);
99			Database::getManager()->flush();
100			}
101
102			/**
103			* Removes a service.
104			*
105			* @param UserRemoteService $service
106			*
107			* @throws OptimisticLockException
108			*/
109			public function removeService($service)
110			{
111			Database::getManager()->remove($service);
112			Database::getManager()->flush();
113			}
114
115			/**
116			* Updates a service.
117			*
118			* @param UserRemoteService $service
119			*
120			* @throws OptimisticLockException
121			*/
122			public function updateService($service)
123			{
124			Database::getManager()->persist($service);
125			Database::getManager()->flush();
126			}
127
128			/**
129			* Returns the active service id.
130			*
131			* @return int\|null
132			*/
133			public function getActiveServiceId()
134			{
135			return array_key_exists('serviceId', $_REQUEST) ? intval($_REQUEST['serviceId']) : null;
136			}
137
138			/**
139			* Generates the menu items to be appended to the navigation array
140			*
141			* @see \return_navigation_array
142			*
143			* @return array menu items
144			*/
145			public function getNavigationMenu()
146			{
147			$menu = [];
148			$activeServiceId = $this->getActiveServiceId();
149			foreach ($this->getServices() as $service) {
150			$key = 'service_'.$service->getId();
151			$current = $service->getId() == $activeServiceId;
152			$menu[$key] = [
153			'key' => $key,
154			'current' => $current ? 'active' : '',
155			'url' => sprintf(
156			'%s%s/iframe.php?serviceId=%d',
157			api_get_path(WEB_PLUGIN_PATH),
158			$this->get_name(),
159			$service->getId()
160			),
161			'title' => $service->getTitle(),
162			];
163			}
164			return $menu;
165			}
166
167			/**
168			* Generates and handles submission of the creation form.
169			*
170			* @throws OptimisticLockException
171			*
172			* @return FormValidator
173			*/
174			public function getCreationForm()
175			{
176			$form = new FormValidator('creationForm');
177			$titleText = $form->addText('title', get_lang('ServiceTitle'));
178			$urlText = $form->addText('url', get_lang('ServiceURL'));
179			$form->addButtonCreate(get_lang('CreateService'));
180			if ($form->validate()) {
181			$this->addService($titleText->getValue(), $urlText->getValue());
182			}
183			return $form;
184			}
185
186			/**
187			* Generates and handles submission of the service deletion form.
188			*
189			* @throws OptimisticLockException
190			*
191			* @return FormValidator
192			*/
193			public function getDeletionForm()
194			{
195			$form = new FormValidator('deletionForm');
196			$services = $this->getServices();
197			$options = [];
198			foreach ($services as $service) {
199			$options[$service->getId()] = $service->getTitle();
200			}
201			$serviceIdSelect = $form->addSelect('serviceId', get_lang('ServicesToDelete'), $options);
202			$serviceIdSelect->setMultiple(true);
203			$form->addButtonDelete(get_lang('DeleteServices'));
204			if ($form->validate()) {
205			foreach ($serviceIdSelect->getValue() as $serviceId) {
206			foreach ($services as $service) {
207			if ($service->getId() == $serviceId) {
208			$this->removeService($service);
209			}
210			}
211			}
212			}
213			return $form;
214			}
215
216			/**
217			* Generates the service HTML table.
218			*
219			* @return string
220			*/
221			public function getServiceHTMLTable()
222			{
223			$html = '';
224			$services = $this->getServices();
225			if (!empty($services)) {
226			$table = new HTML_Table('class="table"');
227			$table->addRow(
228			[
229			get_lang('ServiceTitle'),
230			get_lang('ServiceURL'),
231			],
232			null,
233			'th'
234			);
235			foreach ($services as $service) {
236			$table->addRow([
237			$service->getTitle(),
238			$service->getURL(),
239			]);
240			}
241			$html = $table->toHtml();
242			}
243			return $html;
244			}
245
246			/**
247			* Retrieves one service.
248			*
249			* @param int $id the service identifier
250			*
251			* @return UserRemoteService the service
252			*/
253			public function getService($id)
254			{
255			return Database::getManager()->getRepository(
256			'Chamilo\PluginBundle\UserRemoteService\UserRemoteService'
257			)->find($id);
258			}
259
260			/**
261			* Generates the iframe HTML element to load a service URL
262			*
263			* @throws Exception on hash generation failure
264			*
265			* @return string the iframe HTML element
266			*/
267			public function getIFrame()
268			{
269			$userInfo = api_get_user_info();
270			return sprintf(
271			<<<HTML
272			<div class="embed-responsive embed-responsive-16by9">
273			<iframe class="embed-responsive-item" src="%s"></iframe>
274			</div>
275			HTML,
276			$this->getService(
277			$this->getActiveServiceId()
278			)->getCustomUserURL($userInfo['username'], $userInfo['id'], $this->salt())
279			);
280			}
281			}
282

chamilo / chamilo-lms

Push — 1.11.x ( 24970b...636aa7 )

UserRemoteServicePlugin::updateService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like