COM クラス

説明

COM クラスにより、OLE 互換の COM オブジェクトのインスタンスを作成し、そのメソッドをコールしたりそのプロパティにアクセスしたりすることが可能となります。

メソッド

com COM::COM ( string $module_name [, mixed $server_name [, int $codepage [, string $typelib ]]] )

COM クラスのコンストラクタ。パラメータには以下のような意味があります。

module_name

ロードするコンポーネントを指定するプログラム ID、クラス ID またはモニカです。プログラムID は、通常、アプリケーションまたは DLL の名前の後に、 Word.Application のようにピリオドとオブジェクト名を付けたものです。クラス ID は、指定されたクラスがユニークに定義する UUID です。モニカは、URL スキームの考え方に似た特別な命名形式です。リソースと、それがどのように読み込まれるかを指定します。例として、モジュール名に Word ドキュメントのフルパスを指定すると、Word を読み込んでドキュメントに対応するオブジェクトを取得することができます。あるいは、LDAP への ADSI インターフェースを指すモニカとして LDAP: を使用することが可能です。

server_name

コンポーネントが読み込んで実行される DCOM サーバの名前です。 NULL の場合、オブジェクトはアプリケーションのデフォルトを指定して実行されます。典型的なデフォルトは、ローカルマシン上で実行させることでが、管理者によってはアプリケーションを別のマシン上で実行させるように設定しているかもしれません。非 NULL 値をサーバに指定した場合、設定オプションが TRUE に設定されていない限り PHP はオブジェクトの読み込みを拒否します。

server_name が配列の場合、以下の要素 (大文字小文字を区別します!)を含まなければなりません。これらはすべて省略可能であることに注意しましょう (とはいえ、Username および Password は両方指定する必要があります)。もしサーバ設定を省略した場合は(上で説明した)デフォルトのサーバが使用され、オブジェクトの生成はディレクティブの影響を受けません。

**DCOM サーバ名**
`server_name` のキー	型	説明
Server	string	サーバの名前。
Username	string	接続するユーザ名。
Password	string	`Username` に対するパスワード。
Flags	integer	以下の定数のうちのひとつまたは複数の論理和。 `CLSCTX_INPROC_SERVER`、 `CLSCTX_INPROC_HANDLER`、 `CLSCTX_LOCAL_SERVER`、 `CLSCTX_REMOTE_SERVER`、 `CLSCTX_SERVER` および `CLSCTX_ALL`。指定されていない場合のデフォルト値は、`Server` を省略した場合が `CLSCTX_SERVER` でサーバ名を指定した場合は `CLSCTX_REMOTE_SERVER` です。これらの定数の意味についての詳細な情報を得るには、Microsoft のドキュメントで CoCreateInstance について調べましょう。通常はこれらを使用する必要はないはずです。

codepage

文字列と Unicode 文字列との相互変換に使用するコードページを指定します。 PHP の文字列と COM オブジェクトのメソッドとの受け渡しの際には、いつも変換が行われます。PHP 5 では、コードページの扱いは面倒です。というのは、オブジェクトだけではなくオブジェクトから返される variant にもそれが影響するからです。とりうる値は CP_ACP (システムのデフォルト ANSI コードページを使用する - このパラメータが指定されなかった場合のデフォルト)、 CP_MACCP、 CP_OEMCP、CP_SYMBOL、 CP_THREAD_ACP (現在実行中のスレッドのコードページ/ロケールを使用する)、CP_UTF7 および CP_UTF8 です。コードページに対応する数値を指定することも可能です。コードページとそれに対応する数値についての詳細は、Microsoft のドキュメントを参照ください。

オーバーロードされたメソッド

返されるオブジェクトは、オーバーロードされたものです。つまり、 PHP 側では通常のクラスのメソッドは見えないということです。その代わりに、プロパティやメソッドへのアクセスは COM を通じて行います。

PHP 5 以降では、参照渡しのパラメータを受け付けるメソッドを PHP が自動検出するようになりました。それらのメソッドについては、PHP が自動的に変数を参照渡し形式に変換します。つまり、メソッドのコールをより自然に行えるということです。コードの中で特別な処理をする必要はありません。

PHP 4 では、パラメータを参照渡しする場合には、そのパラメータをラップするために VARIANT クラスのインスタンスを生成する必要があります。

疑似メソッド

PHP 5 より前のバージョンでは、以下のようなメソッド名を COM に渡すことができず、直接 PHP で扱うことができないというあまりうれしくない出来事がありました。PHP 5 ではこれらを解決します。スクリプトの修正方法については以下の詳細を参照ください。これらのマジックメソッドの名前は大文字小文字を区別しません。

void COM::AddRef ( void )

COM オブジェクトの参照カウントを作為的に追加します。

警告

このメソッドを使用することはまずないはずです。これは、以下で説明する Release() メソッドを論理的に補完するものとして存在するものです。

void COM::Release ( void )

COM オブジェクトの参照カウントを作為的に削除します。

警告

このメソッドを使用することはまずないはずです。これは、COM オブジェクトが必要以上に動作を続けてしまうというバグに対応する方法として PHP に存在するものです。

反復処理のための疑似メソッド

以下の疑似メソッドは、 com_isenum() が TRUE を返す場合のみ利用可能で、この場合、これらのメソッドは、通常は COM オブジェクトにより提供される同じ名前を有する全てのメソッドを隠蔽します。これらのメソッドは PHP 5 では完全に廃止されています。代わりに For Each を使用してください。

variant COM::All ( void )

10 の要素を保持する SafeArray を表す variant を返します。個々の要素は empty/null の variant となります。この関数はイテレータからの全ての要素を含む配列を返すことを想定していますが、決して完了しません。使用しないでください。

variant COM::Next ( void )

イテレータの次の要素を表す variant を返します。要素がもうない場合には FALSE を返します。

variant COM::Prev ( void )

イテレータの前の要素を現す variant を返します。要素がもうない場合には FALSE を返します。

void COM::Reset ( void )

イテレータを最初の場所まで巻き戻します。

COM の例

例1 COM の例 (1)


<?php
// word を起動します
$word = new COM("word.application") or die("Unable to instantiate Word");
echo "Loaded Word, version {$word->Version}\n";

// 前面に移動させます
$word->Visible = 1;

// 空のドキュメントを開きます
$word->Documents->Add();

// 何か複雑なことを行います
$word->Selection->TypeText("This is a test...");
$word->Documents[1]->SaveAs("Useless test.doc");

// word を閉じます
$word->Quit();

// オブジェクトを開放します
$word = null;
?>

例2 COM の例 (2)


<?php

$conn = new COM("ADODB.Connection") or die("Cannot start ADO");
$conn->Open("Provider=SQLOLEDB; Data Source=localhost;
Initial Catalog=database; User ID=user; Password=password");

$rs = $conn->Execute("SELECT * FROM sometable");    // レコードセット

$num_columns = $rs->Fields->Count();
echo $num_columns . "\n";

for ($i=0; $i < $num_columns; $i++) {
    $fld[$i] = $rs->Fields($i);
}

$rowcount = 0;
while (!$rs->EOF) {
    for ($i=0; $i < $num_columns; $i++) {
        echo $fld[$i]->value . "\t";
    }
    echo "\n";
    $rowcount++;            // 行カウントの加算
    $rs->MoveNext();
}

$rs->Close();
$conn->Close();

$rs = null;
$conn = null;

?>