Download the PHP package codexsoft/transmission-schema without Composer
On this page you can find all versions of the php package codexsoft/transmission-schema. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codexsoft/transmission-schema
More information about codexsoft/transmission-schema
Files in codexsoft/transmission-schema
Package transmission-schema
Short Description Schema configuration, validation and normalization part of CodexSoft Transmission PHP Library for building HTTP JSON API
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 transmission-schema
CodexSoft Transmission
Compact extendable library to build HTTP API based on JSON.
Provides normalization and validation features based on top of symfony/validator component.
Installation
Why
Suppose we have incoming data like this in our controller:
- How will we check that
petspresent in$input? - How will we check that
nameis not empty or contains at least 3 symbols? - How will we check that
emailis formally correct? - How will we check that
petshas at least one pet? - How will we check that
pets[n].kindcontains one of allowed values (15, 34, 42)? - How will we handle these violations and generate error response?
This library allows to do this:
That's it! We have now normalized data that we can process further.
Introduction
This library supports numerous scalar data type definitions and two complex type definitions: arrays
("collections") and hash ("json") out the box. Data type definition called Element in this library.
You can add your own data types by extending AbstractElement class.
To use specific element you should first instantiate it by just calling:
or by using Accept fascade:
Every element has some basic attributes:
- is it nullable or not
- is it required or not
- what is default value for optional elements
- should be value type strictly match element data type or can be automatically converted
- is it deprecated* or not
- label* (or, comment)
More specific elements have more specific attributes. For example: minimal length for strings, max value for integer, can be string blank, etc.
When strict type check enabled for integer, '42' will generate violation for this element.
List of all built-in elements:
| Element | Value example |
|---|---|
| BoolElement | true, false |
| CollectionElement | [1, 2, 3] |
| DateElement | '2020-05-25' |
| DateTimeElement | '2020-05-10 12:34:56' |
| EmailElement | '[email protected]' |
| FloatElement | 42.4 |
| IntegerElement | 42 |
| JsonElement | ['hello' => 'world'] |
| NumberElement | 42.4, 55 |
| ScalarElement | 'hello', 42, true |
| StringElement | 'hello world' |
| TimeElement | '12:34:56' |
| TimestampElement | 1541508448 |
| UrlElement | https://example.com |
| UuidElement | 'a8d8f871-481f-436f-b22f-6598f89635ca' |
Usage
Basic normalizing for boolean data.
labelanddeprecatedattributes exists for historical reasons, because this library started as unified schema description for further OpenApi schema generation (check codexsoft/transmission-openapi3).
Always check violations count before using normalized data, as
in that case original input data will be stored in result.data.
No exceptions are trown automatically but you can write a wrapper to force throwing exceptions in case of violations detected or handle this case in another way.
