HTML 数値エンティティを文字にデコードする

# mb_decode_numericentity

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

mb_decode_numericentity — HTML 数値エンティティを文字にデコードする

### 説明

function mb_decode_numericentity(string `$string`, array `$map`, ?string `$encoding` = `null`): string

文字列 `string` において指定した文字領域にある数値エンティティを変換し、 変換後の文字列を返します。

### パラメータ

`string`

  デコードする文字列。

`map`

  `map` は変換するコード領域を指定する配列です。

`encoding`
  `encoding` パラメータには文字エンコーディングを指定します。省略した場合、もしくは `null` の場合は、 内部文字エンコーディングを使用します。

### 戻り値

変換された文字列を返します。

### エラー / 例外

`map` が整数のリストでない場合、 ValueError がスローされます。

### 変更履歴

バージョン | 説明
--- | ---
8.4.0 | `map` が整数のリストでない場合、 mb_decode_numericentity() は ValueError をスローするようになりました。
8.0.0 | `encoding` は、nullable になりました。

### 例

例1 `map` の例

    <?php
    $convmap = array (
       int start_code1, int end_code1, int offset1, int mask1,
       int start_code2, int end_code2, int offset2, int mask2,
       // ........
       int start_codeN, int end_codeN, int offsetN, int maskN );
    // start_codeN および end_codeN に Unicode値を指定
    // 値にoffsetNを追加、マスクmaskNを指定してビット毎の'AND'をとり、
    // 数値エンティティに値を変換します。
    ?>

例2 `map` を使って JavaScript の文字列をエスケープする例

    <?php
    function escape_javascript_string($str) {
      $map = [
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,0,0, // 49
              0,0,0,0,0,0,0,0,1,1,
              1,1,1,1,1,0,0,0,0,0,
              0,0,0,0,0,0,0,0,0,0,
              0,0,0,0,0,0,0,0,0,0,
              0,1,1,1,1,1,1,0,0,0, // 99
              0,0,0,0,0,0,0,0,0,0,
              0,0,0,0,0,0,0,0,0,0,
              0,0,0,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1, // 149
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1, // 199
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1,
              1,1,1,1,1,1,1,1,1,1, // 249
              1,1,1,1,1,1,1, // 255
              ];
      // 文字エンコーディングは UTF-8
      $mblen = mb_strlen($str, 'UTF-8');
      $utf32 = bin2hex(mb_convert_encoding($str, 'UTF-32', 'UTF-8'));
      for ($i=0, $encoded=''; $i < $mblen; $i++) {
          $u = substr($utf32, $i*8, 8);
          $v = base_convert($u, 16, 10);
          if ($v < 256 && $map[$v]) {
            $encoded .= '\\x'.substr($u, 6,2);
          } else if ($v == 2028) {
            $encoded .= '\\u2028';
          } else if ($v == 2029) {
            $encoded .= '\\u2029';
          } else {
            $encoded .= mb_convert_encoding(hex2bin($u), 'UTF-8', 'UTF-32');
          }
       }
       return $encoded;
    }

    // テストデータ
    $convmap = [ 0x0, 0xffff, 0, 0xffff ];
    $msg = '';
    for ($i=0; $i < 1000; $i++) {
      // chr() では 128 より大きい UTF-8 データを正しく生成できないので、mb_decode_numericentity() を使います
      $msg .= mb_decode_numericentity('&#'.$i.';', $convmap, 'UTF-8');
    }

    // var_dump($msg);
    var_dump(escape_javascript_string($msg));

### 参考

- mb_encode_numericentity() - 文字を HTML 数値エンティティにエンコードする

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open