FileRef Class Reference

Inheritance diagram for FileRef:

Collaboration diagram for FileRef:

Public Member Functions
	cbRemoveFileIfOrphaned ()
	cbMakeUniqueFilename ()
	setDownloadURL ($field, $url)
	getDownloadURL ($dltype='normal')
	getAuthorName ()
	incrementDownloadCounter ()
	getLicenseObject ()
	isLink ()
	setFolderType ($field, FolderType $folder_type)
	getFolderType ()
	isImage ()
	isAudio ()
	isVideo ()
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toRawArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	getDefaultValue ($field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	isI18nField ($field)
	setData ($data, $reset=false)
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)
	cleanup ()

Static Public Member Functions
static	exportUserData (StoredUserData $storage)
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=[])
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=[])
static	findOneBySQL ($where, $params=[])
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=[])
static	findMany ($pks=[], $order='', $order_params=[])
static	findEachMany ($callable, $pks=[], $order='', $order_params=[])
static	findAndMapBySQL ($callable, $where, $params=[])
static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
static	deleteBySQL ($where, $params=[])
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Data Fields
	$path_to_blob
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=[])
static	config ($key)

Protected Attributes
	$folder_type
	$download_url
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = []
	$serialized_fields = []
	$alias_fields = []
	$i18n_fields = []
	$additional_fields = []
	$relations = []
	$has_many = []
	$has_one = []
	$belongs_to = []
	$has_and_belongs_to_many = []
	$registered_callbacks = []
	$known_slots = []
	$notification_map = []
	$additional_data = []
	$getter_setter_map = []

Additional Inherited Members
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Member Functions inherited from SimpleORMap
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
	cbI18N ($type)
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Member Function Documentation

cbMakeUniqueFilename()

cbMakeUniqueFilename

(

)

This callback is called before storing a FileRef object. In case the name field is changed this callback assures that the name of the FileRef is unique inside the folder where the FileRef is placed.

Here is the call graph for this function:

cbRemoveFileIfOrphaned()

cbRemoveFileIfOrphaned

(

)

This callback is called after deleting a FileRef. It removes the File object that is associated with the FileRef, if the File is not referenced by any other FileRef object.

Here is the call graph for this function:

configure()

static configure (   $config = [] )

staticprotected

set configuration data from subclass

Parameters

array

$config

configuration data

Returns

void

Reimplemented from SimpleORMap.

exportUserData()

static exportUserData ( StoredUserData  $storage )

static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters

StoredUserData

$storage

object to store data into

Here is the call graph for this function:

getAuthorName()

getAuthorName

(

)

Returns the name of the FileRef's author.

Returns

string The name of the FileRef's author.

getDownloadURL()

getDownloadURL

(

$dltype = 'normal'

)

Returns the download-URL for the FileRef.

Parameters

string

$dltype

The download type: 'normal', 'zip', 'force' or 'force_download'.

Returns

string The URL for the FileRef.

Here is the call graph for this function:

getFolderType()

getFolderType

(

)

getLicenseObject()

getLicenseObject

(

)

Returns the license object for this file.

Returns

Object (to be specified!)

incrementDownloadCounter()

incrementDownloadCounter

(

)

This method increments the download counter of the FileRef.

Returns

The number of rows of the file_refs table that have been altered.

Here is the call graph for this function:

isAudio()

isAudio

(

)

Determines if the FileRef references an audio file.

Returns

bool True, if the referenced file is an audio file, false otherwise.

isImage()

isImage

(

)

Determines if the FileRef references an image file.

Returns

bool True, if the referenced file is an image file, false otherwise.

isLink()

isLink

(

)

Determines whether this FileRef is a link or not.

Returns

bool True, if the FileRef references a link, false otherwise.

isVideo()

isVideo

(

)

Determines if the FileRef references a video file.

Returns

bool True, if the referenced file is a video file, false otherwise.

setDownloadURL()

setDownloadURL	(		$field,
			$url
	)

Overrides the usual download url that this file_ref would get by the system (sendfile.php...) Use this method by cloud plugins. If you set download URL to null, the normal sendfile.php will be set as default download URL.

Parameters

$url	: string as URL or null to set URL to sendfile.php-URL

setFolderType()

setFolderType	(		$field,
		FolderType	$folder_type
	)

Field Documentation

$download_url

$download_url

protected

$folder_type

$folder_type

protected

$path_to_blob

$path_to_blob

---

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

• lib/models/FileRef.php