Inheritance diagram for Tickets:

Collaboration diagram for Tickets:

Public Member Functions
	__construct ()
	Constructor.

	get ($id, $contact_list=1)
	Get properties of a Ticket object.

	getByTrackId ($track_id, $contact_list=1)
	Get properties of a Ticket object from track id.

	getByRef ($ref, $contact_list=1)
	Get properties of a Ticket object from ref.

	index ($socid=0, $sortfield="t.rowid", $sortorder="ASC", $limit=100, $page=0, $sqlfilters='', $properties='', $loadcontacts=0, $pagination_data=false)
	List tickets.

	post ($request_data=null)
	Create ticket object.

	postNewMessage ($request_data=null)
	Add a new message to an existing ticket identified by property ->track_id into request.

	put ($id, $request_data=null)
	Update ticket.

	delete ($id)
	Delete ticket.

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas @phpstan-template T.

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
	getCommon ($id=0, $track_id='', $ref='', $contact_list=1)
	Get properties of a Ticket object Return an array with ticket information.

	_validate ($data)
	Validate fields before create or update object.

	_validateMessage ($data)
	Validate fields before create or update object message.

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.

Detailed Description

Definition at line 32 of file api_tickets.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Tickets::_cleanObjectDatas ( $object )

protected

Clean sensible object datas @phpstan-template T.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

@phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

Definition at line 590 of file api_tickets.class.php.

References $object, and _cleanObjectDatas().

Referenced by _cleanObjectDatas(), getCommon(), and index().

◆ _validate()

Tickets::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,string> $data Data to validate

Returns: array<string,string>

Exceptions

RestException

Definition at line 540 of file api_tickets.class.php.

Referenced by post().

◆ _validateMessage()

Tickets::_validateMessage ( $data )

private

Validate fields before create or update object message.

Parameters

?array<string,string> $data Data to validate

Returns: array<string,string>

Exceptions

RestException

Definition at line 563 of file api_tickets.class.php.

Referenced by postNewMessage().

◆ delete()

Tickets::delete ( $id )

Delete ticket.

Parameters

int $id Ticket ID

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

Definition at line 506 of file api_tickets.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ get()

Tickets::get	(		$id,
			$contact_list = 1 )

Get properties of a Ticket object.

Return an array with ticket information

Parameters

int	$id	ID of ticket
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses

Returns: Object Object with cleaned properties

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 78 of file api_tickets.class.php.

References $id, and getCommon().

◆ getByRef()

Tickets::getByRef	(		$ref,
			$contact_list = 1 )

Get properties of a Ticket object from ref.

Return an array with ticket information

Parameters

string	$ref	Reference for ticket
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses

Returns: array|mixed Data without useless information

@url GET ref/{ref}

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 118 of file api_tickets.class.php.

References getCommon().

◆ getByTrackId()

Tickets::getByTrackId	(		$track_id,
			$contact_list = 1 )

Get properties of a Ticket object from track id.

Return an array with ticket information

Parameters

string	$track_id	Tracking ID of ticket
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses

Returns: array|mixed Data without useless information

@url GET track_id/{track_id}

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 98 of file api_tickets.class.php.

References getCommon().

◆ getCommon()

Tickets::getCommon	(	$id = 0,
		$track_id = '',
		$ref = '',
		$contact_list = 1 )

private

Get properties of a Ticket object Return an array with ticket information.

Parameters

int	$id	ID of ticket
string	$track_id	Tracking ID of ticket
string	$ref	Reference for ticket
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses

Returns: array|mixed Data without useless information

Definition at line 133 of file api_tickets.class.php.

References $id, DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), and dolGetFirstLastname().

Referenced by get(), getByRef(), and getByTrackId().

◆ index()

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

List tickets.

Get a list of tickets

Parameters

int	$socid	Filter list with thirdparty ID
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') and (t.fk_statut:=:1)"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
int	$loadcontacts	Load also contacts/addresses (0=No, 1=Yes)
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 ticket objects @phan-return Ticket[]|array{data:Ticket[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return Ticket[]|array{data:Ticket[],pagination:array{total:int,page:int,page_count:int,limit:int}}

Definition at line 226 of file api_tickets.class.php.

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

◆ post()

Tickets::post ( $request_data = null )

Create ticket object.

Parameters

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

Returns: int ID of ticket

Definition at line 345 of file api_tickets.class.php.

References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), _validate(), generate_random_id(), and sanitizeVal().

◆ postNewMessage()

Tickets::postNewMessage ( $request_data = null )

Add a new message to an existing ticket identified by property ->track_id into request.

Parameters

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

Returns: int ID of ticket

Definition at line 399 of file api_tickets.class.php.

References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), _validateMessage(), and sanitizeVal().

◆ put()

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

Update ticket.

Parameters

int	$id	Id of ticket to update
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Updated object

Definition at line 443 of file api_tickets.class.php.

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

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

dolibarr_23.0/htdocs/ticket/class/api_tickets.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ _validateMessage()

◆ delete()

◆ get()

◆ getByRef()

◆ getByTrackId()

◆ getCommon()

◆ index()

◆ post()

◆ postNewMessage()

◆ put()