pure.fw.brownie
[ class tree: pure.fw.brownie ] [ index: pure.fw.brownie ] [ all elements ]

Class: Brownie

Source Location: /package/pure/fw/brownie/Brownie.inc

Class Overview

PURE_Class
   |
   --Brownie

Brownie を利用する場合のメインクラスです。


Variables

Constants

Methods



Class Details

[line 22]
Brownie を利用する場合のメインクラスです。



[ Top ]


Class Variables

static $lineTypeKeywords = array(
         '#$'      => Brownie::LINE_TYPE_PARAMETER,
         '#'         => Brownie::LINE_TYPE_COMMENT,
         '----'      => Brownie::LINE_TYPE_HORIZONTAL_RULE,
         '~'         => Brownie::LINE_TYPE_PARAGRAPH,
         '+'         => Brownie::LINE_TYPE_ORDERED_LIST,
         '-'         => Brownie::LINE_TYPE_UNORDERED_LIST,
         ':'         => Brownie::LINE_TYPE_DEFINE_LIST,
         '>'         => Brownie::LINE_TYPE_BLOCKQUOT,
         '******'   => Brownie::LINE_TYPE_HEADING,
         '*****'      => Brownie::LINE_TYPE_HEADING,
         '****'      => Brownie::LINE_TYPE_HEADING,
         '***'      => Brownie::LINE_TYPE_HEADING,
         '**'      => Brownie::LINE_TYPE_HEADING,
         '*'         => Brownie::LINE_TYPE_HEADING,
         '\\'      => Brownie::LINE_TYPE_CONTINUE,
         '$:'      => Brownie::LINE_TYPE_DIVISION
      )

[line 47]

行種を判断するプレフィックスを保持する配列です。

配列のキーがプレフィックス、値が行種の定数になります。




Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor __construct [line 104]

Brownie __construct( )

標準のコンストラクタです。



Tags:

access:  public


[ Top ]

method elementHtmlFormater [line 776]

void elementHtmlFormater( Brownie_Element $current, int $indent, [bool $compact = false])

指定のエレメントに保持されているエレメント、テキストをHTMLに成形して返します。



Tags:

access:  protected


Parameters:

Brownie_Element   $current   成形したいエレメント
bool   $compact   可能であればコンパクト整形するか否か
int   $indent   出力ソースのインデント深さ

[ Top ]

method elementParser [line 581]

Brownie_Element_Root elementParser( string $source)

ソース文字列をパースし、ルートエレメントを保持するBrownie_Element_Rootオブジェクトを返します。



Tags:

return:  解析結果を保持するBrownie_Element_Rootオブジェクト
access:  protected


Parameters:

string   $source   パースするソース

[ Top ]

method elementTextFormater [line 957]

void elementTextFormater( Brownie_Element $current, int $indent, [int $indent_size = 4])

指定のエレメントに保持されているエレメント、テキストをテキストに成形して返します。



Tags:

access:  protected


Parameters:

Brownie_Element   $current   成形したいエレメント
int   $indent   出力ソースのインデント深さ
int   $indent_size   インデントの文字数

[ Top ]

method format [line 1083]

string format( string $source)

指定のBrownie形式テキストを元にHTMLを整形して返します。



Tags:

return:  整形されたHTML
access:  public


Parameters:

string   $source   整形したい文字列ソース

[ Top ]

method formatFromFile [line 1110]

string formatFromFile( string $fileName)

指定のファイルを読み込んで整形して返します。



Tags:

return:  整形されたHTML
access:  public


Parameters:

string   $fileName   整形したいファイルのファイル名

[ Top ]

method formatText [line 1097]

string formatText( string $source, [int $indent_size = 4])

指定のBrownie形式テキストを元にテキストを整形して返します。



Tags:

return:  整形されたテキスト
access:  public


Parameters:

string   $source   整形したい文字列ソース
int   $indent_size   インデントの文字数

[ Top ]

method formatTextFromFile [line 1121]

