LilyBBS API 0.10α Doc

静态类。包含有关编码方面的参数。

静态类。包含关于更新策略（时机）。

静态类。包含向百合发请时所要用到的Url及其相关。

静态类。包含关于百合的Cookie相关设置。

静态类。包含其他设置的。

接口。是对所有进行更新操作的类的抽象。是系统更新框架的一部分。

• update() : void [Public]

  更新与该Updater对应的IUpdate对象（即包含该IUpdater的IUpdate）。

接口。用于检测所对应的IUpdate是否需要更新。

• updated() : void [Public]

  通知该对象：与该对象对应的IUpdate的更新过程已经完成。以便于下次检测时进行参考。

• needUpdate() : bool [Public]

  检测与该对象对应的IUpdate是否需要更新。具体的检测策略由该类的子类实现。

  RETURN : true : 需要更新; false : 不需要更新;

接口。对所有包含可更新数据的类的抽象。

• getUpdater() : IUpdater [Public]

  RETURN : 与该对象对应的Updater

• getUpdateCheck() : IUpdateCheck [Public]

  RETURN : 与该对象对应的UpdateCheck

继承自Lily_IUpdateCheck。对Lily_IUpdateCheck的实现，依据时间判断数据是否过期。

• $lastUpdateTime : int [Public ReadOnly]

  上次更新的时间，由time()获得的格式。

• $lifeTime : int [Public]

  所对应的IUpdate的生存周期。

• everUpdated : bool [Public ReadOnly]

  是否曾进行过更新。

继承自Lily_TimeUpdateCheck。 在Lily_TimeUpdateCheck的时间判定的基础上加上了对 Lily_UpdateConfig :: AUTO_UPDATE 的判定。最终实现了完整的更新检测过程。

静态类。与编码相关的实用方法。

• Encode ( $text : string ) : string [Public Static]

  将由百合BBS得到的字符串的编码由 Lily_EncodingConfig::LILYBBS_ENCODING 转化到 Lily_EncodingConfig::OUTPUT_ENCODING 。以便于输出。

  Return : 转换后的字符串。

  （参见：Lily_EncodingConfig）

• ConstStr ( $text : string ) : string [Public Static]

  将代码中出现的中文字符常量的编码由 Lily_EncodingConfig::FILE_ENCODING 转化到 Lily_EncodingConfig::OUTPUT_ENCODING 。以便于比较。

  Return : 转换后的字符串。

静态类。更新检测或更新过程中要用到的实用方法。

• update ( $updateItem : IUpdate ) : bool [Public Static]

  首先检查所传入的IUpdate是否需要更新（通过 $updateItem->getUpdateCheck() 来获取IUpdateCheck进行检查）。若需要，则进行更新（通过 $updateItem->getUpdater() 来获取IUpdater进行更新），并返回true。 若不需要，返回false。

  Return : true : 进行了更新; false : 没有进行更新

• forceUpdate ( $updateItem : IUpdate ) : void [Public Static]

  不进行更新检测，强制博时价值进行更新。

• updateBegin ( $dataitem : DataItem ) : void [Public Static]

  将一个对象标记为“正在进行更新”。

• updateEnd ( $dataitem : DataItem ) : void [Public Static]

  取消一个对象的“正在进行更新”标记。

• isUpdating ( $dataitem : DataItem ) : bool [Public Static]

  检测一个对象是否被标记了“正在进行更新”。

  Return : true: 有“正在进行更新”的标记; false没有。

静态类。与Url相关的实用方法。

• isUserInfoUrl( $url : string ) : bool [Public Static]

  判断所传入的url是否是用户信息的Url。

  Return : true : 是; false : 否

• isPostUrl( $url : string ) : bool [Public Static]

  判断所传入的url是否是帖子的Url。

  Return : true : 是; false : 否

• isThemeUrl( $url : string ) : bool [Public Static]

  判断所传入的url是否是主题的Url。

  Return : true : 是; false : 否

• isBoardThemeModeUrl( $url : string ) : bool [Public Static]

  判断所传入的url是否是主题模式的版块的Url。

  Return : true : 是; false : 否

• isBoardPostModeUrl( $url : string ) : bool [Public Static]

  判断所传入的url是否是一般模式的版块的Url。

  Return : true : 是; false : 否

