phpwechaty/php-wechaty repository overview

⁠php-wechaty

⁠Connecting Chatbots

Wechaty is a Conversational SDK for Chatbot Makers that can help you create a bot in 8 lines of PHP

⁠Voice of the Developers

See more at Wiki:Voice Of Developer⁠

⁠Join Us

Wechaty is used in many ChatBot projects by thousands of developers. If you want to talk with other developers, just scan the following QR Code in WeChat with secret code php wechaty, join our Wechaty PHP Developers' Home.

Scan now, because other Wechaty PHP developers want to talk with you too! (secret code: php wechaty)

⁠Getting Started

⁠1. Docker

• PHP Wechaty Starter Repository for Docker - https://github.com/wechaty/docker-php-wechaty-getting-started⁠

2.1. Run php script

# for php script
docker run -ti --volume="$(pwd)":/bot --rm phpwechaty/php-wechaty:v1 docker/ding-dong-bot.php

⁠New environment variables

1. WECHATY_PUPPET_SERVICE_TLS_CA_CERT: can be overwrite by options.tlsRootCert. Set Root CA Cert to verify the server or client.

For Puppet Server:

For Puppet Client:

⁠The World's Shortest PHP ChatBot: 8 lines of Code

⁠php

$wechaty = \IO\Github\Wechaty\Wechaty::getInstance($token, $endPoint);
$wechaty->onScan(function($qrcode, $status, $data) {
    $qr = \IO\Github\Wechaty\Util\QrcodeUtils::getQr($qrcode);
    echo "$qr\n\nOnline Image: https://wechaty.github.io/qrcode/$qrcode\n";
})->onLogin(function(\IO\Github\Wechaty\User\ContactSelf $user) {
})->onMessage(function(\IO\Github\Wechaty\User\Message $message) {
    $message->say("hello from PHP7.4");
})->start();

⁠PHP Wechaty Developing Plan

We already have Wechaty in TypeScript, It will be not too hard to translate the TypeScript(TS) to PHP because wechaty⁠ has only 3,000 lines of the TS code, they are well designed and de-coupled by the wechaty-puppet⁠ abstraction. So after we have translated those 3,000 lines of TypeScript code, we will almost be done.

As we have already a ecosystem of Wechaty in TypeScript, so we will not have to implement everything in PHP, especially, in the Feb 2020, we have finished the @chatie/grpc⁠ service abstracting module with the wechaty-puppet-service⁠ implmentation.

The following diagram shows out that we can reuse almost everything in TypeScript, and what we need to do is only the block located at the top right of the diagram: Wechaty (PHP).

  +--------------------------+ +--------------------------+
  |                          | |                          |
  |   Wechaty (TypeScript)   | |      Wechaty (PHP)        |
  |                          | |                          |
  +--------------------------+ +--------------------------+

  +-------------------------------------------------------+
  |                 Wechaty Puppet Service                 |
  |                                                       |
  |                (wechaty-puppet-service)                |
  +-------------------------------------------------------+

+---------------------  @chatie/grpc  ----------------------+

  +-------------------------------------------------------+
  |                Wechaty Puppet Abstract                |
  |                                                       |
  |                   (wechaty-puppet)                    |
  +-------------------------------------------------------+

  +--------------------------+ +--------------------------+
  |      Pad Protocol        | |      Web Protocol        |
  |                          | |                          |
  | wechaty-puppet-padplus   | |(wechaty-puppet-puppeteer)|
  +--------------------------+ +--------------------------+
  +--------------------------+ +--------------------------+
  |    Windows Protocol      | |       Mac Protocol       |
  |                          | |                          |
  | (wechaty-puppet-windows) | | (wechaty-puppet-macpro)  |
  +--------------------------+ +--------------------------+

⁠Example: How to Translate TypeScript to PHP

There's a 100 lines class named Image in charge of downloading the WeChat image to different sizes.

It is a great example for demonstrating how do we translate the TypeScript to PHP in Wechaty Way:

⁠Image Class Source Code

• TypeScript: https://github.com/wechaty/wechaty/blob/master/src/user/image.ts⁠
• PHP: https://github.com/wechaty/php-wechaty/blob/master/wechaty/IO/Github/Wechaty/User/Image.php⁠

If you are interested in the translation and want to look at how it works, it will be a good start from reading and comparing those two Image class files in TypeScript and PHP at the same time.

⁠To-do List

• TS: TypeScript
• SLOC: Source Lines Of Code

⁠Wechaty Internal Modules

1. Class Wechaty
   • TS SLOC(1160): https://github.com/wechaty/wechaty/blob/master/src/wechaty.ts⁠
   • Code
   • Unit Tests
   • Documentation
2. Class Contact
   • TS SLOC(804): https://github.com/wechaty/wechaty/blob/master/src/user/contact.ts⁠
   • Code
   • Unit Tests
   • Documentation
3. Class ContactSelf
   • TS SLOC(199): https://github.com/wechaty/wechaty/blob/master/src/user/contact-self.ts⁠
   • Code
   • Unit Tests
   • Documentation
4. Class Message
   • TS SLOC(1054): https://github.com/wechaty/wechaty/blob/master/src/user/message.ts⁠
   • Code
   • Unit Tests
   • Documentation
