plugindev:media

MEDIAクラス リファレンス

MEDIAクラスはメディアの入出力を行うためのメソッドを提供するクラスです。このクラスはv3.3現在、nucleus/libs/MEDIA.phpで定義されています。

間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。

メソッド一覧(一部)

リファレンス

getCollectionList

array MEDIA::getCollectionList()

メンバーが使用可能なコレクションの一覧を取得する

現在のメンバーが使用可能なコレクションの一覧を取得します。

一覧は連想配列として返されます。キーはコレクションの名前、値は表示に用いる名前です。これらは通常同一ですが、プライベート・コレクションの場合のみ、表示に使用する名前が"Private Collection"になります。

  • 戻り値
    • コレクションの一覧である連想配列
  • パラメータ
    • なし

getMediaListByCollection

array MEDIA::getMediaListByCollection(string collection [, string filter])

コレクション内のメディアのリストを取得する

コレクション内に含まれるメディアの一覧を返します。サブディレクトリは検索されません。

第二引数に文字列を指定することで、ファイル名にその文字列を含むメディアのみの一覧を返すようになります。

一覧は配列の形で返されます。配列はタイムスタンプ順にソートされたMEDIAOBJECTオブジェクトです。MEDIAOBJECTクラスについてはMEDIAOBJECTクラス リファレンスを参照してください。

  • 戻り値
    • メディアの一覧である配列
  • パラメータ
    1. string collection : 検索を行うコレクション
    2. string filter : 絞込みを行う文字列

checkFilter

bool MEDIA::checkFilter(string strText, string strFilter)

文字列に、別の文字列が含まれているか調べる

第二引数が空文字列である場合、または第一引数の文字列の中に第二引数の文字列が含まれている場合に真を返し、それ以外の場合は偽を返すメソッドです。

大文字小文字の違いは無視されます。

  • 戻り値
    • チェック結果を示す真偽値
  • パラメータ
    1. string strText : チェックされる文字列
    2. string strFilter : チェックする文字列

isValidCollection

bool MEDIA::isValidCollection(string collectionName)

指定されたコレクションが使用可能なものかどうか調べる

指定された文字列を、現在のメンバーが使用可能な場合に真を返します。それ以外の場合の返り値は偽です。

メンバーがコレクションを使用できないのは以下の場合です。

  • コレクションに対応するディレクトリが存在しない。
  • コレクションが他のメンバーのプライベート・コレクションである。
  • 戻り値
    • チェック結果を示す真偽値
  • パラメータ
    1. string collectionName : チェックするコレクション名

addMediaObject

string MEDIA::addMediaObject(string collection, array uploadfile, string filename)

アップロードされたメディア・ファイルを保存する

アップロードされたファイルを保存します。

ファイル情報は第二引数で指定します。ここにはpostFileInfoで得られるファイルの情報を指定します。

Nucleus v3.3以降では、このメソッドからPreMediaUploadイベント、およびPostMediaUploadイベントが呼び出されます。これらのイベントを使用するプラグインによって、保存時のコレクションやファイル名が変更されたり、保存そのものが実行されなくなる可能性があります。

戻り値はエラー・メッセージです。エラーが発生しなかった場合は空文字列が返ります。

  • 戻り値
    • エラー・メッセージ
  • パラメータ
    • string collection : 保存先のコレクション名
    • array uploadfile : アップロードされたファイルの情報
    • string filename : 保存時に使用されるファイル名

addMediaObjectRaw

string MEDIA::addMediaObjectRaw(string collection, string filename, string &data)

バイナリ・データをメディア・ファイルとして保存する

指定されたバイナリデータをファイルとして保存します。

MEDIA::addMediaObjectとは違い、現在のメンバーが指定されたコレクションを使用可能かどうかはチェックされません。また、PreMediaUploadイベント、およびPostMediaUploadイベントの呼び出しも行われません。

戻り値はエラー・メッセージです。エラーが発生しなかった場合は空文字列が返ります。

  • 戻り値
    • エラー・メッセージ
  • パラメータ
    • string collection : 保存先のコレクション名
    • string filename : 保存時に使用されるファイル名
    • string data : 保存されるバイナリ・データ
 
plugindev/media.txt · 最終更新: 2011/03/23 21:28 (外部編集)