Inheritance diagram for File:

Public Member Functions
	clientConfig ()

	check ($value, $index=null)

	preview ($filename=null, &$count=null, &$rotate=null)
	Generate a preview. More...

	rotate ($angle=90, $filename=null)
	Rotate a file. More...

Public Member Functions inherited from Widget
	__construct ($config=null)

	update ($config)
	Update the widget configuration. More...

	clientConfig ()
	Public configuration. More...

	caption ($id=null)

	hint ($id=null)

	convert ($value)
	Convert a value from user format to standard, internal format. More...

	clientConvert ($value)
	Convert a value from client format to standard, internal format. More...

	dataConvert ($value)
	Convert an internal value before it is stored in the request data. More...

	format ($value)
	Format a value from standard, internal format to user format. More...

	clientFormat ($value)
	Format a value from standard, internal format to client format. More...

	formatTag ($value)
	Format a tag value. More...

	purge ($value)
	Purge a value. More...

	expect ($action)
	Note if an action is expected. More...

	execute ()
	Execute an action on this widget. More...

	nothing ($value)
	Check if a value is empty. More...

	check ($value, $index=null)
	Check a value. More...

Public Member Functions inherited from Thing
	propertyExists ($property)
	Check if a property exists (public or published). More...

	constants ($prefix=null)
	Return all constants. More...

	get ($key)
	Get one or more properties. More...

	set ($key, $value=null)
	Set one or more properties. More...

	__get ($key)

	__set ($key, $value)

