Download the PHP package exorg/data-coder without Composer
On this page you can find all versions of the php package exorg/data-coder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download exorg/data-coder
More information about exorg/data-coder
Files in exorg/data-coder
Package data-coder
Short Description Expansible Universal Data and Data Files Decoder/Encoder.
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 data-coder
DataCoder
Extendable set of data and data file encoders and decoders. It allows to transfer PHP arrays into data strings and datafiles and vice versa with chosen format like YAML and JSON. It provides encapsulation of various decoding and encoding mechanisms, unifies interface and exceptions handling.
There are various groups of decoders and encoders
- With predefined data format - e.g. Coder\Json\Data\Decoder, Coder\Yaml\Datafile\Encoder
- With configurable data format - e.g. Coder\Data\Decoder, Coder\Datafile\Encoder
- For raw data - e.g. Coder\Json\Data\Decoder, Coder\Data\Encoder
- For data in the file - e.g. Coder\Yaml\Datafile\Encoder, Coder\Datafile\Decoder
Getting Started
Prerequisities
The instruction assumes using the Linux operating system or compatible tools for other operating systems.
Installation
php8.*-cli, Git and Composer required
The recommended way to install DataCoder into the source code of the project is to handle it as code dependency by Composer. Git is needed to fetch packages from version control repositories.
The php8.*-cli is needed for installing Composer.
DataCoder installation
Add to your composer.json file appropriate entry by running the following command
If it's project set-up stage and no one dependency have been installed yet, run
If another dependencies have been intalled previously, run
Usage
The simplest way to autoload all needed files in executable file is attaching autoload.php file generated by Composer (after running composer install or composer update command) like in following example
Data Encoders with predefined format
Data Decoders with predefined format
Data Encoder with configurable format
Data Decoder with configurable format
Datafile Encoders and Decoders
Datafile Encoders and Decoders usage is similar to the Data Encoders and Decoders. There are coders with predefined data format like Coder\Json\Datafile\Encoder or Coder\Yaml\Datafile\Decoder and those, where data format can be chosen by function setDataFormat, just like in examples above - Code\Datafile\Encoder and Code\Datafile\Decoder.
Data format recognizing by file extension
Datafile coders with configurable data format - Coder\Datafile\Encoder and Coder\Datafile\Decoder - can recognize data format by file extension. In that case, there is no need to set data format manually.
Datafile Encoder
Datafile Decoder
Tests
Unit tests
This project has unit tests, which has been built with PHPUnit framework and run on Linux operating system.
To run tests, write the following command in your command line inside the main DataCoder project directory
or use a Composer script
Code style tests
This code follows PSR-1 and PSR-12 standards.
To run tests for code style write the following command in your command line inside the main DataCoder project directory
or use a Composer script
You can also use a Composer script for running both tests and check code style
Built with
Versioning
This project is versioning according to SemVer versioning standars. All available releases are tagged.
Contributing
Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.
Author
- Katarzyna Krasińska - katheroine, ExOrg
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
