Previous Next

Captcha Adapters

The following adapters are shipped with Zend Framework by default.

Zend_Captcha_Word

Zend_Captcha_Word is an abstract adapter that serves as the basis for the Dumb, Figlet, and Image adapters. It provides mutators for specifying word length, session TTL, the session namespace object to use, and the session namespace class to use for persistence if you do not wish to use Zend_Session_Namespace. Additionally, it encapsulates all validation logic.

By default, the word length is 8 characters, the session timeout is 5 minutes, and Zend_Session_Namespace is used for persistence (using the namespace "Zend_Form_Captcha_<captcha ID>").

In addition to the standard methods required by the Zend_Captcha_Adapter interface, Zend_Captcha_Word exposes the following methods:

  • setWordLen($length) and getWordLen() allow you to specify the length of the generated "word" in characters, and to retrieve the current value.

  • setTimeout($ttl) and getTimeout() allow you to specify the time-to-live of the session token, and to retrieve the current value. $ttl should be specified in seconds.

  • setSessionClass($class) and getSessionClass() allow you to specify an alternate Zend_Session_Namespace implementation to use to persist the captcha token, as well as to retrieve the current value.

  • getId() allows you to retrieve the current token identifier.

  • getWord() allows you to retrieve the generated word to use with the captcha; it will generate it for you if none has been generated yet.

  • setSession(Zend_Session_Namespace $session) allows you to specify a session object to use for persisting the captcha token; getSession() allows you to retrieve the current session object.

All Word captchas allow you to pass an array of options to the constructor, or, alternately, pass them to setOptions() (or pass a Zend_Config object to setConfig()). By default, the wordLen, timeout, and sessionClass keys may all be used; each concrete implementation may define additional keys or utilize the options in other ways.

Note:

Remeber, Word is an abstract class and may not be instantiated directly.

Zend_Captcha_Dumb

The Dumb adapter is mostly self-describing. It provides a random string that needs to be typed in reverse to validate. As such, it's not a good CAPTCHA solution, and should only be used either for testing or as a last resort. It extends Zend_Captcha_Word.

Zend_Captcha_Figlet

The Figlet adapter utilizes Zend_Text_Figlet to present a Figlet to the user. Figlet captchas are limited to characters only.

Options passed to the constructor will also be passed to the Zend_Text_Figlet object the adapter utilizes; see that documentation for details on what configuration options may be utilized.

Zend_Captcha_Image

The Image adapter takes the word generated and renders it as an image, performing various skewing permutations on it to make it difficult to automatically decipher. To perform its work, it requires the » GD extension compiled with TrueType or Freetype support. Currently, the Image adapter can only generate PNG images.

Zend_Captcha_Image extends Zend_Captcha_Word, and additionally exposes the following methods:

  • setExpiration($expiration) and getExpiration() allow you to specify a maximum lifetime a captcha image may reside on the filesystem. This is typically a longer duration than the session lifetime. Garbage collection is run periodically each time the captcha object is invoked, and images that have expired will be cleaned up. Expiration values are in seconds.

  • setGcFreq($gcFreq) and getGcFreg() allow you to specify how frequently garbage collection should run. Garbage collection will run every 1/$gcFreq calls (default is 100).

  • setFont($font) and getFont() allow you to specify the font you wish to utilize. It should be a fully qualified path to the font file to utilize. If you do not set this value, the captcha will throw an exception during generation; the font is mandatory.

  • setFontSize($fsize) and getFontSize() allow you to specify the font size, in pixels, to use when generating the captcha. This defaults to 24px.

  • setHeight($height) and getHeight() allow you to specify the height, in pixels, of the generated captcha image. This defaults to 50px.

  • setWidth($width) and getWidth() allow you to specify the width, in pixels, of the generated captcha image. This defaults to 200px.

  • setImgDir($imgDir) and getImgDir() allow you to specify the directory in which captcha images are stored. This defaults to "./images/captcha/", which should look relative to the bootstrap script.

  • setImgUrl($imgUrl) and getImgUrl() allow you to specify the relative path to a captcha image to use for the HTML markup. This defaults to "/images/captcha/".

  • setSuffix($suffix) and getSuffix() allows you to specify the filename suffix to utilize. This defaults to ".png". Note: changing this will not change the image type generated.

All of the above options may be passed as options to the constructor by simply removing the 'set' method prefix and casting the initial letter to lowercase: "suffix", "height", "imgUrl", etc.

Zend_Captcha_ReCaptcha

The ReCaptcha adapter utilizes Zend_Service_ReCaptcha to generate and validate captchas. It exposes the following methods:

  • setPrivKey($key) and getPrivKey() allow you to specify the private key you use with the ReCaptcha service. This must be specified during construction, though it may be overridden at any point.

  • setPubKey($key) and getPubKey() allow you to specify the public key you use with the ReCaptcha service. This must be specified during construction, though it may be overridden at any point.

  • setService(Zend_Service_ReCaptcha $service) and getService() allow you to specify and interact with the ReCaptcha service object.

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 ファイルの書式
命名規約
コーディングスタイル
著作権に関する情報