diff options
Diffstat (limited to '')
| -rw-r--r-- | hugo/libraries/plugins/transformations/TEMPLATE | 68 | ||||
| -rw-r--r-- | hugo/libraries/plugins/transformations/TEMPLATE_ABSTRACT | 89 |
2 files changed, 157 insertions, 0 deletions
diff --git a/hugo/libraries/plugins/transformations/TEMPLATE b/hugo/libraries/plugins/transformations/TEMPLATE new file mode 100644 index 0000000..b0ce2f0 --- /dev/null +++ b/hugo/libraries/plugins/transformations/TEMPLATE @@ -0,0 +1,68 @@ +<?php +// vim: expandtab sw=4 ts=4 sts=4: +/** + * This file contains the basic structure for a specific MIME Type and Subtype + * transformations class. + * For instructions, read the documentation + * + * @package PhpMyAdmin-Transformations + * @subpackage [TransformationName] + */ +if (! defined('PHPMYADMIN')) { + exit; +} + +/* Get the [TransformationName] transformations interface */ +require_once 'abstract/[TransformationName]TransformationsPlugin.class.php'; + +/** + * Handles the [TransformationName] transformation for [MIMEType] - [MIMESubtype] + * + * @package PhpMyAdmin + */ +class [MIMEType]_[MIMESubtype]_[TransformationName] + extends [TransformationName]TransformationsPlugin +{ + /** + * Gets the plugin`s MIME type + * + * @return string + */ + public static function getMIMEType() + { + return "[MIMEType]"; + } + + /** + * Gets the plugin`s MIME subtype + * + * @return string + */ + public static function getMIMESubtype() + { + return "[MIMESubtype]"; + } +} + +/** + * Function to call [MIMEType]_[MIMESubtype]_[TransformationName]::getInfo(); + * + * Temporary workaround for bug #3783 : + * Calling a method from a variable class is not possible before PHP 5.3. + * + * This function is called by PMA_getTransformationDescription() + * in libraries/transformations.lib.php using a variable to construct it's name. + * This function then calls the static method. + * + * Don't use this function unless you are affected by the same issue. + * Call the static method directly instead. + * + * @deprecated + * @return string Info about transformation class + */ + +function [MIMEType]_[MIMESubtype]_[TransformationName]_getInfo() +{ + return [MIMEType]_[MIMESubtype]_[TransformationName]::getInfo(); +} +?> diff --git a/hugo/libraries/plugins/transformations/TEMPLATE_ABSTRACT b/hugo/libraries/plugins/transformations/TEMPLATE_ABSTRACT new file mode 100644 index 0000000..5cc1d26 --- /dev/null +++ b/hugo/libraries/plugins/transformations/TEMPLATE_ABSTRACT @@ -0,0 +1,89 @@ +<?php +// vim: expandtab sw=4 ts=4 sts=4: +/** + * This file contains the basic structure for an abstract class defining a + * transformation. + * For instructions, read the documentation + * + * @package PhpMyAdmin-Transformations + * @subpackage [TransformationName] + */ +if (! defined('PHPMYADMIN')) { + exit; +} + +/* Get the transformations interface */ +require_once 'libraries/plugins/TransformationsPlugin.class.php'; + +/** + * Provides common methods for all of the [TransformationName] transformations plugins. + * + * @package PhpMyAdmin + */ +abstract class [TransformationName]TransformationsPlugin + extends TransformationsPlugin +{ + /** + * Gets the transformation description of the specific plugin + * + * @return string + */ + public static function getInfo() + { + return __( + 'Description of the transformation.' + ); + } + + /** + * Does the actual work of each specific transformations plugin. + * + * @param string $buffer text to be transformed + * @param array $options transformation options + * @param string $meta meta information + * + * @return void + */ + public function applyTransformation($buffer, $options = array(), $meta = '') + { + // possibly use a global transform and feed it with special options + + // further operations on $buffer using the $options[] array. + + // You can evaluate the propagated $meta Object. It's contained fields are described in http://www.php.net/mysql_fetch_field. + // This stored information can be used to get the field information about the transformed field. + // $meta->mimetype contains the original MimeType of the field (i.e. 'text/plain', 'image/jpeg' etc.) + + return $buffer; + } + + /** + * This method is called when any PluginManager to which the observer + * is attached calls PluginManager::notify() + * + * @param SplSubject $subject The PluginManager notifying the observer + * of an update. + * + * @todo implement + * @return void + */ + public function update (SplSubject $subject) + { + ; + } + + + /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */ + + + /** + * Gets the TransformationName of the specific plugin + * + * @return string + */ + public static function getName() + { + return "[TransformationName]"; + } +} +?> |
