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

Procedural File: csv_api.php

Source Location: /core/csv_api.php

Page Details

CSV API Names for formatting functions are csv_format_*, where * corresponds to the field name as return get csv_get_columns() and by the filter 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
csv_escape_string  [line 71]

TODO csv_escape_string( $p_str, type $todo  )

escape a string before writing it to csv file.

Parameters:
type   $todo:  TODO
   $p_str: 

API Tags:
Access:  public


[ Top ]
csv_format_additional_information  [line 335]

string csv_format_additional_information( string $p_additional_information  )

return the additional information

Parameters:
string   $p_additional_information: 

API Tags:
Return:  formatted additional information
Access:  public


[ Top ]
csv_format_build  [line 265]

string csv_format_build( string $p_build  )

return the build

Parameters:
string   $p_build: 

API Tags:
Return:  formatted build
Access:  public


[ Top ]
csv_format_category_id  [line 215]

string csv_format_category_id( int $p_category_id  )

return the category

Parameters:
int   $p_category_id: 

API Tags:
Return:  formatted category string
Access:  public


[ Top ]
csv_format_date_submitted  [line 225]

string csv_format_date_submitted( string $p_date_submitted  )

return the date submitted

Parameters:
string   $p_date_submitted: 

API Tags:
Return:  formatted date
Access:  public


[ Top ]
csv_format_description  [line 315]

string csv_format_description( string $p_description  )

return the description

Parameters:
string   $p_description:  description

API Tags:
Return:  formatted description
Access:  public


[ Top ]
csv_format_duplicate_id  [line 365]

string csv_format_duplicate_id( int $p_duplicate_id  )

return the duplicate bug id

Parameters:
int   $p_duplicate_id: 

API Tags:
Return:  formatted bug id
Access:  public


[ Top ]
csv_format_eta  [line 235]

string csv_format_eta( int $p_eta  )

return the eta

Parameters:
int   $p_eta:  eta

API Tags:
Return:  formatted eta
Access:  public


[ Top ]
csv_format_fixed_in_version  [line 185]

string csv_format_fixed_in_version( string $p_fixed_in_version  )

return the fixed_in_version

Parameters:
string   $p_fixed_in_version:  fixed in version string

API Tags:
Return:  formatted fixed in version string
Access:  public


[ Top ]
csv_format_handler_id  [line 133]

string csv_format_handler_id( int $p_handler_id  )

returns the handler name corresponding to the supplied id

Parameters:
int   $p_handler_id:  user id

API Tags:
Return:  formatted user name
Access:  public


[ Top ]
csv_format_id  [line 103]

string csv_format_id( int $p_bug_id  )

format bug id

Parameters:
int   $p_bug_id:  bug id

API Tags:
Return:  csv formatted bug
Access:  public


[ Top ]
csv_format_last_updated  [line 295]

string csv_format_last_updated( string $p_last_updated  )

return the last updated date

Parameters:
string   $p_last_updated:  last updated

API Tags:
Return:  formated last updated string
Access:  public


[ Top ]
csv_format_os  [line 245]

string csv_format_os( string $p_os  )

return the operating system

Parameters:
string   $p_os:  operating system

API Tags:
Return:  formatted operating system
Access:  public


[ Top ]
csv_format_os_build  [line 255]

string csv_format_os_build( string $p_os_build  )

return the os build (os version)

Parameters:
string   $p_os_build:  operating system build

API Tags:
Return:  formatted operating system build
Access:  public


[ Top ]
csv_format_platform  [line 275]

string csv_format_platform( string $p_platform  )

return the platform

Parameters:
string   $p_platform:  platform

API Tags:
Return:  formatted platform
Access:  public


[ Top ]
csv_format_priority  [line 145]

string csv_format_priority( int $p_priority  )

return the priority string

Parameters:
int   $p_priority: 

API Tags:
Return:  formatted priority string
Access:  public


[ Top ]
csv_format_projection  [line 205]

string csv_format_projection( int $p_projection  )

return the projection

Parameters:
int   $p_projection: 

API Tags:
Return:  formatted projection string
Access:  public


[ Top ]
csv_format_project_id  [line 113]

string csv_format_project_id( int $p_project_id  )

returns the project name corresponding to the supplied project id.

Parameters:
int   $p_project_id:  project id

API Tags:
Return:  csv formatted project name
Access:  public


[ Top ]
csv_format_reporter_id  [line 123]

string csv_format_reporter_id( int $p_reporter_id  )

returns the reporter name corresponding to the supplied id.

Parameters:
int   $p_reporter_id:  user id

API Tags:
Return:  formatted user name
Access:  public


[ Top ]
csv_format_reproducibility  [line 165]

string csv_format_reproducibility( int $p_reproducibility  )

return the reproducability string

Parameters:
int   $p_reproducibility: 

API Tags:
Return:  formatted reproducibility string
Access:  public


[ Top ]
csv_format_resolution  [line 355]

string csv_format_resolution( int $p_resolution  )

return the resolution string

Parameters:
int   $p_resolution:  resolution

API Tags:
Return:  formatted resolution string
Access:  public


[ Top ]
csv_format_selection  [line 375]

string csv_format_selection( int $p_duplicate_id  )

return the selection

Parameters:
int   $p_duplicate_id: 

API Tags:
Access:  public


[ Top ]
csv_format_severity  [line 155]

string csv_format_severity( int $p_severity  )

return the severity string

Parameters:
int   $p_severity: 

API Tags:
Return:  formatted severity string
Access:  public


[ Top ]
csv_format_status  [line 345]

string csv_format_status( string $p_status  )

return the status string

Parameters:
string   $p_status:  status

API Tags:
Return:  formatted status
Access:  public


[ Top ]
csv_format_steps_to_reproduce  [line 325]

string csv_format_steps_to_reproduce( string $p_steps_to_reproduce  )

return the steps to reproduce

Parameters:
string   $p_steps_to_reproduce:  steps to reproduce

API Tags:
Return:  formatted steps to reproduce
Access:  public


[ Top ]
csv_format_summary  [line 305]

string csv_format_summary( string $p_summary  )

return the summary

Parameters:
string   $p_summary:  summary

API Tags:
Return:  formatted summary
Access:  public


[ Top ]
csv_format_target_version  [line 195]

string csv_format_target_version( string $p_target_version  )

return the target_version

Parameters:
string   $p_target_version:  target version string

API Tags:
Return:  formatted target version string
Access:  public


[ Top ]
csv_format_version  [line 175]

string csv_format_version( string $p_version  )

return the version

Parameters:
string   $p_version:  version string

API Tags:
Return:  formatted version string
Access:  public


[ Top ]
csv_format_view_state  [line 285]

string csv_format_view_state( int $p_view_state  )

return the view state (eg: private / public)

Parameters:
int   $p_view_state:  view state

API Tags:
Return:  formatted view state
Access:  public


[ Top ]
csv_get_columns  [line 92]

TODO csv_get_columns( [type $todo = TODO]  )

An array of column names that are used to identify fields to include and in which order.

Parameters:
type   $todo:  TODO

API Tags:
Access:  public


[ Top ]
csv_get_default_filename  [line 53]

string csv_get_default_filename( )

if all projects selected, default to <username>.csv, otherwise default to <projectname>.csv.


API Tags:
Return:  filename
Access:  public


[ Top ]
csv_get_newline  [line 34]

string csv_get_newline( )

get the csv file new line, can be moved to config in the future


API Tags:
Return:  containing new line character
Access:  public


[ Top ]
csv_get_separator  [line 43]

string csv_get_separator( )

get the csv file separator, can be moved to config in the future


API Tags:
Access:  public


[ Top ]


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