Download the PHP package rollerworks/uri-encoder without Composer
On this page you can find all versions of the php package rollerworks/uri-encoder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rollerworks/uri-encoder
More information about rollerworks/uri-encoder
Files in rollerworks/uri-encoder
Package uri-encoder
Short Description A simple library, to safely encode a string for usage in a URI.
License MIT
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 uri-encoder
Rollerworks UriEncoder
This package provides the Rollerworks UriEncoder component, a simple library, to safely encode a string for usage in a URI. Plus a zlib compression.
Caution:
Do not use this library for encoding authorization/reset tokens, as this will leak information. Only use this library to transport "public" information, like a filtering preference.
Use paragonie/constant_time_encoding for time-safe en/decoding. Don't use conversion caching or compression for sensitive information!
Installation
To install this package, add rollerworks/search-uri-encoder to your composer.json:
Now, Composer will automatically download all required files, and install them for you.
Requirements
You need at least PHP 8.1, and optionally have support for gzip compression enabled.
This package has no other external dependencies.
Basic usage
The usage of this library is very straightforward, each encoder encodes and decodes a URL string.
To encode a string for safe usage in a URL call encodeUri() on the encoder.
To decode an encoded string, to the original value call decodeUri() on the encoder.
Note: The decode() method will silently ignore invalid data,
and return null instead.
Base64UriEncoder
Decorators
To keep the encoders small special features are provided in the form of object decorators.
A decorator operates on top of the actual encoder.
encodeUri()modifies the value returned by the decorated encoder.decodeUri()modifies the passed-in value before passing to the decorated encoder.
These decorators cannot be used as a stand-alone.
GZipCompressionDecorator
The GZipCompressionDecorator (de)compresses URI data.
Caution: The GZipCompressionDecorator creates a non-safe binary result,
make sure the original encoder supports this.
Versioning
For transparency and insight into the release cycle, and for striving to maintain backward compatibility, this package is maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
<major>.<minor>.<patch>
And constructed with the following guidelines:
- Breaking backward compatibility bumps the major (and resets the minor and patch)
- New additions without breaking backward compatibility bumps the minor (and resets the patch)
- Bug fixes and misc changes bumps the patch
For more information on SemVer, please visit http://semver.org/.
License
This library is released under the MIT license.
Contributing
This is an open source project. If you'd like to contribute, please read the Contributing Guidelines. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section.ß
