/inc/exportcodes.php

Description
Description | Includes | Constants | Functions

Numeric codes for defining data export types and formats

Export types include TAB and Comma delimited, formats include the number of decimal places to use. The numeric codes for report sections aren't designed to be bitshifted (they are mutually exclusive options) so they are not powers of 2. Formatting options may be use with bitwise addition etc.

Includes
Description | Includes | Constants | Functions
require_once ('inc/typeinfo.php') (line 19)

Load ancillary functions

Constants
Description | Includes | Constants | Functions
EXPORT_CALC_TOTAL = 2048 (line 102)

Formatting code: create an automatic total of the data for this column in the table

EXPORT_FORMAT_CSV = EXPORT_FORMAT_DELIMITED|4 (line 27)

comma separated variable format

EXPORT_FORMAT_CUSTOM = 1 (line 23)

use a user-defined function to create report

EXPORT_FORMAT_DELIMITED = 2 (line 25)

output format is a delimited format like CSV

EXPORT_FORMAT_DELIMITED_MASK = EXPORT_FORMAT_CSV|EXPORT_FORMAT_TAB (line 31)

delimited output bitmask

EXPORT_FORMAT_MASK = EXPORT_FORMAT_USEARRAY_MASK|EXPORT_FORMAT_DELIMITED_MASK|EXPORT_FORMAT_CUSTOM (line 49)

bitmask for all export formats

EXPORT_FORMAT_PDF = EXPORT_FORMAT_USEARRAY|1024 (line 42)

Export using a PDF

EXPORT_FORMAT_TAB = EXPORT_FORMAT_DELIMITED|8 (line 29)

tab separated variable format

EXPORT_FORMAT_USEARRAY = 64 (line 34)

create a complex data array using ArrayExport

EXPORT_FORMAT_USEARRAY_MASK = EXPORT_FORMAT_VIEWOPEN|EXPORT_FORMAT_PDF|EXPORT_FORMAT_VIEW (line 44)

bitmask for all exports using ArrayExport

EXPORT_FORMAT_USEHTML = 128 (line 36)

create an HTML representation of the report using HTMLExport

EXPORT_FORMAT_USEHTML_MASK = EXPORT_FORMAT_VIEWOPEN|EXPORT_FORMAT_VIEW (line 46)

bitmask for all exports using HTMLExport

EXPORT_FORMAT_VIEW = EXPORT_FORMAT_USEARRAY|EXPORT_FORMAT_USEHTML|512 (line 40)

Open the HTML in the existing window

EXPORT_FORMAT_VIEWOPEN = EXPORT_FORMAT_USEARRAY|EXPORT_FORMAT_USEHTML|256 (line 38)

Open the HTML in a new window

EXPORT_HTML_ALIGN = 1 (line 76)

Formatting code: alignment descriptions

EXPORT_HTML_ALIGN_MASK = EXPORT_HTML_CENTRE|EXPORT_HTML_RIGHT|EXPORT_HTML_LEFT (line 84)

Formatting code: alignment bitmask

EXPORT_HTML_CENTRE = EXPORT_HTML_ALIGN|2 (line 78)

Formatting code: centre output

EXPORT_HTML_DATE = 8192 (line 107)

Formatting code: format value as date according to locale settings

EXPORT_HTML_DATETIME = 4096 (line 105)

Formatting code: format value as date-time according to locale settings

EXPORT_HTML_DECIMAL_1 = EXPORT_HTML_NUMBER|256 (line 93)

Formatting code: format to 1 decimal place, rounding appropriately

EXPORT_HTML_DECIMAL_2 = EXPORT_HTML_NUMBER|512 (line 95)

Formatting code: format to 2 decimal places, rounding appropriately

EXPORT_HTML_DECIMAL_MASK = EXPORT_HTML_INTEGER|EXPORT_HTML_DECIMAL_1|EXPORT_HTML_DECIMAL_2 (line 97)

Formatting code: format to x decimal places bitmask

EXPORT_HTML_INTEGER = EXPORT_HTML_NUMBER|128 (line 91)

Formatting code: format to 1 decimal place, rounding appropriately

EXPORT_HTML_LEFT = EXPORT_HTML_ALIGN|8 (line 82)

Formatting code: left-align output

EXPORT_HTML_MONEY = EXPORT_HTML_NUMBER|64 (line 89)

Formatting code: format as money (use defined currency symbol and 2 decimal places)

EXPORT_HTML_NUMBER = 32 (line 87)

Formatting code: format as a number

EXPORT_HTML_NUMBER_MASK = EXPORT_HTML_MONEY|EXPORT_HTML_DECIMAL_MASK (line 99)

Formatting code: format as a number bitmask

EXPORT_HTML_RIGHT = EXPORT_HTML_ALIGN|4 (line 80)

Formatting code: right align output

EXPORT_HTML_TIME = 16384 (line 109)

Formatting code: format value as time according to locale settings

EXPORT_REPORT_END = 2 (line 55)

End of the report (HTML and PDF reports)

EXPORT_REPORT_HEADER = 3 (line 57)

Data for the report page header area

EXPORT_REPORT_SECTION_HEADER = 4 (line 59)

Start of the section header for this part of the report

EXPORT_REPORT_START = 1 (line 53)

Start of the report (HTML and PDF reports)

EXPORT_REPORT_TABLE_END = 10 (line 72)

End of data table (HTML and PDF reports)

EXPORT_REPORT_TABLE_FOOTER = 9 (line 70)

Footer row in a data table (HTML and PDF reports)

  • todo: //TODO: EXPORT_REPORT_TABLE_FOOTER not implemented in styling
EXPORT_REPORT_TABLE_HEADER = 6 (line 63)

Header row for the data table (HTML and PDF reports)

EXPORT_REPORT_TABLE_ROW = 7 (line 65)

Data row in a data table (HTML and PDF reports)

EXPORT_REPORT_TABLE_START = 5 (line 61)

Start a data table in the report (HTML and PDF reports)

EXPORT_REPORT_TABLE_TOTAL = 8 (line 67)

Totals row in a data table (HTML and PDF reports)

Functions
Description | Includes | Constants | Functions
exportStringToCode (line 117)

convert a string name for an export into the defined numeric code

  • return: numeric code for the export name
integer exportStringToCode (string $export_name)
  • string $export_name: name of the exported variable

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