書き換えAPIを使用したRESTful URLの作成
私はRESTful APIの書き換えルールを生成しようとしています。私はただ、あらゆる書き換えの組み合わせを書き出さなければならないよりも、この作品を作るためのより良い方法があるかどうかを見たいだけです。
わかりましたので、URLに含める4つのクエリ変数があります
- インジケータ
- 国
- 応答
- 調査
基本URLはwww.example.com/some-page/になります。4つの変数の順序は一貫していますが、いくつかのクエリ変数はオプションです。
だから私は….
/indicator/{indicator value}/country/{country value}/response/{response value}/survey/{survey value}/
または...（いいえ/応答/）
/indicator/{indicator value}/country/{country value}/survey/{survey value}/
または...
/indicator/{indicator value}/country/{country value}/
rewrite_rules_arrayをフィルタリングして手動で作成した私の書き換えルールの配列を追加するよりもこれを達成するためのより良い方法はありますか？ add_rewrite_endpoint() rewrite_endpointまたはadd_rewrite_tag()は私にとって何か役に立つものでしょうか。
私は最良の選択肢はエンドポイントだと思います。すべてのデータを単純な文字列として取得するので、解析方法を決定できます。他の書き換え規則との衝突について心配する必要はありません。
私がエンドポイントについて学んだことの1つは、メインの作業を可能な限り抽象的なものにし、WordPressのAPIの不具合をデータにとらわれない方法で修正することです。
ロジックを3つの部分に分けます。a controller モデルとビューを選択し、 model はエンドポイントを処理し、1つ以上は views を返します有用なデータやエラーメッセージ。
コントローラー
コントローラから始めましょう。それほど多くは行われないので、ここでは非常に単純な関数を使用します。
add_action( 'plugins_loaded', 't5_cra_init' );
function t5_cra_init()
{
require dirname( __FILE__ ) . '/class.T5_CRA_Model.php';
$options = array (
'callback' => array ( 'T5_CRA_View_Demo', '__construct' ),
'name' => 'api',
'position' => EP_ROOT
);
new T5_CRA_Model( $options );
}
基本的には、モデルT5_CRA_Modelをロードし、いくつかのパラメータを渡します…そしてすべての作業を渡します。コントローラは、モデルやビューの内部ロジックについては何も知りません。それは両方をくっつけるだけです。これは再利用できない唯一の部分です。だからこそ、私はそれを他の部分から切り離していました。
少なくとも2つのクラスが必要です。APIを登録する model と、出力を作成する view です。
モデル
このクラスは：
- エンドポイントを登録する
- 追加のパラメータなしでエンドポイントが呼び出された場合のキャッチケース
- サードパーティコードのいくつかのバグのために欠けている書き換えルールを埋める
EP_ROOTの静的フロントページとエンドポイントに関するWordPressの不具合を修正しました- uRIを解析して配列にします（これも分離できます）。
- それらの値でコールバックハンドラを呼び出す
私はコードがそれ自身のために話すことを願っています。 :)
モデルは、データの内部構造やプレゼンテーションについては何も知りません。したがって、1行を変更せずに何百ものAPIを登録するためにそれを使用することができます。
<?php # -*- coding: utf-8 -*-
/**
* Register new REST API as endpoint.
*
* @author toscho http://toscho.de
*
*/
class T5_CRA_Model
{
protected $options;
/**
* Read options and register endpoint actions and filters.
*
* @wp-hook plugins_loaded
* @param array $options
*/
public function __construct( Array $options )
{
$default_options = array (
'callback' => array ( 'T5_CRA_View_Demo', '__construct' ),
'name' => 'api',
'position' => EP_ROOT
);
$this->options = wp_parse_args( $options, $default_options );
add_action( 'init', array ( $this, 'register_api' ), 1000 );
// endpoints work on the front end only
if ( is_admin() )
return;
add_filter( 'request', array ( $this, 'set_query_var' ) );
// Hook in late to allow other plugins to operate earlier.
add_action( 'template_redirect', array ( $this, 'render' ), 100 );
}
/**
* Add endpoint and deal with other code flushing our rules away.
*
* @wp-hook init
* @return void
*/
public function register_api()
{
add_rewrite_endpoint(
$this->options['name'],
$this->options['position']
);
$this->fix_failed_registration(
$this->options['name'],
$this->options['position']
);
}
/**
* Fix rules flushed by other peoples code.
*
* @wp-hook init
* @param string $name
* @param int $position
*/
protected function fix_failed_registration( $name, $position )
{
global $wp_rewrite;
if ( empty ( $wp_rewrite->endpoints ) )
return flush_rewrite_rules( FALSE );
foreach ( $wp_rewrite->endpoints as $endpoint )
if ( $endpoint[0] === $position && $endpoint[1] === $name )
return;
flush_rewrite_rules( FALSE );
}
/**
* Set the endpoint variable to TRUE.
*
* If the endpoint was called without further parameters it does not
* evaluate to TRUE otherwise.
*
* @wp-hook request
* @param array $vars
* @return array
*/
public function set_query_var( Array $vars )
{
if ( ! empty ( $vars[ $this->options['name'] ] ) )
return $vars;
// When a static page was set as front page, the WordPress endpoint API
// does some strange things. Let's fix that.
if ( isset ( $vars[ $this->options['name'] ] )
or ( isset ( $vars['pagename'] ) and $this->options['name'] === $vars['pagename'] )
or ( isset ( $vars['page'] ) and $this->options['name'] === $vars['name'] )
)
{
// In some cases WP misinterprets the request as a page request and
// returns a 404.
$vars['page'] = $vars['pagename'] = $vars['name'] = FALSE;
$vars[ $this->options['name'] ] = TRUE;
}
return $vars;
}
/**
* Prepare API requests and hand them over to the callback.
*
* @wp-hook template_redirect
* @return void
*/
public function render()
{
$api = get_query_var( $this->options['name'] );
$api = trim( $api, '/' );
if ( '' === $api )
return;
$parts = explode( '/', $api );
$type = array_shift( $parts );
$values = $this->get_api_values( join( '/', $parts ) );
$callback = $this->options['callback'];
if ( is_string( $callback ) )
{
call_user_func( $callback, $type, $values );
}
elseif ( is_array( $callback ) )
{
if ( '__construct' === $callback[1] )
new $callback[0]( $type, $values );
elseif ( is_callable( $callback ) )
call_user_func( $callback, $type, $values );
}
else
{
trigger_error(
'Cannot call your callback: ' . var_export( $callback, TRUE ),
E_USER_ERROR
);
}
// Important. WordPress will render the main page if we leave this out.
exit;
}
/**
* Parse request URI into associative array.
*
* @wp-hook template_redirect
* @param string $request
* @return array
*/
protected function get_api_values( $request )
{
$keys = $values = array();
$count = 0;
$request = trim( $request, '/' );
$tok = strtok( $request, '/' );
while ( $tok !== FALSE )
{
0 === $count++ % 2 ? $keys[] = $tok : $values[] = $tok;
$tok = strtok( '/' );
}
// fix odd requests
if ( count( $keys ) !== count( $values ) )
$values[] = '';
return array_combine( $keys, $values );
}
}
景色
今私達は私達のデータで何かをしなければなりません。不完全なリクエストのために欠けているデータをキャッチしたり、他のビューやサブコントローラに処理を委任することもできます。
これは非常に簡単な例です。
class T5_CRA_View_Demo
{
protected $allowed_types = array (
'plain',
'html',
'xml'
);
protected $default_values = array (
'country' => 'Norway',
'date' => 1700,
'max' => 200
);
public function __construct( $type, $data )
{
if ( ! in_array( $type, $this->allowed_types ) )
die( 'Your request is invalid. Please read our fantastic manual.' );
$data = wp_parse_args( $data, $this->default_values );
header( "Content-Type: text/$type;charset=utf-8" );
$method = "render_$type";
$this->$method( $data );
}
protected function render_plain( $data )
{
foreach ( $data as $key => $value )
print "$key: $value\n";
}
protected function render_html( $data ) {}
protected function render_xml( $data ) {}
}
重要なのは、ビューがエンドポイントについて何も知らないということです。例えばwp-adminのAJAXリクエストなど、まったく異なるリクエストを処理するためにそれを使用することができます。ビューを独自のMVCパターンに分割することも、単純な関数を使用することもできます。