Data Fields
const	TYPES = 'types'
	Allowed file types (mime or extension; mime can have asterisk wildcards or even be a complete. More...

const	FILENAME = 'filename'
	Fixed filename for the upload. If everything is OK, file will be overwitten directly, and. More...

const	MULTI = 'multi'
	Allow multiple files to be uploaded. More...

const	PREVIEW_SIZE = 'previewSize'
	Size (width) of preview image (false = no preview). More...

const	USER_FILES = 'userFiles'
	Show user files. More...

const	EVENT_UPLOAD = 'controller:widget:file:upload'

	$types = []

	$filename = null

	$multi = false

	$previewSize = false

	$previewMax = 3
	Maximum number of preview images. More...

	$sideloadControllerName = null
	Controller that provides the sideloading. More...

	$sideloadPath = null
	Path to temporary store sideload files. More...

	$sideloadExt = '.side'
	Extension for sideload files. More...

	$sideloadMode = 0666
	File mode for sideload files. More...

	$sideloadTokenLength = 16
	Length of the sideload token. More...

	$sideloadHint = null
	Hint to show during sideloading (translated). More...

	$sideloadInterval = 5
	Poll interval for sideloading check (seconds). More...

	$sideloadGarbageChance = 100
	Clear sideloading path once every ... times. More...

	$sideloadSkip = 5
	Stop scanning for new files after this number of misses. More...

Data Fields inherited from Widget
const	CHILD_ID_SEPARATOR = '__'

const	CAPTION = 'caption'

const	DEFAULT_VALUE = 'defaultValue'

const	DISPLAY = 'display'
	Display type (see DISPLAY_* constants). More...

const	HELP = 'help'
	Help string (translated). More...

const	HINT = 'hint'
	Hint string (translated). More...

const	PARAMS = 'params'
	Extra parameters (prefix the key with a '@' to point to the value of another widget). More...

const	RIGHT = 'right'
	Optional different right with respect to the controller. If the user has the right, then (s)he. More...

const	TRAILER = 'trailer'
	Trailer string (translated). More...

const	TAGS = 'tags'
	Extra tags for help, hint, and trailer. More...

const	WIDGET_HELP = 'widgetHelp'
	General widget help (translated). More...

const	CLASS_NAME = 'className'

const	MIN = 'min'
	Minimum value. More...

const	MAX = 'max'
	Maximum value. More...

const	REQUIRED = 'required'
	True for required. Set to self::VALID_FUNC to let the validation function handle this. Use. More...

const	VALID_FUNC = 'validFunc'
	Specific validation function (called with value and index; returns true if OK). More...

const	WIDGETS = 'widgets'
	Optional child widgets (key = name, value = widget object). More...

const	SECURITY_CHECKS_IGNORE = 'securityChecksIgnore'
	Security checks to ignore (array with checks to ignore, true =. More...

const	DISPLAY_HIDDEN = 'h'
	Do not show (only hidden) More...

const	DISPLAY_MINIMAL = 'm'
	Show only value (without input element(s)). More...

const	DISPLAY_READABLE = 'r'
	Show input element(s), but read-only. More...

const	DISPLAY_WRITEABLE = 'w'
	Show editable input element(s). More...

const	EVENT_ACTION_PREFIX = 'controller:widget:action:'

	$defaultValue = null

	$help = null

	$min = null

	$max = null

	$required = null

	$trailer = null

	$widgetHelp = null

	$validFunc = null

	$parent = null
	Optional parent widget. More...

Data Fields inherited from Thing
const	HIDDEN = 0
	Property is hidden. More...

const	READABLE = 1
	Property is readable. More...

const	WRITEABLE = 2
	Property is writeable. More...

const	READWRITE = 3
	Property is readable and writeable. More...

Protected Member Functions
	purgeBase ($value)
	Purge uploaded filename from possible array construction. More...

	uploadEvent ($name)

	checkMin ($value, $index=null)

	checkMax ($value, $index=null)

	checkUpload ($value, $index=null)

	checkTypes ($value, $index=null)

	processUpload ($data, $name)
	Process upload data. More...

	sideloadFilename ($token, $index=null)
	Filename for a sideload file. More...

	sideloadUrl ($token)
	Sideload URL. More...

	sideloadGarbage ()
	Clear old sideload tokens. More...

	actionRotate ()

	actionDownload ()

	actionUpload ()

	actionDelete ()

	actionUserFiles ()

	actionUserFilePreview ()

	actionUserFile ()

	actionSideload ()

	actionSideloadImage ()

	actionSideloadCheck ()

	getSideloadToken ()

Protected Member Functions inherited from Widget
	init ()

	config ($key, $default=null)
	Get single configuration value. More...

	purgeBase ($value)
	Purge function that will be called first. More...

	executeChild ($id)
	Execute an action on a child widget. More...

	checkMin ($value, $index=null)

	checkMax ($value, $index=null)

	checkRequired ($value, $index=null)
	Required check. More...

	checkValidFunc ($value, $index=null)

	actionHelp ()

	setController ($value)

	getDisplay ()

	getFred ()

	getId ()

	getParams ()

	getReadable ()

	getRight ()

	getTags ()

	getWidgets ()

	getWriteable ()

	_get ($key)

Protected Member Functions inherited from Thing
	publish ($property, $visibility=self::READABLE)
	Publish a property (or hide it again). More...

	configure ($config)
	Configure the object. More...

	_get ($key)
	Default getter if no specific setter is defined, and the property is also not published (readable). More...

	_set ($key, $value)
	Default setter if no specific setter is defined, and the property is also not published (writeable). More...

Protected Attributes
	$_raw = null

	$_multiRaw = null

Protected Attributes inherited from Widget
	$_controller = null

	$_id = null

	$_widgets = null
	Optional child widgets. More...

	$_securityChecksIgnore = []
	Security checks to ignore. More...

	$_config = []
	Widget configuration (see constants). More...

	$_display = null

	$_params = null

	$_right = null

	$_tags = null

Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

Detailed Description

Definition at line 7 of file File.php.

Member Function Documentation

◆ actionDelete()

actionDelete ( )

protected

Definition at line 279 of file File.php.

◆ actionDownload()

actionDownload ( )

protected

Definition at line 263 of file File.php.

◆ actionRotate()

actionRotate ( )

protected

Definition at line 252 of file File.php.

◆ actionSideload()

actionSideload ( )

protected

Definition at line 309 of file File.php.

◆ actionSideloadCheck()

actionSideloadCheck ( )

protected

Definition at line 344 of file File.php.

◆ actionSideloadImage()

actionSideloadImage ( )

protected

Definition at line 336 of file File.php.

◆ actionUpload()

actionUpload ( )

protected

Definition at line 271 of file File.php.

◆ actionUserFile()

actionUserFile ( )

protected

Definition at line 302 of file File.php.

◆ actionUserFilePreview()

actionUserFilePreview ( )

protected

Definition at line 291 of file File.php.

◆ actionUserFiles()

actionUserFiles ( )

protected

Definition at line 284 of file File.php.

◆ check()

check	(	$value,
		$index = `null`
	)

Definition at line 95 of file File.php.

◆ checkMax()

checkMax	(	$value,
		$index = `null`
	)

protected

Definition at line 78 of file File.php.

◆ checkMin()

checkMin	(	$value,
		$index = `null`
	)

protected

Definition at line 74 of file File.php.

◆ checkTypes()

checkTypes	(	$value,
		$index = `null`
	)

protected

Definition at line 86 of file File.php.

◆ checkUpload()

checkUpload	(	$value,
		$index = `null`
	)

protected

Definition at line 82 of file File.php.

◆ clientConfig()

clientConfig ( )

Definition at line 39 of file File.php.

◆ getSideloadToken()

getSideloadToken ( )

protected

Definition at line 362 of file File.php.

◆ preview()

preview	(		$filename = `null`,
		&	$count = `null`,
		&	$rotate = `null`
	)

Generate a preview.

Parameters

string	$filename	File to generate a preview for (empty = fixed upload filename).
int	$count	Will be set to the number of pages in the file.
bool	$rotate	Will be set to true if the image can be rotated.

Returns: array Preview PNG images.

Definition at line 112 of file File.php.

◆ processUpload()

processUpload	(	$data,
		$name
	)

protected

Process upload data.

Parameters

mixed	$data	Uploaded data (binary string).
string	$name	Original filename.

Definition at line 203 of file File.php.

◆ purgeBase()

purgeBase ( $value )

protected

Purge uploaded filename from possible array construction.

If all details are needed you can call fred->request->file(['widget','id']) (where $id can also be multiple levels deep).

Definition at line 62 of file File.php.

◆ rotate()

rotate	(	$angle = `90`,
		$filename = `null`
	)

Rotate a file.

Parameters

int	$angle	Rotation angle (positive: degrees clockwise; -1: flip horizontal, -2: flip vertical).
string	$filename	File to rotate (empty = fixed upload filename).

Returns: bool True if the operation was successful (file will be replaced).

Definition at line 165 of file File.php.

◆ sideloadFilename()

sideloadFilename	(	$token,
		$index = `null`
	)

protected

Filename for a sideload file.

Parameters

string	$token	Sideload token.
int	$index	Upload index.

Returns: string

Definition at line 223 of file File.php.

◆ sideloadGarbage()

sideloadGarbage ( )

protected

Clear old sideload tokens.

Definition at line 237 of file File.php.

◆ sideloadUrl()

sideloadUrl ( $token )

protected

Sideload URL.

Parameters

string $token Sideload token.

Returns: string Full URL.

Definition at line 231 of file File.php.

◆ uploadEvent()

uploadEvent ( $name )

protected

Definition at line 70 of file File.php.

Field Documentation

◆ $_multiRaw

$_multiRaw = null

protected

Definition at line 37 of file File.php.

◆ $_raw

$_raw = null

protected

Definition at line 36 of file File.php.

◆ $filename

$filename = null

Definition at line 20 of file File.php.

◆ $multi

$multi = false

Definition at line 21 of file File.php.

◆ $previewMax

$previewMax = 3

Maximum number of preview images.

Definition at line 24 of file File.php.

◆ $previewSize

$previewSize = false

Definition at line 22 of file File.php.

◆ $sideloadControllerName

$sideloadControllerName = null

Controller that provides the sideloading.

Definition at line 26 of file File.php.

◆ $sideloadExt

$sideloadExt = '.side'

Extension for sideload files.

Definition at line 28 of file File.php.

◆ $sideloadGarbageChance

$sideloadGarbageChance = 100

Clear sideloading path once every ... times.

Definition at line 33 of file File.php.

◆ $sideloadHint

$sideloadHint = null

Hint to show during sideloading (translated).

Definition at line 31 of file File.php.

◆ $sideloadInterval

$sideloadInterval = 5

Poll interval for sideloading check (seconds).

Definition at line 32 of file File.php.

◆ $sideloadMode

$sideloadMode = 0666

File mode for sideload files.

Definition at line 29 of file File.php.

◆ $sideloadPath

$sideloadPath = null

Path to temporary store sideload files.

Definition at line 27 of file File.php.

◆ $sideloadSkip

$sideloadSkip = 5

Stop scanning for new files after this number of misses.

Definition at line 34 of file File.php.

◆ $sideloadTokenLength

$sideloadTokenLength = 16

Length of the sideload token.

Definition at line 30 of file File.php.

◆ $types

$types = []

Definition at line 19 of file File.php.

◆ EVENT_UPLOAD

const EVENT_UPLOAD = 'controller:widget:file:upload'

Definition at line 17 of file File.php.

◆ FILENAME

const FILENAME = 'filename'

Fixed filename for the upload. If everything is OK, file will be overwitten directly, and.

Definition at line 11 of file File.php.

◆ MULTI

const MULTI = 'multi'

Allow multiple files to be uploaded.

Definition at line 13 of file File.php.

◆ PREVIEW_SIZE

const PREVIEW_SIZE = 'previewSize'

Size (width) of preview image (false = no preview).

Definition at line 14 of file File.php.

◆ TYPES

const TYPES = 'types'

Allowed file types (mime or extension; mime can have asterisk wildcards or even be a complete.

Definition at line 9 of file File.php.

◆ USER_FILES

const USER_FILES = 'userFiles'

Show user files.

Definition at line 15 of file File.php.

The documentation for this class was generated from the following file:

/var/www/fred.local/vendor/rsi/fred/src/Rsi/Fred/Controller/Widget/File.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ actionDelete()

◆ actionDownload()

◆ actionRotate()

◆ actionSideload()

◆ actionSideloadCheck()

◆ actionSideloadImage()

◆ actionUpload()

◆ actionUserFile()

◆ actionUserFilePreview()

◆ actionUserFiles()

◆ check()

◆ checkMax()

◆ checkMin()

◆ checkTypes()

◆ checkUpload()

◆ clientConfig()

◆ getSideloadToken()

◆ preview()

◆ processUpload()

◆ purgeBase()

◆ rotate()

◆ sideloadFilename()

◆ sideloadGarbage()

◆ sideloadUrl()

◆ uploadEvent()

Field Documentation

◆ $_multiRaw

◆ $_raw

◆ $filename

◆ $multi

◆ $previewMax

◆ $previewSize

◆ $sideloadControllerName

◆ $sideloadExt

◆ $sideloadGarbageChance

◆ $sideloadHint

◆ $sideloadInterval

◆ $sideloadMode

◆ $sideloadPath

◆ $sideloadSkip

◆ $sideloadTokenLength

◆ $types

◆ EVENT_UPLOAD

◆ FILENAME

◆ MULTI

◆ PREVIEW_SIZE

◆ TYPES

◆ USER_FILES