[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> sponsorship_api.php (summary)

Sponsorship API

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 432 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SponsorshipData:: (14 methods):
  sponsorship_cache_row()
  sponsorship_clear_cache()
  sponsorship_exists()
  sponsorship_get_id()
  sponsorship_get()
  sponsorship_get_all_ids()
  sponsorship_get_amount()
  sponsorship_get_currency()
  sponsorship_format_amount()
  sponsorship_update_bug()
  sponsorship_set()
  sponsorship_delete()
  sponsorship_update_paid()
  sponsorship_update_date()


Class: SponsorshipData  - X-Ref

Sponsorship Data Structure Definition

sponsorship_cache_row( $p_sponsorship_id, $p_trigger_errors = true )   X-Ref
Cache a sponsorship row if necessary and return the cached copy
If the second parameter is true (default), trigger an error
if the sponsorship can't be found.  If the second parameter is
false, return false if the sponsorship can't be found.

param: int $p_sponsorship_id
param: bool $p_trigger_errors
return: array

sponsorship_clear_cache( $p_sponsorship_id = null )   X-Ref
Clear the sponsorship cache (or just the given id if specified)

param: int $p_sponsorship_id
return: null

sponsorship_exists( $p_sponsorship_id )   X-Ref
check to see if sponsorship exists by id
return true if it does, false otherwise

param: int $p_sponsorship_id
return: bool

sponsorship_get_id( $p_bug_id, $p_user_id = null )   X-Ref
return false if not found
otherwise returns sponsorship id

param: int $p_bug_id
param: int $p_user_id
return: int|false

sponsorship_get( $p_sponsorship_id )   X-Ref
get information about a sponsorship given its id

param: int $p_sponsorship_id
return: array

sponsorship_get_all_ids( $p_bug_id )   X-Ref
Return an array of Sponsorships associated with the specified bug id

param: int $p_bug_id
return: array

sponsorship_get_amount( $p_sponsorship_id )   X-Ref
Get the amount of sponsorships for the specified id(s)
handles the case where $p_sponsorship_id is an array or an id.

param: int $p_sponsorship_id
return: int

sponsorship_get_currency()   X-Ref
Return the currency used for all sponsorships

return: string

sponsorship_format_amount( $p_amount )   X-Ref
This function should return the string in a globalized format.

param: int $p_amount
return: string

sponsorship_update_bug( $p_bug_id )   X-Ref
Update bug to reflect sponsorship change
This is to be called after adding/updating/deleting sponsorships

param: int $p_bug_id
return: null

sponsorship_set( $p_sponsorship )   X-Ref
if sponsorship contains a non-zero id, then update the corresponding record.
if sponsorship contains a zero id, search for bug_id/user_id, if found, then update the entry
otherwise add a new entry

param: int $p_sponsorship
return: int

sponsorship_delete( $p_sponsorship_id )   X-Ref
delete a sponsorship given its id
id can be an array of ids or just an id.

param: int $p_sponsorship_id
return: null

sponsorship_update_paid( $p_sponsorship_id, $p_paid )   X-Ref
updates the paid field

param: int $p_sponsorship_id
param: int $p_paid
return: true

sponsorship_update_date( $p_sponsorship_id )   X-Ref
updates the last_updated field

param: int $p_sponsorship_id
return: true



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