Added way to get a textual description of a file (e.g. 'Word document') based on its MIME type.

This commit is contained in:
sam_marshall 2006-03-09 13:14:33 +00:00
parent 3ce73b147f
commit c0381e22da
2 changed files with 46 additions and 0 deletions

View File

@ -0,0 +1,26 @@
<?PHP
// These should be accessed using get_mimetype_description in filelib.php.
// They correspond to a (currently small) subset of the MIME types that Moodle
// supports, which are also listed in filelib.php. Descriptions for other types
// should be added here.
// Style: initial lower-case letter, except as required for product names etc.
$string['text/plain'] = 'text file';
$string['application/pdf'] = 'PDF document';
$string['application/msword'] = 'Word document';
$string['text/rtf'] = 'RTF document';
$string['application/vnd.ms-excel'] = 'Excel spreadsheet';
$string['audio/wav'] = 'sound file';
$string['audio/mp3'] = 'MP3 audio file';
$string['application/vnd.ms-powerpoint'] = 'Powerpoint presentation';
$string['application/zip'] = 'zip archive';
$string['image/jpeg'] = 'JPEG image';
$string['image/gif'] = 'GIF image';
$string['image/bmp'] = 'uncompressed BMP image';
// Moodle default MIME type used for all types not described
$string['document/unknown'] = 'file';
?>

View File

@ -182,6 +182,26 @@ function mimeinfo_from_type($element, $mimetype) {
return $mimeinfo['xxx'][$element]; // Default
}
/**
* Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
* mimetypes.php language file.
* @param string $mimetype MIME type (can be obtained using the mimeinfo function)
* @param bool $capitalise If true, capitalises first character of result
* @return string Text description
*/
function get_mimetype_description($mimetype,$capitalise=false) {
$result=get_string($mimetype,'mimetypes');
// Surrounded by square brackets indicates that there isn't a string for that
// (maybe there is a better way to find this out?)
if(strpos($result,'[')===0) {
$result=get_string('document/unknown','mimetypes');
}
if($capitalise) {
$result=ucfirst($result);
}
return $result;
}
/**
* @PARAM $filter int 0=no filtering, 1=all files, 2=html files only
*/