Tickets Class Reference

Inheritance diagram for Tickets:

Collaboration diagram for Tickets:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a Ticket object.
	getByTrackId ($track_id)
	Get properties of a Ticket object from track id.
	getByRef ($ref)
	Get properties of a Ticket object from ref.
	index ($socid=0, $sortfield="t.rowid", $sortorder="ASC", $limit=100, $page=0, $sqlfilters='', $properties='', $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.
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='')
	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.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 498 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

$data

Data to validate

Returns

array

Exceptions

RestException

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

Referenced by post().

_validateMessage()

Tickets::_validateMessage ( $data )

private

Validate fields before create or update object message.

Parameters

array

$data

Data to validate

Returns

array

Exceptions

RestException

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

Referenced by postNewMessage().

delete()

Tickets::delete

(

$id

)

Delete ticket.

Parameters

int

$id

Ticket ID

Returns

array

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

References $id, and DolibarrApi\_checkAccessToResource().

get()

Tickets::get

(

$id

)

Get properties of a Ticket object.

Return an array with ticket information

Parameters

int

$id

ID of ticket

Returns

Object Object with cleaned properties

Exceptions

RestException	401
RestException	403
RestException	404

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

References $id, and getCommon().

getByRef()

Tickets::getByRef

(

$ref

)

Get properties of a Ticket object from ref.

Return an array with ticket information

Parameters

string

$ref

Reference for ticket

Returns

array|mixed Data without useless information

@url GET ref/{ref}

Exceptions

RestException	401
RestException	403
RestException	404

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

References getCommon().

getByTrackId()

Tickets::getByTrackId

(

$track_id

)

Get properties of a Ticket object from track id.

Return an array with ticket information

Parameters

string

$track_id

Tracking ID of ticket

Returns

array|mixed Data without useless information

@url GET track_id/{track_id}

Exceptions

RestException	401
RestException	403
RestException	404

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

References getCommon().

getCommon()

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

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

Returns

array|mixed Data without useless information

Definition at line 129 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 = '',
			$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
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

Definition at line 205 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 datas

Returns

int ID of ticket

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

References 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 datas

Returns

int ID of ticket

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

References 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	Datas

Returns

Object Updated object

Definition at line 383 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_dev/htdocs/ticket/class/api_tickets.class.php