Repository navigation
docs: name the third Transition parameter as the transition name, not the new state - #2607
Merged
Su (sushmangupta) merged 2 commits intoOct 14, 2026
Merged
Conversation
… the new state Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Developer Docs healthcheckStatus: Completed with |
Su (sushmangupta)
approved these changes
Oct 14, 2026
Su (sushmangupta)
deleted the
fix/docs-state-machine-transition-parameter
branch
October 14, 2026 14:19
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.
Summary
Transitionas "the new state to be transitioned to. E.g. this could bepaid". The parameter is the name of the transition (action): the state machine looks up the transition with that action name from the current state and derives the resulting state. The guide's own examples (process,do_pay,ship) and its lists of "possible transition values" show this.Transitionhas a fifth, optional parameter ($internalComment).Related links
Docs (at
origin/main70b7d45):using-the-state-machine.md L49-50("The third parameter is the new state to be transitioned to. E.g. this could bepaid, if the order is stillopen."),using-the-state-machine.md L51("The last parameter is the name of theStateMachineStateField."), and the section Forcing a transition L172-L175 ("the transition name is interpreted as the target state's technical name").Platform source (tag
v6.7.15.1):Transition.php L11-15: constructor parameters in order$entityName,$entityId,$transitionName,$stateFieldName,?$internalComment = null.StateMachineRegistry.php L169-174:getTransitionDestinationById(..., $transition->getTransitionName(), ...); L339:if ($transition->getActionName() !== $transitionName) { continue; }(the name is matched against the transitions' action names); L383-L387: only with theFORCE_TRANSITIONcontext state is the name searched as a statetechnicalName.StateMachineTransitionActions.phpL10-L31: the action names (cancel,process,ship, ...).Checklist
PageRefreferences where relevant. (The anchor#forcing-a-transitionmatches the heading at L172;rumdl@0.2.67passes.).gitbook.yamlif pages were moved, renamed, or deleted. (N/A, no page moved.).wordlist.txt(and sorted it) if spellcheck flags new legitimate terms. (No new prose words outside code spans; checked against.wordlist.txt; the docker spellcheck image could not be run locally.)Notes
main(Shopware 6.7) only. Checked against the platform tagv6.7.15.1(the latest 6.7 tag when this was written). Older versions have their own docs branches and are not touched here.payaction" is covered by docs: use the process action instead of do_pay in the order transaction state machine guide (6.7) #2587; L140 says you cannotrefunda delivery that was never shipped, but the delivery transition list has no refund action; the page's source links point at the stale tagv6.3.4.1; the helper-method list near the end omits some current methods.getTransitionDestinationByIdabove, not on execution.🤖 Generated with Claude Code