MEDIAクラスはメディアの入出力を行うためのメソッドを提供するクラスです。このクラスはv3.3現在、nucleus/libs/MEDIA.phpで定義されています。
間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。
array MEDIA::getCollectionList()
現在のメンバーが使用可能なコレクションの一覧を取得します。
一覧は連想配列として返されます。キーはコレクションの名前、値は表示に用いる名前です。これらは通常同一ですが、プライベート・コレクションの場合のみ、表示に使用する名前が”Private Collection”になります。
array MEDIA::getMediaListByCollection(string collection [, string filter])
コレクション内に含まれるメディアの一覧を返します。サブディレクトリは検索されません。
第二引数に文字列を指定することで、ファイル名にその文字列を含むメディアのみの一覧を返すようになります。
一覧は配列の形で返されます。配列はタイムスタンプ順にソートされたMEDIAOBJECTオブジェクトです。MEDIAOBJECTクラスについてはMEDIAOBJECTクラス リファレンスを参照してください。
bool MEDIA::checkFilter(string strText, string strFilter)
第二引数が空文字列である場合、または第一引数の文字列の中に第二引数の文字列が含まれている場合に真を返し、それ以外の場合は偽を返すメソッドです。
大文字小文字の違いは無視されます。
bool MEDIA::isValidCollection(string collectionName)
指定された文字列を、現在のメンバーが使用可能な場合に真を返します。それ以外の場合の返り値は偽です。
メンバーがコレクションを使用できないのは以下の場合です。
string MEDIA::addMediaObject(string collection, array uploadfile, string filename)
アップロードされたファイルを保存します。
ファイル情報は第二引数で指定します。ここにはpostFileInfoで得られるファイルの情報を指定します。
Nucleus v3.3以降では、このメソッドからPreMediaUploadイベント、およびPostMediaUploadイベントが呼び出されます。これらのイベントを使用するプラグインによって、保存時のコレクションやファイル名が変更されたり、保存そのものが実行されなくなる可能性があります。
戻り値はエラー・メッセージです。エラーが発生しなかった場合は空文字列が返ります。
string MEDIA::addMediaObjectRaw(string collection, string filename, string &data)
指定されたバイナリデータをファイルとして保存します。
MEDIA::addMediaObjectとは違い、現在のメンバーが指定されたコレクションを使用可能かどうかはチェックされません。また、PreMediaUploadイベント、およびPostMediaUploadイベントの呼び出しも行われません。
戻り値はエラー・メッセージです。エラーが発生しなかった場合は空文字列が返ります。
