README

一个辅助类库，用于在PHP中创建JSON或JSONx字符串。它可以用于从任何变量类型（字符串、数字、布尔数组甚至对象）创建格式良好的JSON字符串。

内容

• 什么是JSON？
• 特性
• 支持的PHP版本
• 安装
• 代码示例
• 基本用法
  • 示例
• 转换属性大小写
• 从文件读取
• 与对象一起工作
• 解码JSON字符串
• 存储输出
• 与数组一起工作
• [JSONx](#jsonx)

什么是JSON？

根据json.org，JSON是一种基于JavaScript部分的数据交换格式。它易于人类阅读和机器理解。JSON数据以键值对的形式表示。

特性

• 支持创建格式良好的JSON。
• 支持创建JSONx。
• 能够解码JSON字符串并将它们转换为Json对象。
• 能够读取JSON文件并将JSON值映射到PHP数据类型。
• 能够按需操作JSON属性。

支持的PHP版本

安装

如果您使用composer管理依赖项，则可以在composer.json文件的require部分包含条目"webfiori/jsonx":"*"来安装库并安装最新版本。

包含库的另一种方式是访问发布版，下载最新版本，解压缩文件内容，并将其添加到您的包含目录中。

基本用法

使用类的过程非常简单。您需要执行的步骤如下

• 导入（或包含）类Json。
• 创建类的实例。
• 按需添加数据。
• 使用echo命令或类似命令输出对象。

有关更多信息和高级用法，请参阅此处。

示例

以下代码显示了非常简单的使用示例。

//load the class "Json"
require_once 'Json.php';
use webfiori\json\Json;

//initialize an object of the class Json
$j = new Json();

//add a number attribute
$j->addNumber('my-number', 34);

//add a boolean with 'false' as its value. 
$j->addBoolean('my-boolean', false);

//add a string
$j->addString('a-string', 'Hello, I\'m Json! I like "JSON". ');

header('content-type:application/json');
/*
send back the generated json string.
The output of the code will be like that:
{
    "my-number":34,
    "my-boolean":false,
    "my-number":"Hello, I'm Json! I like \"json\". ",
}
*/
echo $j;

以下示例显示了如何直接使用构造函数添加数据。

$jsonObj = new Json([
    'first-name' => 'Ibrahim',
    'last-name' => 'BinAlshikh',
    'age' => 26,
    'is-married' => true,
    'mobile-number' => null
]);

此代码的JSON输出如下

{
    "first-name":"Ibrahim",
    "last-name":"BinAlshikh",
    "age":26,
    "is-married":true,
    "mobile-number":null
}