archived-doc-ja/reference/ffi/ffi.cdata.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d17b7b4947e7819ff5036715dd706be87ae4def Maintainer: nsfisis Status: ready -->

<reference xml:id="class.ffi-cdata" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>C のデータハンドル</title>
 <titleabbrev>FFI\CData</titleabbrev>

 <partintro>

<!-- {{{ FFI\CData intro -->
  <section xml:id="ffi-cdata.intro">
   &reftitle.intro;
   <para>
    <classname>FFI\CData</classname> オブジェクトは、通常の PHP データのように様々な方法で使用できます:

    <itemizedlist>
     <listitem>
      <simpara>
       スカラー型の C のデータは <property>$cdata</property> プロパティを通してアクセスできます。例:
       <code>$x = FFI::new('int'); $x-&gt;cdata = 42;</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C の構造体や共用体のフィールドは通常の PHP のオブジェクトプロパティのようにアクセスできます。例:
       <code>$cdata-&gt;field</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C の配列要素は通常の PHP の配列要素のようにアクセスできます。例:
       <code>$cdata[$offset]</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C の配列は &foreach; 文を使って反復できます。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C の配列は <function>count</function> の引数として使えます。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C のポインタは配列のように参照外しできます。例: <code>$cdata[0]</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C のポインタは通常の比較演算子を使って比較できます (<code>&lt;</code>、
       <code>&lt;=</code>、<code>==</code>、<code>!=</code>、<code>&gt;=</code>、<code>&gt;</code>)。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C のポインタは通常の <code>+</code>/<code>-</code>/
       <code>++</code>/<code>--</code> 演算子を使ってインクリメント・デクリメントできます。例: <code>$cdata += 5</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C のポインタは通常の <code>-</code> 演算子を使って他のポインタと引き算できます。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       C の関数ポインタは通常の PHP のクロージャのように呼び出せます。例: <code>$cdata()</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       任意の C のデータは <link linkend="language.oop5.cloning">clone</link> 演算子を使って
       複製できます。例: <code>$cdata2 = clone $cdata;</code>
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       任意の C のデータは <function>var_dump</function> や <function>print_r</function> 等を
       使って可視化できます。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       PHP 8.3.0 以降、<classname>FFI\CData</classname> は構造体やフィールドに代入できるようになりました。
      </simpara>
     </listitem>
    </itemizedlist>
    <note>
     <simpara>
      特筆すべき制限として、<classname>FFI\CData</classname> インスタンスは
      <function>isset</function>、<function>empty</function>、<function>unset</function> をサポートしていません。
      また、ラップされた C の構造体や共用体は <interfacename>Traversable</interfacename> を実装していません。
     </simpara>
    </note>
   </para>
  </section>
<!-- }}} -->

  <section xml:id="ffi-cdata.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <modifier>final</modifier>
     <classname>FFI\CData</classname>
    </ooclass>
   </classsynopsis>
<!-- }}} -->

  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        <classname>FFI\CData</classname> は構造体やフィールドに代入できるようになりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>

 </partintro>

 <!-- &reference.ffi.entities.ffi-cdata; -->

</reference>
<!-- 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
-->