cse / helpers-json
The helpers allows you to JSON processing. Encode, decode, check error, throw exception - all this is available in this library.
Requires
- php: >=7.1
- cse/base-exceptions: *
Requires (Dev)
README
English | Русский
JSON CSE HELPERS
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
$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 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 was created for the rapid development of web applications.
CSE Helpers project:
- Array CSE helpers
- Cookie CSE helpers
- Date CSE helpers
- Email CSE helpers
- IP CSE helpers
- Json CSE helpers
- Math Converter CSE helpers
- Phone CSE helpers
- Request CSE helpers
- Session CSE helpers
- Word CSE helpers
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.
Composer
Execute the following command to get the latest version of the package:
composer require cse/helpers-json
Or file composer.json should include the following contents:
{ "require": { "cse/helpers-json": "*" } }
Git
Clone this repository locally:
git clone https://github.com/cs-eliseev/helpers-json.git
Download
Download the latest release here.
Usage
The class consists of static methods that are conveniently used in any project. See example examples-json.php.
JSON ENCODE
Example:
Json::encode(['example' => 12345]); // {"example": 12345}
Set Check Exception:
Json::setCheckException(); Json::encode([urldecode('bad utf string %C4_')]); // Exception: Malformed UTF-8 characters, possibly incorrectly encoded
JSON Pretty Print
Example:
Json::prettyPrint(['example' => 12345, 'example2' => 56789]); // { // "example": 12345, // "example": 56789 // }
Set Check Exception:
Json::setCheckException(); Json::prettyPrint([urldecode('bad utf string %C4_')]); // Exception: Malformed UTF-8 characters, possibly incorrectly encoded
JSON DECODE
Example:
Json::decode('{"example": 12345}'); // ['example' => 12345]
Set Check Exception:
Json::setCheckException(); Json::decode("{'example': 12345}"); // Syntax error
GET JSON data to key
Example:
Json::get('{"example": 12345}', 'example'); // 12345
Set default data:
Json::get('{"example": 12345}', 'example2', 56789); // 56789
Set Check Exception:
Json::setCheckException(); Json::get("{'example': 12345}", 'example'); // Syntax error
SET JSON data
Example:
Json::set('{"example": 12345}', 'example2', 56789); // {"example": 12345, "example2": 56789}
Change value:
Json::set('{"example": 12345}', 'example', 56789); // {"example": 56789}
Set Check Exception:
Json::setCheckException(); Json::set("{'example': 12345}", 'example2', 56789); // Syntax error
SET ARRAY JSON
Example:
Json::setArray('{"example": 12345}', ['example2' => 56789]); // {"example": 12345, "example2": 56789}
Change value:
Json::setArray('{"example": 12345}', ['example' => 56789]); // {"example": 56789}
Set Check Exception:
Json::setCheckException(); Json::setArray("{'example': 12345}", ['example2' => 56789]); // Syntax error
Check error last json transform
Example:
Json::decode('{"example": 12345}'); Json::isNoteError(); // true Json::decode("{'example': 12345}"); Json::isNoteError(); // false
Get error
Example:
Json::decode('{"example": 12345}'); Json::getErrorMsg(); // NULL Json::decode("{'example': 12345}"); Json::getErrorMsg(); // Syntax error
Add msg:
Json::decode("{'example': 12345}"); Json::getErrorMsg('- Example'); // Syntax error - Example
Error to exception
Example:
try { Json::decode("{'example': 12345}"); Json::errorToException(); } catch (CSEHelpersJsonException $e) { var_dump($e->getMessage()); } // Syntax error
Add msg:
try { Json::decode("{'example': 12345}"); Json::errorToException('(JSON)'); } catch (CSEHelpersJsonException $e) { var_dump($e->getMessage()); } // Syntax error (JSON)
Exception instance:
try { Json::decode("{'example': 12345}"); Json::errorToException('(JSON)'); } catch (CseExceptions $e) { var_dump($e->getMessage()); } // Syntax error (JSON)
Set check exception
Example:
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:
phpunit PATH/TO/PROJECT/tests/
If you want code coverage reports, use the following:
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
Used PHPUnit default config:
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
Donating
You can support this project here. 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 for more information.
GitHub @cs-eliseev