Completed
Pull Request — master (#1993)
by Basil
02:35 queued 11s
created

TextToSpeechWidget::createButton()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 8
c 0
b 0
f 0
rs 10
cc 1
nc 1
nop 3
1
<?php
2
3
namespace luya\texttospeech;
4
5
use luya\base\Widget;
6
use luya\helpers\Json;
7
use Yii;
8
use yii\base\InvalidConfigException;
9
10
/**
11
 * Text to Speech
12
 * 
13
 * @author Martin Petrasch <[email protected]>
14
 * @author Basil Suter <[email protected]>
15
 * @since 1.1.0
16
 */
17
class TextToSpeechWidget extends Widget
18
{
19
    /**
20
     * @var string The jQuery selector which should be used to read the content from, examples:
21
     * - `.container`: All elements which class `.container` will be spoken.
22
     * - `#content`: The element with id `id="content"` only will be spoken.
23
     * 
24
     * The input data will be wrapped with `$()`.
25
     */
26
    public $targetSelector;
27
28
    /**
29
     * @var string If enabled, the {{$targetSelector}} attribute has no effect and only the text from the property will be read - on start.
30
     */
31
    public $text;
32
33
    public $playButtonSelector = '#play-button';
34
35
    public $pauseButtonSelector = '#pause-button';
36
37
    public $stopButtonSelector = '#stop-button';
38
39
    public $playButtonActiveClass = 'playing';
40
41
    public $pauseButtonActiveClass = 'paused';
42
43
    public $containerClass = 'text-to-speech-container';
44
45
    public $buttonClass = 'text-to-speech-button';
46
47
    /**
48
     * @var array|boolean You can either disable the default buttons by setting buttons to false, or you can provide an array with button configurations, each element requires the following keys:
49
     * - label:
50
     * - id:
51
     * - content:
52
     */
53
    public $buttons;
54
55
    public $playSVG = '<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 60 60" style="enable-background:new 0 0 60 60;" xml:space="preserve"><g><path d="M45.563,29.174l-22-15c-0.307-0.208-0.703-0.231-1.031-0.058C22.205,14.289,22,14.629,22,15v30c0,0.371,0.205,0.711,0.533,0.884C22.679,45.962,22.84,46,23,46c0.197,0,0.394-0.059,0.563-0.174l22-15C45.836,30.64,46,30.331,46,30S45.836,29.36,45.563,29.174z M24,43.107V16.893L43.225,30L24,43.107z"/><path d="M30,0C13.458,0,0,13.458,0,30s13.458,30,30,30s30-13.458,30-30S46.542,0,30,0z M30,58C14.561,58,2,45.439,2,30S14.561,2,30,2s28,12.561,28,28S45.439,58,30,58z"/></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g></svg>';
56
57
    public $stopSVG = '<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 60 60" style="enable-background:new 0 0 60 60;" xml:space="preserve"><path d="M30,0C13.458,0,0,13.458,0,30s13.458,30,30,30s30-13.458,30-30S46.542,0,30,0z M44,44H16V16h28V44z"/><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g></svg>';
58
59
    public $pauseSVG = '<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 202.205 202.205" style="enable-background:new 0 0 202.205 202.205;" xml:space="preserve"><g> <g> <path style="fill:#010002;" d="M23.483,202.205H85.83V0H23.483V202.205z M31.417,7.934h46.479v186.336H31.417V7.934z"/> <path style="fill:#010002;" d="M116.372,0v202.205h62.351V0H116.372z M170.788,194.271h-46.486V7.934h46.482v186.336H170.788z"/> </g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g><g></g></svg>';
60
    
61
    public function init()
62
    {
63
        if (!$this->text && !$this->targetSelector) {
64
            throw new InvalidConfigException("Either text or targetSelector property must be configured.");
65
        }
66
        if ($this->buttons === null || $this->buttons === true) {
67
            $this->buttons[] = $this->createButton('Play', 'play-button', $this->playSVG);
68
            $this->buttons[] = $this->createButton('Pause', 'pause-button', $this->pauseSVG);
69
            $this->buttons[] = $this->createButton('Stop', 'stop-button', $this->stopSVG);
70
        }
71
    }
72
73
    public function run()
74
    {
75
        TextToSpeechAsset::register($this->view);
76
77
        $config = Json::htmlEncode([
78
            'playButtonSelector' => $this->playButtonSelector,
79
            'pauseButtonSelector' => $this->pauseButtonSelector,
80
            'stopButtonSelector' => $this->stopButtonSelector,
81
            'targetSelector' => $this->targetSelector,
82
            'playClass' => $this->playButtonActiveClass,
83
            'pauseClass' => $this->pauseButtonActiveClass,
84
            'text' => $this->text ? $this->text : '', // must be an empty string as it will checked with .length
85
            'language' => Yii::$app->composition->langShortCode,
86
        ]);
87
88
        $this->view->registerJs("$.textToSpeech({$config});");
89
90
        return $this->render('texttospeech', [
91
            'buttons' => $this->buttons,
92
            'id' => $this->getId(),
93
            'containerClass' => $this->containerClass,
94
            'buttonClass' => $this->buttonClass,
95
        ]);
96
    }
97
98
    public function createButton($label, $id, $svg)
99
    {
100
        return [
101
            'label' => $label,
102
            'id' => $id,
103
            'content' => $svg,
104
        ];
105
    }
106
}