Docs For Class Admin_MediaController

Admin

# Class: Admin_MediaController Source Location: /application/modules/admin/controllers/MediaController.php
### Class Overview
    Zend_Controller_Action
       |
       --Setuco_Controller_Action_Abstract
          |
          --Setuco_Controller_Action_AdminAbstract
             |
             --Admin_MediaController
ファイル管理画面の操作を行うコントローラ #### Author(s): akitsukada | ### Variables $_fileInputIDs $_fileInputID_base $_media | ### Constants FILECOMMENT_LENGTH_MAX FILENAME_LENGTH_MAX FILENAME_LENGTH_MIN FILE_COUNT_MAX FILE_SIZE_MAX FILE_SIZE_MIN PAGE_LIMIT | ### Methods createAction deleteAction formAction indexAction init updateAction _backupFileById _createSearchForm _createUpdateForm _createUploadForm _makeFileCommentValidators _makeFileNameValidators _makeFileValidators _recoverFromBackUpFile _removeBackupFile _removeFileById _updateFailed
### Inherited Constants #### Class: Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_AdminAbstract::PAGE_LIMIT #### Class: Setuco_Controller_Action_Abstract Setuco_Controller_Action_Abstract::DOT_ADDITIONAL_STRING | ### Inherited Variables #### Class: Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_AdminAbstract::$_navigation Setuco_Controller_Action_AdminAbstract::$_pageLimit Setuco_Controller_Action_AdminAbstract::$_pageTitle | ### Inherited Methods #### Class: Setuco_Controller_Action_AdminAbstract Setuco_Controller_Action_AdminAbstract::init() adminモジュールコントローラの初期処理です。 Setuco_Controller_Action_AdminAbstract::postDispatch() アクションメソッドが呼ばれた後の処理です。 Setuco_Controller_Action_AdminAbstract::_addFormElementCommonOptions() フォームエレメントの共通設定をする requiredなどの設定をする 　第２引数で、設定しない項目を指定できる Setuco_Controller_Action_AdminAbstract::_chooseHeadTitle() リクエスト中のページのタイトルを取得します。 Setuco_Controller_Action_AdminAbstract::_getAccountInfos() ログインしているユーザーの情報を取得する Setuco_Controller_Action_AdminAbstract::_initHeader() ヘッダーに関する初期処理です。 Setuco_Controller_Action_AdminAbstract::_initNavigation() ナビゲーションの設定情報を初期化します。 #### Class: Setuco_Controller_Action_Abstract Setuco_Controller_Action_Abstract::init() 全てのコントローラ共通の初期処理です。 Setuco_Controller_Action_Abstract::setPagerForView() ページャーの設定をして、ビューで使用できるようにする Setuco_Controller_Action_Abstract::_encodeRestParam() パラメーターをリダイレクトパラムで確実に送信出来るようにエンコードします。 Setuco_Controller_Action_Abstract::_getModulePath() モジュールのディレクトリーのパスを取得する Setuco_Controller_Action_Abstract::_getPageLimit() 一ページあたりの取得件数の_pageLimitのゲッター Setuco_Controller_Action_Abstract::_getPageNumber() ページネーターで使う現在の（クリックされた）ページ番号を取得するメソッドです Setuco_Controller_Action_Abstract::_initLayout() レイアウトを設定します。 Setuco_Controller_Action_Abstract::_isRedirectNeeded() REST形式のURLにリダイレクトするかどうか判断します。 Setuco_Controller_Action_Abstract::_loadRedirectParams() REST形式にリダイレクトするパラメーターを取得する ファイル名は rest-params.xml Setuco_Controller_Action_Abstract::_restRedirectIfNeeded() REST形式のURLにリダイレクトするものだったら、リダイレクトする Setuco_Controller_Action_Abstract::_setLayoutName() レイアウト名を設定します。 Setuco_Controller_Action_Abstract::_setPageLimit() 一ページあたりの取得件数の_pageLimitのセッター メソッドチェーンを使用できる Setuco_Controller_Action_Abstract::_showFlashMessages() フラッシュメッセージがアクションヘルパーに設定されていればビューにセットして可視化します。
### Class Details [line 25] ファイル管理画面の操作を行うコントローラ #### Tags:
author: | akitsukada
[ Top ] ### Class Variables #### $_fileInputIDs = array() [line 43] 複数ファイルアップロード用inputのidとname。$_fileInputID_baseに連番を振ったもの。 連番は1〜FILE_COUNT_MAXまでで、init()で設定される。 #### Tags:
access: | private
Type: | array
[ Top ] #### $_fileInputID_base = 'upload_img_' [line 37] 複数ファイルアップロード用inputのidとnameになる文字列の共通部分。末尾に連番を振る。 #### Tags:
access: | private
Type: | string
[ Top ] #### $_media = null [line 32] Mediaサービスクラスのオブジェクト #### Tags:
access: | private
Type: | Admin_Model_Media
[ Top ] ### Class Methods ### method createAction [line 177]
`void createAction( )`
ファイルの新規アップロード処理。DB（media）に新規レコード挿入、ファイルシステム上に受信した実ファイルを保存。 画像ファイルの場合はサムネイルも生成する。 #### Tags:
author: | akitsukada
access: | public
[ Top ] ### method deleteAction [line 514]
`void deleteAction( )`
ファイル削除処理。DB（mediaテーブル）のレコードとファイルシステム上の実ファイルを両方削除する。 #### Tags:
author: | akitsukada
access: | public
[ Top ] ### method formAction [line 309]
`void formAction( )`
ファイル更新用のページ #### Tags:
author: | akitsukada
access: | public
[ Top ] ### method indexAction [line 102]
`void indexAction( )`
ファイルのアップロードフォームやアップロードしてあるファイルの一覧を表示するページ #### Tags:
author: | akitsukada
access: | public
[ Top ] ### method init [line 86]
`void init( )`
初期化処理 #### Tags:
author: | akitsukada
access: | public
Overrides Setuco_Controller_Action_AdminAbstract::init() (adminモジュールコントローラの初期処理です。) [ Top ] ### method updateAction [line 347]
`void updateAction( )`
ファイル更新処理のアクション。DBのレコードとファイルシステム上の実ファイル両方を更新する。 formアクションに遷移する。 #### Tags:
author: | akitsukada
access: | public
[ Top ] ### method _backupFileById [line 840]
`boolean _backupFileById( int $id, string $preExtension)`
uploadとthumbnailディレクトリにある指定のファイル(ファイル名：<id.拡張子>)に ".bak"を付けて<id.拡張子.bak>にリネームする <ID.拡張子>　→　<ID.拡張子.bak> ファイル更新失敗時にもとに戻すため #### Tags:
return: | 処理成功すればtrue,失敗すればfalse
author: | akitsukada
access: | private
#### Parameters:
int | $id | ファイルのID
string | $preExtension | 既存ファイルの拡張子
[ Top ] ### method _createSearchForm [line 553]
`Zend_Form _createSearchForm( )`
ファイルの絞込み・ソート用フォームを作成する #### Tags:
return: | ファイルの絞込み・ソート用フォームオブジェクト
author: | akitsukada
todo: | フォームのハッシュ値の設定
access: | private
[ Top ] ### method _createUpdateForm [line 644]
`Zend_Form _createUpdateForm( int $id)`
ファイルの更新（=上書きアップロード）用フォームを作成する #### Tags:
return: | ファイルの更新（=上書きアップロード）用フォームオブジェクト
author: | akitsukada
todo: | フォームのハッシュ値の設定
access: | private
#### Parameters:
int | $id | 更新対象ファイルのID
[ Top ] ### method _createUploadForm [line 599]
`Zend_Form _createUploadForm( )`
ファイル新規アップロード用フォームを作成する #### Tags:
return: | ファイル新規アップロード用フォームオブジェクト
author: | akitsukada
todo: | フォームのハッシュ値の設定
access: | private
[ Top ] ### method _makeFileCommentValidators [line 727]
`void _makeFileCommentValidators( )`
#### Tags:
access: | private
[ Top ] ### method _makeFileNameValidators [line 711]
`void _makeFileNameValidators( )`
#### Tags:
access: | private
[ Top ] ### method _makeFileValidators [line 746]
`array _makeFileValidators( )`
ファイル選択inputのバリデータを作成して返す。 #### Tags:
return: | バリデータの配列
author: | akitsukada
access: | private
[ Top ] ### method _recoverFromBackUpFile [line 899]
`boolean _recoverFromBackUpFile( int $id, string $extension)`
指定したIDと拡張子の〜.bakファイルを、".bak"がない元のファイル名にリネームする。 <ID.拡張子.bak>　→　<ID.拡張子> <ID.拡張子>ファイルは存在していないことが前提 #### Tags:
return: | 処理成功すればtrue,失敗すればfalse
author: | akitsukada
access: | private
#### Parameters:
int | $id | ファイルのID
string | $extension | バックアップファイルの拡張子
[ Top ] ### method _removeBackupFile [line 872]
`boolean _removeBackupFile( int $id, string $extension)`
指定したIDと拡張子の〜.bakファイル（本体もサムネイルも両方）を削除する <ID.拡張子.bak>　→　削除 #### Tags:
return: | 処理成功すればtrue,失敗すればfalse
author: | akitsukada
access: | private
#### Parameters:
int | $id | ファイルのID
string | $extension | バックアップファイルの拡張子
[ Top ] ### method _removeFileById [line 793]
`boolean _removeFileById( int $id)`
アップロードされた、指定IDのファイル（ファイル本体とサムネイル両方）をファイルシステム上から削除する。 ファイル本体は、uploadディレクトリ内の<指定ID>.(jpg|gif|png|pdf|txt) を全て削除する。 <指定ID>.jpg.bakなどは削除しない。 サムネイルは、thumbnailディレクトリ内の<指定ID>.gifを削除する。 処理中にfalseとなった場合、その時点で削除してしまったファイルは元に戻らない。 #### Tags:
return: | 正常にファイル本体／サムネイルとも削除できればTrue、一つでも削除に失敗すればFalse。
author: | akitsukada
access: | private
#### Parameters:
int | $id | 削除するファイルのID
[ Top ] ### method _updateFailed [line 493]
`void _updateFailed( int $id, string $inputName, string $inputComment, $form, [ $errorMessage = null])`
更新処理中にエラーが起きたとき、$formにエラー情報をセットしてformActionにforwardする #### Tags:
access: | private
#### Parameters:
int | $id |
string | $inputName |
string | $inputComment |
Zend_Form | $form |
| $errorMessage |
[ Top ] ### Class Constants #### FILECOMMENT_LENGTH_MAX = 300 [line 73] ファイルの説明の長さ 最長文字数 [ Top ] #### FILENAME_LENGTH_MAX = 50 [line 68] ファイルの表示名の長さ 最長文字数 [ Top ] #### FILENAME_LENGTH_MIN = 1 [line 63] ファイルの表示名の長さ 最短文字数 [ Top ] #### FILE_COUNT_MAX = 5 [line 48] アップロードできる最大ファイル個数 [ Top ] #### FILE_SIZE_MAX = 512000 [line 53] アップロードできるファイルサイズの最大値（Byte単位） [ Top ] #### FILE_SIZE_MIN = 1 [line 58] アップロードできるファイルサイズの最小値（Byte単位） [ Top ] #### PAGE_LIMIT = 10 [line 78] 一覧表示時、１ページに何件のファイルを表示するか [ Top ] Documentation generated on Mon, 07 Feb 2011 01:28:21 +0900 by phpDocumentor 1.4.3