| [ Index ] |
|
Code source de Horde 3.1.3 |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 470 lignes (16 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
MIME_Viewer:: (15 méthodes):
factory()
includeDriver()
MIME_Viewer()
setMIMEPart()
getType()
render()
renderAttachmentInfo()
canDisplayInline()
resolveDriver()
getDriver()
getIcon()
_getIcon()
getCharset()
getConfigParam()
forceInlineView()
Classe: MIME_Viewer - X-Ref
The MIME_Viewer:: class provides an abstracted interface to| factory(&$mime_part, $mime_type = null) X-Ref |
| Attempts to return a concrete MIME_Viewer_* object based on the type of MIME_Part passed onto it. param: MIME_Part &$mime_part Reference to a MIME_Part object with the param: string $mime_type Use this MIME type instead of the type return: MIME_Viewer The MIME_Viewer object, or false on error. |
| includeDriver($mime_type) X-Ref |
| Include the code for the relevant driver. param: string $mime_type The Content-type of the part to be rendered. return: stdClass See MIME_Driver::getDriver(). |
| MIME_Viewer(&$mime_part, $conf = array() X-Ref |
| Constructor for MIME_Viewer param: MIME_Part &$mime_part Reference to a MIME_Part object with the |
| setMIMEPart(&$mime_part) X-Ref |
| Sets the MIME_Part object for the class. param: MIME_Part &$mime_part Reference to a MIME_Part object with the |
| getType() X-Ref |
| Return the MIME type of the rendered content. This can be overridden by the individual drivers, depending on what format they output in. By default, it passes through the MIME type of the object, or replaces custom extension types with 'text/plain' to let the browser do a best-guess render. return: string MIME-type of the output content. |
| render($params = null) X-Ref |
| Return the rendered version of the object. Should be overridden by individual drivers to perform custom tasks. The $mime_part class variable has the information to render, encapsulated in a MIME_Part object. param: mixed $params Any optional parameters this driver needs at return: string Rendered version of the object. |
| renderAttachmentInfo() X-Ref |
| Return text/html output used as alternative output when the fully rendered object cannot (or should not) be displayed. For example, this function should be used for MIME attachments that cannot be viewed inline, where the user may be given options on how to view the attachment. Should be overridden by individual drivers to perform custom tasks. The $mime_part class variable has the information to render, encapsulated in a MIME_Part object. param: mixed $params Any optional parameters this driver needs at return: string Text/html rendered information. |
| canDisplayInline() X-Ref |
| Can this driver render the the data inline? return: boolean True if the driver can display inline. |
| resolveDriver($driver = 'default', $app = 'horde') X-Ref |
| Given a driver and an application, this returns the fully qualified filesystem path to the driver source file. param: string $driver Driver name. param: string $app Application name. return: string Filesystem path of the driver/application queried. |
| getDriver($mimeType, $module = 'horde') X-Ref |
| Given an input MIME type and a module name, this function resolves it into a specific output driver which can handle it. param: string $mimeType MIME type to resolve. param: string $module Module in which to search for the driver. return: stdClass Object with the following items: |
| getIcon($mimeType) X-Ref |
| Given a MIME type, this function will return an appropriate icon. param: string $mimeType The MIME type that we need an icon for. return: string The URL to the appropriate icon. |
| _getIcon($mimeType, $module = 'horde') X-Ref |
| Given an input MIME type and module, this function returns the URL of an icon that can be associated with it param: string $mimeType MIME type to get the icon for. return: stdClass url: URL to an icon, or null if none |
| getCharset() X-Ref |
| Returns the character set used for the Viewer. Should be overridden by individual drivers to perform custom tasks. return: string The character set used by this Viewer. |
| getConfigParam($param) X-Ref |
| Return a configuration parameter for the current viewer. param: string $param The parameter name. return: mixed The value of the parameter; returns null if the parameter |
| forceInlineView() X-Ref |
| Should we force viewing of this MIME Part inline, regardless of the Content-Disposition of the MIME Part? return: boolean Force viewing inline? |
| Généré le : Sun Feb 25 18:01:28 2007 | par Balluche grâce à PHPXref 0.7 |