[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 1117 lines (40 kb)
Included or required: 38 times
Referenced: 0 times
Includes or requires: 12 files
 include/class.filter.php
 include/class.support.php
 include/class.status.php
 include/class.validation.php
 include/class.group.php
 include/class.display_column.php
 include/class.misc.php
 include/class.date.php
 include/class.release.php
 include/class.error_handler.php
 include/class.issue.php
 include/class.category.php

Defines 1 class

Project:: (30 methods):
  getOutgoingSenderAddress()
  getInitialStatus()
  getAnonymousPostOptions()
  updateAnonymousPost()
  getAnonymousList()
  exists()
  getID()
  getName()
  getSegregateReporters()
  getDetails()
  remove()
  removeUserByProjects()
  update()
  associateUser()
  insert()
  getList()
  getAssocList()
  getUserAssocList()
  getUserColList()
  getAll()
  getAddressBookEmails()
  getAddressBook()
  getAddressBookAssocList()
  getRemoteAssocList()
  getRemoteAssocListByUser()
  getUserEmailAssocList()
  getReporters()
  updateFieldDisplaySettings()
  getFieldDisplaySettings()
  getDisplayFields()


Class: Project  - X-Ref

Class to handle the business logic related to the administration
of projects in the system.

getOutgoingSenderAddress($prj_id)   X-Ref
Method used to get the outgoing email sender address associated with
a given project.

param: integer $prj_id The project ID
return: array The outgoing sender information

getInitialStatus($prj_id)   X-Ref
Method used to get the initial status that should be set to a new issue
created and associated with a given project.

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

getAnonymousPostOptions($prj_id)   X-Ref
Method used to get the options related to the anonymous posting
of new issues.

param: integer $prj_id The project ID
return: array The anonymous posting options

updateAnonymousPost($prj_id)   X-Ref
Method used to update the anonymous posting related options.

param: integer $prj_id The project ID
return: integer 1 if the update worked, -1 otherwise

getAnonymousList()   X-Ref
Method used to get the list of projects that allow anonymous
posting of new issues.

return: array The list of projects

exists($prj_id)   X-Ref
Method used to check whether a project exists or not.

param: integer $prj_id The project ID
return: boolean

getID($prj_title)   X-Ref
Method used to get the project ID of the given project title.

param: string $prj_title The project title
return: integer The project ID

getName($prj_id)   X-Ref
Method used to get the title of a given project ID.

param: integer $prj_id The project ID
return: string The project title

getSegregateReporters($prj_id)   X-Ref
Method used to get if reporters should be segregated for a project ID

param: integer $prj_id The project ID
return: boolean If reporters should be segregated

getDetails($prj_id)   X-Ref
Method used to get the details for a given project ID.

param: integer $prj_id The project ID
return: array The project details

remove()   X-Ref
Method used to remove a given set of projects from the system.

return: boolean

removeUserByProjects($ids, $users_to_not_remove = false)   X-Ref
Method used to remove all project/user associations for a given
set of projects.

param: array $ids The project IDs
param: array $users_to_not_remove Users that should not be removed
return: boolean

update()   X-Ref
Method used to update the details of the project information.

return: integer 1 if the update worked, -1 otherwise

associateUser($prj_id, $usr_id, $role)   X-Ref
Method used to associate an user to a project. If the user association already exists
no change will be made.

param: integer $prj_id The project ID
param: integer $usr_id The user ID
param: integer $role The role of the user
return: boolean

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

return: integer 1 if the update worked, -1 or -2 otherwise

getList()   X-Ref
Method used to get the list of projects available in the
system.

return: array The list of projects

getAssocList($usr_id, $force_refresh = false, $include_role = false)   X-Ref
Method used to get an associative array of project ID and title
of all projects available in the system to a given user ID.

param: integer $usr_id The user ID
param: boolean $force_refresh If the cache should not be used.
param: boolean $include_role if the user role should be included.
return: array The list of projects

getUserAssocList($prj_id, $status = NULL, $role = NULL)   X-Ref
Method used to get the list of users associated with a given project.

param: integer $prj_id The project ID
param: string $status The desired user status
param: integer $role The role ID of the user
return: array The list of users

getUserColList($prj_id)   X-Ref
Method used to get a list of user IDs associated with a given
project.

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

getAll($include_no_customer_association = TRUE)   X-Ref
Method used to get an associative array of project ID and title
of all projects that exist in the system.

param: boolean $include_no_customer_association Whether to include in the results projects with customer integration or not
return: array List of projects

getAddressBookEmails($prj_id, $issue_id)   X-Ref
Method used to get a list of emails that are associated with a given
project and issue.

param: integer $prj_id The project ID
param: integer $issue_id The issue ID
return: array List of emails

getAddressBook($prj_id, $issue_id = FALSE)   X-Ref
Method used to get a list of names and emails that are
associated with a given project and issue.

param: integer $prj_id The project ID
param: integer $issue_id The issue ID
return: array List of names and emails

getAddressBookAssocList($prj_id, $issue_id = FALSE)   X-Ref
Method used to get an associative array of names and emails
that are associated with a given project and issue.

param: integer $prj_id The project ID
param: integer $issue_id The issue ID
return: array List of names and emails

getRemoteAssocList()   X-Ref
Method used to get the list of projects that allow remote
invocation of issues.

return: array The list of projects

getRemoteAssocListByUser($usr_id, $only_customer_projects = FALSE)   X-Ref
Method used to get the list of projects assigned to a given user that
allow remote invocation of issues.

param: integer $usr_id The user ID
param: boolean $only_customer_projects Whether to only include projects with customer integration or not
return: array The list of projects

getUserEmailAssocList($prj_id, $status = NULL, $role = NULL)   X-Ref
Method used to get the list of users associated with a given project.

param: integer $prj_id The project ID
param: string $status The desired user status
return: array The list of users

getReporters($prj_id)   X-Ref
Method used to get the list of users associated with a given project.

param: integer $prj_id The project ID
param: string $status The desired user status
return: array The list of users

updateFieldDisplaySettings($prj_id, $settings)   X-Ref
Sets the minimum role needed to view a specific field on the issue creation form.

param: integer $prj_id The project ID.
param: array $settings An array of fields and role is required to view them.
return: integer 1 if the update worked, -1 otherwise.

getFieldDisplaySettings($prj_id)   X-Ref
Returns display settings for a specific project.

param: integer $prj_id The project ID
return: array An associative array of minimum role required to access a field.

getDisplayFields()   X-Ref
Returns an array of fields which can be hidden.

return: array



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