Tab.php
63 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonorDashboards\Tabs\Contracts; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\RuntimeException; |
| 6 | use Give\DonorDashboards\Tabs\Contracts\Route as RouteAbstract; |
| 7 | |
| 8 | /** |
| 9 | * Class Tab |
| 10 | * |
| 11 | * Extend this class when creating Donor Profile tabs. |
| 12 | * |
| 13 | * @since 2.10.0 |
| 14 | */ |
| 15 | abstract class Tab { |
| 16 | /** |
| 17 | * Return array of routes (must extend DonorDashboard Route class) |
| 18 | * |
| 19 | * @return array |
| 20 | * @since 2.10.0 |
| 21 | */ |
| 22 | abstract public function routes(); |
| 23 | |
| 24 | /** |
| 25 | * Return a unique identifier for the tab |
| 26 | * |
| 27 | * @return string |
| 28 | * @since 2.10.0 |
| 29 | */ |
| 30 | public static function id() { |
| 31 | throw new RuntimeException( 'A unique ID must be provided for the tab' ); |
| 32 | } |
| 33 | |
| 34 | |
| 35 | /** |
| 36 | * Enqueue assets required for frontend rendering of tab |
| 37 | * |
| 38 | * @since 2.10.0 |
| 39 | */ |
| 40 | public function enqueueAssets() { |
| 41 | return null; |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Registers routes with WP REST api |
| 46 | * |
| 47 | * @since 2.10.0 |
| 48 | */ |
| 49 | public function registerRoutes() { |
| 50 | $routeClasses = $this->routes(); |
| 51 | foreach ( $routeClasses as $routeClass ) { |
| 52 | if ( ! is_subclass_of( $routeClass, RouteAbstract::class ) ) { |
| 53 | throw new \InvalidArgumentException( $routeClass . ' must extend the ' . RouteAbstract::class . ' class' ); |
| 54 | } |
| 55 | ( new $routeClass )->registerRoute(); |
| 56 | } |
| 57 | } |
| 58 | |
| 59 | public function registerTab() { |
| 60 | give()->donorDashboardTabs->addTab( get_called_class() ); |
| 61 | } |
| 62 | } |
| 63 |