Builder_Interface.php
49 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Pods\REST\Interfaces\Swagger; |
| 4 | |
| 5 | use Pods\REST\Interfaces\Endpoints\READ_Interface; |
| 6 | |
| 7 | /** |
| 8 | * Provider interface. |
| 9 | * |
| 10 | * @credit The Events Calendar team - https://github.com/the-events-calendar/tribe-common |
| 11 | * |
| 12 | * @since 3.0 |
| 13 | */ |
| 14 | interface Builder_Interface { |
| 15 | /** |
| 16 | * Registers a documentation provider for a path. |
| 17 | * |
| 18 | * @since 3.0 |
| 19 | * |
| 20 | * @param string $path |
| 21 | * @param READ_Interface $endpoint |
| 22 | */ |
| 23 | public function register_documentation_provider( $path, Provider_Interface $endpoint ); |
| 24 | |
| 25 | /** |
| 26 | * @since 3.0 |
| 27 | * |
| 28 | * @return Provider_Interface[] |
| 29 | */ |
| 30 | public function get_registered_documentation_providers(); |
| 31 | |
| 32 | /** |
| 33 | * Registers a documentation provider for a definition. |
| 34 | * |
| 35 | * @since 3.0 |
| 36 | * |
| 37 | * @param string $type |
| 38 | * @param Provider_Interface $provider |
| 39 | */ |
| 40 | public function register_definition_provider( $type, Provider_Interface $provider ); |
| 41 | |
| 42 | /** |
| 43 | * @since 3.0 |
| 44 | * |
| 45 | * @return Provider_Interface[] |
| 46 | */ |
| 47 | public function get_registered_definition_providers(); |
| 48 | } |
| 49 |