soumenpasari/response-creator

一个简单的库,帮助您创建和管理代码的响应并返回它

v1.0.0 2020-01-12 06:58 UTC

This package is auto-updated.

Last update: 2024-09-21 23:14:36 UTC


README

这是一个响应管理库,主要用于管理代码和程序的响应,以便后续使用或用例。它有助于管理代码中多个模块的响应,并按需返回响应。这是一个静态库,因此您不需要创建它的任何对象。

功能!

  • 管理您的代码或API的响应。
  • 可以创建和管理多个响应分支。
  • 不同的分支可以合并
  • 以两种格式返回或获取响应,即数组或JSON格式。
  • 有助于维护程序中的HTTP响应代码。

通过Composer安装

composer require soumenpasari/response-creator

需要配置

支持PHP v5.6或更高版本

文档

本指南将帮助您了解如何使用此静态库。这是一个 静态库,您不需要创建它的对象。

基本用法

<?php
    use \soumenpasari\responseCreator\ResponseCreator as rpc;
    
    /**
    *   if success to be recorded
    **/
    rpc::success('abc_module','some message to record',200,[1,2,3,4]);
    
    /**
    *   fetch response of abc_module
    **/
    $abc_module_response = rpc::getResponse('array','abc_module');

    /**
    *   fetch all response
    **/
    $whole_response = rpc::getResponse('json');

?>

别名命名空间(如果需要的话)

use \soumenpasari\responseCreator\ResponseCreator as rpc;

理解分支

默认情况下,只有一个分支,即整个响应的master分支,您记录或存储的所有内容都记录或存储在响应的master分支下。
为什么需要创建分支:假设您正在开发的应用程序或软件或API有多个模块,并且您想跟踪代码在单个运行中通过多个模块的响应。例如,当执行登录模块时,会有多个模块,例如:

  • 用户输入数据的后端验证
  • 检查用户ID是否存在
  • 检查该用户的密码是否有效
  • 如果用户凭据有效,则创建会话并重定向

因此,对于这些模块,您可以创建不同的响应分支并分析,以便使您的代码相应地执行,例如,如果它通过了,或者如果它失败,则失败消息是什么。可以根据您的分支获取和管理所有这些信息。

记录成功

rpc::success(branch_name,message_to_log,http_response_code,data_to_log)
  • branch_name - 字符串 - 分支名称,如果是master分支,则必须提及。(必需)
  • message_to_log - 字符串 - 在该分支中记录的消息。(必需)
  • http_response_code - 整数 - 代码要设置的HTTP响应代码(在这里通常是200)。(必需)
  • data_to_log - 数组 - 在相应分支中记录的数组或任何其他数据。(可选

记录错误

rpc::error(branch_name,message_to_log,http_response_code,data_to_log)
  • branch_name - 字符串 - 分支名称,如果是master分支,则必须提及。(必需)
  • message_to_log - 字符串 - 在该分支中记录的消息。(必需
  • http_response_code - 整数 - 代码要设置的HTTP响应代码(默认值:400)(可选
  • data_to_log - 数组 - 在相应分支中记录的数组或任何其他数据。(可选

合并两个分支

rpc::merge(branch_that_to_merge,branch_to_be_merged_into,delete_merged_branch)
  • branch_that_to_merge - 字符串 - 要合并的分支名称。(必需
  • branch_to_be_merged_into - 字符串 - 其他分支要合并到的分支名称。(默认值:master)(可选
  • delete_merged_branch - 布尔值 - 如果您想在合并后删除合并的分支,请设置为 true。(默认值:true) (可选)

重置任何分支的响应值

rpc::reset(branch_name)
  • branch_name - 字符串 - 要重置的分支名称。(默认值:master)。(可选)

获取响应

rpc::getResponse(type_of_response,branch_name)
  • type_of_response - 字符串 - 要获取的响应类型,例如;数组或 JSON。(默认值:array)。(可选)。
    • array - 如果您希望响应以数组形式呈现,则参数应为数组。
    • json - 如果您希望以 JSON 格式获取响应。
  • branch_name - 字符串 - 要获取响应的分支名称。默认情况下,如果没有传递任何参数,则将获取所有分支的响应。(可选)

许可证

responseCreator 使用 MIT 许可证授权 - 请参阅 许可证 了解详情。