[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.status.php (summary)

(no description)

File Size: 789 lines (28 kb)
Included or required: 19 times
Referenced: 0 times
Includes or requires: 1 file
 include/class.error_handler.php

Defines 1 class

Status:: (23 methods):
  getProjectStatusCustomization()
  getCustomizationDetails()
  removeCustomization()
  updateCustomization()
  insertCustomization()
  getCustomizationList()
  hasClosedContext()
  insert()
  update()
  remove()
  addProjectAssociation()
  removeProjectAssociations()
  getDetails()
  getList()
  getAssociatedProjects()
  getStatusID()
  getStatusTitle()
  getClosedAbbreviationAssocList()
  getAbbreviationAssocList()
  getAssocStatusList()
  getAssocList()
  getClosedAssocList()
  getStatusColors()


Class: Status  - X-Ref

Class to handle all business logic related to the way statuses
are represented in the system.

getProjectStatusCustomization($prj_id, $sta_ids)   X-Ref
Returns the label and date field associated with the customization of
the given project and status IDs.

param: integer $prj_id The project ID
param: array $sta_ids The list of status IDs
return: array The label and date field

getCustomizationDetails($psd_id)   X-Ref
Returns the details of a given project status customization entry.

param: integer $psd_id The customization entry ID
return: array The details

removeCustomization($items)   X-Ref
Removes a given set of customizations.

param: array $items The customization entry IDs
return: boolean

updateCustomization($psd_id, $prj_id, $sta_id, $date_field, $label)   X-Ref
Method used to update the details of a customization entry in the system.

param: integer $psd_id The customization entry ID
param: integer $prj_id The project ID
param: integer $sta_id The status ID
param: string $date_field The date field name
param: string $label The label that should appear in the issue listing screen
return: integer 1 if the insert worked properly, any other value otherwise

insertCustomization($prj_id, $sta_id, $date_field, $label)   X-Ref
Method used to add a new customization entry to the system.

param: integer $prj_id The project ID
param: integer $sta_id The status ID
param: string $date_field The date field name
param: string $label The label that should appear in the issue listing screen
return: integer 1 if the insert worked properly, any other value otherwise

getCustomizationList()   X-Ref
Method used to get a list of all existing customizations.

return: array The list of available customizations

hasClosedContext($sta_id)   X-Ref
Method used to check whether the given status has a closed context or
not.

return: boolean

insert()   X-Ref
Method used to add a new custom status to the system.

return: integer 1 if the insert worked properly, any other value otherwise

update()   X-Ref
Method used to update the details of a given custom status.

return: integer 1 if the update worked properly, any other value otherwise

remove()   X-Ref
Method used to remove a set of custom statuses.

return: boolean

addProjectAssociation($sta_id, $prj_id)   X-Ref
Method used to add a project association to a status.

param: integer $sta_id The status ID
param: integer $prj_id The project ID
return: void

removeProjectAssociations($sta_id, $prj_id=FALSE)   X-Ref
Method used to remove the project associations for a given
custom status.

param: integer $sta_id The custom status ID
param: integer $prj_id The project ID
return: boolean

getDetails($sta_id)   X-Ref
Method used to get the details of a given status ID.

param: integer $sta_id The custom status ID
return: array The status details

getList()   X-Ref
Method used to get the list of statuses ordered by title.

return: array The list of statuses

getAssociatedProjects($sta_id)   X-Ref
Method used to get the list of associated projects for a given
custom status.

param: integer $sta_id The custom status ID
return: array The list of projects

getStatusID($sta_title)   X-Ref
Method used to get the status ID for a given status title.

param: string $sta_title The status title
return: integer The status ID

getStatusTitle($sta_id)   X-Ref
Method used to get the status title for a given status ID.

param: integer $sta_id The status ID
return: string The status title

getClosedAbbreviationAssocList($prj_id)   X-Ref
Method used to get the list of available closed-context statuses as an
associative array in the style of (abbreviation => title)

param: array $prj_id List of project IDs
return: array The list of closed-context statuses

getAbbreviationAssocList($prj_id, $show_closed)   X-Ref
Method used to get the list of available statuses as an associative array
in the style of (abbreviation => title)

param: array $prj_id List of project IDs
param: boolean $show_closed Whether to also return closed-context statuses or not
return: array The list of statuses

getAssocStatusList($prj_id, $show_closed = TRUE)   X-Ref
Method used to get the list of available statuses as an associative array
in the style of (id => title)

param: array $prj_id List of project IDs
param: boolean $show_closed Whether to show closed context statuses or not
return: array The list of statuses

getAssocList()   X-Ref
Method used to get the list of available statuses as an associative array
in the style of (id => title)

return: array The list of statuses

getClosedAssocList($prj_id)   X-Ref
Method used to get the list of available statuses as an associative array
in the style of (id => title). Only return the list of statuses that have
a 'closed' context.

param: integer $prj_id The project ID
return: array The list of statuses

getStatusColors()   X-Ref
Method used to get the list of statuses and their respective colors

return: array List of statuses



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7