0 關注者

Class 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 method (available since version 2.0.3)

允許擴展的 HtmlPurifier 類別設定一些預設的配置選項。

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

                protected static function configure($config)
{
}

            
process() public static method

透過 HTMLPurifier 處理標記,使其安全地輸出給終端使用者。

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

要淨化的 HTML 內容

$config 陣列|Closure|null

用於 HtmlPurifier 的配置。如果未指定或為 null,則將使用預設配置。您可以使用陣列或匿名函式來提供配置選項

  • 陣列將會傳遞給 HTMLPurifier_Config::create() 方法。
  • 匿名函式將在配置建立後被呼叫。簽名應為:function($config),其中 $config 將會是 HTMLPurifier_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');
    });
    
返回 字串

淨化後的 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);
}