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='', $pagination_data=false)
	List jobpositions.

	indexCandidature ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='', $pagination_data=false)
	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 38 of file api_recruitments.class.php.

Constructor & Destructor Documentation

◆ __construct()

Recruitments::__construct ( )

Constructor.

@url GET /

Definition at line 56 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 624 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<string,mixed> $data Array of data to validate

Returns: array<string,mixed>

Exceptions

RestException

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

Referenced by postCandidature(), and postJobPosition().

◆ deleteCandidature()

Recruitments::deleteCandidature ( $id )

Delete candidature.

Parameters

int $id candidature ID

Returns: array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

Exceptions

RestException

@url DELETE candidature/{id}

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

References $id, and DolibarrApi\_checkAccessToResource().

◆ deleteJobPosition()

Recruitments::deleteJobPosition ( $id )

Delete jobposition.

Parameters

int $id jobposition ID

Returns: array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

Exceptions

RestException

@url DELETE jobposition/{id}

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

References $id, and 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 109 of file api_recruitments.class.php.

References $id, 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 78 of file api_recruitments.class.php.

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

Referenced by putJobPosition().

◆ indexCandidature()

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

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')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Returns: array Array of order objects @phan-return array<string,mixed> @phpstan-return array<string,mixed>

Exceptions

RestException

@url GET /candidature/

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

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

◆ indexJobPosition()

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

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
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Returns: array Array of order objects @phan-return array<string,mixed> @phpstan-return array<string,mixed>

Exceptions

RestException

@url GET /jobposition/

Definition at line 147 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 @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int ID of candidature

Exceptions

RestException

@url POST candidature/

Definition at line 409 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 @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int ID of jobposition

Exceptions

RestException

@url POST jobposition/

Definition at line 369 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 @phan-param ?array<string,mixed> $request_data @phpstan-param ?array<string,mixed> $request_data

Returns: Object Object with cleaned properties

Exceptions

RestException

@url PUT candidature/{id}

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

References $id, 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 @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Object with cleaned properties

Exceptions

RestException

@url PUT jobposition/{id}

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

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

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

dolibarr_dev/htdocs/recruitment/class/api_recruitments.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ deleteCandidature()

◆ deleteJobPosition()

◆ getCandidature()

◆ getJobPosition()

◆ indexCandidature()

◆ indexJobPosition()

◆ postCandidature()

◆ postJobPosition()

◆ putCandidature()

◆ putJobPosition()