Using the File API in Moodle forms - Revision history

Devdocsbot: Protected "Using the File API in Moodle forms": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2023-01-16T12:57:05Z

Protected "Using the File API in Moodle forms": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 12:57, 16 January 2023
(No difference)

Devdocsbot: Update migration status and path

2023-01-16T12:54:48Z

Update migration status and path

Show changes

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T20:33:13Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"
Show changes

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T20:05:23Z

Text replacement - "</code>" to "</syntaxhighlight>"

Show changes

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:09:22Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:09, 14 July 2021
				
Line 99:
Line 99:
;areamaxbytes:(Default 0) Restricts the total size of all the files. ;areamaxbytes:(Default 0) Restricts the total size of all the files.
;maxfiles:(Default -1) Restricts the total number of files. ;maxfiles:(Default -1) Restricts the total number of files.
;accepted_types:(Default *) You can specify what file types are accepted by filemanager.  All current file types are listed in <code>get_mimetypes_array()</code> in [https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php lib/classes/filetypes.php]. ;accepted_types:(Default *) You can specify what file types are accepted by filemanager.  All current file types are listed in <syntaxhighlight lang="php">get_mimetypes_array()</code> in [https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php lib/classes/filetypes.php].



Example usage:  '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''. Example usage:  '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''.



Gb2048: _manager should be _filemanager as per 'file_postupdate_standard_filemanager()' in '/lib/filelib.php'.
2021-05-16T11:36:43Z
_manager should be _filemanager as per 'file_postupdate_standard_filemanager()' in '/lib/filelib.php'.

				
				
				
				
				
				← Older revision
				Revision as of 11:36, 16 May 2021
				
Line 334:
Line 334:
Note the following: Note the following:
* The format element and the help button are no longer required for the HTML editor element * The format element and the help button are no longer required for the HTML editor element
* The name of the form element needs to be changed by adding '_editor' or '_manager' to the original name. This is a naming convention that is used by a couple of functions we will look at shortly * The name of the form element needs to be changed by adding '_editor' or '_filemanager' to the original name. This is a naming convention that is used by a couple of functions we will look at shortly
* Make sure $definitionoptions has context parameter, else system context is used and editor will not respect filter settings. * Make sure $definitionoptions has context parameter, else system context is used and editor will not respect filter settings.






Jboulen: /* Add file manager element */ remove a dead link and an old hint for moodle prior 2.3
2020-05-12T08:58:42Z
Add file manager element:  remove a dead link and an old hint for moodle prior 2.3

				
				
				
				
				
				← Older revision
				Revision as of 08:58, 12 May 2020
				
Line 99:
Line 99:
;areamaxbytes:(Default 0) Restricts the total size of all the files. ;areamaxbytes:(Default 0) Restricts the total size of all the files.
;maxfiles:(Default -1) Restricts the total number of files. ;maxfiles:(Default -1) Restricts the total number of files.
;accepted_types:(Default *) You can specify what file types are accepted by filemanager.  All current file types are listed in this file: [http://cvs.moodle.org/moodle/lib/filestorage/file_types.mm moodle/lib/filestorage/file_types.mm].  This is a [http://freemind.sourceforge.net/wiki/index.php/Main_Page freemind] file: if it is edited the changes will be immediately reflected in Moodle. ;accepted_types:(Default *) You can specify what file types are accepted by filemanager.  All current file types are listed in <code>get_mimetypes_array()</code> in [https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php lib/classes/filetypes.php].
  
As of 2.3 file_types.mm is no longer used, instead the file types are listed in <code>get_mimetypes_array()</code> in lib/classes/filetypes.php (https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php). 



Example usage:  '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''. Example usage:  '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''.



Howardsmiller: /* Element preparation */
2019-01-18T11:44:28Z
Element preparation

				
				
				
				
				
				← Older revision
				Revision as of 11:44, 18 January 2019
				
Line 298:
Line 298:
*# You '''must''' name the form element as {element}_editor or {element}_filemanager (see next section) *# You '''must''' name the form element as {element}_editor or {element}_filemanager (see next section)
*# You '''must''' have at least the following fields in the database: {element} and {element}summary, as described earlier in this documentation *# You '''must''' have at least the following fields in the database: {element} and {element}summary, as described earlier in this documentation
*# $entry will be populated with a field (in this case) 'definition_filemanager' having the draftfileid of your files. This needs to get passed to the 'value' of the filemanager control in the form. If you get this wrong, existing file will not appear in the control when it is reloaded.



We can now look at the upgrades needed in the form definition file. We can now look at the upgrades needed in the form definition file.



Howardsmiller: /* Element preparation */
2019-01-18T11:41:54Z
Element preparation

				
				
				
				
				
				← Older revision
				Revision as of 11:41, 18 January 2019
				
Line 290:
Line 290:
                                                  'definitionoptions'=>$definitionoptions,                                                     'definitionoptions'=>$definitionoptions,  
                                                  'attachmentoptions'=>$attachmentoptions));                                                   'attachmentoptions'=>$attachmentoptions));
$mform->set_data($entry);
</code> </code>
Things to note: Things to note:



Howardsmiller: /* Element preparation */
2019-01-18T11:03:17Z
Element preparation

				
				
				
				
				
				← Older revision
				Revision as of 11:03, 18 January 2019
				
