Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > erbライブラリ > ERBクラス

class ERB

クラスの継承リスト: ERB < Object < Kernel < BasicObject

Abstract

eRuby スクリプトを処理するクラス。

従来 ERbLight と呼ばれていたもので、 標準出力への印字が文字列の挿入とならない点が eruby と異なります。

使い方

ERB クラスを使うためには require 'erb' する必要があります。

例: 

require 'erb'

ERB.new($<.read).run

trim_mode

trim_mode は整形の挙動を変更するオプションです。次の振舞いを指定できます。

trim_mode に指定できる値は次の通りです。

実行例: 

# スクリプト
<% 3.times do |n| %>
% n = 0
* <%= n%>
<% end %>

# trim_mode = nil, '', 0

% n = 0
* 0

% n = 0
* 1

% n = 0
* 2

# trim_mode = 1, '>'
% n = 0
* 0% n = 0
* 1% n = 0
* 2

# trim_mode = 2, '<>'
% n = 0
* 0
% n = 0
* 1
% n = 0
* 2

# trim_mode = '%'

* 0

* 0

* 0

# trim_mode = '%>', '>%'
* 0* 0* 0

# trim_mode = '%<>', '<>%'
* 0
* 0
* 0

# スクリプト
<% 3.times do |n| -%>
% n = 0
  <%- m = 0 %>*
* <%= n%>
<% end -%>

# trim_mode = '%-'
*
* 0
*
* 0
*
* 0

# スクリプト
<% 3.times do |n| %>
% n = 0
  <%- m = 0 %>*
* <%= n%>
<% end %>

# trim_mode = '%'

  *
* 0

  *
* 0

  *
* 0

特異メソッド

new(eruby_script, safe_level=nil, trim_mode=nil, eoutvar='_erbout') -> ERB

eRubyスクリプト から ERB オブジェクトを生成して返します。

[PARAM] eruby_script:
eRubyスクリプト
[PARAM] safe_level:
eRubyスクリプトが実行されるときのセーフレベル
[PARAM] trim_mode:
整形の挙動を変更するオプション
[PARAM] eoutvar:
eRubyスクリプトの中で出力をためていく変数。eRuby スクリプトの中でさらに ERB を使うときに変更します。通常は指定する必要はありません。
version -> String

erb.rbのリビジョン情報を返します。

インスタンスメソッド

def_class(suplerklass=Object, methodname='erb') -> Class

変換した Ruby スクリプトをメソッドとして定義した無名のクラスを返します。

[PARAM] suplerklass:
無名クラスのスーパークラス
[PARAM] methodname:
メソッド名
def_method(mod, methodname, fname='(ERB)') -> nil

変換した Ruby スクリプトをメソッドとして定義します。

定義先のモジュールは mod で指定し、メソッド名は methodname で指定します。 fname はスクリプトを定義する際のファイル名です。主にエラー時に活躍します。

[PARAM] mod:
メソッドを定義するモジュール（またはクラス）
[PARAM] methodname:
メソッド名
[PARAM] fname:
スクリプトを定義する際のファイル名

例: 

erb = ERB.new(script)
erb.def_method(MyClass, 'foo(bar)', 'foo.erb')
def_module(methodname='erb') -> Module

変換した Ruby スクリプトをメソッドとして定義した無名のモジュールを返します。

[PARAM] methodname:
メソッド名
filename -> String

エラーメッセージを表示する際のファイル名を取得します。

filename= -> String

エラーメッセージを表示する際のファイル名を設定します。

filename を設定しておくことにより、エラーが発生した eRuby スクリプトの特定が容易になります。filename を設定していない場合は、エラー発生箇所は「 (ERB) 」という出力となります。

result(b=TOPLEVEL_BINDING) -> String

ERB を b の binding で実行し、結果の文字列を返します。

[PARAM] b:
eRubyスクリプトが実行されるときのbinding
run(b=TOPLEVEL_BINDING) -> nil

ERB を b の binding で実行し、結果を標準出力へ印字します。

[PARAM] b:
eRubyスクリプトが実行されるときのbinding
set_eoutvar(compiler, eoutvar = '_erbout') -> Array

ERBの中でeRubyスクリプトの出力をためていく変数を設定します。

ERBでeRubyスクリプトの出力をためていく変数を設定するために使用します。 この設定は ERB#new でも行えるため、通常はそちらを使用した方がより容易です。 本メソッドを使用するためには、引数にて指定する eRuby コンパイラを事前に生成しておく必要があります。

[PARAM] compiler:
eRubyコンパイラ
[PARAM] eoutvar:
eRubyスクリプトの中で出力をためていく変数
src -> String

変換した Ruby スクリプトを取得します。

Methods

Classes