|
| __construct () |
| Constructor.
|
|
| index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0) |
| Get the list of salaries. More...
|
|
| get ($id) |
| Get salary by ID. More...
|
|
| post ($request_data=null) |
| Create salary object. More...
|
|
| put ($id, $request_data=null) |
| Update salary. More...
|
|
| getAllPayments ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0) |
| Delete salary. More...
|
|
| getPayments ($pid) |
| Get a given payment. More...
|
|
| addPayment ($id, $request_data=null) |
| Create payment salary on a salary. More...
|
|
| updatePayment ($id, $request_data=null) |
| Update paymentsalary. More...
|
|
| __construct ($db, $cachedir='', $refreshCache=false) |
| Constructor. More...
|
|
|
static | $FIELDSPAYMENT |
| array $FIELDS Mandatory fields, checked when creating an object
|
|
Definition at line 31 of file api_salaries.class.php.
◆ _cleanObjectDatas()
Salaries::_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 464 of file api_salaries.class.php.
References $object.
◆ _validate()
Salaries::_validate |
( |
|
$data | ) |
|
|
private |
Delete a payment salary.
- Parameters
-
int | $id | ID of payment salary |
- Returns
- array
@url DELETE {id}/payments Validate fields before creating an object
- Parameters
-
array | null | $data | Data to validate |
- Returns
- array
- Exceptions
-
Definition at line 423 of file api_salaries.class.php.
◆ _validatepayments()
Salaries::_validatepayments |
( |
|
$data | ) |
|
|
private |
Validate fields before creating an object.
- Parameters
-
array | null | $data | Data to validate |
- Returns
- array
- Exceptions
-
Definition at line 443 of file api_salaries.class.php.
◆ addPayment()
Salaries::addPayment |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Create payment salary on a salary.
- Parameters
-
int | $id | Id of salary |
array | $request_data | Request data |
- Returns
- int ID of paymentsalary
@url POST {id}/payments
- Exceptions
-
Definition at line 316 of file api_salaries.class.php.
◆ get()
◆ getAllPayments()
Salaries::getAllPayments |
( |
|
$sortfield = "t.rowid" , |
|
|
|
$sortorder = 'ASC' , |
|
|
|
$limit = 100 , |
|
|
|
$page = 0 |
|
) |
| |
Delete salary.
- Parameters
-
- Returns
- array Get the list of payment of salaries.
- Parameters
-
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
- Returns
- array List of paymentsalary objects
@url GET /payments
- Exceptions
-
Definition at line 238 of file api_salaries.class.php.
◆ getPayments()
Salaries::getPayments |
( |
|
$pid | ) |
|
◆ index()
Salaries::index |
( |
|
$sortfield = "t.rowid" , |
|
|
|
$sortorder = 'ASC' , |
|
|
|
$limit = 100 , |
|
|
|
$page = 0 |
|
) |
| |
Get the list of salaries.
- Parameters
-
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
- Returns
- array List of salary objects
- Exceptions
-
Definition at line 73 of file api_salaries.class.php.
◆ post()
Salaries::post |
( |
|
$request_data = null | ) |
|
Create salary object.
- Parameters
-
array | $request_data | Request data |
- Returns
- int ID of salary
Definition at line 143 of file api_salaries.class.php.
◆ put()
Salaries::put |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Update salary.
- Parameters
-
int | $id | ID of salary |
array | $request_data | Data |
- Returns
- Object Updated object
Definition at line 169 of file api_salaries.class.php.
◆ updatePayment()
Salaries::updatePayment |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Update paymentsalary.
- Parameters
-
int | $id | ID of paymentsalary |
array | $request_data | data |
- Returns
- Object PaymentSalary object
@url POST {id}/payments
- Exceptions
-
Definition at line 357 of file api_salaries.class.php.
The documentation for this class was generated from the following file: