OXDEV-6455: Add descriptions to Vendor-Type and relation-services

OXID-eSales · Feb 14, 2024 · f8d6eba · f8d6eba
1 parent 6bd273b
commit f8d6eba
Show file tree

Hide file tree

Showing 31 changed files with 99 additions and 0 deletions.
diff --git a/src/Address/Service/AddressRelations.php b/src/Address/Service/AddressRelations.php
@@ -34,6 +34,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Address-Type.
      * @Field()
      */
     public function country(AbstractAddress $address): ?Country
@@ -44,6 +45,7 @@ public function country(AbstractAddress $address): ?Country
     }
 
     /**
+     * Field of Storefront module's Address-Type.
      * @Field()
      */
     public function state(AbstractAddress $address): ?State

diff --git a/src/Banner/Service/RelationService.php b/src/Banner/Service/RelationService.php
@@ -39,6 +39,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Banner-Type.
      * @Field()
      */
     public function getProduct(Banner $banner): ?Product

diff --git a/src/Basket/Service/BasketCostRelations.php b/src/Basket/Service/BasketCostRelations.php
@@ -31,6 +31,7 @@ public function __construct(BasketCostInfrastructure $basketCostInfrastructure)
     }
 
     /**
+     * Field of Storefront module's BasketCost-Type.
      * @Field()
      */
     public function getProductNet(BasketCost $basketCost): Price
@@ -42,6 +43,7 @@ public function getProductNet(BasketCost $basketCost): Price
     }
 
     /**
+     * Field of Storefront module's BasketCost-Type.
      * @Field()
      */
     public function getProductGross(BasketCost $basketCost): BasketProductBruttoSum
@@ -50,6 +52,7 @@ public function getProductGross(BasketCost $basketCost): BasketProductBruttoSum
     }
 
     /**
+     * Field of Storefront module's BasketCost-Type.
      * @Field()
      */
     public function getPayment(BasketCost $basketCost): Price
@@ -61,6 +64,7 @@ public function getPayment(BasketCost $basketCost): Price
     }
 
     /**
+     * Field of Storefront module's BasketCost-Type.
      * @Field()
      */
     public function getCurrency(BasketCost $basketCost): Currency
@@ -69,6 +73,7 @@ public function getCurrency(BasketCost $basketCost): Currency
     }
 
     /**
+     * Field of Storefront module's BasketCost-Type.
      * @Field()
      */
     public function getDelivery(BasketCost $basketCost): Price

diff --git a/src/Basket/Service/BasketItemRelationService.php b/src/Basket/Service/BasketItemRelationService.php
@@ -33,6 +33,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's BasketItem-Type.
      * @Field()
      */
     public function product(BasketItem $basketItem): ?Product

diff --git a/src/Basket/Service/BasketPaymentService.php b/src/Basket/Service/BasketPaymentService.php
@@ -30,6 +30,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's BasketPayment-Type.
      * @Field()
      */
     public function cost(BasketPayment $basketPayment): Price

diff --git a/src/Basket/Service/BasketProductBruttoSumRelations.php b/src/Basket/Service/BasketProductBruttoSumRelations.php
@@ -30,6 +30,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's BasketProductBruttoSum-Type.
      * @Field()
      *
      * @return BasketProductVats[]

diff --git a/src/Basket/Service/BasketRelationService.php b/src/Basket/Service/BasketRelationService.php
@@ -78,6 +78,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * @Field()
      */
     public function owner(Basket $basket): ?BasketOwner
@@ -92,6 +93,7 @@ public function owner(Basket $basket): ?BasketOwner
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * @Field()
      *
      * @return BasketItem[]