string formatTextFromFile( string $fileName)

指定のファイルを読み込んで整形して返します。



Tags:

return:  整形されたテキスト
access:  public


Parameters:

string   $fileName   整形したいファイルのファイル名

[ Top ]

method getHeadingDepth [line 174]

int getHeadingDepth( )

ヘッダの追加深度を取得します。



Tags:

return:  ヘッダの追加深度
access:  public


[ Top ]

method getLogicalResourcePath [line 150]

string getLogicalResourcePath( )

論理リソースパスを取得します。

論理リソースパスはBrownie形式テキストをパース、フォーマットした結果のHTMLがクライアント側に転送された後の、外部リソースを参照する場合のルートパスを定義します。 標準では物理リソースパスは定義されません。 これはレスポンスを受け取ったユーザから見たサーバ上の仮想カレントディレクトリと、レスポンス結果のHTMLに記述されている相対パスのベースディレクトリが一致していることを表します。




Tags:

access:  public


[ Top ]

method getParam [line 1136]

パラメータ値 getParam( string $key, [mixed $def = false])

formatメソッドにより直前に整形されたBrownie形式テキストのパラメータを取得します。

指定パラメータ名に対するパラメータ値が見つからない場合には標準ではfalseが返されます。 $def引数は指定のパラメータ名のパラメータ値が見つからなかった場合の返却値を指定します。




Tags:

access:  public


Parameters:

string   $key   パラメータ名
mixed   $def   パラメータが見つからなかった場合の返却値

[ Top ]

method getPhysicalResourcePath [line 122]

string getPhysicalResourcePath( )

物理リソースパスを取得します。

物理リソースパスはBrownie形式テキストをパース、フォーマットする際に外部リソースを相対参照する場合のルートパスを定義します。 標準では物理リソースパスは定義されません。 これはスクリプトが稼働しているカレントディレクトリと、Brownie形式テキストに記述されている相対パスのベースディレクトリが一致していることを表します。




Tags:

access:  public


[ Top ]

method isRestrictMode [line 203]

bool isRestrictMode( )

制限モードか否かを取得します。

制限モードの詳細に関してはsetRestrictModeメソッドを参照してください。




Tags:

return:  制限モードか否か
see:  Brownie::setRestrictMode()
access:  public


[ Top ]

method paramToArray [line 1152]

array paramToArray( )

パラメータを配列で返します。

配列の添字がパラメータ名、値がパラメータ値になります。




Tags:

return:  パラメータの配列
access:  public


[ Top ]

method phraseFormater [line 419]

void phraseFormater( Brownie_Phrase $phrase, int $option)

指定のフレーズを元にHTMLを整形して返します。



Tags:

access:  protected


Parameters:

Brownie_Phrase   $phrase   整形したいフレーズ
int   $option   整形オプション

[ Top ]

method phraseParser [line 231]

Brownie_Phrase_Root phraseParser( string $source)

文字列をパースしルートフレーズを保持するBrownie_Phrase_Rootオブジェクトを返します。



Tags:

return:  解析結果を保持するBrownie_Phrase_Rootオブジェクト
access:  protected


Parameters:

string   $source   パースしたい文字列

[ Top ]

method phraseToHtml [line 538]

string phraseToHtml( string $source, int $indent, [bool $compact = false])

文字列をHTMLに整形して返します。



Tags:

return:  整形済みHTML
access:  protected


Parameters:

string   $source   整形したい文字列
int   $indent   インデント深さ
bool   $compact   コンパクト整形するか否か

[ Top ]

method phraseToText [line 564]

string phraseToText( string $source, int $indent, [int $indent_size = 4])

文字列をテキストに整形して返します。



Tags:

return:  整形済みHTML
access:  protected


Parameters:

string   $source   整形したい文字列
int   $indent   インデント深さ
int   $indent_size   インデントの文字数

[ Top ]

method setHeadingDepth [line 190]

void setHeadingDepth( int $headingDepth)

