libraries/transformations/TEMPLATE

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