data_field_file Class Reference

Inheritance diagram for data_field_file:

Public Member Functions
	define_default_field ()
	This field just sets up a default field object.
	define_field ($data)
	Set up the field object according to data in an object.
object	delete_content ($recordid=0)
	Delete all content associated with the field.
object	delete_field ()
	Delete a field completely.
	display_add_field ($recordid=0, $formdata=null)
	Print the relevant form element in the ADD template for this field.
	display_browse_field ($recordid, $template)
	Display the content of the field in browse mode.
object	display_edit_field ()
	Print the relevant form element to define the attributes for this field viewable by teachers only.
	display_search_field ($value='')
	export_file_value (stdClass $record)
	Exports the file content for file export.
	export_text_value (stdClass $record)
	Here we export the text value of a file field which is the filename of the exported file.
	file_export_supported ()
	Specifies that this field type supports the export of files.
	file_import_supported ()
	Specifies that this field type supports the import of files.
	file_ok ($path)
	generate_sql ($tablealias, $value)
	get_config_for_external ()
	Return the plugin configs for external functions.
	get_data_content_preview (int $recordid)
	Generate a fake data_content for this field to be used in preset previews.
	get_field_params ()
	Function to let field define their parameters.
	get_file ($recordid, $content=null)
	get_name ()
	Return the field type name.
	get_preview ()
	Get the field preview value.
	get_sort_field ()
	Returns the sortable field for the content.
	get_sort_sql ($fieldname)
	Returns the SQL needed to refer to the column.
object	image ()
	Prints the respective type icon.
	import_file_value (int $contentid, string $filecontent, string $filename)
	Provides the necessary code for importing a file when importing the content of a mod_data instance.
object	insert_field ()
	Insert a new field in the database We assume the field object is already defined as $this->field.
	name ()
	Returns the name/type of the field.
	notemptyfield ($value, $name)
	Custom notempty function.
	parse_search_field ($defaults=null)
	print_after_form ()
	Just in case a field needs to print something after the whole form.
	print_before_form ()
	Just in case a field needs to print something before the whole form.
	set_preview (bool $preview)
	Set the field to preview mode.
	supports_preview ()
	Return if the field type supports preview.
	text_export_supported ()
	Per default, it is assumed that fields support text exporting.
	update_content ($recordid, $value, $name='')
	Update the content of one data field in the data_content table.
object	update_field ()
	Update a field in the database.
	validate (stdClass $fieldinput)
	Validates params of fieldinput data.

Static Public Member Functions
static	get_content_value ($content)
	Returns the presentable string value for a field content.
static	get_priority ()
	Returns the priority for being indexed by globalsearch.

Public Attributes
object	$cm
	course module or cmifno
object	$context
	activity context
object	$data = NULL
	The database object that this field belongs to.
object	$field = NULL
	The field object itself, if we know it.
int	$iconheight = 16
	Width of the icon for this fieldtype.
int	$iconwidth = 16
	Width of the icon for this fieldtype.
	$type = 'file'
const	HIGH_PRIORITY = 3
	priority value for high priority
const	LOW_PRIORITY = 2
	priority value for low priority
const	MAX_PRIORITY = 4
	priority value for maximum priority
const	MIN_PRIORITY = 1
	priority value for minimum priority
const	NO_PRIORITY = 0
	priority value for invalid fields regarding indexing

Protected Member Functions
	get_data_content (int $recordid)
	Return the data_content of the field, or generate it if it is in preview mode.

Protected Attributes
bool	$preview = false
	whether the field is used in preview mode.

Static Protected Attributes
static priority	$priority = self::NO_PRIORITY
	for globalsearch indexing

Member Function Documentation

define_default_field()

data_field_base::define_default_field ( )

inherited

This field just sets up a default field object.

Return values

bool

define_field()

data_field_base::define_field ( $data )

inherited

Set up the field object according to data in an object.

Now is the time to clean it!

Return values

bool

delete_content()

object data_field_base::delete_content ( $recordid = 0 )

inherited

Delete all content associated with the field.

Parameters

int

$recordid

Return values

bool

delete_field()

object data_field_base::delete_field ( )

inherited

Delete a field completely.

Return values

bool

display_add_field()

data_field_file::display_add_field	(		$recordid = 0,
			$formdata = null )

Print the relevant form element in the ADD template for this field.

Parameters

int

$recordid

Return values

string

Reimplemented from data_field_base.

display_browse_field()

data_field_file::display_browse_field	(		$recordid,
			$template )

Display the content of the field in browse mode.

Parameters

int	$recordid
object	$template

Return values

bool|string

Reimplemented from data_field_base.

display_edit_field()

object data_field_base::display_edit_field ( )

inherited

Print the relevant form element to define the attributes for this field viewable by teachers only.

@global object

Return values

void	Output is echo'd

export_file_value()

data_field_file::export_file_value

(

stdClass

$record

)

Exports the file content for file export.

Parameters

stdClass

$record

the data content record the file belongs to

Return values

null|string

The file content of the stored file or null if no file should be exported for this record

Reimplemented from data_field_base.

export_text_value()

data_field_file::export_text_value

(

stdClass

$record

)

Here we export the text value of a file field which is the filename of the exported file.

Parameters

stdClass

