libraries/transformations/TEMPLATE

   1 <?php
   2 /* $Id$ */
   3 // vim: expandtab sw=4 ts=4 sts=4:
   4
   5 /**
   6  * Plugin function TEMPLATE (Garvin Hicking).
   7  * -----------------------------------------
   8  *
   9  * For instructions, read the /Documentation.html file.
  10  *
  11  * The string [ENTER_FILENAME_HERE] shall be substituted with the filename without the '.inc.php'
  12  * extension. For further information regarding naming conventions see the /Documentation.html file.
  13  */
  14
  15 function PMA_transformation_[ENTER_FILENAME_HERE]_info() {
  16     return array(
  17         'info' =>  __('Description of the transformation.'),
  18         );
  19 }
  20
  21 function PMA_transformation_[ENTER_FILENAME_HERE]($buffer, $options = array(), $meta = '') {
  22     // possibly use a global transform and feed it with special options:
  23     // include('./libraries/transformations/global.inc.php');
  24
  25     // further operations on $buffer using the $options[] array.
  26
  27     // You can evaluate the propagated $meta Object. It's contained fields are described in http://www.php.net/mysql_fetch_field.
  28     // This stored information can be used to get the field information about the transformed field.
  29     // $meta->mimetype contains the original MimeType of the field (i.e. 'text/plain', 'image/jpeg' etc.)
  30
  31     return $buffer;
  32 }
  33
  34 ?>