{"id":15706814,"url":"https://github.com/razonyang/yii2-jsend","last_synced_at":"2025-05-12T19:10:18.146Z","repository":{"id":62533650,"uuid":"200605309","full_name":"razonyang/yii2-jsend","owner":"razonyang","description":"JSend formatter, serializer and error handler for Yii2","archived":false,"fork":false,"pushed_at":"2019-08-21T08:13:30.000Z","size":7,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-12T19:10:00.753Z","etag":null,"topics":["yii2-jsend"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/razonyang.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-05T07:33:58.000Z","updated_at":"2020-10-19T03:28:13.000Z","dependencies_parsed_at":"2022-11-02T14:46:42.809Z","dependency_job_id":null,"html_url":"https://github.com/razonyang/yii2-jsend","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/razonyang%2Fyii2-jsend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/razonyang%2Fyii2-jsend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/razonyang%2Fyii2-jsend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/razonyang%2Fyii2-jsend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/razonyang","download_url":"https://codeload.github.com/razonyang/yii2-jsend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253805860,"owners_count":21967053,"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":["yii2-jsend"],"created_at":"2024-10-03T20:28:53.352Z","updated_at":"2025-05-12T19:10:18.128Z","avatar_url":"https://github.com/razonyang.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"JSend port for Yii2\n===================\n\n[![Build Status](https://travis-ci.org/razonyang/yii2-jsend.svg?branch=master)](https://travis-ci.org/razonyang/yii2-jsend)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/razonyang/yii2-jsend/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/razonyang/yii2-jsend/?branch=master)\n[![Code Coverage](https://scrutinizer-ci.com/g/razonyang/yii2-jsend/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/razonyang/yii2-jsend/?branch=master)\n[![Latest Stable Version](https://img.shields.io/packagist/v/razonyang/yii2-jsend.svg)](https://packagist.org/packages/razonyang/yii2-jsend)\n[![Total Downloads](https://img.shields.io/packagist/dt/razonyang/yii2-jsend.svg)](https://packagist.org/packages/razonyang/yii2-jsend)\n[![LICENSE](https://img.shields.io/github/license/razonyang/yii2-jsend)](LICENSE)\n\n\nThe package is a Yii2's implementation of [JSend](https://github.com/omniti-labs/jsend) specification.\n\nInstallation\n------------\n\n```\ncomposer require razonyang/yii2-jsend\n```\n\nUsage\n-----\n\nUpdate resposne formater and error handler:\n\n```php\nreturn [\n    'components' =\u003e [\n        'response' =\u003e [\n            'formatters' =\u003e [\n                \\yii\\web\\Response::JSON =\u003e [\n                    'class' =\u003e \\RazonYang\\Yii2\\JSend\\Formatter::class,\n                ],\n            ],\n        ],\n        'errorHandler' =\u003e [\n            'class' =\u003e \\RazonYang\\Yii2\\JSend\\ErrorHandler::class,\n        ],\n    ],\n];\n```\n\nChange you rest controller serializer:\n\n```php\npublic $serializer = \\RazonYang\\Yii2\\JSend\\Serializer::class;\n```\n\nError Handler\n-------------\n\n`ErrorHandler` converts exception to error payload:\n\n```json\n{\n    \"status\": \"error\",\n    \"code\": \"exception code\",\n    \"message\": \"exception message\"\n}\n```\n\nIt can also returns the optional data field by throwing a JSend's Exception:\n\n```php\nthrows new RazonYang\\Jsend\\Exception($message, $code, $data, $previous);\n\n// you can also define your own exception:\nclass MyException extends RazonYang\\Jsend\\Exception\n{\n}\n\nthrows new MyException();\n```\n\n```json\n{\n    \"status\": \"error\",\n    \"code\": \"exception code\",\n    \"message\": \"exception message\",\n    \"data\": \"exception data\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frazonyang%2Fyii2-jsend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frazonyang%2Fyii2-jsend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frazonyang%2Fyii2-jsend/lists"}