125 lines
3.5 KiB
PHP
125 lines
3.5 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; under version 2
|
|
* of the License (non-upgradable).
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* Copyright (c) 2008-2010 (original work) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
|
|
* 2009-2016 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
|
|
*
|
|
*/
|
|
|
|
use oat\oatbox\service\ServiceManager;
|
|
use oat\tao\model\upload\UploadService;
|
|
|
|
/**
|
|
* The description of a file at upload time.
|
|
*
|
|
* @access public
|
|
* @author Jerome Bogaerts, <jerome@taotesting.com>
|
|
* @package tao
|
|
*/
|
|
class tao_helpers_form_data_UploadFileDescription extends tao_helpers_form_data_FileDescription
|
|
{
|
|
|
|
/** Action form: add */
|
|
const FORM_ACTION_ADD = 'add';
|
|
|
|
/** Action form: delete */
|
|
const FORM_ACTION_DELETE = 'delete';
|
|
|
|
/**
|
|
* The mime/type of the file e.g. text/plain.
|
|
*
|
|
* @access private
|
|
* @var string
|
|
*/
|
|
private $type = '';
|
|
|
|
/**
|
|
* The temporary file path where the file is uploaded, waiting to be moved
|
|
* the right place on the file system.
|
|
*
|
|
* @access private
|
|
* @var \oat\oatbox\filesystem\File
|
|
*/
|
|
private $tmpPath;
|
|
|
|
/**
|
|
* Allow to specify action to know form purpose
|
|
*
|
|
* @var string
|
|
*/
|
|
private $action;
|
|
|
|
/**
|
|
* The temporary file path where the file is stored before being moved to
|
|
* right place.
|
|
*
|
|
* @access public
|
|
* @author Jerome Bogaerts <jerome@taotesting.com>
|
|
* @param string $name The name of the file e.g. tmpImage.tmp
|
|
* @param int $size The size of the file in bytes
|
|
* @param string $type The mime-type of the file e.g. text/plain.
|
|
* @param string $tmpPath
|
|
* @param string $action
|
|
* @return mixed
|
|
* @throws \oat\oatbox\service\ServiceNotFoundException
|
|
* @throws \common_Exception
|
|
*/
|
|
public function __construct($name, $size, $type, $tmpPath, $action = null)
|
|
{
|
|
parent::__construct($name, $size);
|
|
$this->type = $type;
|
|
if ($tmpPath) {
|
|
$this->tmpPath = ServiceManager::getServiceManager()->get(UploadService::SERVICE_ID)->universalizeUpload($tmpPath);
|
|
}
|
|
$this->action = is_null($action) ? self::FORM_ACTION_ADD : $action;
|
|
}
|
|
|
|
/**
|
|
* Returns the mime-type of the file.
|
|
*
|
|
* @access public
|
|
* @author Jerome Bogaerts <jerome@taotesting.com>
|
|
* @return string
|
|
*/
|
|
public function getType()
|
|
{
|
|
return (string) $this->type;
|
|
}
|
|
|
|
/**
|
|
* Returns the temporary path of the file.
|
|
*
|
|
* @access public
|
|
* @author Jerome Bogaerts <jerome@taotesting.com>
|
|
* @return \oat\oatbox\filesystem\File
|
|
*/
|
|
public function getTmpPath()
|
|
{
|
|
return $this->tmpPath;
|
|
}
|
|
|
|
/**
|
|
* Return action form
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getAction()
|
|
{
|
|
return $this->action;
|
|
}
|
|
}
|