offsetexists.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 09003ff79e20ff948b2c9efb2745f7625637d7e4 Maintainer: takagi Status: ready -->
<refentry xml:id="arrayaccess.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ArrayAccess::offsetExists</refname>
  <refpurpose>オフセットが存在するかどうか</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ArrayAccess">
   <modifier>public</modifier> <type>bool</type><methodname>ArrayAccess::offsetExists</methodname>
   <methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
  </methodsynopsis>
  <para>
   オフセットが存在するかどうかを返します。
  </para>
  <para>
   このメソッドが実行されるのは、<classname>ArrayAccess</classname>
   を実装したオブジェクト上で <function>isset</function> あるいは
   <function>empty</function> を使用した場合です。
  </para>
  <note>
   <para>
    <function>empty</function> を使用すると <function>ArrayAccess::offsetGet</function>
    がコールされ、<function>ArrayAccess::offsetExists</function> が
    &true; を返すかどうかで空かどうかを判断します。
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry><term><parameter>offset</parameter></term>
     <listitem>
      <para>
       調べたいオフセット。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <note>
   <para>
    非 boolean 値が返された場合は <type>bool</type> にキャストして返します。
   </para>
  </note>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ArrayAccess::offsetExists</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
class obj implements ArrayAccess {
    public function offsetSet($offset, $value): void {
        var_dump(__METHOD__);
    }
    public function offsetExists($var): bool {
        var_dump(__METHOD__);
        if ($var == "foobar") {
            return true;
        }
        return false;
    }
    public function offsetUnset($var): void {
        var_dump(__METHOD__);
    }
    #[\ReturnTypeWillChange]
    public function offsetGet($var) {
        var_dump(__METHOD__);
        return "value";
    }
}

$obj = new obj;

echo "Runs obj::offsetExists()\n";
var_dump(isset($obj["foobar"]));

echo "\nRuns obj::offsetExists() and obj::offsetGet()\n";
var_dump(empty($obj["foobar"]));

echo "\nRuns obj::offsetExists(), *not* obj:offsetGet() as there is nothing to get\n";
var_dump(empty($obj["foobaz"]));
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Runs obj::offsetExists()
string(17) "obj::offsetExists"
bool(true)

Runs obj::offsetExists() and obj::offsetGet()
string(17) "obj::offsetExists"
string(14) "obj::offsetGet"
bool(false)

Runs obj::offsetExists(), *not* obj:offsetGet() as there is nothing to get
string(17) "obj::offsetExists"
bool(true)
]]>
    </screen>
   </example>
  </para>
 </refsect1>


<!--
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>Classname::Method</methodname></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
-->