Previous Next

Zend_Service_Akismet

導入

Zend_Service_Akismet は、 » Akismet API のクライアント機能を提供します。Akismet サービスは、 入力データがスパムかどうかを判定するために用いられます。 また、あるデータを「スパムである」とか「無実である (ハム)」 などと登録するためのメソッドも公開しています。 もともとは Wordpress 向けのスパムを識別するために作られたものですが、 あらゆる型のデータに対して使用できます。

Akismet を使用するには API キーが必要です。 キーを取得するには » WordPress.com でアカウントを作成します。blog を作成する必要はありません。 単にアカウントを作成するだけで API キーが使用できます。

さらに、Akismet を使用する場合は、 フィルタリングしたいデータを指す URL を指定してリクエストする必要があります。 Akismet は WordPress 向けに作られたものであることから、 これは blog url と呼ばれます。 これは、コンストラクタの二番目の引数として渡さなければなりません。 ただ、いつでも setBlogUrl() で変更することができますし、 その他のメソッドコールの際に 'blog' キーを指定して上書きすることもできます。

API キーの検証

Zend_Service_Akismet::verifyKey($key) を使用して、Akismet API キーが有効かどうかを検証します。 たいていの場合は特に検証する必要もないでしょうが、 改ざんされていないかどうか調べたり、 新しく取得したキーが実際に使用可能かどうかを調べたり といった場合にこのメソッドを使用します。

verifyKey($apiKey) {
echo "このキーは有効です。\n";
} else {
echo "このキーは無効です。\n";
}

引数を指定せずにコールすると、verifyKey() はコンストラクタで指定した API キーを使用します。

verifyKey() は、Akismet の verify-key REST メソッドを実装したものです。

スパムのチェック

Zend_Service_Akismet::isSpam($data) を使用して、Akismet がそのデータをスパムとみなすかどうかを調べます。 引数はひとつで、ここに連想配列を指定することができます。 この配列には、次のキーを設定しなければなりません。

  • user_ip は、データを送信したユーザの IP アドレスです (あなたの IP アドレスではなく、 あなたのサイトを使用しているユーザの IP アドレスです)。

  • user_agent は、データを送信したユーザの UserAgent 文字列 (ブラウザおよびバージョン) です。

以下のキーも、API 側で認識されます。

  • blog は、リソースやアプリケーションを指す 完全な URL です。指定しなかった場合は、 コンストラクタに渡した URL を使用します。

  • referrer は、送信時の HTTP_REFERER ヘッダの内容です (スペルに注意しましょう。ヘッダの名前とは異なります)。

  • permalink は、送信するデータの永続的な場所 (もしあれば) です。

  • comment_type は、データの形式です。 ここで指定する値は API で定義されており、 'comment'、'trackback'、'pingback' およb 空の文字列 ('') などがあります。しかし、 任意の値を指定することができます。

  • comment_author は、データの送信者の名前です。

  • comment_author_email は、 データの送信者のメールアドレスです。

  • comment_author_url は、 データの送信者の URL あるいはホームページです。

  • comment_content は、 実際に送信されたデータの内容です。

その他の環境変数の内容を送信し、 そのデータがスパムであるかどうかの判断材料とさせることもできます。 Akismet は、$_SERVER 配列の中身をすべて送信することを推奨しています。

isSpam() メソッドは true あるいは false を返します。 API キーが無効な場合は例外をスローします。

Example #1 isSpam() の使用法

 '111.222.111.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.2; en-GB; rv:1.8.1) Gecko/20061010 Firefox/2.0',
    'comment_type'         => 'contact',
    'comment_author'       => '誰かさん',
    'comment_author_email' => 'nospam@myhaus.net',
    'comment_content'      => "スパマーじゃないもん。信じて!"
);
if ($akismet->isSpam($data)) {
    echo "悪いけど、たぶんあなたはスパマーでしょう。";
} else {
    echo "私たちのサイトへようこそ!";
}

isSpam() は、Akismet API のメソッド comment-check を実装したものです。

既知のスパムの送信

