1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
archived-doc-ja/reference/mbstring/functions/mb-check-encoding.xml
2022-10-02 09:58:37 +09:00

122 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d2ff0abe1650703e8974acaa7674c678e587a696 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.mb-check-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_check_encoding</refname>
<refpurpose>文字列が、指定したエンコーディングで有効なものかどうかを調べる</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mb_check_encoding</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
そのバイトストリームが指定したエンコーディングで有効なものかどうかを調べます。
<parameter>value</parameter> が配列の場合、全てのキーと値が再帰的に調べられます。
これは、いわゆる「不正なエンコーディングによる攻撃」を防ぐのに役立ちます。
</para>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
調べるバイトストリーム または &array;。省略した場合は、
リクエスト開始時からのすべての入力が対象となります。
</para>
<warning>
<para>
PHP 8.1.0 以降では、このパラメータを省略したり &null; を渡したりすることは推奨されなくなっています。
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
期待するエンコーディング。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
引数を渡さずにこの関数を呼び出したり、
<parameter>value</parameter>&null; を渡して呼び出すことは推奨されなくなりました。
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>value</parameter><parameter>encoding</parameter> は、nullable になりました。
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
この関数は、<parameter>value</parameter> に配列を受け入れるようになりました。
このバージョンより前では、文字列のみがサポートされていました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->