class ShipmentController in Commerce Shipping 8.2

Provides the add-page and title callbacks for shipments.

Hierarchy

• class \Drupal\Core\Entity\Controller\EntityController implements ContainerInjectionInterface uses UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\commerce_shipping\Controller\ShipmentController

1 file declares its use of ShipmentController

ShipmentRouteProvider.php in src/ShipmentRouteProvider.php

File

src/Controller/ShipmentController.php, line 11

Namespace

Drupal\commerce_shipping\Controller

class ShipmentController extends EntityController {

  /**
   * Redirects to the shipment add form.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $commerce_order
   *   The commerce order to add a shipment to.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect response to the shipment add page.
   */
  public function addShipmentPage(OrderInterface $commerce_order) {
    $order_type = $this->entityTypeManager
      ->getStorage('commerce_order_type')
      ->load($commerce_order
      ->bundle());

    // Find the shipment type associated to this order type.
    $shipment_type = $order_type
      ->getThirdPartySetting('commerce_shipping', 'shipment_type', 'default');
    return $this
      ->redirect('entity.commerce_shipment.add_form', [
      'commerce_order' => $commerce_order
        ->id(),
      'commerce_shipment_type' => $shipment_type,
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityController::$entityRepository	protected	property	The entity repository.
EntityController::$entityTypeBundleInfo	protected	property	The entity type bundle info.
EntityController::$entityTypeManager	protected	property	The entity manager.
EntityController::$renderer	protected	property	The renderer.
EntityController::addBundleTitle	public	function	Provides a generic add title callback for entities with bundles.
EntityController::addPage	public	function	Displays add links for the available bundles.
EntityController::addTitle	public	function	Provides a generic add title callback for an entity type.
EntityController::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
EntityController::deleteTitle	public	function	Provides a generic delete title callback.
EntityController::doGetEntity	protected	function	Determines the entity.
EntityController::editTitle	public	function	Provides a generic edit title callback.
EntityController::loadBundleDescriptions	protected	function	Expands the bundle information with descriptions, if known.
EntityController::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
EntityController::title	public	function	Provides a generic title callback for a single entity.
EntityController::__construct	public	function	Constructs a new EntityController.
ShipmentController::addShipmentPage	public	function	Redirects to the shipment add form.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.