Gitee
\
Acme
addons
adminlte
controller
command
controller
library
crontab
controller
database
controller
library
example
controller
freecode
controller
loginbg
controller
loginbgindex
controller
simditor
summernote
controller
test
controller
tinymce
controller
app
admin
behavior
command
Api
library
controller
auth
example
forum
general
user
library
traits
model
forum
validate
forum
api
controller
library
common
behavior
controller
library
token
driver
model
index
controller
model
Composer
Autoload
Cron
Tests
Doctrine
Common
Cache
Tests
Common
Cache
EasyWeChat
Broadcast
Card
Comment
Core
Exceptions
Device
Encryption
Foundation
ServiceProviders
Fundamental
Js
Material
Menu
Message
MiniProgram
Core
Encryption
Material
Notice
QRCode
Server
Sns
Staff
Stats
Notice
OpenPlatform
Api
EventHandlers
Payment
CashCoupon
LuckyMoney
MerchantPay
POI
QRCode
Reply
Semantic
Server
ShakeAround
Staff
Stats
Store
Support
Traits
Url
User
Endroid
QrCode
Bundle
Controller
DependencyInjection
Twig
Extension
Exceptions
Factory
Tests
Bundle
Controller
Tests
QrCode
fast
GatewayWorker
Lib
Protocols
GuzzleHttp
Cookie
Exception
Handler
Promise
Psr7
League
OAuth2
Client
Provider
Monolog
Formatter
Handler
Curl
FingersCrossed
Slack
SyslogUdp
Processor
Overtrue
Pinyin
Socialite
Providers
Pimple
Exception
Psr11
Tests
Fixtures
Psr11
Psr
Container
Http
Message
Log
Test
Symfony
Bridge
PsrHttpMessage
Factory
Tests
Factory
Fixtures
Component
HttpFoundation
Exception
File
Exception
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
Tests
File
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
OptionsResolver
Debug
Exception
Tests
Debug
Polyfill
Mbstring
Php70
think
addons
cache
driver
captcha
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
controller
db
builder
connector
exception
debug
exception
helper
hash
log
driver
model
relation
paginator
driver
process
exception
pipes
response
session
driver
template
driver
taglib
view
driver
traits
controller
model
think
Workerman
Connection
Events
React
Lib
Protocols

\EasyWeChat\UserUser

Class User.

Summary

Methods
Properties
Constants
__construct()
getHttp()
setHttp()
getAccessToken()
setAccessToken()
maxRetries()
parseJSON()
get()
batchGet()
lists()
remark()
group()
getGroup()
blacklist()
batchBlock()
batchUnblock()
No public properties found
GET
POST
JSON
API_GET
API_BATCH_GET
API_LIST
API_GROUP
API_REMARK
API_OAUTH_GET
API_GET_BLACK_LIST
API_BATCH_BLACK_LIST
API_BATCH_UNBLACK_LIST
registerHttpMiddlewares()
accessTokenMiddleware()
logMiddleware()
retryMiddleware()
checkAndThrow()
$http
$accessToken
$maxRetries
N/A
No private methods found
No private properties found
N/A

Constants

GET

GET = 'get'

POST

POST = 'post'

JSON

JSON = 'json'

API_GET

API_GET = 'https://api.weixin.qq.com/cgi-bin/user/info'

API_BATCH_GET

API_BATCH_GET = 'https://api.weixin.qq.com/cgi-bin/user/info/batchget'

API_LIST

API_LIST = 'https://api.weixin.qq.com/cgi-bin/user/get'

API_GROUP

API_GROUP = 'https://api.weixin.qq.com/cgi-bin/groups/getid'

API_REMARK

API_REMARK = 'https://api.weixin.qq.com/cgi-bin/user/info/updateremark'

API_OAUTH_GET

API_OAUTH_GET = 'https://api.weixin.qq.com/sns/userinfo'

API_GET_BLACK_LIST

API_GET_BLACK_LIST = 'https://api.weixin.qq.com/cgi-bin/tags/members/getblacklist'

API_BATCH_BLACK_LIST

API_BATCH_BLACK_LIST = 'https://api.weixin.qq.com/cgi-bin/tags/members/batchblacklist'

API_BATCH_UNBLACK_LIST

API_BATCH_UNBLACK_LIST = 'https://api.weixin.qq.com/cgi-bin/tags/members/batchunblacklist'

Properties

$maxRetries

$maxRetries : integer

Type

integer

Methods

setHttp()

setHttp(\EasyWeChat\Core\Http  $http) : $this

Set the http instance.

Parameters

\EasyWeChat\Core\Http $http

Returns

$this

setAccessToken()

setAccessToken(\EasyWeChat\Core\AccessToken  $accessToken) : $this

Set the request token.

Parameters

\EasyWeChat\Core\AccessToken $accessToken

Returns

$this

maxRetries()

maxRetries(integer  $retries)

Parameters

integer $retries

parseJSON()

parseJSON(string  $method, array  $args) : \EasyWeChat\Support\Collection

Parse JSON from response and check error.

Parameters

string $method
array $args

Throws

\EasyWeChat\Core\Exceptions\HttpException

Returns

\EasyWeChat\Support\Collection —

| null

get()

get(string  $openId, string  $lang = 'zh_CN') : \EasyWeChat\Support\Collection

Fetch a user by open id.

Parameters

string $openId
string $lang

Returns

\EasyWeChat\Support\Collection

batchGet()

batchGet(array  $openIds, string  $lang = 'zh_CN') : \EasyWeChat\Support\Collection

Batch get users.

Parameters

array $openIds
string $lang

Returns

\EasyWeChat\Support\Collection

lists()

lists(string  $nextOpenId = null) : \EasyWeChat\Support\Collection

List users.

Parameters

string $nextOpenId

Returns

\EasyWeChat\Support\Collection

remark()

remark(string  $openId, string  $remark) : \EasyWeChat\Support\Collection

Set user remark.

Parameters

string $openId
string $remark

Returns

\EasyWeChat\Support\Collection

group()

group(string  $openId) : \EasyWeChat\Support\Collection

Get user's group id.

Parameters

string $openId

Returns

\EasyWeChat\Support\Collection

getGroup()

getGroup(string  $openId) : \EasyWeChat\Support\Collection

Get user's group.

Parameters

string $openId

Returns

\EasyWeChat\Support\Collection

blacklist()

blacklist(string|null  $beginOpenid = null) : \EasyWeChat\Support\Collection

Get black list.

Parameters

string|null $beginOpenid

Returns

\EasyWeChat\Support\Collection

batchBlock()

batchBlock(array  $openidList) : \EasyWeChat\Support\Collection

Batch block user.

Parameters

array $openidList

Returns

\EasyWeChat\Support\Collection

batchUnblock()

batchUnblock(array  $openidList) : \EasyWeChat\Support\Collection

Batch unblock user.

Parameters

array $openidList

Returns

\EasyWeChat\Support\Collection

registerHttpMiddlewares()

registerHttpMiddlewares()

Register Guzzle middlewares.

accessTokenMiddleware()

accessTokenMiddleware() : \Closure

Attache access token to request query.

Returns

\Closure

logMiddleware()

logMiddleware() : \Closure

Log the request.

Returns

\Closure

retryMiddleware()

retryMiddleware() : \Closure

Return retry middleware.

Returns

\Closure

checkAndThrow()

checkAndThrow(array  $contents)

Check the array data errors, and Throw exception when the contents contains error.

Parameters

array $contents

Throws

\EasyWeChat\Core\Exceptions\HttpException