Line 282:
Line 282:
<code php> <code php>
$entry = new stdClass(); $entry = new stdClass();
$entry->id = 0; \\ See notes!
$entry = file_prepare_standard_editor($entry, 'definition', $definitionoptions, $context, $entry = file_prepare_standard_editor($entry, 'definition', $definitionoptions, $context,
                                       'mod_glossary', 'entry', $entry->id);                                        'mod_glossary', 'entry', $entry->id);

← Older revision		Revision as of 13:09, 14 July 2021
Line 99:		Line 99:
	;areamaxbytes:(Default 0) Restricts the total size of all the files.		;areamaxbytes:(Default 0) Restricts the total size of all the files.
	;maxfiles:(Default -1) Restricts the total number of files.		;maxfiles:(Default -1) Restricts the total number of files.
	;accepted_types:(Default *) You can specify what file types are accepted by filemanager. All current file types are listed in <~~code~~>get_mimetypes_array()</code> in [https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php lib/classes/filetypes.php].		;accepted_types:(Default *) You can specify what file types are accepted by filemanager. All current file types are listed in <syntaxhighlight lang="php">get_mimetypes_array()</code> in [https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php lib/classes/filetypes.php].

	Example usage: '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''.		Example usage: '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''.

← Older revision		Revision as of 11:36, 16 May 2021
Line 334:		Line 334:
	Note the following:		Note the following:
	* The format element and the help button are no longer required for the HTML editor element		* The format element and the help button are no longer required for the HTML editor element
	* The name of the form element needs to be changed by adding '_editor' or '~~_manager~~' to the original name. This is a naming convention that is used by a couple of functions we will look at shortly		* The name of the form element needs to be changed by adding '_editor' or '_filemanager' to the original name. This is a naming convention that is used by a couple of functions we will look at shortly
	* Make sure $definitionoptions has context parameter, else system context is used and editor will not respect filter settings.		* Make sure $definitionoptions has context parameter, else system context is used and editor will not respect filter settings.

← Older revision		Revision as of 08:58, 12 May 2020
Line 99:		Line 99:
	;areamaxbytes:(Default 0) Restricts the total size of all the files.		;areamaxbytes:(Default 0) Restricts the total size of all the files.
	;maxfiles:(Default -1) Restricts the total number of files.		;maxfiles:(Default -1) Restricts the total number of files.
	;accepted_types:(Default *) You can specify what file types are accepted by filemanager. All current file types are listed in this file: [http://cvs.moodle.org/moodle/lib/filestorage/file_types.mm moodle/lib/filestorage/file_types.mm]. This is a [http://freemind.sourceforge.net/wiki/index.php/Main_Page freemind] file: if it is edited the changes will be immediately reflected in Moodle.		;accepted_types:(Default *) You can specify what file types are accepted by filemanager. All current file types are listed in <code>get_mimetypes_array()</code> in [https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php lib/classes/filetypes.php].

	~~As of 2.3 file_types.mm is no longer used, instead the~~ file types are listed in <code>get_mimetypes_array()</code> in ~~lib/classes/filetypes.php (~~https://github.com/moodle/moodle/blob/master/lib/classes/filetypes.php).

	Example usage: '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''.		Example usage: '''array('audio', 'video', 'document')''', you can include file extensions as well, for example: '''array('.txt', '.jpg', 'audio')'''.

← Older revision		Revision as of 11:44, 18 January 2019
Line 298:		Line 298:
	*# You '''must''' name the form element as {element}_editor or {element}_filemanager (see next section)		*# You '''must''' name the form element as {element}_editor or {element}_filemanager (see next section)
	*# You '''must''' have at least the following fields in the database: {element} and {element}summary, as described earlier in this documentation		*# You '''must''' have at least the following fields in the database: {element} and {element}summary, as described earlier in this documentation
			*# $entry will be populated with a field (in this case) 'definition_filemanager' having the draftfileid of your files. This needs to get passed to the 'value' of the filemanager control in the form. If you get this wrong, existing file will not appear in the control when it is reloaded.

	We can now look at the upgrades needed in the form definition file.		We can now look at the upgrades needed in the form definition file.

← Older revision		Revision as of 11:41, 18 January 2019
Line 290:		Line 290:
	'definitionoptions'=>$definitionoptions,		'definitionoptions'=>$definitionoptions,
	'attachmentoptions'=>$attachmentoptions));		'attachmentoptions'=>$attachmentoptions));
			$mform->set_data($entry);
	</code>		</code>
	Things to note:		Things to note:

← Older revision		Revision as of 11:03, 18 January 2019
Line 282:		Line 282:
	<code php>		<code php>
	$entry = new stdClass();		$entry = new stdClass();
			$entry->id = 0; \\ See notes!
	$entry = file_prepare_standard_editor($entry, 'definition', $definitionoptions, $context,		$entry = file_prepare_standard_editor($entry, 'definition', $definitionoptions, $context,
	'mod_glossary', 'entry', $entry->id);		'mod_glossary', 'entry', $entry->id);

Using the File API in Moodle forms - Revision history

Devdocsbot: Protected "Using the File API in Moodle forms": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Gb2048: _manager should be _filemanager as per 'file_postupdate_standard_filemanager()' in '/lib/filelib.php'.

Jboulen: /* Add file manager element */ remove a dead link and an old hint for moodle prior 2.3

Howardsmiller: /* Element preparation */

Howardsmiller: /* Element preparation */

Howardsmiller: /* Element preparation */

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""

Mudrd8mz: Text replacement - "`" to ""`