Fix #2183 inconsistent return type comments in File controller and model classes

This commit is contained in:
Kijin Sung 2023-09-16 18:51:57 +09:00
parent ec4d5f07df
commit e5bea38a9e
2 changed files with 15 additions and 15 deletions

View file

@ -165,7 +165,7 @@ class FileController extends File
/** /**
* Iframe upload attachments * Iframe upload attachments
* *
* @return Object * @return void
*/ */
function procFileIframeUpload() function procFileIframeUpload()
{ {
@ -210,7 +210,7 @@ class FileController extends File
/** /**
* Image resize * Image resize
* *
* @return Object * @return void
*/ */
function procFileImageResize() function procFileImageResize()
{ {
@ -573,7 +573,7 @@ class FileController extends File
/** /**
* Delete an attachment from the editor * Delete an attachment from the editor
* *
* @return Object * @return void
*/ */
function procFileDelete() function procFileDelete()
{ {
@ -610,7 +610,7 @@ class FileController extends File
/** /**
* get file list * get file list
* *
* @return Object * @return void
*/ */
function procFileGetList() function procFileGetList()
{ {
@ -662,7 +662,7 @@ class FileController extends File
* A trigger to delete the attachment in the upload_target_srl (document_srl) * A trigger to delete the attachment in the upload_target_srl (document_srl)
* *
* @param object $obj Trigger object * @param object $obj Trigger object
* @return Object * @return BaseObject
*/ */
function triggerDeleteAttached(&$obj) function triggerDeleteAttached(&$obj)
{ {
@ -677,7 +677,7 @@ class FileController extends File
* A trigger to delete the attachment in the upload_target_srl (comment_srl) * A trigger to delete the attachment in the upload_target_srl (comment_srl)
* *
* @param object $obj Trigger object * @param object $obj Trigger object
* @return Object * @return BaseObject
*/ */
function triggerCommentDeleteAttached(&$obj) function triggerCommentDeleteAttached(&$obj)
{ {
@ -694,7 +694,7 @@ class FileController extends File
* A trigger to delete all the attachements when deleting the module * A trigger to delete all the attachements when deleting the module
* *
* @param object $obj Trigger object * @param object $obj Trigger object
* @return Object * @return BaseObject
*/ */
function triggerDeleteModuleFiles(&$obj) function triggerDeleteModuleFiles(&$obj)
{ {
@ -740,7 +740,7 @@ class FileController extends File
* By changing its state to valid when a document is inserted, it prevents from being considered as a unnecessary file * By changing its state to valid when a document is inserted, it prevents from being considered as a unnecessary file
* *
* @param int $upload_target_srl * @param int $upload_target_srl
* @return Object * @return BaseObject
*/ */
function setFilesValid($upload_target_srl, $upload_target_type = null) function setFilesValid($upload_target_srl, $upload_target_type = null)
{ {
@ -780,12 +780,12 @@ class FileController extends File
* - sid * - sid
* </pre> * </pre>
* *
* @param object $file_info PHP file information array * @param array $file_info PHP file information array
* @param int $module_srl Sequence of module to upload file * @param int $module_srl Sequence of module to upload file
* @param int $upload_target_srl Sequence of target to upload file * @param int $upload_target_srl Sequence of target to upload file
* @param int $download_count Initial download count * @param int $download_count Initial download count
* @param bool $manual_insert If set true, pass validation check * @param bool $manual_insert If set true, pass validation check
* @return Object * @return BaseObject
*/ */
function insertFile($file_info, $module_srl, $upload_target_srl, $download_count = 0, $manual_insert = false) function insertFile($file_info, $module_srl, $upload_target_srl, $download_count = 0, $manual_insert = false)
{ {
@ -1486,7 +1486,7 @@ class FileController extends File
* </pre> * </pre>
* *
* @param array|int $file_list or $file_srl * @param array|int $file_list or $file_srl
* @return Object * @return BaseObject
*/ */
function deleteFile($file_list) function deleteFile($file_list)
{ {
@ -1572,7 +1572,7 @@ class FileController extends File
* Delete all attachments of a particular document * Delete all attachments of a particular document
* *
* @param int $upload_target_srl Upload target srl to delete files * @param int $upload_target_srl Upload target srl to delete files
* @return Object * @return BaseObject
*/ */
function deleteFiles($upload_target_srl) function deleteFiles($upload_target_srl)
{ {
@ -1593,7 +1593,7 @@ class FileController extends File
* Delete the attachment of a particular module * Delete the attachment of a particular module
* *
* @param int $module_srl Sequence of module to delete files * @param int $module_srl Sequence of module to delete files
* @return Object * @return BaseObject
*/ */
function deleteModuleFiles($module_srl) function deleteModuleFiles($module_srl)
{ {
@ -1616,7 +1616,7 @@ class FileController extends File
* @param int $source_srl Sequence of target to move * @param int $source_srl Sequence of target to move
* @param int $target_module_srl New squence of module * @param int $target_module_srl New squence of module
* @param int $target_srl New sequence of target * @param int $target_srl New sequence of target
* @return object * @return ?BaseObject
*/ */
function moveFile($source_srl, $target_module_srl, $target_srl) function moveFile($source_srl, $target_module_srl, $target_srl)
{ {

View file

@ -363,7 +363,7 @@ class FileModel extends File
* *
* @param int $file_srl The sequence of file to get information * @param int $file_srl The sequence of file to get information
* @param array $columnList The list of columns to get from DB * @param array $columnList The list of columns to get from DB
* @return Object|object|array If error returns an instance of Object. If result set is one returns a object that contins file information. If result set is more than one returns array of object. * @return object|array If error returns an instance of Object. If result set is one returns a object that contins file information. If result set is more than one returns array of object.
*/ */
public static function getFile($file_srl, $columnList = array()) public static function getFile($file_srl, $columnList = array())
{ {