Contracts
5 years ago
DonationHistoryTab
5 years ago
EditProfileTab
5 years ago
TabsRegister.php
5 years ago
TabsRegister.php
123 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonorDashboards\Tabs; |
| 4 | |
| 5 | use Give\DonorDashboards\Tabs\Contracts\Tab; |
| 6 | use Give\DonorDashboards\Exceptions\MissingTabException; |
| 7 | use Give\DonorDashboards\Exceptions\DuplicateTabException; |
| 8 | use http\Exception\InvalidArgumentException; |
| 9 | |
| 10 | /** |
| 11 | * @since 2.10.0 |
| 12 | */ |
| 13 | class TabsRegister { |
| 14 | /** |
| 15 | * FQCN of Tab classes |
| 16 | * |
| 17 | * @since 2.10.0 |
| 18 | * |
| 19 | * @var string[] |
| 20 | */ |
| 21 | private $tabs = []; |
| 22 | |
| 23 | /** |
| 24 | * Returns all of the registered tabs |
| 25 | * |
| 26 | * @since 2.10.0 |
| 27 | * |
| 28 | * @return string[] |
| 29 | */ |
| 30 | public function getTabs() { |
| 31 | return $this->tabs; |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Checks to see if a tab is registered with the given ID |
| 36 | * |
| 37 | * @since 2.10.0 |
| 38 | * |
| 39 | * @param string $id |
| 40 | * |
| 41 | * @return bool |
| 42 | */ |
| 43 | public function hasTab( $id ) { |
| 44 | return isset( $this->tabs[ $id ] ); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Returns a tab with the given ID |
| 49 | * |
| 50 | * @since 2.10.0 |
| 51 | * |
| 52 | * @param string $id |
| 53 | * |
| 54 | * @return string |
| 55 | */ |
| 56 | public function getTab( $id ) { |
| 57 | if ( ! $this->hasTab( $id ) ) { |
| 58 | throw new MissingTabException( $id ); |
| 59 | } |
| 60 | |
| 61 | return $this->tabs[ $id ]; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Returns all of the registered tab ids |
| 66 | * |
| 67 | * @since 2.10.0 |
| 68 | * |
| 69 | * @return string[] |
| 70 | */ |
| 71 | public function getRegisteredIds() { |
| 72 | return array_keys( $this->tabs ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Add a tab to the list of tabs |
| 77 | * |
| 78 | * @since 2.10.0 |
| 79 | * |
| 80 | * @param string $tabClass FQCN of the Tab Class |
| 81 | */ |
| 82 | public function addTab( $tabClass ) { |
| 83 | if ( ! is_subclass_of( $tabClass, Tab::class ) ) { |
| 84 | throw new \InvalidArgumentException( 'Class must extend the ' . Tab::class . ' class' ); |
| 85 | } |
| 86 | |
| 87 | $tabId = $tabClass::id(); |
| 88 | |
| 89 | if ( $this->hasTab( $tabId ) ) { |
| 90 | throw new DuplicateTabException(); |
| 91 | } |
| 92 | |
| 93 | $this->tabs[ $tabId ] = $tabClass; |
| 94 | |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Helper for adding a bunch of tabs at once |
| 99 | * |
| 100 | * @since 2.10.0 |
| 101 | * |
| 102 | * @param string[] $tabClasses |
| 103 | */ |
| 104 | public function addTabs( array $tabClasses ) { |
| 105 | foreach ( $tabClasses as $tabClass ) { |
| 106 | $this->addTab( $tabClass ); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | public function registerTabRoutes() { |
| 111 | foreach ( give()->donorDashboardTabs->tabs as $tabClass ) { |
| 112 | $tab = new $tabClass; |
| 113 | $tab->registerRoutes(); |
| 114 | } |
| 115 | } |
| 116 | |
| 117 | public function enqueueTabAssets() { |
| 118 | foreach ( give()->donorDashboardTabs->tabs as $tabClass ) { |
| 119 | ( new $tabClass )->enqueueAssets(); |
| 120 | } |
| 121 | } |
| 122 | } |
| 123 |