Database fields - Revision history

Devdocsbot: Protected "Database fields": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-22T07:04:22Z

Protected "Database fields": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 07:04, 22 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-22T07:01:21Z

Update migration status and path

← Older revision		Revision as of 07:01, 22 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/mod_data/fields}}
	==Introduction==		==Introduction==
	Moodle's [[:en:Database module\|Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:		Moodle's [[:en:Database module\|Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:

Dmonllao: /* The PHP class */

2016-11-28T08:43:58Z

The PHP class

← Older revision		Revision as of 08:43, 28 November 2016
Line 48:		Line 48:
	function get_content_value($value) // Useful if the info stored in the database if different from the info that ends up being presented to the user		function get_content_value($value) // Useful if the info stored in the database if different from the info that ends up being presented to the user

	If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.		If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.

			You can also overwrite the default data_field_base::$priority field if your field type should be highly ranked in global search search results. This field is used specify which is the priority of this field type in relation to other field types.

	==Example==		==Example==

Dmonllao at 08:41, 28 November 2016

2016-11-28T08:41:15Z

← Older revision		Revision as of 08:41, 28 November 2016
Line 46:		Line 46:
	function update_content($recordid, $value, $name='') // Used when a user stores data for a record		function update_content($recordid, $value, $name='') // Used when a user stores data for a record
	function get_sort_sql($fieldname) // Specify SQL for how this field should be sorted		function get_sort_sql($fieldname) // Specify SQL for how this field should be sorted
			function get_content_value($value) // Useful if the info stored in the database if different from the info that ends up being presented to the user

	If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.		If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.

Abgreeve: /* File structure */

2012-01-30T06:36:44Z

File structure

← Older revision		Revision as of 06:36, 30 January 2012
Line 23:		Line 23:
	* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.		* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.
	* '''version.php''' - contains version information about the field type.		* '''version.php''' - contains version information about the field type.
	* '''~~datafield_tastiness~~.php''' - contains the language strings used in the field type. You will need to create the same file structure as the other field types~~. In the example it is~~ 'mod/data/field/~~tastiness~~/lang/en/'. All of the normal field types keep their language definitions in the general language file ('mod/data/lang/en/data.php'), but I recommend keeping your language strings separate where you can.		* '''datafield_url.php''' - contains the language strings used in the url field type. You will need to create the same file structure as the other field types ('mod/data/field/url/lang/en/'). All of the normal field types keep their language definitions in the general language file ('mod/data/lang/en/data.php'), but I recommend keeping your language strings separate where you can.
	* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field. To add an icon for your field you need to include this file in 'mod/data/pix/field/'. You will see icons for all the other fields in this directory.		* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field. To add an icon for your field you need to include this file in 'mod/data/pix/field/'. You will see icons for all the other fields in this directory.


	==The PHP class==		==The PHP class==

Abgreeve at 05:51, 30 January 2012

2012-01-30T05:51:02Z

← Older revision		Revision as of 05:51, 30 January 2012
Line 1:		Line 1:
			==Introduction==
	Moodle's [[:en:Database module\|Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:		Moodle's [[:en:Database module\|Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:

Line 15:		Line 16:
	# What to do (what info to store) when the teacher submits the field-add/edit form		# What to do (what info to store) when the teacher submits the field-add/edit form

	==~~The files~~==		==File structure==

	The best way to get an understanding of the plugin architecture is to look at an existing field type - I recommend you look at '''the URL field type''', stored in /moodle/mod/data/field/url. There are ~~three~~ files:		The best way to get an understanding of the plugin architecture is to look at an existing field type - I recommend you look at '''the URL field type''', stored in /moodle/mod/data/field/url. There are five files:

	* '''field.class.php''' - the most important file, this defines a PHP class which defines the majority of the data field's behaviour. See below for more detail on this.		* '''field.class.php''' - the most important file, this defines a PHP class which defines the majority of the data field's behaviour. See below for more detail on this.
	* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.		* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.
	* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field.		* '''version.php''' - contains version information about the field type.
			* '''datafield_tastiness.php''' - contains the language strings used in the field type. You will need to create the same file structure as the other field types. In the example it is 'mod/data/field/tastiness/lang/en/'. All of the normal field types keep their language definitions in the general language file ('mod/data/lang/en/data.php'), but I recommend keeping your language strings separate where you can.
			* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field. To add an icon for your field you need to include this file in 'mod/data/pix/field/'. You will see icons for all the other fields in this directory.


Line 47:		Line 50:
	If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.		If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.

	~~''To be continued~~...''		==Example==

			This is an example of a custom field type for phone numbers. I have tried to keep this example as simple as possible while still providing enough detail that you can create your own with minimal trouble.
			*[https://github.com/abgreeve/moodle/compare/wip-HQ-180-master Phone number field type.]

	[[Category:Plugins]]		[[Category:Plugins]]

	[[ja:データベースフィールド]]		[[ja:データベースフィールド]]

Deraadt: Adding to a top level category

2011-11-04T09:03:58Z

Adding to a top level category

← Older revision		Revision as of 09:03, 4 November 2011
Line 1:		Line 1:
	Moodle's [[Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:		Moodle's [[:en:Database module\|Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:

	; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.		; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.
Line 49:		Line 49:
	''To be continued...''		''To be continued...''

			[[Category:Plugins]]

	[[ja:データベースフィールド]]		[[ja:データベースフィールド]]

Topstone: link to Japanese page

2008-09-06T14:30:06Z

link to Japanese page

← Older revision		Revision as of 14:30, 6 September 2008
Line 48:		Line 48:

	''To be continued...''		''To be continued...''



			[[ja:データベースフィールド]]

Tsala: stub template removed

2007-11-28T21:07:33Z

stub template removed

← Older revision		Revision as of 21:07, 28 November 2007
Line 46:		Line 46:

	If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.		If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen.


	''To be continued...''		''To be continued...''

	~~{{stub}}~~

Rcollman: changed link

2007-09-11T11:20:32Z

changed link

← Older revision		Revision as of 11:20, 11 September 2007
Line 1:		Line 1:
	Moodle's [[Database module]] has some predefined [[~~Fields~~\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:		Moodle's [[Database module]] has some predefined [[Database_fields\|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:

	; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.		; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.