Message::withBodyOptions() - Code Metrics - Inspection of "Clean-up, refactoring, update changes html encode." - yiisoft/yii-bulma - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#31)

by Wilmer

created 2021-02-08 19:03 UTC

Message::withBodyOptions() A

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bulma;

use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;

/**
 * Message renders Bulma message component.
 *
 * For example,
 *
 * ```php
 * <?= Message::widget()->withHeaderColor('success')->withHeader('System info')->withBody('Say hello...') ?>
 * ```
 *
 * @link https://bulma.io/documentation/components/message/
 */
final class Message extends Widget
{
    private string $body = '';
    private string $headerColor = 'is-dark';
    private string $headerMessage = '';
    private array $options = [];
    private array $bodyOptions = [];
    private array $closeButtonOptions = [];
    private array $headerOptions = [];
    private string $size = '';
    private bool $withoutCloseButton = false;
    private bool $withoutHeader = true;
    private bool $encodeTags = false;

    protected function run(): string
    {
        $this->buildOptions();

        return
            Html::beginTag('div', $this->options) . "\n" .
                $this->renderHeader() .
                Html::beginTag('div', $this->bodyOptions) . "\n" .
                    $this->renderBodyEnd() . "\n" .
                Html::endTag('div') . "\n" .
            Html::endTag('div');
    }

    /**
     * The body content in the message component. Message widget will also be treated as the body content, and will be
     * rendered before this.
     *
     * @param string $value
     *
     * @return self
     */
    public function withBody(string $value): self
    {
        $new = clone $this;
        $new->body = $value;
        return $new;
    }

    /**
     * Set color header message.
     *
     * @param string $value setting default 'is-dark', 'is-primary', 'is-link', 'is-info', 'is-success', 'is-warning',
     * 'is-danger'.
     *
     * @return self
     */
    public function withHeaderColor(string $value): self
    {
        $new = clone $this;
        $new->headerColor = $value;
        return $new;
    }

    /**
     * The header message in the message component. Message widget will also be treated as the header content, and will
     * be rendered before body.
     *
     * @param string $value
     *
     * @return self
     */
    public function withHeaderMessage(string $value): self
    {
        $new = clone $this;
        $new->headerMessage = $value;
        return $new;
    }

    /**
     * The HTML attributes for the widget container tag.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     *
     * @param array $value
     *
     * @return self
     */
    public function withOptions(array $value): self
    {
        $new = clone $this;
        $new->options = $value;
        return $new;
    }

    /**
     * The HTML attributes for the widget body tag.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     *
     * @param array $value
     *
     * @return self
     */
    public function withBodyOptions(array $value): self
    {
        $new = clone $this;
        $new->bodyOptions = $value;
        return $new;
    }

    /**
     * The options for rendering the close button tag.
     *
     * The close button is displayed in the header of the modal window. Clicking on the button will hide the modal
     * window. If {@see withoutCloseButton} is false, no close button will be rendered.
     *
     * @param array $value
     *
     * @return self
     */
    public function withCloseButtonOptions(array $value): self
    {
        $new = clone $this;
        $new->closeButtonOptions = $value;
        return $new;
    }

    /**
     * The HTML attributes for the widget header tag.
     *
     * {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
     *
     * @param array $value
     *
     * @return self
     */
    public function withHeaderOptions(array $value): self
    {
        $new = clone $this;
        $new->headerOptions = $value;
        return $new;
    }

    /**
     * Set size message widget.
     *
     * @param string $value default setting empty normal, 'is-small', 'is-medium', 'is-large'.
     *
     * @return self
     */
    public function withSize(string $value): self
    {
        $new = clone $this;
        $new->size = $value;
        return $new;
    }

    /**
     * Allows you to enable close button message widget.
     *
     * @return self
     */
    public function withCloseButton(): self
    {
        $new = clone $this;
        $new->withoutCloseButton = true;
        return $new;
    }

    /**
     * Allows you to disable header widget.
     *
     * @return self
     */
    public function withoutHeader(): self
    {
        $new = clone $this;
        $new->withoutHeader = false;
        return $new;
    }

    /**
     * Allows you to enable the encoding tags html.
     *
     * @return self
     */
    public function withEncodeTags(): self
    {
        $new = clone $this;
        $new->encodeTags = true;

        return $new;
    }

    private function buildOptions(): void
    {
        if (!isset($this->options['id'])) {
            $this->options['id'] = "{$this->getId()}-message";
        }

        $this->options = $this->addOptions($this->options, 'message');

        Html::addCssClass($this->options, $this->headerColor);

        if ($this->size !== '') {
            Html::addCssClass($this->options, $this->size);
        }

        $this->bodyOptions = $this->addOptions($this->bodyOptions, 'message-body');
        $this->closeButtonOptions = $this->addOptions($this->closeButtonOptions, 'delete');
        $this->headerOptions = $this->addOptions($this->headerOptions, 'message-header');

        if ($this->encodeTags === false) {
            $this->closeButtonOptions['encode'] = false;
            $this->options['encode'] = false;
        }
    }