時には、スパムがフィルタを通過してしまうこともあります。 フィルタを通過したデータの中に、もし「これはスパムだろう」 というものが見つかったら、それを Akismet に送信しましょう。それにより、フィルタの性能が向上します。

Zend_Service_Akismet::submitSpam() に指定する配列は、 isSpam() に渡すものと同じ形式です。 しかし、このメソッドは値を返しません。 API キーが無効な場合は例外が発生します。

Example #2 submitSpam() の使用法

 '111.222.111.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.2; en-GB; rv:1.8.1) Gecko/20061010 Firefox/2.0',
    'comment_type'         => 'contact',
    'comment_author'       => '誰かさん',
    'comment_author_email' => 'nospam@myhaus.net',
    'comment_content'      => "スパマーじゃないもん。信じて!"
);
$akismet->submitSpam($data));

submitSpam() は、Akismet API のメソッド submit-spam を実装したものです。

無実のデータ (ハム) の送信

時には、Akismet が間違ってスパムと判定してしまうこともあります。 そのため、Akismet がスパムと判断したデータのログを定期的にチェックする必要があります。 このような現象を発見したら、そのデータを Akismet に「ハム」 あるいは無実のデータとして送信しましょう (ハムは善玉、スパムは悪玉です)。

Zend_Service_Akismet::submitHam() に指定する配列は、 isSpam()submitSpam() に渡すものと同じ形式です。また、 submitSpam() と同様、値を返しません。 API キーが無効な場合は例外が発生します。

Example #3 submitHam() の使用法

 '111.222.111.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.2; en-GB; rv:1.8.1) Gecko/20061010 Firefox/2.0',
    'comment_type'         => 'contact',
    'comment_author'       => '誰かさん',
    'comment_author_email' => 'nospam@myhaus.net',
    'comment_content'      => "スパマーじゃないもん。信じて!"
);
$akismet->submitHam($data));

submitHam() は、Akismet API のメソッド submit-ham を実装したものです。

Zend 固有のアクセス用メソッド

Akismet API では四つのメソッドしか定義されていませんが、 Zend_Service_Akismet では それ以外のアクセス用メソッドも用意しています。 これらを使用して、内部のプロパティを変更します。

  • getBlogUrl() および setBlogUrl() は、リクエストで使用する blog URL を取得したり変更したりします。

  • getApiKey() および setApiKey() は、リクエストで使用する API キーを取得したり変更したりします。

  • getCharset() および setCharset() は、リクエストで使用する文字セットを取得したり変更したりします。

  • getPort() および setPort() は、リクエストで使用する TCP ポートを取得したり変更したりします。

  • getUserAgent() および setUserAgent() は、リクエストで使用する HTTP ユーザエージェントを 取得したり変更したりします。 注意: これは、サービスに送信するデータの user_agent ではありません。サービスへのリクエストを作成する際に HTTP User-Agent ヘッダで指定する内容となります。

    ユーザエージェントに設定する値は some user agent/version | Akismet/version 形式でなければなりません。デフォルトは Zend Framework/ZF-VERSION | Akismet/1.11 です。ZF-VERSION の部分には現在の Zend Framework のバージョン、つまり定数 Zend_Framework::VERSION の値があてはまります。

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
Introduction
Captcha Operation
Captcha Adapters
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Console_Getopt
Getopt について
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ: Zend_Controller_Router_Rewrite
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helpers
Dojo Form Elements and Decorators
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Validators for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
Gdata について
AuthSub による認証
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
YouTube Data API の使用法
Picasa Web Albums の使用法
Gdata の例外処理
Zend_Http
Zend_Http_Client - 導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
JSON オブジェクト
XML から JSON への変換
Zend_Json_Server - JSON-RPC server
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
ロケールがサポートする言語
ロケールがサポートする地域
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
Introduction
Usage
Configuration
Advanced usage
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ドキュメントのページ
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery. Introduction
Class autodiscovering.
Functions autodiscovering.
Autodiscovering. Datatypes.
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
PHP のバージョン
PHP の拡張モジュール
Zend Framework のコンポーネント
Zend Framework の依存性
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
著作権に関する情報