{"id":22747150,"url":"https://github.com/cs-eliseev/helpers-json","last_synced_at":"2025-07-09T13:39:24.116Z","repository":{"id":56959780,"uuid":"166348157","full_name":"cs-eliseev/helpers-json","owner":"cs-eliseev","description":"The helpers allows you to JSON processing. Encode, decode, check error, throw exception - all this is available in this library.","archived":false,"fork":false,"pushed_at":"2019-05-05T16:38:26.000Z","size":88,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T00:44:43.557Z","etag":null,"topics":["collection","collections","cse","framework","helper","helpers","json","library","php","tool","tools","utilities","utility","utils"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cs-eliseev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-18T05:17:43.000Z","updated_at":"2022-10-01T18:06:11.000Z","dependencies_parsed_at":"2022-08-21T09:50:52.375Z","dependency_job_id":null,"html_url":"https://github.com/cs-eliseev/helpers-json","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-eliseev%2Fhelpers-json","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-eliseev%2Fhelpers-json/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-eliseev%2Fhelpers-json/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-eliseev%2Fhelpers-json/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cs-eliseev","download_url":"https://codeload.github.com/cs-eliseev/helpers-json/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248872138,"owners_count":21175356,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collection","collections","cse","framework","helper","helpers","json","library","php","tool","tools","utilities","utility","utils"],"created_at":"2024-12-11T03:13:24.766Z","updated_at":"2025-04-14T11:33:34.026Z","avatar_url":"https://github.com/cs-eliseev.png","language":"PHP","funding_links":["https://www.paypal.me/cseliseev/10usd"],"categories":[],"sub_categories":[],"readme":"English | [Русский](https://github.com/cs-eliseev/helpers-json/blob/master/README.ru_RU.md)\n\nJSON CSE HELPERS\n=======\n\n[![Travis (.org)](https://img.shields.io/travis/cs-eliseev/helpers-json.svg?style=flat-square)](https://travis-ci.org/cs-eliseev/helpers-json)\n[![Codecov](https://img.shields.io/codecov/c/github/cs-eliseev/helpers-json.svg?style=flat-square)](https://codecov.io/gh/cs-eliseev/helpers-json)\n[![Scrutinizer code quality](https://img.shields.io/scrutinizer/g/cs-eliseev/helpers-json.svg?style=flat-square)](https://scrutinizer-ci.com/g/cs-eliseev/helpers-json/?branch=master)\n\n[![Packagist](https://img.shields.io/packagist/v/cse/helpers-json.svg?style=flat-square)](https://packagist.org/packages/cse/helpers-json)\n[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg?style=flat-square)](https://packagist.org/packages/cse/helpers-json)\n[![Packagist](https://img.shields.io/packagist/l/cse/helpers-json.svg?style=flat-square)](https://github.com/cs-eliseev/helpers-json/blob/master/LICENSE.md)\n[![GitHub repo size](https://img.shields.io/github/repo-size/cs-eliseev/helpers-json.svg?style=flat-square)](https://github.com/cs-eliseev/helpers-json/archive/master.zip)\n\nThe helpers allows you to JSON processing. Encode, decode, check error, throw exception - all this is available in this library.\n\nProject repository: https://github.com/cs-eliseev/helpers-json\n\n**DEMO**\n```php\n$json = [\n    '{\"example\": 12345}',   // success\n    \"{'example': 12345}\",   // Syntax error\n    '{\"example\": 12345}',   // success\n];\n\nforeach ($json as $item) {\n    try {\n        Json::decode($item);\n        Json::errorToException();\n        var_dump('success');\n    } catch (CSEHelpersJsonException $e) {\n        var_dump($e-\u003egetMessage());\n    }\n}\n```\n\n***\n\n## Introduction\n\n[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.\n\nDespite using PHP as the main programming language for the Internet, its functions are not enough.\n JSON CSE HELPERS used method: encode, decode, check error, throw exception.\n\n[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.\n\n**CSE Helpers project:**\n* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)\n* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)\n* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)\n* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)\n* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)\n* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)\n* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)\n* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)\n* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)\n* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)\n* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)\n\nBelow you will find some information on how to init library and perform common commands.\n\n## Install\n\nYou can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-json).\n\n### Composer\n\nExecute the following command to get the latest version of the package:\n```bash\ncomposer require cse/helpers-json\n```\n\nOr file composer.json should include the following contents:\n```json\n{\n    \"require\": {\n        \"cse/helpers-json\": \"*\"\n    }\n}\n```\n\n### Git\n\nClone this repository locally:\n```bash\ngit clone https://github.com/cs-eliseev/helpers-json.git\n```\n\n### Download\n\n[Download the latest release here](https://github.com/cs-eliseev/helpers-json/archive/master.zip).\n\n## Usage\n\nThe class consists of static methods that are conveniently used in any project. \nSee example [examples-json.php](https://github.com/cs-eliseev/helpers-json/blob/master/examples/examples-json.php).\n\n**JSON ENCODE**\n\nExample:\n```php\nJson::encode(['example' =\u003e 12345]);\n// {\"example\": 12345}\n```\n\nSet Check Exception:\n```php\nJson::setCheckException();\nJson::encode([urldecode('bad utf string %C4_')]);\n// Exception: Malformed UTF-8 characters, possibly incorrectly encoded\n```\n\n**JSON Pretty Print**\n\nExample:\n```php\nJson::prettyPrint(['example' =\u003e 12345, 'example2' =\u003e 56789]);\n// {\n//    \"example\": 12345,\n//    \"example\": 56789\n// }\n```\n\nSet Check Exception:\n```php\nJson::setCheckException();\nJson::prettyPrint([urldecode('bad utf string %C4_')]);\n// Exception: Malformed UTF-8 characters, possibly incorrectly encoded\n```\n\n**JSON DECODE**\n\nExample:\n```php\nJson::decode('{\"example\": 12345}');\n// ['example' =\u003e 12345]\n```\n\nSet Check Exception:\n```php\nJson::setCheckException();\nJson::decode(\"{'example': 12345}\");\n// Syntax error\n```\n\n**GET JSON data to key**\n\nExample:\n```php\nJson::get('{\"example\": 12345}', 'example');\n// 12345\n```\n\nSet default data:\n```php\nJson::get('{\"example\": 12345}', 'example2', 56789);\n// 56789\n```\n\nSet Check Exception:\n```php\nJson::setCheckException();\nJson::get(\"{'example': 12345}\", 'example');\n// Syntax error\n```\n\n**SET JSON data**\n\nExample:\n```php\nJson::set('{\"example\": 12345}', 'example2', 56789);\n// {\"example\": 12345, \"example2\": 56789}\n```\n\nChange value:\n```php\nJson::set('{\"example\": 12345}', 'example', 56789);\n// {\"example\": 56789}\n```\n\nSet Check Exception:\n```php\nJson::setCheckException();\nJson::set(\"{'example': 12345}\", 'example2', 56789);\n// Syntax error\n```\n\n**SET ARRAY JSON**\n\nExample:\n```php\nJson::setArray('{\"example\": 12345}', ['example2' =\u003e 56789]);\n// {\"example\": 12345, \"example2\": 56789}\n```\n\nChange value:\n```php\nJson::setArray('{\"example\": 12345}', ['example' =\u003e 56789]);\n// {\"example\": 56789}\n```\n\nSet Check Exception:\n```php\nJson::setCheckException();\nJson::setArray(\"{'example': 12345}\", ['example2' =\u003e 56789]);\n// Syntax error\n```\n\n**Check error last json transform**\n\nExample:\n```php\nJson::decode('{\"example\": 12345}');\nJson::isNoteError();\n// true\nJson::decode(\"{'example': 12345}\");\nJson::isNoteError();\n// false\n```\n\n**Get error**\n\nExample:\n```php\nJson::decode('{\"example\": 12345}');\nJson::getErrorMsg();\n// NULL\nJson::decode(\"{'example': 12345}\");\nJson::getErrorMsg();\n// Syntax error\n```\n\nAdd msg:\n```php\nJson::decode(\"{'example': 12345}\");\nJson::getErrorMsg('- Example');\n// Syntax error - Example\n```\n\n**Error to exception**\n\nExample:\n```php\ntry {\n    Json::decode(\"{'example': 12345}\");\n    Json::errorToException();\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n// Syntax error\n```\n\nAdd msg:\n```php\ntry {\n    Json::decode(\"{'example': 12345}\");\n    Json::errorToException('(JSON)');\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n// Syntax error (JSON)\n```\n\nException instance:\n```php\ntry {\n    Json::decode(\"{'example': 12345}\");\n    Json::errorToException('(JSON)');\n} catch (CseExceptions $e) {\n    var_dump($e-\u003egetMessage());\n}\n// Syntax error (JSON)\n```\n\n**Set check exception**\n\nExample:\n```php\nclass Default\n{\n    public function example(): void\n    {\n        Json::encode('{\"example\": 12345}');\n    }\n}\n\nclass ExceptionTrue\n{\n    public function example(): void\n    {\n        Json::setCheckException();\n        Json::encode(\"{'example': 12345}\");\n    }\n}\n\nclass ExceptionFalse\n{\n    public function example(): void\n    {\n        Json::setCheckException(false);\n        Json::encode(\"{'example': 12345}\");\n    }\n}\n\n$default = new Default();\n$e_true = new ExceptionTrue();\n$e_false = new ExceptionFalse();\n\ntry {\n    $default-\u003eexample();\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n\ntry {\n    $e_true-\u003eexample();\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n// Syntax error\n\ntry {\n    $default-\u003eexample();\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n// Syntax error\n\ntry {\n    $e_false-\u003eexample();\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n\ntry {\n    $default-\u003eexample();\n} catch (CSEHelpersJsonException $e) {\n    var_dump($e-\u003egetMessage());\n}\n```\n\n\n## Testing \u0026 Code Coverage\n\nPHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.\n\nGeneral PHPUnit documentation can be found at https://phpunit.de/documentation.html.\n\nTo run the PHPUnit unit tests, execute:\n```bash\nphpunit PATH/TO/PROJECT/tests/\n```\n\nIf you want code coverage reports, use the following:\n```bash\nphpunit --coverage-html ./report PATH/TO/PROJECT/tests/\n```\n\nUsed PHPUnit default config:\n```bash\nphpunit --configuration PATH/TO/PROJECT/phpunit.xml\n```\n\n\n## Donating\n\nYou can support this project [here](https://www.paypal.me/cseliseev/10usd). \nYou can also help out by contributing to the project, or reporting bugs. \nEven voicing your suggestions for features is great. Anything to help is much appreciated.\n\n\n## License\n\nThe 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.\n\n***\n\n\u003e GitHub [@cs-eliseev](https://github.com/cs-eliseev)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs-eliseev%2Fhelpers-json","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcs-eliseev%2Fhelpers-json","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs-eliseev%2Fhelpers-json/lists"}