Ruby PHP 序列化器技术文档

本文档旨在帮助用户了解和正确使用Ruby PHP序列化器（Ruby PHP Serializer）项目，包括安装指南、使用说明以及项目API使用文档。

1. 安装指南

在您的Gemfile中添加以下代码以安装Ruby PHP序列化器：

gem "php-serialize"

随后执行bundle install命令以完成安装。

2. 项目的使用说明

本项目提供了两个方法：PHP.serialize和PHP.unserialize，这两个方法与PHP中同名的函数具有兼容性。

• PHP.serialize方法用于将Ruby数据结构序列化为PHP格式的字符串。例如：

  PHP.serialize({'foo' => 'bar'})               #=> "a:1:{s:3:\"foo\";s:3:\"bar\";}"
  

• PHP.unserialize方法用于将PHP序列化的字符串反序列化为Ruby的数据结构。例如：

  PHP.unserialize('a:1:{s:3:"foo";s:3:"bar";}') #=> {"foo"=>"bar"}
  

此外，PHP.unserialize还可以读取PHP会话，这些会话是一组命名序列化对象的集合。可以使用PHP.serialize_session将这些会话反序列化，该方法与PHP.serialize具有相同的语义，但只支持Hash和关联数组作为根对象。

3. 项目API使用文档

以下是本项目API的简要说明：

• PHP.serialize(data): 将Ruby数据结构序列化为PHP格式的字符串。
• PHP.unserialize(serialized_data): 将PHP序列化的字符串反序列化为Ruby数据结构。
• PHP.serialize_session(serialized_session): 用于序列化PHP会话数据，只支持Hash和关联数组作为根对象。

4. 项目安装方式

项目的安装方式已在安装指南中说明，简要概括如下：

1. 在Gemfile中添加gem "php-serialize"。
2. 执行bundle install命令。

以上步骤完成后，即可在项目中使用Ruby PHP序列化器。