    private function renderHeader(): string
    {
        $html = '';

        if ($this->withoutHeader) {
            $html = Html::beginTag('div', $this->headerOptions) . "\n" . $this->renderHeaderMessage() . "\n" .
                Html::endTag('div') . "\n";
        }

        return $html;
    }

    private function renderHeaderMessage(): string
    {
        $result = $this->headerMessage;

        if ($this->renderCloseButton() !== null) {
            $result = '<p>' . $this->headerMessage . '</p>' . "\n" . $this->renderCloseButton();
        }

        return $result;
    }

    private function renderBodyEnd(): string
    {
        return $this->body;
    }

    private function renderCloseButton(): ?string
    {
        if ($this->withoutCloseButton === true) {
            return null;
        }

        $spanOptions = ['aria-hidden' => 'true', 'encode' => false];
        $tag = ArrayHelper::remove($this->closeButtonOptions, 'tag', 'button');
        $label = ArrayHelper::remove(
            $this->closeButtonOptions,
            'label',
            Html::tag('span', '&times;', $spanOptions)
        );

        if ($tag === 'button') {
            $this->closeButtonOptions['type'] = 'button';
        }

        if ($this->size !== '') {
            Html::addCssClass($this->closeButtonOptions, [$this->size]);
        }

        return Html::tag($tag, $label, $this->closeButtonOptions);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Bulma;
6
7		use Yiisoft\Arrays\ArrayHelper;
8		use Yiisoft\Html\Html;
9
10		/**
11		* Message renders Bulma message component.
12		*
13		* For example,
14		*
15		* ```php
16		* <?= Message::widget()->withHeaderColor('success')->withHeader('System info')->withBody('Say hello...') ?>
17		* ```
18		*
19		* @link https://bulma.io/documentation/components/message/
20		*/
21		final class Message extends Widget
22		{
23		private string $body = '';
24		private string $headerColor = 'is-dark';
25		private string $headerMessage = '';
26		private array $options = [];
27		private array $bodyOptions = [];
28		private array $closeButtonOptions = [];
29		private array $headerOptions = [];
30		private string $size = '';
31		private bool $withoutCloseButton = false;
32		private bool $withoutHeader = true;
33		private bool $encodeTags = false;
34
35	12	protected function run(): string
36		{
37	12	$this->buildOptions();
38
39		return
40	12	Html::beginTag('div', $this->options) . "\n" .
41	12	$this->renderHeader() .
42	12	Html::beginTag('div', $this->bodyOptions) . "\n" .
43	12	$this->renderBodyEnd() . "\n" .
44	12	Html::endTag('div') . "\n" .
45	12	Html::endTag('div');
46		}
47
48		/**
49		* The body content in the message component. Message widget will also be treated as the body content, and will be
50		* rendered before this.
51		*
52		* @param string $value
53		*
54		* @return self
55		*/
56	12	public function withBody(string $value): self
57		{
58	12	$new = clone $this;
59	12	$new->body = $value;
60	12	return $new;
61		}
62
63		/**
64		* Set color header message.
65		*
66		* @param string $value setting default 'is-dark', 'is-primary', 'is-link', 'is-info', 'is-success', 'is-warning',
67		* 'is-danger'.
68		*
69		* @return self
70		*/
71	1	public function withHeaderColor(string $value): self
72		{
73	1	$new = clone $this;
74	1	$new->headerColor = $value;
75	1	return $new;
76		}
77
78		/**
79		* The header message in the message component. Message widget will also be treated as the header content, and will
80		* be rendered before body.
81		*
82		* @param string $value
83		*
84		* @return self
85		*/
86	12	public function withHeaderMessage(string $value): self
87		{
88	12	$new = clone $this;
89	12	$new->headerMessage = $value;
90	12	return $new;
91		}
92
93		/**
94		* The HTML attributes for the widget container tag.
95		*
96		* {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
97		*
98		* @param array $value
99		*
100		* @return self
101		*/
102	1	public function withOptions(array $value): self
103		{
104	1	$new = clone $this;
105	1	$new->options = $value;
106	1	return $new;
107		}
108
109		/**
110		* The HTML attributes for the widget body tag.
111		*
112		* {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
113		*
114		* @param array $value
115		*
116		* @return self
117		*/
118	1	public function withBodyOptions(array $value): self
119		{
120	1	$new = clone $this;
121	1	$new->bodyOptions = $value;
122	1	return $new;
123		}
124
125		/**
126		* The options for rendering the close button tag.
127		*
128		* The close button is displayed in the header of the modal window. Clicking on the button will hide the modal
129		* window. If {@see withoutCloseButton} is false, no close button will be rendered.
130		*
131		* @param array $value
132		*
133		* @return self
134		*/
135	1	public function withCloseButtonOptions(array $value): self
136		{
137	1	$new = clone $this;
138	1	$new->closeButtonOptions = $value;
139	1	return $new;
140		}
141
142		/**
143		* The HTML attributes for the widget header tag.
144		*
145		* {@see Html::renderTagAttributes()} for details on how attributes are being rendered.
146		*
147		* @param array $value
148		*
149		* @return self
150		*/
151	1	public function withHeaderOptions(array $value): self
152		{
153	1	$new = clone $this;
154	1	$new->headerOptions = $value;
155	1	return $new;
156		}
157
158		/**
159		* Set size message widget.
160		*
161		* @param string $value default setting empty normal, 'is-small', 'is-medium', 'is-large'.
162		*
163		* @return self
164		*/
165	1	public function withSize(string $value): self
166		{
167	1	$new = clone $this;
168	1	$new->size = $value;
169	1	return $new;
170		}
171
172		/**
173		* Allows you to enable close button message widget.
174		*
175		* @return self
176		*/
177	1	public function withCloseButton(): self
178		{
179	1	$new = clone $this;
180	1	$new->withoutCloseButton = true;
181	1	return $new;
182		}
183
184		/**
185		* Allows you to disable header widget.
186		*
187		* @return self
188		*/
189	1	public function withoutHeader(): self
190		{
191	1	$new = clone $this;
192	1	$new->withoutHeader = false;
193	1	return $new;
194		}
195
196		/**
197		* Allows you to enable the encoding tags html.
198		*
199		* @return self
200		*/
201	1	public function withEncodeTags(): self
202		{
203	1	$new = clone $this;
204	1	$new->encodeTags = true;
205
206	1	return $new;
207		}
208
209	12	private function buildOptions(): void
210		{
211	12	if (!isset($this->options['id'])) {
212	12	$this->options['id'] = "{$this->getId()}-message";
213		}
214
215	12	$this->options = $this->addOptions($this->options, 'message');
216
217	12	Html::addCssClass($this->options, $this->headerColor);
218
219	12	if ($this->size !== '') {
220	1	Html::addCssClass($this->options, $this->size);
221		}
222
223	12	$this->bodyOptions = $this->addOptions($this->bodyOptions, 'message-body');
224	12	$this->closeButtonOptions = $this->addOptions($this->closeButtonOptions, 'delete');
225	12	$this->headerOptions = $this->addOptions($this->headerOptions, 'message-header');
226
227	12	if ($this->encodeTags === false) {
228	11	$this->closeButtonOptions['encode'] = false;
229	11	$this->options['encode'] = false;
230		}
231	12	}
232
233	12	private function renderHeader(): string
234		{
235	12	$html = '';
236
237	12	if ($this->withoutHeader) {
238	11	$html = Html::beginTag('div', $this->headerOptions) . "\n" . $this->renderHeaderMessage() . "\n" .
239	11	Html::endTag('div') . "\n";
240		}
241
242	12	return $html;
243		}
244
245	11	private function renderHeaderMessage(): string
246		{
247	11	$result = $this->headerMessage;
248
249	11	if ($this->renderCloseButton() !== null) {
250	10	$result = '<p>' . $this->headerMessage . '</p>' . "\n" . $this->renderCloseButton();
251		}
252
253	11	return $result;
254		}
255
256	12	private function renderBodyEnd(): string
257		{
258	12	return $this->body;
259		}
260
261	11	private function renderCloseButton(): ?string
262		{
263	11	if ($this->withoutCloseButton === true) {
264	1	return null;
265		}
266
267	10	$spanOptions = ['aria-hidden' => 'true', 'encode' => false];
268	10	$tag = ArrayHelper::remove($this->closeButtonOptions, 'tag', 'button');
269	10	$label = ArrayHelper::remove(
270	10	$this->closeButtonOptions,
271	10	'label',
272	10	Html::tag('span', '×', $spanOptions)
273		);
274
275	10	if ($tag === 'button') {
276	10	$this->closeButtonOptions['type'] = 'button';
277		}
278
279	10	if ($this->size !== '') {
280	1	Html::addCssClass($this->closeButtonOptions, [$this->size]);
281		}
282
283	10	return Html::tag($tag, $label, $this->closeButtonOptions);
284		}
285		}
286

yiisoft / yii-bulma

Pull Request — master (#31)

Message::withBodyOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like