LocalTaxes Class Reference

Inheritance diagram for LocalTaxes:

Collaboration diagram for LocalTaxes:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a local tax object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='', $pagination_data=false)
	List local taxes (RE / IRPF).
	post ($request_data=null)
	Create a local tax.
	put ($id, $request_data=null)
	Update a local tax.
	delete ($id)
	Delete a local tax.
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensitive object data.
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.
	_checkValExtrafieldsForAPI ($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 creating an 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', $parenttableforentity='')
	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 30 of file api_localtaxes.class.php.

Member Function Documentation

_cleanObjectDatas()

LocalTaxes::_cleanObjectDatas ( $object )

protected

Clean sensitive object data.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 339 of file api_localtaxes.class.php.

References $object.

Referenced by get(), and index().

_validate()

LocalTaxes::_validate ( $data )

private

Validate fields before creating an object.

Parameters

?array<string,string>

$data Data to validate

Returns

array<string,string>

Exceptions

RestException

400 Missing mandatory field

Definition at line 317 of file api_localtaxes.class.php.

Referenced by post().

delete()

LocalTaxes::delete

(

$id

)

Delete a local tax.

Parameters

int

$id

ID of the local tax

Returns

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

Exceptions

RestException	403 Access denied
RestException	404 Local tax not found
RestException	500 Error when deleting the local tax

Definition at line 283 of file api_localtaxes.class.php.

References $id.

get()

LocalTaxes::get

(

$id

)

Get properties of a local tax object.

Parameters

int

$id

ID of the local tax

Returns

Object Object with cleaned properties

Exceptions

RestException	403 Access denied
RestException	404 Local tax not found

Definition at line 61 of file api_localtaxes.class.php.

References $id, and _cleanObjectDatas().

index()

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

List local taxes (RE / IRPF).

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.datep:>=:'20240101') and (t.amount:<:100)"
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 local tax objects @phan-return Localtax[]|array{data:Localtax[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return Localtax[]|array{data:Localtax[],pagination:array{total:int,page:int,page_count:int,limit:int}}

Exceptions

RestException	400 Bad value for sqlfilters
RestException	403 Access denied
RestException	503 Error when retrieving list

Definition at line 96 of file api_localtaxes.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

post()

LocalTaxes::post

(

$request_data = null

)

Create a local tax.

Parameters

array

$request_data

Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns

int ID of the created local tax

Exceptions

RestException	400 Missing mandatory field
RestException	403 Access denied
RestException	500 Error when creating the local tax

Definition at line 180 of file api_localtaxes.class.php.

References DolibarrApi\_checkValForAPI(), _validate(), dol_now(), and sanitizeVal().

put()

LocalTaxes::put	(		$id,
			$request_data = null )

Update a local tax.

Parameters

int	$id	ID of the local tax
array	$request_data	Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns

Object Updated object with cleaned properties

Exceptions

RestException	403 Access denied
RestException	404 Local tax not found
RestException	500 Error when updating the local tax

Definition at line 230 of file api_localtaxes.class.php.

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

---

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

• dolibarr_dev/htdocs/tax/class/api_localtaxes.class.php