MailTemplateManager::returnForm() - Code Metrics - Inspection of "Internal - Fix legacy code, add psalm checks" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 41516e...c87549 )

by Julito

created 2020-09-25 11:55 UTC

MailTemplateManager::returnForm() B

↳ Parent: MailTemplateManager

Complexity

Conditions	6
Paths	32

Size

Total Lines	77
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	41
nc	32
nop	2
dl	0
loc	77
rs	8.6417
c	0
b	0
f	0

How to fix Long Method

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

use Symfony\Component\Finder\Finder;

/**
 * Class MailTemplateManager.
 */
class MailTemplateManager extends Model
{
    public $columns = [
        'id',
        'name',
        'template',
        'type',
        'system',
        'url_id',
        'default_template',
        'created_at',
        'updated_at',
        'author_id',
    ];

    public function __construct()
    {
        parent::__construct();

        $this->table = 'mail_template';
    }

    /**
     * @return int
     */
    public function get_count()
    {
        $row = Database::select(
            'count(*) as count',
            $this->table,
            ['where' => ['url_id = ? ' => api_get_current_access_url_id()]],
            'first'
        );

        return $row['count'];
    }

    /**
     * Displays the title + grid.
     *
     * @return string html code
     */
    public function display()
    {
        // Action links
        $html = '<div class="actions" style="margin-bottom:20px">';
        $html .= '<a href="'.api_get_path(WEB_CODE_PATH).'admin">'.
            Display::return_icon(
                'back.png',
                get_lang('Back'),
                '',
                '32'
            )
            .'</a>';
        $html .= '<a href="'.api_get_self().'?action=add">'.
            Display::return_icon(
                'add.png',
                get_lang('Add'),
                '',
                '32'
            ).'</a>';
        $html .= '</div>';
        $html .= Display::grid_html('mail_template');

        return $html;
    }

    /**
     * Returns a Form validator Obj.
     *
     * @param string $url
     * @param string $action
     *
     * @return FormValidator
     */
    public function returnForm($url, $action = 'add')
    {
        $form = new FormValidator('template', 'post', $url);
        // Setting the form elements
        $header = get_lang('Add');
        if ('edit' === $action) {
            $header = get_lang('Edit');
        }
        $id = isset($_GET['id']) ? (int) $_GET['id'] : '';

        $form->addElement('header', '', $header);
        $form->addElement('hidden', 'id', $id);
        $form->addElement(
            'text',
            'name',
            get_lang('Name'),
            ['size' => '70', 'id' => 'name']
        );

        /*$form->addHtmlEditor(
            'email_template',
            get_lang('Template'),
            false,
            false,
            [
                'ToolbarSet' => 'Careers',
                'Width' => '100%',
                'Height' => '250',
            ]
        );*/
        $form->addTextarea(
            'email_template',
            get_lang('Template')
        );

        $finder = new Finder();
        $files = $finder
            ->files()
            ->in(api_get_path(SYS_CODE_PATH).'template/default/mail')
            ->sort(
                function ($a, $b) {
                    return strcmp($a->getRealpath(), $b->getRealpath());
                }
            );

        $options = [];
        /** @var SplFileInfo $file */
        foreach ($files as $file) {
            $options[$file->getFilename()] = $file->getFilename();
        }

        $form->addSelect(
            'type',
            get_lang('Type'),
            $options
        );

        $defaults = $this->get($id);

        if ('edit' === $action) {
            $form->addLabel(get_lang('Created at'), Display::dateToStringAgoAndLongDate($defaults['created_at']));
            $form->addLabel(get_lang('Updated at'), Display::dateToStringAgoAndLongDate($defaults['updated_at']));
            $form->addButtonSave(get_lang('Edit'), 'submit');
        } else {
            $form->addButtonCreate(get_lang('Add'), 'submit');
        }

        // Setting the defaults
        if (!empty($defaults)) {
            $defaults['email_template'] = $defaults['template'];
        }
        $form->setDefaults($defaults);

        // Setting the rules
        $form->addRule('name', get_lang('Required field'), 'required');

        return $form;
    }

