Completed
Push — master ( 8829e7...b443e3 )
by Petro
02:58
created

Content::slider()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 11

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 11
ccs 5
cts 5
cp 1
rs 9.9
c 0
b 0
f 0
cc 2
nc 2
nop 4
crap 2
1
<?php
2
3
namespace sokolnikov911\YandexTurboPages\helpers;
4
5
use sokolnikov911\YandexTurboPages\Channel;
6
7
class Content
8
{
9
    const SHARE_TYPE_FACEBOOK = 'facebook';
10
    const SHARE_TYPE_GOOGLE = 'google';
11
    const SHARE_TYPE_ODNOKLASSNIKI = 'odnoklassniki';
12
    const SHARE_TYPE_TELEGRAM = 'telegram';
13
    const SHARE_TYPE_TWITTER = 'twitter';
14
    const SHARE_TYPE_VKONTAKTE = 'vkontakte';
15
16
    const SLIDER_DATA_VIEW_SQUARE = 'square';
17
    const SLIDER_DATA_VIEW_PORTRAIT = 'portrait';
18
    const SLIDER_DATA_VIEW_LANDSCAPE = 'landscape';
19
20
    const SLIDER_DATA_ITEM_VIEW_COVER = 'cover';
21
    const SLIDER_DATA_ITEM_VIEW_CONTAIN = 'contain';
22
23
    const OWN_VIDEO_TYPE_MP4 = 'video/mp4';
24
25
    /**
26
     * Generate header element
27
     * @param string $h1
28
     * @param string|null $h2
29
     * @param string|null $imgUrl
30
     * @param string|null $imgCaption
31
     * @param array|null $menuArray array of arrays with pairs of url and content
32
     * [
33
     *     ['url' => 'http://example/page1.html', 'title' => 'Page title 1'],
34
     *     ['url' => 'http://example/page2.html', 'title' => 'Page title 2'],
35
     * ]
36
     * @return string
37
     */
38 9
    public static function header(string $h1, string $h2 = null, string $imgUrl = null,
39
                                  string $imgCaption = null, array $menuArray = null): string
40
    {
41 9
        $header = '<h1>' . $h1 . '</h1>';
42 9
        $header .= $h2 ? '<h2>' . $h2 . '</h2>' : '';
43 9
        $header .= $menuArray ? self::generateMenu($menuArray) : '';
44 9
        $header .= $imgUrl ? self::img($imgUrl, $imgCaption) : '';
45
46 9
        return '<header>' . $header . '</header>';
47
    }
48
49
    /**
50
     * Generate image element
51
     * @param string $imgUrl
52
     * @param string|null $imgCaption
53
     * @return string
54
     */
55 9
    public static function img(string $imgUrl, string $imgCaption = null): string
56
    {
57 9
        $imageString = '<img src="' . $imgUrl . '" />';
58
59 9
        $imageString .= $imgCaption ? '<figcaption>' . $imgCaption . '</figcaption>' : '';
60
61 9
        return '<figure>' . $imageString . '</figure>';
62
    }
63
64
    /**
65
     * Generate video element
66
     * @param string $videoUrl
67
     * @param string|null $videoCaption
68
     * @param string $imgUrl
69
     * @param string $type
70
     * @return string
71
     */
72 6
    public static function ownVideo(string $videoUrl, string $videoCaption = null, string $type = self::OWN_VIDEO_TYPE_MP4, string $imgUrl = null): string
73
    {
74 6
        $videoString = '<video><source src="' . $videoUrl . '" type="' . $type . '" /></video>';
75 6
        $videoString .= $imgUrl ? '<img src="' . $imgUrl . '" />' : '';
76 6
        $videoString .= $videoCaption ? '<figcaption>' . $videoCaption . '</figcaption>' : '';
77
78 6
        return '<figure>' . $videoString . '</figure>';
79
    }
80
81
    /**
82
     * Generate images gallery
83
     * @param array $imagesArray Array of images urls
84
     * ['http://example.com/image1.jpg', 'http://example.com/image2.jpg']
85
     * @param string|null $header
86
     * @return string
87
     */
88 6
    public static function gallery(array $imagesArray, string $header = null): string
89
    {
90 6
        $galleryString = $header ? '<header>' . $header . '</header>' : '';
91
92 6
        foreach ($imagesArray as $image) {
93 6
            $galleryString .= '<img src="' . $image . '" />';
94
        }
95
96 6
        return '<div data-block="gallery">' . $galleryString . '</div>';
97
    }
98
99
    /**
100
     * Generate media slider
101
     * @param array $itemsArray Array of items with data
102
     * [
103
     *     ['url' => 'http://example.com/image1.jpg', 'title' => 'Image title 1', 'link' => ''],
104
     *     ['url' => 'http://example.com/image2.jpg', 'title' => 'Image title 2', 'link' => ''],
105
     *     ['url' => 'http://example.com/image3.jpg'],
106
     *     ['href' => 'http://example.com/page1.html', 'title' => 'Link title 1', 'text' => 'Link text 1']
107
     * ]
108
     * @param string|null $header
109
     * @param string $dataView
110
     * @param string $dataItemView
111
     * @return string
112
     */
113 6
    public static function slider(array $itemsArray, string $header = null,
114
                                  string $dataView = self::SLIDER_DATA_VIEW_SQUARE,
115
                                  string $dataItemView = self::SLIDER_DATA_ITEM_VIEW_COVER): string
116
    {
117 6
        $sliderString = $header ? '<header>' . $header . '</header>' : '';
118
119 6
        $sliderString .= self::generateSliderItemsBlock($itemsArray);
120
121 6
        return '<div data-block="slider" data-view="' . $dataView . '" data-item-view="'
122 6
            . $dataItemView . '">' . $sliderString . '</div>';
123
    }
124
125
    /**
126
     * Generate share block
127
     * @param array|null $networks Array of network names
128
     * [Content::SHARE_TYPE_GOOGLE, Content::SHARE_TYPE_TWITTER]
129
     * Can be empty, in this way all possible network types will be showed.
130
     * @return string
131
     */
132 6
    public static function share(array $networks = null): string
133
    {
134 6
        $networksString = $networks
135 3
            ? 'data-network="' . implode(',', $networks) . '"'
136 6
            : '';
137
138 6
        return '<div data-block="share" ' . $networksString . '></div>';
139
    }
140
141
    /**
142
     * Generate rating block
143
     * @param float $currentRating
144
     * @param float $maxRating
145
     * @return string
146
     */
147 12
    public static function rating(float $currentRating, float $maxRating): string
148
    {
149 12
        if (($currentRating > $maxRating) || ($maxRating <= 0) || ($currentRating < 0)) {
150 9
            throw new \UnexpectedValueException("Current rating can't be bigger than max value. And max value must be bigger than 0.");
151
        }
152
153
        return '<div itemscope="" itemtype="http://schema.org/Rating">
154 3
                       <meta itemprop="ratingValue" content="' . $currentRating . '" />
155 3
                       <meta itemprop="bestRating" content="' . $maxRating . '" />
156
                </div>';
157
    }
158
159
    /**
160
     * Generate button
161
     * @param string $text
162
     * @param string $url
163
     * @param string $phone Phone number in RFC-3966 format
164
     * @param string|null $buttonColor Can be Text or HEX
165
     * @param string|null $textColor Can be Text or HEX
166
     * @param bool $isBoldText
167
     * @param bool $isDisabled
168
     * @return string
169
     */
170 12
    public static function button(string $text, string $url = '', string $phone = '',
171
                                  string $buttonColor = null, string $textColor = null,
172
                                  bool $isBoldText = false, bool $isDisabled = false): string
173
    {
174 12
        if (!$url && !$phone) {
175 3
            throw new \UnexpectedValueException('Please set url or phone number for button');
176
        }
177
178 9
        $formAction = $url ? $url : 'tel:' . $phone;
179 9
        $buttonColorString = $buttonColor ? 'data-background-color="' . $buttonColor . '"' : '';
180 9
        $textColorString = $textColor ? 'data-color="' . $textColor . '"' : '';
181 9
        $isBoldTextString = $isBoldText ? 'data-primary="true"' : '';
182 9
        $isDisabledString = $isDisabled ? 'disabled="true"' : '';
183
184
        return "<button
185 9
                    formaction=\"" . $formAction . "\"
186 9
                    " . $buttonColorString . "
187 9
                    " . $textColorString . "
188 9
                    " . $isBoldTextString . "
189 9
                    " . $isDisabledString . ">" . $text . "</button>";
190
    }
191
192
    /**
193
     * Generate comment block
194
     * @param string $url URL to comments page
195
     * @param array $commentsArray multidimensional or one-dimensional array of comments,
196
     * can has unlimited includes, example:
197
     * [
198
     *  [
199
     *      'author' => 'First Author Name',
200
     *      'avatar' => 'http://example.com/user1.jpg',
201
     *      'title' => 'Comment Title',
202
     *      'subtitle' => '2017-12-10',
203
     *      'content' => 'Somme comment text',
204
     *      'comments' => [
205
     *          [
206
     *              'author' => 'Third Author Name',
207
     *              'avatar' => 'http://example.com/user3.jpg',
208
     *              'title' => 'Comment Title',
209
     *              'subtitle' => '2017-12-12',
210
     *              'content' => 'Some answer text'
211
     *          ],
212
     *          [
213
     *              'author' => 'Another Author Name',
214
     *              'avatar' => 'http://example.com/user4.jpg',
215
     *              'title' => 'Comment Title',
216
     *              'subtitle' => '2017-12-13',
217
     *              'content' => 'Another answer text'
218
     *          ],
219
     *      ]
220
     *  ],
221
     *  [
222
     *      'author' => 'Second Author Name',
223
     *      'avatar' => 'http://example.com/user2.jpg',
224
     *      'title' => 'Comment Title',
225
     *      'subtitle' => '2017-12-11',
226
     *      'content' => 'Some comment text'
227
     *  ],
228
     * ]
229
     * @return string
230
     */
231 3
    public static function comment(string $url, array $commentsArray): string
232
    {
233 3
        $commentBlock = self::generateCommentBlock($commentsArray);
234
235 3
        return '<div data-block="comments" data-url="' . $url . '">' . $commentBlock . '</div>';
236
    }
237
238
    /**
239
     * Generate accordion
240
     * @param array $accordionArray array accordion elements
241
     * [
242
     *     ['title' => 'Page title 1', 'text' => 'Text 1'],
243
     *     ['title' => 'Page title 2', 'text' => 'Text 2', 'expanded' => true],
244
     * ]
245
     * @return string
246
     */
247 3
    public static function accordion(array $accordionArray): string
248
    {
249 3
        $accordionString = '<div data-block="accordion">';
250
251 3
        foreach ($accordionArray as $item) {
252 3
            $expanded = isset($item['expanded']) && $item['expanded'] ? ' data-expanded="true"' : '';
253 3
            $accordionString .= '<div data-block="item" data-title="' . $item['title'] . '"' . $expanded . '>' . $item['text'] . '</div>';
254
        }
255
256 3
        $accordionString .= '</div>';
257
258 3
        return $accordionString;
259
    }
260
261
    /**
262
     * Generate Ad block position element
263
     * @param string $turboAdId value of $turboAdId used in Channel() class
264
     * @return string
265
     *
266
     * @see Channel::$adTurboAdId
267
     */
268 3
    public static function adBlockPosition(string $turboAdId): string
269
    {
270 3
        return '<figure data-turbo-ad-id="' . $turboAdId . '"></figure>';
271
    }
272
273 6
    private static function generateSliderItemsBlock(array $itemsArray)
274
    {
275 6
        $sliderString = '';
276
277 6
        foreach ($itemsArray as $item) {
278 6
            $sliderString .= '<figure>';
279
280 6
            if (isset($item['title'])) {
281 6
                $sliderString .= '<figcaption>' . $item['title'] . '</figcaption>';
282
            }
283
284 6
            if (isset($item['url'])) {
285 6
                $sliderString .= '<img src="' . $item['url'] . '" />';
286 6
            } elseif (isset($item['href']) && isset($item['text'])) {
287 6
                $sliderString .= '<a href="' . $item['href'] . '">' . $item['text'] . '</a>';
288
            }
289
290 6
            $sliderString .= '</figure>';
291
        }
292
293 6
        return $sliderString;
294
    }
295
296 3
    private static function generateCommentBlock(array $commentsArray)
297
    {
298 3
        $commentBlock = '';
299
300 3
        foreach ($commentsArray as $commentArray) {
301 3
            $author = isset($commentArray['author']) ? 'data-author="' . $commentArray['author'] . '"' : '';
302 3
            $avatar = isset($commentArray['avatar']) ? 'data-avatar-url="' . $commentArray['avatar'] . '"' : '';
303 3
            $subtitle = isset($commentArray['subtitle']) ? 'data-subtitle="' . $commentArray['subtitle'] . '"' : '';
304
305
            $commentBlock .= '<div
306
                        data-block="comment"
307 3
                        ' . $author . ' 
308 3
                        ' . $avatar . '
309 3
                        ' . $subtitle . '                         
310
                        ><div data-block="content">';
311
312 3
            $commentBlock .= isset($commentArray['title']) ? '<header>' . $commentArray['title'] . '</header>' : '';
313 3
            $commentBlock .= isset($commentArray['content']) ? '<p>' . $commentArray['content'] . '</p></div>' : '';
314
315 3
            if (isset($commentArray['comments'])) {
316 3
                $commentBlock .= '<div data-block="comments">';
317 3
                $commentBlock .= self::generateCommentBlock($commentArray['comments']);
318 3
                $commentBlock .= '</div>';
319
            }
320
321 3
            $commentBlock .= '</div>';
322
        }
323
324 3
        return $commentBlock;
325
    }
326
327
    /**
328
     * Generate header menu
329
     * @param array $menuArray array of arrays with pairs of url and title
330
     * [
331
     *     ['url' => 'http://example/page1.html', 'title' => 'Page title 1'],
332
     *     ['url' => 'http://example/page2.html', 'title' => 'Page title 2'],
333
     * ]
334
     * @return string
335
     */
336 3
    private static function generateMenu(array $menuArray)
337
    {
338 3
        $menuString = '';
339
340 3
        foreach ($menuArray as $menuItem) {
341 3
            $menuString .= '<a href="' . $menuItem['url'] . '">' . $menuItem['title'] . '</a>';
342
        }
343
344 3
        return '<menu>' . $menuString . '</menu>';
345
    }
346
}