$record

the record which is being exported

Return values

string

the value which will be stored in the exported file for this field

Reimplemented from data_field_base.

file_export_supported()

data_field_file::file_export_supported

(

)

Specifies that this field type supports the export of files.

Return values

bool	true which means that file export is being supported by this field type

Reimplemented from data_field_base.

file_import_supported()

data_field_file::file_import_supported

(

)

Specifies that this field type supports the import of files.

Return values

bool	true which means that file import is being supported by this field type

Reimplemented from data_field_base.

file_ok()

data_field_file::file_ok

(

$relativepath

)

Parameters

string

$relativepath

Return values

bool

false

Reimplemented from data_field_base.

get_config_for_external()

data_field_file::get_config_for_external

(

)

Return the plugin configs for external functions.

Return values

array

the list of config parameters

Since

Moodle 3.3

Reimplemented from data_field_base.

get_content_value()

static data_field_base::get_content_value ( $content )

staticinherited

Returns the presentable string value for a field content.

The returned string should be plain text.

Parameters

stdClass

$content

Return values

string

Reimplemented in data_field_checkbox, data_field_multimenu, and data_field_textarea.

get_data_content()

data_field_base::get_data_content ( int $recordid )

protectedinherited

Return the data_content of the field, or generate it if it is in preview mode.

Parameters

int

$recordid

the record id

Return values

stdClass|bool

the record data or false if none

get_data_content_preview()

data_field_file::get_data_content_preview

(

int

$recordid

)

Generate a fake data_content for this field to be used in preset previews.

Data plugins must override this method and support_preview in order to enable preset preview for this field.

Parameters

int

$recordid

the fake record id

Return values

stdClass

the fake record

Reimplemented from data_field_base.

get_field_params()

data_field_file::get_field_params

(

)

Function to let field define their parameters.

This method that should be overridden by the datafield plugins when they need to define their data.

Return values

array

Reimplemented from data_field_base.

get_name()

data_field_base::get_name ( )

inherited

Return the field type name.

Return values

string

the filed type.

get_preview()

data_field_base::get_preview ( )

inherited

Get the field preview value.

Return values

bool

get_priority()

static data_field_base::get_priority ( )

staticinherited

Returns the priority for being indexed by globalsearch.

Return values

int

get_sort_field()

data_field_base::get_sort_field ( )

inherited

Returns the sortable field for the content.

By default, it's just content but for some plugins, it could be content 1 - content4

Return values

string

get_sort_sql()

data_field_base::get_sort_sql ( $fieldname )

inherited

Returns the SQL needed to refer to the column.

Some fields may need to CAST() etc.

Parameters

string

$fieldname

Return values

string\$fieldname

Reimplemented in data_field_date, data_field_latlong, and data_field_number.

image()

object data_field_base::image ( )

inherited

Prints the respective type icon.

Return values

string

import_file_value()

data_field_file::import_file_value	(	int	$contentid,
		string	$filecontent,
		string	$filename )

Provides the necessary code for importing a file when importing the content of a mod_data instance.

Parameters

int	$contentid	the id of the mod_data content record
string	$filecontent	the content of the file to import as string
string	$filename	the filename the imported file should get

Return values

void

Reimplemented from data_field_base.

insert_field()

object data_field_base::insert_field ( )

inherited

Insert a new field in the database We assume the field object is already defined as $this->field.

Return values

bool

name()

data_field_base::name ( )

inherited

Returns the name/type of the field.

Return values

string

notemptyfield()

data_field_file::notemptyfield	(		$value,
			$name )

Custom notempty function.

Parameters

string	$value
string	$name

Return values

bool

Reimplemented from data_field_base.

print_after_form()

data_field_base::print_after_form ( )

inherited

Just in case a field needs to print something after the whole form.

Reimplemented in data_field_textarea.

set_preview()

data_field_base::set_preview ( bool $preview )

inherited

Set the field to preview mode.

Parameters

bool

$preview

the new preview value

supports_preview()

data_field_file::supports_preview

(

)

Return if the field type supports preview.

Fields without a preview cannot be displayed in the preset preview.

Return values

bool	if the plugin supports preview.

Reimplemented from data_field_base.

text_export_supported()

data_field_base::text_export_supported ( )

inherited

Per default, it is assumed that fields support text exporting.

Override this (return false) on fields not supporting text exporting.

Return values

bool

true

update_content()

data_field_file::update_content	(		$recordid,
			$value,
			$name = '' )

Update the content of one data field in the data_content table.

Parameters

int	$recordid
mixed	$value
string	$name

Return values

bool

Reimplemented from data_field_base.

update_field()

object data_field_base::update_field ( )

inherited

Update a field in the database.

Return values

bool

Reimplemented in data_field_picture.

validate()

data_field_base::validate ( stdClass $fieldinput )

inherited

Validates params of fieldinput data.

Overwrite to validate fieldtype specific data.

You are expected to return an array like ['paramname' => 'Error message for paramname param'] if there is an error, return an empty array if everything is fine.

Parameters

stdClass

$fieldinput

The field input data to check

Return values

array\$errors

if empty validation was fine, otherwise contains one or more error messages

Reimplemented in data_field_picture.

---

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

• mod/data/field/file/field.class.php