UploadCCVAPI Class Reference

Inheritance diagram for UploadCCVAPI:

List of all members.

Public Member Functions
	UploadCCVAPI ()
	processParams ($params)
	createProduct ($person, $paper, $category, $type, $ccv_id, $overwrite=false)
	createHQP ($supervisor, $hqp)
	updatePersonalInfo ($person, $info)
	updateEmployment ($person, $employment)
	updateKeywords ($person, $keywords)
	doAction ($noEcho=false)
	isLoginRequired ()
Public Attributes
	$structure = null
Static Public Attributes
static	$diplomaMap
static	$genderMap
static	$honorificMap
static	$languageMap

---

Member Function Documentation

UploadCCVAPI::createHQP	(	$	supervisor,
		$	hqp
	)

Creates or updates an HQP

Parameters:

	Person	$supervisor The supervisor for the HQP
	array	$hqp The array containing the ccv data for the HQP

Returns:

boolean The status of the creation

UploadCCVAPI::createProduct	(	$	person,
		$	paper,
		$	category,
		$	type,
		$	ccv_id,
		$	overwrite = false
	)

Creates a new Product if it doesn't already exist

Parameters:

	Person	$person The Person creating the product
	array	$paper The array containing the ccv data for the Product
	string	$category The category of the new Product
	string	$type The type of the new Product
	string	$ccv_id The id of the Product in the ccv

Returns:

Product the new Product

UploadCCVAPI::isLoginRequired

(

)

Returns:

boolean Returns whether or not a login is required to execute this action

Reimplemented from API.

UploadCCVAPI::processParams

(

$

params

)

Does some pre-proccessing to the parameters

Parameters:

array

$params The array of GET parameters

Reimplemented from API.

UploadCCVAPI::updateEmployment	(	$	person,
		$	employment
	)

Adds the employment information to the person's history

Parameters:

	Person	$person The Person to update
	array	$employment The array containing the employment ccv data

Returns:

boolean The status of the update

UploadCCVAPI::updatePersonalInfo	(	$	person,
		$	info
	)

Fills in some of the personal fields from the CCV

Parameters:

	Person	$person The Person to update
	array	$info The array containing the personal info ccv data

Returns:

boolean The status of the update

---

Member Data Documentation

UploadCCVAPI::$diplomaMap [static]

Initial value:

 array("00000000000000000000000000000071" => "Undergraduate",
                               "00000000000000000000000000000072" => "Masters Student",
                               "00000000000000000000000000000073" => "PhD Student",
                               "00000000000000000000000000000074" => "PostDoc",
                               "00000000000000000000000000000081" => "Masters Student",
                               "00000000000000000000000000000083" => "Undergraduate",
                               "00000000000000000000000000000084" => "Undergraduate",
                               "00000000000000000000000000000085" => "Masters Student",
                               "00000000000000000000000000000086" => "PhD Student")

UploadCCVAPI::$genderMap [static]

Initial value:

 array("00000000000000000000000000000282" => "Male",
                              "00000000000000000000000000000283" => "Female",
                              "00000000000000000000000000000284" => "")

UploadCCVAPI::$honorificMap [static]

Initial value:

 array("00000000000000000000000000000317" => "Dr.",
                                 "00000000000000000000000000000318" => "Mr.",
                                 "00000000000000000000000000000319" => "Mrs.",
                                 "00000000000000000000000000000320" => "Miss",
                                 "00000000000000000000000000000321" => "Professor",
                                 "00000000000000000000000000000322" => "Reverend")

UploadCCVAPI::$languageMap [static]

Initial value:

 array("00000000000000000000000000000054" => "English",
                                "00000000000000000000000000000055" => "French")

---

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

• extensions/API/UploadCCVAPI.php