archived-doc-ja/reference/var/functions/empty.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e6e9c116083c3d1aeb3d1fc2e45f51fbcb0d5182 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.empty" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>empty</refname>
  <refpurpose>変数が空であるかどうかを検査する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>empty</methodname>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
  </methodsynopsis>
  <para>
   変数が空であるかどうかを検査します。
   変数が空であるとみなされるのは、変数が存在しない場合や
   変数の値が &false; に等しい場合です。
   <function>empty</function> は、変数が存在しない場合でも警告を発生させません。
   このことは、多次元配列やチェインされたプロパティのような、
   ネストされたデータ構造であっても当てはまります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>var</parameter></term>
     <listitem>
      <para>
       チェックする変数
      </para>
      <para>
       変数が存在しなくても警告は発生しません。
       つまり、<function>empty</function> は本質的に
       <command>!isset($var) || $var == false</command>
       と同じことを簡潔に記述しているだけです。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>var</parameter> が存在しない、
   または空や0の値が設定されている場合、
   つまり boolean のコンテキストで &false; と見なされる場合、
   &true; を返します。
   詳細は <link linkend="language.types.boolean.casting">boolean への変換</link> を参照ください。
   それ以外の場合は &false; を返します。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>
     簡単な <function>empty</function> / <function>isset</function>
     の比較
    </title>  
    <programlisting role="php">
<![CDATA[
<?php
$var = 0;

// $var が空なのでtrueと評価されます
if (empty($var)) {
    echo '$var is either 0, empty, or not set at all';
}

// $var が設定されているのでtrueと評価されます
if (isset($var)) {
    echo '$var is set even though it is empty';
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <example>
   <title>文字列のオフセットに対する <function>empty</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$expected_array_got_string = 'somestring';
var_dump(empty($expected_array_got_string['some_key']));
var_dump(empty($expected_array_got_string[0]));
var_dump(empty($expected_array_got_string['0']));
var_dump(empty($expected_array_got_string['0.5']));
var_dump(empty($expected_array_got_string['0 Mostel']));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bool(true)
bool(false)
bool(false)
bool(true)
bool(true)
]]>
   </screen>
  </example>
  <example>
   <title>多次元配列に対する <function>empty</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$multidimensional = [
    'some' => [
        'deep' => [
            'nested' => 'value'
        ]
    ]
];

if (!empty($multidimensional['some']['some']['nested'])) {
    $someVariable = $multidimensional['some']['deep']['nested'];
}

var_dump(empty($multidimensional['some-undefined-key']));
var_dump(empty($multidimensional['some']['deep']['unknown']));
var_dump(empty($multidimensional['some']['deep']['nested']));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bool(true)
bool(true)
bool(false)
]]>
   </screen>
  </example>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  &note.language-construct;
  <note>
   <para>
    オブジェクトのアクセス不能なプロパティに対して <function>empty</function>
    を使用した場合は、もしオーバーロードメソッド
    <link linkend="object.isset">__isset()</link>
    が宣言されていればそれをコールします。
   </para>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>isset</function></member>
    <member><link linkend="object.isset">__isset()</link></member>
    <member><function>unset</function></member>
    <member><function>array_key_exists</function></member>
    <member><function>count</function></member> 
    <member><function>strlen</function></member>
    <member><link linkend="types.comparisons">PHP 型の比較表</link></member>
   </simplelist>
  </para>
 </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
-->