fix: use correct @property syntax for all models (fixes #926) #927
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
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.
I whipped up some sloppy regular expressions and fixed most of this automatically, although the formatting wasn't entirely consistent so I had to clean up some mess afterwards.
Note that you can't actually mark a magic
@propertyas@deprecatedin PHPDoc syntax, so I've just written "Deprecated: this property has been removed from the Xero API." in those properties' descriptions instead. I think this may not be ideal - if those properties have indeed been removed from Xero's API entirely, and trying to access them using xero-php will error, then the magic properties should probably be removed from xero-php as well. That way, tooling like PHPStan will know the property no longer exists and alert users that are still trying to use it. If those properties are technically deprecated but still safe to access, then it's fine to keep them in xero-php with a note indicating they were deprecated.