[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/api/soap/ -> mc_enum_api.php (summary)

(no description)

File Size: 322 lines (10 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 18 functions

  mc_enum_status()
  mc_enum_priorities()
  mc_enum_severities()
  mc_enum_reproducibilities()
  mc_enum_projections()
  mc_enum_etas()
  mc_enum_resolutions()
  mc_enum_access_levels()
  mc_enum_project_status()
  mc_enum_project_view_states()
  mc_enum_view_states()
  mc_enum_custom_field_types()
  mc_enum_get()
  mci_explode_to_objectref()
  mci_validate_enum_access()
  mci_enum_get_array_by_id()
  mci_get_enum_value_from_label()
  mci_get_enum_id_from_objectref()

Functions
Functions that are not part of a class:

mc_enum_status( $p_username, $p_password )   X-Ref
Get all available status.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_priorities( $p_username, $p_password )   X-Ref
Get all available priorities.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_severities( $p_username, $p_password )   X-Ref
Get all available severities.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_reproducibilities( $p_username, $p_password )   X-Ref
Get all available reproducibilities.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_projections( $p_username, $p_password )   X-Ref
Get all available projections.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_etas( $p_username, $p_password )   X-Ref
Get all available etas.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_resolutions( $p_username, $p_password )   X-Ref
Get all available resolutions.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_access_levels( $p_username, $p_password )   X-Ref
Get all available access levels.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_project_status( $p_username, $p_password )   X-Ref
Get all available project status.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_project_view_states( $p_username, $p_password )   X-Ref
Get all available project view states.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_view_states( $p_username, $p_password )   X-Ref
Get all available view states.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_custom_field_types( $p_username, $p_password )   X-Ref
Get all available custom field types.

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
return: Array  The requested enumeration

mc_enum_get( $p_username, $p_password, $p_enumeration )   X-Ref
Get an appropriate enumeration. (Should become an internal function.)

param: string $p_username  The name of the user trying to access the enumeration.
param: string $p_password  The password of the user.
param: string $p_enumeration  The enumeration to get.
return: string  The requested enumeration.

mci_explode_to_objectref( $p_enumeration_name )   X-Ref
Explode a configuration enumeration name into an array structure that can
be safely converted into an ObjectRef structure.

param: string $p_enumeration_name  The name of the enumeration to convert
return: Array  The converted enumeration

mci_validate_enum_access($p_username, $p_password)   X-Ref
Validates that the user has access to the enumeration values

param: string $p_username
param: string $p_password
return: boolean true if the user has access, false otherwise

mci_enum_get_array_by_id( $p_enum_id, $p_enum_type, $p_lang )   X-Ref
Get a localized enumeration element.

param: integer $p_enum_id  The id of the enumeration element to retrieve.
param: String $p_enum_type  The type of the enumeration element (e.g. 'status', 'reproducibility' etc.).
param: String $p_lang  The language for the name field.
return: Array an Array containing the id and the name of the enumeration element.

mci_get_enum_value_from_label( $p_enum_string, $p_label )   X-Ref
Get the enum id given the enum label.

param: $p_enum_string   The enum string to search in.
param: $p_label         The label to search for.
return: The id corresponding to the given label, or 0 if not found.

mci_get_enum_id_from_objectref( $p_enum, $p_object_ref )   X-Ref
Get the enumeration id given an object ref.  The id is set based on the following algorithm:
- id from objectref.
- id corresponding to name in object ref.
- default value for the specified enumeration, if exists in configuration.
- first id, if object ref doesn't contain an id or a name.

param: string     $p_enum         The name of the enumeration as in the MantisBT configuration file
param: ObjectRef  $p_object_ref   An associate array with "id" and "name" keys.
return: enum id



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