家›支持›PHP客户端库参考示例

概述

此示例客户端库（语言绑定）可用于使用PHP代码以面向对象的方式与Brafton API交互。该库将发送请求和将XML响应解析为对象。

兼容：PHP5

[跳到顶端]

下载

[跳到顶端]

实例

包括“Sample_Php_ApiClientLibrary/apidhandler.Php”//参考从上面下载的示例php客户端库。

//馈源配置
$API\u Key=“您的API\u Key”//通过电子邮件提供的唯一API_密钥
$apiBaseUrl=“您的\u API\u BASE\u URL”；//通过电子邮件提供的API基本URL
$feed=新的ApiHandler（$API_Key，$apiBaseUrl）//创建一个新的提要对象
$newsList=$feed->getNewsHTML（）//返回包含HTML编码文本的最新新闻项数组。注意，这仍然是原始数据。

[跳到顶端]

APIHandler类引用

这是一个主类，它提供了与提要交互的核心方法，并返回与提要相关的多个对象集合，即新闻项、类别定义和最新评论。

[构造师]

ApiHandler（$API\U键，$apiBaseUrl）

  • 说明：APIHandler类构造函数。
  • 参数–$API_键：您唯一的API密钥。
  • 参数–$apiBaseUrl:提供给您的基本url
  • 例外情况：XMLLoadException
[新闻功能]

getNewsHTML（）

  • 说明：获取提要的新闻项对象数组，其中包含HTML格式的正文内容
  • 返回值：新闻项数组

getNewsRaw（）

  • 说明：获取提要的新闻项对象数组，其正文内容为原始文本
  • 返回值：新闻项数组
[类别功能]

getCategoryDefinitions（）

  • 说明：返回为提要定义的所有类别对象的数组
  • 返回值：新闻类别数组
[注释功能]

getLatestComments（）

  • 说明：获取提要新闻项目的所有最新评论的数组
  • 返回值：新闻评论数组

[跳到顶端]

newsItem类引用

[[物业]
  • getByLine（）：String–新闻文章的作者
  • getCategories（）：Category[]–与新闻文章关联的类别对象数组
  • getClientQuote（）：String–引用客户端与此项目相关的文本。
  • getComments（）：Comment[]–与新闻文章关联的评论对象数组
  • getCreatedDate：字符串–创建项目时ISO 8601系统自动生成的日期
  • getEncoding（）：使用的字符串-字符编码系统，如UTF-8
  • getExtract（）：字符串–新闻文章的摘要
  • getFormat（）：字符串–HTML或原始文本内容的格式
  • getHeadline（）：字符串–新闻文章标题
  • getHtmlMetaDescription（）：String–新闻文章的描述元标记的值
  • getHtmlMetaKeywords（）：String–新闻文章的关键字元标记的值
  • getHtmlMetaLanguage（）：String–新闻文章的语言元标记的值
  • getHtmlTitle（）：String–html标题元素的值
  • getId（）：int–主键。唯一的新闻文章id
  • getLastModifiedDate（）：：字符串–ISO 8601上次修改文章的日期
  • 获取照片（）：数不清

    –与新闻文章关联的照片对象数组

  • getPriority（）：int–优先级标志30=高，正常=20用于对新闻进行优先级排序
  • getPublishDate（）：字符串–ISO 8601文章发布日期
  • getSource（）：String–文章的原始来源
  • getState（）：String–文章的当前状态，例如LIVE/APPROVAL/DRAFT/DELETED
  • getTags（）：字符串–以逗号分隔的自由文本标记列表
  • getText（）：String–新闻文章的文本内容
  • getTweetText（）：字符串–新闻文章的140个字符的推特版

[跳到顶端]

NewsCategory类引用

[[物业]
  • getId（）：int–唯一的类别id
  • getName（）：String–类别的文本名称

[跳到顶端]

照片类参考

[[物业]
  • getAlt（）：String–可在图像的可选文本属性中使用的文本
  • getCustom（）：PhotoInstance–获取照片的自定义PhotoInstance
  • getHiRes（）：PhotoInstance–获取照片的高分辨率PhotoInstance
  • getId（）：int–唯一的照片id
  • getLarge（）：PhotoInstance–获取照片的大型PhotoInstance
  • getOrientation（）：字符串–照片的方向（纵向或横向）
  • getThumb（）：PhotoInstance–获取照片的缩略图PhotoInstance

[跳到顶端]

PhotoInstance类引用

[[物业]
  • getHeight（）：int–此图像实例的高度（以像素为单位）
  • getUrl（）：String–指向此映像实例的源位置的URL
  • getWidth（）：int–此图像实例的宽度（以像素为单位）

[跳到顶端]

NewsComment类引用

[[物业]
  • getCommentTxt（）：字符串–注释文本
  • getId（）：int–唯一的注释id
  • getLocation（）：String–注释的地理位置信息
  • getPostDate（）：字符串–ISO 8601提交注释的日期
  • getUser（）：String–注释者的名称

[跳到顶端]