PHP-binary-tools PR #3 docs#15
Merged
Merged
Conversation
Updated binary tools documentation to reflect changes in integer handling and added support for terminators.
Added support for fixed-size field padding in BinaryString methods.
Added API reference documentation for Binary Tools in PHP, including BinaryString, BinaryWriter, and BinaryReader classes with detailed method descriptions and usage examples.
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.
Refers kduma-OSS/PHP-binary-tools#3
This pull request updates the documentation for the
kduma/binary-toolsPHP library, introducing new features for flexible integer handling and terminator-based parsing, and refactoring usage examples and API descriptions to reflect these enhancements. The changes modernize the API, add support for more binary protocols, and clarify the distinction between string and binary data operations.Core API and Feature Enhancements
IntTypeenum, which allows configurable byte order and signedness for all integer operations. All relevant examples and method signatures now useIntTypeinstead of hardcoded types. [1] [2] [3] [4] [5] [6] [7] [8] [9]Terminatorenum and updated examples to demonstrate usage. [1] [2] [3] [4] [5] [6] [7]Documentation and Example Improvements
writeInt,readInt,writeStringWith, andreadStringWithmethods, showing how to handle various integer types and terminator-based parsing. Deprecated older methods and provided migration guidance. [1] [2] [3] [4] [5] [6]IntTypeandTerminator, including supported types, byte sizes, endianness, and available terminator values for binary parsing. [1] [2]API Reference and Migration Notes
These changes make the library more robust for protocol work and clarify usage for both binary and text data.