MongoGridFS::storeFile

(PECL mongo >=0.9.0)

MongoGridFS::storeFile — ファイルをデータベースに格納する

説明

public MongoGridFS::storeFile ( string|resource $filename [, array $metadata = array() [, array $options = array() ]] ) : mixed

パラメータ

filename

格納するファイルの名前、あるいは読み込み可能なストリーム。

metadata

格納するファイルに含めるその他のメタデータフィールド。

注意:

これらのフィールドは、ドライバが自動生成したフィールドも上書きします。詳しい説明は、MongoDB コアドキュメントの » files collection を参照ください。この挙動の現実的な使い道としては、ファイルの chunkSize や _id を独自に指定する場合などがあります。

options

chunks および files コレクションに対して追加操作を実行するときの、オプションの配列。 オプションの意味については、MongoCollection::insert() を参照ください。

返り値

格納したファイルドキュメントの _id を返します。metadata パラメータで _id を明示的に指定していない場合は、自動生成した MongoId となります。

エラー / 例外

filename の読み込みに失敗したり、 chunks あるいは files コレクションへの追加に失敗したりした場合に MongoGridFSException をスローします。

例

例1 MongoGridFS::storeFile() でのメタデータの追加

<?php
$m = new MongoClient();
$gridfs = $m->selectDB('test')->getGridFS();

$id = $gridfs->storeFile('example.txt', array('contentType' => 'plain/text'));
$gridfsFile = $gridfs->get($id);

var_dump($gridfsFile->file);
?>

上の例の出力は、 たとえば以下のようになります。

array(7) {
  ["_id"]=>
  object(MongoId)#6 (0) {
  }
  ["contentType"]=>
  string(10) "plain/text"
  ["filename"]=>
  string(11) "example.txt"
  ["uploadDate"]=>
  object(MongoDate)#7 (0) {
  }
  ["length"]=>
  int(26)
  ["chunkSize"]=>
  int(262144)
  ["md5"]=>
  string(32) "c3fcd3d76192e4007dfb496cca67e13b"
}

参考