class OrderRouteProvider in Commerce Core 8.2
Provides routes for the Order entity.
Hierarchy
- class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
- class \Drupal\entity\Routing\DefaultHtmlRouteProvider
- class \Drupal\entity\Routing\AdminHtmlRouteProvider
- class \Drupal\commerce_order\OrderRouteProvider
- class \Drupal\entity\Routing\AdminHtmlRouteProvider
- class \Drupal\entity\Routing\DefaultHtmlRouteProvider
Expanded class hierarchy of OrderRouteProvider
File
- modules/
order/ src/ OrderRouteProvider.php, line 12
Namespace
Drupal\commerce_orderView source
class OrderRouteProvider extends AdminHtmlRouteProvider {
/**
* {@inheritdoc}
*/
protected function getCanonicalRoute(EntityTypeInterface $entity_type) {
$route = parent::getCanonicalRoute($entity_type);
// Replace the 'full' view mode with the 'admin' view mode.
$route
->setDefault('_entity_view', 'commerce_order.admin');
// The canonical route is the admin view of the order.
$route
->setOption('_admin_route', TRUE);
return $route;
}
/**
* {@inheritdoc}
*/
public function getRoutes(EntityTypeInterface $entity_type) {
$collection = parent::getRoutes($entity_type);
if ($resend_receipt_form_route = $this
->getResendReceiptFormRoute($entity_type)) {
$collection
->add("entity.commerce_order.resend_receipt_form", $resend_receipt_form_route);
}
$collection
->addRequirements([
'_permission' => 'access commerce administration pages',
]);
return $collection;
}
/**
* Gets the resend-receipt-form route.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type.
*
* @return \Symfony\Component\Routing\Route|null
* The generated route, if available.
*/
protected function getResendReceiptFormRoute(EntityTypeInterface $entity_type) {
$route = new Route($entity_type
->getLinkTemplate('resend-receipt-form'));
$route
->addDefaults([
'_entity_form' => 'commerce_order.resend-receipt',
'_title_callback' => '\\Drupal\\Core\\Entity\\Controller\\EntityController::title',
])
->setRequirement('_entity_access', 'commerce_order.resend_receipt')
->setRequirement('commerce_order', '\\d+')
->setOption('parameters', [
'commerce_order' => [
'type' => 'entity:commerce_order',
],
])
->setOption('_admin_route', TRUE);
return $route;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DefaultHtmlRouteProvider:: |
protected | property | The entity field manager. | |
DefaultHtmlRouteProvider:: |
protected | property | The entity type manager. | |
DefaultHtmlRouteProvider:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface:: |
1 |
DefaultHtmlRouteProvider:: |
protected | function | Gets the add-form route. | 2 |
DefaultHtmlRouteProvider:: |
protected | function | Gets the add page route. | 2 |
DefaultHtmlRouteProvider:: |
protected | function |
Gets the collection route. Overrides DefaultHtmlRouteProvider:: |
|
DefaultHtmlRouteProvider:: |
protected | function | Gets the delete-form route. | 1 |
DefaultHtmlRouteProvider:: |
protected | function | Returns the delete multiple form route. | 1 |
DefaultHtmlRouteProvider:: |
protected | function | Gets the duplicate-form route. | |
DefaultHtmlRouteProvider:: |
protected | function | Gets the edit-form route. | 1 |
DefaultHtmlRouteProvider:: |
protected | function | Gets the type of the ID key for a given entity type. | 1 |
DefaultHtmlRouteProvider:: |
public | function | Constructs a new DefaultHtmlRouteProvider. | 1 |
OrderRouteProvider:: |
protected | function |
Gets the canonical route. Overrides DefaultHtmlRouteProvider:: |
|
OrderRouteProvider:: |
protected | function | Gets the resend-receipt-form route. | |
OrderRouteProvider:: |
public | function |
Provides routes for entities. Overrides AdminHtmlRouteProvider:: |