HTML-Parser-3.55 > HTML::Entities
Other versions:


HTML::Entities - Encode or decode strings with HTML entities

HTML::Entities - HTMLエンティティ(実体参照)文字列をエンコード/デコードする


 use HTML::Entities;

 $a = "Våre norske tegn bør &#230res";
 encode_entities($a, "\200-\377");

For example, this:


 $input = "vis-à-vis Beyoncé's naïve\npapier-mâché résumé";
 print encode_entities($input), "\n"

Prints this out:


 vis-à-vis Beyoncé's naïve
 papier-mâché résumé


This module deals with encoding and decoding of strings with HTML character entities. The module provides the following functions:

このモジュールは、HTML文字エンティティ(実体参照)のエンコードとデコード を取り扱う。このモジュールは以下の機能を提供する:

decode_entities( $string, ... )

This routine replaces HTML entities found in the $string with the corresponding Unicode character. Under perl 5.6 and earlier only characters in the Latin-1 range are replaced. Unrecognized entities are left alone.

このルーチンは対応するユニコード文字を含む $string 中のHTMLエンティティ を置き換える。perl 5.6 とそれ以前では、Latin-1の範囲の文字のみが置き換え られる。認識できないエンティティはそのまま残る。

If multiple strings are provided as argument they are each decoded separately and the same number of strings are returned.

もしも、引数として複数の文字列が提供された場合、それらは個別にデコード され、同じ数の文字列が返る。

This routine is exported by default.


This routine is exported by default.


_decode_entities( $string, \%entity2char )
_decode_entities( $string, \%entity2char, $expand_prefix )

This will in-place replace HTML entities in $string. The %entity2char hash must be provided. Named entities not found in the %entity2char hash are left alone. Numeric entities are expanded unless their value overflow.

これは、$string中のHTMLエンティティをその場で置き換える。%entiti2char ハッシュが提供されなければならない。%entity2char中に見つからない、名前 が付いたエンティティはそのまま残る。数字のエンティティはその値がオーバ フローするまで拡張される。

The keys in %entity2char are the entity names to be expanded and their values are what they should expand into. The values do not have to be single character strings. If a key has ";" as suffix, then occurrences in $string are only expanded if properly terminated with ";". Entities without ";" will be expanded regardless of how they are terminated for compatiblity with how common browsers treat entities in the Latin-1 range.

%entity2char中のキーは拡張されるエンティティ名で、その値は拡張されるべき ものである。その値は単一文字のの文字列であってはならない。もしもキーが サフィックスとして";"を持っているならば、$string中に見つかるものは、 もしも適切に";"で終了しているならば、それのみ拡張される。";"を持たない エンティティは、共通のブラウザが、Latin-1の範囲中でエンティティを取り扱う コンパチビリティのためにどのように終了したとしていても、拡張される。

If $expand_prefix is TRUE then entities without trailing ";" in %entity2char will even be expanded as a prefix of a longer unrecognized name. The longest matching name in %entity2char will be used. This is mainly present for compatibility with an MSIE misfeature.

もしも、$expand_prefix が TRUE であれば、%entity2char中の、末尾の";"なしの エンティティはより長い認識されない名前のプレフィックスとして、拡張される。 %entity2char中の、もっとも長い一致した名前が使われる。これは、主に、MSIE の間違った機能に対する互換のために提供されている。

   $string = "foo&nbspbar";
   _decode_entities($string, { nb => "@", nbsp => "\xA0" }, 1);
   print $string;  # will print "foo bar"

This routine is exported by default.


encode_entities( $string )
encode_entities( $string, $unsafe_chars )

This routine replaces unsafe characters in $string with their entity representation. A second argument can be given to specify which characters to consider unsafe (i.e., which to escape). The default set of characters to encode are control chars, high-bit chars, and the <, &, >, ' and " characters. But this, for example, would encode just the <, &, >, and " characters:

このルーチンはエンティティの表現と共に $string中の安全でない文字を 置き換える。2番目の引数は、どの文字が安全でないと考えられるかを提供する ことが出来る(たとえば、どれをエスケープするか)。エンコードされる規定値 の文字セットは、コントロール文字、8ビット目が設定されている文字と <, &, >, '" である。しかし、 これは、例をあげると、<, &, >, '" は以下のような形でエンコードできる。

  $encoded = encode_entities($input, '<>&"');

This routine is exported by default.


encode_entities_numeric( $string )
encode_entities_numeric( $string, $unsafe_chars )

This routine works just like encode_entities, except that the replacement entities are always &#xhexnum; and never &entname;. For example, encode_entities("r\xF4le") returns "r&ocirc;le", but encode_entities_numeric("r\xF4le") returns "r&#xF4;le".

このルーチンは、encode_entitiesと同じように動作するが、置換エンティティ は常時&#xhexnum;となり、決して&entname;にならないところが 違う。例をあげると、 encode_entities("r\xF4le") は "r&ocirc;le" を 返すが、encode_entities_numeric("r\xF4le")は"r&#xF4;le"を返す。

This routine is not exported by default. But you can always export it with use HTML::Entities qw(encode_entities_numeric); or even use HTML::Entities qw(:DEFAULT encode_entities_numeric);

このルーチンは規定値ではエクスポートされない。しかし、 use HTML::Entities qw(encode_entities_numeric);か、 use HTML::Entities qw(:DEFAULT encode_entities_numeric); で常にエクスポートすることが出来る。

All these routines modify the string passed as the first argument, if called in a void context. In scalar and array contexts, the encoded or decoded string is returned (without changing the input string).

上記のすべてのルーチンは、もしも、void コンテキストとして呼ばれた場合、 最初の引数として渡された文字列を変更する。スカラーまたは配列コンテキスト 中では、エンコードまたはデコードされた文字列が戻る(入力文字列の変更 なしに)。

If you prefer not to import these routines into your namespace, you can call them as:

もしも、名前空間にそれらのルーチンをインポートしたくないのであれば、 それらを以下のように呼び出すことが出来る:

  use HTML::Entities ();
  $decoded = HTML::Entities::decode($a);
  $encoded = HTML::Entities::encode($a);
  $encoded = HTML::Entities::encode_numeric($a);

The module can also export the %char2entity and the %entity2char hashes, which contain the mapping from all characters to the corresponding entities (and vice versa, respectively).

これらのモジュールは、対応するエンティティ(と逆もまた同様)のための すべての文字列からのマッピングを含む $char2entityと%entity2charハッシュ をもエクスポートすることが出来る。


Copyright 1995-2006 Gisle Aas. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.