chore(Annotation): add correct typed magic getReference method to resource models

Author: Jens Schulze

src/Helper/Annotate/ClassAnnotator.php

@@ -72,6 +72,28 @@ protected function reflectFields()
         }
     }
 
+    protected function reflectReference()
+    {
+        $reflectionClass = new \ReflectionClass($this->class->getClassName());
+        if (!$reflectionClass->isSubclassOf('Commercetools\Core\Model\Common\Resource')) {
+            return;
+        }
+
+        $referenceClass = $this->class->getClassName() . 'Reference';
+        $referenceShortName = $this->class->getShortClassName() . 'Reference';
+        if (class_exists($referenceClass)) {
+            $this->class->addMagicMethod(
+                'getReference',
+                [],
+                $referenceShortName,
+                null,
+                null,
+                false,
+                true
+            );
+        }
+    }
+
     protected function reflectElementType()
     {
         $reflectionClass = new \ReflectionClass($this->class->getClassName());
@@ -163,6 +185,7 @@ public function generate()
         }
 
         $this->reflectFields();
+        $this->reflectReference();
         $this->annotate();
     }
 

src/Model/Cart/Cart.php

@@ -57,6 +57,7 @@
  * @method Cart setCustom(CustomFieldObject $custom = null)
  * @method PaymentInfo getPaymentInfo()
  * @method Cart setPaymentInfo(PaymentInfo $paymentInfo = null)
+ * @method CartReference getReference()
  */
 class Cart extends Resource
 {

src/Model/CartDiscount/CartDiscount.php

@@ -43,6 +43,7 @@
  * @method CartDiscount setRequiresDiscountCode(bool $requiresDiscountCode = null)
  * @method ReferenceCollection getReferences()
  * @method CartDiscount setReferences(ReferenceCollection $references = null)
+ * @method CartDiscountReference getReference()
  */
 class CartDiscount extends Resource
 {

src/Model/Category/Category.php

@@ -43,6 +43,7 @@
  * @method Category setMetaTitle(LocalizedString $metaTitle = null)
  * @method LocalizedString getMetaKeywords()
  * @method Category setMetaKeywords(LocalizedString $metaKeywords = null)
+ * @method CategoryReference getReference()
  */
 class Category extends Resource
 {

src/Model/Channel/Channel.php

@@ -34,6 +34,7 @@
  * @method Channel setCustom(CustomFieldObject $custom = null)
  * @method ReviewRatingStatistics getReviewRatingStatistics()
  * @method Channel setReviewRatingStatistics(ReviewRatingStatistics $reviewRatingStatistics = null)
+ * @method ChannelReference getReference()
  */
 class Channel extends Resource
 {

src/Model/Customer/Customer.php

@@ -57,6 +57,7 @@
  * @method Customer setCustomerGroup(CustomerGroupReference $customerGroup = null)
  * @method CustomFieldObject getCustom()
  * @method Customer setCustom(CustomFieldObject $custom = null)
+ * @method CustomerReference getReference()
  */
 class Customer extends Resource
 {

src/Model/CustomerGroup/CustomerGroup.php

@@ -21,6 +21,7 @@
  * @method CustomerGroup setLastModifiedAt(\DateTime $lastModifiedAt = null)
  * @method string getName()
  * @method CustomerGroup setName(string $name = null)
+ * @method CustomerGroupReference getReference()
  */
 class CustomerGroup extends Resource
 {

src/Model/DiscountCode/DiscountCode.php

@@ -40,6 +40,7 @@
  * @method DiscountCode setMaxApplications(int $maxApplications = null)
  * @method int getMaxApplicationsPerCustomer()
  * @method DiscountCode setMaxApplicationsPerCustomer(int $maxApplicationsPerCustomer = null)
+ * @method DiscountCodeReference getReference()
  */
 class DiscountCode extends Resource
 {

src/Model/Order/Order.php

@@ -79,6 +79,7 @@
  * @method Order setState(StateReference $state = null)
  * @method PaymentInfo getPaymentInfo()
  * @method Order setPaymentInfo(PaymentInfo $paymentInfo = null)
+ * @method OrderReference getReference()
  */
 class Order extends Resource
 {

src/Model/Payment/Payment.php

@@ -49,6 +49,7 @@
  * @method Payment setTransactions(TransactionCollection $transactions = null)
  * @method CustomFieldObjectCollection getInterfaceInteractions()
  * @method Payment setInterfaceInteractions(CustomFieldObjectCollection $interfaceInteractions = null)
+ * @method PaymentReference getReference()
  */
 class Payment extends Resource
 {