# 消息接收器 Receiver
**目录 (Table of Contents)**
[TOC]
## 类基本信息
**类简要描述:**
>[info] 消息接收器用于接收微信公众号客户端发送给服务器的消息或触发的事件,并将消息转换为特定类型消息的格式
**类名字空间:**
- endor/wechat/message
**类成员变量说明:**
|成员变量|类型|访问修饰|说明
|:---- |:---|:----- |----- |
|$_eventArr| string数组 | protected | 微信监听事件标识数组 |
**事件常量描述:**
| 常量标识 | 对应微信事件字符串 | 描述 |
| --- | --- |--- |
| TEXT| 无 | 除事件外的所有消息 |
| EVENT_SCAN | scan | |
| EVENT_LOCATION | LOCATION | |
| EVENT_SUBSCRIBE | subscribe | |
| EVENT_UNSUBSCRIBE | unsubscribe | |
| EVENT_CLICK | click| |
| EVENT_ENTER | ENTER | |
| EVENT_TEMPLATE_SENDJOBFINISH| TEMPLATESENDJOBFINISH| |
**类继承关系:**
Reciever -> WechatCommon
## 类成员函数/方法
### __construct($configure)
+ 参数列表:
|参数名|类型|必填项|说明
|:---- |:---|:----- |----- |
|$configure| object (WechatConfig) | 是 | 微信配置参数对象 |
+ 返回值:
`无`
+ 函数说明:
`构造函数`
### addEventListener($eventName,$eventCallback)
+ 参数列表:
|参数名|类型|必填项|说明
|:---- |:---|:----- |----- |
|$eventName| string | 是 | 需要关注(监听)的微信消息事件 |
|$eventCallback| closure | 是 | 闭包,用于处理对应的微信事件 |
+ 返回值:
`无`
+ 函数说明:
`添加关注的消息,当消息到达时,会调用执行eventCallback中的内容`
### removeEventListener($eventName)
+ 参数列表:
|参数名|类型|必填项|说明
|:---- |:---|:----- |----- |
|$eventName| string | 是 | 需要取消关注(监听)的微信消息事件 |
+ 返回值:
`无`
+ 函数说明:
`从监听数组中把 $eventName 相应事件移除`
### receiver()
+ 参数列表:
`无`
+ 返回值:
`无`
+ 函数说明:
`开始接收消息`
>[danger]特别注意:: receiver函数必须在所有需要关注的事件都被设置之后才能调用,否则在receiver之后在注册任何事件都是无效的。
## 消息示例程序
```PHP
$receiverHandler = new Receiver();
$receiverHandler->addEventListener(Receiver::EVENT_SUBSCRIBE, function($msg) {
// 关注公众号时触发
$focus = "欢迎关注我们的公众号";
$textMessage = new TextMessage(msg->getPlateForm(),$msg->getUser(),time(),null,$foucsMsg);
$textMessage->response();
} );
$receiverHandler->receiver();
// 在receiver调用后,在执行任何addEventListener都将不会生效
```
- 1、序言
- 1.1、更新说明
- 1.2、更新计划
- 2、开始使用 Endor
- 3、目录结构
- 4、类说明
- 4.1、WechatConfig
- 4.2、WechatValid
- 4.3、WechatCommon
- 4.4、WechatException
- 4.5、基础接口
- 4.5.1、ShortUrl
- 4.5.2、WechatServerApi
- 4.6、菜单接口
- 4.6.1、菜单类设计
- 4.6.2、Menu
- 4.6.3、ClickMenu
- 4.6.4、ViewMenu
- 4.6.5、MiniProgramMenu
- 4.6.6、MenuApi
- 4.7、消息接口
- 4.7.1、Receiver
- 4.7.2、Message
- 4.7.3、EventMessage
- 4.7.4、TextMessage
- 4.7.5、ClickEventMessage
- 4.7.6、SubscribeEventMessage
- 4.7.7、UnSubscribeEventMessage
- 4.7.8、LocationEventMessage
- 4.7.9、ImageMessage
- 4.7.10、LinkMessage
- 4.7.11、NewsMessage
- 4.7.12、NewsContext
- 4.8、OAuth2.0权限验证
- 4.8.1、WechatUser
- 4.8.2、OAuthApi
- 4.9、微信支付接口
- 4.9.1、微信支付类设计
- 4.9.2、PayApi
- 4.9.3、RequestPay
- 4.9.4、ResponsePay
- 4.9.5、UnifiedOrder
- 4.9.6、JsPay
- 4.9.7、Refund
- 4.9.8、Query
- 4.9.9、Bill
- 4.9.10、NotifyData
- 4.9.11、Notify
- 4.10、模板消息接口
- 4.10.1、TemplateContext
- 4.10.2、TemplateMessageApi
- 5、使用场景
- 5.1、微信接入服务器验证
- 5.2、获取微信API令牌(access_token)
- 5.3、获取JS API
- 5.4、OAuth2.0静默登录
- 5.5、微信菜单
- 5.6、微信消息
- 5.7、微信支付
- 5.7.1、微信公众号内JsApi支付
- 5.7.2、Native 模式二 扫码支付
- 5.8、模板消息发送