Source for file exportcodes.php

Documentation is available at exportcodes.php

  1. <?php
  2. /**
  3. * Numeric codes for defining data export types and formats
  4. *
  5. * Export types include TAB and Comma delimited, formats include the number of decimal places to use.
  6. * The numeric codes for report sections aren't designed to be bitshifted (they
  7. * are mutually exclusive options) so they are not powers of 2.
  8. * Formatting options may be use with bitwise addition etc.
  9. *
  10. * @author    Stuart Prescott
  11. * @copyright  Copyright Stuart Prescott
  12. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  13. * @version    $Id$
  14. * @package    Bumblebee
  15. * @subpackage Export
  16. */
  17.  
  18. /** Load ancillary functions */
  19. require_once 'inc/typeinfo.php';
  20. checkValidInclude();
  21.  
  22. /** use a user-defined function to create report */
  23. define('EXPORT_FORMAT_CUSTOM',         1);
  24. /** output format is a delimited format like CSV */
  25. define('EXPORT_FORMAT_DELIMITED',      2);
  26. /** comma separated variable format */
  27. define('EXPORT_FORMAT_CSV',            EXPORT_FORMAT_DELIMITED|4);
  28. /** tab separated variable format */
  29. define('EXPORT_FORMAT_TAB',            EXPORT_FORMAT_DELIMITED|8);
  30. /** delimited output bitmask */
  31. define('EXPORT_FORMAT_DELIMITED_MASK', EXPORT_FORMAT_CSV|EXPORT_FORMAT_TAB);
  32.  
  33. /** create a complex data array using {@link ArrayExport } */
  34. define('EXPORT_FORMAT_USEARRAY',  64);
  35. /** create an HTML representation of the report using {@link HTMLExport } */
  36. define('EXPORT_FORMAT_USEHTML',   128);
  37. /** Open the HTML in a new window */
  38. define('EXPORT_FORMAT_VIEWOPEN',  EXPORT_FORMAT_USEARRAY|EXPORT_FORMAT_USEHTML|256);
  39. /** Open the HTML in the existing window */
  40. define('EXPORT_FORMAT_VIEW',      EXPORT_FORMAT_USEARRAY|EXPORT_FORMAT_USEHTML|512);
  41. /** Export using a PDF */
  42. define('EXPORT_FORMAT_PDF',       EXPORT_FORMAT_USEARRAY|1024);
  43. /** bitmask for all exports using {@link ArrayExport } */
  44. define('EXPORT_FORMAT_USEARRAY_MASK', EXPORT_FORMAT_VIEWOPEN|EXPORT_FORMAT_PDF|EXPORT_FORMAT_VIEW);
  45. /** bitmask for all exports using {@link HTMLExport } */
  46. define('EXPORT_FORMAT_USEHTML_MASK',  EXPORT_FORMAT_VIEWOPEN|EXPORT_FORMAT_VIEW);
  47.  
  48. /** bitmask for all export formats */
  49. define('EXPORT_FORMAT_MASK',      EXPORT_FORMAT_USEARRAY_MASK|EXPORT_FORMAT_DELIMITED_MASK
  50.                                             |EXPORT_FORMAT_CUSTOM);
  51.  
  52. /** Start of the report (HTML and PDF reports) */
  53. define('EXPORT_REPORT_START',              1);
  54. /** End of the report (HTML and PDF reports) */
  55. define('EXPORT_REPORT_END',                2);
  56. /** Data for the report page header area */
  57. define('EXPORT_REPORT_HEADER',             3);
  58. /** Start of the section header for this part of the report */
  59. define('EXPORT_REPORT_SECTION_HEADER',     4);
  60. /** Start a data table in the report (HTML and PDF reports) */
  61. define('EXPORT_REPORT_TABLE_START',        5);
  62. /** Header row for the data table (HTML and PDF reports) */
  63. define('EXPORT_REPORT_TABLE_HEADER',       6);
  64. /** Data row in a data table (HTML and PDF reports) */
  65. define('EXPORT_REPORT_TABLE_ROW',          7);
  66. /** Totals row in a data table (HTML and PDF reports) */
  67. define('EXPORT_REPORT_TABLE_TOTAL',        8);
  68. /** Footer row in a data table (HTML and PDF reports)
  69. * @todo //TODO: EXPORT_REPORT_TABLE_FOOTER not implemented in styling */
  70. define('EXPORT_REPORT_TABLE_FOOTER',       9);
  71. /** End of data table (HTML and PDF reports) */
  72. define('EXPORT_REPORT_TABLE_END',         10);
  73.  
  74.  
  75. /** Formatting code: alignment descriptions */
  76. define('EXPORT_HTML_ALIGN',      1);
  77. /** Formatting code: centre output */
  78. define('EXPORT_HTML_CENTRE',     EXPORT_HTML_ALIGN|2);
  79. /** Formatting code: right align output */
  80. define('EXPORT_HTML_RIGHT',      EXPORT_HTML_ALIGN|4);
  81. /** Formatting code: left-align output */
  82. define('EXPORT_HTML_LEFT',       EXPORT_HTML_ALIGN|8);
  83. /** Formatting code: alignment bitmask */
  84. define('EXPORT_HTML_ALIGN_MASK', EXPORT_HTML_CENTRE|EXPORT_HTML_RIGHT|EXPORT_HTML_LEFT);
  85.  
  86. /** Formatting code: format as a number */
  87. define('EXPORT_HTML_NUMBER',       32);
  88. /** Formatting code: format as money (use defined currency symbol and 2 decimal places) */
  89. define('EXPORT_HTML_MONEY',        EXPORT_HTML_NUMBER|64);
  90. /** Formatting code: format to 1 decimal place, rounding appropriately */
  91. define('EXPORT_HTML_INTEGER',      EXPORT_HTML_NUMBER|128);  // round to integer
  92. /** Formatting code: format to 1 decimal place, rounding appropriately */
  93. define('EXPORT_HTML_DECIMAL_1',    EXPORT_HTML_NUMBER|256);  // round to 1 sig figs
  94. /** Formatting code: format to 2 decimal places, rounding appropriately */
  95. define('EXPORT_HTML_DECIMAL_2',    EXPORT_HTML_NUMBER|512);  // round to 2 sig figs
  96. /** Formatting code: format to x decimal places  bitmask */
  97. define('EXPORT_HTML_DECIMAL_MASK', EXPORT_HTML_INTEGER|EXPORT_HTML_DECIMAL_1|EXPORT_HTML_DECIMAL_2);
  98. /** Formatting code: format as a number bitmask */
  99. define('EXPORT_HTML_NUMBER_MASK',  EXPORT_HTML_MONEY|EXPORT_HTML_DECIMAL_MASK);
  100.  
  101. /** Formatting code: create an automatic total of the data for this column in the table */
  102. define('EXPORT_CALC_TOTAL',        2048);
  103.  
  104. /** Formatting code: format value as date-time according to locale settings */
  105. define('EXPORT_HTML_DATETIME',     4096);
  106. /** Formatting code: format value as date according to locale settings */
  107. define('EXPORT_HTML_DATE',         8192);
  108. /** Formatting code: format value as time according to locale settings */
  109. define('EXPORT_HTML_TIME',         16384);
  110.  
  111. /**
  112. * convert a string name for an export into the defined numeric code
  113. *
  114. * @param string $export_name  name of the exported variable
  115. * @return integer numeric code for the export name
  116. */
  117. function exportStringToCode($export_name) {
  118.   switch ($export_name) {
  119.     case 'EXPORT_FORMAT_CUSTOM':
  120.       return EXPORT_FORMAT_CUSTOM;
  121.     case 'EXPORT_FORMAT_VIEW':
  122.       return EXPORT_FORMAT_VIEW;
  123.     case 'EXPORT_FORMAT_VIEWOPEN':
  124.       return EXPORT_FORMAT_VIEWOPEN;
  125.     case 'EXPORT_FORMAT_CSV':
  126.       return EXPORT_FORMAT_CSV;
  127.     case 'EXPORT_FORMAT_TAB':
  128.       return EXPORT_FORMAT_TAB;
  129.     case 'EXPORT_FORMAT_PDF':
  130.       return EXPORT_FORMAT_PDF;
  131.   }
  132. }
  133.  
  134. ?>

Documentation generated on Tue, 06 Mar 2007 10:01:26 +0000 by phpDocumentor 1.3.0