[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> excel_api.php (summary)

Excel API

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 453 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 39 functions

  excel_get_header()
  excel_get_footer()
  excel_format_column_title()
  excel_get_start_row()
  excel_get_end_row()
  excel_get_titles_row()
  excel_get_default_filename()
  excel_prepare_string()
  excel_get_columns()
  excel_format_id()
  excel_format_project_id()
  excel_format_reporter_id()
  excel_format_bugnotes_count()
  excel_format_handler_id()
  excel_format_priority()
  excel_format_severity()
  excel_format_reproducibility()
  excel_format_view_state()
  excel_format_projection()
  excel_format_eta()
  excel_format_status()
  excel_format_resolution()
  excel_format_version()
  excel_format_fixed_in_version()
  excel_format_target_version()
  excel_format_category_id()
  excel_format_os()
  excel_format_os_build()
  excel_format_build()
  excel_format_platform()
  excel_format_date_submitted()
  excel_format_last_updated()
  excel_format_summary()
  excel_format_selection()
  excel_format_description()
  excel_format_steps_to_reproduce()
  excel_format_additional_information()
  excel_format_custom_field()
  excel_format_due_date()

Functions
Functions that are not part of a class:

excel_get_header( $p_worksheet_title )   X-Ref
A method that returns the header for an Excel Xml file.

returns: the header Xml.
param: $p_worksheet_title  The worksheet title.

excel_get_footer()   X-Ref
A method that returns the footer for an Excel Xml file.

returns: the footer xml.

excel_format_column_title( $p_column_title )   X-Ref
Generates a cell XML for a column title.

returns: The cell xml.

excel_get_start_row()   X-Ref
Generates the xml for the start of an Excel row.

returns: The Row tag.

excel_get_end_row()   X-Ref
Generates the xml for the end of an Excel row.

returns: The Row end tag.

excel_get_titles_row()   X-Ref
Gets an Xml Row that contains all column titles.

returns: The xml row.

excel_get_default_filename()   X-Ref
Gets the download file name for the Excel export.  If 'All Projects' selected, default to <username>,
otherwise default to <projectname>.

returns: file name without extension

excel_prepare_string( $p_value )   X-Ref
Escapes the specified column value and includes it in a Cell Xml.

returns: The Cell Xml.
param: $p_value The value

excel_get_columns()   X-Ref
Gets the columns to be included in the Excel Xml export.

returns: column names.

excel_format_id( $p_bug_id )   X-Ref
Gets the formatted bug id value.

returns: The bug id prefixed with 0s.
param: $p_bug_id  The bug id to be formatted.

excel_format_project_id( $p_project_id )   X-Ref
Gets the formatted project id value.

returns: The project name.
param: $p_project_id The project id.

excel_format_reporter_id( $p_reporter_id )   X-Ref
Gets the formatted reporter id value.

returns: The reporter user name.
param: $p_reporter_id The reporter id.

excel_format_bugnotes_count( $p_bugnotes_count )   X-Ref
Gets the formatted number of bug notes.

returns: The number of bug notes.
param: $p_bugnotes_count  The number of bug notes.

excel_format_handler_id( $p_handler_id )   X-Ref
Gets the formatted handler id.

returns: The handler user name or empty string.
param: $p_handler_id The handler id.

excel_format_priority( $p_priority )   X-Ref
Gets the formatted priority.

returns: the priority text.
param: $p_priority priority id.

excel_format_severity( $p_severity )   X-Ref
Gets the formatted severity.

returns: the severity text.
param: $p_severity severity id.

excel_format_reproducibility( $p_reproducibility )   X-Ref
Gets the formatted reproducibility.

returns: the reproducibility text.
param: $p_reproducibility reproducibility id.

excel_format_view_state( $p_view_state )   X-Ref
Gets the formatted view state,

returns: The view state
param: $p_view_state The view state (e.g. public vs. private)

excel_format_projection( $p_projection )   X-Ref
Gets the formatted projection.

returns: the projection text.
param: $p_projection projection id.

excel_format_eta( $p_eta )   X-Ref
Gets the formatted eta.

returns: the eta text.
param: $p_eta eta id.

excel_format_status( $p_status )   X-Ref
Gets the status field.

returns: the formatted status.
param: $p_status The status field.

excel_format_resolution( $p_resolution )   X-Ref
Gets the resolution field.

returns: the formatted resolution.
param: $p_resolution The resolution field.

excel_format_version( $p_version )   X-Ref
Gets the formatted version.

returns: the product version.
param: $p_version The product version

excel_format_fixed_in_version( $p_fixed_in_version )   X-Ref
Gets the formatted fixed in version.

returns: the fixed in version.
param: $p_fixed_in_version The product fixed in version

excel_format_target_version( $p_target_version )   X-Ref
Gets the formatted target version.

returns: the target version.
param: $p_target_version The target version

excel_format_category_id( $p_category_id )   X-Ref
Gets the formatted category.

returns: the category.
param: $p_category The category

excel_format_os( $p_os )   X-Ref
Gets the formatted operating system.

returns: the operating system.
param: $p_os The operating system

excel_format_os_build( $p_os_build )   X-Ref
Gets the formatted operating system build (version).

returns: the operating system build (version)
param: $p_os The operating system build (version)

excel_format_build( $p_build )   X-Ref
Gets the formatted product build,

returns: the product build.
param: $p_build The product build

excel_format_platform( $p_platform )   X-Ref
Gets the formatted platform,

returns: the platform.
param: $p_platform The platform

excel_format_date_submitted( $p_date_submitted )   X-Ref
Gets the formatted date submitted.

returns: the date submitted in short date format.
param: $p_date_submitted The date submitted

excel_format_last_updated( $p_last_updated )   X-Ref
Gets the formatted date last updated.

returns: the date last updated in short date format.
param: $p_last_updated The date last updated.

excel_format_summary( $p_summary )   X-Ref
Gets the summary field.

returns: the formatted summary.
param: $p_summary The summary.

excel_format_selection( $p_param )   X-Ref
Gets the formatted selection.

returns: An formatted empty string.
param: $p_selection The selection value

excel_format_description( $p_description )   X-Ref
Gets the formatted description field.

returns: The formatted description (multi-line).
param: $p_description The description.

excel_format_steps_to_reproduce( $p_steps_to_reproduce )   X-Ref
Gets the formatted 'steps to reproduce' field.

returns: The formatted steps to reproduce (multi-line).
param: $p_steps_to_reproduce The steps to reproduce.

excel_format_additional_information( $p_additional_information )   X-Ref
Gets the formatted 'additional information' field.

returns: The formatted additional information (multi-line).
param: $p_additional_information The additional information field.

excel_format_custom_field( $p_issue_id, $p_project_id, $p_custom_field )   X-Ref
Gets the formatted value for the specified issue id, project and custom field.

returns: The custom field value.
param: $p_issue_id The issue id.
param: $p_project_id The project id.
param: $p_custom_field The custom field name (without 'custom_' prefix).

excel_format_due_date( $p_due_date )   X-Ref
Gets the formatted due date.

returns: The formatted due date.
param: $p_due_date The due date.



Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7