Overview

Namespaces

  • LucidFrame
    • Console
    • Core
    • File
  • None

Classes

  • AsynFileUploader
  • File
  • Overview
  • Namespace
  • Class

Class AsynFileUploader

Helper for ajax-like file upload with instant preview if the preview placeholder is provided

Namespace: LucidFrame\File
Located at classes/AsynFileUploader.php
Methods summary
public
# __construct( )

Constructor

Constructor

public
# setName( string $name )

Setter for the property name

Setter for the property name

Parameters

$name
The unique name for the file input element
public
# setId( string $id )

Setter for the property id

Setter for the property id

Parameters

$id
The unique HTML id for the file browsing button
public
# setLabel( string $label )

Setter for the property label

Setter for the property label

Parameters

$label
The caption name for the file input to use in validation error
public
# setCaption( string $caption )

Setter for the property caption

Setter for the property caption

Parameters

$caption
The caption for image uploaded
public
# setValue( array $value, integer $id = 0 )

Setter for the property value

Setter for the property value

Parameters

$value
The file name saved in the database
$id
The ID related to the file name saved in the database
public
# getValue( )

Getter for the property value

Getter for the property value

public
# getValueId( )

Getter for the id saved in db related to the value

Getter for the id saved in db related to the value

public
# setHidden( string $key, mixed $value = '' )

Setter for the property hidden

Setter for the property hidden

Parameters

$key
The key - id, dimensions, fileName or uniqueId
$value
The value for the key
public
# setUploadDir( string $dir )

Setter for the property uploadDir

Setter for the property uploadDir

Parameters

$dir
The directory where the file will be uploaded. Default to /files/tmp/
public
# setMaxSize( integer $size )

Setter for the property maxSize

Setter for the property maxSize

Parameters

$size
The maximum file size allowed in MB
public
# setExtensions( array $extensions )

Setter for the property extensions

Setter for the property extensions

Parameters

$extensions
The array of extensions such as array('jpg', 'png', 'gif')
public
# setDimensions( array $dimensions )

Setter for the property dimensions

Setter for the property dimensions

Parameters

$dimensions
The array of extensions such as array('600x400', '300x200')
public
# setButtons( )

Setter for the property buttons

Setter for the property buttons

public
# isDeletable( boolean $value )

Setter for the property isDeletable

Setter for the property isDeletable

Parameters

$value
If the delete button is provided or not
public
# isFileNameDisplayed( boolean $value )

Setter for the property fileNameIsDisplayed

Setter for the property fileNameIsDisplayed

Parameters

$value
If the uploaded file name is displayed next to the button or not
public
# setUploadAsOriginalFileName( boolean $value )

Setter for the property uploadAsOriginalFileName

Setter for the property uploadAsOriginalFileName

Parameters

$value
Use original file name on upload or not
public
# setOnUpload( string $callable )

Setter for the onUpload hook

Setter for the onUpload hook

Parameters

$callable
The callback PHP function name
public
# setOnDelete( string $callable )

Setter for the onDelete hook

Setter for the onDelete hook

Parameters

$callable
The callback PHP function name
public
# setUploadHandler( string $url )

Setter for the property uploadHandler

Setter for the property uploadHandler

Parameters

$url
The URL where file upload will be handled
public
# html( array $attributes = array() )

Display file input HTML

Display file input HTML

Parameters

$attributes

The HTML attribute option for the button

array(
  'class' => '',
  'id' => '',
  'title' => ''
)
public static mixed
# getDirFromRequest( string $name )

Get the upload directory name from REQUEST

Get the upload directory name from REQUEST

Parameters

$name
The file element name

Returns

mixed
PHPLucidFrame 3.2 API documentation generated by ApiGen