[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

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

(no description)

File Size: 385 lines (14 kb)
Included or required: 13 times
Referenced: 0 times
Includes or requires: 3 files
 include/class.misc.php
 include/class.validation.php
 include/class.error_handler.php

Defines 1 class

Priority:: (11 methods):
  changeRank()
  _getRanking()
  getDetails()
  removeByProjects()
  remove()
  update()
  insert()
  getList()
  getTitle()
  getAssocList()
  getPriorityID()


Class: Priority  - X-Ref

Class to handle project priority related issues.

changeRank($prj_id, $pri_id, $rank_type)   X-Ref
Method used to quickly change the ranking of a reminder entry
from the administration screen.

param: integer $pri_id The reminder entry ID
param: string $rank_type Whether we should change the reminder ID down or up (options are 'asc' or 'desc')
return: boolean

_getRanking($prj_id)   X-Ref
Returns an associative array with the list of reminder IDs and
their respective ranking.

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

getDetails($pri_id)   X-Ref
Method used to get the full details of a priority.

param: integer $pri_id The priority ID
return: array The information about the priority provided

removeByProjects($ids)   X-Ref
Method used to remove all priorities related to a set of
specific projects.

param: array $ids The project IDs to be removed
return: boolean Whether the removal worked or not

remove()   X-Ref
Method used to remove user-selected priorities from the
database.

return: boolean Whether the removal worked or not

update()   X-Ref
Method used to update the values stored in the database.
Typically the user would modify the title of the priority in
the application and this method would be called.

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

insert()   X-Ref
Method used to add a new priority to the application.

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

getList($prj_id)   X-Ref
Method used to get the full list of priorities associated with
a specific project.

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

getTitle($pri_id)   X-Ref
Method used to get the title for a priority ID.

param: integer $pri_id The priority ID
return: string The priority title

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

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

getPriorityID($prj_id, $pri_title)   X-Ref
Method used to get the pri_id of a project by priority title.

param: integer $prj_id The project ID
param: integer $pri_id The priority ID
param: string $pri_title The priority title
return: integer $pri_id The priority ID



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