dolibarr 20.0.0
|
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. | |
Definition at line 37 of file api_recruitments.class.php.
Recruitments::__construct | ( | ) |
|
protected |
Clean sensible object datas.
Object | $object | Object to clean |
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().
|
private |
Validate fields before create or update object.
array | $data | Array of data to validate |
RestException |
Definition at line 629 of file api_recruitments.class.php.
Referenced by postCandidature(), and postJobPosition().
Recruitments::deleteCandidature | ( | $id | ) |
Delete candidature.
int | $id | candidature ID |
RestException |
@url DELETE candidature/{id}
Definition at line 531 of file api_recruitments.class.php.
References DolibarrApi\_checkAccessToResource().
Recruitments::deleteJobPosition | ( | $id | ) |
Delete jobposition.
int | $id | jobposition ID |
RestException |
@url DELETE jobposition/{id}
Definition at line 495 of file api_recruitments.class.php.
References DolibarrApi\_checkAccessToResource().
Recruitments::getCandidature | ( | $id | ) |
Get properties of a candidature object.
Return an array with candidature information
int | $id | ID of candidature |
@url GET candidature/{id}
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().
Recruitments::getJobPosition | ( | $id | ) |
Get properties of a jobposition object.
Return an array with jobposition information
int | $id | ID of jobposition |
@url GET jobposition/{id}
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().
Recruitments::indexCandidature | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$sqlfilters = '' ) |
List candatures.
Get a list of candidatures
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')" |
RestException |
@url GET /candidature/
Definition at line 234 of file api_recruitments.class.php.
References _cleanObjectDatas(), and forgeSQLFromUniversalSearchCriteria().
Recruitments::indexJobPosition | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$sqlfilters = '', | |||
$properties = '' ) |
List jobpositions.
Get a list of jobpositions
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 |
RestException |
@url GET /jobposition/
Definition at line 144 of file api_recruitments.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().
Recruitments::postCandidature | ( | $request_data = null | ) |
Create candidature object.
array | $request_data | Request datas |
RestException |
@url POST candidature/
Definition at line 358 of file api_recruitments.class.php.
References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().
Recruitments::postJobPosition | ( | $request_data = null | ) |
Create jobposition object.
array | $request_data | Request datas |
RestException |
@url POST jobposition/
Definition at line 320 of file api_recruitments.class.php.
References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().
Recruitments::putCandidature | ( | $id, | |
$request_data = null ) |
Update candidature.
int | $id | Id of candidature to update |
array | $request_data | Datas |
RestException |
@url PUT candidature/{id}
Definition at line 446 of file api_recruitments.class.php.
References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), getCandidature(), and sanitizeVal().
Recruitments::putJobPosition | ( | $id, | |
$request_data = null ) |
Update jobposition.
int | $id | Id of jobposition to update |
array | $request_data | Datas |
RestException |
@url PUT jobposition/{id}
Definition at line 397 of file api_recruitments.class.php.
References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), getJobPosition(), and sanitizeVal().