Development:Using the File API - Revision history

Sunner: /* File areas */ Fix a typo

2011-04-05T04:35:03Z

File areas: Fix a typo

← Older revision		Revision as of 04:35, 5 April 2011
Line 12:		Line 12:
	* A unique itemid. Normally, the itemid relates to something depending on the file area type. For example, for a 'course', 'intro' file area, the itemid is 0. For forum post, it is the post id.		* A unique itemid. Normally, the itemid relates to something depending on the file area type. For example, for a 'course', 'intro' file area, the itemid is 0. For forum post, it is the post id.

	File areas are not listed separately anywhere, they are stored implicitly in the files table. Please note that each subsystem is allowed to access only own file areas, for example ~~onnly~~ code in /mod/assignment/* may access files with component 'mod_assignment'.		File areas are not listed separately anywhere, they are stored implicitly in the files table. Please note that each subsystem is allowed to access only own file areas, for example only code in /mod/assignment/* may access files with component 'mod_assignment'.

	===Naming file areas===		===Naming file areas===

Sunner: /* File areas */ Remove a duplicated 'is'

2011-04-05T04:33:59Z

File areas: Remove a duplicated 'is'

← Older revision		Revision as of 04:33, 5 April 2011
Line 10:		Line 10:
	* full component name, for example 'course', 'mod_forum', 'mod_glossary'.		* full component name, for example 'course', 'mod_forum', 'mod_glossary'.
	* A file area type, for example 'intro' or 'post'.		* A file area type, for example 'intro' or 'post'.
	* A unique itemid. Normally, the itemid relates to something depending on the file area type. For example, for a 'course', 'intro' file area, the itemid is is 0. For forum post, it is the post id.		* A unique itemid. Normally, the itemid relates to something depending on the file area type. For example, for a 'course', 'intro' file area, the itemid is 0. For forum post, it is the post id.

	File areas are not listed separately anywhere, they are stored implicitly in the files table. Please note that each subsystem is allowed to access only own file areas, for example onnly code in /mod/assignment/* may access files with component 'mod_assignment'.		File areas are not listed separately anywhere, they are stored implicitly in the files table. Please note that each subsystem is allowed to access only own file areas, for example onnly code in /mod/assignment/* may access files with component 'mod_assignment'.

Chrisstones: ; should be , in the examples

2010-07-26T21:55:58Z

; should be , in the examples

← Older revision		Revision as of 21:55, 26 July 2010
Line 134:		Line 134:
	// Prepare file record object		// Prepare file record object
	$fileinfo = array(		$fileinfo = array(
	'contextid' => $context->id; // ID of context		'contextid' => $context->id, // ID of context
	'component' => 'mod_mymodule'; // usually = table name		'component' => 'mod_mymodule', // usually = table name
	'filearea' => 'myarea'; // usually = table name		'filearea' => 'myarea', // usually = table name
	'itemid' => 0; // usually = ID of row in table		'itemid' => 0, // usually = ID of row in table
	'filepath' => '/'; // any path beginning and ending in /		'filepath' => '/', // any path beginning and ending in /
	'filename' => 'myfile.txt'); // any filename		'filename' => 'myfile.txt'); // any filename

Line 158:		Line 158:
	// Prepare file record object		// Prepare file record object
	$fileinfo = array(		$fileinfo = array(
	'component' => 'mod_mymodule'; // usually = table name		'component' => 'mod_mymodule', // usually = table name
	'filearea' => 'myarea'; // usually = table name		'filearea' => 'myarea', // usually = table name
	'itemid' => 0; // usually = ID of row in table		'itemid' => 0, // usually = ID of row in table
	'contextid' => $context->id; // ID of context		'contextid' => $context->id, // ID of context
	'filepath' => '/'; // any path beginning and ending in /		'filepath' => '/', // any path beginning and ending in /
	'filename' => 'myfile.txt'); // any filename		'filename' => 'myfile.txt'); // any filename

Line 186:		Line 186:
	// Prepare file record object		// Prepare file record object
	$fileinfo = array(		$fileinfo = array(
	'filearea' => 'mod_mymodule';		'filearea' => 'mod_mymodule',
	'filearea' => 'myarea'; // usually = table name		'filearea' => 'myarea', // usually = table name
	'itemid' => 0; // usually = ID of row in table		'itemid' => 0, // usually = ID of row in table
	'contextid' => $context->id; // ID of context		'contextid' => $context->id, // ID of context
	'filepath' => '/'; // any path beginning and ending in /		'filepath' => '/', // any path beginning and ending in /
	'filename' => 'myfile.txt'); // any filename		'filename' => 'myfile.txt'); // any filename

Skodak: /* Create a copy of stored file */

