IntlChar::iscntrl

(PHP 7, PHP 8)

IntlChar::iscntrl — コードポイントが制御文字かどうかを調べる

説明

public static function IntlChar::iscntrl(int|string $codepoint): ?bool

指定されたコードポイントが制御文字かを判定します。

制御文字は、以下に挙げるものです:

ISO 8-bit control character (U+0000..U+001f and U+007f..U+009f)
IntlChar::CHAR_CATEGORY_CONTROL_CHAR (Cc)
IntlChar::CHAR_CATEGORY_FORMAT_CHAR (Cf)
IntlChar::CHAR_CATEGORY_LINE_SEPARATOR (Zl)
IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR (Zp)

パラメータ

codepoint: コードポイントを表す int 型の値 (例: U+2603 SNOWMAN を表す 0x2603)、あるいは UTF-8 文字列としてエンコードされた文字 (例: "\u{2603}")。

戻り値

codepoint が制御文字の場合に true を返します。そうでない場合に、false を返します。失敗した場合は、null を返します。

例

例1 さまざまなコードポイントの例

<?php
var_dump(IntlChar::iscntrl("A"));
var_dump(IntlChar::iscntrl(" "));
var_dump(IntlChar::iscntrl("\n"));
var_dump(IntlChar::iscntrl("\u{200e}"));
?>

上の例の出力は以下となります。

bool(false)
bool(false)
bool(true)
bool(true)

参考

IntlChar::isprint() - コードポイントが印字可能な文字かを調べる
IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT
ctype_cntrl() - 制御文字かどうかを調べる

関連キーワード:

IntlChar コードポイント制御 iscntrl dump codepoint isblank isdefined static 判定 control character エンコード参考 isprint 印字 ctype cntrl