• getUserInfoUrl( $id : string ) : string [Public Static]

  Return : 用于查询id为$id的用户信息的Url

• resolvePostUrl( $post : Post ) : void [Public Static]

  将传入的Post的$post->url解析成$board、$file、$num，并分别设置到$post->board、$post->file、$post->num上。

• generatePostUrl( $post : Post ) : void [Public Static]

  resolvePostUrl的逆过程。依照传入的Post的$post->board、$post->file、$post->num来生成$url，并设置到$post->url上。

• resolveThemeUrl( $theme : Theme ) : void [Public Static]

  将传入的Theme的$theme->url解析成$board、$gid，并分别设置到$theme->board、$theme->gid上。

• generateThemeUrl( $theme : Theme ) : void [Public Static]

  resolveThemeUrl的逆过程。依照传入的Theme的$theme->board、$theme->gid来生成$url，并设置到$theme->url上。

• getBoardThemeModeUrl( $id : string ) : string [Public Static]

  Return : id为$id的版块的主题模式的Url。

• getBoardPostModeUrl( $id : string ) : string [Public Static]

  Return : id为$id的版块的一般模式的Url。

• getThemeSetUrl( $id : string $num : int ) : string [Public Static]

  Param :

  1. $id : 要查询的版块的id。
  2. $num : 要查询帖子的序号。

  Return : 用于查询板块中特定序号的贴子的url。

• getLoginUrl( $id : string, $password : string ) : string

  Param :

  1. $id : 用户id。
  2. $password : 密码。

  Return : 用于登陆的Url。

• getFriendListUrl() : string

  Return : 好友列表的Url。

• getAddFriendUrl( $id : string, $password : string ) : string

  Params :

  1. $id : 好友id。
  2. $introduce : 好友说明。

  Return : 添加好友的Url。

• getDelFriendUrl( $id : string ) : string

  Params :

  1. $id : 好友id。

  Return : 删除好友的Url。

静态类。用于解析html的实用方法集。

• fetchProp( $ipnut : string, $begin='' : string, $end='' : string ) : string

  获取输入字符串（$ipnut ）中夹在$begin和$end的部分。若$end为''，则为$begin到字符串结尾。若$begin为''，则为字符串开始到$end。多用于解析html时，获取特定的属性。

静态类。和Cookie相关的实用方法集。

• generateCookie( $cookieStr : string ) : Lily_Cookie [Public Static]

  将登陆后百合服务器返回的Cookie由解析成字符串解析成Lily_Cookie用来维持Session。

• setCookie( $httpMessage : Lily_HttpMessage, $cookie : Lily_Cookie ) : void [Public Static]

  将$cookie转换成Http消息头中的Cookie项，并添加到$httpMessage的Header中。

静态类。与登陆验证有关的实用方法集。

• login( $id : string, $password : string ) : Lily_Cookie / bool [Public Static]

  登陆，成功返回Cookie，否则返回false。

  Param :

  1. $id : 账号id。
  2. $password : 账号密码。

抽象的Http消息。

• getHeaders() : [ string=>string] [Public]

  Return : 存储Http头信息的数组。

• getHeader( $name : string ) : string [Public]

  Return : Http头中名称为$name（如'Content-Type'）的项的值。

• addHeader( $name : string, $value : string ) : void [Public]

  添加Http头项。

  Param :

  1. $name : 名称
  2. $value : 键值

• getContent() : string [Public]

  Return : Http消息的Content。

• setContent( $content : string ) : void [Public]

  设置Http消息的Content。

继承自Lily_HttpMessage。Http请求。

• __construct( $url='' : string, $method='GET' : string ) [Public]

  构造函数。

  Param :

  1. $url : http请求的Url。
  2. $method : http请求的方法。'GET' / 'SET'。

• resolveUrl( $url : string ) : string [Public]

  就是nslookup啦~~不过偷了个懒哈~看看方法体就知道了~

• generateHeader( $output='' : string ) : string

  生成最终的文本形式的Http请求的头。生成的字符串会附加在$output上，并返回。

• generateContent( $output : string ) : string

  生成最终的文本形式的Http请求的内容。生成的字符串会附加在$output上，并返回。

• generateMessage() : string

  Return : 最终的文本形式的Http请求。

• clearHeader() : void

  清空Http请求的头数据。

• getResponse() : Lily_HttpResponse

  发送该http请求，并将Response返回。