    /**
     * @param int $id
     *
     * @return bool
     */
    public function setDefault($id)
    {
        $template = $this->get($id);
        if (empty($template)) {
            return false;
        }
        $type = $template['type'];
        $urlId = api_get_current_access_url_id();
        $sql = "UPDATE {$this->table} SET default_template = 0
                WHERE type = '$type' AND url_id = $urlId";
        Database::query($sql);

        $sql = "UPDATE {$this->table} SET default_template = 1
                WHERE id = $id";
        Database::query($sql);

        return true;
    }

    /**
     * @param int   $templateId
     * @param array $userInfo
     *
     * @return string|false
     */
    public function parseTemplate($templateId, $userInfo)
    {
        $templateInfo = $this->get($templateId);
        if (!empty($templateInfo)) {
            $emailTemplate = $templateInfo['template'];

            $keys = array_keys($userInfo);
            foreach ($keys as $key) {
                $emailTemplate = str_replace("{{user.$key}}", $userInfo[$key], $emailTemplate);
            }
            $template = new Template();
            $template->twig->setLoader(new \Twig_Loader_String());
            $emailBody = $template->twig->render($emailTemplate);

            return $emailBody;
        }

        return false;
    }

    /**
     * Gets a custom mail template by the name of the template it replaces.
     *
     * @param string $templateType Name of the template file it replaces
     *
     * @return string
     */
    public function getTemplateByType($templateType)
    {
        if (empty($templateType)) {
            return '';
        }
        $result = Database::select(
            'template',
            $this->table,
            ['where' => ['type = ? ' => $templateType, ' AND url_id = ? ' => api_get_current_access_url_id()]],
            'first'
        );
        if (empty($result)) {
            return '';
        }

        return $result['template'];
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			use Symfony\Component\Finder\Finder;
5
6			/**
7			* Class MailTemplateManager.
8			*/
9			class MailTemplateManager extends Model
10			{
11			public $columns = [
12			'id',
13			'name',
14			'template',
15			'type',
16			'system',
17			'url_id',
18			'default_template',
19			'created_at',
20			'updated_at',
21			'author_id',
22			];
23
24			public function __construct()
25			{
26			parent::__construct();
27
28			$this->table = 'mail_template';
29			}
30
31			/**
32			* @return int
33			*/
34			public function get_count()
35			{
36			$row = Database::select(
37			'count(*) as count',
38			$this->table,
39			['where' => ['url_id = ? ' => api_get_current_access_url_id()]],
40			'first'
41			);
42
43			return $row['count'];
44			}
45
46			/**
47			* Displays the title + grid.
48			*
49			* @return string html code
50			*/
51			public function display()
52			{
53			// Action links
54			$html = '<div class="actions" style="margin-bottom:20px">';
55			$html .= '<a href="'.api_get_path(WEB_CODE_PATH).'admin">'.
56			Display::return_icon(
57			'back.png',
58			get_lang('Back'),
59			'',
60			'32'
61			)
62			.'</a>';
63			$html .= '<a href="'.api_get_self().'?action=add">'.
64			Display::return_icon(
65			'add.png',
66			get_lang('Add'),
67			'',
68			'32'
69			).'</a>';
70			$html .= '</div>';
71			$html .= Display::grid_html('mail_template');
72
73			return $html;
74			}
75
76			/**
77			* Returns a Form validator Obj.
78			*
79			* @param string $url
80			* @param string $action
81			*
82			* @return FormValidator
83			*/
84			public function returnForm($url, $action = 'add')
85			{
86			$form = new FormValidator('template', 'post', $url);
87			// Setting the form elements
88			$header = get_lang('Add');
89			if ('edit' === $action) {
90			$header = get_lang('Edit');
91			}
92			$id = isset($_GET['id']) ? (int) $_GET['id'] : '';
93
94			$form->addElement('header', '', $header);
95			$form->addElement('hidden', 'id', $id);
96			$form->addElement(
97			'text',
98			'name',
99			get_lang('Name'),
100			['size' => '70', 'id' => 'name']
101			);
102
103			/*$form->addHtmlEditor(
104			'email_template',
105			get_lang('Template'),
106			false,
107			false,
108			[
109			'ToolbarSet' => 'Careers',
110			'Width' => '100%',
111			'Height' => '250',
112			]
113			);*/
114			$form->addTextarea(
115			'email_template',
116			get_lang('Template')
117			);
118
119			$finder = new Finder();
120			$files = $finder
121			->files()
122			->in(api_get_path(SYS_CODE_PATH).'template/default/mail')
123			->sort(
124			function ($a, $b) {
125			return strcmp($a->getRealpath(), $b->getRealpath());
126			}
127			);
128
129			$options = [];
130			/** @var SplFileInfo $file */
131			foreach ($files as $file) {
132			$options[$file->getFilename()] = $file->getFilename();
133			}
134
135			$form->addSelect(
136			'type',
137			get_lang('Type'),
138			$options
139			);
140
141			$defaults = $this->get($id);
142
143			if ('edit' === $action) {
144			$form->addLabel(get_lang('Created at'), Display::dateToStringAgoAndLongDate($defaults['created_at']));
145			$form->addLabel(get_lang('Updated at'), Display::dateToStringAgoAndLongDate($defaults['updated_at']));
146			$form->addButtonSave(get_lang('Edit'), 'submit');
147			} else {
148			$form->addButtonCreate(get_lang('Add'), 'submit');
149			}
150
151			// Setting the defaults
152			if (!empty($defaults)) {
153			$defaults['email_template'] = $defaults['template'];
154			}
155			$form->setDefaults($defaults);
156
157			// Setting the rules
158			$form->addRule('name', get_lang('Required field'), 'required');
159
160			return $form;
161			}
162
163			/**
164			* @param int $id
165			*
166			* @return bool
167			*/
168			public function setDefault($id)
169			{
170			$template = $this->get($id);
171			if (empty($template)) {
172			return false;
173			}
174			$type = $template['type'];
175			$urlId = api_get_current_access_url_id();
176			$sql = "UPDATE {$this->table} SET default_template = 0
177			WHERE type = '$type' AND url_id = $urlId";
178			Database::query($sql);
179
180			$sql = "UPDATE {$this->table} SET default_template = 1
181			WHERE id = $id";
182			Database::query($sql);
183
184			return true;
185			}
186
187			/**
188			* @param int $templateId
189			* @param array $userInfo
190			*
191			* @return string\|false
192			*/
193			public function parseTemplate($templateId, $userInfo)
194			{
195			$templateInfo = $this->get($templateId);
196			if (!empty($templateInfo)) {
197			$emailTemplate = $templateInfo['template'];
198
199			$keys = array_keys($userInfo);
200			foreach ($keys as $key) {
201			$emailTemplate = str_replace("{{user.$key}}", $userInfo[$key], $emailTemplate);
202			}
203			$template = new Template();
204			$template->twig->setLoader(new \Twig_Loader_String());
205			$emailBody = $template->twig->render($emailTemplate);
206
207			return $emailBody;
208			}
209
210			return false;
211			}
212
213			/**
214			* Gets a custom mail template by the name of the template it replaces.
215			*
216			* @param string $templateType Name of the template file it replaces
217			*
218			* @return string
219			*/
220			public function getTemplateByType($templateType)
221			{
222			if (empty($templateType)) {
223			return '';
224			}
225			$result = Database::select(
226			'template',
227			$this->table,
228			['where' => ['type = ? ' => $templateType, ' AND url_id = ? ' => api_get_current_access_url_id()]],
229			'first'
230			);
231			if (empty($result)) {
232			return '';
233			}
234
235			return $result['template'];
236			}
237			}
238

chamilo / chamilo-lms

Push — master ( 41516e...c87549 )

MailTemplateManager::returnForm() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like