| [ Index ] |
PHP Cross Reference of MantisBT |
[Source view] [Print] [Project Stats]
Version 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: | 696 lines (22 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
VersionData:: (21 methods):
__set()
__get()
version_cache_row()
version_exists()
version_is_unique()
version_ensure_exists()
version_ensure_unique()
version_add()
version_update()
version_remove()
version_remove_all()
version_cache_array_rows()
version_get_all_rows()
version_get_all_rows_with_subs()
version_get_id()
version_get_field()
version_full_name()
version_get()
version_prepare_db()
version_should_show_product_version()
version_get_project_where_clause()
Class: VersionData - X-Ref
Version Data Structure Definition| __set($name, $value) X-Ref |
param: string $name param: string $value |
| __get( $p_name ) X-Ref |
param: string $p_string |
| version_cache_row( $p_version_id, $p_trigger_errors = true ) X-Ref |
| Cache a version row if necessary and return the cached copy If the second parameter is true (default), trigger an error if the version can't be found. If the second parameter is false, return false if the version can't be found. param: int $p_version_id param: bool $p_trigger_errors return: array |
| version_exists( $p_version_id ) X-Ref |
| Check whether the version exists $p_project_id : null will use the current project, otherwise the specified project Returns true if the version exists, false otherwise param: int $p_version_id return: bool |
| version_is_unique( $p_version, $p_project_id = null ) X-Ref |
| Check whether the version name is unique Returns true if the name is unique, false otherwise param: string $p_version param: int $p_project_id return: bool |
| version_ensure_exists( $p_version_id ) X-Ref |
| Check whether the version exists Trigger an error if it does not param: int $p_version_id |
| version_ensure_unique( $p_version, $p_project_id = null ) X-Ref |
| Check whether the version is unique within a project Trigger an error if it is not param: string $p_version param: int $p_project_id |
| version_add( $p_project_id, $p_version, $p_released = VERSION_FUTURE, $p_description = '', $p_date_order = null, $p_obsolete = false ) X-Ref |
| Add a version to the project param: int $p_project_id param: string $p_version param: int $p_released param: string $p_description param: int $p_date_order param: bool $p_obsolete return: int |
| version_update( $p_version_info ) X-Ref |
| Update the definition of a version param: VersionData @p_version_info return: true |
| version_remove( $p_version_id, $p_new_version = '' ) X-Ref |
| Remove a version from the project param: int $p_version_id param: string $p_new_version return: true |
| version_remove_all( $p_project_id ) X-Ref |
| Remove all versions associated with a project param: int $p_project_id return: true |
| version_cache_array_rows( $p_project_id_array ) X-Ref |
| Cache version information for an array of project id's param: array $p_project_id_array return: null |
| version_get_all_rows( $p_project_id, $p_released = null, $p_obsolete = false, $p_inherit = null ) X-Ref |
| Return all versions for the specified project param: int $p_project_id param: int $p_released param: bool $p_obsolete return: array Array of version rows (in array format) |
| version_get_all_rows_with_subs( $p_project_id, $p_released = null, $p_obsolete = false ) X-Ref |
| Return all versions for the specified project, including subprojects param: int $p_project_id param: int $p_released param: bool $p_obsolete return: array |
| version_get_id( $p_version, $p_project_id = null, $p_inherit = null ) X-Ref |
| Get the version_id, given the project_id and $p_version_id returns false if not found, otherwise returns the id. param: string $p_version param: int $p_project_id param: mixed $p_inherit true to look for version in parent projects, false not to, null to use default configuration. return: int |
| version_get_field( $p_version_id, $p_field_name ) X-Ref |
| Get the specified field name for the specified version id. triggers an error if version not found, otherwise returns the field value. param: int $p_version_id param: string $p_field_name return: string |
| version_full_name( $p_version_id, $p_show_project = null, $p_current_project_id = null ) X-Ref |
| Gets the full name of a version. This may include the project name as a prefix (e.g. '[MantisBT] 1.2.0') param: int $p_version_id The version id. param: bool $p_show_project Whether to include the project or not, null means include the project if different from current. param: int $p_current_project_id The current project id or null to use the cookie. return: string The full name of the version. |
| version_get( $p_version_id ) X-Ref |
| get information about a version given its id param: int $p_version_id return: VersionData |
| version_prepare_db( $p_version_info ) X-Ref |
| Return a copy of the version structure with all the instvars prepared for db insertion param: VersionData $p_version_info return: VersionData |
| version_should_show_product_version( $p_project_id ) X-Ref |
| Checks whether the product version should be shown (i.e. report, update, view, print). param: integer $p_project_id The project id. return: bool true: show, false: otherwise. |
| version_get_project_where_clause( $p_project_id, $p_inherit ) X-Ref |
| Gets the where clause to use for retrieving versions. param: integer $p_project_id The project id to use. param: bool $p_inherit Include versions from parent projects? true: yes, false: no, null: use default configuration. return: string The where clause not including WHERE. |
| Generated: Thu Jul 28 15:48:31 2011 | Cross-referenced by PHPXref 0.7 |