You are here

Home » API reference » Commerce Cart API 8 » CartCouponsResource.php

class CartCouponsResource in Commerce Cart API 8

Provides a cart collection resource for current session.

Plugin annotation


@RestResource(
  id = "commerce_cart_coupons",
  label = @Translation("Cart coupons"),
  uri_paths = {
    "canonical" = "/cart/{commerce_order}/coupons"
  }
)

Hierarchy

Expanded class hierarchy of CartCouponsResource

File

src/Plugin/rest/resource/CartCouponsResource.php, line 33

Namespace

Drupal\commerce_cart_api\Plugin\rest\resource
View source 
class CartCouponsResource extends CartResourceBase {
  use EntityResourceValidationTrait;

  /**
   * The serializer.
   *
   * @var \Symfony\Component\Serializer\SerializerInterface
   */
  protected $serializer;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new CartUpdateItemsResource object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param array $serializer_formats
   *   The available serialization formats.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\commerce_cart\CartProviderInterface $cart_provider
   *   The cart provider.
   * @param \Drupal\commerce_cart\CartManagerInterface $cart_manager
   *   The cart manager.
   * @param \Symfony\Component\Serializer\SerializerInterface $serializer
   *   The serializer.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, array $serializer_formats, LoggerInterface $logger, CartProviderInterface $cart_provider, CartManagerInterface $cart_manager, SerializerInterface $serializer, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger, $cart_provider, $cart_manager);
    $this->serializer = $serializer;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->getParameter('serializer.formats'), $container
      ->get('logger.factory')
      ->get('rest'), $container
      ->get('commerce_cart.cart_provider'), $container
      ->get('commerce_cart.cart_manager'), $container
      ->get('serializer'), $container
      ->get('entity_type.manager'));
  }
  public function get(OrderInterface $commerce_order) {
    $response = new ResourceResponse($commerce_order
      ->get('coupons'));
    $response
      ->addCacheableDependency($commerce_order);
    return $response;
  }
  public function patch(OrderInterface $commerce_order, array $unserialized) {

    // Add coupons.
    if (!isset($unserialized['coupon_code'])) {
      throw new BadRequestHttpException('Coupon code not provided.');
    }
    $coupon_storage = $this->entityTypeManager
      ->getStorage('commerce_promotion_coupon');
    assert($coupon_storage instanceof CouponStorageInterface);
    $coupon = $coupon_storage
      ->loadEnabledByCode($unserialized['coupon_code']);
    if (!$coupon instanceof CouponInterface) {
      throw new UnprocessableEntityHttpException(sprintf('%s is not a valid coupon code.', $unserialized['coupon_code']));
    }
    $commerce_order
      ->get('coupons')
      ->setValue([
      $coupon,
    ]);
    $this
      ->validate($commerce_order);
    try {
      $commerce_order
        ->setRefreshState(OrderInterface::REFRESH_ON_SAVE);
      $commerce_order
        ->save();
      return new ModifiedResourceResponse($commerce_order, 200);
    } catch (EntityStorageException $e) {
      throw new HttpException(500, 'Internal Server Error', $e);
    }
  }
  public function delete(OrderInterface $commerce_order) {
    $commerce_order
      ->get('coupons')
      ->setValue(NULL);
    $commerce_order
      ->setRefreshState(OrderInterface::REFRESH_ON_SAVE);
    $commerce_order
      ->save();
    return new ModifiedResourceResponse(NULL, 204);
  }

  /**
   * {@inheritdoc}
   */
  protected function getBaseRoute($canonical_path, $method) {
    $route = parent::getBaseRoute($canonical_path, $method);
    $parameters = $route
      ->getOption('parameters') ?: [];
    $parameters['commerce_order']['type'] = 'entity:commerce_order';
    $route
      ->setOption('parameters', $parameters);
    return $route;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CartCouponsResource::$entityTypeManager protected property The entity type manager.
CartCouponsResource::$serializer protected property The serializer.
CartCouponsResource::create public static function Creates an instance of the plugin. Overrides CartResourceBase::create
CartCouponsResource::delete public function
CartCouponsResource::get public function
CartCouponsResource::getBaseRoute protected function Gets the base route for a particular method. Overrides ResourceBase::getBaseRoute
CartCouponsResource::patch public function
CartCouponsResource::__construct public function Constructs a new CartUpdateItemsResource object. Overrides CartResourceBase::__construct
CartResourceBase::$cartManager protected property The cart manager.
CartResourceBase::$cartProvider protected property The cart provider.
CartResourceBase::getBaseRouteRequirements protected function Gets the base route requirements for a particular method. Overrides ResourceBase::getBaseRouteRequirements
CartResourceBase::permissions public function We do not return specific resource permissions, as we respect the existing cart management and ownership logic. Overrides ResourceBase::permissions
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityResourceValidationTrait::validate protected function Verifies that an entity does not violate any validation constraints.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ResourceBase::$logger protected property A logger instance.
ResourceBase::$serializerFormats protected property The available serialization formats.
ResourceBase::availableMethods public function Returns the available HTTP request methods on this plugin. Overrides ResourceInterface::availableMethods 1
ResourceBase::requestMethods protected function Provides predefined HTTP request methods.
ResourceBase::routes public function Returns a collection of routes with URL path information for the resource. Overrides ResourceInterface::routes
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.