Merge pull request #33 from TonyDeStefano/docblocks

tareqtms · web-flow · commit 86bc8246f8c4 · 2018-08-28T12:29:06.000+06:00
Fixed docblock declarations
diff --git a/lib/Article.php b/lib/Article.php
@@ -10,13 +10,15 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Article -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Event
+ * @property-read Event $Event
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Event(integer $id = null)
+ * @method Event Event(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  *
  */
 class Article extends ShopifyResource
diff --git a/lib/Blog.php b/lib/Blog.php
@@ -9,17 +9,17 @@
 
 namespace PHPShopify;
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Blog -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Article
- * @property-read ShopifyResource $Event
- * @property-read ShopifyResource $Metafield
+ * @property-read Article $Article
+ * @property-read Event $Event
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Article(integer $id = null)
- * @method ShopifyResource Event(integer $id = null)
- * @method ShopifyResource Metafield(integer $id = null)
+ * @method Article Article(integer $id = null)
+ * @method Event Event(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  *
  */
 class Blog extends ShopifyResource
diff --git a/lib/Comment.php b/lib/Comment.php
@@ -10,14 +10,14 @@
 namespace PHPShopify;
 
 
-/*
+/**
  *
  * --------------------------------------------------------------------------
  * Comment -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Event
+ * @property-read Event $Event
  *
- * @method ShopifyResource Event(integer $id = null)
+ * @method Event Event(integer $id = null)
  *
  * --------------------------------------------------------------------------
  * Comment -> Custom actions
diff --git a/lib/Country.php b/lib/Country.php
@@ -10,13 +10,13 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Country -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Province
+ * @property-read Province $Province
  *
- * @method ShopifyResource Province(integer $id = null)
+ * @method Province Province(integer $id = null)
  *
  */
 class Country extends ShopifyResource
diff --git a/lib/CustomCollection.php b/lib/CustomCollection.php
@@ -10,15 +10,15 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * CustomCollection -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Event
- * @property-read ShopifyResource $Metafield
+ * @property-read Event $Event
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Event(integer $id = null)
- * @method ShopifyResource Metafield(integer $id = null)
+ * @method Event Event(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  *
  */
 class CustomCollection extends ShopifyResource
diff --git a/lib/Customer.php b/lib/Customer.php
@@ -10,15 +10,15 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Customer -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Address
- * @property-read ShopifyResource $Metafield
+ * @property-read CustomerAddress $Address
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Address(integer $id = null)
- * @method ShopifyResource Metafield(integer $id = null)
+ * @method CustomerAddress Address(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  * --------------------------------------------------------------------------
  * Customer -> Custom actions
  * --------------------------------------------------------------------------
diff --git a/lib/CustomerAddress.php b/lib/CustomerAddress.php
@@ -10,12 +10,11 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * CustomerAddress -> Custom actions
  * --------------------------------------------------------------------------
  * @method array makeDefault()      Sets the address as default for the customer
- * @method array set($params)       Perform bulk operations against a number of addresses
  *
  */
 class CustomerAddress extends ShopifyResource
diff --git a/lib/CustomerSavedSearch.php b/lib/CustomerSavedSearch.php
@@ -10,13 +10,13 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * CustomerSavedSearch -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Customer
+ * @property-read Customer $Customer
  *
- * @method ShopifyResource Customer(integer $id = null)
+ * @method Customer Customer(integer $id = null)
  *
  */
 class CustomerSavedSearch extends ShopifyResource
diff --git a/lib/Discount.php b/lib/Discount.php
@@ -10,7 +10,7 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Discount -> Custom actions
  * --------------------------------------------------------------------------
diff --git a/lib/Fulfillment.php b/lib/Fulfillment.php
@@ -10,13 +10,13 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Fulfillment -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Event
+ * @property-read Event $Event
  *
- * @method ShopifyResource Event(integer $id = null)
+ * @method Event Event(integer $id = null)
  *
  * --------------------------------------------------------------------------
  * Fulfillment -> Custom actions
diff --git a/lib/GiftCard.php b/lib/GiftCard.php
@@ -10,11 +10,10 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * GiftCard -> Custom actions
  * --------------------------------------------------------------------------
- * @method array disable()      Disable a gift card. Disabling a gift card is permanent and cannot be undone.
  * @method array search()       Search for gift cards matching supplied query
  *
  */
diff --git a/lib/Order.php b/lib/Order.php
@@ -11,30 +11,30 @@
 
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Order -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Fulfillment
- * @property-read ShopifyResource $Risk
- * @property-read ShopifyResource $Refund
- * @property-read ShopifyResource $Transaction
- * @property-read ShopifyResource $Event
- * @property-read ShopifyResource $Metafield
+ * @property-read Fulfillment $Fulfillment
+ * @property-read OrderRisk $Risk
+ * @property-read Refund $Refund
+ * @property-read Transaction $Transaction
+ * @property-read Event $Event
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Fulfillment(integer $id = null)
- * @method ShopifyResource Risk(integer $id = null)
- * @method ShopifyResource Refund(integer $id = null)
- * @method ShopifyResource Transaction(integer $id = null)
- * @method ShopifyResource Event(integer $id = null)
- * @method ShopifyResource Metafield(integer $id = null)
+ * @method Fulfillment Fulfillment(integer $id = null)
+ * @method OrderRisk Risk(integer $id = null)
+ * @method Refund Refund(integer $id = null)
+ * @method Transaction Transaction(integer $id = null)
+ * @method Event Event(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  *
  * --------------------------------------------------------------------------
  * Order -> Custom actions
  * --------------------------------------------------------------------------
  * @method array close()     Close an Order
  * @method array open()         Re-open a closed Order
- * @method array cancel($data)  Cancel an Order
+ * @method array cancel(array $data)  Cancel an Order
  *
  */
 class Order extends ShopifyResource
diff --git a/lib/Page.php b/lib/Page.php
@@ -10,15 +10,15 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Page -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Event
- * @property-read ShopifyResource $Metafield
+ * @property-read Event $Event
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Event(integer $id = null)
- * @method ShopifyResource Metafield(integer $id = null)
+ * @method Event Event(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  *
  */
 class Page extends ShopifyResource
diff --git a/lib/Product.php b/lib/Product.php
@@ -10,19 +10,19 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Product -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Image
- * @property-read ShopifyResource $Variant
- * @property-read ShopifyResource $Metafield
- * @property-read ShopifyResource $Event
+ * @property-read ProductImage $Image
+ * @property-read ProductVariant $Variant
+ * @property-read Metafield $Metafield
+ * @property-read Event $Event
  *
- * @method ShopifyResource Image(integer $id = null)
- * @method ShopifyResource Variant(integer $id = null)
- * @method ShopifyResource Metafield(integer $id = null)
- * @method ShopifyResource Event(integer $id = null)
+ * @method ProductImage Image(integer $id = null)
+ * @method ProductVariant Variant(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
+ * @method Event Event(integer $id = null)
  *
  */
 class Product extends ShopifyResource
diff --git a/lib/ProductVariant.php b/lib/ProductVariant.php
@@ -10,13 +10,13 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * ProductVariant -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $Metafield
+ * @property-read Metafield $Metafield
  *
- * @method ShopifyResource Metafield(integer $id = null)
+ * @method Metafield Metafield(integer $id = null)
  *
  */
 class ProductVariant extends ShopifyResource
diff --git a/lib/RecurringApplicationCharge.php b/lib/RecurringApplicationCharge.php
@@ -10,19 +10,18 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * RecurringApplicationCharge -> Child Resources
  * --------------------------------------------------------------------------
- * @property-read ShopifyResource $UsageCharge
+ * @property-read UsageCharge $UsageCharge
  *
- * @method ShopifyResource UsageCharge(integer $id = null)
+ * @method UsageCharge UsageCharge(integer $id = null)
  *
  * --------------------------------------------------------------------------
  * RecurringApplicationCharge -> Custom actions
  * --------------------------------------------------------------------------
  * @method array activate()             Activate a recurring application charge
- * @method array customize($data)     Customize a recurring application charge
  *
  */
 class RecurringApplicationCharge extends ShopifyResource
diff --git a/lib/Refund.php b/lib/Refund.php
@@ -10,7 +10,7 @@
 namespace PHPShopify;
 
 
-/*
+/**
  * --------------------------------------------------------------------------
  * Refund -> Custom actions
  * --------------------------------------------------------------------------
diff --git a/lib/ShopifyResource.php b/lib/ShopifyResource.php
@@ -426,8 +426,6 @@ public function delete($urlParams = array(), $url = null)
      * @param array $dataArray
      * @param string $dataKey
      *
-     * @internal
-     *
      * @return array
      */
     protected function wrapData($dataArray, $dataKey = null)
diff --git a/lib/ShopifySDK.php b/lib/ShopifySDK.php
diff --git a/lib/SmartCollection.php b/lib/SmartCollection.php
diff --git a/lib/Theme.php b/lib/Theme.php
diff --git a/lib/User.php b/lib/User.php

Original file line number	Diff line number	Diff line change
`@@ -10,14 +10,14 @@`
`10`	`10`	`namespace PHPShopify;`
`11`	`11`
`12`	`12`
`13`		`-/*`
	`13`	`+/**`
`14`	`14`	`*`
`15`	`15`	`* --------------------------------------------------------------------------`
`16`	`16`	`* Comment -> Child Resources`
`17`	`17`	`* --------------------------------------------------------------------------`
`18`		`- * @property-read ShopifyResource $Event`
	`18`	`+ * @property-read Event $Event`
`19`	`19`	`*`
`20`		`- * @method ShopifyResource Event(integer $id = null)`
	`20`	`+ * @method Event Event(integer $id = null)`
`21`	`21`	`*`
`22`	`22`	`* --------------------------------------------------------------------------`
`23`	`23`	`* Comment -> Custom actions`