Salaries

class Salaries extends DolibarrApi (View source)

API class for salaries

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
static string[] $FIELDSPAYMENT

Methods

__construct()

Constructor

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
array
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0)

Get the list of salaries.

object
get(int $id)

Get salary by ID.

int
post(array $request_data = null)

Create salary object

object
put(int $id, array $request_data = null)

Update salary

array
getAllPayments(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0)

Get the list of payment of salaries.

object
getPayments(int $pid)

Get a given payment.

int
addPayment(int $id, array $request_data = null)

Create payment salary on a salary

object
updatePayment(int $id, array $request_data = null)

Update paymentsalary

Details

at line 58
__construct()

Constructor

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 489
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 77
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $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

Return Value

array

List of salary objects

Exceptions

RestException

at line 126
object get(int $id)

Get salary by ID.

Parameters

int $id

ID of salary

Return Value

object

Salary object

Exceptions

RestException

at line 149
int post(array $request_data = null)

Create salary object

Parameters

array $request_data

Request data

Return Value

int

ID of salary

at line 177
object put(int $id, array $request_data = null)

Update salary

Parameters

int $id

ID of salary
array $request_data Data

Return Value

object

Updated object

at line 248
array getAllPayments(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0)

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

Return Value

array

List of paymentsalary objects

Exceptions

RestException

at line 300
object getPayments(int $pid)

Get a given payment.

Parameters

int $pid

ID of payment salary

Return Value

object

PaymentSalary object

Exceptions

RestException

at line 328
int addPayment(int $id, array $request_data = null)

Create payment salary on a salary

Parameters

int $id

Id of salary
array $request_data

Request data

Return Value

int

ID of paymentsalary

Exceptions

RestException

at line 371
object updatePayment(int $id, array $request_data = null)

Update paymentsalary

Parameters

int $id

ID of paymentsalary
array $request_data data

Return Value

object

PaymentSalary object

Exceptions

RestException