@@ -109,6 +111,7 @@ public function items(
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * @Field()
      */
     public function cost(Basket $basket): BasketCost
@@ -117,6 +120,7 @@ public function cost(Basket $basket): BasketCost
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * @Field()
      *
      * @return Voucher[]
@@ -127,6 +131,7 @@ public function vouchers(Basket $basket): array
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * @Field()
      */
     public function deliveryAddress(Basket $basket): ?DeliveryAddress
@@ -147,6 +152,7 @@ public function deliveryAddress(Basket $basket): ?DeliveryAddress
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * Returns selected payment for current basket.
      *
      * @Field()
@@ -169,6 +175,7 @@ public function payment(Basket $basket): ?Payment
     }
 
     /**
+     * Field of Storefront module's Basket-Type.
      * Returns selected delivery method for current basket.
      *
      * @Field()

diff --git a/src/Basket/Service/PublicBasketRelationService.php b/src/Basket/Service/PublicBasketRelationService.php
@@ -40,6 +40,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's PublicBasket-Type.
      * @Field()
      */
     public function owner(PublicBasketDataType $basket): BasketOwner
@@ -48,6 +49,7 @@ public function owner(PublicBasketDataType $basket): BasketOwner
     }
 
     /**
+     * Field of Storefront module's PublicBasket-Type.
      * @Field()
      *
      * @return BasketItem[]

diff --git a/src/Category/Service/RelationService.php b/src/Category/Service/RelationService.php
@@ -54,6 +54,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Category-Type.
      * @Field()
      */
     public function getParent(Category $category): ?Category
@@ -62,6 +63,7 @@ public function getParent(Category $category): ?Category
     }
 
     /**
+     * Field of Storefront module's Category-Type.
      * @Field()
      */
     public function getRoot(Category $category): ?Category
@@ -70,6 +72,7 @@ public function getRoot(Category $category): ?Category
     }
 
     /**
+     * Field of Storefront module's Category-Type.
      * @Field()
      *
      * @return Category[]
@@ -86,6 +89,7 @@ public function getChildren(Category $category): array
     }
 
     /**
+     * Field of Storefront module's Category-Type.
      * @Field()
      */
     public function getSeo(Category $category): Seo
@@ -94,6 +98,7 @@ public function getSeo(Category $category): Seo
     }
 
     /**
+     * Field of Storefront module's Category-Type.
      * @Field()
      *
      * @return Product[]
@@ -136,6 +141,7 @@ private function getCategoryById(ID $id): ?Category
     }
 
     /**
+     * Field of Storefront module's Category-Type.
      * @Field()
      *
      * @return CategoryAttribute[]

diff --git a/src/Content/Service/RelationService.php b/src/Content/Service/RelationService.php
@@ -40,6 +40,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Content-Type.
      * @Field()
      */
     public function getSeo(Content $content): Seo
@@ -48,6 +49,7 @@ public function getSeo(Content $content): Seo
     }
 
     /**
+     * Field of Storefront module's Content-Type.
      * @Field()
      */
     public function getCategory(Content $content): ?CategoryDataType

diff --git a/src/Country/Service/RelationService.php b/src/Country/Service/RelationService.php
@@ -33,6 +33,7 @@ public function __construct(StateService $stateService)
     }
 
     /**
+     * Field of Storefront module's Country-Type.
      * @Field()
      *
      * @return StateDataType[]

diff --git a/src/Customer/Service/RelationService.php b/src/Customer/Service/RelationService.php
@@ -70,6 +70,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      *
      * @return ReviewDataType[]
@@ -88,6 +89,7 @@ public function getReviews(CustomerDataType $customer): array
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      */
     public function getNewsletterStatus(): ?NewsletterStatusType
@@ -100,6 +102,7 @@ public function getNewsletterStatus(): ?NewsletterStatusType
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      *
      * @return DeliveryAddress[]
@@ -110,6 +113,7 @@ public function deliveryAddresses(CustomerDataType $customer): array
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      */
     public function invoiceAddress(): InvoiceAddressDataType
@@ -118,6 +122,7 @@ public function invoiceAddress(): InvoiceAddressDataType
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      */
     public function getBasket(CustomerDataType $customer, string $title): BasketDataType
@@ -126,6 +131,7 @@ public function getBasket(CustomerDataType $customer, string $title): BasketData
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      *
      * @return BasketDataType[]
@@ -136,6 +142,7 @@ public function getBaskets(CustomerDataType $customer): array
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field()
      *
      * @return OrderDataType[]
