dolibarr 21.0.0-alpha
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='')
 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 31 of file api_tickets.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Tickets::_cleanObjectDatas ( $object)
protected

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 476 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$dataData to validate
Returns
array
Exceptions
RestException

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

Referenced by post().

◆ _validateMessage()

Tickets::_validateMessage ( $data)
private

Validate fields before create or update object message.

Parameters
array$dataData to validate
Returns
array
Exceptions
RestException

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

Referenced by postNewMessage().

◆ delete()

Tickets::delete ( $id)

Delete ticket.

Parameters
int$idTicket ID
Returns
array

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

References DolibarrApi\_checkAccessToResource().

◆ get()

Tickets::get ( $id)

Get properties of a Ticket object.

Return an array with ticket information

Parameters
int$idID of ticket
Returns
Object Object with cleaned properties
Exceptions
RestException401
RestException403
RestException404

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

References getCommon().

◆ getByRef()

Tickets::getByRef ( $ref)

Get properties of a Ticket object from ref.

Return an array with ticket information

Parameters
string$refReference for ticket
Returns
array|mixed Data without useless information

@url GET ref/{ref}

Exceptions
RestException401
RestException403
RestException404

Definition at line 114 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_idTracking ID of ticket
Returns
array|mixed Data without useless information

@url GET track_id/{track_id}

Exceptions
RestException401
RestException403
RestException404

Definition at line 95 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$idID of ticket
string$track_idTracking ID of ticket
string$refReference for ticket
Returns
array|mixed Data without useless information

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

References 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 = '' )

List tickets.

Get a list of tickets

Parameters
int$socidFilter list with thirdparty ID
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther 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$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of ticket objects

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

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

◆ post()

Tickets::post ( $request_data = null)

Create ticket object.

Parameters
array$request_dataRequest datas
Returns
int ID of ticket

Definition at line 285 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_dataRequest datas
Returns
int ID of ticket

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

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

◆ put()

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

Update ticket.

Parameters
int$idId of ticket to update
array$request_dataDatas
Returns
Object Updated object

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

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


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