\cge_uploader

__construct()

__construct(\string  $prefix, \string  $destdir, \CGExtensions\watermarker  $obj = null) 

Constructor

Parameters

set_preprocessor()

set_preprocessor(callable  $func) 

Set a preprocessor object

Parameters

get_accepted_filetypes()

get_accepted_filetypes() 

Return the list of accepted file extensions

set_accepted_filetypes()

set_accepted_filetypes(mixed  $filetypes) 

Set the list of accepted file extensions

Parameters

is_accepted_file()

is_accepted_file(string  $filename) : boolean

Test if the specified filename is among the accepted filetypes

Parameters

Returns

set_max_filesize()

set_max_filesize(integer  $size) 

Set the maximum file size for uploaded files (in kilobytes).

This method has no effect on the php.ini settings.

Parameters

set_allow_overwrite()

set_allow_overwrite(boolean  $flag = true) 

Set a flag that indicates wether overwriting existing files is permitted.

Parameters

get_error()

get_error() : string

Get any error code returned after handling the upload.

See the error codes contained in this string.

Returns

get_errormsg()

get_errormsg() : string

Return a human readable message pertaining to any error code returned after handling the upload.

Returns

reset_errors()

reset_errors() 

Reset any errors

get_dest_dir()

get_dest_dir() : string

Return the destination directory for uploaded files

Returns

set_dest_dir()

set_dest_dir(string  $dir) 

Set the destination directory for uploaded files

Parameters

get_dest_filename()

get_dest_filename() : string

Get the optional destination filename. If any has been specified.

Returns

get_orig_filename()

get_orig_filename() 

Get the original filename.

This method is only useful after handle_upload has been called.

check_upload_attempted()

check_upload_attempted(string  $name, string  $subfield = null) : boolean

Check if a file has been uploaded with the specified field name.

If specified in the constructor a prefix will be prepended to this name for comparison. This method will not set any of the error members in the object.

Parameters

Returns

get_uploaded_filename()

get_uploaded_filename(string  $field_name, string  $subfield = null) 

Get the name of an uploaded file before processing

Parameters

check_upload()

check_upload(string  $name, string  $subfield = null, boolean  $checkdir = TRUE) : boolean

Check if a file has been uploaded to the specified name, and if it is valid.

If specified in the constructor a prefix will be prepended to this name for comparison. This method will set internal error strings and numbers on failure.

Parameters

Returns

True on success, false on error.

handle_upload()

handle_upload(string  $name, string  $destfilename = '', string  $subfield = null) : string

Handle the upload of a file.

This method will generate thumbnails from images that are in the accepted filetypes.

Parameters

Returns

The basename of the uploaded file.

set_preview()

set_preview(boolean  $flag = true) 

Set a flag indicating that a preview (slightly larger than a thumbnail) image should be generated from an uploaded image.

Parameters

set_preview_size()

set_preview_size(integer  $size) 

Set the size (in pixels) of the preview image.

This is only applicable if preview is enabled.

Parameters

set_watermark()

set_watermark(boolean  $flag = true) 

Set a flag indicating that an uploaded image should be watermarked.

Parameters

set_thumbnail()

set_thumbnail(boolean  $flag = true) 

Set a flag indicating that a thumbnail should be generated from an uploaded image.

Parameters

set_thumbnail_size()

set_thumbnail_size(integer  $size) 

Set the size (in pixels) of the generated thumbnails.

Parameters

set_delete_orig()

set_delete_orig(boolean  $flag = true) 

Set a flag to indicate that the original file should be deleted after processing.

Parameters

is_accepted_imagefile()

is_accepted_imagefile(string  $filename) : boolean

Test wether the filename specified is a file acceptable for processing.

Parameters

Returns

get_accepted_imagetypes()

get_accepted_imagetypes() : array<mixed,string>

Return a list of the file extensions that will be accepted for processing on upload.

Returns

set_accepted_imagetypes()

set_accepted_imagetypes(string|array<mixed,string>  $imagetypes) 

Set the list of file extensions that will be accepted for processing on upload.

Parameters

set_errno()

set_errno(string  $val) 

Set the current error code See error codes defined above.

Parameters

set_error()

set_error(string  $val) 

Set a human readable error message.

Parameters

get_new_filename()

get_new_filename(string  $input_name) : string

Get an adjusted upload filename, using the destname if provided.

Note: extension will be preserved in output filename.

Parameters

Returns

get_file_record()

get_file_record(string  $field_name, string  $subfield = null) : array|null

Given a field name, and a subfield.

. get the aggregated record from $_FILES so that the upload can be processed.

In the event of a problem this method sets the errno variable for error handling.

Parameters

Returns

preprocess_upload()

preprocess_upload(array  $fileinfo) : string

Preprocess the uploaded image file. If the file is in the accepted image types.

by default this method will generate a preview image (if enabled), and then optionally watermark it.

Parameters

Returns

The path and filename of the destination file.