ILIAS
release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
|
Class ilFileDelivery. More...
Public Member Functions | |
__construct ($path_to_file) | |
stream () | |
deliver () | |
deliverVirtual () | |
not supported More... | |
setGeneralHeaders () | |
setCachingHeaders () | |
generateEtag () | |
getDeliveryType () | |
setDeliveryType ($delivery_type) | |
getMimeType () | |
setMimeType ($mime_type) | |
getPathToFile () | |
setPathToFile ($path_to_file) | |
getDownloadFileName () | |
setDownloadFileName ($download_file_name) | |
getDisposition () | |
setDisposition ($disposition) | |
isSendMimeType () | |
setSendMimeType ($send_mime_type) | |
isExitAfter () | |
setExitAfter ($exit_after) | |
isConvertFileNameToAsci () | |
setConvertFileNameToAsci ($convert_file_name_to_asci) | |
getEtag () | |
setEtag ($etag) | |
getShowLastModified () | |
setShowLastModified ($show_last_modified) | |
isHasContext () | |
setHasContext ($has_context) | |
hasCache () | |
setCache ($cache) | |
hasHashFilename () | |
setHashFilename ($hash_filename) | |
isDeleteFile () | |
setDeleteFile ($delete_file) | |
isUrlencodeFilename () | |
setUrlencodeFilename ($urlencode_filename) | |
Static Public Member Functions | |
static | deliverFileAttached ($path_to_file, $download_file_name=null, $mime_type=null) |
static | streamVideoInline ($path_to_file, $download_file_name=null) |
static | deliverFileInline ($path_to_file, $download_file_name=null) |
static | isDEBUG () |
static | setDEBUG ($DEBUG) |
static | returnASCIIFileName ($original_name) |
Data Fields | |
const | DELIVERY_METHOD_NONE = 'cache' |
const | DELIVERY_METHOD_XSENDFILE = 'mod_xsendfile' |
const | DELIVERY_METHOD_XACCEL = 'x-accel-redirect' |
const | DELIVERY_METHOD_PHP = 'php' |
const | DELIVERY_METHOD_PHP_CHUNKED = 'php_chunked' |
const | DELIVERY_METHOD_VIRTUAL = 'virtual' |
const | DISP_ATTACHMENT = 'attachment' |
const | DISP_INLINE = 'inline' |
const | VIRTUAL_DATA = 'virtual-data' |
const | SECURED_DATA = 'secured-data' |
const | DATA = 'data' |
Protected Member Functions | |
deliverXSendfile () | |
deliverXAccelRedirect () | |
deliverPHP () | |
clearHeaders () | |
close () | |
determineMimeType () | |
determineDownloadFileName () | |
detemineDeliveryType () | |
deliverPHPChunked () | |
sendEtagHeader () | |
sendLastModified () | |
isNonModified () | |
checkCache () | |
clearBuffer () | |
checkExisting () | |
sendFileUnbufferedUsingHeaders (\Closure $closure) | |
Protected Attributes | |
$delivery_type = self::DELIVERY_METHOD_PHP | |
$mime_type = '' | |
$path_to_file = '' | |
$download_file_name = '' | |
$disposition = self::DISP_ATTACHMENT | |
$send_mime_type = true | |
$exit_after = true | |
$convert_file_name_to_asci = true | |
$etag = '' | |
$show_last_modified = true | |
$has_context = true | |
$cache = false | |
$hash_filename = false | |
$delete_file = false | |
$urlencode_filename = false | |
Static Protected Attributes | |
static | $self_streaming_methods |
static | $delivery_type_static = null |
static | $DEBUG = false |
ilFileDelivery::__construct | ( | $path_to_file | ) |
$path_to_file |
Definition at line 153 of file class.ilFileDelivery.php.
References $path_to_file, detemineDeliveryType(), determineDownloadFileName(), determineMimeType(), ilContext\getType(), setHasContext(), and setPathToFile().
|
protected |
Definition at line 733 of file class.ilFileDelivery.php.
References generateEtag(), hasCache(), isNonModified(), sendEtagHeader(), setCachingHeaders(), and setShowLastModified().
Referenced by deliver().
|
protected |
Definition at line 756 of file class.ilFileDelivery.php.
References $download_file_name, close(), getDownloadFileName(), getPathToFile(), isConvertFileNameToAsci(), isUrlencodeFilename(), ilIniFile\readVariable(), setConvertFileNameToAsci(), setDownloadFileName(), setUrlencodeFilename(), and ilHTTP\status().
Referenced by setGeneralHeaders().
|
protected |
Definition at line 747 of file class.ilFileDelivery.php.
References ilWACLog\getInstance().
Referenced by deliver().
|
protected |
Definition at line 256 of file class.ilFileDelivery.php.
Referenced by deliverVirtual(), and deliverXAccelRedirect().
|
protected |
Definition at line 298 of file class.ilFileDelivery.php.
References exit.
Referenced by checkExisting(), deliver(), and deliverPHPChunked().
ilFileDelivery::deliver | ( | ) |
Definition at line 171 of file class.ilFileDelivery.php.
References checkCache(), clearBuffer(), close(), deliverPHP(), deliverPHPChunked(), deliverVirtual(), deliverXAccelRedirect(), deliverXSendfile(), getDeliveryType(), isExitAfter(), and setGeneralHeaders().
Referenced by stream().
|
static |
$path_to_file | ||
null | $download_file_name |
Definition at line 108 of file class.ilFileDelivery.php.
References $download_file_name, $mime_type, and $path_to_file.
Referenced by ilObjBibliographicGUI\sendFile().
|
static |
$path_to_file | ||
null | $download_file_name |
Definition at line 139 of file class.ilFileDelivery.php.
References $download_file_name, and $path_to_file.
|
protected |
Definition at line 248 of file class.ilFileDelivery.php.
References $file, and getPathToFile().
Referenced by deliver().
|
protected |
Definition at line 584 of file class.ilFileDelivery.php.
References $_SERVER, $file, $size, close(), getPathToFile(), and ilHTTP\status().
Referenced by deliver().
ilFileDelivery::deliverVirtual | ( | ) |
not supported
Definition at line 204 of file class.ilFileDelivery.php.
References $path_to_file, clearHeaders(), and getPathToFile().
Referenced by deliver().
|
protected |
Definition at line 228 of file class.ilFileDelivery.php.
References $path_to_file, clearHeaders(), getPathToFile(), isDeleteFile(), and sendFileUnbufferedUsingHeaders().
Referenced by deliver().
|
protected |
Definition at line 215 of file class.ilFileDelivery.php.
References getPathToFile(), isDeleteFile(), and sendFileUnbufferedUsingHeaders().
Referenced by deliver().
|
protected |
Definition at line 340 of file class.ilFileDelivery.php.
References getDeliveryType(), ilRuntime\getInstance(), ilWACLog\getInstance(), getPathToFile(), and setDeliveryType().
Referenced by __construct().
|
protected |
Definition at line 329 of file class.ilFileDelivery.php.
References $download_file_name, getDownloadFileName(), getPathToFile(), and setDownloadFileName().
Referenced by __construct().
|
protected |
Definition at line 306 of file class.ilFileDelivery.php.
References $info, ilMimeTypeUtil\APPLICATION__OCTET_STREAM, getPathToFile(), ilMimeTypeUtil\lookupMimeType(), and setMimeType().
Referenced by __construct().
ilFileDelivery::generateEtag | ( | ) |
Definition at line 293 of file class.ilFileDelivery.php.
References getPathToFile(), and setEtag().
Referenced by checkCache().
ilFileDelivery::getDeliveryType | ( | ) |
Definition at line 379 of file class.ilFileDelivery.php.
References $delivery_type.
Referenced by deliver(), detemineDeliveryType(), setGeneralHeaders(), and stream().
ilFileDelivery::getDisposition | ( | ) |
Definition at line 443 of file class.ilFileDelivery.php.
References $disposition.
Referenced by setGeneralHeaders().
ilFileDelivery::getDownloadFileName | ( | ) |
Definition at line 427 of file class.ilFileDelivery.php.
References $download_file_name.
Referenced by checkExisting(), determineDownloadFileName(), and setGeneralHeaders().
ilFileDelivery::getEtag | ( | ) |
Definition at line 507 of file class.ilFileDelivery.php.
References $etag.
Referenced by isNonModified(), and sendEtagHeader().
ilFileDelivery::getMimeType | ( | ) |
Definition at line 395 of file class.ilFileDelivery.php.
References $mime_type.
Referenced by setGeneralHeaders().
ilFileDelivery::getPathToFile | ( | ) |
Definition at line 411 of file class.ilFileDelivery.php.
References $path_to_file.
Referenced by checkExisting(), deliverPHP(), deliverPHPChunked(), deliverVirtual(), deliverXAccelRedirect(), deliverXSendfile(), detemineDeliveryType(), determineDownloadFileName(), determineMimeType(), generateEtag(), isNonModified(), sendLastModified(), and setGeneralHeaders().
ilFileDelivery::getShowLastModified | ( | ) |
Definition at line 523 of file class.ilFileDelivery.php.
References $show_last_modified.
Referenced by sendLastModified().
ilFileDelivery::hasCache | ( | ) |
Definition at line 555 of file class.ilFileDelivery.php.
References $cache.
Referenced by checkCache().
ilFileDelivery::hasHashFilename | ( | ) |
Definition at line 571 of file class.ilFileDelivery.php.
References $hash_filename.
Referenced by setGeneralHeaders().
ilFileDelivery::isConvertFileNameToAsci | ( | ) |
Definition at line 491 of file class.ilFileDelivery.php.
References $convert_file_name_to_asci.
Referenced by checkExisting(), and setGeneralHeaders().
|
static |
Definition at line 720 of file class.ilFileDelivery.php.
ilFileDelivery::isDeleteFile | ( | ) |
Definition at line 799 of file class.ilFileDelivery.php.
References $delete_file.
Referenced by deliverXAccelRedirect(), and deliverXSendfile().
ilFileDelivery::isExitAfter | ( | ) |
Definition at line 475 of file class.ilFileDelivery.php.
References $exit_after.
Referenced by deliver().
ilFileDelivery::isHasContext | ( | ) |
|
protected |
Definition at line 694 of file class.ilFileDelivery.php.
References $_SERVER, getEtag(), and getPathToFile().
Referenced by checkCache().
ilFileDelivery::isSendMimeType | ( | ) |
Definition at line 459 of file class.ilFileDelivery.php.
References $send_mime_type.
Referenced by setGeneralHeaders().
ilFileDelivery::isUrlencodeFilename | ( | ) |
Definition at line 815 of file class.ilFileDelivery.php.
References $urlencode_filename.
Referenced by checkExisting().
|
static |
$original_name |
Definition at line 790 of file class.ilFileDelivery.php.
References ilUtil\getASCIIFilename().
|
protected |
Definition at line 677 of file class.ilFileDelivery.php.
References getEtag().
Referenced by checkCache(), and setCachingHeaders().
|
protected |
\Closure | $closure | which sets the output-headers, e.g. header('X-Sendfile: ' . realpath($this->getPathToFile())); |
Definition at line 832 of file class.ilFileDelivery.php.
Referenced by deliverXAccelRedirect(), and deliverXSendfile().
|
protected |
Definition at line 684 of file class.ilFileDelivery.php.
References getPathToFile(), and getShowLastModified().
Referenced by setCachingHeaders().
ilFileDelivery::setCache | ( | $cache | ) |
boolean | $cache |
Definition at line 563 of file class.ilFileDelivery.php.
References $cache.
Referenced by ilWebAccessCheckerDelivery\deliver().
ilFileDelivery::setCachingHeaders | ( | ) |
Definition at line 285 of file class.ilFileDelivery.php.
References sendEtagHeader(), and sendLastModified().
Referenced by checkCache().
ilFileDelivery::setConvertFileNameToAsci | ( | $convert_file_name_to_asci | ) |
boolean | $convert_file_name_to_asci |
Definition at line 499 of file class.ilFileDelivery.php.
References $convert_file_name_to_asci.
Referenced by checkExisting().
|
static |
boolean | $DEBUG |
Definition at line 728 of file class.ilFileDelivery.php.
References $DEBUG.
ilFileDelivery::setDeleteFile | ( | $delete_file | ) |
boolean | $delete_file |
Definition at line 807 of file class.ilFileDelivery.php.
References $delete_file.
ilFileDelivery::setDeliveryType | ( | $delivery_type | ) |
string | $delivery_type |
Definition at line 387 of file class.ilFileDelivery.php.
References $delivery_type.
Referenced by detemineDeliveryType(), and stream().
ilFileDelivery::setDisposition | ( | $disposition | ) |
string | $disposition |
Definition at line 451 of file class.ilFileDelivery.php.
References $disposition.
Referenced by ilWebAccessCheckerDelivery\deliverDummyImage(), and ilWebAccessCheckerDelivery\deliverDummyVideo().
ilFileDelivery::setDownloadFileName | ( | $download_file_name | ) |
string | $download_file_name |
Definition at line 435 of file class.ilFileDelivery.php.
References $download_file_name.
Referenced by checkExisting(), and determineDownloadFileName().
ilFileDelivery::setEtag | ( | $etag | ) |
string | $etag |
Definition at line 515 of file class.ilFileDelivery.php.
References $etag.
Referenced by generateEtag().
ilFileDelivery::setExitAfter | ( | $exit_after | ) |
boolean | $exit_after |
Definition at line 483 of file class.ilFileDelivery.php.
References $exit_after.
ilFileDelivery::setGeneralHeaders | ( | ) |
Definition at line 261 of file class.ilFileDelivery.php.
References $download_file_name, checkExisting(), getDeliveryType(), getDisposition(), getDownloadFileName(), getMimeType(), getPathToFile(), hasHashFilename(), isConvertFileNameToAsci(), and isSendMimeType().
Referenced by deliver().
ilFileDelivery::setHasContext | ( | $has_context | ) |
boolean | $has_context |
Definition at line 547 of file class.ilFileDelivery.php.
References $has_context.
Referenced by __construct().
ilFileDelivery::setHashFilename | ( | $hash_filename | ) |
boolean | $hash_filename |
Definition at line 579 of file class.ilFileDelivery.php.
References $hash_filename.
ilFileDelivery::setMimeType | ( | $mime_type | ) |
string | $mime_type |
Definition at line 403 of file class.ilFileDelivery.php.
References $mime_type.
Referenced by determineMimeType().
ilFileDelivery::setPathToFile | ( | $path_to_file | ) |
string | $path_to_file |
Definition at line 419 of file class.ilFileDelivery.php.
References $path_to_file.
Referenced by __construct().
ilFileDelivery::setSendMimeType | ( | $send_mime_type | ) |
boolean | $send_mime_type |
Definition at line 467 of file class.ilFileDelivery.php.
References $send_mime_type.
ilFileDelivery::setShowLastModified | ( | $show_last_modified | ) |
boolean | $show_last_modified |
Definition at line 531 of file class.ilFileDelivery.php.
References $show_last_modified.
Referenced by checkCache().
ilFileDelivery::setUrlencodeFilename | ( | $urlencode_filename | ) |
bool | $urlencode_filename |
Definition at line 823 of file class.ilFileDelivery.php.
References $urlencode_filename.
Referenced by checkExisting().
ilFileDelivery::stream | ( | ) |
Definition at line 163 of file class.ilFileDelivery.php.
References deliver(), getDeliveryType(), and setDeliveryType().
|
static |
$path_to_file | ||
null | $download_file_name |
Definition at line 125 of file class.ilFileDelivery.php.
References $download_file_name, and $path_to_file.
|
protected |
Definition at line 85 of file class.ilFileDelivery.php.
Referenced by hasCache(), and setCache().
|
protected |
Definition at line 69 of file class.ilFileDelivery.php.
Referenced by isConvertFileNameToAsci(), and setConvertFileNameToAsci().
|
staticprotected |
Definition at line 101 of file class.ilFileDelivery.php.
Referenced by setDEBUG().
|
protected |
Definition at line 93 of file class.ilFileDelivery.php.
Referenced by isDeleteFile(), and setDeleteFile().
|
protected |
Definition at line 41 of file class.ilFileDelivery.php.
Referenced by getDeliveryType(), and setDeliveryType().
|
staticprotected |
Definition at line 37 of file class.ilFileDelivery.php.
|
protected |
Definition at line 57 of file class.ilFileDelivery.php.
Referenced by getDisposition(), and setDisposition().
|
protected |
Definition at line 53 of file class.ilFileDelivery.php.
Referenced by checkExisting(), deliverFileAttached(), deliverFileInline(), determineDownloadFileName(), getDownloadFileName(), setDownloadFileName(), setGeneralHeaders(), and streamVideoInline().
|
protected |
Definition at line 73 of file class.ilFileDelivery.php.
|
protected |
Definition at line 65 of file class.ilFileDelivery.php.
Referenced by isExitAfter(), and setExitAfter().
|
protected |
Definition at line 81 of file class.ilFileDelivery.php.
Referenced by isHasContext(), and setHasContext().
|
protected |
Definition at line 89 of file class.ilFileDelivery.php.
Referenced by hasHashFilename(), and setHashFilename().
|
protected |
Definition at line 45 of file class.ilFileDelivery.php.
Referenced by deliverFileAttached(), getMimeType(), and setMimeType().
|
protected |
Definition at line 49 of file class.ilFileDelivery.php.
Referenced by __construct(), deliverFileAttached(), deliverFileInline(), deliverVirtual(), deliverXAccelRedirect(), getPathToFile(), setPathToFile(), and streamVideoInline().
|
staticprotected |
Definition at line 30 of file class.ilFileDelivery.php.
|
protected |
Definition at line 61 of file class.ilFileDelivery.php.
Referenced by isSendMimeType(), and setSendMimeType().
|
protected |
Definition at line 77 of file class.ilFileDelivery.php.
Referenced by getShowLastModified(), and setShowLastModified().
|
protected |
Definition at line 97 of file class.ilFileDelivery.php.
Referenced by isUrlencodeFilename(), and setUrlencodeFilename().
const ilFileDelivery::DATA = 'data' |
Definition at line 26 of file class.ilFileDelivery.php.
const ilFileDelivery::DELIVERY_METHOD_NONE = 'cache' |
Definition at line 16 of file class.ilFileDelivery.php.
const ilFileDelivery::DELIVERY_METHOD_PHP = 'php' |
Definition at line 19 of file class.ilFileDelivery.php.
const ilFileDelivery::DELIVERY_METHOD_PHP_CHUNKED = 'php_chunked' |
Definition at line 20 of file class.ilFileDelivery.php.
const ilFileDelivery::DELIVERY_METHOD_VIRTUAL = 'virtual' |
Definition at line 21 of file class.ilFileDelivery.php.
const ilFileDelivery::DELIVERY_METHOD_XACCEL = 'x-accel-redirect' |
Definition at line 18 of file class.ilFileDelivery.php.
const ilFileDelivery::DELIVERY_METHOD_XSENDFILE = 'mod_xsendfile' |
Definition at line 17 of file class.ilFileDelivery.php.
const ilFileDelivery::DISP_ATTACHMENT = 'attachment' |
Definition at line 22 of file class.ilFileDelivery.php.
const ilFileDelivery::DISP_INLINE = 'inline' |
Definition at line 23 of file class.ilFileDelivery.php.
const ilFileDelivery::SECURED_DATA = 'secured-data' |
Definition at line 25 of file class.ilFileDelivery.php.
const ilFileDelivery::VIRTUAL_DATA = 'virtual-data' |
Definition at line 24 of file class.ilFileDelivery.php.