6章 定数

Chapter 6. Constants

6.1. 定数とは?

定数とはテンプレートの”Constants”フィールドで定義されている値のことである。それらは通常のTypoScriptのシンタックスに従うものである!

注、予約名:”ファイル“のオブジェクト又はプロパティは常に”resource”データタイプとして翻訳される。

注:トップレベルの“オブジェクト”TSConstantEditorは使用できない。それはConstantEditorモジュールのコンフィグレーション用に確保されている。

6.1. What are constants?

Constants are values defined in the "Constants"-field of a template. They follow the syntax of ordinary TypoScript!

NOTE, reserved name: The object or property "file" is always interpreted as data type "resource".

NOTE: Toplevel "object" TSConstantEditor cannot be used. It's reserved for configuration of the ConstantEditor module (Changed from beta4)

例:

ここでは”bgCol”を”red”に設定、”file.toplogo”をテンプレートのリソースフィールドにある”logo*.gif”に設定する。

bgCol = red
topimg.width = 200
topimg.file.pic2 = fileadmin/logo2.gif
file.toplogo = logo*.gif 

これは以下のようにも定義できる:

bgCol = red
file {
  toplogo = logo*.gif
}
topimg {
  width = 200
  file.pic2 = fileadmin/logo2.gif

(太字のオブジェクトは保存されたワード”ファイル“でプロパティは常に”リソース“データタイプである)

例:

Example:

Here "bgCol" is set to "red" and "file.toplogo" is set to "logo*.gif" which is found in the resource-field of the template.

bgCol = red
topimg.width = 200
topimg.file.pic2 = fileadmin/logo2.gif
file.toplogo = logo*.gif

This could also be defined like this:

bgCol = red
file {
  toplogo = logo*.gif
}
topimg {
  width = 200
  file.pic2 = fileadmin/logo2.gif
}

(The objects in bold is the reserved word "file" and the properties are always of data type "resource"

Example:

定数の挿入

定数は、普通のstr_replaceオペレーションを実行することによって、temlate-setup内に挿入される。

{$bgCol}
{$topimg.width}
{$topimg.file.pic2}
{$file.toplogo}

例:

page = PAGE
page.typeNum = 0
page.bodyTag = <body bgColor="{$bgCol}">
page.10 = IMAGE
page.10.file = {$file.toplogo}

定義された定数のみが代入される。

組み込まれているテンプレート内の定数もまた、テンプレート全体が大量のテキスト上にある時に代入される。

定数は大文字、小文字の識別がある。

定数の系統的なネーミングを使用しなければならない。コード例などで発想を求めること。

定数の挿入

Inserting constants

Constants are inserted in the template-setup by performing an ordinary str_replace operation! You insert them like this:

{$bgCol}
{$topimg.width}
{$topimg.file.pic2}
{$file.toplogo}

Example:

page = PAGE
page.typeNum = 0
page.bodyTag = <body bgColor="{$bgCol}">
page.10 = IMAGE
page.10.file = {$file.toplogo}

Only defined constants are substituted.

Constants in included templates are also substituted as the whole template is just on large chunk of text.

Constants are case sensitive.

You should use a systematic naming of constants. Seek inspiration in the code-examples around.

Inserting constants

セットアップコード内での定数はどのように代入されているか注意。オブジェクトブラウザでは、代入してもしくはせずに定数を監視できる。また、値”logo*.gif”はリソース”uploads/tf/logo_01.gif”に変形されていることに注意。

(注:”Crop lines”を選択した場合は、”定数表示”関数は使用できない)

Notice how the constants in the setup code is substituted. In the Object Browser, you can monitor the constants with or without substitution. Also notice that the value "logo*.gif" was resolved to the resource "uploads/tf/logo_01.gif"

(Note: The "Constants display" function is not available if you select "Crop lines")