dolibarr  21.0.0-alpha
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Recruitments Class Reference
Inheritance diagram for Recruitments:
Inheritance graph
[legend]
Collaboration diagram for Recruitments:
Collaboration graph
[legend]

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='', $properties='')
 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...
 
 _filterObjectProperties ($object, $properties)
 Filter properties that will be returned on object. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used. 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_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$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

References $object.

◆ _validate()

Recruitments::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array$dataArray of data to validate
Returns
array
Exceptions
RestException

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

◆ deleteCandidature()

Recruitments::deleteCandidature (   $id)

Delete candidature.

Parameters
int$idcandidature ID
Returns
array
Exceptions
RestException@url DELETE candidature/{id}

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

◆ deleteJobPosition()

Recruitments::deleteJobPosition (   $id)

Delete jobposition.

Parameters
int$idjobposition ID
Returns
array
Exceptions
RestException@url DELETE jobposition/{id}

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

◆ getCandidature()

Recruitments::getCandidature (   $id)

Get properties of a candidature object.

Return an array with candidature information

Parameters
int$idID of candidature
Returns
Object Object with cleaned properties

@url GET candidature/{id}

Exceptions
RestException401 Not allowed
RestException404 Not found

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

◆ getJobPosition()

Recruitments::getJobPosition (   $id)

Get properties of a jobposition object.

Return an array with jobposition information

Parameters
int$idID of jobposition
Returns
Object Object with cleaned properties

@url GET jobposition/{id}

Exceptions
RestException401 Not allowed
RestException404 Not found

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

◆ indexCandidature()

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

List candatures.

Get a list of candidatures

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther 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.

◆ indexJobPosition()

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

List jobpositions.

Get a list of jobpositions

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string$propertiesRestrict 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.

◆ postCandidature()

Recruitments::postCandidature (   $request_data = null)

Create candidature object.

Parameters
array$request_dataRequest datas
Returns
int ID of candidature
Exceptions
RestException@url POST candidature/

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

◆ postJobPosition()

Recruitments::postJobPosition (   $request_data = null)

Create jobposition object.

Parameters
array$request_dataRequest datas
Returns
int ID of jobposition
Exceptions
RestException@url POST jobposition/

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

◆ putCandidature()

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

Update candidature.

Parameters
int$idId of candidature to update
array$request_dataDatas
Returns
Object Object with cleaned properties
Exceptions
RestException@url PUT candidature/{id}

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

◆ putJobPosition()

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

Update jobposition.

Parameters
int$idId of jobposition to update
array$request_dataDatas
Returns
Object Object with cleaned properties
Exceptions
RestException@url PUT jobposition/{id}

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


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