Enhancement: Enable IntelliSense (IDE friendly) for class properties #278

phpdave · 2016-09-27T14:29:55Z

Added phpdoc class properties so that intellisense can pick up "magic" fields created by the use of __get

Also added params and return type for Recurly_Transaction's get() function. This allows the intellisense to know that the returned object is a Recurly_Transaction. Might want to add this to other class methods/functions.

drewish

What do you think about stripping this back to just type and property name? I think that would be pretty straightforward to generate off of the XML. I think the descriptions are going to be tricker to fill in and keep updated etc.

drewish · 2016-09-27T15:07:01Z

lib/recurly/account.php

+ * @property string $invoices The URL of invoices for the specified account.
+ * @property string $redemption The URL of the coupon redemption for the specified account.
+ * @property string $subscriptions The URL of subscriptions for the specified account.
+ * @property string $transactions The URL of transactions for the specified account.


I don't think these values that are listing as being URLs will actually be present as strings. I think they'll be Stubs for loading the full object.

drewish · 2016-09-27T15:09:22Z

lib/recurly/adjustment.php

+ * class Recurly_Adjustment
+ * @property string $type The type of adjustment to return: charge or credit.
+ * @property string $account The URL of the account for the specified adjustment.
+ * @property string $invoice The URL of the invoice for the specified adjustment.


Same here I think anything with an href="" in the XML will become a Recurly_Stub in the object.

drewish · 2016-09-27T15:26:51Z

lib/recurly/billing_info.php

+ * class Recurly_BillingInfo
+ * @property string $account_code Account's unique code.
+ * @property string $token_id A token generated by Recurly.js
+ * @property string $currency Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.


There's definitely more properties on this object: https://dev.recurly.com/docs/create-an-accounts-billing-info-credit-card

Thanks, I added the missing fields.

drewish · 2016-09-27T15:29:03Z

lib/recurly/plan.php

+ * class Recurly_Plan
+ * @property string $plan_code Unique code to identify the plan. This code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 50 characters.
+ * @property string $name Plan name. Max of 255 characters.
+ * @property array of objects $unit_amount_in_cents Array of currency objects, see example below. Max 10000000.


So this one is showing the limits of the site we use for docs. In PHP land it's a Recurly_CurrencyList so this makes me wonder if we should just list the properties and a type but not bother with copying over the descriptions.

phpdave · 2016-09-27T16:58:18Z

I think the descriptions bring a lot of value to the developer as they can instantly see what that field is. I was hoping the documentation scraper could be enchanced and reused https://gist.github.com/phpdave/0804dec42e88a9ae192db73eaba7ff27.
Agreed that URLs need to be of type Recurly_Stub
Yea there is some weirdness as you pointed out with unit_amount_in_cents being of type Recurly_CurrencyList. The question is will the developer realize its a bunch of non-sense and go digging for answers. This is probably the exception not the rule? Perhaps maintain an exception array in the scraper to override the description for problematic documentation... Without knowing much about your internal systems I'll probably have to leave it up to you to decide if the descriptions should stay and be maintained. A great addition will just being able to see the field names in intellisense and each thing we add on top of that just makes the developers job a little easier.

What intellisense looks like now:

drewish · 2016-09-27T17:52:53Z

Oh looks like there's a conflict in transaction.php could you rebase this on master?

phpdave · 2016-09-27T18:53:21Z

@drewish Is there an easy way to rebase via the github website, i don't have this pulled down... I did fix the transaction class to be identical to the main branch but it still is reporting a conflict. ecd6440

Would opening a new PR work?

UPDATE: working on rebasing

Conflicts: lib/recurly/transaction.php

phpdave · 2016-09-27T19:34:43Z

@drewish rebased! Wow what an awful experience.... I'll have to make sure i update my forks before making edits.

"This branch has no conflicts with the base branch"

phpdave · 2016-09-27T20:06:34Z

Fixed some of the types and added a missing * to enable the intellisense in a few files.

drewish · 2016-09-27T21:01:57Z

What you've got here looks pretty good to me. You okay if I merge what's here or were you wanting to get other object types?

drewish · 2016-09-27T21:04:41Z

Oh one request. Could you make the top of the CHANGELOG read:

# Recurly PHP Client Library CHANGELOG

## Unreleased

