DocumentHandler Class Reference

Public Member Functions
	DocumentHandler ()
	getDocMimeType ($name)
	Replaces getMimeType because name conflicts with getMIMEType. More...

Static Public Member Functions
static	getDocType ($doc)
	Returns a human-readable type name for a document, based on the file extension of the supplied file name. More...
static	getDocSize ($doc)
	Returns the file size in Kb for a document. More...
static	getDocIcon ($doc)
static	getIcon ($file)
	Retrieves a graphic icon appropriate for the given file. More...
static	getMIMEType ($filename)

Detailed Description

Definition at line 113 of file document_handler.inc.

Member Function Documentation

DocumentHandler()

DocumentHandler::DocumentHandler

(

)

Definition at line 115 of file document_handler.inc.

     {
          
     }

getDocIcon()

static DocumentHandler::getDocIcon (   $doc )

static

Definition at line 189 of file document_handler.inc.

     {
          global $doc_icons;
          $n = strtolower($doc);
          $extension = substr($n, strrpos($n, "."));
          $icon = $doc_icons[$extension];
          if (!$icon) $icon = "/fakoli/images/file_icon.png";
          return $icon;
     }    

getDocMimeType()

DocumentHandler::getDocMimeType

(

$name

)

Replaces getMimeType because name conflicts with getMIMEType.

Parameters

$name

Definition at line 178 of file document_handler.inc.

     {
          global $doc_mime_types;
     
          $n = strtolower($name);
          $extension = substr($n, strrpos($n, "."));
          $type = $doc_mime_types[$extension];
          if (!$type) $type="application/octet-stream";
          return $type;  
     }

getDocSize()

static DocumentHandler::getDocSize (   $doc )

static

Returns the file size in Kb for a document.

Parameters

string

$doc

the (local) URL of the document

Definition at line 147 of file document_handler.inc.

     {
          global $config;
    
     // Find the file name for the file on disk
    
          $doc_file = $doc;
    
          $doc_file = str_replace($config["uploadurl"], $config["uploaddir"], $doc_file);
    
     // If the file exists, return its size
    
          if (file_exists($doc_file))
          {
               $doc_size = (int)(filesize($doc_file)/1024);
     }
          else
     {
                $doc_size = 0;
          }
    
     return $doc_size;
     }    

getDocType()

static DocumentHandler::getDocType (   $doc )

static

Returns a human-readable type name for a document, based on the file extension of the supplied file name.

Parameters

string

$doc

the filename of the document

Definition at line 126 of file document_handler.inc.

     {
     global $doc_extensions;
    
     $d = strtolower($doc);
    
          $ext = substr($d, strrpos($d, "."));
    
          $doc_type = $doc_extensions[$ext];
         
          if (!$doc_type) $doc_type = "Unknown";
    
     return $doc_type;
     }

getIcon()

static DocumentHandler::getIcon (   $file )

static

Retrieves a graphic icon appropriate for the given file.

Parameters

$file

the name of the file

Returns

string URL of the graphic icon for the file

Definition at line 204 of file document_handler.inc.

     {
          global $_icons;
          global $auto_form_defaults;
     
          $ext = substr($file, strrpos($file, "."));
          $icon = $_icons[$ext];
          trace("getIcon($file) $ext $icon", 3);
     
          if (!isset($icon))
          {
               $icon = $_icons["default"];
          }
     
          return $auto_form_defaults["componentPath"].$icon;               
     }    

getMIMEType()

static DocumentHandler::getMIMEType (   $filename )

static

Definition at line 221 of file document_handler.inc.

     {
          $mime_types = array(
     
               'txt' => 'text/plain',
          'htm' => 'text/html',
               'html' => 'text/html',
               'css' => 'text/css',
          'js' => 'application/javascript',
               'json' => 'application/json',
               'xml' => 'application/xml',
          'swf' => 'application/x-shockwave-flash',
          'flv' => 'video/x-flv',
 
               // images
          'png' => 'image/png',
               'jpe' => 'image/jpeg',
          'jpeg' => 'image/jpeg',
               'jpg' => 'image/jpeg',
          'gif' => 'image/gif',
          'bmp' => 'image/bmp',
          'ico' => 'image/vnd.microsoft.icon',
          'tiff' => 'image/tiff',
          'tif' => 'image/tiff',
          'svg' => 'image/svg+xml',
          'svgz' => 'image/svg+xml',
 
          // archives
          'zip' => 'application/zip',
          'rar' => 'application/x-rar-compressed',
                'exe' => 'application/x-msdownload',
          'msi' => 'application/x-msdownload',
          'cab' => 'application/vnd.ms-cab-compressed',
 
                // audio/video
          'mp3' => 'audio/mpeg',
               'qt' => 'video/quicktime',
               'mov' => 'video/quicktime',
               'mp4' => 'video/mp4',
               'm4a' => 'audio/m4a',
                    
               // adobe
               'pdf' => 'application/pdf',
          'psd' => 'image/vnd.adobe.photoshop',
          'ai' => 'application/postscript',
               'eps' => 'application/postscript',
          'ps' => 'application/postscript',
 
          // ms office
          'doc' => 'application/msword',
          'rtf' => 'application/rtf',
          'xls' => 'application/vnd.ms-excel',
          'ppt' => 'application/vnd.ms-powerpoint',
 
                // open office
               'odt' => 'application/vnd.oasis.opendocument.text',
          'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
           );
 
           $ext = strtolower(array_pop(explode('.',$filename)));
 
           if (array_key_exists($ext, $mime_types)) 
           {
                return $mime_types[$ext];
           }
           elseif (function_exists('finfo_open')) 
           {
               $finfo = finfo_open(FILEINFO_MIME);
               $mimetype = finfo_file($finfo, $filename);
               finfo_close($finfo);
               return $mimetype;
          }
          else 
          {
          // Prevent other file types (such as source code or configuration files) from being served
          die("");
          }
     }    

---

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

• C:/code/cms.sonjara.com/framework/document_handler.inc