Migrate package enums to native PHP backed enums - #483
Open
JonPurvis wants to merge 2 commits into
Open
Conversation
JonPurvis
marked this pull request as ready for review
June 13, 2026 15:48
This file contains hidden or 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.
This PR replaces
EnumTraitclasses, from thefuneralzone/valueobjectspackage, with native PHP backed enums that were introduced in PHP 8.1, now that the package requires that version as a minimum. We still requirefuneralzone/valueobjectsfor Value objects (ShopId,AccessToken,ShopDomain, etc.). There's multiple reasons we should do this:This change will most likely have to be a major version bump. If apps reference enums directly, then they will break (update instructions at the bottom of this comment)!
Changes
stringorintbacking as appropriate)ChargeStatus::ACTIVE()is nowChargeStatus::ACTIVE$enum->toNative()is now$enum->value$a->isSame($b)is now$a === $bChargeStatus::ACTIVE, notActive) to minimise breaking changes. Whilst the general consensus is that enums should be CamelCase, I didn't think it was worth changing this.fromNative()kept but marked@deprecatedon all enums. Folks should useEnum::from()/Enum::tryFrom()going forward.fromNative()could be removed in a later version.ChargeStatus::fromShopifyApiStatus()retained as a domain helperBacking values
Enum
->valuematches legacytoNative()output (constant name strings), not the old internal int constants.->valueChargeStatus,PlanType,AuthMode, etc.string"ACTIVE","RECURRING"ThemeSupportLevel,SessionTokenSourceint0,1,2Breaking changes
Apps that reference package enums directly will need to update:
ChargeStatus::ACTIVE()ChargeStatus::ACTIVE$status->toNative()$status->value$a->isSame($b)$a === $bChargeStatus::fromNative('ACTIVE')ChargeStatus::from('ACTIVE')(deprecated shim still works for now)