Documentation

Media extends BasicWeChat
in

微信素材管理 Class Media

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
add() 新增临时素材 array
get() 获取临时素材 array|string
addNews() 新增图文素材 array
updateNews() 更新图文素材 array
uploadImg() 上传图文消息内的图片获取URL array
addMaterial() 新增其他类型永久素材 array
getMaterial() 获取永久素材 array|string
delMaterial() 删除永久素材 array
getMaterialCount() 获取素材总数 array
batchGetMaterial() 获取素材列表 array
__construct() BasicWeChat constructor. mixed
instance() 静态创建对象 static
getAccessToken() 获取访问accessToken string
setAccessToken() 设置外部接口 AccessToken mixed
delAccessToken() 清理删除 AccessToken bool
httpGetForJson() 以GET获取接口数据并转为数组 array
httpPostForJson() 以POST获取接口数据并转为数组 array
registerApi() 注册当前请求接口 mixed
callPostApi() 接口通用POST请求方法 array
callGetApi() 接口通用GET请求方法 array

Properties

$access_token

访问AccessToken

public string $access_token = ''

$currentMethod

当前请求方法参数

protected array $currentMethod = []

$GetAccessTokenCallback

注册代替函数

protected string $GetAccessTokenCallback

Methods

add()

新增临时素材

public add( $filename : string [, $type : string = 'image' ] ) : array
Parameters
$filename : string

文件名称

$type : string = 'image'

媒体文件类型(image|voice|video|thumb)

Tags
throws
throws
Return values
array

get()

获取临时素材

public get( $media_id : string [, $outType : string = null ] ) : array|string
Parameters
$media_id : string
$outType : string = null

返回处理函数

Tags
throws
throws
Return values
array|string

addNews()

新增图文素材

public addNews( $data : array ) : array
Parameters
$data : array

文件名称

Tags
throws
throws
Return values
array

updateNews()

更新图文素材

public updateNews( $media_id : string , $index : int , $news : array ) : array
Parameters
$media_id : string

要修改的图文消息的id

$index : int

要更新的文章在图文消息中的位置(多图文消息时,此字段才有意义),第一篇为0

$news : array

文章内容

Tags
throws
throws
Return values
array

uploadImg()

上传图文消息内的图片获取URL

public uploadImg( $filename : string ) : array
Parameters
$filename : string
Tags
throws
throws
Return values
array

addMaterial()

新增其他类型永久素材

public addMaterial( $filename : string [, $type : string = 'image' ] [, $description : array = [] ] ) : array
Parameters
$filename : string

文件名称

$type : string = 'image'

媒体文件类型(image|voice|video|thumb)

$description : array = []

包含素材的描述信息

Tags
throws
throws
Return values
array

getMaterial()

获取永久素材

public getMaterial( $media_id : string [, $outType : null|string = null ] ) : array|string
Parameters
$media_id : string
$outType : null|string = null

输出类型

Tags
throws
throws
Return values
array|string

delMaterial()

删除永久素材

public delMaterial( $media_id : string ) : array
Parameters
$media_id : string
Tags
throws
throws
Return values
array

getMaterialCount()

获取素材总数

public getMaterialCount( ) : array
Tags
throws
throws
Return values
array

batchGetMaterial()

获取素材列表

public batchGetMaterial( [ $type : string = 'image' ] , $offset : int [, $count : int = 20 ] ) : array
Parameters
$type : string = 'image'
$offset : int
$count : int = 20
Tags
throws
throws
Return values
array

__construct()

BasicWeChat constructor.

public __construct( $options : array ) : mixed
Parameters
$options : array
Return values
mixed

instance()

静态创建对象

public static instance( $config : array ) : static
Parameters
$config : array
Return values
static

getAccessToken()

获取访问accessToken

public getAccessToken( ) : string
Tags
throws
throws
Return values
string

setAccessToken()

设置外部接口 AccessToken

public setAccessToken( $access_token : string ) : mixed
Parameters
$access_token : string
Tags
throws
author

高一平 iam@gaoyiping.com

当用户使用自己的缓存驱动时,直接实例化对象后可直接设置 AccessToekn

  • 多用于分布式项目时保持 AccessToken 统一
  • 使用此方法后就由用户来保证传入的 AccessToekn 为有效 AccessToekn
Return values
mixed

delAccessToken()

清理删除 AccessToken

public delAccessToken( ) : bool
Return values
bool

httpGetForJson()

以GET获取接口数据并转为数组

protected httpGetForJson( $url : string ) : array
Parameters
$url : string

接口地址

Tags
throws
throws
Return values
array

httpPostForJson()

以POST获取接口数据并转为数组

protected httpPostForJson( $url : string , $data : array [, $buildToJson : bool = true ] ) : array
Parameters
$url : string

接口地址

$data : array

请求数据

$buildToJson : bool = true
Tags
throws
throws
Return values
array

registerApi()

注册当前请求接口

protected registerApi( &$url : string , $method : string [, $arguments : array = [] ] ) : mixed
Parameters
$url : string

接口地址

$method : string

当前接口方法

$arguments : array = []

请求参数

Tags
throws
throws
Return values
mixed

callPostApi()

接口通用POST请求方法

public callPostApi( $url : string , $data : array [, $isBuildJson : bool = true ] ) : array
Parameters
$url : string

接口URL

$data : array

POST提交接口参数

$isBuildJson : bool = true
Tags
throws
throws
Return values
array

callGetApi()

接口通用GET请求方法

public callGetApi( $url : string ) : array
Parameters
$url : string

接口URL

Tags
throws
throws
Return values
array

Search results