mirror of
https://github.com/php/doc-ja.git
synced 2026-03-27 08:32:09 +01:00
4284d39ec2
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@324072 c90b9560-bf6c-de11-be94-00142212c4b1
161 lines
5.7 KiB
XML
161 lines
5.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 94880ef80d76627ab272603ee59a1de75bececa9 Maintainer: takagi Status: ready -->
|
|
|
|
<reference xml:id="ref.hwapi" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<title>Hyperwave API &Functions;</title>
|
|
|
|
<partintro>
|
|
<section xml:id="hwapi.apache">
|
|
<title>Apache との統合</title>
|
|
<para>
|
|
Apache やその他のサーバーと統合するための情報は、すでに
|
|
<link linkend="ref.hw">Hyperwave モジュール</link>で説明されています。
|
|
これは、Hyperwave サーバーに接続するための最初の拡張モジュールでした。
|
|
</para>
|
|
</section>
|
|
|
|
<!-- FIXME: This extension apparently defines a class.. -->
|
|
<section xml:id="hwapi.classes">
|
|
<title>クラス</title>
|
|
<para>
|
|
HW_API 拡張モジュールが提供する API は、完全にオブジェクト指向です。
|
|
Hyperwave SDK の C++ インターフェイスに非常によく似ています。
|
|
この API は、以下のクラスからなります。
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>HW_API</classname>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>HW_API_Object</classname>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>HW_API_Attribute</classname>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>HW_API_Error</classname>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>HW_API_Content</classname>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>HW_API_Reason</classname>
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
Hyperwave SDK に含まれているクラスのうち、
|
|
<classname>HW_API_String</classname>、
|
|
<classname>HW_API_String_Array</classname>
|
|
のような基本的なクラスは実装されていません。
|
|
PHP には、それらに代わる強力な機能があるからです。
|
|
</para>
|
|
<para>
|
|
各クラスにはメソッドが含まれており、その名前は Hyperwave SDK
|
|
の対応するメソッドと同じです。この関数に引数を渡す方法は
|
|
PHP の他の拡張モジュールとは少し異なっており、HW SDK の C++ API
|
|
に似ています。複数のパラメータを別々に渡すのではなく、
|
|
それらをひとつの連想配列にまとめて単一のパラメータとして渡します。
|
|
連想配列のキーの名前は、HW SDK に記述されている内容と同じです。
|
|
一般的なパラメータについては以下で説明します。
|
|
それ以外のパラメータが必要になる場合は、必要に応じて説明されます。
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>objectIdentifier</classname> オブジェクトの名前あるいは ID。
|
|
例 "rootcollection"、"0x873A8768 0x00000002"。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>parentIdentifier</classname>
|
|
親オブジェクトの名前あるいは ID。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>object</classname> HW_API_Object クラスのインスタンス。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>parameters</classname> HW_API_Object クラスのインスタンス。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>version</classname> オブジェクトのバージョン。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>mode</classname> 実行される操作を定義する整数値。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>attributeSelector</classname>
|
|
文字列の配列で、個々の要素は属性の名前となります。
|
|
オブジェクトレコードを取得する際に特定の属性を含めたい場合に使用します。
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<classname>objectQuery</classname>
|
|
オブジェクトのリストの中から特定のオブジェクトを選択するためのクエリ。
|
|
<function>hw_api::children</function> や <function>hw_api::find</function>
|
|
のような関数から返されるオブジェクトの数を減らすために使用します。
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<note>
|
|
<para>
|
|
<type>boolean</type> 型のメソッドは、
|
|
&true;、&false; あるいは
|
|
<classname>HW_API_Error</classname> オブジェクトを返します。
|
|
</para>
|
|
</note>
|
|
</section>
|
|
</partintro>
|
|
|
|
&reference.hwapi.entities.hw-api;
|
|
&reference.hwapi.entities.hw-api-attribute;
|
|
&reference.hwapi.entities.hw-api-content;
|
|
&reference.hwapi.entities.hw-api-error;
|
|
&reference.hwapi.entities.hw-api-object;
|
|
&reference.hwapi.entities.hw-api-reason;
|
|
&reference.hwapi.entities.functions;
|
|
|
|
</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
|
|
-->
|