Improved php type hints #1794
Merged
Improved php type hints #1794
+1,390
−1,390
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can we add a changelog entry? |
prathmesh-stripe
force-pushed
the
prathmesh/improved-php-type-hints
branch
from
fecce93 to
02b76c0
Compare
helenye-stripe
approved these changes
Dec 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issues:
#1787
#1740
Changelog
Adds Create/Update/Retrieve/Delete/All/Search parameters
You will now be able to get type hints of the keys that can passed without switching out of your IDE. Eg.
* @param null|array{customer:string, components: array} $paramsUpdated StripeObject class properties
We changed the type of class properties from
StripeObjectto something more specific.For example: Invoice settings was defined as a StripeObject in Customer resource.
stripe-php/lib/Customer.php
Line 25 in bae10cd
Now you will be able to reference
custom_fieldsandrendering_optionsoncustomer->invoice_settingswithout PHPStan complaining.* @property object{custom_fields: null|object{name: string, value: string}&\Stripe\StripeObject&\stdClass[], default_payment_method: null|string|\Stripe\PaymentMethod, footer: null|string, rendering_options: null|object{amount_tax_display: null|string, template: null|string}&\Stripe\StripeObject&\stdClass}&\Stripe\StripeObject&\stdClass $invoice_settings */