add phpDoc comment in trash module

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10800 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
ovclas 2012-06-26 07:57:36 +00:00
parent 663fcaf84b
commit 7f54f7b14e
6 changed files with 95 additions and 51 deletions

View file

@ -1,10 +1,20 @@
<?php
/**
* trashModel class
* trash the module's model class
*
* @author NHN (developers@xpressengine.com)
* @package /modules/trash
* @version 0.1
*/
class trashModel extends trash
{
/**
* @brief get one trash object
**/
* Get one trash object
* @param int $trashSrl
* @pram array $columnList
* @return TrashVO
*/
function getTrash($trashSrl, $columnList = array())
{
$oTrashVO = new TrashVO();
@ -20,8 +30,11 @@ class trashModel extends trash
}
/**
* @brief get trash object list
**/
* Get TrashVO list
* @param object $args
* @param array $columnList
* @return object
*/
function getTrashList($args, $columnList = array())
{
$output = executeQueryArray('trash.getTrashList', $args, $columnList);
@ -39,8 +52,11 @@ class trashModel extends trash
}
/**
* @brief set trash object from std object
**/
* Set trash object from std object
* @param TrashVO $oTrashVO
* @param object $stdObject
* @return void
*/
function _setTrashObject(&$oTrashVO, $stdObject)
{
$oTrashVO->setTrashSrl($stdObject->trash_srl);