ucscode / local-storage
一个具有可选加密功能的本地数据存储PHP库。
2.0.2
2024-07-30 22:43 UTC
Requires
- php: >=8.1
README
本地存储库是一个简单的PHP库,提供了一种方便的方式在本地存储和检索数据,并可选择加密。它设计得与stdClass
类似,但增加了将数据保存到和从文件加载的功能。
安装
您可以使用Composer安装本地存储库。运行以下命令:
composer require ucscode/local-storage
不使用Composer安装
如果您不希望使用Composer,可以通过以下步骤手动将本地存储库包含到您的项目中:
-
克隆Github仓库并将解压的内容提取到您的项目目录中。
-
在您的PHP代码中包含
LocalStorage.php
文件
require_once 'path/to/src/LocalStorage.php';
加密
默认情况下,库使用gzdeflate和gzinflate进行基本数据压缩。然而,您可以通过在实例化时提供一个安全密钥来使用OpenSSL加密提高安全性。
使用方法
如果实例化文件已经包含LocalStorage数据,LocalStorage实例将自动填充这些数据。
use Ucscode\LocalStorage\LocalStorage; $filepath = 'path/to/storage/file.txt'; $localStorage = new LocalStorage($filepath);
可选地,在实例化时可以添加一个密钥以增强安全性。
$optionalSecretKey = "my_secret_key"; $localStorage = new LocalStorage($filepath, $optionalSecretKey);
创建与访问
$localstorage->author = "Ucscode"; $localStorage->data = []; $localStorage->data['foundation'] = "User Synthetics"; $localStorage->data['description'] = "Save encrypted contents into local file instead of database"; $localStorage->data['foundation']; // User Synthetics
保存数据
LocalStorage中的数据除非显式调用保存方法,否则不会自动保存。
$localStorage->save();
检索所有数据
要检索本地存储中所有可用的数据数组,请使用getContext
方法。
$localStorage->getContext(); // [author => Ucscode, data => [...]]
贡献与反馈
如果您遇到任何问题、有建议或想为本地存储库做出贡献,请在GitHub仓库上打开一个问题。
许可证
本本地存储库是开源软件,许可协议为MIT许可证。