summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/web/src/Widget/Icon.php
blob: 5c2617f03f66bd2c477f5233d6dc83ae894f8668 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?php

namespace ipl\Web\Widget;

use ipl\Html\Attributes;
use ipl\Html\BaseHtmlElement;

/**
 * Icon element
 */
class Icon extends BaseHtmlElement
{
    protected $tag = 'i';

    /** @var string Icon style */
    protected $style;

    /** @var string Icon default style */
    protected $defaultStyle = 'fa';

    /**
     * Create an icon element
     *
     * Creates an icon element from the given name and HTML attributes. The icon element's tag will be <i>. The given
     * name will be used as automatically added CSS class for the icon element in the format 'icon-$name'. In addition,
     * the CSS class 'icon' will be automatically added too.
     *
     * @param string           $name       The name of the icon
     * @param Attributes|array $attributes The HTML attributes for the element
     */
    public function __construct(string $name, $attributes = null)
    {
        $this
            ->getAttributes()
                ->add('class', ['icon', "fa-$name"])
                ->add($attributes);
    }

    /**
     * Get the icon style
     *
     * @return string
     */
    public function getStyle(): string
    {
        return $this->style ?? $this->defaultStyle;
    }

    /**
     * Set the icon style
     *
     * @param string $style Style class with prefix
     *
     * @return $this
     */
    public function setStyle(string $style): self
    {
        $this->style = $style;

        return $this;
    }

    protected function assemble()
    {
        $this->addAttributes(['class' => $this->getStyle()]);
    }
}