Tighten and modernise the public API - #156
Merged
Merged
Conversation
…entKeyException for missing token keys
…lel-array tuple with MatcherMatch
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 tightens the public API and moves the code to modern PHP property syntax:
StateInterface,NodeInterface,NodeVisitorInterfaceandTokenInterfacedeclare native return types.findMatchingToken()returnsTokenInterfaceinstead ofTokenInterface|false, andleaveNode()returnsNodeInterface|NodeVisitorAction|null.VisitableInterface::accept()takes aVisitorInterfaceand returnsmixed. The visitor interfaces have docblocks explaining how to extend them.Token::getValue()throwsNonexistentKeyExceptionfor a missing key.StateInterfacedropsrunMatchers(), andAbstractState's matching internals are private. Matches are held as small internalMatcherMatchobjects instead of three parallel arrays.Lexer::pushState()replacessetState(), which remains as a deprecated alias.readonlyand constructor promotion where they fit.Breaking changes: implementations of these interfaces need the new return types, including
leaveNode()in visitors andaccept()in visitable nodes. Subclasses ofAbstractStatecan no longer callrunMatchers()orguardAgainstWrongNumberOfMatches(). Subclasses ofAbstractNodethat redeclare$attributesor$nodesmust type them asarray.TokenandMatchedTextnow require arrays for their values.