Skip to content

icms_file_MediaUploadHandler

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_file_MediaUploadHandler

Upload Media files Example of usage: <code> $allowed_mimetypes = array('image/gif', 'image/jpeg', 'image/pjpeg', 'image/x-png'); $maxfilesize = 50000; $maxfilewidth = 120; $maxfileheight = 120; $uploader = new icms_file_MediaUploadHandler('/home/httpdocs/uploads', $allowed_mimetypes, $maxfilesize, $maxfilewidth, $maxfileheight); if($uploader->fetchMedia($_POST['uploade_file_name'])) { if(!$uploader->upload()) { echo $uploader->getErrors(); } else { echo '<h4>File uploaded successfully!</h4>' echo 'Saved as: ' . $uploader->getSavedFileName() . '<br />'; echo 'Full path: ' . $uploader->getSavedDestination(); } } else { echo $uploader->getErrors(); } </code>

  • Class name: icms_file_MediaUploadHandler
  • Namespace:

Properties

$allowUnknownTypes

private bool $allowUnknownTypes = \false
  • Visibility: private

$mediaName

private string $mediaName
  • Visibility: private

$mediaType

private string $mediaType
  • Visibility: private

$mediaSize

private string $mediaSize
  • Visibility: private

$mediaTmpName

private string $mediaTmpName
  • Visibility: private

$mediaError

private string $mediaError
  • Visibility: private

$mediaRealType

private string $mediaRealType
  • Visibility: private

$uploadDir

private string $uploadDir
  • Visibility: private

$allowedMimeTypes

private array $allowedMimeTypes = array()
  • Visibility: private

$deniedMimeTypes

private string $deniedMimeTypes = array(application/x-httpd-php)
  • Visibility: private

$maxFileSize

private int $maxFileSize
  • Visibility: private

$maxWidth

private string $maxWidth
  • Visibility: private

$maxHeight

private string $maxHeight
  • Visibility: private

$targetFileName

private string $targetFileName
  • Visibility: private

$prefix

private string $prefix
  • Visibility: private

$errors

private array $errors = array()
  • Visibility: private

$savedDestination

private string $savedDestination
  • Visibility: private

$savedFileName

private string $savedFileName
  • Visibility: private

$extensionToMime

private array $extensionToMime = array()
  • Visibility: private

$checkImageType

private bool $checkImageType = \true
  • Visibility: private

$extensionsToBeSanitized

private array $extensionsToBeSanitized = array(php, phtml, phtm, php3, php4, cgi, pl, asp, php5)
  • Visibility: private

$imageExtensions

private array $imageExtensions = array(1 => gif, 2 => jpg, 3 => png, 4 => swf, 5 => psd, 6 => bmp, 7 => tif, 8 => tif, 9 => jpc, 10 => jp2, 11 => jpx, 12 => jb2, 13 => swc, 14 => iff, 15 => wbmp, 16 => xbm)
  • Visibility: private

Methods

__construct

mixed icms_file_MediaUploadHandler::__construct(string uploadDir, array allowedMimeTypes, int maxFileSize, int maxWidth, int maxHeight)

Constructor

  • Visibility: public

Arguments

  • uploadDir string
  • allowedMimeTypes array
  • maxFileSize int
  • maxWidth int
  • maxHeight int

fetchFromURL

mixed icms_file_MediaUploadHandler::fetchFromURL(string url)

Do same as fetchMedia but from URL

  • Visibility: public

Arguments

  • url string

fetchMedia

bool icms_file_MediaUploadHandler::fetchMedia(string media_name, int index)

Fetch the uploaded file

  • Visibility: public

Arguments

  • media_name string - <p>Name of the file field</p>
  • index int - <p>Index of the file (if more than one uploaded under that name)</p>

getUploadErrorText

string icms_file_MediaUploadHandler::getUploadErrorText(int err)

Get Text messages for POST upload errors

  • Visibility: private

Arguments

  • err int - <p>error number</p>

setTargetFileName

mixed icms_file_MediaUploadHandler::setTargetFileName(string value)

Set the target filename

  • Visibility: public

Arguments

  • value string

setPrefix

mixed icms_file_MediaUploadHandler::setPrefix(string value, bool unique)

Set the prefix

  • Visibility: public

Arguments

  • value string
  • unique bool

getMediaName

string icms_file_MediaUploadHandler::getMediaName()

Get the uploaded filename

  • Visibility: public

getMediaType

string icms_file_MediaUploadHandler::getMediaType()

Get the type of the uploaded file

  • Visibility: public

getMediaSize

int icms_file_MediaUploadHandler::getMediaSize()

Get the size of the uploaded file

  • Visibility: public

getMediaTmpName

string icms_file_MediaUploadHandler::getMediaTmpName()

Get the temporary name that the uploaded file was stored under

  • Visibility: public

getSavedFileName

string icms_file_MediaUploadHandler::getSavedFileName()

Get the saved filename

  • Visibility: public

getSavedDestination

string icms_file_MediaUploadHandler::getSavedDestination()

Get the destination the file is saved to

  • Visibility: public

upload

bool icms_file_MediaUploadHandler::upload(mixed chmod)

Check the file and copy it to the destination

  • Visibility: public

Arguments

  • chmod mixed

_copyFile

bool icms_file_MediaUploadHandler::_copyFile(mixed chmod)

Copy the file to its destination

  • Visibility: private

Arguments

  • chmod mixed

checkMaxFileSize

bool icms_file_MediaUploadHandler::checkMaxFileSize()

Is the file the right size?

  • Visibility: public

checkMaxWidth

bool icms_file_MediaUploadHandler::checkMaxWidth()

Is the picture the right width?

  • Visibility: public

checkMaxHeight

bool icms_file_MediaUploadHandler::checkMaxHeight()

Is the picture the right height?

  • Visibility: public

checkMimeType

bool icms_file_MediaUploadHandler::checkMimeType()

Check whether or not the uploaded file type is allowed

  • Visibility: public

checkImageType

bool icms_file_MediaUploadHandler::checkImageType()

Check whether or not the uploaded image type is valid

  • Visibility: public

sanitizeMultipleExtensions

mixed icms_file_MediaUploadHandler::sanitizeMultipleExtensions()

Sanitize executable filename with multiple extensions

  • Visibility: public

setErrors

mixed icms_file_MediaUploadHandler::setErrors(string error)

Add an error

  • Visibility: public

Arguments

  • error string

getErrors

array|string icms_file_MediaUploadHandler::getErrors(bool ashtml)

Get generated errors

  • Visibility: public

Arguments

  • ashtml bool - <p>Format using HTML?</p>
Clone this wiki locally