phpDocumentor CoreAPI
ExcelAPI
[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]

Procedural File: excel_api.php

Source Location: /core/excel_api.php

Page Details

Excel API

Copyright:  Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
Copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Link:  http://www.mantisbt.org
Functions
excel_format_additional_information  [line 398]

The excel_format_additional_information( $p_additional_information $p_additional_information  )

Gets the formatted 'additional information' field.

Parameters:
$p_additional_information   $p_additional_information:  The additional information field.

API Tags:
Return:  formatted additional information (multi-line).


[ Top ]
excel_format_bugnotes_count  [line 178]

The excel_format_bugnotes_count( $p_bugnotes_count $p_bugnotes_count  )

Gets the formatted number of bug notes.

Parameters:
$p_bugnotes_count   $p_bugnotes_count:  The number of bug notes.

API Tags:
Return:  number of bug notes.


[ Top ]
excel_format_build  [line 326]

the excel_format_build( $p_build $p_build  )

Gets the formatted product build,

Parameters:
$p_build   $p_build:  The product build

API Tags:
Return:  product build.


[ Top ]
excel_format_category_id  [line 299]

the excel_format_category_id( $p_category $p_category_id  )

Gets the formatted category.

Parameters:
$p_category   $p_category_id:  The category

API Tags:
Return:  category.


[ Top ]
excel_format_column_title  [line 52]

The excel_format_column_title( $p_column_title  )

Generates a cell XML for a column title.

Parameters:
   $p_column_title: 

API Tags:
Return:  cell xml.


[ Top ]
excel_format_custom_field  [line 409]

The excel_format_custom_field( $p_issue_id $p_issue_id, $p_project_id $p_project_id, $p_custom_field $p_custom_field  )

Gets the formatted value for the specified issue id, project and custom field.

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

API Tags:
Return:  custom field value.


[ Top ]
excel_format_date_submitted  [line 344]

the excel_format_date_submitted( $p_date_submitted $p_date_submitted  )

Gets the formatted date submitted.

Parameters:
$p_date_submitted   $p_date_submitted:  The date submitted

API Tags:
Return:  date submitted in short date format.


[ Top ]
excel_format_description  [line 380]

The excel_format_description( $p_description $p_description  )

Gets the formatted description field.

Parameters:
$p_description   $p_description:  The description.

API Tags:
Return:  formatted description (multi-line).


[ Top ]
excel_format_eta  [line 245]

the excel_format_eta( $p_eta $p_eta  )

Gets the formatted eta.

Parameters:
$p_eta   $p_eta:  eta id.

API Tags:
Return:  eta text.


[ Top ]
excel_format_fixed_in_version  [line 281]

the excel_format_fixed_in_version( $p_fixed_in_version $p_fixed_in_version  )

Gets the formatted fixed in version.

Parameters:
$p_fixed_in_version   $p_fixed_in_version:  The product fixed in version

API Tags:
Return:  fixed in version.


[ Top ]
excel_format_handler_id  [line 187]

The excel_format_handler_id( $p_handler_id $p_handler_id  )

Gets the formatted handler id.

Parameters:
$p_handler_id   $p_handler_id:  The handler id.

API Tags:
Return:  handler user name or empty string.


[ Top ]
excel_format_id  [line 151]

The excel_format_id( $p_bug_id $p_bug_id  )

Gets the formatted bug id value.

Parameters:
$p_bug_id   $p_bug_id:  The bug id to be formatted.

API Tags:
Return:  bug id prefixed with 0s.


[ Top ]
excel_format_last_updated  [line 353]

the excel_format_last_updated( $p_last_updated $p_last_updated  )

Gets the formatted date last updated.

Parameters:
$p_last_updated   $p_last_updated:  The date last updated.

API Tags:
Return:  date last updated in short date format.


[ Top ]
excel_format_os  [line 308]

the excel_format_os( $p_os $p_os  )

Gets the formatted operating system.

Parameters:
$p_os   $p_os:  The operating system

API Tags:
Return:  operating system.


[ Top ]
excel_format_os_build  [line 317]

the excel_format_os_build( $p_os $p_os_build  )

Gets the formatted operating system build (version).

Parameters:
$p_os   $p_os_build:  The operating system build (version)

API Tags:
Return:  operating system build (version)


[ Top ]
excel_format_platform  [line 335]

the excel_format_platform( $p_platform $p_platform  )

Gets the formatted platform,

Parameters:
$p_platform   $p_platform:  The platform

API Tags:
Return:  platform.


[ Top ]
excel_format_priority  [line 200]

the excel_format_priority( $p_priority $p_priority  )

Gets the formatted priority.

Parameters:
$p_priority   $p_priority:  priority id.

API Tags:
Return:  priority text.


[ Top ]
excel_format_projection  [line 236]

the excel_format_projection( $p_projection $p_projection  )

Gets the formatted projection.

Parameters:
$p_projection   $p_projection:  projection id.

