Chonmage manager関数マニュアル

バージョン21.07-1用

クラス chonmage (main.phpに収録)

例: $chonmage = new chonmage();

chonmage::add_file ($up_file, $original_name, $owner, $title, $description, $tags, $save_original)

アップロードされた新しいファイルの情報をデータベースに登録し、config.iniの設定に従ってファイルをサーバーに保存します。ファイルが画像の場合はthumbnails.jsonの設定に従ってリサイズされたサムネイルとともに保存します。

$up_file ：アップロードされたファイルのパス (例: $_FILES["up_file"]["tmp_name"])
$original_name ：ファイルのアップロード前のファイル名(例: $_FILES["up_file"]["name"])
$owner ：投稿者のIDまたはハンドルネームなど
$title ：ファイルのタイトルなど
$description ：ファイルの説明など
$tags ：ファイルに付与するタグ(10個までの配列、11個目以降の項目は無視されます。)
$save_original(省略可) ：アップロードされたオリジナルファイルを保存するか(FALSEを指定するか省略すると、画像のサイズがconfig.iniで指定した最大値より大きい場合は画像を縮小してから保存します。TRUEを指定した場合は画像のサイズに関わらず画像を縮小しません。)

返り値 ：成功した場合は、アップロードされた画像に自動的に割り当てられたファイルIDの文字列を返します。失敗した場合はFALSEを返します。

注意

php.iniの設定でアップロードファイルのサイズの最大値や、メモリ使用量の上限が小さく設定されていると、大きなファイルをアップロードする際にエラーが発生します。

chonmage::delete_file ($file_id)

指定されたファイルを削除します。

$file_id ：削除するファイルのID

返り値 ：成功した場合はTRUE、失敗した場合はFALSEを返します。

chonmage::get_file_info ($file_id, $get_details)

指定されたファイルの情報を取得します。
$file_id ：情報を取得するファイルのID
$get_details ：詳細情報を取得するか(省略時はTRUEとして扱います)

返り値 ：成功した場合は、画像の情報を連想配列で返します。失敗した場合はFALSEを返します。
$get_detailsにFALSEを指定すると、width、height、original_file_created、tagsは出力されません。

　base_path ファイル実体へのパス(拡張子を含みません)
　file_name アップロード前のファイル名
　file_format ファイルの形式(jpeg、pngなど)
　title ファイルのタイトル
　description 画像の説明文
　owner 投稿者のIDまたはハンドルネームなど
　created ファイルが最初にアップロードされた日時
　last_updated ファイルの最終更新日時
　file_size ファイルサイズ数値(バイト単位)
　hash ファイルのチェックサム(方式はconfig.iniで指定可能)
　width 画像の幅(画像以外ではこの項目は存在しません)
　height 画像の高さ(画像以外ではこの項目は存在しません)
　original_file_created 写真の撮影日時(画像以外ではこの項目は存在しません)
　tags タグ(配列)

chonmage::replace_file ($file_id, $up_file, $original_name, $save_original)

アップロードされた新しいファイルで既存のファイルを置き換えます。

$file_id ：置き換えるファイルのID
$up_file ：アップロードされたファイルのパス (例: $_FILES["up_file"]["tmp_name"])
$original_name ：ファイルのアップロード前のファイル名(例: $_FILES["up_file"]["name"])
$save_original(省略可) ：アップロードされたオリジナルファイルを保存するか(FALSEを指定するか省略すると、画像のサイズがconfig.iniで指定した最大値より大きい場合は画像を縮小してから保存します。TRUEを指定した場合は画像のサイズに関わらず画像を縮小しません。)

返り値 ：成功した場合はTRUE、失敗した場合はFALSEを返します。

chonmage::search_files ($q, $start, $rows, $key, $asc)

ファイルを検索します。検索条件を全て省略し、全ファイルの一覧を取得するために使用することもできます。

$q ：検索情報を含む連想配列(必要のない項目は省略可能、全て省略すると全ファイルの一覧を取得します。)
　　"file_name" ：アップロード前のファイル名
　　"file_format" ：ファイルフォーマット("png"、"jpeg"など)
　　"category" ：ファイルのカテゴリ("image"、"document"、"archive"、"audio"、"movie"、"font"、"other"のいずれか)
　　"owner" ：投稿者のIDまたはハンドルネームなど
　　"tags" ：タグ(復数の場合は配列で指定)
　　"min_created" ：ファイルの作成日の範囲、前
　　"max_created" ：ファイルの作成日の範囲、後
　　"min_last_updated" ：ファイルの更新日の範囲、前
　　"max_last_updated" ：ファイルの更新日の範囲、後
$start ：検索結果をいくつめから取得するか
$rows ：検索結果をいくつ取得するか
$key(省略可) ：結果の並び替えに使用する値(省略時は作成日、CHONMAGE_SEARCH_LAST_UPDATEDを指定した場合は更新日)
$asc(省略可) ：結果並び順を昇順にする場合はTRUE(省略時はFALSE)

返り値 ：成功した場合は、結果を連想配列で返します。このうち、"results"には検索結果の配列(各項目はget_file_infoで$get_details=FALSEを指定した場合と同様の連想配列)、"count"には検索条件に一致するすべての画像($startと$rowsに関係なく)の件数が格納されます。なお、検索条件に一致する画像がなかった場合にはNULL、エラーの場合はFALSEを返します。

chonmage::update_file_info ($file_id, $owner, $title, $description, $tags, $file_name, $update_date_time)

画像の情報を変更します。

$file_id ：情報を変更するファイルのID
$owner ：投稿者のIDまたはハンドルネームなど
$title ：ファイルのタイトルなど
$description ：ファイルの説明など
$tags ：ファイルのタグ(配列で指定、10個まで)
$file_name ：ファイル名。省略可能。 $update_date_time ：省略時はTRUEとみなします。FALSEを指定した場合のみ、データベースの更新日時に反映されません。
返り値 ：成功した場合はTRUE、失敗した場合はFALSEを返します。

クラス chonmage_config (config.phpに収録)

例: $config = new chonmage_config();

(執筆中)