5. Class Room
   • TS SLOC(1194): https://github.com/wechaty/wechaty/blob/master/src/user/room.ts⁠
   • Code
   • Unit Tests
   • Documentation
6. Class Image
   • TS SLOC(60): https://github.com/wechaty/wechaty/blob/master/src/user/image.ts⁠
   • Code
   • Unit Tests
   • Documentation
7. Class Accessory
   • TS SLOC(179): https://github.com/wechaty/wechaty/blob/master/src/accessory.ts⁠
   • Code
   • Unit Tests
   • Documentation
8. Class Config
   • TS SLOC(187): https://github.com/wechaty/wechaty/blob/master/src/config.ts⁠
   • Code
   • Unit Tests
   • Documentation
9. Class Favorite
   • TS SLOC(52): https://github.com/wechaty/wechaty/blob/master/src/user/favorite.ts⁠
   • Code
   • Unit Tests
   • Documentation
10. Class Friendship
    • TS SLOC(417): https://github.com/wechaty/wechaty/blob/master/src/user/friendship.ts⁠
    • Code
    • Unit Tests
    • Documentation
11. Class MiniProgram
    • TS SLOC(70): https://github.com/wechaty/wechaty/blob/master/src/user/mini-program.ts⁠
    • Code
    • Unit Tests
    • Documentation
12. Class RoomInvitation
    • TS SLOC(317): https://github.com/wechaty/wechaty/blob/master/src/user/room-invitation.ts⁠
    • Code
    • Unit Tests
    • Documentation
13. Class Tag
    • TS SLOC(190): https://github.com/wechaty/wechaty/blob/master/src/user/tag.ts⁠
    • Code
    • Unit Tests
    • Documentation
14. Class UrlLink
    • TS SLOC(107): https://github.com/wechaty/wechaty/blob/master/src/user/url-link.ts⁠
    • Code
    • Unit Tests
    • Documentation

⁠Wechaty External Modules

1. Class FileBox
   • TS SLOC(638): https://github.com/huan/file-box/blob/master/src/file-box.ts⁠
   • Code
   • Unit Tests
   • Documentation
2. Class MemoryCard
   • TS SLOC(376): https://github.com/huan/memory-card/blob/master/src/memory-card.ts⁠
   • Code
   • Unit Tests
   • Documentation
3. Class WechatyPuppet
   • TS SLOC(1115): https://github.com/wechaty/wechaty-puppet/blob/master/src/puppet.ts⁠
   • Code
   • Unit Tests
   • Documentation
4. Class WechatyPuppetService
   • TS SLOC(909): https://github.com/wechaty/wechaty-puppet-service/blob/master/src/client/puppet-service.ts⁠
   • Code
   • Unit Tests
   • Documentation

⁠Usage

WIP...

⁠docker

docker build -t php-wechaty:v1 .
docker run -ti --volume="$(pwd)":/bot --rm php-wechaty:v1 docker/ding-dong-bot.php

⁠Requirements

1. PHP 7.4+

⁠Install

⁠pecl安装

pecl install grpc
pecl install protobuf
pecl install yac

⁠CentOS yum安装

# php make sure is 7.4+
sudo yum install php-pecl-grpc
sudo yum install php-pecl-protobuf
sudo yum install php-pecl-yac
sudo yum install php-xml

# php74
sudo yum install php74-php-pecl-grpc
sudo yum install php74-php-pecl-protobuf
sudo yum install php74-php-pecl-yac
sudo yum install php74-php-xml

# php[x]
sudo yum install php[x]-php-pecl-grpc
sudo yum install php[x]-php-pecl-protobuf
sudo yum install php[x]-php-pecl-yac
sudo yum install php[x]-php-xml

⁠Yac enable

yac.enable=1
yac.enable_cli=1

⁠composer

composer config repo.packagist composer https://mirrors.aliyun.com/composer/
# https://packagist.org/packages/wechaty/php-wechaty
composer require wechaty/php-wechaty

⁠test

php examples/bot.php

⁠Development

⁠See Also

⁠PHP for Node.js Developer

⁠History

⁠master

⁠v0.0.1 (Jul 09, 2020)

1. Project created.
2. Welcome our first PHP Wechaty contributor:
   • Chunsheng Zhang （张春生） https://github.com/zhangchunsheng⁠ (https://github.com/wechaty/php-wechaty⁠)

⁠Related Projects

• Wechaty⁠ - Conversatioanl AI Chatot SDK for Wechaty Individual Accounts (TypeScript)
• Python Wechaty⁠ - Python WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Python)
• Go Wechaty⁠ - Go WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Go)
• Java Wechaty⁠ - Java WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Java)
• Scala Wechaty⁠ - Scala WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (Scala)
• PHP Wechaty⁠ - PHP WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (PHP)
• .NET(C#) Wechaty⁠ - .NET(C#) WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (.NET/C#)

⁠Badge

[![Wechaty in PHP](https://img.shields.io/badge/Wechaty-PHP-7de)](https://github.com/wechaty/php-wechaty)

⁠Contributors

1. @zhangchunsheng⁠ - Chunsheng Zhang (张春生)

⁠Creator

• @zhangchunsheng⁠ - Chunsheng Zhang (张春生)

⁠Copyright & License

• Code & Docs © 2020 Wechaty Contributors https://github.com/wechaty⁠
• Code released under the Apache-2.0 License
• Docs released under Creative Commons