WordPress_Core
[ class tree: WordPress_Core ] [ index: WordPress_Core ] [ all elements ]

Class: WordPress_Core_API

Source Location: /core/API.class.php

Class Overview


WordPress XML-RPC API用基底クラス


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2009 Takahiro Ooishi

Variables

Constants

Methods


Child classes:

WordPress_API
WordPress XML-RPC API用拡張クラス

Class Details

[line 37]
WordPress XML-RPC API用基底クラス

WordPress XML-RPC APIにて共通的に使用する機能を集めた用基底クラス




Tags:

author:  Takahiro Ooishi <taka0125@users.sourceforge.jp>
version:  Release: @package_version@
copyright:  2009 Takahiro Ooishi
see:  http://codex.wordpress.org/XML-RPC_wp
abstract:  
license:  New BSD License


[ Top ]


Class Variables

$config =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]

$connection =

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$errorFlg =

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$faultCode =

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]

$faultString =

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 53]

void __construct( object $config)

コンストラクタ



Parameters:

object   $config   WordPress_Configクラスのインスタンス

[ Top ]

destructor __destruct [line 66]

void __destruct( )

デストラクタ



[ Top ]

method buildRequest [line 223]

string buildRequest( string $function_name, array $params)

XML-RPCリクエスト用XMLの作成



Tags:

return:  XML-RPCリクエスト用XML
access:  protected


Parameters:

string   $function_name   コールする関数名
array   $params   パラメータ

[ Top ]

method clearError [line 159]

void clearError( )

エラー情報を初期化する



Tags:

access:  protected


[ Top ]

method close [line 211]

void close( mixed $connection)

Curlコネクションの削除



Tags:

access:  protected


Parameters:

mixed   $connection   Curlコネクション

[ Top ]

method config [line 79]

object 保持しているconfigを返す config( )

configを返す



[ Top ]

method faultCode [line 137]

string faultCode( )

直近のリクエストでのfaultCodeを返す



Tags:

return:  faultCode


[ Top ]

method faultString [line 148]

string faultString( )

直近のリクエストでのfaultStringを返す



Tags:

return:  faultString


[ Top ]

method getError [line 126]

string getError( )

直近のリクエストでのエラー内容を返す



Tags:

return:  エラー内容


[ Top ]

method isError [line 116]

bool isError( )

直近のリクエストの成功/失敗を返す



Tags:

return:  エラー時:true,成功時:false


[ Top ]

method isValidConfig [line 272]

bool isValidConfig( object $config)

正当なコンフィグオブジェクトかチェック



Tags:

return:  正当:true,不正:false
access:  protected


Parameters:

object   $config   チェックするオブジェクト

[ Top ]

method open [line 188]

mixed open( )

Curlコネクションの作成



Tags:

return:  Curlコネクション
access:  protected


[ Top ]

method request [line 238]

array request( string $request)

XML-RPCリクエスト実行



Tags:

return:  XML-RPCリクエスト結果
access:  protected


Parameters:

string   $request   XML-RPCリクエスト用XML

[ Top ]

method setConfig [line 90]

void setConfig( object $config)

configを設定する



Parameters:

object   $config   WordPress_Configクラスのインスタンス

[ Top ]

method setError [line 172]

void setError( array $results)

リクエストのエラー情報を設定する



Tags:

access:  protected


Parameters:

array   $results   リクエスト結果

[ Top ]

method setTimeout [line 101]

bool setTimeout( integer $timeout)

Curlのタイムアウトを設定する



Tags:

return:  成功時:true,失敗時:false


Parameters:

integer   $timeout   タイムアウト秒数(1以上)

[ Top ]


Class Constants

DefaultTimeOut =  10

[line 45]


[ Top ]



Documentation generated on Sun, 04 Oct 2009 03:42:59 +0900 by phpDocumentor 1.4.3