Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 2
 CRAP
0.00% covered (danger)
0.00%
0 / 1
ThumbnailRenderer
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 2
 20
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
 2
 render
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
 12
1<?php
2declare( strict_types = 1 );
3
4/**
5 * ThumbnailRenderer.php
6 *
7 * This file is part of the Codex PHP library, which provides a PHP-based interface for creating
8 * UI components consistent with the Codex design system.
9 *
10 * The `ThumbnailRenderer` class leverages the `TemplateParser` and `Sanitizer` utilities to ensure the
11 * component object is rendered according to Codex design system standards.
12 *
13 * @category Renderer
14 * @package  Codex\Renderer
15 * @since    0.1.0
16 * @author   Doğu Abaris <abaris@null.net>
17 * @license  https://www.gnu.org/copyleft/gpl.html GPL-2.0-or-later
18 * @link     https://doc.wikimedia.org/codex/main/ Codex Documentation
19 */
20
21namespace Wikimedia\Codex\Renderer;
22
23use InvalidArgumentException;
24use Wikimedia\Codex\Component\Thumbnail;
25use Wikimedia\Codex\Contract\Component;
26use Wikimedia\Codex\Contract\Renderer;
27use Wikimedia\Codex\Parser\TemplateParser;
28use Wikimedia\Codex\Utility\Sanitizer;
29
30/**
31 * ThumbnailRenderer is responsible for rendering the HTML markup
32 * for a Thumbnail component using a Mustache template.
33 *
34 * This class uses the `TemplateParser` and `Sanitizer` utilities to manage
35 * the template rendering process, ensuring that the component object's HTML
36 * output adheres to the Codex design system's standards.
37 *
38 * @category Renderer
39 * @package  Codex\Renderer
40 * @since    0.1.0
41 * @author   Doğu Abaris <abaris@null.net>
42 * @license  https://www.gnu.org/copyleft/gpl.html GPL-2.0-or-later
43 * @link     https://doc.wikimedia.org/codex/main/ Codex Documentation
44 */
45class ThumbnailRenderer extends Renderer {
46
47    /**
48     * The template parser instance.
49     */
50    private TemplateParser $templateParser;
51
52    /**
53     * Constructor to initialize the ThumbnailRenderer with a sanitizer and a template parser.
54     *
55     * @since 0.1.0
56     * @param Sanitizer $sanitizer The sanitizer instance used for content sanitization.
57     * @param TemplateParser $templateParser The template parser instance.
58     */
59    public function __construct( Sanitizer $sanitizer, TemplateParser $templateParser ) {
60        parent::__construct( $sanitizer );
61        $this->templateParser = $templateParser;
62    }
63
64    /**
65     * Renders the HTML for a thumbnail component.
66     *
67     * Uses the provided Thumbnail component to generate HTML markup adhering to the Codex design system.
68     *
69     * @since 0.1.0
70     * @param Component $component The Thumbnail object to render.
71     * @return string The rendered HTML string for the component.
72     */
73    public function render( Component $component ): string {
74        if ( !$component instanceof Thumbnail ) {
75            throw new InvalidArgumentException( "Expected instance of Thumbnail, got " . get_class( $component ) );
76        }
77
78        $thumbnailData = [
79            'id' => $component->getId(),
80            'backgroundImage' => $component->getBackgroundImage() ?
81                $this->sanitizer->sanitizeUrl( $component->getBackgroundImage() ) : null,
82            'placeholderClass' => $component->getPlaceholderClass(),
83            'extraClasses' => $this->getExtraClasses( $component->getAttributes() ),
84            'attributes' => $this->getOtherAttributes( $component->getAttributes() ),
85        ];
86
87        return $this->templateParser->processTemplate( 'thumbnail', $thumbnailData );
88    }
89}