\AipKg

Aip Base 基类

Summary

Methods

Properties

Constants

__construct()
getVersion()
setConnectionTimeoutInMillis()
setSocketTimeoutInMillis()
setProxies()
report()
createTask()
updateTask()
getTaskInfo()
getUserTasks()
startTask()
getTaskStatus()

No public properties found

No constants found

proccessRequest()
request()
multi_request()
validate()
proccessResult()
isPermission()

$accessTokenUrl
$reportUrl
$appId
$apiKey
$secretKey
$scope

N/A

getAuthFilePath()
writeAuthObj()
readAuthObj()
auth()
getAuthHeaders()

$createTaskUrl
$updateTaskUrl
$taskInfoUrl
$taskQueryUrl
$taskStartUrl
$taskStatusUrl

N/A

File: app/Libs/baidu_sdk/AipKg.php
Package: Default
Class hierarchy: \AipBase

\AipKg

Tags

None found

Properties

$accessTokenUrl

$accessTokenUrl : string

获取access token url

Type

string

$reportUrl

$reportUrl : string

反馈接口

Type

string

$appId

$appId : string

appId

Type

string

$apiKey

$apiKey : string

apiKey

Type

string

$secretKey

$secretKey : string

secretKey

Type

string

$scope

$scope : array

权限

Type

array

$createTaskUrl

$createTaskUrl : string

创建任务 create_task api url

Type

string

$updateTaskUrl

$updateTaskUrl : string

更新任务 update_task api url

Type

string

$taskInfoUrl

$taskInfoUrl : string

获取任务详情 task_info api url

Type

string

$taskQueryUrl

$taskQueryUrl : string

以分页的方式查询当前用户所有的任务信息 task_query api url

Type

string

$taskStartUrl

$taskStartUrl : string

启动任务 task_start api url

Type

string

$taskStatusUrl

$taskStatusUrl : string

查询任务状态 task_status api url

Type

string

Methods

__construct()

__construct(string  $appId, string  $apiKey, string  $secretKey)

Parameters

string	$appId
string	$apiKey
string	$secretKey

getVersion()

getVersion() : string

查看版本

Returns

string

setConnectionTimeoutInMillis()

setConnectionTimeoutInMillis(integer  $ms)

连接超时

Parameters

integer

$ms

毫秒

setSocketTimeoutInMillis()

setSocketTimeoutInMillis(integer  $ms)

响应超时

Parameters

integer

$ms

毫秒

setProxies()

setProxies(  $proxies) : string

代理

Parameters

$proxies

Returns

string

report()

report(  $feedback) : array

反馈

Parameters

$feedback

Returns

array

createTask()

createTask(string  $name, string  $templateContent, string  $inputMappingFile, string  $outputFile, string  $urlPattern, array  $options = array()) : array

创建任务接口

Parameters

string	$name	任务名字
string	$templateContent	json string 解析模板内容
string	$inputMappingFile	抓取结果映射文件的路径
string	$outputFile	输出文件名字
string	$urlPattern	url pattern
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipKg

Tags

description	options列表: limit_count 限制解析数量limit_count为0时进行全量任务，limit_count>0时只解析limit_count数量的页面

updateTask()

updateTask(integer  $id, array  $options = array()) : array

更新任务接口

Parameters

integer	$id	任务ID
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipKg

Tags

description	options列表: name 任务名字 template_content json string 解析模板内容 input_mapping_file 抓取结果映射文件的路径 url_pattern url pattern output_file 输出文件名字

getTaskInfo()

getTaskInfo(integer  $id, array  $options = array()) : array

获取任务详情接口

Parameters

integer	$id	任务ID
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipKg

Tags

description	options列表:

getUserTasks()

getUserTasks(array  $options = array()) : array

以分页的方式查询当前用户所有的任务信息接口

Parameters

array

$options

可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipKg

Tags

description	options列表: id 任务ID，精确匹配 name 中缀模糊匹配,abc可以匹配abc,aaabc,abcde等 status 要筛选的任务状态 page 页码 per_page 页码

startTask()

startTask(integer  $id, array  $options = array()) : array

启动任务接口

Parameters

integer	$id	任务ID
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipKg

Tags

description	options列表:

getTaskStatus()

getTaskStatus(integer  $id, array  $options = array()) : array

查询任务状态接口

Parameters

integer	$id	任务ID
array	$options	可选参数对象，key: value都为string类型

Returns

array

Inherited from: \AipKg

Tags

description	options列表:

proccessRequest()

proccessRequest(string  $url, array  $params, array  $data, array  $headers)

处理请求参数

Parameters

string	$url
array	$params
array	$data
array	$headers

request()

request(string  $url, mixed  $data,   $headers = array()) : mixed

Api 请求

Parameters

string	$url
mixed	$data
	$headers

Returns

mixed

multi_request()

multi_request(string  $url, mixed  $data) : mixed

Api 多个并发请求

Parameters

string	$url
mixed	$data

Returns

mixed

validate()

validate(string  $url, array  $data) : \mix

格式检查

Parameters

string	$url
array	$data

Returns

\mix

proccessResult()

proccessResult(  $content) : mixed

格式化结果

Parameters

$content

string

Returns

mixed

isPermission()

isPermission(array  $authObj) : boolean

判断认证是否有权限

Parameters

array

$authObj

Returns

boolean

getAuthFilePath()

getAuthFilePath() : string

返回 access token 路径

Returns

string

writeAuthObj()

writeAuthObj(array  $obj) : void

写入本地文件

Parameters

array

$obj

readAuthObj()

readAuthObj() : array

读取本地缓存

Returns

array

auth()

auth(boolean  $refresh = false) : array

认证

Parameters

boolean

$refresh

是否刷新

Returns

array

getAuthHeaders()

getAuthHeaders(string  $method, string  $url,   $params = array(),   $headers = array()) : array

Parameters

string	$method	HTTP method
string	$url
	$params
	$headers

Returns

array