0 フォロワー

クラス yii\helpers\BaseHtmlPurifier

継承yii\helpers\BaseHtmlPurifier
サブクラスyii\helpers\HtmlPurifier
利用可能なバージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseHtmlPurifier.php

BaseHtmlPurifier は、yii\helpers\HtmlPurifier の具体的な実装を提供します。

BaseHtmlPurifier を使用しないでください。代わりに yii\helpers\HtmlPurifier を使用してください。

公開メソッド

継承されたメソッドを隠す

メソッド 説明 定義元
process() マークアップをHTMLPurifierに通して、エンドユーザーへの出力が安全になるようにします。 yii\helpers\BaseHtmlPurifier

保護されたメソッド

継承されたメソッドを隠す

メソッド 説明 定義元
configure() 拡張されたHtmlPurifierクラスがいくつかのデフォルト設定オプションを設定できるようにします。 yii\helpers\BaseHtmlPurifier

メソッドの詳細

継承されたメソッドを隠す

configure() protected static メソッド (バージョン 2.0.3 から利用可能)

拡張されたHtmlPurifierクラスがいくつかのデフォルト設定オプションを設定できるようにします。

protected static void configure ( $config )
$config \HTMLPurifier_Config

                protected static function configure($config)
{
}

            
process() public static メソッド

マークアップをHTMLPurifierに通して、エンドユーザーへの出力が安全になるようにします。

public static string process ( $content, $config null )
$content string

浄化するHTMLコンテンツ

$config array|Closure|null

HtmlPurifierに使用する設定。指定しない場合、またはnullの場合、デフォルト設定が使用されます。配列または匿名関数を使用して構成オプションを提供できます。

  • 配列は、HTMLPurifier_Config::create() メソッドに渡されます。
  • 匿名関数は、構成が作成された後に呼び出されます。署名は次のとおりです:function($config)。ここで、$configHTMLPurifier_Configのインスタンスになります。

    以下は、そのような関数の使用例です。

    // Allow the HTML5 data attribute `data-type` on `img` elements.
    $content = HtmlPurifier::process($content, function ($config) {
      $config->getHTMLDefinition(true)
             ->addAttribute('img', 'data-type', 'Text');
    });
    
戻り値 string

浄化されたHTMLコンテンツ。

                public static function process($content, $config = null)
{
    $configInstance = \HTMLPurifier_Config::create($config instanceof \Closure ? null : $config);
    $configInstance->autoFinalize = false;
    $purifier = \HTMLPurifier::instance($configInstance);
    $purifier->config->set('Cache.SerializerPath', \Yii::$app->getRuntimePath());
    $purifier->config->set('Cache.SerializerPermissions', 0775);
    static::configure($configInstance);
    if ($config instanceof \Closure) {
        call_user_func($config, $configInstance);
    }
    return $purifier->purify($content);
}