alexeevdv / telegram-cli-client
用于telegram-cli的php客户端
Requires
- php: >=5.3.0,<6.0.0
Requires (Dev)
- zyberspace/discovery-shell: dev-master
README
###更新 2015-12-23
由于我现在没有时间再继续这个项目,而且Telegram发布了它自己的机器人API,因此未来这个项目不会有很多新的更新。我将尽力解决所有目前开放的bug,以便在问题部分不再有任何东西(即使我需要使用wontfix
来关闭一些事情)。
如果有人想接管这个项目,我愿意给他推送权限或在其github/packagist上的分支链接。
如果您想将您的项目移植到新的机器人API,请查看非官方的php-sdk。
zyberspace/telegram-cli-client
用于telegram-cli的php客户端
需求
- 需要运行在监听Unix套接字(
-S
)或端口(-P
)上的telegram-cli,并且将所有答案作为JSON返回(--json
)。
需要预先配置(电话号码等)。 - php >= 5.3.0
用法
###设置telegram-cli telegram-cli需要在Unix套接字(-S
)或端口(-P
)上运行,以便telegram-cli-client可以连接到它。所有答案都需要以JSON格式返回(--json
)。
您还应该使用-W
启动它,以便在启动时加载联系人列表。
在这个例子中,我们将使用以下命令(从您安装telegram-cli的目录中执行此命令,而不是php客户端的目录),-d
让它作为守护进程运行。
./bin/telegram-cli --json -dWS /tmp/tg.sck &
如果您使用与您的php脚本不同的用户运行telegram-cli,并且您使用的是linux,则需要更改套接字的权限,以便php脚本可以访问它(感谢dennydai提供这个解决方案!)。
例如,将两者添加到telegram
组中,然后执行以下操作:
chown :telegram /tmp/tg.sck chmod g+rwx /tmp/tg.sck
如果您以前从未启动过telegram-cli,则需要首先以正常模式启动它,以便您可以输入您的Telegram电话号码并注册它(如果需要的话)(./bin/telegram-cli
)。
要停止守护进程,请使用killall telegram-cli
或kill -TERM [telegram-pid]
。
###使用composer安装telegram-cli-client 在您的项目根目录中
composer require --update-no-dev zyberspace/telegram-cli-client
Composer会自动将包添加到您的项目需求中,并安装它(如果您还没有,也会创建composer.json
)。
如果您想使用发现外壳,请从命令中删除--update-no-dev
。
###使用它
require('vendor/autoload.php'); $telegram = new \Zyberspace\Telegram\Cli\Client('unix:///tmp/tg.sck'); $contactList = $telegram->getContactList(); $telegram->msg($contactList[0]->print_name, 'Hey man, what\'s up? :D');
###使用发现外壳使用它 真正简单学习API的方法是通过使用内置的发现外壳。您需要安装开发依赖项(composer update --dev
)。
$ ./discovery-shell.php -- discovery-shell to help discover a class or library -- Use TAB for autocompletion and your arrow-keys to navigate through your method-history. Beware! This is not a full-featured php-shell. The input gets parsed with PHP-Parser to avoid the usage of eval(). > $telegram->getContactList(); array(13) { [...] } > $telegram->msg('my_contact', 'Hi, i am sending this from a php-client for telegram-cli.'); true
文档
要创建文档,只需在项目根目录中运行phpdoc
。
在线版本可在phpdoc.zyberware.org/zyberspace/telegram-cli-client找到。
支持的命令
您可以使用RawClient
类的exec()
方法执行每个命令,但还有几个命令包装器可供使用(doc-link),您应该优先使用(参见example.php
)。
如果您只想使用自己的命令包装器,只需扩展RawClient
类(负责套接字连接并提供一些辅助方法)。
在您的命令包装器中或如果您直接使用exec()
,请务必使用escapePeer()
来转义联系人(联系人、聊天名称等),并使用escapeStringArgument()
来转义所有字符串参数,以避免错误。
API 稳定性
命令包装器的 API 在未来肯定会发生变化,例如,目前getHistory()
只返回telegram-cli的原始答案,实际上并不太有用。因此,您不应在生产环境中使用此功能。
如果您仍然想在项目中使用它,请确保您保持在相同的次要版本(例如~0.1.0
或0.1.*
)。.
许可
本软件根据Mozilla公共许可证v. 2.0授权。有关更多信息,请参阅LICENSE
文件。