Previous Next

Zend_ProgressBar

導入

Zend_ProgressBar は、 さまざまな環境上でプログレスバーの作成や更新を行うコンポーネントです。 単一のバックエンドが、複数のアダプタの中のいずれかを用いて進捗状況を出力します。 更新のたびに現在値とオプションのメッセージを受け取り、 進捗率や残り時間などを計算してアダプタを呼び出します。

Zend_Progressbar の基本的な使用法

Zend_ProgressBar の使い方はきわめて簡単です。 単純に Zend_Progressbar の新しいインスタンスを作成し、 最小値と最大値を指定した上でデータ出力用のアダプタを選択するだけです。 何かのファイルの処理を行いたい場合は、たとえば次のようになります。

$progressBar = new Zend_ProgressBar($adapter, 0, $fileSize);

while (!feof($fp)) {
    // なにかの処理

    $progressBar->update($currentByteCount);
}

$progressBar->finish();

まず第一段階として、Zend_ProgressBar のインスタンスを作成してアダプタを指定し、 最小値を 0、最大値をファイルのサイズに指定します。 ループ内でファイルが処理されるたびに、 現在のバイト数でプログレスバーを更新します。 ループを抜けた後で、プログレスバーを処理完了状態に設定します。

Zend_ProgressBarupdate() メソッドを引数なしでコールすることもできます。 その場合は、単に残り時間を再計算してアダプタに通知します。 これは、データが何も更新されていないけれども プログレスバーを更新したいという場合に有用です。

進捗の永続化

複数のリクエストにまたがってプログレスバーを持続させたい場合は、 コンストラクタの 4 番目の引数でセッション名前空間名を指定します。 そうすると、プログレスバーのコンストラクタ内ではアダプタへの通知が行われず update() あるいは finish() をコールしたときにのみ通知が行われるようになります。 また、現在の値や状況表示用テキスト、 そして残り時間計算用の開始時刻などは次のリクエストにも引き継がれるようになります。

標準のアダプタ

Zend_ProgressBar には次の 3 つのアダプタが同梱されています。

Zend_ProgressBar_Adapter_Console

Zend_ProgressBar_Adapter_Console は、 ターミナル用に使用するテキストベースのアダプタです。 ターミナルの横幅を自動的に検出することができますが、 独自に幅を指定することもできます。 プログレスバーとともに表示する要素や、その順序も変更することができます。 また、プログレスバーそのものの形式も設定することが可能です。

Note: 自動的なコンソール幅の認識

この機能を *nix 系のシステムで使用するには shell_exec が必要です。Windows ではターミナルの幅は 80 文字固定なので、 認識処理は不要です。

アダプタのオプションを設定するには、set* メソッドを使用するか、あるいはコンストラクタの最初のパラメータで 配列か Zend_Config インスタンスを渡します。 使用できるオプションは次のとおりです。

  • outputStream: さまざまな出力ストリーム。 STDOUT 意外に出力したい場合に使用します。 php://stderr のようなストリーム、 あるいはファイルへのパスを指定できます。

  • width: 整数値、あるいは Zend_Console_ProgressBar の定数 AUTO

  • elements: デフォルトは NULL。 あるいは以下の Zend_Console_ProgressBar の定数のうちの少なくともひとつを値として持つ配列。

    • ELEMENT_PERCENT: パーセントであらわした現在値。

    • ELEMENT_BAR: パーセンテージを表示するバー。

    • ELEMENT_ETA: 自動的に計算した予想残り時間。 この要素が表示されるのは、開始後 5 秒たってからです。 それまでは正確な結果を算出できないからです。

    • ELEMENT_TEXT: 現在の処理に関する状況を説明するオプションのメッセージ。

  • textWidth: ELEMENT_TEXT 要素の幅を文字数で表したもの。デフォルトは 20。

  • charset: ELEMENT_TEXT 要素の文字セット。デフォルトは utf-8。

  • barLeftChar: プログレスバー内で左側のインジケータとして使用する文字列。

  • barRightChar: プログレスバー内で右側のインジケータとして使用する文字列。

  • barIndicatorChar: プログレスバー内でインジケータとして使用する文字列。 これは空にすることもできます。

Zend_ProgressBar_Adapter_JsPush

Zend_ProgressBar_Adapter_JsPush は、 ブラウザ内のプログレスバーを Javascript の Push で更新するアダプタです。 つまり、実行中のプロセスの情報を取得するために改めて接続を行う必要がなく、 そのプロセス自身が状況を直接ブラウザに送信するということです。

