FrmAdd::build() - Code Metrics - Inspection of "Merge branch 'master' of github.com:chamilo/chamil..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b0b4c3...57268f )

by Yannick

created 2024-03-28 11:54 UTC

FrmAdd::build() C

↳ Parent: FrmAdd

Complexity

Conditions	9
Paths	48

Size

Total Lines	135
Code Lines	92

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	92
c	0
b	0
f	0
dl	0
loc	135
rs	6.6189
cc	9
nc	48
nop	0

How to fix Long Method

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

namespace Chamilo\PluginBundle\ImsLti\Form;

use Category;
use Chamilo\PluginBundle\Entity\ImsLti\ImsLtiTool;
use Display;
use FormValidator;
use ImsLti;
use ImsLtiPlugin;
use LtiAssignmentGradesService;
use LtiNamesRoleProvisioningService;

/**
 * Class FrmAdd.
 */
class FrmAdd extends FormValidator
{
    /**
     * @var ImsLtiTool|null
     */
    private $baseTool;
    /**
     * @var bool
     */
    private $toolIsV1p3;

    /**
     * FrmAdd constructor.
     *
     * @param string $name
     * @param array  $attributes
     */
    public function __construct(
        $name,
        $attributes = [],
        ImsLtiTool $tool = null
    ) {
        parent::__construct($name, 'POST', '', '', $attributes, self::LAYOUT_HORIZONTAL, true);

        $this->baseTool = $tool;
        $this->toolIsV1p3 = $this->baseTool
            && !empty($this->baseTool->publicKey)
            && !empty($this->baseTool->getClientId())
            && !empty($this->baseTool->getLoginUrl())
            && !empty($this->baseTool->getRedirectUrl());
    }

    /**
     * Build the form.
     */
    public function build()
    {
        $plugin = ImsLtiPlugin::create();

        $this->addHeader($plugin->get_lang('ToolSettings'));
        $this->addText('name', get_lang('Name'));
        $this->addTextarea('description', get_lang('Description'));

        if (null === $this->baseTool) {
            $this->addUrl('launch_url', $plugin->get_lang('LaunchUrl'), true);
            $this->addRadio(
                'version',
                $plugin->get_lang('LtiVersion'),
                [
                    ImsLti::V_1P1 => 'LTI 1.0 / 1.1',
                    ImsLti::V_1P3 => 'LTI 1.3.0',
                ]
            );
            $this->addHtml('<div class="'.ImsLti::V_1P1.'" style="display: none;">');
            $this->addText('consumer_key', $plugin->get_lang('ConsumerKey'), false);
            $this->addText('shared_secret', $plugin->get_lang('SharedSecret'), false);
            $this->addHtml('</div>');
            $this->addHtml('<div class="'.ImsLti::V_1P3.'" style="display: block;">');
            $this->addRadio(
                'public_key_type',
                $plugin->get_lang('PublicKeyType'),
                [
                    ImsLti::LTI_JWK_KEYSET => $plugin->get_lang('KeySetUrl'),
                    ImsLti::LTI_RSA_KEY => $plugin->get_lang('RsaKey'),
                ]
            );
            $this->addHtml('<div class="'.ImsLti::LTI_JWK_KEYSET.'" style="display: block;">');
            $this->addUrl('jwks_url', $plugin->get_lang('PublicKeyset'), false);
            $this->addHtml('</div>');
            $this->addHtml('<div class="'.ImsLti::LTI_RSA_KEY.'" style="display: none;">');
            $this->addTextarea(
                'public_key',
                $plugin->get_lang('PublicKey'),
                ['style' => 'font-family: monospace;', 'rows' => 5]
            );
            $this->addHtml('</div>');
            $this->addUrl('login_url', $plugin->get_lang('LoginUrl'), false);
            $this->addUrl('redirect_url', $plugin->get_lang('RedirectUrl'), false);
            $this->addHtml('</div>');
        }

        $this->addButtonAdvancedSettings('lti_adv');
        $this->addHtml('<div id="lti_adv_options" style="display:none;">');
        $this->addTextarea(
            'custom_params',
            [$plugin->get_lang('CustomParams'), $plugin->get_lang('CustomParamsHelp')]
        );
        $this->addSelect(
            'document_target',
            get_lang('LinkTarget'),
            ['iframe' => 'iframe', 'window' => 'window']
        );

        if (null === $this->baseTool
            || ($this->baseTool && !$this->baseTool->isActiveDeepLinking())
        ) {
            $this->addCheckBox(
                'deep_linking',
                [null, $plugin->get_lang('SupportDeppLinkingHelp'), null],
                $plugin->get_lang('SupportDeepLinking')
            );
        }

        $showAGS = false;

        if (api_get_course_int_id()) {
            $caterories = Category::load(null, null, api_get_course_id());

            if (!empty($caterories)) {
                $showAGS = true;
            }
        } else {
            $showAGS = true;
        }

        $this->addHtml('<div class="'.ImsLti::V_1P3.'" style="display: none;">');

        if ($showAGS) {
            $this->addRadio(
                '1p3_ags',
                $plugin->get_lang('AssigmentAndGradesService'),
                [
                    LtiAssignmentGradesService::AGS_NONE => $plugin->get_lang('DontUseService'),
                    LtiAssignmentGradesService::AGS_SIMPLE => $plugin->get_lang('AGServiceSimple'),
                    LtiAssignmentGradesService::AGS_FULL => $plugin->get_lang('AGServiceFull'),
                ]
            );
        } else {
            $gradebookUrl = api_get_path(WEB_CODE_PATH).'gradebook/index.php?'.api_get_cidreq();

            $this->addLabel(
                $plugin->get_lang('AssigmentAndGradesService'),
                sprintf(
                    $plugin->get_lang('YouNeedCreateTheGradebokInCourseFirst'),
                    Display::url($gradebookUrl, $gradebookUrl)
                )
            );
        }

        $this->addRadio(
            '1p3_nrps',
            $plugin->get_lang('NamesAndRoleProvisioningService'),
            [
                LtiNamesRoleProvisioningService::NRPS_NONE => $plugin->get_lang('DontUseService'),
                LtiNamesRoleProvisioningService::NRPS_CONTEXT_MEMBERSHIP => $plugin->get_lang('UseService'),
            ]
        );
        $this->addHtml('</div>');

        if (!$this->baseTool) {
            $this->addText(
                'replacement_user_id',
                [
                    $plugin->get_lang('ReplacementUserId'),
                    $plugin->get_lang('ReplacementUserIdHelp'),
                ],
                false
            );
            $this->applyFilter('replacement_user_id', 'trim');
        }

        $this->addHtml('</div>');
        $this->addButtonAdvancedSettings('lti_privacy', get_lang('Privacy'));
        $this->addHtml('<div id="lti_privacy_options" style="display:none;">');
        $this->addCheckBox('share_name', null, $plugin->get_lang('ShareLauncherName'));
        $this->addCheckBox('share_email', null, $plugin->get_lang('ShareLauncherEmail'));
        $this->addCheckBox('share_picture', null, $plugin->get_lang('ShareLauncherPicture'));
        $this->addHtml('</div>');
        $this->addButtonCreate($plugin->get_lang('AddExternalTool'));
        $this->applyFilter('__ALL__', 'trim');
    }

