Download the PHP package golded-dev/laravel-ftn without Composer
On this page you can find all versions of the php package golded-dev/laravel-ftn. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download golded-dev/laravel-ftn
More information about golded-dev/laravel-ftn
Files in golded-dev/laravel-ftn
Package laravel-ftn
Short Description Shared FTN message-base reader contracts and value objects.
License MIT
Homepage https://github.com/golded-dev/laravel-ftn
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-ftn
Laravel FTN
Shared FTN/FidoNet reader contracts, value objects, and small parsing helpers for PHP 8.4.
Concrete reader packages use this as their common language.
It does not read Squish, JAM, Hudson, or any other message base by itself. That is deliberate. This package is the shared core, not the reader.
Installation
Requires PHP 8.4+.
What You Get
MessageBaseReader: interface for classes that read messages from a source path.MessageSourceCatalog: interface for classes that list readable message sources.MessageWriter: interface for classes that write outgoing messages.MessageSourceLocator: interface for resolving a message source path.FtnAddress: readonly value object for full FTN addresses.ParsedMessage: readonly value object for normalized message data.ParsedArea: readonly value object for message area metadata.OutgoingMessage: readonly value object for messages handed to writers.ReaderOptions: shared reader options.WriterOptions: shared writer options.MessageControlLines: parsed FTN control-line metadata.MessageProvenance: source metadata for imported messages.CharsetDetector: detects FTN charset kludges such asCHRSandCHARSET.MojibakeRepairer: repairs common FTN mojibake when the signal is strong enough.ControlLines: extracts selected FTN control lines.Text: helper methods for null-padded fields, body normalization, encoding conversion, and synthetic IDs.
What You Do Not Get
- No concrete message-base reader.
- No concrete message writer.
- No Laravel service provider.
- No database models.
- No queues, commands, config publishing, or framework bootstrapping.
If you need a real reader, build it in a package that depends on this one.
Reading Messages
Concrete reader packages implement MessageBaseReader.
Use MessageSourceCatalog when a reader package can list areas, folders, or other readable sources:
Consumers should depend on the contracts and DTOs, not on a concrete storage format.
Reader Options
CP850 is the default fallback because old FTN message bases are not UTF-8-first.
FTN Addresses
fromString() throws when the address is invalid. tryFromString() returns null.
Parsed Messages
ParsedMessage is a readonly DTO. Reader implementations fill what the source format knows and leave unknown optional fields as null.
Reader packages may attach MessageControlLines and MessageProvenance when the source format exposes them.
Writing Messages
MessageWriter is a contract only. This package defines the shape of outgoing messages, not how a format stores them.
Concrete packages own charset conversion, wrapping, storage rules, and format details.
Charset Detection
FTN messages often carry charset information in control lines:
Unknown charset names use the configured fallback:
Mojibake Repair
FTN messages often contain text decoded through the wrong charset. MojibakeRepairer fixes the common cases when the repaired text clearly scores better than the original.
It handles DOS glyph damage, UTF-8-as-Latin-1 damage, and RFC 2047 encoded words.
It does not decide when a UI should apply repairs, expose toggles, or rewrite stored source text. That belongs in the consuming app.
Text Helpers
Use these helpers instead of scattering string parsing through concrete readers.
Control Lines
extractMsgid() returns the trimmed MSGID value, or null.
Use parseMessage() when you need the structural control-line metadata:
parseMessage() does not convert charsets, rewrite the body, or expand abbreviated routing lines. SEEN-BY and PATH values stay raw because resolving them needs source context.
Development
Install dependencies:
Run tests:
Run static analysis:
Run Rector dry-run:
Run everything:
Versioning
This package starts at 1.0.0 and uses semantic versioning.
Breaking changes include:
- changing public interface signatures
- changing required DTO constructor parameters
- changing constructor parameter order
- changing default reader options
Adding optional DTO fields is usually a minor release.
Contributing
Contributions are welcome when they keep the package small and portable. See CONTRIBUTING.md.
Security
Do not report security issues in public tickets. See SECURITY.md.
Code Of Conduct
Be direct, useful, and not a pain on purpose. See CODE_OF_CONDUCT.md.
Changelog
See CHANGELOG.md.
License
Released under the MIT License. See LICENSE.