* Added property documentation to several classes (thanks to [phpdave](https://github.com/phpdave)) [#278](https://github.com/recurly/recurly-client-php/pull/278)

## Version 2.7.0 (September 15th, 2016)

drewish

Looks good. Happy to add in other stuff if you'd like to provide them.

phpdave · 2016-09-27T21:49:53Z

Thanks for doing the merge!

Just added invoice and subscriptions but maybe we'll do that another day.

https://github.com/phpdave/recurly-client-php/blob/master/lib/recurly/invoice.php
https://github.com/phpdave/recurly-client-php/blob/master/lib/recurly/subscription.php

drewish · 2016-09-27T23:51:00Z

Yeah few free to queue them up and we can do another PR

phpdave added 8 commits September 26, 2016 23:15

Update transaction.php

8441a34

Update transaction.php

3d0f21c

Update transaction.php

e4396ba

Update transaction.php

6950eae

Update account.php

017383e

Update adjustment.php

5f8a0c2

Update billing_info.php

042ab50

Update plan.php

289fd2e

phpdave mentioned this pull request Sep 27, 2016

Enhancement: Enable IntelliSense (IDE friendly) for class properties #277

Closed

drewish reviewed Sep 27, 2016

View reviewed changes

phpdave added 4 commits September 27, 2016 13:00

Update account.php

8444ab9

Update adjustment.php

3f0ce67

Update transaction.php

5170424

Update billing_info.php

a4c8bb5

Update transaction.php

ecd6440

phpdave added 12 commits September 27, 2016 15:05

Update transaction.php

988c269

Update transaction.php

48a61e1

Update transaction.php

e054ae0

Update transaction.php

2fd71eb

Update account.php

a8387c4

Update adjustment.php

2d3ce69

Update billing_info.php

561e568

Update plan.php

e209126

Update account.php

ac030aa

Update adjustment.php

01c9435

Update transaction.php

5d7ceda

Update billing_info.php

09a9475

Merge branch 'master' of https://github.com/phpdave/recurly-client-php

aab63ae

Conflicts: lib/recurly/transaction.php

phpdave added 7 commits September 27, 2016 15:45

Update account.php

2405439

Update adjustment.php

7c5b9b9

Update adjustment.php

77eb093

Update billing_info.php

b82fdd0

Update plan.php

d0f557f

Update transaction.php

e2cddd6

Update account.php

361f734

Update CHANGELOG.md

00cdce6

drewish approved these changes Sep 27, 2016

View reviewed changes

drewish merged commit 0ad19a0 into recurly:master Sep 27, 2016

bhelx mentioned this pull request Jan 9, 2017

Bump 2.7.1 #292

Merged

bhelx added the V2 V2 Client label Mar 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancement: Enable IntelliSense (IDE friendly) for class properties #278

Enhancement: Enable IntelliSense (IDE friendly) for class properties #278

phpdave commented Sep 27, 2016

drewish left a comment

drewish Sep 27, 2016 •

edited

Loading

drewish Sep 27, 2016

drewish Sep 27, 2016

phpdave Sep 27, 2016

drewish Sep 27, 2016

phpdave commented Sep 27, 2016

drewish commented Sep 27, 2016

phpdave commented Sep 27, 2016 •

edited

Loading

phpdave commented Sep 27, 2016

phpdave commented Sep 27, 2016

drewish commented Sep 27, 2016

drewish commented Sep 27, 2016

drewish left a comment

phpdave commented Sep 27, 2016 •

edited

Loading

drewish commented Sep 27, 2016

Enhancement: Enable IntelliSense (IDE friendly) for class properties #278

Enhancement: Enable IntelliSense (IDE friendly) for class properties #278

Conversation

phpdave commented Sep 27, 2016

drewish left a comment

Choose a reason for hiding this comment

drewish Sep 27, 2016 • edited Loading

Choose a reason for hiding this comment

drewish Sep 27, 2016

Choose a reason for hiding this comment

drewish Sep 27, 2016

Choose a reason for hiding this comment

phpdave Sep 27, 2016

Choose a reason for hiding this comment

drewish Sep 27, 2016

Choose a reason for hiding this comment

phpdave commented Sep 27, 2016

drewish commented Sep 27, 2016

phpdave commented Sep 27, 2016 • edited Loading

phpdave commented Sep 27, 2016

phpdave commented Sep 27, 2016

drewish commented Sep 27, 2016

drewish commented Sep 27, 2016

drewish left a comment

Choose a reason for hiding this comment

phpdave commented Sep 27, 2016 • edited Loading

drewish commented Sep 27, 2016

drewish Sep 27, 2016 •

edited

Loading

phpdave commented Sep 27, 2016 •

edited

Loading

phpdave commented Sep 27, 2016 •

edited

Loading