Editor PHP 2.3.2

Upload extends Ext

in package

• Application

Upload class for Editor. This class provides the ability to easily specify file upload information, specifically how the file should be recorded on the server (database and file system).

Tags

example

Store information about a file in a table called files and the actual file in an uploads directory.

	new Field( 'imageId' )
		->upload(
			new Upload( $_SERVER['DOCUMENT_ROOT'].'/uploads/__ID__.__EXTN__' )
		 		->db( 'files', 'id', [
					'webPath'     => Upload::DB_WEB_PATH,
					'fileName'    => Upload::DB_FILE_NAME,
					'fileSize'    => Upload::DB_FILE_SIZE,
					'systemPath'  => Upload::DB_SYSTEM_PATH
				] )
				->allowedExtensions( [ 'png', 'jpg' ], "Please upload an image file" )
		)

Table of Contents

Constants

DB_CONTENT  = 'editor-content'

Database value option (`Db()`) - File content. This should be written to a blob. Typically this should be avoided and the file saved on the file system, but there are cases where it can be useful to store the file in the database.

DB_CONTENT_TYPE  = 'editor-contentType'

Database value option (`Db()`) - Content type

DB_EXTN  = 'editor-extn'

Database value option (`Db()`) - File extension

DB_FILE_NAME  = 'editor-fileName'

Database value option (`Db()`) - File name (with extension)

DB_FILE_SIZE  = 'editor-fileSize'

Database value option (`Db()`) - File size (bytes)

DB_MIME_TYPE  = 'editor-mimeType'

Database value option (`Db()`) - MIME type

DB_READ_ONLY  = 'editor-readOnly'

Read from the database - don't write to it.

DB_SYSTEM_PATH  = 'editor-systemPath'

Database value option (`Db()`) - Full system path to the file

DB_WEB_PATH  = 'editor-webPath'

Database value option (`Db()`) - HTTP path to the file. This is derived from the system path by removing `$_SERVER['DOCUMENT_ROOT']`. If your images live outside of the document root a custom value would be to be used.

Methods

__construct()  : mixed

Upload instance constructor.

action()  : $this

Set the action to take when a file is uploaded. This can be either of:.

allowedExtensions()  : $this

An array of valid file extensions that can be uploaded. This is for simple validation that the file is of the expected type - for example you might use `[ 'png', 'jpg', 'jpeg', 'gif' ]` for images. The check is case-insensitive. If no extensions are given, no validation is performed on the file extension.

db()  : $this

Database configuration method. When used, this method will tell Editor what information you want written to a database on file upload, should you wish to store relational information about your file on the database (this is generally recommended).

dbClean()  : $this

Set a callback function that is used to remove files which no longer have a reference in a source table.

inst()  : static

Static method to instantiate a new instance of a class (shorthand of 'instantiate').

instantiate()  : static

Static method to instantiate a new instance of a class.

mode()  : $this

Set the permissions on the file after it has been uploaded using chmod.

validator()  : $this

Add a validation method to check file uploads. Multiple validators can be added by calling this method multiple times - they will be executed in sequence when a file has been uploaded.

where()  : $this

Add a condition to the data to be retrieved from the database. This must be given as a function to be executed (usually anonymous) and will be passed in a single argument, the `Query` object, to which conditions can be added. Multiple calls to this method can be made.

_getSet()  : mixed

Common getter / setter function for DataTables classes.

_propExists()  : bool

Determine if a property is available in a data set (allowing `null` to be a valid value).

_readProp()  : mixed

Read a value from a data structure, using Javascript dotted object notation. This is the inverse of the `_writeProp` method and provides the same support, matching DataTables' ability to read nested JSON data objects.

_writeProp()  : mixed

Write the field's value to an array structure, using Javascript dotted object notation to indicate JSON data structure. For example `name.first` gives the data structure: `name: { first: ... }`. This matches DataTables own ability to do this on the client-side, although this doesn't implement implement quite such a complex structure (no array / function support).