ヘッダの追加深度を設定します。

追加深度はHnエレメントを出力する際にnに加算されます。 既に文書中に上位のヘッダが出現している際に、文書の論理構造を崩壊させないために設定します。 0より小さい値を指定した場合には深度は減算され、0より大きい値を指定した場合には深度は加算されます。 0の場合にはBrownie形式テキストの記述のままになります。 なお、Brownie形式テキストのヘッダ深度と追加深度の合計値が1~6に収まらない場合には丸め込まれることに注意してください。




Tags:

access:  public


Parameters:

int   $headingDepth   ヘッダの追加深度

[ Top ]

method setLogicalResourcePath [line 164]

void setLogicalResourcePath( string $logicalResourcePath)

論理リソースパスを設定します。

論理リソースパスはBrownie形式テキストをパース、フォーマットした結果のHTMLがクライアント側に転送された後の、外部リソースを参照する場合のルートパスを定義します。 標準では物理リソースパスは定義されません。 これはレスポンスを受け取ったユーザから見たサーバ上の仮想カレントディレクトリと、レスポンス結果のHTMLに記述されている相対パスのベースディレクトリが一致していることを表します。




Tags:

access:  public


Parameters:

string   $logicalResourcePath   論理リソースパス

[ Top ]

method setPhysicalResourcePath [line 136]

void setPhysicalResourcePath( string $physicalResourcePath)

物理リソースパスを設定します。

物理リソースパスはBrownie形式テキストをパース、フォーマットする際に外部リソースを相対参照する場合のルートパスを定義します。 標準では物理リソースパスは定義されません。 これはスクリプトが稼働しているカレントディレクトリと、Brownie形式テキストに記述されている相対パスのベースディレクトリが一致していることを表します。




Tags:

access:  public


Parameters:

string   $physicalResourcePath   物理リソースパス

[ Top ]

method setRestrictMode [line 220]

void setRestrictMode( bool $restrictMode)

制限モードか否かを設定します。

Brownie形式テキストには掲示板の投稿欄のような制限された文法に対応するモードが用意されています。 制限モードを有効にすると以下の機能が制限されます。

  1. インデントレベルは無視され、全て同一のインデントレベルであると認識されます。
  2. 章、節、項、大見出し、中見出し、小見出しの段落が認識されなくなります。
  3. インライン修飾が認識されなくなります。




Tags:

access:  public


Parameters:

bool   $restrictMode   制限モードか否か

[ Top ]


Class Constants

LINE_TYPE_BLANK =   101

[line 26]


[ Top ]

LINE_TYPE_BLOCKQUOT =   109

[line 34]


[ Top ]

LINE_TYPE_COMMENT =   199

[line 38]


[ Top ]

LINE_TYPE_CONTINUE =   197

[line 36]


[ Top ]

LINE_TYPE_DEFINE_LIST =   108

[line 33]


[ Top ]

LINE_TYPE_DIVISION =   102

[line 27]


[ Top ]

LINE_TYPE_HEADING =   104

[line 29]


[ Top ]

LINE_TYPE_HORIZONTAL_RULE =   110

[line 35]


[ Top ]

LINE_TYPE_ORDERED_LIST =   106

[line 31]


[ Top ]

LINE_TYPE_PARAGRAPH =   105

[line 30]


[ Top ]

LINE_TYPE_PARAMETER =   198

[line 37]


[ Top ]

LINE_TYPE_ROOT =   103

[line 28]


[ Top ]

LINE_TYPE_UNKNOWN =  -100

[line 25]


[ Top ]

LINE_TYPE_UNORDERED_LIST =   107

[line 32]


[ Top ]

PHRASE_FORMAT_SKIP_ALL_TAG =  3

[line 68]


[ Top ]

PHRASE_FORMAT_SKIP_ANCHOR =  1

[line 67]


[ Top ]



Documentation generated on Sun, 06 Jan 2008 01:33:00 +0900 by phpDocumentor 1.3.2