アダプタのオプションを設定するには、set* メソッドを使用するか、あるいはコンストラクタの最初のパラメータで 配列か Zend_Config インスタンスを渡します。 使用できるオプションは次のとおりです。

  • updateMethodName: 毎回の更新時にコールされる javascript のメソッド。 デフォルト値は Zend_ProgressBar_Update です。

  • finishMethodName: 状態を設定した後にコールされる javascript のメソッド。 デフォルト値は NULL で、この場合は何も行われません。

このアダプタの使い方はきわめて単純です。まず、ブラウザ上にプログレスバーを作成します。 これは JavaScript を用いたものでもかまいませんしプレーンな HTML によるものでもかまいません。それから、更新時のメソッドと 終了時のメソッド (オプション) を JavaScript で定義します。 これらのメソッドは、どちらも唯一の引数として json オブジェクトを受け取るようにします。 そして、処理時間が長くかかるウェブページを iframe タグあるいは object タグの中で呼び出します。処理の実行中に、 更新が行われるたびにアダプタのメソッドがコールされます。 引数として渡される json オブジェクトには次のパラメータが含まれています。

  • current: 現在の値。

  • max: 最大値。

  • percent: 算出したパーセンテージ。

  • timeTaken: これまでの経過時間。

  • timeRemaining: プロセスが終了するまでの予想残り時間。

  • text: オプションのメッセージ (指定した場合のみ)。

Example #1 クライアント側の基本例

この例では、JsPush アダプタ用の HTML および CSS、JavaScript の基本的な設定方法を示します。

#long-running-process {
    position: absolute;
    left: -100px;
    top: -100px;

    width: 1px;
    height: 1px;
}

#zend-progressbar-container {
    width: 100px;
    height: 30px;

    border: 1px solid #000000;
    background-color: #ffffff;
}

#zend-progressbar-done {
    width: 0;
    height: 30px;

    background-color: #000000;
}
function Zend_ProgressBar_Update(data)
{
    document.getElementById('zend-progressbar-done').style.width = data.percent + '%';
}

これは、黒の枠線と進捗状況表示用ブロックからなるシンプルなコンテナを作成します。 iframeobjectdisplay: none; で隠してしまってはいけません。Safari 2 などでは、 そうすると実際のコンテンツを読み込まなくなってしまします。

プログレスバーを自作するのではなく、Dojo や jQuery などの既存の JavaScript ライブラリのものを利用したいこともあるでしょう。 たとえば次のようなものがあります。

  • Dojo: http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/user-assistance-and-feedback/progress-bar

  • jQuery: http://t.wits.sg/2008/06/20/jquery-progress-bar-11/

  • MooTools: http://davidwalsh.name/dw-content/progress-bar.php

  • Prototype: http://livepipe.net/control/progressbar

Note: 更新感覚

あまり頻繁に更新しすぎないようにしましょう。 毎回の更新は、少なくとも 1kb の大きさとなるからです。 これは、Safari が実際にレンダリングを行って関数をコールするのに必要なサイズです。 Internet Explorer の場合はこれは 256 バイトとなります。

Zend_ProgressBar_Adapter_JsPull

Zend_ProgressBar_Adapter_JsPull は jsPush とは逆の動作をします。つまり、 更新をブラウザにプッシュするのではなく更新情報をほかから受け取ることになります。 一般に、このアダプタを使う場合は Zend_ProgressBar の persistence オプションを使用する必要があります。 通知を受け取ると、このアダプタは JSON 文字列をブラウザに送ります。 その内容は jsPush アダプタから送られてくるものとほぼ同じです。 唯一の違いは、追加のパラメータ finished が含まれることです。このパラメータは、 update() がコールされた場合は FALSEfinish() がコールされた場合は TRUE となります。

アダプタのオプションを設定するには、set* メソッドを使用するか、あるいはコンストラクタの最初のパラメータで 配列か Zend_Config インスタンスを渡します。 使用できるオプションは次のとおりです。

  • exitAfterSend: データがブラウザに送信された後に、 現在のリクエストを終了します。デフォルトは TRUE です。

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server
Zend_Application
導入
Zend_Application Quick Start
Theory of Operation
Examples
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGeneratorリファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
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
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Zend_File_Transfer 用のバリデータ
Filters 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
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
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_Navigation
Introduction
画面
Containers
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
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_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
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_Twitter
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDLアクセッサ
自動検出
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project導入
Create A Project
Zend Tool Project Providers
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 のシステム要件
導入
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework Performance Guide
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報