Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cs-eliseev/helpers-json
The helpers allows you to JSON processing. Encode, decode, check error, throw exception - all this is available in this library.
https://github.com/cs-eliseev/helpers-json
collection collections cse framework helper helpers json library php tool tools utilities utility utils
Last synced: 20 days ago
JSON representation
The helpers allows you to JSON processing. Encode, decode, check error, throw exception - all this is available in this library.
- Host: GitHub
- URL: https://github.com/cs-eliseev/helpers-json
- Owner: cs-eliseev
- License: mit
- Created: 2019-01-18T05:17:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-05T16:38:26.000Z (over 5 years ago)
- Last Synced: 2024-05-01T06:04:01.843Z (8 months ago)
- Topics: collection, collections, cse, framework, helper, helpers, json, library, php, tool, tools, utilities, utility, utils
- Language: PHP
- Size: 85.9 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
English | [Русский](https://github.com/cs-eliseev/helpers-json/blob/master/README.ru_RU.md)
JSON CSE HELPERS
=======
[](https://travis-ci.org/cs-eliseev/helpers-json)
[](https://codecov.io/gh/cs-eliseev/helpers-json)
[](https://scrutinizer-ci.com/g/cs-eliseev/helpers-json/?branch=master)
[](https://packagist.org/packages/cse/helpers-json)
[](https://packagist.org/packages/cse/helpers-json)
[](https://github.com/cs-eliseev/helpers-json/blob/master/LICENSE.md)
[](https://github.com/cs-eliseev/helpers-json/archive/master.zip)
The helpers allows you to JSON processing. Encode, decode, check error, throw exception - all this is available in this library.
Project repository: https://github.com/cs-eliseev/helpers-json
**DEMO**
```php
$json = [
'{"example": 12345}', // success
"{'example': 12345}", // Syntax error
'{"example": 12345}', // success
];
foreach ($json as $item) {
try {
Json::decode($item);
Json::errorToException();
var_dump('success');
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
}
```
***
## Introduction
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) is a collection of several libraries with simple functions written in PHP for people.
Despite using PHP as the main programming language for the Internet, its functions are not enough.
JSON CSE HELPERS used method: encode, decode, check error, throw exception.
[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.
**CSE Helpers project:**
* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)
* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)
* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)
* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)
* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)
* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)
* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)
* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)
* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)
* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)
* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)
Below you will find some information on how to init library and perform common commands.
## Install
You can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-json).
### Composer
Execute the following command to get the latest version of the package:
```bash
composer require cse/helpers-json
```
Or file composer.json should include the following contents:
```json
{
"require": {
"cse/helpers-json": "*"
}
}
```
### Git
Clone this repository locally:
```bash
git clone https://github.com/cs-eliseev/helpers-json.git
```
### Download
[Download the latest release here](https://github.com/cs-eliseev/helpers-json/archive/master.zip).
## Usage
The class consists of static methods that are conveniently used in any project.
See example [examples-json.php](https://github.com/cs-eliseev/helpers-json/blob/master/examples/examples-json.php).
**JSON ENCODE**
Example:
```php
Json::encode(['example' => 12345]);
// {"example": 12345}
```
Set Check Exception:
```php
Json::setCheckException();
Json::encode([urldecode('bad utf string %C4_')]);
// Exception: Malformed UTF-8 characters, possibly incorrectly encoded
```
**JSON Pretty Print**
Example:
```php
Json::prettyPrint(['example' => 12345, 'example2' => 56789]);
// {
// "example": 12345,
// "example": 56789
// }
```
Set Check Exception:
```php
Json::setCheckException();
Json::prettyPrint([urldecode('bad utf string %C4_')]);
// Exception: Malformed UTF-8 characters, possibly incorrectly encoded
```
**JSON DECODE**
Example:
```php
Json::decode('{"example": 12345}');
// ['example' => 12345]
```
Set Check Exception:
```php
Json::setCheckException();
Json::decode("{'example': 12345}");
// Syntax error
```
**GET JSON data to key**
Example:
```php
Json::get('{"example": 12345}', 'example');
// 12345
```
Set default data:
```php
Json::get('{"example": 12345}', 'example2', 56789);
// 56789
```
Set Check Exception:
```php
Json::setCheckException();
Json::get("{'example': 12345}", 'example');
// Syntax error
```
**SET JSON data**
Example:
```php
Json::set('{"example": 12345}', 'example2', 56789);
// {"example": 12345, "example2": 56789}
```
Change value:
```php
Json::set('{"example": 12345}', 'example', 56789);
// {"example": 56789}
```
Set Check Exception:
```php
Json::setCheckException();
Json::set("{'example': 12345}", 'example2', 56789);
// Syntax error
```
**SET ARRAY JSON**
Example:
```php
Json::setArray('{"example": 12345}', ['example2' => 56789]);
// {"example": 12345, "example2": 56789}
```
Change value:
```php
Json::setArray('{"example": 12345}', ['example' => 56789]);
// {"example": 56789}
```
Set Check Exception:
```php
Json::setCheckException();
Json::setArray("{'example': 12345}", ['example2' => 56789]);
// Syntax error
```
**Check error last json transform**
Example:
```php
Json::decode('{"example": 12345}');
Json::isNoteError();
// true
Json::decode("{'example': 12345}");
Json::isNoteError();
// false
```
**Get error**
Example:
```php
Json::decode('{"example": 12345}');
Json::getErrorMsg();
// NULL
Json::decode("{'example': 12345}");
Json::getErrorMsg();
// Syntax error
```
Add msg:
```php
Json::decode("{'example': 12345}");
Json::getErrorMsg('- Example');
// Syntax error - Example
```
**Error to exception**
Example:
```php
try {
Json::decode("{'example': 12345}");
Json::errorToException();
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
// Syntax error
```
Add msg:
```php
try {
Json::decode("{'example': 12345}");
Json::errorToException('(JSON)');
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
// Syntax error (JSON)
```
Exception instance:
```php
try {
Json::decode("{'example': 12345}");
Json::errorToException('(JSON)');
} catch (CseExceptions $e) {
var_dump($e->getMessage());
}
// Syntax error (JSON)
```
**Set check exception**
Example:
```php
class Default
{
public function example(): void
{
Json::encode('{"example": 12345}');
}
}
class ExceptionTrue
{
public function example(): void
{
Json::setCheckException();
Json::encode("{'example': 12345}");
}
}
class ExceptionFalse
{
public function example(): void
{
Json::setCheckException(false);
Json::encode("{'example': 12345}");
}
}
$default = new Default();
$e_true = new ExceptionTrue();
$e_false = new ExceptionFalse();
try {
$default->example();
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
try {
$e_true->example();
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
// Syntax error
try {
$default->example();
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
// Syntax error
try {
$e_false->example();
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
try {
$default->example();
} catch (CSEHelpersJsonException $e) {
var_dump($e->getMessage());
}
```
## Testing & Code Coverage
PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.
General PHPUnit documentation can be found at https://phpunit.de/documentation.html.
To run the PHPUnit unit tests, execute:
```bash
phpunit PATH/TO/PROJECT/tests/
```
If you want code coverage reports, use the following:
```bash
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
```
Used PHPUnit default config:
```bash
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
```
## Donating
You can support this project [here](https://www.paypal.me/cseliseev/10usd).
You can also help out by contributing to the project, or reporting bugs.
Even voicing your suggestions for features is great. Anything to help is much appreciated.
## License
The JSON CSE HELPERS is open-source PHP library licensed under the MIT license. Please see [License File](https://github.com/cs-eliseev/helpers-json/blob/master/LICENSE.md) for more information.
***
> GitHub [@cs-eliseev](https://github.com/cs-eliseev)