API Tags:
Return:  projection text.


[ Top ]
excel_format_project_id  [line 160]

The excel_format_project_id( $p_project_id $p_project_id  )

Gets the formatted project id value.

Parameters:
$p_project_id   $p_project_id:  The project id.

API Tags:
Return:  project name.


[ Top ]
excel_format_reporter_id  [line 169]

The excel_format_reporter_id( $p_reporter_id $p_reporter_id  )

Gets the formatted reporter id value.

Parameters:
$p_reporter_id   $p_reporter_id:  The reporter id.

API Tags:
Return:  reporter user name.


[ Top ]
excel_format_reproducibility  [line 218]

the excel_format_reproducibility( $p_reproducibility $p_reproducibility  )

Gets the formatted reproducibility.

Parameters:
$p_reproducibility   $p_reproducibility:  reproducibility id.

API Tags:
Return:  reproducibility text.


[ Top ]
excel_format_resolution  [line 263]

the excel_format_resolution( $p_resolution $p_resolution  )

Gets the resolution field.

Parameters:
$p_resolution   $p_resolution:  The resolution field.

API Tags:
Return:  formatted resolution.


[ Top ]
excel_format_selection  [line 371]

An excel_format_selection( $p_selection $p_param  )

Gets the formatted selection.

Parameters:
$p_selection   $p_param:  The selection value

API Tags:
Return:  formatted empty string.


[ Top ]
excel_format_severity  [line 209]

the excel_format_severity( $p_severity $p_severity  )

Gets the formatted severity.

Parameters:
$p_severity   $p_severity:  severity id.

API Tags:
Return:  severity text.


[ Top ]
excel_format_status  [line 254]

the excel_format_status( $p_status $p_status  )

Gets the status field.

Parameters:
$p_status   $p_status:  The status field.

API Tags:
Return:  formatted status.


[ Top ]
excel_format_steps_to_reproduce  [line 389]

The excel_format_steps_to_reproduce( $p_steps_to_reproduce $p_steps_to_reproduce  )

Gets the formatted 'steps to reproduce' field.

Parameters:
$p_steps_to_reproduce   $p_steps_to_reproduce:  The steps to reproduce.

API Tags:
Return:  formatted steps to reproduce (multi-line).


[ Top ]
excel_format_summary  [line 362]

the excel_format_summary( $p_summary $p_summary  )

Gets the summary field.

Parameters:
$p_summary   $p_summary:  The summary.

API Tags:
Return:  formatted summary.


[ Top ]
excel_format_target_version  [line 290]

the excel_format_target_version( $p_target_version $p_target_version  )

Gets the formatted target version.

Parameters:
$p_target_version   $p_target_version:  The target version

API Tags:
Return:  target version.


[ Top ]
excel_format_version  [line 272]

the excel_format_version( $p_version $p_version  )

Gets the formatted version.

Parameters:
$p_version   $p_version:  The product version

API Tags:
Return:  product version.


[ Top ]
excel_format_view_state  [line 227]

The excel_format_view_state( $p_view_state $p_view_state  )

Gets the formatted view state,

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

API Tags:
Return:  view state


[ Top ]
excel_get_columns  [line 135]

column excel_get_columns( )

Gets the columns to be included in the Excel Xml export.


API Tags:
Return:  names.


[ Top ]
excel_get_default_filename  [line 100]

file excel_get_default_filename( )

Gets the download file name for the Excel export. If 'All Projects' selected, default to <username>, otherwise default to <projectname>.


API Tags:
Return:  name without extension


[ Top ]
excel_get_end_row  [line 68]

The excel_get_end_row( )

Generates the xml for the end of an Excel row.


API Tags:
Return:  Row end tag.


[ Top ]
excel_get_footer  [line 44]

the excel_get_footer( )

A method that returns the footer for an Excel Xml file.


API Tags:
Return:  footer xml.


[ Top ]
excel_get_header  [line 32]

the excel_get_header( $p_worksheet_title $p_worksheet_title  )

A method that returns the header for an Excel Xml file.

Parameters:
$p_worksheet_title   $p_worksheet_title:  The worksheet title.

API Tags:
Return:  header Xml.


[ Top ]
excel_get_start_row  [line 60]

The excel_get_start_row( )

Generates the xml for the start of an Excel row.


API Tags:
Return:  Row tag.


[ Top ]
excel_get_titles_row  [line 76]

The excel_get_titles_row( )

Gets an Xml Row that contains all column titles.


API Tags:
Return:  xml row.


[ Top ]
excel_prepare_string  [line 117]

The excel_prepare_string( $p_value $p_value  )

Escapes the specified column value and includes it in a Cell Xml.

Parameters:
$p_value   $p_value:  The value

API Tags:
Return:  Cell Xml.


[ Top ]


Documentation generated on Sun, 05 Apr 2009 23:01:13 +0100 by phpDocumentor 1.4.1