User Tools

Site Tools


Sidebar

Dokumentation

vortex:apidoc:filefield

FileField

FileField

Filename : /classes/table/fields/filefield.php
Extends : Field

Description

Field for storing a file

Fields

Methods

deleteFile()

Definition : public function deleteFile()

Returns :

Description
Delete the physical file referred to by this field

Parameters

getDOM( &$xmlDocument, $isRelation )

Definition : public function getDOM( &$xmlDocument, $isRelation = false )

Returns :

Description
Get a DOMElement representation of this field

Parameters

$isRelation

Type : boolean
Default value : false

Description
Whether this is a relation or not

&$xmlDocument

Type :
Default value :

Description
The document to make the element part of

getFile()

Definition : public function getFile()

Returns : <String> path and name of the file

Description
Get the path and name of the file referred to by this field

Parameters

getURL()

Definition : public function getURL()

Returns : String URL of where to find the file

Description
Get the URL part of the field value

Parameters

getValue( $save )

Definition : public function getValue( $save = false )

Returns : String or false on error

Description
Get the value of this field. If this method is called during the save process it will verify the data paths and URLs, unlink the old file if changed, move the uploaded file to the right place and assign the filename and url to the field value

Parameters

$save

Type : boolean
Default value : false

Description
Whether this method is called during the save process

load()

Definition : public function load()

Returns :

Description
Call parent::load()

Parameters

setDOM( $xml )

Definition : public function setDOM( $xml )

Returns :

Description
Set this field from a DOMElement

Parameters

$xml

Type :
Default value :

Description
DOMElement to parse for information regarding this field

setFile( $file )

Definition : public function setFile( $file )

Returns :

Description
Set a new file to this field

Parameters

$file

Type : Array
Default value :

Description
Array describing an uploaded file

splitUp()

Definition : public function splitUp()

Returns : [0] = filepath + name, [1] = url

Description
Split the field value into an array containing the different parts

Parameters

vortex/apidoc/filefield.txt · Last modified: 2019/06/28 07:07 by hubbe