Recruitments Class Reference

Inheritance diagram for Recruitments:

Collaboration diagram for Recruitments:

Public Member Functions
	__construct ()
	Constructor.
	getJobPosition ($id)
	Get properties of a jobposition object.
	getCandidature ($id)
	Get properties of a candidature object.
	indexJobPosition ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
	List jobpositions.
	indexCandidature ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='')
	List candatures.
	postJobPosition ($request_data=null)
	Create jobposition object.
	postCandidature ($request_data=null)
	Create candidature object.
	putJobPosition ($id, $request_data=null)
	Update jobposition.
	putCandidature ($id, $request_data=null)
	Update candidature.
	deleteJobPosition ($id)
	Delete jobposition.
	deleteCandidature ($id)
	Delete candidature.
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas.
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.
	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.
	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

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

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.
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string.

Detailed Description

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

Constructor & Destructor Documentation

__construct()

Recruitments::__construct

(

)

Constructor.

@url GET /

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

Member Function Documentation

_cleanObjectDatas()

Recruitments::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 565 of file api_recruitments.class.php.

References $object, and _cleanObjectDatas().

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

_validate()

Recruitments::_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 629 of file api_recruitments.class.php.

Referenced by postCandidature(), and postJobPosition().

deleteCandidature()

Recruitments::deleteCandidature

(

$id

)

Delete candidature.

Parameters

int

$id

candidature ID

Returns

array

Exceptions

RestException

@url DELETE candidature/{id}

Definition at line 531 of file api_recruitments.class.php.

References DolibarrApi\_checkAccessToResource().

deleteJobPosition()

Recruitments::deleteJobPosition

(

$id

)

Delete jobposition.

Parameters

int

$id

jobposition ID

Returns

array

Exceptions

RestException

@url DELETE jobposition/{id}

Definition at line 495 of file api_recruitments.class.php.

References DolibarrApi\_checkAccessToResource().

getCandidature()

Recruitments::getCandidature

(

$id

)

Get properties of a candidature object.

Return an array with candidature information

Parameters

int

$id

ID of candidature

Returns

Object Object with cleaned properties

@url GET candidature/{id}

Exceptions

RestException	401 Not allowed
RestException	404 Not found

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

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

Referenced by putCandidature().

getJobPosition()

Recruitments::getJobPosition

(

$id

)

Get properties of a jobposition object.

Return an array with jobposition information

Parameters

int

$id

ID of jobposition

Returns

Object Object with cleaned properties

@url GET jobposition/{id}

Exceptions

RestException	401 Not allowed
RestException	404 Not found

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

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

Referenced by putJobPosition().

indexCandidature()

Recruitments::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

@url GET /candidature/

Definition at line 234 of file api_recruitments.class.php.

References _cleanObjectDatas(), and forgeSQLFromUniversalSearchCriteria().

indexJobPosition()

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

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')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Returns

array Array of order objects

Exceptions

RestException

@url GET /jobposition/

Definition at line 144 of file api_recruitments.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().

postCandidature()

Recruitments::postCandidature

(

$request_data = null

)

Create candidature object.

Parameters

array

$request_data

Request datas

Returns

int ID of candidature

Exceptions

RestException

@url POST candidature/

Definition at line 358 of file api_recruitments.class.php.

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

postJobPosition()

Recruitments::postJobPosition

(

$request_data = null

)

Create jobposition object.

Parameters

array

$request_data

Request datas

Returns

int ID of jobposition

Exceptions

RestException

@url POST jobposition/

Definition at line 320 of file api_recruitments.class.php.

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

putCandidature()

Recruitments::putCandidature	(		$id,
			$request_data = null )

Update candidature.

Parameters

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

Returns

Object Object with cleaned properties

Exceptions

RestException

@url PUT candidature/{id}

Definition at line 446 of file api_recruitments.class.php.

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

putJobPosition()

Recruitments::putJobPosition	(		$id,
			$request_data = null )

Update jobposition.

Parameters

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

Returns

Object Object with cleaned properties

Exceptions

RestException

@url PUT jobposition/{id}

Definition at line 397 of file api_recruitments.class.php.

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

---

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

• dolibarr_20.0/htdocs/recruitment/class/api_recruitments.class.php