Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 24 |
|
0.00% |
0 / 5 |
CRAP | |
0.00% |
0 / 1 |
| TabsBuilder | |
0.00% |
0 / 24 |
|
0.00% |
0 / 5 |
132 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| setId | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| setTab | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
12 | |||
| setAttributes | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| build | |
0.00% |
0 / 13 |
|
0.00% |
0 / 1 |
20 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * TabsBuilder.php |
| 4 | * |
| 5 | * This file is part of the Codex design system, the official design system |
| 6 | * for Wikimedia projects. It provides the `Tabs` class, a builder for constructing |
| 7 | * tabs components using the Codex design system. |
| 8 | * |
| 9 | * Tabs consist of two or more tab items created for navigating between different sections of content. |
| 10 | * |
| 11 | * @category Builder |
| 12 | * @package Codex\Builder |
| 13 | * @since 0.1.0 |
| 14 | * @author Doğu Abaris <abaris@null.net> |
| 15 | * @license https://www.gnu.org/copyleft/gpl.html GPL-2.0-or-later |
| 16 | * @link https://doc.wikimedia.org/codex/main/ Codex Documentation |
| 17 | */ |
| 18 | |
| 19 | namespace Wikimedia\Codex\Builder; |
| 20 | |
| 21 | use InvalidArgumentException; |
| 22 | use Wikimedia\Codex\Component\Tab; |
| 23 | use Wikimedia\Codex\Component\Tabs; |
| 24 | use Wikimedia\Codex\Renderer\TabsRenderer; |
| 25 | |
| 26 | /** |
| 27 | * TabsBuilder |
| 28 | * |
| 29 | * This class implements the builder pattern to construct instances of Tabs. |
| 30 | * It provides a fluent interface for setting various properties and building the |
| 31 | * final immutable object with predefined configurations and immutability. |
| 32 | * |
| 33 | * @category Builder |
| 34 | * @package Codex\Builder |
| 35 | * @since 0.1.0 |
| 36 | * @author Doğu Abaris <abaris@null.net> |
| 37 | * @license https://www.gnu.org/copyleft/gpl.html GPL-2.0-or-later |
| 38 | * @link https://doc.wikimedia.org/codex/main/ Codex Documentation |
| 39 | */ |
| 40 | class TabsBuilder { |
| 41 | |
| 42 | /** |
| 43 | * The ID for the tabs. |
| 44 | */ |
| 45 | protected string $id = ''; |
| 46 | |
| 47 | /** |
| 48 | * An array of Tab objects representing each tab in the component. |
| 49 | */ |
| 50 | private array $tabs = []; |
| 51 | |
| 52 | /** |
| 53 | * Additional MarkupHandler attributes for the `<form>` element. |
| 54 | */ |
| 55 | protected array $attributes = []; |
| 56 | |
| 57 | /** |
| 58 | * The renderer instance used to render the tabs. |
| 59 | */ |
| 60 | protected TabsRenderer $renderer; |
| 61 | |
| 62 | /** |
| 63 | * Constructor for the TabsBuilder class. |
| 64 | * |
| 65 | * @param TabsRenderer $renderer The renderer to use for rendering the tabs. |
| 66 | */ |
| 67 | public function __construct( TabsRenderer $renderer ) { |
| 68 | $this->renderer = $renderer; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Set the Tabs HTML ID attribute. |
| 73 | * |
| 74 | * @since 0.1.0 |
| 75 | * @param string $id The ID for the Tabs element. |
| 76 | * @return $this |
| 77 | */ |
| 78 | public function setId( string $id ): self { |
| 79 | $this->id = $id; |
| 80 | |
| 81 | return $this; |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Add one or more tabs to the tabs component. |
| 86 | * |
| 87 | * This method allows the addition of one or more `Tab` objects to the tabs component. |
| 88 | * Each tab's properties, such as label, content, selected state, and disabled state, |
| 89 | * are used to construct and configure the tabs. |
| 90 | * |
| 91 | * Example usage: |
| 92 | * |
| 93 | * $tabs->setTab($tab1) |
| 94 | * ->setTab([$tab2, $tab3]); |
| 95 | * |
| 96 | * @since 0.1.0 |
| 97 | * @param TabBuilder|array $tab A `Tab` object or an array of `Tab` objects to add. |
| 98 | * @return $this Returns the Tabs instance for method chaining. |
| 99 | */ |
| 100 | public function setTab( $tab ): self { |
| 101 | if ( is_array( $tab ) ) { |
| 102 | foreach ( $tab as $t ) { |
| 103 | $this->tabs[] = $t; |
| 104 | } |
| 105 | } else { |
| 106 | $this->tabs[] = $tab; |
| 107 | } |
| 108 | |
| 109 | return $this; |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Set additional HTML attributes for the `<form>` element. |
| 114 | * |
| 115 | * This method allows custom HTML attributes to be added to the `<form>` element that wraps the tabs, |
| 116 | * such as `id`, `data-*`, `aria-*`, or any other valid attributes. These attributes can be used |
| 117 | * to enhance accessibility or integrate with JavaScript. |
| 118 | * |
| 119 | * Example usage: |
| 120 | * |
| 121 | * $tabs->setAttributes([ |
| 122 | * 'id' => 'tabs-form', |
| 123 | * 'data-category' => 'navigation', |
| 124 | * ]); |
| 125 | * |
| 126 | * @since 0.1.0 |
| 127 | * @param array $attributes An associative array of HTML attributes. |
| 128 | * @return $this Returns the Tabs instance for method chaining. |
| 129 | */ |
| 130 | public function setAttributes( array $attributes ): self { |
| 131 | foreach ( $attributes as $key => $value ) { |
| 132 | $this->attributes[$key] = $value; |
| 133 | } |
| 134 | return $this; |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Build and return the Tabs component object. |
| 139 | * This method constructs the immutable Tabs object with all the properties set via the builder. |
| 140 | * |
| 141 | * @since 0.1.0 |
| 142 | * @return Tabs The constructed Tabs. |
| 143 | */ |
| 144 | public function build(): Tabs { |
| 145 | $tabComponents = []; |
| 146 | foreach ( $this->tabs as $tab ) { |
| 147 | if ( $tab instanceof TabBuilder ) { |
| 148 | $tabComponents[] = $tab->build(); |
| 149 | } elseif ( $tab instanceof Tab ) { |
| 150 | $tabComponents[] = $tab; |
| 151 | } else { |
| 152 | throw new InvalidArgumentException( 'All tabs must be instances of TabBuilder or Tab' ); |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | return new Tabs( |
| 157 | $this->id, |
| 158 | $tabComponents, |
| 159 | $this->attributes, |
| 160 | $this->renderer |
| 161 | ); |
| 162 | } |
| 163 | } |