Inheritance diagram for Recruitment:

Collaboration diagram for Recruitment:

Public Member Functions
	__construct ()
	Constructor. More...

	getJobPosition ($id)
	Get properties of a jobposition object. More...

	getCandidature ($id)
	Get properties of a candidature object. More...

	indexJobPosition ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $sqlfilters= '')
	List jobpositions. More...

	indexCandidature ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $sqlfilters= '')
	List candatures. More...

	postJobPosition ($request_data=null)
	Create jobposition object. More...

	postCandidature ($request_data=null)
	Create candidature object. More...

	putJobPosition ($id, $request_data=null)
	Update jobposition. More...

	putCandidature ($id, $request_data=null)
	Update candidature. More...

	deleteJobPosition ($id)
	Delete jobposition. More...

	deleteCandidature ($id)
	Delete candidature. More...

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir= '', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...

Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name. More...

	_cleanObjectDatas ($object)
	Clean sensible object datas. More...

	_checkFilters ($sqlfilters, &$error= '')
	Return if a $sqlfilters parameter is valid. More...

Private Member Functions
	_validate ($data)
	Validate fields before create or update object. More...

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename= '', $feature2= '', $dbt_keyfield= 'fk_soc', $dbt_select= 'rowid')
	Check access by user to a given resource. More...

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string. More...

Detailed Description

Definition at line 37 of file api_recruitment.class.php.

Constructor & Destructor Documentation

Recruitment::__construct ( )

Constructor.

GET /

Definition at line 55 of file api_recruitment.class.php.

References db.

Member Function Documentation

Recruitment::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Definition at line 574 of file api_recruitment.class.php.

Referenced by getCandidature(), getJobPosition(), indexCandidature(), and indexJobPosition().

Recruitment::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array $data Array of data to validate

Returns: array

Exceptions

RestException

Definition at line 638 of file api_recruitment.class.php.

Referenced by postCandidature(), and postJobPosition().

Recruitment::deleteCandidature ( $id )

Delete candidature.

Parameters

int $id candidature ID

Returns: array

Exceptions

RestException DELETE candidature/{id}

Definition at line 540 of file api_recruitment.class.php.

References DolibarrApi\_checkAccessToResource().

Recruitment::deleteJobPosition ( $id )

Delete jobposition.

Parameters

int $id jobposition ID

Returns: array

Exceptions

RestException DELETE jobposition/{id}

Definition at line 504 of file api_recruitment.class.php.

References DolibarrApi\_checkAccessToResource().

Recruitment::getCandidature ( $id )

Get properties of a candidature object.

Return an array with candidature informations

Parameters

int $id ID of candidature

Returns: array|mixed data without useless information

GET candidature/{id}

Exceptions

RestException	401 Not allowed
RestException	404 Not found

Definition at line 108 of file api_recruitment.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Recruitment::getJobPosition ( $id )

Get properties of a jobposition object.

Return an array with jobposition informations

Parameters

int $id ID of jobposition

Returns: array|mixed data without useless information

GET jobposition/{id}

Exceptions

RestException	401 Not allowed
RestException	404 Not found

Definition at line 77 of file api_recruitment.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Recruitment::indexCandidature	(	$sortfield = `"t.rowid"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$sqlfilters = `''`
	)

List candatures.

Get a list of candidatures

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"

Returns: array Array of order objects

Exceptions

RestException GET /candidature/

Definition at line 251 of file api_recruitment.class.php.

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), and db.

Recruitment::indexJobPosition	(	$sortfield = `"t.rowid"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$sqlfilters = `''`
	)

List jobpositions.

Get a list of jobpositions

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"

Returns: array Array of order objects

Exceptions

RestException GET /jobposition/

Definition at line 143 of file api_recruitment.class.php.

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), and db.

Recruitment::postCandidature ( $request_data = null )

Create candidature object.

Parameters

array $request_data Request datas

Returns: int ID of candidature

Exceptions

RestException POST candidature/

Definition at line 385 of file api_recruitment.class.php.

References DolibarrApi\_checkValForAPI(), and _validate().

Recruitment::postJobPosition ( $request_data = null )

Create jobposition object.

Parameters

array $request_data Request datas

Returns: int ID of jobposition

Exceptions

RestException POST jobposition/

Definition at line 353 of file api_recruitment.class.php.

References DolibarrApi\_checkValForAPI(), and _validate().

Recruitment::putCandidature	(	$id,
		$request_data = `null`
	)

Update candidature.

Parameters

int	$id	Id of candidature to update
array	$request_data	Datas

Returns: int

Exceptions

RestException PUT candidature/{id}

Definition at line 461 of file api_recruitment.class.php.

References DolibarrApi\_checkAccessToResource(), and DolibarrApi\_checkValForAPI().

Recruitment::putJobPosition	(	$id,
		$request_data = `null`
	)

Update jobposition.

Parameters

int	$id	Id of jobposition to update
array	$request_data	Datas

Returns: int

Exceptions

RestException PUT jobposition/{id}

Definition at line 418 of file api_recruitment.class.php.

References DolibarrApi\_checkAccessToResource(), and DolibarrApi\_checkValForAPI().

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

htdocs/recruitment/class/api_recruitment.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation