Docs For Class Brownie

[line 44]
Brownie形式テストをHTMLへ自動整形する終了フィルタです。

Brownie_FilterクラスはBrownie形式テキストをHTMLへ自動変換する終了フィルタです。主に文書全体をBrownie形式テキストで構成している場合に有用です。

なお、Brownie形式テキストはBODY内部の本文のみを生成するテキストフォーマッタです。従ってBrownie形式テキストをフォーマットしただけではHTML文書として必要なヘッダ情報などの情報は自動的には付加されません。

Brownie終了フィルタはこの問題を簡易テンプレート機能を実装することで解決します。 Brownie終了フィルタはBrownie形式テキストをフォーマットした後、整形後のテキストを適用するためのテンプレートを検索します。テンプレートはカレントディレクトリ（通常はリクエストされた文書が存在するディレクトリ）から順に上層のディレクトリに遡りつつ、"template.brownie"という名前のテンプレートファイルを探します。テンプレートファイルが見付かった場合、Brownie終了フィルタはテンプレートファイルに整形後のHTMLをはめ込みます。

テンプレートファイルは通常、HTMLファイルです。 HTMLファイル中に以下のキーワードを挿入することで、整形後のテキストをはめ込むことが出来ます。

{$contents} 整形されたHTML本体を挿入します。通常、BODYエレメントの子要素として記述します。 {$title} Brownie形式テキスト中に記述されたtitleパラメータを挿入します。通常、TITLEエレメントの子要素として記述します。

テンプレートファイルが見付からない場合には、Brownie_Filterクラスの標準テンプレートが利用されます。

static method findTemplate [line 99]

static string findTemplate(
)

テンプレートを検索して返します。

テンプレートを検索して、見付かった場合にはその内容を取得して返します。見付からなかった場合には標準のテンプレートの内容を返します。

Tags:

return:	テンプレート内容
access:	public

[ Top ]

static method getDefaultTemplate [line 58]

static string getDefaultTemplate(
)

標準のテンプレートを取得します。

Tags:

access:

public

[ Top ]

static method initialization [line 76]

static void initialization(
)

クラス標準の初期化処理を行います。

Tags:

access:

public

[ Top ]

static method setDefaultTemplate [line 68]

static void setDefaultTemplate(
string
$template)

標準のテンプレートを設定します。

Tags:

access:

public

Parameters:

string

$template

標準のテンプレート

[ Top ]

method execute [line 120]

string execute(
string
$source)

フィルタの主処理を実装します。

Tags:

return:	フィルタリング後の文字列
access:	public

Parameters:

string

$source

フィルタリングする文字列

[ Top ]

Class: Brownie_Filter

Class Overview

Methods

Class Details

Class Methods

static method findTemplate [line 99]

Tags:

static method getDefaultTemplate [line 58]

Tags:

static method initialization [line 76]

Tags:

static method setDefaultTemplate [line 68]

Tags:

Parameters:

method execute [line 120]

Tags:

Parameters: