Upload helper class for working with uploaded files and Validation.
$array= Validation::factory($_FILES);
Remember to define your form with "enctype=multipart/form-data" or file uploading will not work!
The following configuration properties can be set:
Class declared in SYSPATH/classes/upload.php on line 3.
string $default_directorylink to thisdefault upload directory
string(6) "upload"boolean $remove_spaceslink to thisremove spaces in uploaded files
bool TRUE
Validation rule to test if an upload is an image and, optionally, is the correct size.
// The "image" file must be an image$array->rule('image','Upload::image')// The "photo" file has a maximum size of 640x480 pixels$array->rule('photo','Upload::image',array(640, 480));// The "image" file must be exactly 100x100 pixels$array->rule('image','Upload::image',array(100, 100, TRUE));
array
$file
required - $_FILES iteminteger
$max_width
= NULL - Maximum width of imageinteger
$max_height
= NULL - Maximum height of imageboolean
$exact
= bool FALSE - Match width and height exactly?boolean
publicstaticfunctionimage(array$file,$max_width= NULL,$max_height= NULL,$exact= FALSE){if(Upload::not_empty($file)){try{// Get the width and height from the uploaded imagelist($width,$height) =getimagesize($file['tmp_name']);}catch(ErrorException$e){// Ignore read errors}if(empty($width) ORempty($height)){// Cannot get image size, cannot validatereturnFALSE;}if( !$max_width){// No limit, use the image width$max_width=$width;}if( !$max_height){// No limit, use the image height$max_height=$height;}if($exact){// Check if dimensions match exactlyreturn($width===$max_widthAND$height===$max_height);}else{// Check if size is within maximum dimensionsreturn($width<=$max_widthAND$height<=$max_height);}}returnFALSE;}
Tests if a successful upload has been made.
$array->rule('file','Upload::not_empty');
array
$file
required - $_FILES itembool
publicstaticfunctionnot_empty(array$file){return(isset($file['error'])AND isset($file['tmp_name'])AND$file['error'] === UPLOAD_ERR_OKANDis_uploaded_file($file['tmp_name']));}
Save an uploaded file to a new location. If no filename is provided, the original filename will be used, with a unique prefix added.
This method should be used after validating the $_FILES array:
if($array->check()){// Upload is valid, save itUpload::save($array['file']);}
array
$file
required - Uploaded file datastring
$filename
= NULL - New filenamestring
$directory
= NULL - New directoryinteger
$chmod
= integer 420 - Chmod maskstring - On success, full path to new fileFALSE - On failure
publicstaticfunctionsave(array$file,$filename= NULL,$directory= NULL,$chmod= 0644){if( ! isset($file['tmp_name']) OR !is_uploaded_file($file['tmp_name'])){// Ignore corrupted uploadsreturnFALSE;}if($filename=== NULL){// Use the default filename, with a timestamp pre-pended$filename= uniqid().$file['name'];}if(Upload::$remove_spaces=== TRUE){// Remove spaces from the filename$filename= preg_replace('/\s+/u','_',$filename);}if($directory=== NULL){// Use the pre-configured upload directory$directory= Upload::$default_directory;}if( !is_dir($directory) OR !is_writable(realpath($directory))){thrownewKohana_Exception('Directory :dir must be writable',array(':dir'=> Debug::path($directory)));}// Make the filename into a complete path$filename=realpath($directory).DIRECTORY_SEPARATOR.$filename;if(move_uploaded_file($file['tmp_name'],$filename)){if($chmod!== FALSE){// Set permissions on filenamechmod($filename,$chmod);}// Return new file pathreturn$filename;}returnFALSE;}
Validation rule to test if an uploaded file is allowed by file size. File sizes are defined as: SB, where S is the size (1, 8.5, 300, etc.) and B is the byte unit (K, MiB, GB, etc.). All valid byte units are defined in Num::$byte_units
$array->rule('file','Upload::size',array(':value','1M'))$array->rule('file','Upload::size',array(':value','2.5KiB'))
array
$file
required - $_FILES itemstring
$size
required - Maximum file size allowedbool
publicstaticfunctionsize(array$file,$size){if($file['error'] === UPLOAD_ERR_INI_SIZE){// Upload is larger than PHP allowed size (upload_max_filesize)returnFALSE;}if($file['error'] !== UPLOAD_ERR_OK){// The upload failed, no size to checkreturnTRUE;}// Convert the provided size to bytes for comparison$size= Num::bytes($size);// Test that the file is under or equal to the max sizereturn($file['size'] <=$size);}
Test if an uploaded file is an allowed file type, by extension.
$array->rule('file','Upload::type',array(':value',array('jpg','png','gif')));
array
$file
required - $_FILES itemarray
$allowed
required - Allowed file extensionsbool
publicstaticfunctiontype(array$file,array$allowed){if($file['error'] !== UPLOAD_ERR_OK)returnTRUE;$ext=strtolower(pathinfo($file['name'], PATHINFO_EXTENSION));returnin_array($ext,$allowed);}
Tests if upload data is valid, even if no file was uploaded. If you do require a file to be uploaded, add the Upload::not_empty rule before this rule.
$array->rule('file','Upload::valid')
array
$file
required - $_FILES itembool
publicstaticfunctionvalid($file){return(isset($file['error'])AND isset($file['name'])AND isset($file['type'])AND isset($file['tmp_name'])AND isset($file['size']));}