getSafeHTML() は、antisamy ポリシーファイルで指定されたルールに基づいて、特定の入力文字列をサニタイズします。この関数を使用すると、アプリケーションにおいて、ユーザーが不要な HTML を指定せずに済みます。
戻り値
サニタイズされた入力を返します。throwOnError が true に設定されている場合は、エラーを返します。それ以外の場合は、空の文字列を返します。
戻り値
ColdFusion 11:この関数が追加されました。
関連項目
パラメータ
パラメータ |
説明 |
inputString |
必須。エンコードする文字列です。 |
PolicyFile |
オプション。HTML ルールを指定する antisamy ポリシーファイルのファイルパスです。このパラメーターを指定しない場合は、アプリケーションレベルでポリシーファイルを設定するためのプロビジョニングが行われます。それ以外の場合は、ColdFusion に付属のデフォルトのポリシーファイルが使用されます。 |
throwOnError |
オプション。true に設定すると、例外がスローされます。 |
例
次の例は、サンプルの Antisamy コンポーネントを示しています。
<cfcomponent> |
次の例は、isSafeHTML と getSafeHTML の検証を示しています。
この例では、入力 HTML ファイルは GIF 画像です。関数(isSafeHTML、getSafeHTML)を使用してこのファイルを処理する際は、特定の入力文字列が、antiSamy ポリシーファイルで指定されたルールに違反しているかどうかを確認し、許可されている HTML ルールに入力が違反していない場合は true を返します。
<cfset isSafe = isSafeHTML(inputHTML)> |
Antisamy の maxInputsize ディレクティブは、それが検証される前にユーザー入力の最大サイズを指定します。antisamy-basic.xml は ColdFusion 11 に付属し、入力を 5000 文字までに制限します。この関数に提供された入力が 5000 を上回ると、エラーが返されます。ただし、この制限は必要に応じて変更できます。antisamy-basic.xml からこのディレクティブを削除すると、デフォルトの制限は 100,000 に設定されます。