Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/wechaty/php-wechaty

PHP Wechaty is a Conversational SDK for Chatbot Makers Written in PHP https://github.com/wechaty/docker-php-wechaty-getting-started
https://github.com/wechaty/php-wechaty
chatbot php php74 wechat wechaty
Last synced: 3 months ago
JSON representation
PHP Wechaty is a Conversational SDK for Chatbot Makers Written in PHP https://github.com/wechaty/docker-php-wechaty-getting-started
Host: GitHub
URL: https://github.com/wechaty/php-wechaty
Owner: wechaty
License: apache-2.0
Created: 2020-07-09T09:14:54.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-02-21T05:47:43.000Z (almost 2 years ago)
Last Synced: 2024-09-29T20:01:29.723Z (3 months ago)
Topics: chatbot, php, php74, wechat, wechaty
Language: PHP
Homepage: https://github.com/wechaty/php-wechaty-getting-started
Size: 476 KB
Stars: 57
Watchers: 6
Forks: 21
Open Issues: 4
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project

README

        # php-wechaty

[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/wechaty/php-wechaty)](https://packagist.org/packages/wechaty/php-wechaty)

[![PHP](https://github.com/wechaty/php-wechaty/workflows/PHP/badge.svg)](https://github.com/wechaty/php-wechaty/actions?query=workflow%3APHP)

[![PHP Wechaty](https://wechaty.github.io/php-wechaty/images/php-wechaty.png)](https://github.com/wechaty/php-wechaty)

[![PHP Wechaty Getting Started](https://img.shields.io/badge/PHP%20Wechaty-Getting%20Started-7de)](https://github.com/wechaty/php-wechaty-getting-started)

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

## Read code

 

## Connecting Chatbots

[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)

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

## Voice of the Developers

> "Wechaty is a great solution, I believe there would be much more users recognize it." [link](https://github.com/Wechaty/wechaty/pull/310#issuecomment-285574472)  

> — @Gcaufy, Tencent Engineer, Author of [WePY](https://github.com/Tencent/wepy)

>

> "太好用，好用的想哭"  

> — @xinbenlv, Google Engineer, Founder of HaoShiYou.org

>

> "最好的微信开发库" [link](http://weibo.com/3296245513/Ec4iNp9Ld?type=comment)  

> — @Jarvis, Baidu Engineer

>

> "Wechaty让运营人员更多的时间思考如何进行活动策划、留存用户，商业变现" [link](http://mp.weixin.qq.com/s/dWHAj8XtiKG-1fIS5Og79g)  

> — @lijiarui, Founder & CEO of Juzi.BOT.

>

> "If you know js ... try Wechaty, it's easy to use."  

> — @Urinx Uri Lee, Author of [WeixinBot(Python)](https://github.com/Urinx/WeixinBot)

See more at [Wiki:Voice Of Developer](https://github.com/Wechaty/wechaty/wiki/Voice%20Of%20Developer)

## 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**.

![Wechaty Friday.BOT QR Code](https://wechaty.js.org/img/friday-qrcode.svg)

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

## Getting Started

### 1. Docker

[![Docker Pulls](https://img.shields.io/docker/pulls/phpwechaty/php-wechaty)](https://hub.docker.com/r/phpwechaty/php-wechaty/)

[![Docker Layers](https://images.microbadger.com/badges/image/wechaty/php-wechaty.svg)](https://microbadger.com/#/images/wechaty/php-wechaty)

- PHP Wechaty Starter Repository for Docker - 

> PHP Wechaty Docker supports PHP Script.

2.1. Run php script

```shell

# for php script

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

```

> Learn more about Wechaty Docker at [Wiki:Docker](https://github.com/Wechaty/php-wechaty/wiki/Docker).

#### 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:

| Environment Variable | Options | Description |

| -------------------- | ------- | ----------- |

| `WECHATY_PUPPET_SERVICE_TLS_SERVER_CERT` | `options.tls.serverCert` | Server CA Cert (string data) |

| `WECHATY_PUPPET_SERVICE_TLS_SERVER_KEY` | `options.tls.serverKey` | Server CA Key (string data) |

| `WECHATY_PUPPET_SERVICE_NO_TLS_INSECURE_SERVER` | `options.tls.disable` | Set `true` to disable server TLS |

For Puppet Client:

| Environment Variable | Options | Description |

| -------------------- | ------- | ----------- |

| `WECHATY_PUPPET_SERVICE_AUTHORITY` | `options.authority` | Service discovery host, default: `api.chatie.io` |

| `WECHATY_PUPPET_SERVICE_TLS_CA_CERT` | `options.caCert` | Certification Authority Root Cert, default is using Wechaty Community root cert |

| `WECHATY_PUPPET_SERVICE_TLS_SERVER_NAME` | `options.serverName` | Server Name (mast match for SNI) |

| `WECHATY_PUPPET_SERVICE_NO_TLS_INSECURE_CLIENT` | `options.tls.disable` | Set `true` to disable client TLS |

> Learn more about tls at https://github.com/wechaty/puppet-service

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

### php

```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](https://github.com/wechaty/wechaty) has only 3,000 lines of the TS code, they are well designed and de-coupled by the [wechaty-puppet](https://github.com/wechaty/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](https://github.com/chatie/grpc) service abstracting module with the [wechaty-puppet-service](https://github.com/wechaty/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)`.

```ascii

  +--------------------------+ +--------------------------+

  |                          | |                          |

  |   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: 

- 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): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Contact

    - TS SLOC(804): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class ContactSelf

    - TS SLOC(199): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Message

    - TS SLOC(1054): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Room

    - TS SLOC(1194): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Image

    - TS SLOC(60): 

    - [X] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Accessory

    - TS SLOC(179): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Config

    - TS SLOC(187): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Favorite

    - TS SLOC(52): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Friendship

    - TS SLOC(417): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class MiniProgram

    - TS SLOC(70): 

    - [x] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class RoomInvitation

    - TS SLOC(317): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class Tag

    - TS SLOC(190): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class UrlLink

    - TS SLOC(107): 

    - [x] Code

    - [ ] Unit Tests

    - [ ] Documentation

### Wechaty External Modules

1. [ ] Class FileBox

    - TS SLOC(638): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class MemoryCard

    - TS SLOC(376): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class WechatyPuppet

    - TS SLOC(1115): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

1. [ ] Class WechatyPuppetService

    - TS SLOC(909): 

    - [ ] Code

    - [ ] Unit Tests

    - [ ] Documentation

## Usage

WIP...

## docker

```shell script

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安装

```shell script

pecl install grpc

pecl install protobuf

pecl install yac

```

### CentOS yum安装

```shell script

# 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 

```shell script

yac.enable=1

yac.enable_cli=1

```

### composer

```shell

composer config repo.packagist composer https://mirrors.aliyun.com/composer/

# https://packagist.org/packages/wechaty/php-wechaty

composer require wechaty/php-wechaty

```

### test

```shell script

php examples/bot.php

```

## Development

```sh

```

## See Also

### PHP for Node.js Developer

## History

### master

### v0.0.1 (Jul 09, 2020)

1. Project created.

1. Welcome our first PHP Wechaty contributor:

    - Chunsheng Zhang （张春生）  (https://github.com/wechaty/php-wechaty)

## Related Projects

- [Wechaty](https://github.com/wechaty/wechaty) - Conversatioanl AI Chatot SDK for Wechaty Individual Accounts (TypeScript)

- [Python Wechaty](https://github.com/wechaty/python-wechaty) - Python WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Python)

- [Go Wechaty](https://github.com/wechaty/go-wechaty) - Go WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Go)

- [Java Wechaty](https://github.com/wechaty/java-wechaty) - Java WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Java)

- [Scala Wechaty](https://github.com/wechaty/scala-wechaty) - Scala WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (Scala)

- [PHP Wechaty](https://github.com/wechaty/php-wechaty) - PHP WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (PHP)

- [.NET(C#) Wechaty](https://github.com/wechaty/dotnet-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)

```md

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

```

## Contributors

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/1)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/1)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/0)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/0)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/2)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/2)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/3)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/3)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/4)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/4)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/5)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/5)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/6)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/6)

[![](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/images/7)](https://sourcerer.io/fame/zhangchunsheng/wechaty/php-wechaty/links/7)

1. [@zhangchunsheng](https://github.com/zhangchunsheng) - Chunsheng Zhang (张春生)

## Creator

- [@zhangchunsheng](https://github.com/zhangchunsheng) - Chunsheng Zhang (张春生) 

## Copyright & License

- Code & Docs © 2020 Wechaty Contributors 

- Code released under the Apache-2.0 License

- Docs released under Creative Commons