Milestone Class Reference

List of all members.

Public Member Functions
	newFromId ($milestone_id, $id=2147483647)
	newFromIndex ($id=2147483647)
	newFromTitle ($milestone_title, $id=2147483647)
	Milestone ($data)
	getId ()
	getActivity ()
	getMilestoneId ()
	getOrder ()
	getParent ()
	prepareParents ()
	getRevisionByDate ($date)
	getTitle ()
	getStatus ()
	getModification ()
	getProject ()
	getLeaders ()
	getPeople ()
	getPeopleText ()
	getDescription ()
	getEndUser ()
	getEditedBy ()
	getStartDate ()
	getEndDate ()
	getQuarters ()
	getVeryStartDate ()
	isNew ()
	getProjectedEndDate ()
	getComment ()
	getCreated ()
Public Attributes
	$id
	$activity
	$milestone_id
	$order
	$parent
	$project
	$leader
	$people
	$peopleText
	$peopleWaiting
	$title
	$status
	$modification
	$description
	$endUser
	$parentWaiting
	$editedBy
	$start_date
	$end_date
	$quarters
	$comment
	$created
Static Public Attributes
static	$cache = array()
static	$statuses
static	$fesStatuses
static	$modifications
static	$endUsers

---

Member Function Documentation

Milestone::getActivity

(

)

Returns the Activity associated with this Milestone (null if there is no activity)

Returns:

Activity The Activity associated with this Milestone

Milestone::getComment

(

)

Returns the comment of this Milestone

Returns:

string The comment of this Milestone

Milestone::getDescription

(

)

Returns the description of this Milestone

Returns:

string The description of this Milestone

Milestone::getEditedBy

(

)

Returns the Person who modified this Milestone revision

Returns:

Person The Person who modified this Milestone revision

Milestone::getEndDate

(

)

Returns the end date of this Milestone

Returns:

string The end date of this Milestone

Milestone::getEndUser

(

)

Returns the 'end user' of this Milestone

Returns:

string The 'end user' of this Milestone

Milestone::getId

(

)

Returns the revision id of this Milestone

Returns:

integer The revision id of this Milestone

Milestone::getLeaders

(

)

Returns the People who leads this Milestone

Returns:

array The People who leads this Milestone

Milestone::getMilestoneId

(

)

Returns the id of this Milestone

Returns:

integer The id of this Milestone

Milestone::getModification

(

)

Returns the modification of this Milestone

Returns:

string The modification of this Milestone

Milestone::getOrder

(

)

Returns the order of this Milestone

Returns:

integer The order of this Milestone

Milestone::getParent

(

)

Returns the parent of this Milestone (Lazy to help avoid potential infinite loops, and to improve performance on Object construction)

Returns:

Milestone the parent of this Milestone

Milestone::getPeople

(

)

Returns the People involved in this Milestone revision

Returns:

array The People involved in this Milestone revision

Milestone::getPeopleText

(

)

Returns the People involved in this Milestone revision

Returns:

array The People involved in this Milestone revision

Milestone::getProject

(

)

Returns the Project that this Milestone belongs to

Returns:

Project The Project that this Milestone belongs to

Milestone::getProjectedEndDate

(

)

Returns the projected end date of this Milestone

Returns:

string The projected end date of this Milestone

Milestone::getQuarters

(

)

Returns which quarters of for each year this milestone is to take place

Returns:

array The quarters for each year

Milestone::getRevisionByDate

(

$

date

)

Returns the Milestone revision closest to the given date

Parameters:

string

$date The date of the revision

Returns:

Milestone The revision closest to the given date

Milestone::getStartDate

(

)

Returns the start date of this Milestone

Returns:

string The start date of this Milestone

Milestone::getStatus

(

)

Returns the status of this Milestone

Returns:

string The status of this Milestone

Milestone::getTitle

(

)

Return the title of this Milestone

Returns:

string The title of this Milestone

Milestone::getVeryStartDate

(

)

Returns the start date of the very first revision of this Milestone NOTE: This method may be slow if there are many revisions

Returns:

string The start date of the very first revision of this Milestone

Milestone::newFromId	(	$	milestone_id,
		$	id = 2147483647
	)

Creates a Milestone from the given milestone_id and id

Parameters:

	integer	$milestone_id The id of the milestone
	integer	$id The id of the revision (optional)

Returns:

Milestone The milestone

Milestone::newFromIndex

(

$

id = 2147483647

)

Creates a Milestone from the given revision id

Parameters:

integer

$id The id of the revision

Returns:

Milestone The milestone

Milestone::newFromTitle	(	$	milestone_title,
		$	id = 2147483647
	)

Creates a new Milestone from the given title and revision id

Parameters:

	string	$milestone_title The title of the Milestone
	integer	$id The revision id of the Milestone

Returns:

Milestone The Milestone

---

Member Data Documentation

Milestone::$endUsers [static]

Initial value:

 array("",
                             "Researchers",
                             "Policymakers",
                             "Government Officials",
                             "Funders",
                             "Media",
                             "General Public",
                             "Other")

Milestone::$fesStatuses [static]

Initial value:

 array("New" => "#BBBBBB",
                                "Completed" => "#3399FF",
                                "Pending" => "#55BB55",
                                "Abandoned" => "#FF6666")

Milestone::$modifications [static]

Initial value:

 array("" => "transparent", 
                                  "Revised" => "#0000FF", 
                                  "Postponed" => "#FF0000")

Milestone::$statuses [static]

Initial value:

 array("New" => "#BBBBBB",
                             "Completed" => "#3399FF",
                             "On Going" => "#55BB55",
                             "Late" => "#FFDD00",
                             "Problem" => "#FF8800",
                             "Abandoned" => "#FF6666")

---

The documentation for this class was generated from the following file:

• extensions/GrandObjects/Milestone.php