GravityKit\GravityExport\Routing\GravityExportRouter
Router for Gravity Export.
It augments the WordPress router with additional endpoints and configuration.
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:16
Details
-
Kind:
class -
Namespace:
GravityKit\GravityExport\Routing -
Implements:
Router
Methods
| Method | Description |
|---|---|
__construct() | Creates the Gravity Export router. |
init() | |
endpoints() | |
get_url_for_form() | |
get_url_for_hash() | |
matches() | |
get_feed_by_request() | |
get_default_endpoint() | Returns the default action URL. |
Method Reference
__construct()
public function __construct( Router $router=null )
Creates the Gravity Export router.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$router | Router | null | null | An optional delegation router. |
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:43
init()
public function init(): void
Returns
void
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:52
endpoints()
public function endpoints(): array
Returns
array
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:65
get_url_for_form()
public function get_url_for_form( int $form_id ): ?string
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_id | int |
Returns
?string
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:91
get_url_for_hash()
public function get_url_for_hash( string $hash ): string
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$hash | string |
Returns
string
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:102
matches()
public function matches( Request $request ): bool
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | Request |
Returns
bool
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:113
get_feed_by_request()
public function get_feed_by_request( Request $request ): ?array
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | Request |
Returns
?array
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:126
get_default_endpoint()
public function get_default_endpoint(): string
Returns the default action URL.
Returns
string
Since: 1.5.0
Source: src/Routing/GravityExportRouter.php:136