    public function setDefaultValues()
    {
        $defaults = [];
        $defaults['version'] = ImsLti::V_1P3;
        $defaults['public_key_type'] = ImsLti::LTI_JWK_KEYSET;

        if ($this->baseTool) {
            $defaults['name'] = $this->baseTool->getName();
            $defaults['description'] = $this->baseTool->getDescription();
            $defaults['custom_params'] = $this->baseTool->getCustomParams();
            $defaults['document_target'] = $this->baseTool->getDocumentTarget();
            $defaults['share_name'] = $this->baseTool->isSharingName();
            $defaults['share_email'] = $this->baseTool->isSharingEmail();
            $defaults['share_picture'] = $this->baseTool->isSharingPicture();
            $defaults['public_key'] = $this->baseTool->publicKey;
            $defaults['login_url'] = $this->baseTool->getLoginUrl();
            $defaults['redirect_url'] = $this->baseTool->getRedirectUrl();

            if ($this->toolIsV1p3) {
                $advServices = $this->baseTool->getAdvantageServices();

                $defaults['1p3_ags'] = $advServices['ags'];
                $defaults['1p3_nrps'] = $advServices['nrps'];
            }
        }

        $this->setDefaults($defaults);
    }

    public function returnForm(): string
    {
        $js = "<script>
                \$(function () {
                    \$('[name=\"version\"]').on('change', function () {
                        $('.".ImsLti::V_1P1.", .".ImsLti::V_1P3."').hide();

                        $('.' + this.value).show();
                    })
                    \$('[name=\"public_key_type\"]').on('change', function () {
                        $('.".ImsLti::LTI_JWK_KEYSET.", .".ImsLti::LTI_RSA_KEY."').hide();
                        $('[name=\"public_key\"], [name=\"jwks_url\"]').val('');

                        $('.' + this.value).show();
                    })
                });
            </script>";

        return $js.parent::returnForm(); // TODO: Change the autogenerated stub
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			namespace Chamilo\PluginBundle\ImsLti\Form;
5
6			use Category;
7			use Chamilo\PluginBundle\Entity\ImsLti\ImsLtiTool;
8			use Display;
9			use FormValidator;
10			use ImsLti;
11			use ImsLtiPlugin;
12			use LtiAssignmentGradesService;
13			use LtiNamesRoleProvisioningService;
14
15			/**
16			* Class FrmAdd.
17			*/
18			class FrmAdd extends FormValidator
19			{
20			/**
21			* @var ImsLtiTool\|null
22			*/
23			private $baseTool;
24			/**
25			* @var bool
26			*/
27			private $toolIsV1p3;
28
29			/**
30			* FrmAdd constructor.
31			*
32			* @param string $name
33			* @param array $attributes
34			*/
35			public function __construct(
36			$name,
37			$attributes = [],
38			ImsLtiTool $tool = null
39			) {
40			parent::__construct($name, 'POST', '', '', $attributes, self::LAYOUT_HORIZONTAL, true);
41
42			$this->baseTool = $tool;
43			$this->toolIsV1p3 = $this->baseTool
44			&& !empty($this->baseTool->publicKey)
45			&& !empty($this->baseTool->getClientId())
46			&& !empty($this->baseTool->getLoginUrl())
47			&& !empty($this->baseTool->getRedirectUrl());
48			}
49
50			/**
51			* Build the form.
52			*/
53			public function build()
54			{
55			$plugin = ImsLtiPlugin::create();
56
57			$this->addHeader($plugin->get_lang('ToolSettings'));
58			$this->addText('name', get_lang('Name'));
59			$this->addTextarea('description', get_lang('Description'));
60
61			if (null === $this->baseTool) {
62			$this->addUrl('launch_url', $plugin->get_lang('LaunchUrl'), true);
63			$this->addRadio(
64			'version',
65			$plugin->get_lang('LtiVersion'),
66			[
67			ImsLti::V_1P1 => 'LTI 1.0 / 1.1',
68			ImsLti::V_1P3 => 'LTI 1.3.0',
69			]
70			);
71			$this->addHtml('<div class="'.ImsLti::V_1P1.'" style="display: none;">');
72			$this->addText('consumer_key', $plugin->get_lang('ConsumerKey'), false);
73			$this->addText('shared_secret', $plugin->get_lang('SharedSecret'), false);
74			$this->addHtml('</div>');
75			$this->addHtml('<div class="'.ImsLti::V_1P3.'" style="display: block;">');
76			$this->addRadio(
77			'public_key_type',
78			$plugin->get_lang('PublicKeyType'),
79			[
80			ImsLti::LTI_JWK_KEYSET => $plugin->get_lang('KeySetUrl'),
81			ImsLti::LTI_RSA_KEY => $plugin->get_lang('RsaKey'),
82			]
83			);
84			$this->addHtml('<div class="'.ImsLti::LTI_JWK_KEYSET.'" style="display: block;">');
85			$this->addUrl('jwks_url', $plugin->get_lang('PublicKeyset'), false);
86			$this->addHtml('</div>');
87			$this->addHtml('<div class="'.ImsLti::LTI_RSA_KEY.'" style="display: none;">');
88			$this->addTextarea(
89			'public_key',
90			$plugin->get_lang('PublicKey'),
91			['style' => 'font-family: monospace;', 'rows' => 5]
92			);
93			$this->addHtml('</div>');
94			$this->addUrl('login_url', $plugin->get_lang('LoginUrl'), false);
95			$this->addUrl('redirect_url', $plugin->get_lang('RedirectUrl'), false);
96			$this->addHtml('</div>');
97			}
98
99			$this->addButtonAdvancedSettings('lti_adv');
100			$this->addHtml('<div id="lti_adv_options" style="display:none;">');
101			$this->addTextarea(
102			'custom_params',
103			[$plugin->get_lang('CustomParams'), $plugin->get_lang('CustomParamsHelp')]
104			);
105			$this->addSelect(
106			'document_target',
107			get_lang('LinkTarget'),
108			['iframe' => 'iframe', 'window' => 'window']
109			);
110
111			if (null === $this->baseTool
112			\|\| ($this->baseTool && !$this->baseTool->isActiveDeepLinking())
113			) {
114			$this->addCheckBox(
115			'deep_linking',
116			[null, $plugin->get_lang('SupportDeppLinkingHelp'), null],
117			$plugin->get_lang('SupportDeepLinking')
118			);
119			}
120
121			$showAGS = false;
122
123			if (api_get_course_int_id()) {
124			$caterories = Category::load(null, null, api_get_course_id());
125
126			if (!empty($caterories)) {
127			$showAGS = true;
128			}
129			} else {
130			$showAGS = true;
131			}
132
133			$this->addHtml('<div class="'.ImsLti::V_1P3.'" style="display: none;">');
134
135			if ($showAGS) {
136			$this->addRadio(
137			'1p3_ags',
138			$plugin->get_lang('AssigmentAndGradesService'),
139			[
140			LtiAssignmentGradesService::AGS_NONE => $plugin->get_lang('DontUseService'),
141			LtiAssignmentGradesService::AGS_SIMPLE => $plugin->get_lang('AGServiceSimple'),
142			LtiAssignmentGradesService::AGS_FULL => $plugin->get_lang('AGServiceFull'),
143			]
144			);
145			} else {
146			$gradebookUrl = api_get_path(WEB_CODE_PATH).'gradebook/index.php?'.api_get_cidreq();
147
148			$this->addLabel(
149			$plugin->get_lang('AssigmentAndGradesService'),
150			sprintf(
151			$plugin->get_lang('YouNeedCreateTheGradebokInCourseFirst'),
152			Display::url($gradebookUrl, $gradebookUrl)
153			)
154			);
155			}
156
157			$this->addRadio(
158			'1p3_nrps',
159			$plugin->get_lang('NamesAndRoleProvisioningService'),
160			[
161			LtiNamesRoleProvisioningService::NRPS_NONE => $plugin->get_lang('DontUseService'),
162			LtiNamesRoleProvisioningService::NRPS_CONTEXT_MEMBERSHIP => $plugin->get_lang('UseService'),
163			]
164			);
165			$this->addHtml('</div>');
166
167			if (!$this->baseTool) {
168			$this->addText(
169			'replacement_user_id',
170			[
171			$plugin->get_lang('ReplacementUserId'),
172			$plugin->get_lang('ReplacementUserIdHelp'),
173			],
174			false
175			);
176			$this->applyFilter('replacement_user_id', 'trim');
177			}
178
179			$this->addHtml('</div>');
180			$this->addButtonAdvancedSettings('lti_privacy', get_lang('Privacy'));
181			$this->addHtml('<div id="lti_privacy_options" style="display:none;">');
182			$this->addCheckBox('share_name', null, $plugin->get_lang('ShareLauncherName'));
183			$this->addCheckBox('share_email', null, $plugin->get_lang('ShareLauncherEmail'));
184			$this->addCheckBox('share_picture', null, $plugin->get_lang('ShareLauncherPicture'));
185			$this->addHtml('</div>');
186			$this->addButtonCreate($plugin->get_lang('AddExternalTool'));
187			$this->applyFilter('__ALL__', 'trim');
188			}
189
190			public function setDefaultValues()
191			{
192			$defaults = [];
193			$defaults['version'] = ImsLti::V_1P3;
194			$defaults['public_key_type'] = ImsLti::LTI_JWK_KEYSET;
195
196			if ($this->baseTool) {
197			$defaults['name'] = $this->baseTool->getName();
198			$defaults['description'] = $this->baseTool->getDescription();
199			$defaults['custom_params'] = $this->baseTool->getCustomParams();
200			$defaults['document_target'] = $this->baseTool->getDocumentTarget();
201			$defaults['share_name'] = $this->baseTool->isSharingName();
202			$defaults['share_email'] = $this->baseTool->isSharingEmail();
203			$defaults['share_picture'] = $this->baseTool->isSharingPicture();
204			$defaults['public_key'] = $this->baseTool->publicKey;
205			$defaults['login_url'] = $this->baseTool->getLoginUrl();
206			$defaults['redirect_url'] = $this->baseTool->getRedirectUrl();
207
208			if ($this->toolIsV1p3) {
209			$advServices = $this->baseTool->getAdvantageServices();
210
211			$defaults['1p3_ags'] = $advServices['ags'];
212			$defaults['1p3_nrps'] = $advServices['nrps'];
213			}
214			}
215
216			$this->setDefaults($defaults);
217			}
218
219			public function returnForm(): string
220			{
221			$js = "<script>
222			\$(function () {
223			\$('[name=\"version\"]').on('change', function () {
224			$('.".ImsLti::V_1P1.", .".ImsLti::V_1P3."').hide();
225
226			$('.' + this.value).show();
227			})
228			\$('[name=\"public_key_type\"]').on('change', function () {
229			$('.".ImsLti::LTI_JWK_KEYSET.", .".ImsLti::LTI_RSA_KEY."').hide();
230			$('[name=\"public_key\"], [name=\"jwks_url\"]').val('');
231
232			$('.' + this.value).show();
233			})
234			});
235			</script>";
236
237			return $js.parent::returnForm(); // TODO: Change the autogenerated stub
238			}
239			}
240

chamilo / chamilo-lms

Push — master ( b0b4c3...57268f )

FrmAdd::build() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like