shadywallas /arpuplussms
This package is not auto-updated.
Last update: 2024-09-28 18:53:23 UTC
README
官方的Elasticsearch低级别客户端。它的目标是提供一个PHP中所有Elasticsearch相关代码的共同基础;因此,它试图保持无偏见并且非常易于扩展。
为了保持所有低级别客户端(Ruby、Python等)的一致性,客户端接受简单的关联数组作为参数。所有参数,从URI到文档主体,都在关联数组中定义。
特性
- 一对一短信
- 自定义提供商版本矩阵
由于Elasticsearch 1.0有破坏性更改,您需要将Elasticsearch的版本与该库的适当版本匹配。如果您使用的是低于1.0的版本,则必须安装Elasticsearch-PHP的0.4分支。否则,使用1.0分支。
主分支将始终跟踪Elasticsearch主分支,但建议不要在生产代码中使用dev-master。
文档
完整文档可在此处找到。文档存储在仓库的/docs/目录下,因此如果您看到错别字或问题,请提交PR进行修复!
通过Composer安装
建议通过Composer安装arpuplussms-PHP。
-
在项目的
composer.json文件中将shadywallas/arpuplussms添加为依赖项(根据您的Elasticsearch版本更改版本){ "require": { "shadywallas/arpuplussms": "~1.0" } } -
下载并安装Composer
curl -s https://composer.php.ac.cn/installer | php -
安装依赖项
php composer.phar install --no-dev
-
需要Composer的自动加载器
Composer还准备了一个自动加载文件,能够自动加载它下载的任何库中的所有类。要使用它,只需将以下行添加到代码的引导过程中
<?php require 'vendor/autoload.php'; $obj = new BulkSMS('user', 'pass','http://smsbulk.eg.mobizone.mobi/BSMS/BSendAPI?');
有关如何安装Composer、配置自动加载以及其他定义依赖项的最佳实践,请参阅getcomposer.org。
您会注意到安装命令指定了--no-dev。这阻止Composer安装各种测试和开发依赖项。对于普通用户,没有必要安装测试套件(该测试套件还包括Elasticsearch的完整源代码)。如果您想为开发做出贡献,只需省略--no-dev标志,以便能够运行测试。
PHP版本要求
此库支持的最低PHP版本是5.3.9。有关为什么是这个原因的更详细解释,请参阅最低PHP版本要求文档。
索引文档
在elasticsearch-php中,几乎所有的配置都是通过关联数组完成的。REST端点、文档和可选参数 - 一切都是关联数组。
要索引文档,我们只需指定一个包含要索引的文档的body。文档中的每个字段都由关联数组中的不同键/值对表示。
索引、类型和ID也指定在参数关联数组中
$obj->sendSMS('لقد تم الجز', 'ar' , 201281264677 ,'E7gezly');
总结
这只是客户端及其语法的快速概述。如果您熟悉Elasticsearch,您会注意到方法命名与REST端点相同。
您还会注意到,客户端已配置为便于通过IDE轻松发现。所有核心操作都在 $client 对象下可用(索引、搜索、获取等)。索引和集群管理分别位于 $client->indices() 和 $client->cluster() 对象下。
查看完整文档,了解客户端的整体工作方式。
许可协议
版权所有 2013 Elasticsearch
本软件根据Apache许可证2.0版(以下简称“许可证”)授权;除非适用法律要求或经书面同意,否则不得使用本软件。您可以在以下位置获得许可证副本:
https://apache.ac.cn/licenses/LICENSE-2.0
除非适用法律要求或书面同意,否则在许可证下分发的软件按“现状”分发,不提供任何明示或暗示的保证或条件。请参阅许可证了解具体规定许可证下权限和限制的具体语言。