[ja] translate ja/console-and-shells/helpers.rst

ja/console-and-shells/helpers.rst

@@ -1,12 +1,111 @@
-Shell Helpers
-#############
+Shell ヘルパー
+##############
 
-.. note::
-    The documentation is not currently supported in ja language for this page.
+.. versionadded:: 2.8
+    Shell ヘルパーは、2.8.0 で追加されました。
 
-    Please feel free to send us a pull request on
-    `Github <https://github.com/cakephp/docs>`_ or use the **Improve This Doc**
-    button to directly propose your changes.
+Shell ヘルパーは、複雑な出力生成コードをまとめられます。Shell ヘルパーは、
+任意のシェルやタスクからアクセスや使用ができます。 ::
 
-    You can referer to the english version in the select top menu to have
-    information about this page's topic.
+    // 表としてデータを出力
+    $this->helper('table')->output($data);
+
+    // プラグインからヘルパーを取得
+    $this->helper('Plugin.HelperName')->output($data);
+
+また、ヘルパーのインスタンス取得や、そのインスタンスのパブリックメソッドの呼び出しができます。 ::
+
+    // Progress ヘルパーの取得と使用
+    $progress = $this->helper('Progress');
+    $progress->increment(10);
+    $progress->draw();
+
+ヘルパーの作成
+===============
+
+CakePHP は、いくつかの Shell ヘルパーを用意していますが、あなたのアプリケーションや
+プラグインの中で、新たに作成することができます。例として、装飾的なヘッダーを生成するための
+単純なヘルパーを作成してみましょう。最初に **app/Console/Helper/HeadingHelper.php** を
+作成し、以下のように記述します。 ::
+
+    <?php
+    App::uses("BaseShellHelper", "Console/Helper");
+
+    class HeadingHelper extends BaseShellHelper
+    {
+        public function output($args)
+        {
+            $args += array('', '#', 3);
+            $marker = str_repeat($args[1], $args[2]);
+            $this->_consoleOutput->out($marker . ' ' . $args[0] . ' ' . $marker);
+        }
+    }
+
+以下のように、あるシェルコマンドの中でこの新しいヘルパーを使用することができます。 ::
+
+    // 両側に ### を追加
+    $this->helper('heading')->output('It works!');
+
+    // 両側に ~~~~ を追加
+    $this->helper('heading')->output('It works!', '~', 4);
+
+組込ヘルパー
+=============
+
+Table ヘルパー
+--------------
+
+TableHelper は、アスキーアートの表の作成を支援します。使い方は、とてもシンプルです。 ::
+
+        $data = array(
+            array('Header 1', 'Header', 'Long Header'),
+            array('short', 'Longish thing', 'short'),
+            array('Longer thing', 'short', 'Longest Value'),
+        );
+        $this->helper('table')->output($data);
+
+        // 出力結果
+        +--------------+---------------+---------------+
+        | Header 1     | Header        | Long Header   |
+        +--------------+---------------+---------------+
+        | short        | Longish thing | short         |
+        | Longer thing | short         | Longest Value |
+        +--------------+---------------+---------------+
+
+Progress ヘルパー
+-----------------
+
+ProgressHelper は２つの異なる方法で利用されます。シンプルなモードは、
+処理が完了するまでに呼び出されるコールバックを渡すことができます。 ::
+
+    $this->helper('progress')->output(function ($progress) {
+        // ここで作動します
+        $progress->increment(20);
+    });
+
+追加のオプションを渡すことで、プログレスバーの制御ができます。
+
+- ``total`` プログレスバーの全アイテム数。デフォルトは 100 です。
+- ``width`` プログレスバーの幅。デフォルトは 80 です。
+- ``callback`` プログレスバーを更新するループ中で呼ばれるコールバック。
+
+全てのオプションを使用した例です。 ::
+
+    $this->helper('progress')->output(array(
+        'total' => 10,
+        'width' => 20,
+        'callback' => function ($progress) {
+            $progress->increment(2);
+        }
+    ));
+
+Progress ヘルパーは、必要であればプログレスバーの増加や再描画を手動で行うことができます。 ::
+
+    $progress = $this->helper('Progress');
+    $progress->init(array(
+        'total' => 10,
+        'width' => 20,
+    ));
+
+    $this->helper->increment(4);
+    $this->helper->draw();