@@ -146,6 +153,7 @@ public function getOrders(CustomerDataType $customer, ?PaginationFilter $paginat
     }
 
     /**
+     * Field of Storefront module's Customer-Type.
      * @Field
      *
      * @return OrderFile[]

diff --git a/src/DeliveryMethod/Service/BasketDeliveryMethodRelationService.php b/src/DeliveryMethod/Service/BasketDeliveryMethodRelationService.php
@@ -29,6 +29,7 @@ public function __construct(BasketInfrastructure $basketInfrastructure)
     }
 
     /**
+     * Field of Storefront module's BasketDeliveryMethod-Type.
      * @Field()
      */
     public function cost(BasketDeliveryMethod $basketDeliveryMethod): Price

diff --git a/src/File/Service/FileRelations.php b/src/File/Service/FileRelations.php
@@ -31,6 +31,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's File-Type.
      * @Field()
      */
     public function getProduct(File $file): Product

diff --git a/src/Manufacturer/Service/RelationService.php b/src/Manufacturer/Service/RelationService.php
@@ -35,6 +35,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's Manufacturer-Type.
      * @Field()
      */
     public function getSeo(Manufacturer $manufacturer): Seo
@@ -43,6 +44,7 @@ public function getSeo(Manufacturer $manufacturer): Seo
     }
 
     /**
+     * Field of Storefront module's Manufacturer-Type.
      * @Field()
      *
      * @return ProductDataType[]

diff --git a/src/Order/Service/OrderCostRelations.php b/src/Order/Service/OrderCostRelations.php
@@ -31,6 +31,7 @@ public function __construct(OrderCostInfrastructure $orderCostInfrastructure)
     }
 
     /**
+     * Field of Storefront module's OrderCost-Type.
      * @Field()
      */
     public function getDelivery(OrderCost $orderCost): Price
@@ -42,6 +43,7 @@ public function getDelivery(OrderCost $orderCost): Price
     }
 
     /**
+     * Field of Storefront module's OrderCost-Type.
      * @Field()
      */
     public function getPayment(OrderCost $orderCost): Price
@@ -53,6 +55,7 @@ public function getPayment(OrderCost $orderCost): Price
     }
 
     /**
+     * Field of Storefront module's OrderCost-Type.
      * @Field()
      */
     public function getProductNet(OrderCost $orderCost): Price
@@ -64,6 +67,7 @@ public function getProductNet(OrderCost $orderCost): Price
     }
 
     /**
+     * Field of Storefront module's OrderCost-Type.
      * @Field()
      */
     public function getProductGross(OrderCost $orderCost): OrderProductBruttoSum
@@ -72,6 +76,7 @@ public function getProductGross(OrderCost $orderCost): OrderProductBruttoSum
     }
 
     /**
+     * Field of Storefront module's OrderCost-Type.
      * @Field()
      */
     public function getCurrency(OrderCost $orderCost): Currency

diff --git a/src/Order/Service/OrderDeliveryRelations.php b/src/Order/Service/OrderDeliveryRelations.php
@@ -29,6 +29,7 @@ public function __construct(OrderDeliveryInfrastructure $orderDeliveryInfrastruc
     }
 
     /**
+     * Field of Storefront module's OrderDelivery-Type.
      * @Field()
      */
     public function getProvider(OrderDelivery $orderDelivery): DeliveryProvider

diff --git a/src/Order/Service/OrderFileRelations.php b/src/Order/Service/OrderFileRelations.php
@@ -31,6 +31,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's OrderFile-Type.
      * @Field()
      */
     public function file(OrderFile $orderFile): ?FileDataType

diff --git a/src/Order/Service/OrderItemRelations.php b/src/Order/Service/OrderItemRelations.php
@@ -33,6 +33,7 @@ public function __construct(
     }
 
     /**
+     * Field of Storefront module's OrderItem-Type.
      * @Field()
      */
     public function getProduct(OrderItem $orderItem): ?Product
-Original file line number
+Diff line change
@@ Expand Up / @@ -39,6 +39,7 @@ public function __construct( @@
         }
         /**
+         * Field of Storefront module's Banner-Type.
          * @Field()
          */
         public function getProduct(Banner $banner): ?Product
@@ Expand Down @@