2010-07-03T14:21:17Z

Create a copy of stored file

← Older revision		Revision as of 14:21, 3 July 2010
Line 95:		Line 95:
	<code php>		<code php>
	$context = get_context_instance_by_id($contextid);		$context = get_context_instance_by_id($contextid);
	$file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);		$file_info = $browser->get_file_info($context, $component, $filearea, $fileitemid, $filepath, $filename);
	// copy this file to draft area		// copy this file to draft area
	$file_info->copy_to_storage($user_context->id, 'user', 'draft', $newitemid, '/', $title);		$file_info->copy_to_storage($user_context->id, 'user', 'draft', $newitemid, '/', $title);

Skodak: /* Delete file */

2010-07-03T13:58:36Z

Delete file

← Older revision		Revision as of 13:58, 3 July 2010
Line 186:		Line 186:
	// Prepare file record object		// Prepare file record object
	$fileinfo = array(		$fileinfo = array(
	'filearea' => '~~my_area~~'; // usually = table name		'filearea' => 'mod_mymodule';
			'filearea' => 'myarea'; // usually = table name
	'itemid' => 0; // usually = ID of row in table		'itemid' => 0; // usually = ID of row in table
	'contextid' => $context->id; // ID of context		'contextid' => $context->id; // ID of context
Line 193:		Line 194:

	// Get file		// Get file
	$file = $fs->get_file($fileinfo->contextid, $fileinfo->filearea,		$file = $fs->get_file($fileinfo->contextid, $fileinfo->component, $fileinfo->filearea,
	$fileinfo->itemid, $fileinfo->filepath, $fileinfo->filename);		$fileinfo->itemid, $fileinfo->filepath, $fileinfo->filename);

Skodak: /* Read file */

2010-07-03T13:57:52Z

Read file

← Older revision		Revision as of 13:57, 3 July 2010
Line 151:		Line 151:
	=== Read file ===		=== Read file ===

	This is a way to read a file, equivalent to <tt>file_get_contents</tt>.		This is a way to read a file, equivalent to <tt>file_get_contents</tt>. '''Please note your are allowed to do this ONLY from mod/mymodule/* code, it is not acceptable to do this anywhere else.''' Other code has to use file_browser interface instead.

	<code php>		<code php>
Line 158:		Line 158:
	// Prepare file record object		// Prepare file record object
	$fileinfo = array(		$fileinfo = array(
	'filearea' => '~~my_area~~'; // usually = table name		'component' => 'mod_mymodule'; // usually = table name
			'filearea' => 'myarea'; // usually = table name
	'itemid' => 0; // usually = ID of row in table		'itemid' => 0; // usually = ID of row in table
	'contextid' => $context->id; // ID of context		'contextid' => $context->id; // ID of context
Line 165:		Line 166:

	// Get file		// Get file
	$file = $fs->get_file($fileinfo->contextid, $fileinfo->filearea,		$file = $fs->get_file($fileinfo->contextid, $fileinfo->component, $fileinfo->filearea,
	$fileinfo->itemid, $fileinfo->filepath, $fileinfo->filename);		$fileinfo->itemid, $fileinfo->filepath, $fileinfo->filename);

Skodak: /* Create file */

2010-07-03T13:55:57Z

Create file

← Older revision		Revision as of 13:55, 3 July 2010
Line 134:		Line 134:
	// Prepare file record object		// Prepare file record object
	$fileinfo = array(		$fileinfo = array(
	'filearea' => '~~my_area~~'; // usually = table name		'contextid' => $context->id; // ID of context
			'component' => 'mod_mymodule'; // usually = table name
			'filearea' => 'myarea'; // usually = table name
	'itemid' => 0; // usually = ID of row in table		'itemid' => 0; // usually = ID of row in table
	~~'contextid' => $context->id; // ID of context~~
	'filepath' => '/'; // any path beginning and ending in /		'filepath' => '/'; // any path beginning and ending in /
	'filename' => 'myfile.txt'); // any filename		'filename' => 'myfile.txt'); // any filename

Skodak: /* List area files */

2010-07-03T13:55:11Z

List area files

← Older revision		Revision as of 13:55, 3 July 2010
Line 118:		Line 118:
	<code php>		<code php>
	$fs = get_file_storage();		$fs = get_file_storage();
	$files = $fs->get_area_files($contextid, '~~user_draft~~');		$files = $fs->get_area_files($contextid, 'mod_assignment', 'submission', $submission->id);
	foreach ($files as $f) {		foreach ($files as $f) {
	// $f is an instance of stored_file		// $f is an instance of stored_file

Skodak: /* Create a copy of stored file */

2010-07-03T13:54:36Z

Create a copy of stored file

← Older revision		Revision as of 13:54, 3 July 2010
Line 91:		Line 91:

	===Create a copy of stored file===		===Create a copy of stored file===
			TODO: this example is bogus, nobody should ever write code like this (skodak)
	If you need to create a copy of stored file (actually, it add a new record in database):		If you need to create a copy of stored file (actually, it add a new record in database):
	<code php>		<code php>
Line 96:		Line 97:
	$file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);		$file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);
	// copy this file to draft area		// copy this file to draft area
	$file_info->copy_to_storage($user_context->id, '~~user_draft~~', $newitemid, '/', $title);		$file_info->copy_to_storage($user_context->id, 'user', 'draft', $newitemid, '/', $title);
	</code>		</code>

Skodak: /* Create a copy of stored file */

2010-07-03T13:53:50Z

Create a copy of stored file

← Older revision		Revision as of 13:53, 3 July 2010
Line 101:		Line 101:
	The above code is intended for user-interface behaviour which respects the current user's permissions. If you need to write code which copies files at the back-end in areas which are not directly editable by users (for example, when copying a glossary entry to another glossary, and you want to copy its attachments), you do not need to use the user-level $browser at all. All operations are carried out with the file_storage object (usually $fs). The method to use is create_file_from_storedfile.		The above code is intended for user-interface behaviour which respects the current user's permissions. If you need to write code which copies files at the back-end in areas which are not directly editable by users (for example, when copying a glossary entry to another glossary, and you want to copy its attachments), you do not need to use the user-level $browser at all. All operations are carried out with the file_storage object (usually $fs). The method to use is create_file_from_storedfile.

	For example, the glossary stores per-entry files in two areas ('~~glossary_attachment~~' which stores attachments and '~~glossary_entry~~' which stores files directly related to the HTML definition, such as embedded images). The following code copies all the files relating to a specific glossary entry from one such area to a different glossary item in a different glossary. Note that it changes the context ID and item ID of each file to represent the new context (for the different glossary module) and the new glossary entry (a new row was added to glossary_entries).		For example, the glossary stores per-entry files in two areas ('mod_glossary', 'attachment' which stores attachments and 'mod_glossary', 'entry' which stores files directly related to the HTML definition, such as embedded images). The following code copies all the files relating to a specific glossary entry from one such area to a different glossary item in a different glossary. Note that it changes the context ID and item ID of each file to represent the new context (for the different glossary module) and the new glossary entry (a new row was added to glossary_entries).

	<code php>		<code php>
	$fs = get_file_storage();		$fs = get_file_storage();
	if ($files = $fs->get_area_files($oldcontextid, '~~glossary_attachment~~', $oldentryid)) {		if ($files = $fs->get_area_files($oldcontextid, 'mod_glossary', 'attachment', $oldentryid)) {
	foreach ($files as $file) {		foreach ($files as $file) {
	$fs->create_file_from_storedfile(array(		$fs->create_file_from_storedfile(array(