Skip to content

Fixed docblock declarations #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2018
Merged

Fixed docblock declarations #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions lib/Article.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions lib/Blog.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions lib/Comment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions lib/Country.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions lib/CustomCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions lib/Customer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
* --------------------------------------------------------------------------
Expand Down
3 changes: 1 addition & 2 deletions lib/CustomerAddress.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions lib/CustomerSavedSearch.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/Discount.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
namespace PHPShopify;


/*
/**
* --------------------------------------------------------------------------
* Discount -> Custom actions
* --------------------------------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions lib/Fulfillment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions lib/GiftCard.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
*/
Expand Down
28 changes: 14 additions & 14 deletions lib/Order.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions lib/Page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 9 additions & 9 deletions lib/Product.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions lib/ProductVariant.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions lib/RecurringApplicationCharge.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/Refund.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
namespace PHPShopify;


/*
/**
* --------------------------------------------------------------------------
* Refund -> Custom actions
* --------------------------------------------------------------------------
Expand Down
2 changes: 0 additions & 2 deletions lib/ShopifyResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading